@researchdatabox/redbox-core 0.0.0-bootstrap.0

package/dist/services/UsersService.d.ts

@@ -0,0 +1,174 @@
+import { Observable } from 'rxjs';
+import { BrandingModel } from '../model/storage/BrandingModel';
+import { RoleModel } from '../model/storage/RoleModel';
+import { SearchService } from '../SearchService';
+import { UserModel } from '../model/storage/UserModel';
+import { UserAttributes } from '../waterline-models/User';
+import { Services as services } from '../CoreService';
+export declare namespace Services {
+    type AnyRecord = Record<string, unknown>;
+    type DoneCallback = (err: unknown, user?: unknown, info?: unknown) => void;
+    interface LinkedUserSummary {
+        id: string;
+        username: string;
+        name: string;
+        email: string;
+        type: string;
+        accountLinkState: string;
+        linkedAt?: string | Date;
+    }
+    interface UserLinkResponse {
+        primary: LinkedUserSummary;
+        linkedAccounts: LinkedUserSummary[];
+        impact?: {
+            recordsRewritten: number;
+            rolesMerged: number;
+        };
+    }
+    interface UserAuditActor {
+        username: string;
+        name?: string;
+        email?: string;
+    }
+    interface UserAuditRecord {
+        id: string;
+        timestamp: string | null;
+        action: string;
+        actor: UserAuditActor;
+        details: string;
+        parsedAdditionalContext: unknown;
+        rawAdditionalContext: string | null;
+        parseError: boolean;
+    }
+    interface UserAuditSummary {
+        returnedCount: number;
+        truncated: boolean;
+    }
+    interface UserAuditResponse {
+        records: UserAuditRecord[];
+        summary: UserAuditSummary;
+    }
+    /**
+     * Use services...
+     *
+     *
+     * Author: <a href='https://github.com/shilob' target='_blank'>Shilo Banihit</a>
+     *
+     */
+    export class Users extends services.Core.Service {
+        protected _exportedMethods: string[];
+        searchService: SearchService;
+        private getAuthConfig;
+        private normalizeAccountLinkState;
+        private hasRoleInBrand;
+        private getRolesForBrand;
+        private toLinkedUserSummary;
+        private resolveLinkedUserCandidate;
+        private rewriteLinkedRecordAuthorizations;
+        private resolveEffectiveDisabledState;
+        private assertAuthenticationAllowed;
+        enrichUsersWithEffectiveDisabledState<T extends UserAttributes>(users: T[]): Promise<T[]>;
+        disableUser(userId: string, actor: string, brandId: string): Promise<void>;
+        enableUser(userId: string, actor: string, brandId: string): Promise<void>;
+        private toAuditActor;
+        private toAuditContextString;
+        private shouldRedactAuditKey;
+        private redactHeaderPairs;
+        private redactAuditValue;
+        private sanitizeAuditDebugContext;
+        private parseUserAuditContext;
+        private normalizeAuditTimestamp;
+        private timestampSortValue;
+        private matchesSelectedUserForDirectAudit;
+        private matchesSelectedUserForAdminAudit;
+        private getUserAuditDetails;
+        private normalizeUserAuditRecord;
+        private fetchDirectUserAuditRows;
+        getUserAudit(userId: string): Promise<UserAuditResponse>;
+        protected localAuthInit(): void;
+        private hasPreSaveTriggerConfigured;
+        private hasPostSaveTriggerConfigured;
+        private hasPostSaveSyncTriggerConfigured;
+        private checkAllTriggersSuccessOrFailure;
+        private triggerPreSaveTriggers;
+        triggerPostSaveSyncTriggers(user: AnyRecord, config: AnyRecord, mode?: string, response?: unknown): Promise<unknown>;
+        triggerPostSaveTriggers(user: AnyRecord, config: AnyRecord, mode?: string): void;
+        private resolveHookResponse;
+        protected aafAuthInit: () => void;
+        protected openIdConnectAuth: () => void;
+        protected openIdConnectAuthVerifyCallback(oidcConfig: AnyRecord, issuer: AnyRecord, req: AnyRecord, tokenSet: AnyRecord, userinfo: AnyRecord | undefined, done: DoneCallback): void;
+        protected bearerTokenAuthInit: () => void;
+        protected initDefAdmin: (defRoles: AnyRecord[], defAdminRole: AnyRecord) => Observable<{
+            defUser: AnyRecord;
+            defRoles: AnyRecord[];
+        }>;
+        protected mapAdditionalAttributes(profile: unknown, attributeMappings: Record<string, string>): Record<string, unknown>;
+        /**
+         * Creates a user audit record
+         *
+         */
+        addUserAuditEvent: (user: unknown, action: string, additionalContext: unknown) => Promise<Record<string, unknown>> | Promise<null>;
+        stringifyObject(object: unknown): unknown;
+        /**
+         * @return User: the newly created user
+         *
+         */
+        addLocalUser: (username: string, name: string, email: string, password: string) => Observable<UserModel>;
+        private getSearchService;
+        /**
+        @return Object {
+              defUser: the default admin user
+              defRoles: the default brand's roles
+            }
+        */
+        bootstrap: (defRoles: unknown) => Observable<{
+            defUser: AnyRecord;
+            defRoles: AnyRecord[];
+        }>;
+        getUserWithUsername: (username: string) => Observable<UserModel | null>;
+        getUserWithId: (userid: string | number) => Observable<UserModel | null>;
+        /**
+         * @return Collection of all users (local and AAF)
+         */
+        getUsers: () => Observable<UserModel[]>;
+        /**
+         * Retrieve all users that hold at least one role for the supplied brand.
+         * @param brand The brand or brand id to scope the search to.
+         */
+        getUsersForBrand: (brand: BrandingModel | string) => Observable<UserModel[]>;
+        getEffectiveUser: (userOrId: unknown) => Observable<UserModel | null>;
+        getLinkedAccounts: (primaryUserId: string | UserModel) => Observable<UserLinkResponse>;
+        searchLinkCandidates: (query: string, brandId: string, excludeUserId?: string) => Observable<LinkedUserSummary[]>;
+        linkAccounts: (primaryUserId: string, secondaryUserId: string, actor: string, brandId: string) => Observable<UserLinkResponse>;
+        setUserKey: (userid: string | number, uuid: string | null) => Observable<UserModel>;
+        updateUserDetails: (userid: string | number, name: string, email: string, password: string) => Observable<UserModel[]>;
+        updateUserRoles: (userid: string | number, newRoleIds: Array<string | number>) => Observable<UserModel>;
+        private updateUserAfterLogin;
+        hasRole(user: unknown, targetRole: unknown): RoleModel;
+        findUsersWithName(name: string, brandId: string, source?: unknown): Observable<UserModel[]>;
+        findUsersWithEmail(email: string, brandId: string | null, source?: unknown): Observable<UserModel[]>;
+        findUsersWithQuery(query: unknown, brandId: string | null, source?: unknown): Observable<UserModel[]>;
+        /**
+         *
+         * Find all records that the user is intended to have access to and assign actual access using their userId.
+         * This is used as users or services may want to provide access for a user to a record but due to single sign-on solutions,
+         * we're not able to reliably determine the username before they login to the system for the first time.
+         *
+         **/
+        findAndAssignAccessToRecords(pendingValue: string, userid: string): void;
+        /**
+         * Check whether an email is authorized.
+         * @param email The email to check.
+         * @param branding The branding name.
+         * @param authType The auth type ('aaf' or 'oidc').
+         * @returns True if email is authorized or authorization check is disabled, otherwise false if email is not allowed.
+         * @private
+         */
+        checkAuthorizedEmail(email: string, branding: string, authType: string): boolean;
+    }
+    export {};
+}
+declare global {
+    let UsersService: Services.Users;
+}
+//# sourceMappingURL=UsersService.d.ts.map

