@crossauth/backend 0.0.2

package/dist/storage/sqliteconnection.d.ts

@@ -0,0 +1,35 @@
+import { default as sqlite3 } from 'sqlite3';
+import { DbPool, DbConnection, DbParameter } from './dbconnection';
+
+export interface SqlPoolOptions {
+    /** Sqlite doesn't have a native date/time/timestamp format.
+     * List any fields you have in your user or usersecrets models here
+     * and they will be converted upon insert/update/select
+     */
+    dateFields?: string[];
+}
+export declare class SqlitePool extends DbPool {
+    private database;
+    private dateFields;
+    constructor(filename: string, options?: SqlPoolOptions);
+    connect(): Promise<DbConnection>;
+    parameters(): DbParameter;
+}
+export declare class SqliteConnection extends DbConnection {
+    private database;
+    dateFields?: string[];
+    constructor(database: sqlite3.Database, dateFields: string[]);
+    private crossauthErrorFromSqliteError;
+    execute(query: string, values?: any[]): Promise<{
+        [key: string]: any;
+    }[]>;
+    release(): void;
+    startTransaction(): Promise<void>;
+    commit(): Promise<void>;
+    rollback(): Promise<void>;
+}
+export declare class PostgresParameter extends DbParameter {
+    constructor();
+    nextParameter(): string;
+}
+//# sourceMappingURL=sqliteconnection.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sqliteconnection.d.ts","sourceRoot":"","sources":["../../src/storage/sqliteconnection.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAInE,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAG,MAAM,EAAE,CAAC;CAE1B;AAED,qBAAa,UAAW,SAAQ,MAAM;IAClC,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,UAAU,CAAiB;gBAEvB,QAAQ,EAAG,MAAM,EAAE,OAAO,GAAG,cAAmB;IAOtD,OAAO,IAAK,OAAO,CAAC,YAAY,CAAC;IAIvC,UAAU,IAAK,WAAW;CAI7B;AAED,qBAAa,gBAAiB,SAAQ,YAAY;IAC9C,OAAO,CAAC,QAAQ,CAAoB;IACpC,UAAU,CAAC,EAAG,MAAM,EAAE,CAAC;gBAEX,QAAQ,EAAG,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAG,MAAM,EAAE;IAM9D,OAAO,CAAC,6BAA6B;IAmB/B,OAAO,CAAC,KAAK,EAAG,MAAM,EAAE,MAAM,GAAG,GAAG,EAAO,GAAI,OAAO,CAAC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAE,GAAG,CAAA;KAAC,EAAE,CAAC;IAwClF,OAAO,IAAK,IAAI;IAKV,gBAAgB,IAAK,OAAO,CAAC,IAAI,CAAC;IAYlC,MAAM,IAAK,OAAO,CAAC,IAAI,CAAC;IAYxB,QAAQ,IAAK,OAAO,CAAC,IAAI,CAAC;CAWnC;AAGD,qBAAa,iBAAkB,SAAQ,WAAW;;IAM9C,aAAa,IAAK,MAAM;CAG3B"}

package/dist/storage/sqlitestorage.d.ts

