@unchainedshop/core-users 3.0.0-alpha7 → 3.0.0-rc2

package/lib/module/configureUsersModule_LOCAL_57123.d.ts

@@ -0,0 +1,131 @@
+import { ModuleInput, Address, Contact } from '@unchainedshop/mongodb';
+import { User, UserQuery, Email, UserLastLogin, UserProfile, UserData } from '../types.js';
+import { mongodb } from '@unchainedshop/mongodb';
+import { SortOption } from '@unchainedshop/utils';
+import { UserSettingsOptions } from '../users-settings.js';
+import { UsersWebAuthnModule } from './configureUsersWebAuthnModule.js';
+export type UsersModule = {
+    webAuthn: UsersWebAuthnModule;
+    count: (query: UserQuery) => Promise<number>;
+    findUserById: (userId: string) => Promise<User>;
+    findUserByToken: (hashedToken?: string) => Promise<User>;
+    findUserByResetToken: (token: string) => Promise<User>;
+    findUnverifiedEmailToken: (token: string) => Promise<{
+        userId: string;
+        address: string;
+        when: Date;
+    }>;
+    findUserByEmail(email: string): Promise<User>;
+    findUserByUsername(username: string): Promise<User>;
+    findUser: (selector: UserQuery & {
+        sort?: Array<SortOption>;
+    }, options?: mongodb.FindOptions) => Promise<User>;
+    findUsers: (query: UserQuery & {
+        sort?: Array<SortOption>;
+        limit?: number;
+        offset?: number;
+    }) => Promise<Array<User>>;
+    userExists: (query: {
+        userId: string;
+    }) => Promise<boolean>;
+    primaryEmail: (user: User) => Email;
+    userLocale: (user: User) => Intl.Locale;
+    createUser: (userData: UserData, options: {
+        skipMessaging?: boolean;
+        skipPasswordEnrollment?: boolean;
+    }) => Promise<string>;
+    addEmail: (userId: string, email: string) => Promise<void>;
+    removeEmail: (userId: string, email: string) => Promise<void>;
+    sendVerificationEmail: (userId: string, email: string) => Promise<void>;
+    sendResetPasswordEmail: (userId: string, email: string, isEnrollment?: boolean) => Promise<void>;
+    verifyEmail: (userId: string, email: string) => Promise<void>;
+    setUsername: (userId: string, newUsername: string) => Promise<void>;
+    setPassword: (userId: string, newPassword?: string) => Promise<void>;
+    verifyPassword: (hashObject: Record<string, string>, password: string) => Promise<boolean>;
+    addRoles: (userId: string, roles: Array<string>) => Promise<number>;
+    updateAvatar: (_id: string, fileId: string) => Promise<User>;
+    updateGuest: (user: User, guest: boolean) => Promise<void>;
+    updateHeartbeat: (userId: string, doc: UserLastLogin) => Promise<User>;
+    updateLastBillingAddress: (_id: string, lastAddress: Address) => Promise<User>;
+    updateLastContact: (_id: string, lastContact: Contact) => Promise<User>;
+    updateProfile: (_id: string, { profile, meta }: {
+        profile?: UserProfile;
+        meta?: any;
+    }) => Promise<User>;
+    delete: (userId: string) => Promise<User>;
+    updateRoles: (_id: string, roles: Array<string>) => Promise<User>;
+    updateTags: (_id: string, tags: Array<string>) => Promise<User>;
+    updateUser: (selector: mongodb.Filter<User>, modifier: mongodb.UpdateFilter<User>, options: mongodb.FindOneAndUpdateOptions) => Promise<User>;
+    addPushSubscription: (userId: string, subscription: any, options?: {
+        userAgent: string;
+        unsubscribeFromOtherUsers: boolean;
+    }) => Promise<void>;
+    removePushSubscription: (userId: string, p256dh: string) => Promise<void>;
+};
+export declare const removeConfidentialServiceHashes: (rawUser: User) => User;
+export declare const buildFindSelector: ({ includeGuests, queryString, ...rest }: UserQuery) => mongodb.Filter<User>;
+export declare const configureUsersModule: ({ db, options, migrationRepository, }: ModuleInput<UserSettingsOptions>) => Promise<{
+    webAuthn: UsersWebAuthnModule;
+    count(query: UserQuery): Promise<number>;
+    findUserById(userId: string): Promise<User>;
+    findUserByUsername(username: string): Promise<User>;
+    findUserByEmail(email: string): Promise<User>;
+    findUnverifiedEmailToken(plainToken: string): Promise<{
+        userId: string;
+        address: string;
+        when: Date;
+    }>;
+    verifyEmail(userId: string, address: string): Promise<void>;
+    findUserByResetToken(plainToken: string): Promise<User>;
+    findUserByToken(plainToken?: string): Promise<User>;
+    findUser(query: UserQuery & {
+        sort?: Array<SortOption>;
+    }, findOptions?: mongodb.FindOptions): Promise<User>;
+    findUsers({ limit, offset, ...query }: UserQuery & {
+        sort?: Array<SortOption>;
+        limit?: number;
+        offset?: number;
+    }): Promise<Array<User>>;
+    userExists({ userId }: {
+        userId: string;
+    }): Promise<boolean>;
+    primaryEmail(user: User): Email;
+    userLocale(user: User): Intl.Locale;
+    createUser({ password, email, username, initialPassword, roles, webAuthnPublicKeyCredentials, ...userData }: UserData, { skipMessaging, skipPasswordEnrollment, }?: {
+        skipMessaging?: boolean;
+        skipPasswordEnrollment?: boolean;
+    }): Promise<string>;
+    hashPassword(password: any): Promise<{
+        pbkdf2: string;
+    }>;
+    verifyPassword({ bcrypt: bcryptHash, pbkdf2: pbkdf2SaltAndHash }: {
+        bcrypt?: string;
+        pbkdf2?: string;
+    }, plainPassword: string): Promise<boolean>;
+    addEmail(userId: string, address: string): Promise<void>;
+    removeEmail(userId: string, address: string): Promise<void>;
+    sendResetPasswordEmail(userId: string, email: string, isEnrollment?: boolean): Promise<void>;
+    sendVerificationEmail(userId: string, email: string): Promise<void>;
+    addRoles: (userId: string, roles: Array<string>) => Promise<number>;
+    setUsername(userId: string, username: string): Promise<void>;
+    setPassword(userId: string, plainPassword: string): Promise<void>;
+    updateAvatar: (_id: string, fileId: string) => Promise<User>;
+    updateGuest: (user: User, guest: boolean) => Promise<void>;
+    updateHeartbeat: (userId: string, lastLogin: UserLastLogin) => Promise<User>;
+    delete: (userId: string) => Promise<User>;
+    updateProfile: (userId: string, updatedData: {
+        profile?: UserProfile;
+        meta?: any;
+    }) => Promise<User>;
+    updateLastBillingAddress: (_id: string, lastBillingAddress: Address) => Promise<User>;
+    updateLastContact: (_id: string, lastContact: Contact) => Promise<User>;
+    updateRoles: (_id: string, roles: Array<string>) => Promise<User>;
+    updateTags: (_id: string, tags: Array<string>) => Promise<User>;
+    updateUser: (selector: mongodb.Filter<User>, modifier: mongodb.UpdateFilter<User>, updateOptions?: mongodb.FindOneAndUpdateOptions) => Promise<User>;
+    addPushSubscription: (userId: string, subscription: any, subscriptionOptions?: {
+        userAgent: string;
+        unsubscribeFromOtherUsers: boolean;
+    }) => Promise<void>;
+    removePushSubscription: (userId: string, p256dh: string) => Promise<void>;
+}>;
+//# sourceMappingURL=configureUsersModule_LOCAL_57123.d.ts.map

