@tak-ps/node-tak 12.28.0 → 12.30.0

package/dist/test/user-management.test.js

@@ -0,0 +1,158 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import { Readable } from 'node:stream';
+import { Client } from 'undici';
+import TAKAPI from '../lib/api.js';
+import { APIAuthCertificate } from '../lib/auth.js';
+function mockResponse(statusCode, contentType, body) {
+    return {
+        statusCode,
+        headers: { 'content-type': contentType },
+        body: Readable.from([Buffer.from(body)]),
+        trailers: {}
+    };
+}
+async function capture(fn, response = mockResponse(200, 'text/plain', '')) {
+    const originalRequest = Client.prototype.request;
+    let captured;
+    Client.prototype.request = async function (opts) {
+        captured = opts;
+        return response;
+    };
+    try {
+        const api = new TAKAPI(new URL('https://tak.example.com'), new APIAuthCertificate('cert', 'key'));
+        const result = await fn(api);
+        assert.ok(captured);
+        return { captured, result };
+    }
+    finally {
+        Client.prototype.request = originalRequest;
+    }
+}
+test('UserManagement.createUser posts a NewUserModel with defaulted group lists', async () => {
+    const { captured } = await capture((api) => api.UserManagement.createUser({
+        username: 'alice',
+        password: 'Sup3rSecret!',
+        groupListIN: ['Blue']
+    }));
+    assert.equal(captured.method, 'POST');
+    assert.equal(captured.path, '/Marti/api/user-management/api/new-user');
+    assert.deepEqual(JSON.parse(String(captured.body)), {
+        username: 'alice',
+        password: 'Sup3rSecret!',
+        groupList: [],
+        groupListIN: ['Blue'],
+        groupListOUT: []
+    });
+});
+test('UserManagement.createUsers posts a UserGenerationInBulkModel and returns generated credentials', async () => {
+    const { captured, result } = await capture((api) => api.UserManagement.createUsers({
+        usernameExpression: 'team-[N]',
+        startN: 1,
+        endN: 2,
+        groupList: ['Red']
+    }), mockResponse(200, 'application/json', JSON.stringify([
+        { username: 'team-1', password: 'p1' },
+        { username: 'team-2', password: 'p2' }
+    ])));
+    assert.equal(captured.method, 'POST');
+    assert.equal(captured.path, '/Marti/api/user-management/api/new-users');
+    assert.deepEqual(JSON.parse(String(captured.body)), {
+        usernameExpression: 'team-[N]',
+        startN: 1,
+        endN: 2,
+        groupList: ['Red'],
+        groupListIN: [],
+        groupListOUT: []
+    });
+    assert.deepEqual(result, [
+        { username: 'team-1', password: 'p1' },
+        { username: 'team-2', password: 'p2' }
+    ]);
+});
+test('UserManagement.listUsers gets list-users', async () => {
+    const { captured, result } = await capture((api) => api.UserManagement.listUsers(), mockResponse(200, 'application/json', JSON.stringify([{ username: 'alice' }])));
+    assert.equal(captured.method, 'GET');
+    assert.equal(captured.path, '/Marti/api/user-management/api/list-users');
+    assert.deepEqual(result, [{ username: 'alice' }]);
+});
+test('UserManagement.userGroups encodes the username in the path', async () => {
+    const { captured } = await capture((api) => api.UserManagement.userGroups('a b'), mockResponse(200, 'application/json', JSON.stringify({
+        username: 'a b', groupList: [], groupListIN: [], groupListOUT: []
+    })));
+    assert.equal(captured.method, 'GET');
+    assert.equal(captured.path, '/Marti/api/user-management/api/get-groups-for-user/a%20b');
+});
+test('UserManagement.changePassword puts a UserPasswordModel', async () => {
+    const { captured } = await capture((api) => api.UserManagement.changePassword({
+        username: 'alice',
+        password: 'N3wSecret!'
+    }));
+    assert.equal(captured.method, 'PUT');
+    assert.equal(captured.path, '/Marti/api/user-management/api/change-user-password');
+    assert.deepEqual(JSON.parse(String(captured.body)), {
+        username: 'alice',
+        password: 'N3wSecret!'
+    });
+});
+test('UserManagement.updateUserGroups puts a SimpleUserGroupModel', async () => {
+    const { captured } = await capture((api) => api.UserManagement.updateUserGroups({
+        username: 'alice',
+        groupList: ['Blue'],
+        groupListOUT: ['Red']
+    }));
+    assert.equal(captured.method, 'PUT');
+    assert.equal(captured.path, '/Marti/api/user-management/api/update-groups');
+    assert.deepEqual(JSON.parse(String(captured.body)), {
+        username: 'alice',
+        groupList: ['Blue'],
+        groupListIN: [],
+        groupListOUT: ['Red']
+    });
+});
+test('UserManagement.updateGroupUsers puts a SimpleGroupWithUsersModel', async () => {
+    const { captured } = await capture((api) => api.UserManagement.updateGroupUsers({
+        groupname: 'Blue',
+        usersInGroupListIN: ['alice', 'bob']
+    }));
+    assert.equal(captured.method, 'PUT');
+    assert.equal(captured.path, '/Marti/api/user-management/api/update-group-users');
+    assert.deepEqual(JSON.parse(String(captured.body)), {
+        groupname: 'Blue',
+        usersInGroupList: [],
+        usersInGroupListIN: ['alice', 'bob'],
+        usersInGroupListOUT: []
+    });
+});
+test('UserManagement.deleteUser deletes by encoded username', async () => {
+    const { captured } = await capture((api) => api.UserManagement.deleteUser('a/b'));
+    assert.equal(captured.method, 'DELETE');
+    assert.equal(captured.path, '/Marti/api/user-management/api/delete-user/a%2Fb');
+});
+test('UserManagement.listGroups gets list-groupnames', async () => {
+    const { captured, result } = await capture((api) => api.UserManagement.listGroups(), mockResponse(200, 'application/json', JSON.stringify([{ groupname: 'Blue' }])));
+    assert.equal(captured.method, 'GET');
+    assert.equal(captured.path, '/Marti/api/user-management/api/list-groupnames');
+    assert.deepEqual(result, [{ groupname: 'Blue' }]);
+});
+test('UserManagement.groupUsers gets users-in-group by encoded group name', async () => {
+    const { captured, result } = await capture((api) => api.UserManagement.groupUsers('Dark Blue'), mockResponse(200, 'application/json', JSON.stringify({
+        groupname: 'Dark Blue',
+        usersInGroupList: ['alice'],
+        usersInGroupListIN: [],
+        usersInGroupListOUT: ['bob']
+    })));
+    assert.equal(captured.method, 'GET');
+    assert.equal(captured.path, '/Marti/api/user-management/api/users-in-group/Dark%20Blue');
+    assert.deepEqual(result, {
+        groupname: 'Dark Blue',
+        usersInGroupList: ['alice'],
+        usersInGroupListIN: [],
+        usersInGroupListOUT: ['bob']
+    });
+});
+test('UserManagement.cli list-users formats usernames as lines', async () => {
+    const { result } = await capture((api) => api.UserManagement.cli({ _: ['tsx', 'cli.ts', 'user-management', 'list-users'] }), mockResponse(200, 'application/json', JSON.stringify([{ username: 'alice' }, { username: 'bob' }])));
+    assert.equal(result, 'alice\nbob');
+});
+//# sourceMappingURL=user-management.test.js.map

