@sasjs/api 0.6.0 → 0.7.0

package/build/esm/identity/memory-store.js

@@ -39,9 +39,12 @@ const live = (issued, now) => issued && (issued.expiresAt === undefined || issue
  */
 export class MemoryIdentityStore {
     constructor(fixture = DEFAULT_IDENTITY) {
-        this.users = [];
+        this.userList = [];
         this.passwords = new Map();
-        this.clients = new Map();
+        this.groupList = new Map();
+        this.permissionList = new Map();
+        this.clientRecords = new Map();
+        this.clientMap = new Map();
         this.pairs = new Map();
         this.access = new Map();
         this.refresh = new Map();
@@ -50,24 +53,60 @@ export class MemoryIdentityStore {
         if (fixture.format !== IDENTITY_FORMAT)
             throw new ApiError(500, `The identity fixture states format ${String(fixture.format)}; this store reads ${IDENTITY_FORMAT}.`);
         for (const user of fixture.users) {
-            this.users.push({
+            this.userList.push({
                 uid: user.uid,
                 username: user.username,
                 displayName: user.displayName,
                 isAdmin: user.isAdmin,
                 isActive: user.isActive,
-                needsToUpdatePassword: user.needsToUpdatePassword
+                needsToUpdatePassword: user.needsToUpdatePassword,
+                authProvider: user.authProvider,
+                autoExec: user.autoExec
             });
             this.passwords.set(user.uid, user.password);
         }
-        for (const client of fixture.clients)
-            this.clients.set(client.clientId, {
+        for (const client of fixture.clients) {
+            this.clientMap.set(client.clientId, {
                 clientId: client.clientId,
                 accessTokenExpiration: client.accessTokenExpiration,
                 refreshTokenExpiration: client.refreshTokenExpiration
             });
+            this.clientRecords.set(client.clientId, {
+                clientId: client.clientId,
+                clientSecret: client.clientSecret,
+                accessTokenExpiration: client.accessTokenExpiration,
+                refreshTokenExpiration: client.refreshTokenExpiration
+            });
+        }
+        for (const group of fixture.groups) {
+            const uid = group.uid;
+            this.groupList.set(uid, {
+                uid,
+                name: group.name,
+                description: group.description,
+                isActive: group.isActive,
+                authProvider: group.authProvider,
+                users: group.users
+                    .map((username) => this.userList.find((user) => user.username === username)?.uid)
+                    .filter((member) => member !== undefined)
+            });
+        }
+        for (const permission of fixture.permissions) {
+            this.permissionList.set(permission.uid, {
+                uid: permission.uid,
+                path: permission.path,
+                type: permission.type,
+                setting: permission.setting,
+                user: permission.user
+                    ? this.userList.find((user) => user.uid === permission.user)?.uid
+                    : undefined,
+                group: permission.group
+                    ? this.groupList.get(permission.group)?.uid
+                    : undefined
+            });
+        }
         for (const token of fixture.tokens || []) {
-            const user = this.users.find((candidate) => candidate.username === token.username);
+            const user = this.userList.find((candidate) => candidate.username === token.username);
             if (!user)
                 continue;
             const subject = { userId: user.uid, clientId: token.clientId };
@@ -84,7 +123,7 @@ export class MemoryIdentityStore {
                 });
         }
         for (const code of fixture.codes || []) {
-            const user = this.users.find((candidate) => candidate.username === code.username);
+            const user = this.userList.find((candidate) => candidate.username === code.username);
             if (!user)
                 continue;
             this.codes.set(code.code, {
@@ -93,17 +132,19 @@ export class MemoryIdentityStore {
         }
     }
     async userByName(username) {
-        return this.users.find((user) => user.username === username);
+        const user = this.userList.find((candidate) => candidate.username === username);
+        return user ? this.recordOf(user) : undefined;
     }
     async userById(uid) {
-        return this.users.find((user) => user.uid === uid);
+        const user = this.userList.find((candidate) => candidate.uid === uid);
+        return user ? this.recordOf(user) : undefined;
     }
     /** A fixture holds the password in clear, so the check is an equality. */
     async passwordMatches(user, password) {
         return this.passwords.get(user.uid) === password;
     }
     async client(clientId) {
-        return this.clients.get(clientId);
+        return this.clientMap.get(clientId);
     }
     async issue(subject, client) {
         // The lifetimes are the client's, recorded against the instant of issue: a
@@ -188,4 +229,148 @@ export class MemoryIdentityStore {
         this.claimed.add(code);
         return true;
     }
+    // ---------------------------------------------------------------- records
+    async users() {
+        return this.userList.map((user) => this.recordOf(user));
+    }
+    /** A user as the administration routes report one: groups derived, not stored. */
+    recordOf(user) {
+        return {
+            ...user,
+            groups: [...this.groupList.values()]
+                .filter((group) => group.users.includes(user.uid))
+                .map((group) => group.uid)
+        };
+    }
+    async createUser(input) {
+        const user = {
+            uid: `user-${randomHex(6)}`,
+            username: input.username,
+            displayName: input.displayName,
+            isAdmin: input.isAdmin,
+            isActive: input.isActive,
+            needsToUpdatePassword: false,
+            autoExec: input.autoExec,
+            authProvider: input.authProvider
+        };
+        this.userList.push(user);
+        return this.recordOf(user);
+    }
+    async updateUser(uid, change) {
+        const user = this.userList.find((candidate) => candidate.uid === uid);
+        if (!user)
+            return undefined;
+        if (change.username !== undefined)
+            user.username = change.username;
+        if (change.displayName !== undefined)
+            user.displayName = change.displayName;
+        if (change.isAdmin !== undefined)
+            user.isAdmin = change.isAdmin;
+        if (change.isActive !== undefined)
+            user.isActive = change.isActive;
+        if (change.needsToUpdatePassword !== undefined)
+            user.needsToUpdatePassword = change.needsToUpdatePassword;
+        if (change.autoExec !== undefined)
+            user.autoExec = change.autoExec;
+        return this.recordOf(user);
+    }
+    async deleteUser(uid) {
+        const index = this.userList.findIndex((user) => user.uid === uid);
+        if (index === -1)
+            return;
+        this.userList.splice(index, 1);
+        this.passwords.delete(uid);
+        for (const group of this.groupList.values())
+            group.users = group.users.filter((member) => member !== uid);
+        for (const [key, permission] of this.permissionList)
+            if (permission.user === uid)
+                this.permissionList.delete(key);
+        for (const key of this.pairs.keys())
+            if (key.startsWith(`${uid}|`))
+                this.pairs.delete(key);
+    }
+    async setPassword(uid, password) {
+        this.passwords.set(uid, password);
+    }
+    async groups() {
+        return [...this.groupList.values()];
+    }
+    async groupById(uid) {
+        return this.groupList.get(uid);
+    }
+    async groupByName(name) {
+        return [...this.groupList.values()].find((group) => group.name === name);
+    }
+    async createGroup(input) {
+        const group = {
+            uid: `group-${randomHex(6)}`,
+            name: input.name,
+            description: input.description,
+            isActive: input.isActive,
+            users: []
+        };
+        this.groupList.set(group.uid, group);
+        return group;
+    }
+    async deleteGroup(uid) {
+        this.groupList.delete(uid);
+        for (const [key, permission] of this.permissionList)
+            if (permission.group === uid)
+                this.permissionList.delete(key);
+    }
+    async addToGroup(groupUid, userUid) {
+        const group = this.groupList.get(groupUid);
+        if (!group)
+            return undefined;
+        if (!group.users.includes(userUid))
+            group.users.push(userUid);
+        return group;
+    }
+    async removeFromGroup(groupUid, userUid) {
+        const group = this.groupList.get(groupUid);
+        if (!group)
+            return undefined;
+        group.users = group.users.filter((member) => member !== userUid);
+        return group;
+    }
+    async permissions() {
+        return [...this.permissionList.values()];
+    }
+    async permissionById(uid) {
+        return this.permissionList.get(uid);
+    }
+    async createPermission(input) {
+        const permission = {
+            uid: `rule-${randomHex(6)}`,
+            path: input.path,
+            type: input.type,
+            setting: input.setting,
+            user: input.user,
+            group: input.group
+        };
+        this.permissionList.set(permission.uid, permission);
+        return permission;
+    }
+    async setPermissionSetting(uid, setting) {
+        const permission = this.permissionList.get(uid);
+        if (!permission)
+            return undefined;
+        permission.setting = setting;
+        return permission;
+    }
+    async deletePermission(uid) {
+        this.permissionList.delete(uid);
+    }
+    async clients() {
+        return [...this.clientRecords.values()];
+    }
+    async createClient(input) {
+        this.clientRecords.set(input.clientId, input);
+        this.clientMap.set(input.clientId, {
+            clientId: input.clientId,
+            accessTokenExpiration: input.accessTokenExpiration,
+            refreshTokenExpiration: input.refreshTokenExpiration
+        });
+        return input;
+    }
 }

package/build/esm/identity/records.d.ts

@@ -0,0 +1,102 @@
+import type { IdentityClientRecord, IdentityStore, Subject } from './types.js';
+/** The body a client reads for a user, as the server's controllers return it. */
+export interface UserResponse {
+    uid: string;
+    username: string;
+    displayName: string;
+    isAdmin: boolean;
+}
+export interface UserDetailsResponse extends UserResponse {
+    isActive: boolean;
+    needsToUpdatePassword: boolean;
+    autoExec?: string;
+    groups?: {
+        uid: string;
+        name: string;
+        description: string;
+    }[];
+}
+export interface GroupResponse {
+    uid: string;
+    name: string;
+    description: string;
+}
+export interface GroupDetailsResponse extends GroupResponse {
+    isActive: boolean;
+    users: UserResponse[];
+}
+export interface PermissionResponse {
+    uid: string;
+    path: string;
+    type: string;
+    setting: string;
+    user?: UserResponse;
+    group?: GroupDetailsResponse;
+}
+export interface RecordService {
+    listUsers(caller: Subject | undefined): Promise<UserResponse[]>;
+    getUser(caller: Subject | undefined, by: {
+        uid?: string;
+        username?: string;
+    }): Promise<UserDetailsResponse>;
+    createUser(caller: Subject | undefined, body: {
+        username: string;
+        displayName: string;
+        password: string;
+        isAdmin?: boolean;
+        isActive?: boolean;
+        autoExec?: string;
+    }): Promise<UserDetailsResponse>;
+    updateUser(caller: Subject | undefined, by: {
+        uid?: string;
+        username?: string;
+    }, body: {
+        username?: string;
+        displayName?: string;
+        password?: string;
+        isAdmin?: boolean;
+        isActive?: boolean;
+        autoExec?: string;
+    }): Promise<UserDetailsResponse>;
+    deleteUser(caller: Subject | undefined, by: {
+        uid?: string;
+        username?: string;
+    }, body: {
+        password?: string;
+    }): Promise<void>;
+    listGroups(caller: Subject | undefined): Promise<GroupResponse[]>;
+    getGroup(caller: Subject | undefined, by: {
+        uid?: string;
+        name?: string;
+    }): Promise<GroupDetailsResponse>;
+    createGroup(caller: Subject | undefined, body: {
+        name: string;
+        description: string;
+        isActive?: boolean;
+    }): Promise<GroupDetailsResponse>;
+    deleteGroup(caller: Subject | undefined, uid: string): Promise<void>;
+    addUserToGroup(caller: Subject | undefined, groupUid: string, userUid: string): Promise<GroupDetailsResponse>;
+    removeUserFromGroup(caller: Subject | undefined, groupUid: string, userUid: string): Promise<GroupDetailsResponse>;
+    listPermissions(caller: Subject | undefined): Promise<PermissionResponse[]>;
+    createPermission(caller: Subject | undefined, body: {
+        path: string;
+        type: string;
+        setting: string;
+        principalType: string;
+        principalId: string;
+    }): Promise<PermissionResponse>;
+    updatePermission(caller: Subject | undefined, uid: string, body: {
+        setting: string;
+    }): Promise<PermissionResponse>;
+    deletePermission(caller: Subject | undefined, uid: string): Promise<void>;
+    listClients(caller: Subject | undefined): Promise<IdentityClientRecord[]>;
+    createClient(caller: Subject | undefined, body: IdentityClientRecord): Promise<IdentityClientRecord>;
+    /** `PATCH /SASjsApi/auth/updatePassword`, the caller's own password. */
+    updatePassword(caller: Subject | undefined, body: {
+        currentPassword: string;
+        newPassword: string;
+    }): Promise<void>;
+}
+export declare const sanitiseDisplayName: (value: unknown) => string;
+export declare const createRecordService: (store: IdentityStore) => RecordService;
+//# sourceMappingURL=records.d.ts.map

package/build/esm/identity/records.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../../../src/identity/records.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,oBAAoB,EAGpB,aAAa,EAEb,OAAO,EACR,MAAM,YAAY,CAAA;AAEnB,iFAAiF;AACjF,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,QAAQ,EAAE,OAAO,CAAA;IACjB,qBAAqB,EAAE,OAAO,CAAA;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAC9D;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,EAAE,OAAO,CAAA;IACjB,KAAK,EAAE,YAAY,EAAE,CAAA;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB,KAAK,CAAC,EAAE,oBAAoB,CAAA;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAC/D,OAAO,CACL,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GACtC,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC/B,UAAU,CACR,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAA;QAChB,WAAW,EAAE,MAAM,CAAA;QACnB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,GACA,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC/B,UAAU,CACR,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EACvC,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,GACA,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC/B,UAAU,CACR,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EACvC,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1B,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAA;IACjE,QAAQ,CACN,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAClC,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAChC,WAAW,CACT,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAC9D,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAChC,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpE,cAAc,CACZ,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAChC,mBAAmB,CACjB,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAA;IAC3E,gBAAgB,CACd,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,aAAa,EAAE,MAAM,CAAA;QACrB,WAAW,EAAE,MAAM,CAAA;KACpB,GACA,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAC9B,gBAAgB,CACd,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GACxB,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAC9B,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzE,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAA;IACzE,YAAY,CACV,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC,wEAAwE;IACxE,cAAc,CACZ,MAAM,EAAE,OAAO,GAAG,SAAS,EAC3B,IAAI,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GACrD,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAiED,eAAO,MAAM,mBAAmB,GAAI,OAAO,OAAO,KAAG,MAKf,CAAA;AAetC,eAAO,MAAM,mBAAmB,GAAI,OAAO,aAAa,KAAG,aA2Z1D,CAAA"}