@@ -0,0 +1,83 @@
+import { DbUserStorage, DbKeyStorage, DbOAuthClientStorage, DbOAuthAuthorizationStorage, DbUserStorageOptions, DbKeyStorageOptions, DbOAuthClientStorageOptions, DbOAuthAuthorizationStorageOptions } from './dbstorage';
+import { SqlPoolOptions } from './sqliteconnection';
+
+/**
+ * Optional parameters for {@link PostgresUserStorage}.
+ *
+ * See {@link SqliteUserStorage.constructor} for definitions.
+ */
+export interface SqliteUserStorageOptions extends DbUserStorageOptions, SqlPoolOptions {
+}
+/**
+ * Implementation of {@link UserStorage} where username and password is stored
+ * in two Sqlite tables: one for non secret fields, one for secret fields.
+ *
+ * The `pg` package module is used to access the database.
+ *
+ */
+export declare class SqliteUserStorage extends DbUserStorage {
+    /**
+     * Creates a PostgresUserStorage object, optionally overriding defaults.
+     * @param filename the Sqlite database file
+     * @param options see {@link PostgresUserStorageOptions}.
+     */
+    constructor(filename: string, options?: SqliteUserStorageOptions);
+}
+/**
+ * Optional parameters for {@link PostgresKeyStorage}.
+ *
+ * See {@link SqliteKeyStorage.constructor} for definitions.
+ */
+export interface SqliteKeyStorageOptions extends DbKeyStorageOptions, SqlPoolOptions {
+}
+/**
+ * Implementation of {@link KeyStorage } where keys stored in a
+ * Sqlite database.
+ */
+export declare class SqliteKeyStorage extends DbKeyStorage {
+    /**
+     * Creates a SqliteKeyStorage object, optionally overriding defaults.
+     * @param filename the Sqlite database file
+     * @param options see {@link SqliteKeyStorageOptions}.
+     */
+    constructor(filename: string, options?: SqliteKeyStorageOptions);
+}
+/**
+ * Optional parameters for {@link SqliteOAuthClientStorage}.
+ *
+ * See {@link SqliteOAuthClientStorage.constructor} for definitions.
+ */
+export interface SqliteOAuthClientStorageOptions extends DbOAuthClientStorageOptions, SqlPoolOptions {
+}
+/**
+ * Implementation of {@link OAuthClientStorage } where keys stored in a
+ * Sqlite database.
+ */
+export declare class SqliteOAuthClientStorage extends DbOAuthClientStorage {
+    /**
+     * Creates a PostgresOAuthStorage object, optionally overriding defaults.
+     * @param filename the Sqlite database file
+     * @param options see {@link SqliteOAuthClientStorageOptions}.
+     */
+    constructor(filename: string, options?: SqliteOAuthClientStorageOptions);
+}
+/**
+ * Optional parameters for {@link SqliteOAuthAuthorizationStorage}.
+ *
+ * See {@link SqliteOAuthAuthorization.constructor} for definitions.
+ */
+export interface SqliteOAuthAuthorizationStorageOptions extends DbOAuthAuthorizationStorageOptions, SqlPoolOptions {
+}
+/**
+ * Implementation of {@link OAuthAuthorization } where keys stored in a
+ * Sqlite database.
+ */
+export declare class SqliteOAuthAuthorizationStorage extends DbOAuthAuthorizationStorage {
+    /**
+     * Creates a PostgresOAuthStorage object, optionally overriding defaults.
+     * @param filename the Sqlite database file
+     * @param options see {@link SqliteOAuthAuthorizationStorageOptions}.
+     */
+    constructor(filename: string, options?: SqliteOAuthAuthorizationStorageOptions);
+}
+//# sourceMappingURL=sqlitestorage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sqlitestorage.d.ts","sourceRoot":"","sources":["../../src/storage/sqlitestorage.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,oBAAoB,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAC7G,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAC;AAC9I,OAAO,EAAc,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKrE;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB,EAAE,cAAc;CACrF;AAED;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,aAAa;IAEhD;;;;OAIG;gBACS,QAAQ,EAAG,MAAM,EAAE,OAAO,GAAG,wBAA6B;CAGzE;AAKD;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB,EAAE,cAAc;CACnF;AAED;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAE9C;;;;OAIG;gBACS,QAAQ,EAAG,MAAM,EAAE,OAAO,GAAG,uBAA4B;CAGxE;AAKD;;;;GAIG;AACH,MAAM,WAAW,+BAAgC,SAAQ,2BAA2B,EAAE,cAAc;CACnG;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,oBAAoB;IAE9D;;;;OAIG;gBACS,QAAQ,EAAG,MAAM,EAAE,OAAO,GAAG,+BAAoC;CAGhF;AAKD;;;;GAIG;AACH,MAAM,WAAW,sCAAuC,SAAQ,kCAAkC,EAAE,cAAc;CACjH;AAED;;;GAGG;AACH,qBAAa,+BAAgC,SAAQ,2BAA2B;IAE5E;;;;OAIG;gBACS,QAAQ,EAAG,MAAM,EAAE,OAAO,GAAG,sCAA2C;CAGvF"}

package/dist/storage/tests/dbtests.d.ts

@@ -0,0 +1,5 @@
+import { UserStorage, KeyStorage, OAuthClientStorage, OAuthAuthorizationStorage } from '../../storage';
+import { LocalPasswordAuthenticator } from '../../authenticators/passwordauth';
+
+export declare function makeDBTests(prefix: string, userStorage: UserStorage, keyStorage: KeyStorage, clientStorage: OAuthClientStorage, authStorage: OAuthAuthorizationStorage, authenticator: LocalPasswordAuthenticator): void;
+//# sourceMappingURL=dbtests.d.ts.map