package/dist/test/user-management.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-management.test.js","sourceRoot":"","sources":["../../test/user-management.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,MAAM,MAAM,eAAe,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAIpD,SAAS,YAAY,CAAC,UAAkB,EAAE,WAAmB,EAAE,IAAY;IACvE,OAAO;QACH,UAAU;QACV,OAAO,EAAE,EAAE,cAAc,EAAE,WAAW,EAAE;QACxC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACxC,QAAQ,EAAE,EAAE;KACuB,CAAC;AAC5C,CAAC;AAED,KAAK,UAAU,OAAO,CAClB,EAAqC,EACrC,WAAoC,YAAY,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC;IAEvE,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;IAEjD,IAAI,QAAiC,CAAC;IAEtC,MAAM,CAAC,SAAS,CAAC,OAAO,GAAG,KAAK,WAAU,IAAiB;QACvD,QAAQ,GAAG,IAAI,CAAC;QAChB,OAAO,QAAQ,CAAC;IACpB,CAAC,CAAC;IAEF,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,yBAAyB,CAAC,EAAE,IAAI,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;QAClG,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAChC,CAAC;YAAS,CAAC;QACP,MAAM,CAAC,SAAS,CAAC,OAAO,GAAG,eAAe,CAAC;IAC/C,CAAC;AACL,CAAC;AAED,IAAI,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;IACzF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC;QACtE,QAAQ,EAAE,OAAO;QACjB,QAAQ,EAAE,cAAc;QACxB,WAAW,EAAE,CAAC,MAAM,CAAC;KACxB,CAAC,CAAC,CAAC;IAEJ,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,yCAAyC,CAAC,CAAC;IACvE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE;QAChD,QAAQ,EAAE,OAAO;QACjB,QAAQ,EAAE,cAAc;QACxB,SAAS,EAAE,EAAE;QACb,WAAW,EAAE,CAAC,MAAM,CAAC;QACrB,YAAY,EAAE,EAAE;KACnB,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gGAAgG,EAAE,KAAK,IAAI,EAAE;IAC9G,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,OAAO,CACtC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC;QACpC,kBAAkB,EAAE,UAAU;QAC9B,MAAM,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;QACP,SAAS,EAAE,CAAC,KAAK,CAAC;KACrB,CAAC,EACF,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC;QACjD,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACtC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KACzC,CAAC,CAAC,CACN,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,0CAA0C,CAAC,CAAC;IACxE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE;QAChD,kBAAkB,EAAE,UAAU;QAC9B,MAAM,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;QACP,SAAS,EAAE,CAAC,KAAK,CAAC;QAClB,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,EAAE;KACnB,CAAC,CAAC;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE;QACrB,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACtC,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KACzC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;IACxD,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,OAAO,CACtC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,SAAS,EAAE,EACvC,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CACjF,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,2CAA2C,CAAC,CAAC;IACzE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;IAC1E,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAC9B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,EAC7C,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC;QACjD,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE;KACpE,CAAC,CAAC,CACN,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,0DAA0D,CAAC,CAAC;AAC5F,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;IACtE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC;QAC1E,QAAQ,EAAE,OAAO;QACjB,QAAQ,EAAE,YAAY;KACzB,CAAC,CAAC,CAAC;IAEJ,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,qDAAqD,CAAC,CAAC;IACnF,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE;QAChD,QAAQ,EAAE,OAAO;QACjB,QAAQ,EAAE,YAAY;KACzB,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;IAC3E,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,gBAAgB,CAAC;QAC5E,QAAQ,EAAE,OAAO;QACjB,SAAS,EAAE,CAAC,MAAM,CAAC;QACnB,YAAY,EAAE,CAAC,KAAK,CAAC;KACxB,CAAC,CAAC,CAAC;IAEJ,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,8CAA8C,CAAC,CAAC;IAC5E,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE;QAChD,QAAQ,EAAE,OAAO;QACjB,SAAS,EAAE,CAAC,MAAM,CAAC;QACnB,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,CAAC,KAAK,CAAC;KACxB,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;IAChF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,gBAAgB,CAAC;QAC5E,SAAS,EAAE,MAAM;QACjB,kBAAkB,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;KACvC,CAAC,CAAC,CAAC;IAEJ,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,mDAAmD,CAAC,CAAC;IACjF,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE;QAChD,SAAS,EAAE,MAAM;QACjB,gBAAgB,EAAE,EAAE;QACpB,kBAAkB,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;QACpC,mBAAmB,EAAE,EAAE;KAC1B,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;IACrE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAElF,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,kDAAkD,CAAC,CAAC;AACpF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;IAC9D,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,OAAO,CACtC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,EACxC,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CACjF,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,gDAAgD,CAAC,CAAC;IAC9E,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;IACnF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,OAAO,CACtC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,EACnD,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC;QACjD,SAAS,EAAE,WAAW;QACtB,gBAAgB,EAAE,CAAC,OAAO,CAAC;QAC3B,kBAAkB,EAAE,EAAE;QACtB,mBAAmB,EAAE,CAAC,KAAK,CAAC;KAC/B,CAAC,CAAC,CACN,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,2DAA2D,CAAC,CAAC;IACzF,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE;QACrB,SAAS,EAAE,WAAW;QACtB,gBAAgB,EAAE,CAAC,OAAO,CAAC;QAC3B,kBAAkB,EAAE,EAAE;QACtB,mBAAmB,EAAE,CAAC,KAAK,CAAC;KAC/B,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;IACxE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,OAAO,CAC5B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,YAAY,CAAC,EAAE,CAAC,EAC1F,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CACtG,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AACvC,CAAC,CAAC,CAAC"}

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../cli.ts","../index.ts","../test/certificate.test.ts","../test/default.test.ts","../test/findCoT.test.ts","../test/html-error.test.ts","../test/mission-layer.test.ts","../test/mission.test.ts","../test/pipeline.test.ts","../test/queue.test.ts","../test/uploadPackage.test.ts","../lib/api.ts","../lib/auth.ts","../lib/commands.ts","../lib/fetch.ts","../lib/multipart.ts","../lib/stream.ts","../lib/api/certificate.ts","../lib/api/client.ts","../lib/api/contacts.ts","../lib/api/credentials.ts","../lib/api/export.ts","../lib/api/files.ts","../lib/api/groups.ts","../lib/api/iconsets.ts","../lib/api/injectors.ts","../lib/api/locate.ts","../lib/api/mission-invite.ts","../lib/api/mission-layer.ts","../lib/api/mission-log.ts","../lib/api/mission.ts","../lib/api/oauth.ts","../lib/api/package.ts","../lib/api/profile.ts","../lib/api/query.ts","../lib/api/repeater.ts","../lib/api/security.ts","../lib/api/subscriptions.ts","../lib/api/types.ts","../lib/api/video.ts","../lib/utils/html-error.ts","../lib/utils/queue.ts"],"version":"6.0.3"}
+{"root":["../cli.ts","../index.ts","../test/certificate.test.ts","../test/default.test.ts","../test/findCoT.test.ts","../test/html-error.test.ts","../test/mission-layer.test.ts","../test/mission.test.ts","../test/pipeline.test.ts","../test/queue.test.ts","../test/uploadPackage.test.ts","../test/user-management.test.ts","../lib/api.ts","../lib/auth.ts","../lib/commands.ts","../lib/fetch.ts","../lib/multipart.ts","../lib/stream.ts","../lib/api/certificate.ts","../lib/api/client.ts","../lib/api/contacts.ts","../lib/api/credentials.ts","../lib/api/export.ts","../lib/api/files.ts","../lib/api/groups.ts","../lib/api/iconsets.ts","../lib/api/injectors.ts","../lib/api/locate.ts","../lib/api/mission-invite.ts","../lib/api/mission-layer.ts","../lib/api/mission-log.ts","../lib/api/mission.ts","../lib/api/oauth.ts","../lib/api/package.ts","../lib/api/profile.ts","../lib/api/query.ts","../lib/api/repeater.ts","../lib/api/security.ts","../lib/api/subscriptions.ts","../lib/api/types.ts","../lib/api/user-management.ts","../lib/api/video.ts","../lib/utils/html-error.ts","../lib/utils/queue.ts"],"version":"6.0.3"}