package/dist/services/UsersService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UsersService.d.ts","sourceRoot":"","sources":["../../src/services/UsersService.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,UAAU,EAAwC,MAAM,MAAM,CAAC;AAOxE,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAE/D,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAOtD,yBAAiB,QAAQ,CAAC;IACxB,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,KAAK,YAAY,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAkD3E,UAAU,iBAAiB;QACzB,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,gBAAgB,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED,UAAU,gBAAgB;QACxB,OAAO,EAAE,iBAAiB,CAAC;QAC3B,cAAc,EAAE,iBAAiB,EAAE,CAAC;QACpC,MAAM,CAAC,EAAE;YACP,gBAAgB,EAAE,MAAM,CAAC;YACzB,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC;KACH;IAED,UAAU,cAAc;QACtB,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAU,eAAe;QACvB,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,cAAc,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;QAChB,uBAAuB,EAAE,OAAO,CAAC;QACjC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;QACpC,UAAU,EAAE,OAAO,CAAC;KACrB;IAED,UAAU,gBAAgB;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC;KACpB;IAQD,UAAU,iBAAiB;QACzB,OAAO,EAAE,eAAe,EAAE,CAAC;QAC3B,OAAO,EAAE,gBAAgB,CAAC;KAC3B;IAYD;;;;;;OAMG;IACH,MAAM,OAAO,KAAM,SAAQ,QAAQ,CAAC,IAAI,CAAC,OAAO;QAE9C,UAAmB,gBAAgB,EAAE,MAAM,EAAE,CAyB3C;QAEF,aAAa,EAAG,aAAa,CAAC;QAE9B,OAAO,CAAC,aAAa;QAIrB,OAAO,CAAC,yBAAyB;QAMjC,OAAO,CAAC,cAAc;QAYtB,OAAO,CAAC,gBAAgB;QAYxB,OAAO,CAAC,mBAAmB;gBAab,0BAA0B;gBAQ1B,iCAAiC;gBAkEjC,6BAA6B;gBAiB7B,2BAA2B;QAO5B,qCAAqC,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;QA0BzF,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;QAY1E,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;QAYtF,OAAO,CAAC,YAAY;QAgBpB,OAAO,CAAC,oBAAoB;QAY5B,OAAO,CAAC,oBAAoB;QAQ5B,OAAO,CAAC,iBAAiB;QAWzB,OAAO,CAAC,gBAAgB;QAmBxB,OAAO,CAAC,yBAAyB;QAsBjC,OAAO,CAAC,qBAAqB;QA4B7B,OAAO,CAAC,uBAAuB;QAW/B,OAAO,CAAC,kBAAkB;QAQ1B,OAAO,CAAC,iCAAiC;QAOzC,OAAO,CAAC,gCAAgC;QAgBxC,OAAO,CAAC,mBAAmB;QA4B3B,OAAO,CAAC,wBAAwB;gBAelB,wBAAwB;QAoBzB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;QAsDrE,SAAS,CAAC,aAAa;QAuKvB,OAAO,CAAC,2BAA2B;QAanC,OAAO,CAAC,4BAA4B;QAapC,OAAO,CAAC,gCAAgC;QAaxC,OAAO,CAAC,gCAAgC;gBAe1B,sBAAsB;QA2CvB,2BAA2B,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,GAAE,MAAmB,EAAE,QAAQ,GAAE,OAAY;QAqCvH,uBAAuB,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,GAAE,MAAmB,GAAG,IAAI;QA6BnG,OAAO,CAAC,mBAAmB;QAQ3B,SAAS,CAAC,WAAW,aAyQpB;QAED,SAAS,CAAC,iBAAiB,aAmH1B;QAED,SAAS,CAAC,+BAA+B,CACvC,UAAU,EAAE,SAAS,EACrB,MAAM,EAAE,SAAS,EACjB,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,SAAS,GAAG,SAAqB,EAC3C,IAAI,EAAE,YAAY;QAkSpB,SAAS,CAAC,mBAAmB,aAsC5B;QAED,SAAS,CAAC,YAAY,GAAI,UAAU,SAAS,EAAE,EAAE,cAAc,SAAS;;;WAyDvE;QAED,SAAS,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;QAQ7F;;;WAGG;QACI,iBAAiB,GAAI,MAAM,OAAO,EAAE,QAAQ,MAAM,EAAE,mBAAmB,OAAO,sDAkBpF;QAED,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO;QAUzC;;;WAGG;QACI,YAAY,GAAI,UAAU,MAAM,EAAE,MAAM,MAAM,EAAE,OAAO,MAAM,EAAE,UAAU,MAAM,KAAG,UAAU,CAAC,SAAS,CAAC,CA4B7G;QAED,OAAO,CAAC,gBAAgB;QAIxB;;;;;UAKE;QACK,SAAS,GAAI,UAAU,OAAO;;;WAWpC;QAEM,mBAAmB,GAAI,UAAU,MAAM,KAAG,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,CAI5E;QAEM,aAAa,GAAI,QAAQ,MAAM,GAAG,MAAM,KAAG,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,CAI7E;QAED;;WAEG;QACI,QAAQ,QAAO,UAAU,CAAC,SAAS,EAAE,CAAC,CAE5C;QAED;;;WAGG;QACI,gBAAgB,GAAI,OAAO,aAAa,GAAG,MAAM,KAAG,UAAU,CAAC,SAAS,EAAE,CAAC,CAgBjF;QAEM,gBAAgB,GAAI,UAAU,OAAO,KAAG,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,CA+B1E;QAEM,iBAAiB,GAAI,eAAe,MAAM,GAAG,SAAS,KAAG,UAAU,CAAC,gBAAgB,CAAC,CA+B3F;QAEM,oBAAoB,GAAI,OAAO,MAAM,EAAE,SAAS,MAAM,EAAE,gBAAgB,MAAM,KAAG,UAAU,CAAC,iBAAiB,EAAE,CAAC,CA+DtH;QAEM,YAAY,GAAI,eAAe,MAAM,EAAE,iBAAiB,MAAM,EAAE,OAAO,MAAM,EAAE,SAAS,MAAM,KAAG,UAAU,CAAC,gBAAgB,CAAC,CAoHnI;QAEM,UAAU,GAAI,QAAQ,MAAM,GAAG,MAAM,EAAE,MAAM,MAAM,GAAG,IAAI,KAAG,UAAU,CAAC,SAAS,CAAC,CAexF;QAEM,iBAAiB,GAAI,QAAQ,MAAM,GAAG,MAAM,EAAE,MAAM,MAAM,EAAE,OAAO,MAAM,EAAE,UAAU,MAAM,KAAG,UAAU,CAAC,SAAS,EAAE,CAAC,CA+B3H;QAEM,eAAe,GAAI,QAAQ,MAAM,GAAG,MAAM,EAAE,YAAY,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,KAAG,UAAU,CAAC,SAAS,CAAC,CAc5G;QAED,OAAO,CAAC,oBAAoB;QAsBrB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,SAAS;QAQtD,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAE,OAAc;QAUvE,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,GAAE,OAAc;QAShF,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,GAAE,OAAc,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;QAoBlH;;;;;;YAMI;QACG,4BAA4B,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;QA6B/E;;;;;;;WAOG;QACI,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;KAiExF;;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAC;CAClC"}