package/dist/storage/tests/dbtests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbtests.d.ts","sourceRoot":"","sources":["../../../src/storage/tests/dbtests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAEvG,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAE/E,wBAAgB,WAAW,CAAC,MAAM,EAAG,MAAM,EAAE,WAAW,EAAG,WAAW,EAAE,UAAU,EAAG,UAAU,EAAE,aAAa,EAAG,kBAAkB,EAAE,WAAW,EAAG,yBAAyB,EAAE,aAAa,EAAG,0BAA0B,QAwbvN"}

package/dist/storage/tests/inmemorystorage.test.d.ts

@@ -0,0 +1,5 @@
+import { InMemoryUserStorage } from '../inmemorystorage';
+
+export declare var userStorage: InMemoryUserStorage;
+export declare var secretUserStorage: InMemoryUserStorage;
+//# sourceMappingURL=inmemorystorage.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"inmemorystorage.test.d.ts","sourceRoot":"","sources":["../../../src/storage/tests/inmemorystorage.test.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAqF,MAAM,oBAAoB,CAAC;AAI5I,eAAO,IAAI,WAAW,EAAG,mBAAmB,CAAC;AAC7C,eAAO,IAAI,iBAAiB,EAAG,mBAAmB,CAAC"}

package/dist/storage/tests/inmemorytestdata.d.ts

@@ -0,0 +1,4 @@
+import { InMemoryUserStorage } from '../inmemorystorage';
+
+export declare function getTestUserStorage(pepper?: string | undefined): Promise<InMemoryUserStorage>;
+//# sourceMappingURL=inmemorytestdata.d.ts.map

package/dist/storage/tests/inmemorytestdata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inmemorytestdata.d.ts","sourceRoot":"","sources":["../../../src/storage/tests/inmemorytestdata.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAGzD,wBAAsB,kBAAkB,CAAC,MAAM,CAAC,EAAG,MAAM,GAAC,SAAS,GAAI,OAAO,CAAC,mBAAmB,CAAC,CAqBlG"}

package/dist/storage/tests/ldapstorage.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ldapstorage.test.d.ts.map

package/dist/storage/tests/ldapstorage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ldapstorage.test.d.ts","sourceRoot":"","sources":["../../../src/storage/tests/ldapstorage.test.ts"],"names":[],"mappings":""}

package/dist/storage/tests/postgresstorage.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=postgresstorage.test.d.ts.map

package/dist/storage/tests/postgresstorage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgresstorage.test.d.ts","sourceRoot":"","sources":["../../../src/storage/tests/postgresstorage.test.ts"],"names":[],"mappings":""}

package/dist/storage/tests/prismastorage.test.d.ts

@@ -0,0 +1,4 @@
+import { PrismaUserStorage } from '../prismastorage';
+
+export declare var userStorage: PrismaUserStorage;
+//# sourceMappingURL=prismastorage.test.d.ts.map

package/dist/storage/tests/prismastorage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prismastorage.test.d.ts","sourceRoot":"","sources":["../../../src/storage/tests/prismastorage.test.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAA+E,MAAM,kBAAkB,CAAC;AAKlI,eAAO,IAAI,WAAW,EAAG,iBAAiB,CAAC"}

package/dist/storage/tests/sqlitestorage.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sqlitestorage.test.d.ts.map

package/dist/storage/tests/sqlitestorage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlitestorage.test.d.ts","sourceRoot":"","sources":["../../../src/storage/tests/sqlitestorage.test.ts"],"names":[],"mappings":""}

package/dist/storage.d.ts

