Factories (#39)

- decorate user & group with permissions
- add some missing PUT routes
- better error handling validation errors
- constraining views by GID
- zone record factory & subclasses
- zone factory & subclasses
- user factory, toml, mysql, mongodb, elastic classes

Author: msimerson

.github/workflows/publish.yml

@@ -41,9 +41,9 @@ jobs:
           VERSION=$(node -e 'console.log(require("./package.json").version)')
           if printf '%s' "$VERSION" | grep -q -- '-'; then
             # prerelease versions get the "next" tag
-            npm publish --access=public --tag=next
+            npm publish --access public --tag next
           else
-            npm publish --access=public
+            npm publish --access public
           fi
 
   publish-gpr:

.gitignore

@@ -130,4 +130,5 @@ dist
 .pnp.*
 
 package-lock.json
+.release/
 conf.d/*.pem

.release

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
 ### Unreleased
 
+### [3.0.0-alpha.11] - 2026-04-07
+
+- decorate user & group with permissions
+- add some missing PUT routes
+- better error handling validation errors
+- constraining views by GID
+- zone record factory & subclasses
+- zone factory & subclasses
+- user factory, toml, mysql, mongodb, elastic classes
+
 ### [3.0.0-alpha.10] - 2026-03-25
 
 - config: replace .yaml with .toml
@@ -71,3 +81,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/).
 [3.0.0-alpha.8]: https://github.com/NicTool/api/releases/tag/v3.0.0-alpha.8
 [3.0.0-alpha.9]: https://github.com/NicTool/api/releases/tag/v3.0.0-alpha.9
 [3.0.0-alpha.10]: https://github.com/NicTool/api/releases/tag/v3.0.0-alpha.10
+[3.0.0-alpha.11]: https://github.com/NicTool/api/releases/tag/v3.0.0-alpha.11

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 This handcrafted artisanal software is brought to you by:
 
-| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/NicTool/api/commits?author=msimerson">18</a>)|
+| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/NicTool/api/commits?author=msimerson">19</a>)|
 | :---: |
 
 <sub>this file is generated by [.release](https://github.com/msimerson/.release).

CONTRIBUTORS.md

@@ -0,0 +1,166 @@
+import Mysql from '../mysql.js'
+import Permission from '../permission.js'
+import { mapToDbColumn } from '../util.js'
+
+const groupDbMap = { id: 'nt_group_id', parent_gid: 'parent_group_id' }
+const boolFields = ['deleted']
+
+class Group {
+  constructor() {
+    this.mysql = Mysql
+  }
+
+  async create(args) {
+    if (args.id) {
+      const g = await this.get({ id: args.id })
+      if (g.length === 1) return g[0].id
+    }
+
+    const usable_ns = args.usable_ns
+    delete args.usable_ns
+
+    const parent_gid = args.parent_gid ?? 0
+
+    const gid = await Mysql.execute(...Mysql.insert(`nt_group`, mapToDbColumn(args, groupDbMap)))
+
+    if (gid && parent_gid !== 0) {
+      await this.addToSubgroups(gid, parent_gid)
+    }
+
+    await Permission.create({
+      gid,
+      name: `Group ${args.name} perms`,
+      nameserver: { usable: Array.isArray(usable_ns) ? usable_ns : [] },
+    })
+
+    return gid
+  }
+
+  async addToSubgroups(gid, parent_gid, rank = 1000) {
+    if (!parent_gid || parent_gid === 0) return
+
+    await Mysql.execute(...Mysql.insert('nt_group_subgroups', {
+      nt_group_id: parent_gid,
+      nt_subgroup_id: gid,
+      rank,
+    }))
+
+    const parent = await this.get({ id: parent_gid })
+    if (parent.length === 1 && parent[0].parent_gid !== 0) {
+      await this.addToSubgroups(gid, parent[0].parent_gid, rank - 1)
+    }
+  }
+
+  async get(args_orig) {
+    const args = JSON.parse(JSON.stringify(args_orig))
+    if (args.deleted === undefined) args.deleted = false
+
+    const include_subgroups = args.include_subgroups === true
+    delete args.include_subgroups
+
+    let query = `SELECT g.nt_group_id AS id
+        , g.parent_group_id AS parent_gid
+        , g.name
+        , g.deleted
+      FROM nt_group g`
+
+    const params = []
+    const where = []
+
+    if (args.id) {
+      if (include_subgroups) {
+        const subgroupRows = await Mysql.execute(
+          'SELECT nt_subgroup_id FROM nt_group_subgroups WHERE nt_group_id = ?',
+          [args.id]
+        )
+        const gids = [args.id, ...subgroupRows.map(r => r.nt_subgroup_id)]
+        where.push(`g.nt_group_id IN (${gids.join(',')})`)
+      } else {
+        where.push('g.nt_group_id = ?')
+        params.push(args.id)
+      }
+      delete args.id
+    }
+
+    if (args.parent_gid !== undefined) {
+      where.push('g.parent_group_id = ?')
+      params.push(args.parent_gid)
+      delete args.parent_gid
+    }
+
+    if (args.name) {
+      where.push('g.name = ?')
+      params.push(args.name)
+      delete args.name
+    }
+
+    if (args.deleted !== undefined) {
+      where.push('g.deleted = ?')
+      params.push(args.deleted ? 1 : 0)
+      delete args.deleted
+    }
+
+    if (where.length > 0) {
+      query += ` WHERE ${where.join(' AND ')}`
+    }
+
+    const groups = await Mysql.execute(query, params)
+
+    for (const row of groups) {
+      for (const b of boolFields) {
+        row[b] = row[b] === 1
+      }
+      if ([false, undefined].includes(args_orig.deleted)) delete row.deleted
+
+      const perm = await Permission.get({ gid: row.id })
+      if (perm) {
+        row.permissions = perm
+      }
+    }
+    return groups
+  }
+
+  async put(args) {
+    if (!args.id) return false
+    const id = args.id
+    delete args.id
+
+    const usable_ns = args.usable_ns
+    delete args.usable_ns
+
+    if (usable_ns !== undefined) {
+      const perm = await Permission.get({ gid: id })
+      if (perm) {
+        await Permission.put({
+          id: perm.id,
+          nameserver: { usable: Array.isArray(usable_ns) ? usable_ns : [] }
+        })
+      }
+    }
+
+    if (Object.keys(args).length === 0) return true
+
+    const r = await Mysql.execute(
+      ...Mysql.update(`nt_group`, `nt_group_id=${id}`, mapToDbColumn(args, groupDbMap)),
+    )
+    return r.changedRows === 1
+  }
+
+  async delete(args) {
+    const r = await Mysql.execute(
+      ...Mysql.update(`nt_group`, `nt_group_id=${args.id}`, {
+        deleted: args.deleted ?? 1,
+      }),
+    )
+    return r.changedRows === 1
+  }
+
+  async destroy(args) {
+    // Clean up associated permission rows before removing the group
+    await Mysql.execute(`DELETE FROM nt_perm WHERE nt_group_id = ? AND nt_user_id IS NULL`, [args.id])
+    const r = await Mysql.execute(...Mysql.delete(`nt_group`, { nt_group_id: args.id }))
+    return r.affectedRows === 1
+  }
+}
+
+export default new Group()

lib/group.js

@@ -1,9 +1,9 @@
 import assert from 'node:assert/strict'
 import { describe, it, after, before } from 'node:test'
 
-import Group from './group.js'
+import Group from './index.js'
 
-import testCase from './test/group.json' with { type: 'json' }
+import testCase from '../test/group.json' with { type: 'json' }
 
 after(async () => {
   Group.mysql.disconnect()
@@ -16,31 +16,25 @@ describe('group', function () {
 
   it('gets group by id', async () => {
     const g = await Group.get({ id: testCase.id })
-    assert.deepEqual(g[0], {
-      id: testCase.id,
-      name: testCase.name,
-      parent_gid: 0,
-    })
+    assert.equal(g[0].id, testCase.id)
+    assert.equal(g[0].name, testCase.name)
+    assert.equal(g[0].parent_gid, 0)
+    assert.ok(g[0].permissions, 'group has permissions')
   })
 
   it('gets group by name', async () => {
     const g = await Group.get({ name: testCase.name })
-    assert.deepEqual(g[0], {
-      id: testCase.id,
-      name: testCase.name,
-      parent_gid: 0,
-    })
+    assert.equal(g[0].id, testCase.id)
+    assert.equal(g[0].name, testCase.name)
+    assert.equal(g[0].parent_gid, 0)
+    assert.ok(g[0].permissions, 'group has permissions')
   })
 
   it('changes a group', async () => {
     assert.ok(await Group.put({ id: testCase.id, name: 'example.net' }))
-    assert.deepEqual(await Group.get({ id: testCase.id }), [
-      {
-        id: testCase.id,
-        name: 'example.net',
-        parent_gid: 0,
-      },
-    ])
+    const g = await Group.get({ id: testCase.id })
+    assert.equal(g[0].id, testCase.id)
+    assert.equal(g[0].name, 'example.net')
     assert.ok(await Group.put({ id: testCase.id, name: testCase.name }))
   })