@technomoron/api-server-base 1.1.13 → 2.0.0-beta.2

package/dist/esm/passkey/base.d.ts

@@ -0,0 +1,15 @@
+import type { PasskeyChallengeRecord, PasskeyStorageAdapter, PasskeyUserDescriptor, StoredPasskeyCredential } from './types.js';
+import type { AuthIdentifier } from '../auth-api/types.js';
+export declare abstract class PasskeyStore implements PasskeyStorageAdapter {
+    abstract resolveUser(params: {
+        userId?: AuthIdentifier;
+        login?: string;
+    }): Promise<PasskeyUserDescriptor | null>;
+    abstract listUserCredentials(userId: AuthIdentifier): Promise<StoredPasskeyCredential[]>;
+    abstract findCredentialById(credentialId: Buffer): Promise<StoredPasskeyCredential | null>;
+    abstract saveCredential(record: StoredPasskeyCredential): Promise<void>;
+    abstract updateCredentialCounter(credentialId: Buffer, counter: number): Promise<void>;
+    abstract saveChallenge(record: PasskeyChallengeRecord): Promise<void>;
+    abstract consumeChallenge(challenge: string): Promise<PasskeyChallengeRecord | null>;
+    abstract cleanupChallenges(now: Date): Promise<void>;
+}

package/dist/esm/passkey/base.js

@@ -0,0 +1,2 @@
+export class PasskeyStore {
+}

package/dist/esm/passkey/memory.d.ts

@@ -0,0 +1,26 @@
+import { PasskeyStore } from './base.js';
+import type { PasskeyChallengeRecord, PasskeyUserDescriptor, StoredPasskeyCredential } from './types.js';
+import type { AuthIdentifier } from '../auth-api/types.js';
+export interface MemoryPasskeyStoreOptions {
+    resolveUser: (params: {
+        userId?: AuthIdentifier;
+        login?: string;
+    }) => Promise<PasskeyUserDescriptor | null>;
+}
+export declare class MemoryPasskeyStore extends PasskeyStore {
+    private readonly resolveUserFn;
+    private readonly credentials;
+    private readonly challenges;
+    constructor(options: MemoryPasskeyStoreOptions);
+    resolveUser(params: {
+        userId?: AuthIdentifier;
+        login?: string;
+    }): Promise<PasskeyUserDescriptor | null>;
+    listUserCredentials(userId: AuthIdentifier): Promise<StoredPasskeyCredential[]>;
+    findCredentialById(credentialId: Buffer): Promise<StoredPasskeyCredential | null>;
+    saveCredential(record: StoredPasskeyCredential): Promise<void>;
+    updateCredentialCounter(credentialId: Buffer, counter: number): Promise<void>;
+    saveChallenge(record: PasskeyChallengeRecord): Promise<void>;
+    consumeChallenge(challenge: string): Promise<PasskeyChallengeRecord | null>;
+    cleanupChallenges(now: Date): Promise<void>;
+}

package/dist/esm/passkey/memory.js