package/lib/api/files.ts

@@ -175,6 +175,8 @@ export default class FileCommands extends Commands {
         contentType?: string;
         keywords: string[];
         creatorUid: string;
+        /** UID metadata - TAK clients treat a Mission file whose UID matches a map item as an attachment of that item */
+        uid?: string;
         latitude?: string;
         longitude?: string;
         altitude?: string;
@@ -183,6 +185,7 @@ export default class FileCommands extends Commands {
         url.searchParams.append('name', opts.name)
         url.searchParams.append('keywords', opts.keywords.join(','))
         url.searchParams.append('creatorUid', opts.creatorUid)
+        if (opts.uid) url.searchParams.append('uid', opts.uid);
         if (opts.altitude) url.searchParams.append('altitude', opts.altitude);
         if (opts.longitude) url.searchParams.append('longitude', opts.longitude);
         if (opts.latitude) url.searchParams.append('latitude', opts.latitude);

package/lib/api/mission.ts

@@ -200,6 +200,8 @@ export const MissionListInput = Type.Object({
     ascending: Type.Optional(Type.Boolean({ description: 'Sort direction (default true)' })),
     nameFilter: Type.Optional(Type.String({ description: 'Filter by mission name' })),
     uidFilter: Type.Optional(Type.String({ description: 'Filter by mission uid' })),
+    keywordFilter: Type.Optional(Type.Union([Type.Array(Type.String()), Type.String()], { description: 'Filter by one or more mission keywords' })),
+    groupFilter: Type.Optional(Type.Union([Type.Array(Type.String()), Type.String()], { description: 'Filter by one or more mission groups' })),
 });
 
 export const MissionCreateInput = Type.Object({
@@ -715,7 +717,8 @@ export default class MissionCommands extends Commands {
      * List missions in currently active channels
      *
      * Pass `paged: true` to use the paged endpoint (`GET /Marti/api/pagedmissions`) which
-     * additionally supports `page`, `pagesize`, `sort`, `ascending`, `nameFilter` & `uidFilter`.
+     * additionally supports `page`, `pagesize`, `sort`, `ascending`, `nameFilter`, `uidFilter`,
+     * `keywordFilter` & `groupFilter`.
      *
      * {@link https://docs.tak.gov/api/takserver/redoc#tag/mission-api/operation/getAllMissions_1 TAK Server Docs}.
      */
@@ -728,8 +731,18 @@ export default class MissionCommands extends Commands {
 
         let q: keyof typeof params;
         for (q in params) {
-            if (params[q] !== undefined) {
-                url.searchParams.append(q, String(params[q]));
+            const value = params[q];
+
+            if (value === undefined) continue;
+
+            if (Array.isArray(value)) {
+                // `keywordFilter` & `groupFilter` are repeatable
+                // (eg `?keywordFilter=a&keywordFilter=b`).
+                for (const v of value) {
+                    url.searchParams.append(q, String(v));
+                }
+            } else {
+                url.searchParams.append(q, String(value));
             }
         }
 

package/lib/api/user-management.ts

@@ -0,0 +1,326 @@
+import { Type, Static } from '@sinclair/typebox';
+import Commands, { CommandOutputFormat, type ParsedArgs } from '../commands.js';
+
+const GroupLists = {
+    groupList: Type.Optional(Type.Array(Type.String())),
+    groupListIN: Type.Optional(Type.Array(Type.String())),
+    groupListOUT: Type.Optional(Type.Array(Type.String()))
+};
+
+export const UserManagementUsername = Type.Object({
+    username: Type.String()
+});
+
+export const UserManagementGroupName = Type.Object({
+    groupname: Type.String()
+});
+
+export const UserManagementNewUser = Type.Object({
+    username: Type.String(),
+    password: Type.String(),
+    ...GroupLists
+});
+
+export const UserManagementBulkUsers = Type.Object({
+    usernameExpression: Type.String({ description: 'Username pattern containing [N] which is replaced by each integer from startN to endN' }),
+    startN: Type.Integer(),
+    endN: Type.Integer(),
+    ...GroupLists
+});
+
+export const UserManagementUserPassword = Type.Object({
+    username: Type.String(),
+    password: Type.String()
+});
+
+export const UserManagementUserGroups = Type.Object({
+    username: Type.String(),
+    ...GroupLists
+});
+
+export const UserManagementGroupUsers = Type.Object({
+    groupname: Type.String(),
+    usersInGroupList: Type.Optional(Type.Array(Type.String())),
+    usersInGroupListIN: Type.Optional(Type.Array(Type.String())),
+    usersInGroupListOUT: Type.Optional(Type.Array(Type.String()))
+});
+
+export const UserManagementList_Username = Type.Array(UserManagementUsername);
+export const UserManagementList_GroupName = Type.Array(UserManagementGroupName);
+export const UserManagementList_UserPassword = Type.Array(UserManagementUserPassword);
+
+export const UserManagementUserGroupsResponse = Type.Object({
+    username: Type.String(),
+    groupList: Type.Array(Type.String()),
+    groupListIN: Type.Array(Type.String()),
+    groupListOUT: Type.Array(Type.String())
+});
+
+export const UserManagementGroupUsersResponse = Type.Object({
+    groupname: Type.String(),
+    usersInGroupList: Type.Array(Type.String()),
+    usersInGroupListIN: Type.Array(Type.String()),
+    usersInGroupListOUT: Type.Array(Type.String())
+});
+
+/**
+ * Manage File (non-LDAP) User Accounts on TAK Server
+ *
+ * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api TAK Server Docs}.
+ */
+export default class UserManagementCommands extends Commands {
+    schema = {
+        'list-users': {
+            description: 'List File Users',
+            params: Type.Object({}),
+            query: Type.Object({}),
+            formats: [ CommandOutputFormat.JSON ]
+        },
+        'list-groups': {
+            description: 'List Group Names used by File Users',
+            params: Type.Object({}),
+            query: Type.Object({}),
+            formats: [ CommandOutputFormat.JSON ]
+        },
+        'user-groups': {
+            description: 'List Groups for a given File User',
+            params: Type.Object({ username: Type.String() }),
+            query: Type.Object({}),
+            formats: [ CommandOutputFormat.JSON ]
+        },
+        'group-users': {
+            description: 'List File Users in a given Group',
+            params: Type.Object({ group: Type.String() }),
+            query: Type.Object({}),
+            formats: [ CommandOutputFormat.JSON ]
+        },
+        'delete-user': {
+            description: 'Delete a File User',
+            params: Type.Object({ username: Type.String() }),
+            query: Type.Object({}),
+            formats: [ CommandOutputFormat.JSON ]
+        }
+    }
+
+    async cli(args: ParsedArgs): Promise<object | string> {
+        if (args._[3] === 'list-users') {
+            const list = await this.listUsers();
+
+            if (args.format === 'json') {
+                return list;
+            } else {
+                return list.map((user) => user.username).join('\n');
+            }
+        } else if (args._[3] === 'list-groups') {
+            const list = await this.listGroups();
+
+            if (args.format === 'json') {
+                return list;
+            } else {
+                return list.map((group) => group.groupname).join('\n');
+            }
+        } else if (args._[3] === 'user-groups') {
+            if (!args._[4]) throw new Error('username must be provided');
+
+            const user = await this.userGroups(args._[4]);
+
+            if (args.format === 'json') {
+                return user;
+            } else {
+                return [
+                    `${user.username}`,
+                    `  BOTH: ${user.groupList.join(', ')}`,
+                    `  IN:   ${user.groupListIN.join(', ')}`,
+                    `  OUT:  ${user.groupListOUT.join(', ')}`
+                ].join('\n');
+            }
+        } else if (args._[3] === 'group-users') {
+            if (!args._[4]) throw new Error('group must be provided');
+
+            const group = await this.groupUsers(args._[4]);
+
+            if (args.format === 'json') {
+                return group;
+            } else {
+                return [
+                    `${group.groupname}`,
+                    `  BOTH: ${group.usersInGroupList.join(', ')}`,
+                    `  IN:   ${group.usersInGroupListIN.join(', ')}`,
+                    `  OUT:  ${group.usersInGroupListOUT.join(', ')}`
+                ].join('\n');
+            }
+        } else if (args._[3] === 'delete-user') {
+            if (!args._[4]) throw new Error('username must be provided');
+
+            await this.deleteUser(args._[4]);
+
+            return `Deleted ${args._[4]}`;
+        } else {
+            throw new Error('Unsupported Subcommand');
+        }
+    }
+
+    /**
+     * Create a new File User
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/createOrUpdateFileUser TAK Server Docs}.
+     */
+    async createUser(user: Static<typeof UserManagementNewUser>): Promise<void> {
+        const url = new URL('/Marti/api/user-management/api/new-user', this.api.url);
+
+        await this.api.fetch(url, {
+            method: 'POST',
+            body: {
+                username: user.username,
+                password: user.password,
+                groupList: user.groupList ?? [],
+                groupListIN: user.groupListIN ?? [],
+                groupListOUT: user.groupListOUT ?? []
+            }
+        });
+    }
+
+    /**
+     * Create File Users in bulk from a username expression containing `[N]`
+     * Passwords are generated by the server and only returned once
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/createFileUsersInBulk TAK Server Docs}.
+     */
+    async createUsers(
+        bulk: Static<typeof UserManagementBulkUsers>
+    ): Promise<Static<typeof UserManagementList_UserPassword>> {
+        const url = new URL('/Marti/api/user-management/api/new-users', this.api.url);
+
+        return await this.api.fetch(url, {
+            method: 'POST',
+            body: {
+                usernameExpression: bulk.usernameExpression,
+                startN: bulk.startN,
+                endN: bulk.endN,
+                groupList: bulk.groupList ?? [],
+                groupListIN: bulk.groupListIN ?? [],
+                groupListOUT: bulk.groupListOUT ?? []
+            }
+        });
+    }
+
+    /**
+     * List all File Users
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/getAllUsers_3 TAK Server Docs}.
+     */
+    async listUsers(): Promise<Static<typeof UserManagementList_Username>> {
+        const url = new URL('/Marti/api/user-management/api/list-users', this.api.url);
+
+        return await this.api.fetch(url, {
+            method: 'GET'
+        });
+    }
+
+    /**
+     * Get the Groups associated with a File User
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/getGroupsForUsers TAK Server Docs}.
+     */
+    async userGroups(username: string): Promise<Static<typeof UserManagementUserGroupsResponse>> {
+        const url = new URL(`/Marti/api/user-management/api/get-groups-for-user/${encodeURIComponent(username)}`, this.api.url);
+
+        return await this.api.fetch(url, {
+            method: 'GET'
+        });
+    }
+
+    /**
+     * Change the password of a File User
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/changeUserPassword TAK Server Docs}.
+     */
+    async changePassword(user: Static<typeof UserManagementUserPassword>): Promise<void> {
+        const url = new URL('/Marti/api/user-management/api/change-user-password', this.api.url);
+
+        await this.api.fetch(url, {
+            method: 'PUT',
+            body: {
+                username: user.username,
+                password: user.password
+            }
+        });
+    }
+
+    /**
+     * Replace the Groups associated with a File User
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/updateGroupsForUser TAK Server Docs}.
+     */
+    async updateUserGroups(user: Static<typeof UserManagementUserGroups>): Promise<void> {
+        const url = new URL('/Marti/api/user-management/api/update-groups', this.api.url);
+
+        await this.api.fetch(url, {
+            method: 'PUT',
+            body: {
+                username: user.username,
+                groupList: user.groupList ?? [],
+                groupListIN: user.groupListIN ?? [],
+                groupListOUT: user.groupListOUT ?? []
+            }
+        });
+    }
+
+    /**
+     * Replace the File Users associated with a Group
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/updateUsersForGroup TAK Server Docs}.
+     */
+    async updateGroupUsers(group: Static<typeof UserManagementGroupUsers>): Promise<void> {
+        const url = new URL('/Marti/api/user-management/api/update-group-users', this.api.url);
+
+        await this.api.fetch(url, {
+            method: 'PUT',
+            body: {
+                groupname: group.groupname,
+                usersInGroupList: group.usersInGroupList ?? [],
+                usersInGroupListIN: group.usersInGroupListIN ?? [],
+                usersInGroupListOUT: group.usersInGroupListOUT ?? []
+            }
+        });
+    }
+
+    /**
+     * Delete a File User
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/deleteUser_1 TAK Server Docs}.
+     */
+    async deleteUser(username: string): Promise<void> {
+        const url = new URL(`/Marti/api/user-management/api/delete-user/${encodeURIComponent(username)}`, this.api.url);
+
+        await this.api.fetch(url, {
+            method: 'DELETE'
+        });
+    }
+
+    /**
+     * List all Group Names used by File Users
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/getAllGroupNames TAK Server Docs}.
+     */
+    async listGroups(): Promise<Static<typeof UserManagementList_GroupName>> {
+        const url = new URL('/Marti/api/user-management/api/list-groupnames', this.api.url);
+
+        return await this.api.fetch(url, {
+            method: 'GET'
+        });
+    }
+
+    /**
+     * Get the File Users in a Group along with their IN/OUT/BOTH direction
+     *
+     * {@link https://docs.tak.gov/api/takserver#tag/file-user-account-management-api/operation/getUsersInGroup TAK Server Docs}.
+     */
+    async groupUsers(group: string): Promise<Static<typeof UserManagementGroupUsersResponse>> {
+        const url = new URL(`/Marti/api/user-management/api/users-in-group/${encodeURIComponent(group)}`, this.api.url);
+
+        return await this.api.fetch(url, {
+            method: 'GET'
+        });
+    }
+}

package/lib/api.ts

@@ -20,6 +20,7 @@ import Group from './api/groups.js';
 import Subscription from './api/subscriptions.js';
 import Video from './api/video.js';
 import Export from './api/export.js';
+import UserManagement from './api/user-management.js';
 import Err from '@openaddresses/batch-error';
 import { TAKServerError, isHTML } from './utils/html-error.js';
 import * as auth from './auth.js';
@@ -88,7 +89,8 @@ export const CommandList: Record<string, keyof TAKAPI> = {
     video: 'Video',
     export: 'Export',
     query: 'Query',
-    file: 'Files'
+    file: 'Files',
+    'user-management': 'UserManagement'
 }
 
 /**
@@ -120,6 +122,7 @@ export default class TAKAPI {
     Export: Export;
     Query: Query;
     Files: Files;
+    UserManagement: UserManagement;
 
     constructor(url: URL, auth: auth.APIAuth) {
         this.url = url;
@@ -147,6 +150,7 @@ export default class TAKAPI {
         this.Injectors = new Injectors(this);
         this.Repeater = new Repeater(this);
         this.Files = new Files(this);
+        this.UserManagement = new UserManagement(this);
     }
 
     static async init(url: URL, auth: auth.APIAuth): Promise<TAKAPI> {
@@ -256,6 +260,7 @@ export {
     Subscription,
     Video,
     Export,
+    UserManagement,
     MissionSubscriberRole,
     MissionLayerType,
     MissionInviteType

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@tak-ps/node-tak",
     "type": "module",
-    "version": "12.28.0",
+    "version": "12.30.0",
     "description": "Lightweight JavaScript library for communicating with TAK Server",
     "author": "Nick Ingalls <nick@ingalls.ca>",
     "main": "dist/index.js",

package/test/mission.test.ts

@@ -259,3 +259,35 @@ test('Mission.list with paged: true uses the pagedmissions endpoint', async () =
         Client.prototype.request = originalRequest;
     }
 });
+
+test('Mission.list serializes keywordFilter & groupFilter as repeated params', async () => {
+    const originalRequest = Client.prototype.request;
+
+    let captured: RequestArgs | undefined;
+
+    Client.prototype.request = async function(opts: RequestArgs): Promise<Dispatcher.ResponseData> {
+        captured = opts;
+        return mockResponse(200, 'application/json', JSON.stringify({
+            version: '3', type: 'Mission', data: []
+        }));
+    };
+
+    try {
+        const api = new TAKAPI(new URL('https://tak.example.com'), new APIAuthCertificate('cert', 'key'));
+
+        await api.Mission.list({
+            paged: true,
+            keywordFilter: ['fire', 'flood'],
+            groupFilter: '__ANON__'
+        });
+
+        assert.ok(captured);
+        assert.equal(captured.method, 'GET');
+        assert.equal(
+            captured.path,
+            '/Marti/api/pagedmissions?keywordFilter=fire&keywordFilter=flood&groupFilter=__ANON__'
+        );
+    } finally {
+        Client.prototype.request = originalRequest;
+    }
+});