package/lib/module/configureUsersModule_LOCAL_57123.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configureUsersModule_LOCAL_57123.d.ts","sourceRoot":"","sources":["../../src/module/configureUsersModule_LOCAL_57123.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE3F,OAAO,EAGL,OAAO,EAER,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAA+B,UAAU,EAAU,MAAM,sBAAsB,CAAC;AAGvF,OAAO,EAAgB,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAgC,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAGtG,MAAM,MAAM,WAAW,GAAG;IAExB,QAAQ,EAAE,mBAAmB,CAAC;IAG9B,KAAK,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,eAAe,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,oBAAoB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,wBAAwB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;QACnD,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,IAAI,CAAC;KACZ,CAAC,CAAC;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,QAAQ,EAAE,CACR,QAAQ,EAAE,SAAS,GAAG;QAAE,IAAI,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;KAAE,EAClD,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,KAC1B,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,SAAS,EAAE,CACT,KAAK,EAAE,SAAS,GAAG;QACjB,IAAI,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACzB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,KACE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1B,UAAU,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5D,YAAY,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,CAAC;IACpC,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC;IAGxC,UAAU,EAAE,CACV,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,sBAAsB,CAAC,EAAE,OAAO,CAAA;KAAE,KACnE,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,qBAAqB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,sBAAsB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjG,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrE,cAAc,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3F,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IACpE,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,eAAe,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,wBAAwB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/E,iBAAiB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,aAAa,EAAE,CACb,GAAG,EAAE,MAAM,EACX,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,CAAC;QAAC,IAAI,CAAC,EAAE,GAAG,CAAA;KAAE,KACrD,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,UAAU,EAAE,CACV,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAC9B,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,EACpC,OAAO,EAAE,OAAO,CAAC,uBAAuB,KACrC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,mBAAmB,EAAE,CACnB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,GAAG,EACjB,OAAO,CAAC,EAAE;QACR,SAAS,EAAE,MAAM,CAAC;QAClB,yBAAyB,EAAE,OAAO,CAAC;KACpC,KACE,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,sBAAsB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3E,CAAC;AAmBF,eAAO,MAAM,+BAA+B,YAAa,IAAI,KAAG,IAI/D,CAAC;AAEF,eAAO,MAAM,iBAAiB,4CAA6C,SAAS,yBAOnF,CAAC;AAEF,eAAO,MAAM,oBAAoB,0CAI9B,WAAW,CAAC,mBAAmB,CAAC;;iBAcZ,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;yBAKnB,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;iCAKd,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;2BAK5B,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;yCAKR,MAAM,GAAG,OAAO,CAAC;QAC1D,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,IAAI,CAAC;KACZ,CAAC;wBAsBwB,MAAM,WAAW,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;qCAyB1B,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;iCAgB1B,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;oBAahD,SAAS,GAAG;QAAE,IAAI,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;KAAE,gBACjC,OAAO,CAAC,WAAW,GAChC,OAAO,CAAC,IAAI,CAAC;2CASb,SAAS,GAAG;QACb,IAAI,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACzB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;2BAoBK;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;uBAQ/C,IAAI,GAAG,KAAK;qBAMd,IAAI,GAAG,IAAI,CAAC,MAAM;iHAe9B,QAAQ,+CAIR;QAAE,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,sBAAsB,CAAC,EAAE,OAAO,CAAA;KAAE,GAC/D,OAAO,CAAC,MAAM,CAAC;;;;sEA8EmC;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,iBACxE,MAAM,GACpB,OAAO,CAAC,OAAO,CAAC;qBAYI,MAAM,WAAW,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;wBAiBpC,MAAM,WAAW,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;mCAW5B,MAAM,SAAS,MAAM,iBAAiB,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;kCAyB9D,MAAM,SAAS,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;uBAyBhD,MAAM,SAAS,KAAK,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,MAAM,CAAC;wBAc7C,MAAM,YAAY,MAAM;wBAkBxB,MAAM,iBAAiB,MAAM;wBAsB7B,MAAM,UAAU,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;wBAmBtC,IAAI,SAAS,OAAO,KAAG,OAAO,CAAC,IAAI,CAAC;8BAW9B,MAAM,aAAa,aAAa,KAAG,OAAO,CAAC,IAAI,CAAC;qBAoBzD,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;4BAqCnC,MAAM,eACD;QAAE,OAAO,CAAC,EAAE,WAAW,CAAC;QAAC,IAAI,CAAC,EAAE,GAAG,CAAA;KAAE,KACjD,OAAO,CAAC,IAAI,CAAC;oCAmCsB,MAAM,sBAAsB,OAAO,KAAG,OAAO,CAAC,IAAI,CAAC;6BAqC1D,MAAM,eAAe,OAAO,KAAG,OAAO,CAAC,IAAI,CAAC;uBA4BlD,MAAM,SAAS,KAAK,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,IAAI,CAAC;sBAkB7C,MAAM,QAAQ,KAAK,CAAC,MAAM,CAAC,KAAG,OAAO,CAAC,IAAI,CAAC;2BAiBvD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YACpB,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,kBACpB,OAAO,CAAC,uBAAuB,KAC9C,OAAO,CAAC,IAAI,CAAC;kCAYN,MAAM,gBACA,GAAG,wBACK;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,yBAAyB,EAAE,OAAO,CAAC;KACpC,KACA,OAAO,CAAC,IAAI,CAAC;qCAyBuB,MAAM,UAAU,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;EAYhF,CAAC"}