@@ -0,0 +1,78 @@
+import { PasskeyStore } from './base.js';
+function encodeCredentialId(value) {
+    return Buffer.isBuffer(value) ? value.toString('base64') : value;
+}
+function normalizeUserId(identifier) {
+    if (typeof identifier === 'number' && Number.isFinite(identifier)) {
+        return identifier;
+    }
+    if (typeof identifier === 'string' && /^\d+$/.test(identifier)) {
+        return Number(identifier);
+    }
+    return identifier;
+}
+function cloneCredential(record) {
+    return {
+        ...record,
+        credentialId: Buffer.isBuffer(record.credentialId) ? Buffer.from(record.credentialId) : record.credentialId,
+        transports: record.transports ? [...record.transports] : undefined
+    };
+}
+export class MemoryPasskeyStore extends PasskeyStore {
+    constructor(options) {
+        super();
+        this.credentials = new Map();
+        this.challenges = new Map();
+        this.resolveUserFn = options.resolveUser;
+    }
+    async resolveUser(params) {
+        return this.resolveUserFn(params);
+    }
+    async listUserCredentials(userId) {
+        const normalizedUserId = normalizeUserId(userId);
+        return [...this.credentials.values()]
+            .filter((record) => normalizeUserId(record.userId) === normalizedUserId)
+            .map((record) => cloneCredential(record));
+    }
+    async findCredentialById(credentialId) {
+        const record = this.credentials.get(encodeCredentialId(credentialId));
+        return record ? cloneCredential(record) : null;
+    }
+    async saveCredential(record) {
+        this.credentials.set(encodeCredentialId(record.credentialId), {
+            ...record,
+            userId: normalizeUserId(record.userId),
+            credentialId: Buffer.isBuffer(record.credentialId) ? Buffer.from(record.credentialId) : record.credentialId,
+            transports: record.transports ? [...record.transports] : undefined
+        });
+    }
+    async updateCredentialCounter(credentialId, counter) {
+        const key = encodeCredentialId(credentialId);
+        const existing = this.credentials.get(key);
+        if (existing) {
+            existing.counter = counter;
+        }
+    }
+    async saveChallenge(record) {
+        this.challenges.set(record.challenge, {
+            ...record,
+            userId: record.userId !== undefined ? normalizeUserId(record.userId) : undefined,
+            metadata: record.metadata ? { ...record.metadata } : {}
+        });
+    }
+    async consumeChallenge(challenge) {
+        const record = this.challenges.get(challenge);
+        if (!record) {
+            return null;
+        }
+        this.challenges.delete(challenge);
+        return { ...record, metadata: record.metadata ? { ...record.metadata } : {} };
+    }
+    async cleanupChallenges(now) {
+        for (const [challenge, record] of this.challenges.entries()) {
+            if (record.expiresAt && new Date(record.expiresAt) <= now) {
+                this.challenges.delete(challenge);
+            }
+        }
+    }
+}

package/dist/esm/passkey/models.d.ts

