@crossauth/backend 0.0.2

package/dist/storage/dbstorage.d.ts

@@ -0,0 +1,319 @@
+import { DbPool } from './dbconnection';
+import { UserStorage, KeyStorage, UserStorageGetOptions, UserStorageOptions, OAuthClientStorage, OAuthClientStorageOptions, OAuthAuthorizationStorage } from '../storage';
+import { User, UserSecrets, Key, UserInputFields, UserSecretsInputFields, OAuthClient } from '@crossauth/common';
+
+/**
+ * Optional parameters for {@link DbUserStorage}.
+ *
+ * See {@link DbUserStorage.constructor} for definitions.
+ */
+export interface DbUserStorageOptions extends UserStorageOptions {
+    /** Name of user table.  Default `users` */
+    userTable?: string;
+    /** Name of user secrets table Default `usersecrets` */
+    userSecretsTable?: string;
+    /** Name of the id column in the user table.  Can be set to `username` if that is your primary key.
+     * Default `id`.
+     */
+    idColumn?: string;
+    /** Name of the user id column in the user secrets.
+     * Default `userid`.
+     */
+    useridForeignKeyColumn?: string;
+    /**
+     * This works around a Fastify and Sveltekit limitation.  If the id passed to
+     * getUserById() is a string but is numeric, first try forcing it to
+     * a number before selecting.  If that fails, try it as the string.
+     * Default true.
+     */
+    forceIdToNumber?: boolean;
+}
+/**
+ * Implementation of {@link UserStorage} where username and password is stored
+ * in two database tables: one for non secret fields, one for secret fields.
+ *
+ * The database engine is abstracted out.  Instead of using this class,
+ * use a subclass such as {@link PostgresUserTable}, etc.
+ *
+ * By default, the table is called `users`  It must have at least these fields:
+ *    * `username String \@unique`
+ *    * `username_normalized String \@unique`
+ *    * `state String`
+ * It must also contain an ID column, which is either an integer or string type, eg
+ *    * `id serial primary key`
+ * Alternatively you can set it to `username` if you don't have a separate ID field.
+ *
+ * You can optionally check if the `state` field is set to `awaitingemailverification` when validating users.
+ *  If the username is not the email address,
+ *  it must contain these extra two fields:
+ *     * `email String \@unique`
+ *     * `email_normalized String \@unique`
+ *
+ * You can optionally check if a `passwordReset` field is set to `true` when validating users.  Enabling this requires
+ * the user table to also have a `passwordReset Boolean` field.  Use this if you want to require your user to change his/her password.
+ *
+ * If `normalizeUsername` is true, getting a user by username will match on normalized (converting dialetics)
+ * and lowercased username.  This is not true of matching by id, even if the id columns is the same as the username column.
+ *
+ * If `normalitzEmail` is true, getting a user by username will matched on normalized, lowercase username.
+ *
+ * Some database engines are case insensitve by default whereas Typescript isn't.  If you
+ * create your tables with case-sensitive names, these will be returned as-is.
+ * If you create them with case insensitive names (the default) but you have
+ * the name with a different case in your input, it will be returned as
+ * lowercase from the database.  Therefore if you do not explicitly create
+ * your tables with uppercase columns, make sure any field you pass in the
+ * {@link @crossauth/common!User} or {@link @crossauth/common!UserSecrets} is
+ * lowercase.
+ */
+export declare class DbUserStorage extends UserStorage {
+    private userTable;
+    private userSecretsTable;
+    private idColumn;
+    private useridForeignKeyColumn;
+    private forceIdToNumber;
+    private dbPool;
+    /**
+     * Creates a DbUserStorage object, optionally overriding defaults.
+     * @param dbPool the instance of the Posrgres client.
+     * @param options see {@link DbUserStorageOptions}.
+     */
+    constructor(dbPool: DbPool, options?: DbUserStorageOptions);
+    /**
+     * Returns user matching the given id, or throws an exception.
+     *
+     * @param id the id to return the user of
+     * @param options optionally turn off checks.  Used internally
+     * @throws CrossauthException with ErrorCode either `UserNotExist` or whatever pg throws
+     */
+    getUserById(id: string | number, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * Returns user matching the given username, or throws an exception.
+     *
+     * Matches on the normalized username if `normalizeUsername` is true.
+     * @param username the username to return the user of
+     * @param options optionally turn off checks.  Used internally
+     * @throws CrossauthException with ErrorCode either `UserNotExist` or whatever pg throws
+     */
+    getUserByUsername(username: string, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * Returns a {@link @crossauth/common!User} and {@link @crossauth/common!UserSecrets} instance matching the given email address, or throws an Exception.
+     *
+     * If there is no email field in the user, the username is assumed to contain the email
+     *
+     * @param email the email address to look up
+     * @returns a {@link @crossauth/common!User} and {@link @crossauth/common!UserSecrets} instance, ie including the password hash.
+     * @throws {@link @crossauth/common!CrossauthError } with {@link @crossauth/common!ErrorCode } set to either `UserNotExist` or whatever pg throwsa.
+     */
+    getUserByEmail(email: string, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    private getUser;
+    /**
+     * Returns all users, regardless of their status, ordered by username
+     * @param skip limit to this many records returned
+     * @param take skip this nuber of records from the start
+     * @returns
+     */
+    getUsers(skip?: number, take?: number): Promise<User[]>;
+    /**
+     * If the given session key exist in the database, update it with the passed values.  If it doesn't
+     * exist, throw a CreossauthError with InvalidKey.
+     *
+     * Warning: the fields in `user` and `secrets` are not validated so, before calling this,
+     * you should check they are in `userEditableFields`.
+     *
+     * @param user the user to update.  The id to update is taken from this obkect, which must be present.  All other attributes are optional.
+     */
+    updateUser(user: Partial<User>, secrets?: Partial<UserSecrets>): Promise<void>;
+    /**
+     * Create a user
+     *
+     * Warning: the fields in `user` and `secrets` are not validated so, before calling this,
+     * you should check they are in `userEditableFields`.
+     *
+     * @param user
+     * @param secrets
+     */
+    createUser(user: UserInputFields, secrets?: UserSecretsInputFields): Promise<User>;
+    deleteUserByUsername(username: string): Promise<void>;
+    deleteUserById(id: string | number): Promise<void>;
+    private deleteUserById_internal;
+}
+/**
+ * Optional parameters for {@link DbKeyStorage}.
+ *
+ * See {@link DbKeyStorage.constructor} for definitions.
+ */
+export interface DbKeyStorageOptions {
+    keyTable?: string;
+    useridForeignKeyColumn?: string;
+}
+/**
+ * Implementation of {@link KeyStorage } where keys stored in a database managed by
+ * a database engine.
+ *
+ * This is an abstract class.  Instantiate a subclass instead,
+ * eg {@link PostgresKeyStorage}.
+ *
+ * By default, table is called `key`.  It must have at least three fields:
+ *    * `value string type unique`
+ *    * `userid String type or integer`
+ *    * `created timestamp`
+ *    * `expires timestamp`
+ * `key` must have `\@unique`.  It may also contain an ID column, which is not used.  If in the schema,
+ * it must be autoincrement.  THe `userid` may be a `String` or `Int`.  If a database table is used for
+ * user storage (eg {@link PostgresUserStorage} this should be a foreign key to the user table), in which case there
+ * should also be a `user` field (see Prisma documentation on foreign keys).
+ *
+ * In returned {@link @crossauth/common!Key} objects, userid is camelcase.  By
+ * default Postgres is case-insensitive.  If the columns is `userid` in lowercase,
+ * it is converted to `userid` when returned.  Vice versa when saving to the database.
+ */
+export declare class DbKeyStorage extends KeyStorage {
+    private keyTable;
+    private dbPool;
+    private useridForeignKeyColumn;
+    /**
+     * Constructor with user storage object to use plus optional parameters.
+     *
+     * @param dbPool the instance of the Posrgres client.
+     * @param options See {@link PrismaKeyStorageOptions}
+     */
+    constructor(dbPool: DbPool, options?: DbKeyStorageOptions);
+    getKey(key: string): Promise<Key>;
+    private getKeyInTransaction;
+    private makeKey;
+    /**
+     * Saves a key in the session table.
+     *
+     * @param userid user ID to store with the session key.  See {@link PrismaUserStorage} for how this may differ from `username`.
+     * @param value the value of the key to store.
+     * @param created the date/time the key was created.
+     * @param expires the date/time the key expires.
+     * @param extraFields these will be stored in the key table row
+     * @throws {@link @crossauth/common!CrossauthError } if the key could not be stored.
+     */
+    saveKey(userid: string | number | undefined, value: string, created: Date, expires: Date | undefined, data?: string, extraFields?: {
+        [key: string]: any;
+    }): Promise<void>;
+    deleteKey(value: string): Promise<void>;
+    deleteAllForUser(userid: string | number | undefined, prefix: string, except?: string): Promise<void>;
+    deleteMatching(key: Partial<Key>): Promise<void>;
+    deleteWithPrefix(userid: string | number | undefined, prefix: string): Promise<void>;
+    getAllForUser(userid: string | number | undefined): Promise<Key[]>;
+    /**
+     * If the given session key exist in the database, update it with the passed values.  If it doesn't
+     * exist, throw a CreossauthError with InvalidKey.
+     * @param key the new values of the key.   `value` must be set and will not be updated.
+     *        any other fields set (not undefined) will be updated.
+     */
+    updateKey(key: Partial<Key>): Promise<void>;
+    private updateKeyInTransaction;
+    /**
+     * See {@link KeyStorage}.
+     */
+    updateData(keyName: string, dataName: string, value: any | undefined): Promise<void>;
+    /**
+     * See {@link KeyStorage}.
+     */
+    updateManyData(keyName: string, dataArray: {
+        dataName: string;
+        value: any | undefined;
+    }[]): Promise<void>;
+    /**
+     * See {@link KeyStorage}.
+     */
+    deleteData(keyName: string, dataName: string): Promise<void>;
+}
+/**
+ * Optional parameters for {@link PrismaOAuthClientStorage}.
+ */
+export interface DbOAuthClientStorageOptions extends OAuthClientStorageOptions {
+    /** Table name of the OAuth Client table.  Default oauthclient */
+    clientTable?: string;
+    /** Table name of the OAuth Redirect Uri table.  Default oauthclientredirecturi */
+    redirectUriTable?: string;
+    /** Prisma name of the OAuth valid flows table.  Default oauthclientvalidflow */
+    validFlowTable?: string;
+    /** Name of the user id column in the client table.
+     * Default `userid`.
+     */
+    useridForeignKeyColumn?: string;
+}
+/**
+ * Implementation of {@link OAuthClientStorage } where clients stored in a database managed by
+ * the Prisma ORM.
+ */
+export declare class DbOAuthClientStorage extends OAuthClientStorage {
+    private clientTable;
+    private redirectUriTable;
+    private validFlowTable;
+    private dbPool;
+    private useridForeignKeyColumn;
+    /**
+     * Constructor with user storage object to use plus optional parameters.
+     *
+     * @param options See {@link PrismaOAuthClientStorageOptions}
+     */
+    constructor(dbPool: DbPool, options?: DbOAuthClientStorageOptions);
+    getClientById(client_id: string): Promise<OAuthClient>;
+    getClientByName(name: string, userid?: string | number | null): Promise<OAuthClient[]>;
+    private makeClient;
+    private getClientWithTransaction;
+    /**
+     * Saves a key in the session table.
+     *
+     * @param client fields for the client to create
+     * @throws {@link @crossauth/common!CrossauthError } if the client could not be stored.
+     */
+    createClient(client: OAuthClient): Promise<OAuthClient>;
+    private createClientWithTransaction;
+    /**
+     *
+     * @param client_id the client to delete
+     * @throws {@link @crossauth/common!CrossauthError } if the key could not be deleted.
+     */
+    deleteClient(client_id: string): Promise<void>;
+    private deleteClientWithTransaction;
+    /**
+     * If the given session key exist in the database, update it with the passed values.  If it doesn't
+     * exist, throw a CreossauthError with InvalidKey.
+     * @param client the client to update.  It will be searched on its client_id, which cannot be updated.
+     */
+    updateClient(client: Partial<OAuthClient>): Promise<void>;
+    private updateClientWithTransaction;
+    getClients(skip?: number, take?: number, userid?: string | number | null): Promise<OAuthClient[]>;
+}
+/**
+ * Optional parameters for {@link DbOAuthAuthorizationStorage}.
+ */
+export interface DbOAuthAuthorizationStorageOptions extends OAuthClientStorageOptions {
+    /** Prisma name of the OAuth Authorization table.  Default oAuthAuthorization */
+    authorizationTable?: string;
+    useridForeignKeyColumn?: string;
+}
+/**
+ * Implementation of {@link OAuthAuthorizationStorage } where authorizations are stored in a database.
+ */
+export declare class DbOAuthAuthorizationStorage extends OAuthAuthorizationStorage {
+    private authorizationTable;
+    private useridForeignKeyColumn;
+    private dbPool;
+    /**
+     * Constructor with user storage object to use plus optional parameters.
+     *
+     * @param options See {@link PrismaOAuthClientStorageOptions}
+     */
+    constructor(dbPool: DbPool, options?: DbOAuthClientStorageOptions);
+    getAuthorizations(client_id: string, userid: string | number | undefined): Promise<(string | null)[]>;
+    updateAuthorizations(client_id: string, userid: string | number | null, scopes: string[]): Promise<void>;
+}
+//# sourceMappingURL=dbstorage.d.ts.map

package/dist/storage/dbstorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbstorage.d.ts","sourceRoot":"","sources":["../../src/storage/dbstorage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAgB,MAAM,gBAAgB,CAAC;AACtD,OAAO,EACH,WAAW,EACX,UAAU,EACV,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EACH,KAAK,IAAI,EACT,KAAK,WAAW,EAChB,KAAK,GAAG,EACR,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EACJ,MAAM,mBAAmB,CAAC;AAQ1C;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC5D,2CAA2C;IAC3C,SAAS,CAAC,EAAG,MAAM,CAAC;IAEpB,uDAAuD;IACvD,gBAAgB,CAAC,EAAG,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAG,MAAM,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAG,MAAM,CAAC;IAEjC;;;;;OAKG;IACH,eAAe,CAAC,EAAG,OAAO,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC1C,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,gBAAgB,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,sBAAsB,CAAY;IAC1C,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,MAAM,CAAU;IACxB;;;;OAIG;gBACS,MAAM,EAAG,MAAM,EAAE,OAAO,GAAG,oBAAyB;IAWhE;;;;;;OAMG;IACG,WAAW,CACb,EAAE,EAAG,MAAM,GAAC,MAAM,EACjB,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;IAIpF;;;;;;;OAOG;IACG,iBAAiB,CACnB,QAAQ,EAAG,MAAM,EAChB,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;IAKpF;;;;;;;;OAQG;IACG,cAAc,CAChB,KAAK,EAAG,MAAM,EACd,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;YAKrE,OAAO;IAqFrB;;;;;OAKG;IACG,QAAQ,CAAC,IAAI,CAAC,EAAG,MAAM,EAAE,IAAI,CAAC,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,EAAE,CAAC;IAqDhE;;;;;;;;OAQG;IACG,UAAU,CAAC,IAAI,EAAG,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IA4EtF;;;;;;;;OAQG;IACG,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAG,sBAAsB,GAC5D,OAAO,CAAC,IAAI,CAAC;IA8FpB,oBAAoB,CAAC,QAAQ,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAyBvD,cAAc,CAAC,EAAE,EAAG,MAAM,GAAC,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;YAW1C,uBAAuB;CAuBxC;AAKD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,EAAG,MAAM,CAAC;IACnB,sBAAsB,CAAC,EAAG,MAAM,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,YAAa,SAAQ,UAAU;IACxC,OAAO,CAAC,QAAQ,CAAmB;IACnC,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,sBAAsB,CAAY;IAE1C;;;;;OAKG;gBACS,MAAM,EAAG,MAAM,EAAE,OAAO,GAAG,mBAAwB;IAWzD,MAAM,CAAC,GAAG,EAAG,MAAM,GAAI,OAAO,CAAC,GAAG,CAAC;YAsB3B,mBAAmB;IAcjC,OAAO,CAAC,OAAO;IA8Bf;;;;;;;;;OASG;IACG,OAAO,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EAC9C,KAAK,EAAG,MAAM,EAAE,OAAO,EAAG,IAAI,EAC9B,OAAO,EAAG,IAAI,GAAG,SAAS,EAC1B,IAAI,CAAC,EAAG,MAAM,EACd,WAAW,GAAG;QAAC,CAAC,GAAG,EAAG,MAAM,GAAG,GAAG,CAAA;KAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAuCvD,SAAS,CAAC,KAAK,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAYzC,gBAAgB,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAG,MAAM,EAAE,MAAM,CAAC,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAkCzG,cAAc,CAAC,GAAG,EAAG,OAAO,CAAC,GAAG,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IA6BlD,gBAAgB,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EAAE,MAAM,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IA2BvF,aAAa,CAAC,MAAM,EAAG,MAAM,GAAC,MAAM,GAAC,SAAS,GAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAuCtE;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAG,OAAO,CAAC,GAAG,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;YAiBrC,sBAAsB;IA6BpC;;OAEG;IACG,UAAU,CAAC,OAAO,EAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAC,SAAS,GAAI,OAAO,CAAC,IAAI,CAAC;IAK1F;;OAEG;IACO,cAAc,CAAC,OAAO,EAAG,MAAM,EAAE,SAAS,EAAE;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,GAAG,SAAS,CAAA;KAAC,EAAE,GAAI,OAAO,CAAC,IAAI,CAAC;IAyCnH;;OAEG;IACG,UAAU,CAAC,OAAO,EAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;CAmCvE;AAKD;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,yBAAyB;IAE1E,iEAAiE;IACjE,WAAW,CAAC,EAAG,MAAM,CAAC;IAEtB,kFAAkF;IAClF,gBAAgB,CAAC,EAAG,MAAM,CAAC;IAE3B,gFAAgF;IAChF,cAAc,CAAC,EAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAG,MAAM,CAAC;CACpC;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IACxD,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,cAAc,CAAmC;IACzD,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,sBAAsB,CAAY;IAE1C;;;;OAIG;gBACS,MAAM,EAAG,MAAM,EAAE,OAAO,GAAG,2BAAgC;IAUjE,aAAa,CAAC,SAAS,EAAG,MAAM,GAAI,OAAO,CAAC,WAAW,CAAC;IAkBxD,eAAe,CAAC,IAAI,EAAG,MAAM,EAAE,MAAM,CAAC,EAAG,MAAM,GAAC,MAAM,GAAC,IAAI,GAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAkB3F,OAAO,CAAC,UAAU;YA0BJ,wBAAwB;IA6EtC;;;;;OAKG;IACG,YAAY,CAAC,MAAM,EAAG,WAAW,GAAI,OAAO,CAAC,WAAW,CAAC;YAsBjD,2BAA2B;IAsFzC;;;;OAIG;IACG,YAAY,CAAC,SAAS,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;YAoBxC,2BAA2B;IAgBzC;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAG,OAAO,CAAC,WAAW,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;YAqBnD,2BAA2B;IAoFnC,UAAU,CAAC,IAAI,CAAC,EAAG,MAAM,EAAE,IAAI,CAAC,EAAG,MAAM,EAAE,MAAM,CAAC,EAAG,MAAM,GAAC,MAAM,GAAC,IAAI,GAAI,OAAO,CAAC,WAAW,EAAE,CAAC;CAkB1G;AAMD;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IAEjF,gFAAgF;IAChF,kBAAkB,CAAC,EAAG,MAAM,CAAC;IAE7B,sBAAsB,CAAC,EAAG,MAAM,CAAC;CAEpC;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,yBAAyB;IACtE,OAAO,CAAC,kBAAkB,CAAiC;IAC3D,OAAO,CAAC,sBAAsB,CAAW;IACzC,OAAO,CAAC,MAAM,CAAU;IAExB;;;;OAIG;gBACS,MAAM,EAAG,MAAM,EAAE,OAAO,GAAG,2BAAgC;IAOjE,iBAAiB,CAAC,SAAS,EAAG,MAAM,EAAE,MAAM,EAAG,MAAM,GAAC,MAAM,GAAC,SAAS,GAAI,OAAO,CAAC,CAAC,MAAM,GAAC,IAAI,CAAC,EAAE,CAAC;IA0BlG,oBAAoB,CAAC,SAAS,EAAG,MAAM,EAAE,MAAM,EAAG,MAAM,GAAC,MAAM,GAAC,IAAI,EAAE,MAAM,EAAG,MAAM,EAAE,GAAI,OAAO,CAAC,IAAI,CAAC;CAyCjH"}

package/dist/storage/inmemorystorage.d.ts

@@ -0,0 +1,225 @@
+import { UserStorage, KeyStorage, UserStorageGetOptions, UserStorageOptions, OAuthClientStorage, OAuthClientStorageOptions, OAuthAuthorizationStorage, OAuthAuthorizationStorageOptions } from '../storage';
+import { User, UserSecrets, Key, UserInputFields, UserSecretsInputFields, OAuthClient } from '@crossauth/common';
+
+/**
+ * Optional parameters for {@link InMemoryUserStorage}.
+ *
+ * See {@link InMemoryUserStorage.constructor} for definitions.
+ */
+export interface InMemoryUserStorageOptions extends UserStorageOptions {
+}
+/**
+ * Implementation of {@link UserStorage} where username and password is stored in memory.  It is really only
+ * intended for testing and is not thread safe.
+ *
+ * There is no separate ID field - it is set to username.
+ *
+ * You can optionally check if the state field is set to `awaitingemailverification` when validating users,
+*/
+export declare class InMemoryUserStorage extends UserStorage {
+    usersByUsername: {
+        [key: string]: User;
+    };
+    usersByEmail: {
+        [key: string]: User;
+    };
+    secretsByUsername: {
+        [key: string]: UserSecretsInputFields;
+    };
+    secretsByEmail: {
+        [key: string]: UserSecretsInputFields;
+    };
+    /**
+     * Creates a InMemoryUserStorage object, optionally overriding defaults.
+     * @param options @see {@link InMemoryUserStorageOptions}
+    */
+    constructor(options?: InMemoryUserStorageOptions);
+    /**
+     * Create a user
+     * @param user the user to save
+     * @param secrets optionally, secrets to save
+     */
+    createUser(user: UserInputFields, secrets?: UserSecretsInputFields): Promise<User>;
+    /**
+     * Returns a {@link User }and {@link UserSecrets } instance matching the given username, or throws an Exception.
+     *
+     * @param username the username to look up
+     * @returns a {@link User } and {@link UserSecrets }instance
+     * @throws {@link @crossauth/common!CrossauthError } with {@link @crossauth/common!ErrorCode } set to either `UserNotExist`.
+     */
+    getUserByUsername(username: string, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * Returns a {@link User } and {@link UserSecrets } instance matching the given email address, or throws an Exception.
+     *
+     * @param email the emaila ddress to look up
+     * @returns a {@link User } and {@link UserSecrets } instance, ie including the password hash.
+     * @throws {@link @crossauth/common!CrossauthError } with {@link @crossauth/common!ErrorCode } set to either `UserNotExist`.
+     */
+    getUserByEmail(email: string, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * Same as {@link getUserByUsername } - userid is the username in this model,
+     * @param id the user ID to match
+     * @returns a {@link @crossauth/common!User} and
+     *          {@link @crossauth/common!UserSecrets}instance, ie including
+     *          the password hash.
+     * @throws {@link @crossauth/common!CrossauthError } with {@link @crossauth/common!ErrorCode } set to either `UserNotExist` or `Connection`.
+     */
+    getUserById(id: string, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * If the given session key exist in the database, update it with the passed values.  If it doesn't
+     * exist, throw a CreossauthError with InvalidKey.
+     * @param user the user to update.  The id to update is taken from this obkect, which must be present.  All other attributes are optional.
+     */
+    updateUser(user: Partial<User>, secrets?: Partial<UserSecrets>): Promise<void>;
+    /**
+     * Deletes the given user
+     * @param username username of user to delete
+     */
+    deleteUserByUsername(username: string): Promise<void>;
+    /**
+     * Deletes the given user
+     * @param id id of user to delete
+     */
+    deleteUserById(id: string | number): Promise<void>;
+    getUsers(skip?: number, take?: number): Promise<User[]>;
+}
+/**
+ * Implementation of {@link KeyStorage } where keys stored in memory.  Intended for testing.
+ */
+export declare class InMemoryKeyStorage extends KeyStorage {
+    private keys;
+    private keysByUserId;
+    private nonUserKeys;
+    /**
+     * Constructor
+     */
+    constructor();
+    /**
+     * Returns the matching key recortd, with additional, or throws an exception.
+     * @param key the key to look up in the key storage.
+     * @returns the matching Key record
+     * @throws a {@link @crossauth/common!CrossauthError } instance with {@link @crossauth/common!ErrorCode} of `InvalidKey`, `UserNotExist` or `Connection`
+     */
+    getKey(key: string): Promise<Key>;
+    /**
+     * Saves a session key in the session table.
+     *
+     * @param userid user ID to store with the session key.  See {@link InMemoryUserStorage} for how this may differ from `username`.
+     * @param keyValue the value of session key to store.
+     * @param dateCreated the date/time the key was created.
+     * @param expires the date/time the key expires.
+     * @param extraFields these will also be stored in the key table row
+     */
+    saveKey(userid: string | number | undefined, keyValue: string, dateCreated: Date, expires: Date | undefined, data?: string, extraFields?: {
+        [key: string]: any;
+    }): Promise<void>;
+    /**
+     *
+     * @param keyValue the value of key to delete
+     */
+    deleteKey(keyValue: string): Promise<void>;
+    /**
+     * Deletes all keys from storage for the given user ID
+     *
+     * @param userid : user ID to delete keys for
+     */
+    deleteAllForUser(userid: string | number | undefined | null, prefix: string, except?: string | undefined): Promise<void>;
+    getAllForUser(userid: string | number | undefined): Promise<Key[]>;
+    deleteMatching(key: Partial<Key>): Promise<void>;
+    /**
+     * If the given session key exist in the database, update it with the passed values.  If it doesn't
+     * exist, throw a CreossauthError with InvalidKey.
+     * @param key
+     */
+    updateKey(key: Partial<Key>): Promise<void>;
+    /**
+     * See {@link KeyStorage}.
+     */
+    updateData(keyName: string, dataName: string, value: any | undefined): Promise<void>;
+    /**
+     * See {@link KeyStorage}.
+     */
+    updateManyData(keyName: string, dataArray: {
+        dataName: string;
+        value: any | undefined;
+    }[]): Promise<void>;
+    /**
+     * See {@link KeyStorage}.
+     */
+    deleteData(keyName: string, dataName: string): Promise<void>;
+}
+/**
+ * Implementation of {@link KeyStorage } where keys stored in memory.  Intended for testing.
+ */
+export declare class InMemoryOAuthClientStorage extends OAuthClientStorage {
+    private clients;
+    private clientsByName;
+    /**
+     * Constructor
+     */
+    constructor(_options?: OAuthClientStorageOptions);
+    /**
+     * Returns the matching client record or throws an exception.
+     * @param client_id the client to look up in the key storage.
+     * @returns the matching client record
+     * @throws a {@link @crossauth/common!CrossauthError } instance with {@link @crossauth/common!ErrorCode} of `InvalidKey`, `UserNotExist` or `Connection`
+     */
+    getClientById(client_id: string): Promise<OAuthClient>;
+    /**
+     * Returns the matching client record or throws an exception.
+     * @param name the client to look up in the key storage.
+     * @returns the matching client record
+     * @throws a {@link @crossauth/common!CrossauthError } instance with {@link @crossauth/common!ErrorCode} of `InvalidKey`, `UserNotExist` or `Connection`
+     */
+    getClientByName(name: string, userid?: string | number | null): Promise<OAuthClient[]>;
+    /**
+     * Saves a client in the client table.
+     *
+     * @param client the client to save.
+     */
+    createClient(client: OAuthClient): Promise<OAuthClient>;
+    /**
+     *
+     * @param client_id the client to delete
+     */
+    deleteClient(client_id: string): Promise<void>;
+    /**
+     * If the given client exists in the database, update it with the passed values.
+     *
+     * @param client the fields to update.  This must include `client_id` for search purposes, but this field is not updated.
+     * @throws {@link @crossauth/common!CrossauthError} with `InvalidClientId` if the client id doesn't exist}
+     */
+    updateClient(client: Partial<OAuthClient>): Promise<void>;
+    getClients(skip?: number, take?: number, userid?: string | number | null): Promise<OAuthClient[]>;
+}
+/**
+ * Implementation of {@link KeyStorage } where keys stored in memory.  Intended for testing.
+ */
+export declare class InMemoryOAuthAuthorizationStorage extends OAuthAuthorizationStorage {
+    private byClientAndUser;
+    private byClient;
+    /**
+     * Constructor
+     */
+    constructor(_options?: OAuthAuthorizationStorageOptions);
+    getAuthorizations(client_id: string, userid: string | number | undefined): Promise<string[]>;
+    /**
+     * Saves a client in the client table.
+     *
+     * @param client_id the client to save.
+     * @param userid the user Id to associate with the client.  Undefined means
+     *        not associated with a user
+     * @param scopes the scopes that have been authorized for the client
+     */
+    updateAuthorizations(client_id: string, userid: string | number | null, scopes: string[]): Promise<void>;
+}
+//# sourceMappingURL=inmemorystorage.d.ts.map

package/dist/storage/inmemorystorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inmemorystorage.d.ts","sourceRoot":"","sources":["../../src/storage/inmemorystorage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,qBAAqB,EAAE,KAAK,kBAAkB,EAAE,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,yBAAyB,EAAE,KAAK,gCAAgC,EAAE,MAAM,YAAY,CAAC;AAChO,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAE,KAAK,eAAe,EAAE,KAAK,sBAAsB,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAI/I;;;;GAIG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;CACrE;AAOD;;;;;;;EAOE;AACF,qBAAa,mBAAoB,SAAQ,WAAW;IAChD,eAAe,EAAG;QAAE,CAAC,GAAG,EAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAM;IAChD,YAAY,EAAG;QAAE,CAAC,GAAG,EAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAM;IAC7C,iBAAiB,EAAG;QAAE,CAAC,GAAG,EAAG,MAAM,GAAG,sBAAsB,CAAA;KAAE,CAAM;IACpE,cAAc,EAAG;QAAE,CAAC,GAAG,EAAG,MAAM,GAAG,sBAAsB,CAAA;KAAE,CAAM;IAEjE;;;MAGE;gBACU,OAAO,GAAG,0BAA+B;IAIrD;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAG,sBAAsB,GACnE,OAAO,CAAC,IAAI,CAAC;IAuBnB;;;;;;OAMG;IACG,iBAAiB,CACnB,QAAQ,EAAG,MAAM,EACjB,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;IAsCnF;;;;;;OAMG;IACG,cAAc,CAAC,KAAK,EAAG,MAAM,EAC/B,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;IAsBnF;;;;;;;OAOG;IACG,WAAW,CAAC,EAAE,EAAG,MAAM,EACzB,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;IAInF;;;;OAIG;IACG,UAAU,CAAC,IAAI,EAAG,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAwBtF;;;OAGG;IACG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc3D;;;OAGG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD,QAAQ,CAAC,IAAI,CAAC,EAAG,MAAM,EAAE,IAAI,CAAC,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,EAAE,CAAC;CAYnE;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,UAAU;IAC9C,OAAO,CAAC,IAAI,CAAgC;IAC5C,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,WAAW,CAAc;IAEjC;;OAEG;;IAKH;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAG,MAAM,GAAI,OAAO,CAAC,GAAG,CAAC;IAUzC;;;;;;;;OAQG;IACG,OAAO,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EAChC,QAAQ,EAAG,MAAM,EAAE,WAAW,EAAG,IAAI,EACrC,OAAO,EAAG,IAAI,GAAG,SAAS,EAC1B,IAAI,CAAC,EAAG,MAAM,EACd,WAAW,CAAC,EAAG;QAAC,CAAC,GAAG,EAAG,MAAM,GAAG,GAAG,CAAA;KAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAsBvE;;;OAGG;IACG,SAAS,CAAC,QAAQ,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAYlD;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAC,SAAqB,GAAI,OAAO,CAAC,IAAI,CAAC;IAapI,aAAa,CAAC,MAAM,EAAG,MAAM,GAAC,MAAM,GAAC,SAAS,GAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAMhE,cAAc,CAAC,GAAG,EAAG,OAAO,CAAC,GAAG,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAoDxD;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAG,OAAO,CAAC,GAAG,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IASnD;;OAEG;IACG,UAAU,CAAC,OAAO,EAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAC,SAAS,GAAI,OAAO,CAAC,IAAI,CAAC;IAI1F;;OAEG;IACG,cAAc,CAAC,OAAO,EAAG,MAAM,EAAE,SAAS,EAAE;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,GAAC,SAAS,CAAA;KAAC,EAAE,GAAI,OAAO,CAAC,IAAI,CAAC;IAqB7G;;OAEG;IACG,UAAU,CAAC,OAAO,EAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;CAgBvE;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,kBAAkB;IAC9D,OAAO,CAAC,OAAO,CAA8C;IAC7D,OAAO,CAAC,aAAa,CAA2C;IAEhE;;OAEG;gBACS,QAAQ,GAAG,yBAA8B;IAIrD;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAG,MAAM,GAAI,OAAO,CAAC,WAAW,CAAC;IAU9D;;;;;OAKG;IACG,eAAe,CAAC,IAAI,EAAG,MAAM,EAAE,MAAM,CAAC,EAAG,MAAM,GAAC,MAAM,GAAC,IAAI,GAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAa3F;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAG,WAAW,GAAI,OAAO,CAAC,WAAW,CAAC;IAS/D;;;OAGG;IACG,YAAY,CAAC,SAAS,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAgBtD;;;;;OAKG;IACG,YAAY,CAAC,MAAM,EAAG,OAAO,CAAC,WAAW,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAU3D,UAAU,CAAC,IAAI,CAAC,EAAG,MAAM,EAAE,IAAI,CAAC,EAAG,MAAM,EAAE,MAAM,CAAC,EAAG,MAAM,GAAC,MAAM,GAAC,IAAI,GAAI,OAAO,CAAC,WAAW,EAAE,CAAC;CAmB1G;AAED;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,yBAAyB;IAC5E,OAAO,CAAC,eAAe,CAAiE;IACxF,OAAO,CAAC,QAAQ,CAA2C;IAE3D;;OAEG;gBACS,QAAQ,GAAG,gCAAqC;IAItD,iBAAiB,CAAC,SAAS,EAAG,MAAM,EAAE,MAAM,EAAG,MAAM,GAAC,MAAM,GAAC,SAAS,GAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAYjG;;;;;;;OAOG;IACG,oBAAoB,CAAC,SAAS,EAAE,MAAM,EACxC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAC9B,MAAM,EAAE,MAAM,EAAE,GAAI,OAAO,CAAC,IAAI,CAAC;CASxC"}