@@ -0,0 +1,411 @@
+import { User, UserSecrets, Key, UserInputFields, UserSecretsInputFields, OAuthClient } from '@crossauth/common';
+
+/**
+ * Passed to get methods in {@link UserStorage}.
+ */
+export interface UserStorageGetOptions {
+    /**
+     * If true, a valid user will be returned even if state is set to `awaitingemailverification`
+     */
+    skipEmailVerifiedCheck?: boolean;
+    /**
+     * If true, a valid user will be returned even if state is not set to `active`
+     */
+    skipActiveCheck?: boolean;
+    /**
+     * If true, usernames will be matched as lowercase and with diacritics removed.
+     * Default true,
+     *
+     * Note: this doesn't apply to the ID column
+     */
+    normalizeUsername?: boolean;
+    /**
+     * If true, email addresses (in the email column not in the username column)
+     * will be matched as lowercase and with diacritics removed.
+     * Default true.
+     */
+    normalizeEmail?: boolean;
+}
+/**
+ * Options passed to {@link UserStorage} constructor
+ */
+export interface UserStorageOptions {
+    /**
+     * Fields that users are allowed to edit.  Any fields passed to a create or
+     * update call that are not in this list will be ignored.
+     */
+    userEditableFields?: string[];
+    /**
+     * Fields that admins are allowed to edit (in addition to `userEditableFields`)
+     */
+    adminEditableFields?: string[];
+}
+/**
+ * Base class for place where user details are stored,
+ *
+ * This class is subclasses for various types of user storage,
+ * eg {@link PrismaUserStorage } is for storing
+ * username and password in a database table, managed by the Prisma ORM.
+ *
+ * Username and email searches should be case insensitive, as should their
+ * unique constraints.  ID searches need not be case insensitive.
+ */
+export declare abstract class UserStorage {
+    readonly userEditableFields: string[];
+    readonly adminEditableFields: string[];
+    readonly normalizeUsername = true;
+    readonly normalizeEmail = true;
+    /**
+     * Constructor
+     * @param options See {@link UserStorageOptions}
+     */
+    constructor(options?: UserStorageOptions);
+    /**
+     * Returns user matching the given username, or throws an exception.
+     *
+     * if `normalizeUsername` is true, the username should be matched normalized and
+     * lowercased (using normalize())
+     * @param username the username to return the user of
+     * @param options optionally turn off checks.  Used internally
+     * @throws CrossauthException with ErrorCode either `UserNotExist` or `Connection`
+     */
+    abstract getUserByUsername(username: string, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * Returns user matching the given user id, or throws an exception.
+     *
+     * Not that implementations are free to define what the user ID is.  It can be a number of string,
+     * or can simply be `username`.
+     *
+     * @param id the user id to return the user of
+     * @param options optionally turn off checks.  Used internally
+     * @throws {@link @crossauth/common!CrossauthError} with
+     * {@link @crossauth/common!ErrorCode} either `UserNotExist` or `Connection`
+     */
+    abstract getUserById(id: string | number, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * Returns user matching the given email address, or throws an exception.
+     *
+     * If `normalizeEmail` is true, email should be matched normalized and lowercased (using normalize())
+     * If the email field doesn't exist, username is assumed to be the email column
+     *
+     * @param email the email address to return the user of
+     * @param options optionally turn off checks.  Used internally
+     * @throws {@link @crossauth/common!CrossauthError} with
+     * {@link @crossauth/common!ErrorCode} either `UserNotExist` or `Connection`
+     */
+    abstract getUserByEmail(email: string | number, options?: UserStorageGetOptions): Promise<{
+        user: User;
+        secrets: UserSecrets;
+    }>;
+    /**
+     * Creates a user with the given details and secrets.
+     *
+     * @param _user will be put in the User table
+     * @param _secrets will be put in the UserSecrets table
+     * @returns the new user as a {@link @crossauth/common!User} object.
+     */
+    createUser(_user: UserInputFields, _secrets?: UserSecretsInputFields): Promise<User>;
+    /**
+     * Updates an existing user with the given details and secrets.
+     *
+     * If the given user exists in the database, update it with the passed values.
+     * If it doesn't exist, throw a
+     * {@link @crossauth/common!CrossauthError} with
+     * {@link @crossauth/common!ErrorCode} `InvalidKey`.
+     *
+     * @param user  The `id` field must be set, but all others are optional.
+     *              Any parameter not set (or undefined) will not be updated.
+     *              If you want to set somethign to `null` in the database, pass
+     *              the value as `null` not undefined.
+     */
+    abstract updateUser(user: Partial<User>, secrets?: Partial<UserSecrets>): Promise<void>;
+    /**
+     * If the storage supports this, delete the named user from storage.
+     *
+     * @param username username to delete
+     */
+    abstract deleteUserByUsername(username: string): Promise<void>;
+    /**
+     * If the storage supports this, delete the user with the given ID from
+     * storage.
+     *
+     * @param id id of user to delete
+     */
+    abstract deleteUserById(id: string | number): Promise<void>;
+    /**
+     * Returns all users in the storage, in a a fixed order defined by
+     * the storage (eg alphabetical by username)
+     * @param skip skip this number of records from the start of the set
+     * @param take only return at most this number of records
+     *
+     * @returns an array of {@link @crossauth/common!User} objects.
+     */
+    abstract getUsers(skip?: number, take?: number): Promise<User[]>;
+    /**
+     * By default, usernames and emails are stored in lowercase, normalized format.
+     * This function returns that normalization.
+     *
+     * @param str the string to normalize
+     * @returns the normalized string, in lowercase with diacritics removed
+     */
+    static normalize(str: string): string;
+}
+/**
+ * Base class for storing session and API keys.
+ *
+ * This class is subclasses for various types of session key storage,  Eg
+ * {@link PrismaKeyStorage } is for storing
+ * session in a database table, managed by the Prisma ORM.
+ */
+export declare abstract class KeyStorage {
+    /**
+     * Returns the matching key in the session storage or throws an exception if it doesn't exist.
+     *
+     * @param key the key to look up, as it will appear in this storage
+     *            (typically unsigned, hashed)
+     * @returns The matching Key record.
+     */
+    abstract getKey(key: string): Promise<Key>;
+    /**
+     * Saves a session key in the session storage (eg database).
+     *
+     * @param userid the ID of the user.  This matches the primary key in the
+     *               {@link UserStorage } implementation.
+     * @param value the key value to store.
+     * @param dateCreated the date/time the key was created.
+     * @param expires the date/time the key expires.
+     * @param data an optional value, specific to the type of key, eg new
+     *             email for email change tokens
+     * @param extraFields these will also be saved in the key record
+     */
+    abstract saveKey(userid: string | number | undefined, value: string, dateCreated: Date, expires: Date | undefined, data?: string, extraFields?: {
+        [key: string]: any;
+    }): Promise<void>;
+    /**
+     * If the given session key exists in the database, update it with the
+     * passed values.  If it doesn't exist, throw a
+     * {@link @crossauth/common!CrossauthError} with
+     * {@link @crossauth/common!ErrorCode} `InvalidKey`.
+     * @param key the fields defined in this will be updated.  `id` must
+     *            be present and it will not be updated.
+     */
+    abstract updateKey(key: Partial<Key>): Promise<void>;
+    /**
+     * Deletes a key from storage (eg the database).
+     *
+     * @param value the key to delete
+     */
+    abstract deleteKey(value: string): Promise<void>;
+    /**
+     * Deletes all keys from storage for the given user ID
+     *
+     * @param userid : user ID to delete keys for
+     * @param prefix only keys starting with this prefix will be
+     *               deleted
+     * @param except if defined, the key with this value will not be deleted
+     */
+    abstract deleteAllForUser(userid: string | number | undefined, prefix: string, except?: string): Promise<void>;
+    /**
+     * Deletes all matching the given specs
+     *
+     * @param key : any key matching all defined values in this object will
+     *              be deleted
+     */
+    abstract deleteMatching(key: Partial<Key>): Promise<void>;
+    /**
+     * Return all keys matching the given user ID
+     * @param userid user to return keys for
+     * @returns an array of keys
+     */
+    abstract getAllForUser(userid: string | number | undefined): Promise<Key[]>;
+    /**
+     * The `data` field in a key entry is a JSON string.  This class should
+     * atomically update a field in it.
+     * @param keyName the name of they to update, as it appears in the table.
+     * @param dataName the field name to update.  This can contain dots, eg
+     *        `part1.part2`, which means `part2` within `part1` is updated.
+     * @param value the new value.
+     */
+    abstract updateData(keyName: string, dataName: string, value: any | undefined): Promise<void>;
+    /**
+     * Same as `updateData` but updates several keys.
+     *
+     * Ensure it is done as a single transaction.
+     *
+     * @param keyName the key to update
+     * @param dataArray dataName and value pairs
+     */
+    abstract updateManyData(keyName: string, dataArray: {
+        dataName: string;
+        value: any | undefined;
+    }[]): Promise<void>;
+    /**
+     * The `data` field in a key entry is a JSON string.  This class should
+     * atomically update a field in it.
+     * @param keyName the name of they to update, as it appears in the table.
+     * @param dataName the field name to delete.  This can contain dots, eg
+     *        `part1.part2`, which means `part2` within `part1` is deleted.
+     */
+    abstract deleteData(keyName: string, dataName: string): Promise<void>;
+    /**
+     * Returns an object decoded from the data field as a JSON string
+     * @param data the JSON string to decode
+     * @returns the parse JSON object
+     * @throws an exception is data is not a valid JSON string
+     */
+    static decodeData(data: string | undefined): {
+        [key: string]: any;
+    };
+    /**
+     * Returns a JSON string encoded from the given object
+     * @param data the object to encode
+     * @returns a JSON string
+     */
+    static encodeData(data?: {
+        [key: string]: any;
+    }): string;
+    /**
+     * Helper function for imnpklementing `updateData`
+     * @param data parsed data string extracted from the key.
+     * @param dataName name of field to update (may contain dots)
+     * @param value the value to set it to
+     * @returns new data object if changes were made, undefined otherwise
+     */
+    protected updateDataInternal(data: {
+        [key: string]: any;
+    }, dataName: string, value: any | undefined): {
+        [key: string]: any;
+    } | undefined;
+    /**
+     * Helper function for imnpklementing `deleteData`
+     * @param data parsed data string extracted from the key.  Resutls will be
+     *        written back to this
+     * @param dataName name of field to delete (may contain dots)
+     * @returns true if modifications were made, false otherwise
+     */
+    protected deleteDataInternal(data: {
+        [key: string]: any;
+    }, dataName: string): boolean;
+}
+/**
+ * Options for constructing an {@link OAuthClientStorage} object.
+ */
+export interface OAuthClientStorageOptions {
+}
+/**
+ * Base class for storing OAuth clients.
+ *
+ * This class is subclassed for various types of client storage,  Eg {@link PrismaOAuthClientStorage } is for storing
+ * clients in a database table, managed by the Prisma ORM.
+ */
+export declare abstract class OAuthClientStorage {
+    /**
+     * Constructor
+     * @param _options see {@link OAuthClientStorageOptions}
+     */
+    constructor(_options?: OAuthClientStorageOptions);
+    /**
+     * Returns the matching client by its auto-generated id in the storage or
+     * throws an exception if it doesn't exist.
+     *
+     * @param client_id the client_id to look up
+     * @returns The matching {@link @crossauth/common!OAuthClient} object.
+     */
+    abstract getClientById(client_id: string): Promise<OAuthClient>;
+    /**
+     * Returns the matching client in the storage by friendly name or
+     * throws an exception if it doesn't exist.
+     *
+     * @param name the client name to look up
+     * @param userid if defined, only return clients belonging to this user.
+     *               if `null`, return only clients with a null userid.
+     *               if undefined, return all clients with this name.
+     * @returns An array of {@link @crossauth/common!OAuthClient} objects.
+     * @throws {@link @crossauth/common!CrossauthError } with {@link @crossauth/common!ErrorCode } of `InvalidSessionId` if a match was not found in session storage.
+     */
+    abstract getClientByName(name: string, userid?: string | number | null): Promise<OAuthClient[]>;
+    /**
+     * Returns all clients in alphabetical order of client name.
+     * @param skip skip this number of records from the start in alphabetical
+     *             order
+     * @param take return at most this number of records
+     * @param userid if defined, only return clients belonging to this user.
+     *               if `null`, return only clients with a null userid.
+     *               if undefined, return all clients.
+     * @returns An array of {@link @crossauth/common!OAuthClient} objects.
+     */
+    abstract getClients(skip?: number, take?: number, userid?: string | number | null): Promise<OAuthClient[]>;
+    /**
+     * Creates and returns a new client with random ID and optionally secret.
+     *
+     * Saves in the database.
+     *
+     * @param client the client to save.
+     * @returns the new client.
+     *
+     */
+    abstract createClient(client: OAuthClient): Promise<OAuthClient>;
+    /**
+     * If the given session key exists in the database, update it with the
+     * passed values.  If it doesn't
+     * exist, throw a {@link @crossauth/common!CrossauthError} with
+     * `InvalidClient`.
+     * @param client all fields to update (client_id must be set but will not
+     *        be updated)
+     */
+    abstract updateClient(client: Partial<OAuthClient>): Promise<void>;
+    /**
+     * Deletes a key from storage .
+     *
+     * @param client_id the client to delete
+     */
+    abstract deleteClient(client_id: string): Promise<void>;
+}
+/**
+ * Options for creating an {@link OAuthAuthorizationStorage} object
+ */
+export interface OAuthAuthorizationStorageOptions {
+}
+/**
+ * Base class for storing scopes that have been authorized by a user
+ * (or for client credentials, for a client).
+ *
+ * This class is subclassed for various types of storage,  Eg
+ * {@link PrismaOAuthAuthorizationStorage } is for storing
+ * in a database table, managed by the Prisma ORM.
+ */
+export declare abstract class OAuthAuthorizationStorage {
+    /**
+     * Constructor
+     * @param _options see {@link OAuthAuthorizationStorageOptions}
+     */
+    constructor(_options?: OAuthAuthorizationStorageOptions);
+    /**
+     * Returns the matching all scopes authorized for the given client and optionally user.
+     *
+     * @param client_id the client_id to look up
+     * @param userid the userid to look up, undefined for a client authorization not user authorization
+     * @returns The authorized scopes as an array.
+     */
+    abstract getAuthorizations(client_id: string, userid: string | number | undefined): Promise<(string | null)[]>;
+    /**
+     * Saves a new set of authorizations for the given client and optionally
+     * user.
+     *
+     * Deletes the old ones.
+     *
+     * @param client_id the client_id to look up
+     * @param userid the userid to look up, undefined for a client
+     *               authorization not user authorization
+     * @param authorizations new set of authorized scopes, which may be empty
+     *
+     */
+    abstract updateAuthorizations(client_id: string, userid: string | number | null, authorizations: (string | null)[]): Promise<void>;
+}
+//# sourceMappingURL=storage.d.ts.map

package/dist/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEtH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAElC;;OAEG;IACH,sBAAsB,CAAC,EAAG,OAAO,CAAA;IAEjC;;OAEG;IACH,eAAe,CAAC,EAAG,OAAO,CAAC;IAE3B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAG,OAAO,CAAC;IAE7B;;;;OAIG;IACH,cAAc,CAAC,EAAG,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAE/B;;;OAGG;IACN,kBAAkB,CAAC,EAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACN,mBAAmB,CAAC,EAAG,MAAM,EAAE,CAAC;CAChC;AAED;;;;;;;;;GASG;AACH,8BAAsB,WAAW;IAC7B,QAAQ,CAAC,kBAAkB,EAAG,MAAM,EAAE,CAAM;IAC5C,QAAQ,CAAC,mBAAmB,EAAG,MAAM,EAAE,CAAM;IAC7C,QAAQ,CAAC,iBAAiB,QAAQ;IAClC,QAAQ,CAAC,cAAc,QAAQ;IAE/B;;;OAGG;gBACS,OAAO,GAAG,kBAAuB;IAO7C;;;;;;;;OAQG;IACH,QAAQ,CAAC,iBAAiB,CACtB,QAAQ,EAAG,MAAM,EAChB,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;IAEpF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAW,CAChB,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;IAEpF;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,cAAc,CACnB,KAAK,EAAG,MAAM,GAAG,MAAM,EACvB,OAAO,CAAC,EAAG,qBAAqB,GAAI,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,WAAW,CAAA;KAAC,CAAC;IAEnF;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAG,eAAe,EAAE,QAAQ,CAAC,EAAG,sBAAsB,GAChE,OAAO,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAG,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAG,OAAO,CAAC,WAAW,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAE1F;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAEhE;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,EAAG,MAAM,GAAC,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAE3D;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAG,MAAM,EAAE,IAAI,CAAC,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,EAAE,CAAC;IAEnE;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,EAAG,MAAM,GAAI,MAAM;CAG1C;AAED;;;;;;GAMG;AACH,8BAAsB,UAAU;IAE5B;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAG,MAAM,GAAI,OAAO,CAAC,GAAG,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EAChC,KAAK,EAAG,MAAM,EACd,WAAW,EAAG,IAAI,EAClB,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;IAG1E;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAG,OAAO,CAAC,GAAG,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAEtD;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAElD;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EAC1D,MAAM,EAAG,MAAM,EAAE,MAAM,CAAC,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAEtD;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,CAAC,GAAG,EAAG,OAAO,CAAC,GAAG,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAG,MAAM,GAAC,MAAM,GAAC,SAAS,GAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAEzE;;;;;;;OAOG;IACH,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,EAC/B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,GAAG,GAAG,SAAS,GAAI,OAAO,CAAC,IAAI,CAAC;IAE3C;;;;;;;OAOG;IACH,QAAQ,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EACnC,SAAS,EAAE;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,GAAG,SAAS,CAAA;KAAC,EAAE,GAAI,OAAO,CAAC,IAAI,CAAC;IAE5E;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,EAC/B,QAAQ,EAAE,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;IAErC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAG,MAAM,GAAC,SAAS,GAAI;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;IAOhE;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAG;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC,GAAI,MAAM;IAKvD;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAG;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAC,SAAS,GAAI;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC,GAAC,SAAS;IAiBhI;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAG;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC,EAAE,QAAQ,EAAE,MAAM,GAAI,OAAO;CAuBvF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;CACzC;AAED;;;;;GAKG;AACH,8BAAsB,kBAAkB;IAEpC;;;OAGG;gBACS,QAAQ,GAAG,yBAA8B;IAIrD;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAG,MAAM,GAAI,OAAO,CAAC,WAAW,CAAC;IAEjE;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAG,MAAM,EAAE,MAAM,CAAC,EAAG,MAAM,GAAC,MAAM,GAAC,IAAI,GAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAE9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,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;IAE1G;;;;;;;;OAQG;IACH,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAG,WAAW,GAAI,OAAO,CAAC,WAAW,CAAC;IAElE;;;;;;;OAOG;IACH,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAG,OAAO,CAAC,WAAW,CAAC,GAAI,OAAO,CAAC,IAAI,CAAC;IAEpE;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,SAAS,EAAG,MAAM,GAAI,OAAO,CAAC,IAAI,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;CAChD;AAED;;;;;;;GAOG;AACH,8BAAsB,yBAAyB;IAE3C;;;OAGG;gBACS,QAAQ,GAAG,gCAAqC;IAG5D;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,MAAM,EACxC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAI,OAAO,CAAC,CAAC,MAAM,GAAC,IAAI,CAAC,EAAE,CAAC;IAEnE;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAC3C,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAC9B,cAAc,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAI,OAAO,CAAC,IAAI,CAAC;CACzD"}

package/dist/tests/cookieauth.test.d.ts

@@ -0,0 +1,4 @@
+import { InMemoryUserStorage } from '../storage/inmemorystorage';
+
+export declare var userStorage: InMemoryUserStorage;
+//# sourceMappingURL=cookieauth.test.d.ts.map

package/dist/tests/cookieauth.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cookieauth.test.d.ts","sourceRoot":"","sources":["../../src/tests/cookieauth.test.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAsB,MAAM,4BAA4B,CAAC;AAGrF,eAAO,IAAI,WAAW,EAAG,mBAAmB,CAAC"}

package/dist/tests/crypto.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=crypto.test.d.ts.map

package/dist/tests/crypto.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.test.d.ts","sourceRoot":"","sources":["../../src/tests/crypto.test.ts"],"names":[],"mappings":""}

package/dist/tests/email.test.d.ts

@@ -0,0 +1,4 @@
+import { InMemoryUserStorage } from '../storage/inmemorystorage';
+
+export declare var userStorage: InMemoryUserStorage;
+//# sourceMappingURL=email.test.d.ts.map

package/dist/tests/email.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.test.d.ts","sourceRoot":"","sources":["../../src/tests/email.test.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAsB,MAAM,4BAA4B,CAAC;AAGrF,eAAO,IAAI,WAAW,EAAG,mBAAmB,CAAC"}

package/dist/tests/password.test.d.ts

@@ -0,0 +1,5 @@
+import { InMemoryUserStorage } from '../storage/inmemorystorage';
+
+export declare var userStorage: InMemoryUserStorage;
+export declare var secretUserStorage: InMemoryUserStorage;
+//# sourceMappingURL=password.test.d.ts.map

package/dist/tests/password.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"password.test.d.ts","sourceRoot":"","sources":["../../src/tests/password.test.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,eAAO,IAAI,WAAW,EAAG,mBAAmB,CAAC;AAC7C,eAAO,IAAI,iBAAiB,EAAG,mBAAmB,CAAC"}

package/dist/tests/tmp.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=tmp.test.d.ts.map

package/dist/tests/tmp.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tmp.test.d.ts","sourceRoot":"","sources":["../../src/tests/tmp.test.ts"],"names":[],"mappings":""}