@@ -0,0 +1,25 @@
+import { Model, type InferAttributes, type InferCreationAttributes, type ModelStatic, type Sequelize } from 'sequelize';
+import type { PasskeyChallengeMetadata } from './service.js';
+export declare class PasskeyCredentialModel extends Model<InferAttributes<PasskeyCredentialModel>, InferCreationAttributes<PasskeyCredentialModel>> {
+    credentialId: Buffer;
+    userId: number;
+    publicKey: Buffer;
+    counter: number;
+    transports: string[] | null;
+    backedUp: boolean;
+    deviceType: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export declare class PasskeyChallengeModel extends Model<InferAttributes<PasskeyChallengeModel>, InferCreationAttributes<PasskeyChallengeModel>> {
+    challenge: string;
+    action: 'register' | 'authenticate';
+    userId: number | null;
+    login: string | null;
+    metadata: PasskeyChallengeMetadata | null;
+    expiresAt: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export declare function initPasskeyCredentialModel(sequelize: Sequelize): ModelStatic<PasskeyCredentialModel>;
+export declare function initPasskeyChallengeModel(sequelize: Sequelize): ModelStatic<PasskeyChallengeModel>;

package/dist/esm/passkey/models.js

@@ -0,0 +1,108 @@
+import { DataTypes, Model } from 'sequelize';
+const DIALECTS_SUPPORTING_UNSIGNED = new Set(['mysql', 'mariadb']);
+function integerIdType(sequelize) {
+    return DIALECTS_SUPPORTING_UNSIGNED.has(sequelize.getDialect()) ? DataTypes.INTEGER.UNSIGNED : DataTypes.INTEGER;
+}
+export class PasskeyCredentialModel extends Model {
+}
+export class PasskeyChallengeModel extends Model {
+}
+export function initPasskeyCredentialModel(sequelize) {
+    const idType = integerIdType(sequelize);
+    return PasskeyCredentialModel.init({
+        credentialId: {
+            field: 'credential_id',
+            type: DataTypes.STRING(768),
+            primaryKey: true,
+            allowNull: false,
+            get() {
+                const raw = this.getDataValue('credentialId');
+                if (!raw) {
+                    return raw;
+                }
+                if (Buffer.isBuffer(raw)) {
+                    return raw;
+                }
+                return Buffer.from(raw, 'base64');
+            },
+            set(value) {
+                const encoded = typeof value === 'string' ? value : value.toString('base64');
+                this.setDataValue('credentialId', encoded);
+            }
+        },
+        userId: {
+            field: 'user_id',
+            type: idType,
+            allowNull: false
+        },
+        publicKey: {
+            field: 'public_key',
+            type: DataTypes.BLOB,
+            allowNull: false
+        },
+        counter: {
+            type: DataTypes.INTEGER,
+            allowNull: false,
+            defaultValue: 0
+        },
+        transports: {
+            type: DataTypes.JSON,
+            allowNull: true
+        },
+        backedUp: {
+            field: 'backed_up',
+            type: DataTypes.BOOLEAN,
+            allowNull: false,
+            defaultValue: false
+        },
+        deviceType: {
+            field: 'device_type',
+            type: DataTypes.STRING(32),
+            allowNull: false,
+            defaultValue: 'multiDevice'
+        }
+    }, {
+        sequelize,
+        tableName: 'passkey_credentials',
+        timestamps: true,
+        underscored: true
+    });
+}
+export function initPasskeyChallengeModel(sequelize) {
+    const idType = integerIdType(sequelize);
+    return PasskeyChallengeModel.init({
+        challenge: {
+            type: DataTypes.STRING(255),
+            primaryKey: true,
+            allowNull: false
+        },
+        action: {
+            type: DataTypes.STRING(16),
+            allowNull: false
+        },
+        userId: {
+            field: 'user_id',
+            type: idType,
+            allowNull: true
+        },
+        login: {
+            type: DataTypes.STRING(128),
+            allowNull: true
+        },
+        metadata: {
+            type: DataTypes.JSON,
+            allowNull: true
+        },
+        expiresAt: {
+            field: 'expires_at',
+            type: DataTypes.DATE,
+            allowNull: false
+        }
+    }, {
+        sequelize,
+        tableName: 'passkey_challenges',
+        timestamps: true,
+        underscored: true,
+        indexes: [{ fields: ['expires_at'] }, { fields: ['user_id'] }]
+    });
+}

package/dist/esm/passkey/sequelize.d.ts

@@ -0,0 +1,54 @@
+import { Model, type InferAttributes, type InferCreationAttributes, type ModelStatic, type Sequelize } from 'sequelize';
+import { PasskeyStore } from './base.js';
+import type { PasskeyChallengeRecord, PasskeyUserDescriptor, StoredPasskeyCredential } from './types.js';
+import type { AuthIdentifier } from '../auth-api/types.js';
+declare class PasskeyCredentialModel extends Model<InferAttributes<PasskeyCredentialModel>, InferCreationAttributes<PasskeyCredentialModel>> {
+    credentialId: Buffer;
+    userId: number;
+    publicKey: Buffer;
+    counter: number;
+    transports: string[] | null;
+    backedUp: boolean;
+    deviceType: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+declare class PasskeyChallengeModel extends Model<InferAttributes<PasskeyChallengeModel>, InferCreationAttributes<PasskeyChallengeModel>> {
+    challenge: string;
+    action: 'register' | 'authenticate';
+    userId: number | null;
+    login: string | null;
+    metadata: Record<string, unknown> | null;
+    expiresAt: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface SequelizePasskeyStoreOptions {
+    sequelize: Sequelize;
+    credentialModel?: ModelStatic<PasskeyCredentialModel>;
+    challengeModel?: ModelStatic<PasskeyChallengeModel>;
+    credentialModelFactory?: (sequelize: Sequelize) => ModelStatic<PasskeyCredentialModel>;
+    challengeModelFactory?: (sequelize: Sequelize) => ModelStatic<PasskeyChallengeModel>;
+    resolveUser: (params: {
+        userId?: AuthIdentifier;
+        login?: string;
+    }) => Promise<PasskeyUserDescriptor | null>;
+}
+export declare class SequelizePasskeyStore extends PasskeyStore {
+    private readonly resolveUserFn;
+    private readonly credentials;
+    private readonly challenges;
+    constructor(options: SequelizePasskeyStoreOptions);
+    resolveUser(params: {
+        userId?: AuthIdentifier;
+        login?: string;
+    }): Promise<PasskeyUserDescriptor | null>;
+    listUserCredentials(userId: AuthIdentifier): Promise<StoredPasskeyCredential[]>;
+    findCredentialById(credentialId: Buffer): Promise<StoredPasskeyCredential | null>;
+    saveCredential(record: StoredPasskeyCredential): Promise<void>;
+    updateCredentialCounter(credentialId: Buffer, counter: number): Promise<void>;
+    saveChallenge(record: PasskeyChallengeRecord): Promise<void>;
+    consumeChallenge(challenge: string): Promise<PasskeyChallengeRecord | null>;
+    cleanupChallenges(now: Date): Promise<void>;
+}
+export {};

package/dist/esm/passkey/sequelize.js

@@ -0,0 +1,207 @@
+import { DataTypes, Model, Op } from 'sequelize';
+import { PasskeyStore } from './base.js';
+const DIALECTS_SUPPORTING_UNSIGNED = new Set(['mysql', 'mariadb']);
+function integerIdType(sequelize) {
+    return DIALECTS_SUPPORTING_UNSIGNED.has(sequelize.getDialect()) ? DataTypes.INTEGER.UNSIGNED : DataTypes.INTEGER;
+}
+function encodeCredentialId(value) {
+    return Buffer.isBuffer(value) ? value.toString('base64') : value;
+}
+function normalizeUserId(identifier) {
+    if (typeof identifier === 'number' && Number.isFinite(identifier)) {
+        return identifier;
+    }
+    if (typeof identifier === 'string' && /^\d+$/.test(identifier)) {
+        return Number(identifier);
+    }
+    throw new Error(`Unable to normalise user identifier: ${identifier}`);
+}
+class PasskeyCredentialModel extends Model {
+}
+class PasskeyChallengeModel extends Model {
+}
+function initPasskeyCredentialModel(sequelize) {
+    const idType = integerIdType(sequelize);
+    return PasskeyCredentialModel.init({
+        credentialId: {
+            field: 'credential_id',
+            type: DataTypes.STRING(768),
+            primaryKey: true,
+            allowNull: false,
+            get() {
+                const raw = this.getDataValue('credentialId');
+                if (!raw) {
+                    return raw;
+                }
+                if (Buffer.isBuffer(raw)) {
+                    return raw;
+                }
+                return Buffer.from(raw, 'base64');
+            },
+            set(value) {
+                const encoded = typeof value === 'string' ? value : value.toString('base64');
+                this.setDataValue('credentialId', encoded);
+            }
+        },
+        userId: {
+            field: 'user_id',
+            type: idType,
+            allowNull: false
+        },
+        publicKey: {
+            field: 'public_key',
+            type: DataTypes.BLOB,
+            allowNull: false
+        },
+        counter: {
+            type: DataTypes.INTEGER,
+            allowNull: false,
+            defaultValue: 0
+        },
+        transports: {
+            type: DataTypes.JSON,
+            allowNull: true
+        },
+        backedUp: {
+            field: 'backed_up',
+            type: DataTypes.BOOLEAN,
+            allowNull: false,
+            defaultValue: false
+        },
+        deviceType: {
+            field: 'device_type',
+            type: DataTypes.STRING(32),
+            allowNull: false,
+            defaultValue: 'multiDevice'
+        }
+    }, {
+        sequelize,
+        tableName: 'passkey_credentials',
+        timestamps: true,
+        underscored: true
+    });
+}
+function initPasskeyChallengeModel(sequelize) {
+    const idType = integerIdType(sequelize);
+    return PasskeyChallengeModel.init({
+        challenge: {
+            type: DataTypes.STRING(255),
+            primaryKey: true,
+            allowNull: false
+        },
+        action: {
+            type: DataTypes.STRING(16),
+            allowNull: false
+        },
+        userId: {
+            field: 'user_id',
+            type: idType,
+            allowNull: true
+        },
+        login: {
+            type: DataTypes.STRING(128),
+            allowNull: true
+        },
+        metadata: {
+            type: DataTypes.JSON,
+            allowNull: true
+        },
+        expiresAt: {
+            field: 'expires_at',
+            type: DataTypes.DATE,
+            allowNull: false
+        }
+    }, {
+        sequelize,
+        tableName: 'passkey_challenges',
+        timestamps: true,
+        underscored: true,
+        indexes: [{ fields: ['expires_at'] }, { fields: ['user_id'] }]
+    });
+}
+export class SequelizePasskeyStore extends PasskeyStore {
+    constructor(options) {
+        super();
+        if (!options?.sequelize) {
+            throw new Error('SequelizePasskeyStore requires an initialised Sequelize instance');
+        }
+        this.resolveUserFn = options.resolveUser;
+        this.credentials =
+            options.credentialModel ??
+                (options.credentialModelFactory ?? initPasskeyCredentialModel)(options.sequelize);
+        this.challenges =
+            options.challengeModel ?? (options.challengeModelFactory ?? initPasskeyChallengeModel)(options.sequelize);
+    }
+    async resolveUser(params) {
+        return this.resolveUserFn(params);
+    }
+    async listUserCredentials(userId) {
+        const models = await this.credentials.findAll({ where: { userId: normalizeUserId(userId) } });
+        return models.map((model) => ({
+            userId: model.userId,
+            credentialId: model.credentialId,
+            publicKey: model.publicKey,
+            counter: model.counter,
+            transports: (model.transports ?? undefined),
+            backedUp: model.backedUp,
+            deviceType: model.deviceType
+        }));
+    }
+    async findCredentialById(credentialId) {
+        const model = await this.credentials.findByPk(encodeCredentialId(credentialId));
+        if (!model) {
+            return null;
+        }
+        return {
+            userId: model.userId,
+            credentialId: model.credentialId,
+            publicKey: model.publicKey,
+            counter: model.counter,
+            transports: (model.transports ?? undefined),
+            backedUp: model.backedUp,
+            deviceType: model.deviceType
+        };
+    }
+    async saveCredential(record) {
+        await this.credentials.upsert({
+            credentialId: record.credentialId,
+            userId: normalizeUserId(record.userId),
+            publicKey: record.publicKey,
+            counter: record.counter,
+            transports: record.transports ?? null,
+            backedUp: record.backedUp,
+            deviceType: record.deviceType
+        });
+    }
+    async updateCredentialCounter(credentialId, counter) {
+        await this.credentials.update({ counter }, { where: { credentialId: encodeCredentialId(credentialId) } });
+    }
+    async saveChallenge(record) {
+        await this.challenges.upsert({
+            challenge: record.challenge,
+            action: record.action,
+            userId: record.userId !== undefined ? normalizeUserId(record.userId) : null,
+            login: record.login ?? null,
+            metadata: (record.metadata ?? {}),
+            expiresAt: record.expiresAt
+        });
+    }
+    async consumeChallenge(challenge) {
+        const model = await this.challenges.findByPk(challenge);
+        if (!model) {
+            return null;
+        }
+        await model.destroy();
+        return {
+            challenge: model.challenge,
+            action: model.action,
+            userId: model.userId ?? undefined,
+            login: model.login ?? undefined,
+            expiresAt: model.expiresAt,
+            metadata: model.metadata ?? {}
+        };
+    }
+    async cleanupChallenges(now) {
+        await this.challenges.destroy({ where: { expiresAt: { [Op.lte]: now } } });
+    }
+}

package/dist/esm/passkey/service.d.ts

@@ -0,0 +1,17 @@
+import type { PasskeyChallenge, PasskeyChallengeParams, PasskeyStorageAdapter, PasskeyVerificationParams, PasskeyVerificationResult, PasskeyServiceConfig } from './types.js';
+export type { CredentialDeviceType, PasskeyChallenge, PasskeyChallengeParams, PasskeyChallengeRecord, PasskeyChallengeMetadata, PasskeyUserDescriptor, PasskeyVerificationParams, PasskeyVerificationResult, PasskeyServiceConfig, PasskeyStorageAdapter } from './types.js';
+type Logger = Pick<typeof console, 'error' | 'warn'>;
+export declare class PasskeyService {
+    private readonly config;
+    private readonly adapter;
+    private readonly logger;
+    constructor(config: PasskeyServiceConfig, adapter: PasskeyStorageAdapter, logger?: Logger);
+    createChallenge(params: PasskeyChallengeParams): Promise<PasskeyChallenge>;
+    verifyResponse(params: PasskeyVerificationParams): Promise<PasskeyVerificationResult>;
+    private createRegistrationChallenge;
+    private createAuthenticationChallenge;
+    private verifyRegistration;
+    private verifyAuthentication;
+    private requireUser;
+    private createExpiry;
+}