@ultimabase/password 0.0.0-stage → 0.1.0

package/dist/input.d.ts

@@ -0,0 +1,104 @@
+import type { SchemaField } from 'ultimabase';
+type Node = {
+    readonly [key: string]: unknown;
+};
+type Read = {
+    readonly value: unknown;
+} | {
+    readonly message: string;
+};
+type Issue = {
+    readonly path: readonly string[];
+    readonly message: string;
+};
+type Result<O> = {
+    readonly value: O;
+} | {
+    readonly issues: readonly Issue[];
+};
+/** Standard Schema with its JSON Schema export (standardschema.dev), copied as its specification asks. */
+interface StandardSchema<I, O> {
+    readonly '~standard': {
+        readonly version: 1;
+        readonly vendor: string;
+        readonly validate: (value: unknown) => Result<O>;
+        readonly jsonSchema: {
+            readonly input: () => Node;
+            readonly output: () => Node;
+        };
+        readonly types?: {
+            readonly input: I;
+            readonly output: O;
+        };
+    };
+}
+/** One property of an input: how it reads a value, and its JSON Schema. */
+export interface Property {
+    readonly read: (value: unknown) => Read;
+    readonly json: Node;
+    readonly required: boolean;
+    /** The shared nodes its JSON Schema refers to, lifted to the root's. */
+    readonly defs?: Node;
+}
+/** The email trimmed, lowercased and in NFC, the account's subject (D-113, D-115). */
+export declare function emailOf(value: unknown): Read;
+/** How a password is typed does not change it: NFKC (D-115, NIST SP 800-63B). */
+export declare const normalized: (password: string) => string;
+/** A password to store, normalized: 8 to 256 characters, no other rule (D-113). */
+export declare function passwordOf(value: unknown): Read;
+/** `read`'s value, or a `VALIDATION_FAILED` naming `path`. */
+export declare function valid<T>(read: (value: unknown) => Read, value: T, path: string): T;
+/** A property of `read`, whose JSON Schema is `json`. */
+export declare const property: (read: Property['read'], json: Node, required?: boolean) => Property;
+/**
+ * A user field a client may send at sign-up, a json one with its `validate`;
+ * a relation stops startup (D-113, D-125).
+ */
+export declare function fieldProperty(field: SchemaField, required: boolean, where: string, schema?: object): Property;
+/** What a named input's `run` reads, under `input` (D-109). */
+export type Named<O> = {
+    readonly input: O;
+};
+/**
+ * One `input` argument of the object `id`, typed `SignUpInput` over GraphQL
+ * for the id `SignUp`; the email is normalized, the dates read (D-113).
+ */
+export declare function namedInput<O extends object>(id: string, properties: ReadonlyMap<string, Property>): StandardSchema<Named<O>, Named<O>>;
+/** What `signIn` and `User.signIn` take. */
+export type Credentials = {
+    readonly email: string;
+    readonly password: string;
+};
+type ChangePassword = {
+    readonly currentPassword: string;
+    readonly newPassword: string;
+};
+type SignUp = Credentials & {
+    readonly [field: string]: unknown;
+};
+export declare const signInInput: StandardSchema<Named<Credentials>, Named<Credentials>>;
+export declare const changePasswordInput: StandardSchema<Named<ChangePassword>, Named<ChangePassword>>;
+type ResetPassword = {
+    readonly token: string;
+    readonly password: string;
+};
+/** What `requestPasswordReset` takes (D-117). */
+export declare const requestResetInput: StandardSchema<Named<{
+    readonly email: string;
+}>, Named<{
+    readonly email: string;
+}>>;
+/** What `resetPassword` takes: the email's token and the new password (D-117). */
+export declare const resetPasswordInput: StandardSchema<Named<ResetPassword>, Named<ResetPassword>>;
+/** What `verifyEmail` takes: the email's token (D-117). */
+export declare const verifyEmailInput: StandardSchema<Named<{
+    readonly token: string;
+}>, Named<{
+    readonly token: string;
+}>>;
+/** The email, the password and the listed user fields, by their names. */
+export declare const signUpInput: (fields: ReadonlyMap<string, Property>) => StandardSchema<Named<SignUp>, Named<SignUp>>;
+/** An output's schema: typed and exported, never validated (D-45). */
+export declare function outputSchema<T>(node: Node): StandardSchema<T, T>;
+export {};
+//# sourceMappingURL=input.d.ts.map

package/dist/input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../src/input.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAI7C,KAAK,IAAI,GAAG;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAA;AAC/C,KAAK,IAAI,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AACtE,KAAK,KAAK,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3E,KAAK,MAAM,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAA;CAAE,CAAA;AAE9E,0GAA0G;AAC1G,UAAU,cAAc,CAAC,CAAC,EAAE,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE;QACrB,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;QACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,CAAA;QAChD,QAAQ,CAAC,UAAU,EAAE;YACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,CAAA;YAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,IAAI,CAAA;SAC3B,CAAA;QACD,QAAQ,CAAC,KAAK,CAAC,EAAE;YAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;YAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;SAAE,CAAA;KAC1D,CAAA;CACD;AAED,2EAA2E;AAC3E,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;IACvC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IACnB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B,wEAAwE;IACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CACpB;AAQD,sFAAsF;AACtF,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAO5C;AAED,iFAAiF;AACjF,eAAO,MAAM,UAAU,aAAc,MAAM,KAAG,MACnB,CAAA;AAE3B,mFAAmF;AACnF,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAQ/C;AAED,8DAA8D;AAC9D,wBAAgB,KAAK,CAAC,CAAC,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,EAC9B,KAAK,EAAE,CAAC,EACR,IAAI,EAAE,MAAM,GACV,CAAC,CAUH;AAED,yDAAyD;AACzD,eAAO,MAAM,QAAQ,SACd,QAAQ,CAAC,MAAM,CAAC,QAChB,IAAI,yBAER,QAAsC,CAAA;AAkFzC;;;GAGG;AACH,wBAAgB,aAAa,CAC5B,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,OAAO,EACjB,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,MAAM,GACb,QAAQ,CAQV;AA6CD,+DAA+D;AAC/D,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAA;AAE5C;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAC1C,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,GACvC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CA8BpC;AAKD,4CAA4C;AAC5C,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAE/E,KAAK,cAAc,GAAG;IACrB,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;CAC5B,CAAA;AACD,KAAK,MAAM,GAAG,WAAW,GAAG;IAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAA;AAEjE,eAAO,MAAM,WAAW,EAAE,cAAc,CACvC,KAAK,CAAC,WAAW,CAAC,EAClB,KAAK,CAAC,WAAW,CAAC,CAOlB,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,cAAc,CAC/C,KAAK,CAAC,cAAc,CAAC,EACrB,KAAK,CAAC,cAAc,CAAC,CAOrB,CAAA;AAED,KAAK,aAAa,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1E,iDAAiD;AACjD,eAAO,MAAM,iBAAiB,EAAE,cAAc,CAC7C,KAAK,CAAC;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,EACjC,KAAK,CAAC;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CACiC,CAAA;AAEnE,kFAAkF;AAClF,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAC9C,KAAK,CAAC,aAAa,CAAC,EACpB,KAAK,CAAC,aAAa,CAAC,CAOpB,CAAA;AAED,2DAA2D;AAC3D,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAC5C,KAAK,CAAC;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,EACjC,KAAK,CAAC;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CACyC,CAAA;AAE3E,0EAA0E;AAC1E,eAAO,MAAM,WAAW,WACf,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,KACnC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAQ5C,CAAA;AAEF,sEAAsE;AACtE,wBAAgB,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAWhE"}

package/dist/input.js

@@ -0,0 +1,231 @@
+import { PublicError, Refused } from 'ultimabase';
+import { decimalPattern, issueOf } from 'ultimabase/internal';
+const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const text = (value) => typeof value === 'string' ? { value } : { message: 'Expected a string.' };
+/** The email trimmed, lowercased and in NFC, the account's subject (D-113, D-115). */
+export function emailOf(value) {
+    if (typeof value !== 'string')
+        return { message: 'Expected a string.' };
+    const email = value.trim().toLowerCase().normalize('NFC');
+    if (email.length > 254 || !/^[^\s@]+@[^\s@]+$/.test(email)) {
+        return { message: 'Expected an email address.' };
+    }
+    return { value: email };
+}
+/** How a password is typed does not change it: NFKC (D-115, NIST SP 800-63B). */
+export const normalized = (password) => password.normalize('NFKC');
+/** A password to store, normalized: 8 to 256 characters, no other rule (D-113). */
+export function passwordOf(value) {
+    if (typeof value !== 'string')
+        return { message: 'Expected a string.' };
+    const password = normalized(value);
+    const length = Array.from(password).length;
+    if (length < 8 || length > 256) {
+        return { message: 'A password has 8 to 256 characters.' };
+    }
+    return { value: password };
+}
+/** `read`'s value, or a `VALIDATION_FAILED` naming `path`. */
+export function valid(read, value, path) {
+    const result = read(value);
+    if ('message' in result) {
+        const issues = [{ path: [path], message: result.message }];
+        throw new PublicError('VALIDATION_FAILED', `${path}: ${result.message}`, {
+            details: { issues },
+        });
+    }
+    // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- emailOf and passwordOf return the string they were given, normalized.
+    return result.value;
+}
+/** A property of `read`, whose JSON Schema is `json`. */
+export const property = (read, json, required = true) => ({ read, json, required });
+const [smallest, largest] = [-2_147_483_648, 2_147_483_647];
+/**
+ * A field's check, the kernel's (D-127, D-132, D-139): a date may come as an
+ * ISO string, and an optional field takes `null`.
+ */
+function readOf(field) {
+    return (given) => {
+        if (given === null && field.optional && !field.list)
+            return { value: given };
+        const value = field.type === 'dateTime' && typeof given === 'string'
+            ? new Date(given)
+            : given;
+        const message = issueOf(value, field);
+        return message === undefined ? { value } : { message };
+    };
+}
+function jsonOf(field) {
+    const { type, values = [], optional } = field;
+    if (field.list) {
+        const items = jsonOf({ ...field, list: false, optional: false });
+        return {
+            type: 'array',
+            items: type === 'string' ? { ...items, minLength: 1 } : items,
+        };
+    }
+    const integer = field.integer === true;
+    const base = type === 'dateTime' ||
+        type === 'date' ||
+        type === 'enum' ||
+        type === 'decimal'
+        ? 'string'
+        : integer
+            ? 'integer'
+            : type;
+    return {
+        type: optional ? [base, 'null'] : base,
+        ...(integer ? { minimum: smallest, maximum: largest } : {}),
+        ...(type === 'decimal' ? { pattern: decimalPattern } : {}),
+        ...(type === 'dateTime' ? { format: 'date-time' } : {}),
+        ...(type === 'date' ? { format: 'date' } : {}),
+        ...(type === 'enum' ? { enum: optional ? [...values, null] : values } : {}),
+    };
+}
+/** A json field's input JSON Schema, `{}` without an export (D-125). */
+function exported(schema) {
+    const standard = schema && Reflect.get(schema, '~standard');
+    const exporter = isObject(standard) ? standard['jsonSchema'] : undefined;
+    const input = isObject(exporter) ? exporter['input'] : undefined;
+    if (typeof input !== 'function')
+        return {};
+    try {
+        const node = Reflect.apply(input, exporter, [
+            { target: 'draft-2020-12' },
+        ]);
+        return isObject(node) ? node : {};
+    }
+    catch {
+        // A schema it cannot export takes any JSON value, as a field without one.
+        return {};
+    }
+}
+/** A json field: any value read here, its schema run by the kernel (D-125). */
+function jsonProperty(field, required, schema) {
+    const { $schema: _, $defs: defs, ...json } = exported(schema);
+    const typed = Object.keys(json).length > 0;
+    return {
+        read: (value) => ({ value }),
+        json: typed && field.optional ? { anyOf: [json, { type: 'null' }] } : json,
+        required,
+        ...(isObject(defs) ? { defs } : {}),
+    };
+}
+/**
+ * A user field a client may send at sign-up, a json one with its `validate`;
+ * a relation stops startup (D-113, D-125).
+ */
+export function fieldProperty(field, required, where, schema) {
+    if (field.kind !== 'scalar') {
+        throw new Refused(`${where}: ${field.name} is a relation, which sign-up does not take.`);
+    }
+    if (field.type === 'json')
+        return jsonProperty(field, required, schema);
+    return property(readOf(field), jsonOf(field), required);
+}
+/** An object of `properties`, which refuses any other key. */
+function objectRead(properties, value, path, issues) {
+    if (!isObject(value)) {
+        issues.push({ path, message: 'Expected an object.' });
+        return {};
+    }
+    const output = {};
+    for (const key of Object.keys(value)) {
+        if (!properties.has(key)) {
+            issues.push({ path: [...path, key], message: 'Unknown field.' });
+        }
+    }
+    for (const [key, { read, required }] of properties) {
+        const given = value[key];
+        if (given === undefined) {
+            if (required)
+                issues.push({ path: [...path, key], message: 'Required.' });
+            continue;
+        }
+        const result = read(given);
+        if ('message' in result) {
+            issues.push({ path: [...path, key], message: result.message });
+        }
+        else
+            output[key] = result.value;
+    }
+    return output;
+}
+function objectJson(properties) {
+    const required = [...properties].filter(([, each]) => each.required);
+    return {
+        type: 'object',
+        properties: Object.fromEntries([...properties].map(([key, each]) => [key, each.json])),
+        required: required.map(([key]) => key),
+        additionalProperties: false,
+    };
+}
+/**
+ * One `input` argument of the object `id`, typed `SignUpInput` over GraphQL
+ * for the id `SignUp`; the email is normalized, the dates read (D-113).
+ */
+export function namedInput(id, properties) {
+    const json = () => ({
+        $schema: 'https://json-schema.org/draft/2020-12/schema',
+        type: 'object',
+        properties: { input: { $ref: `#/$defs/${id}` } },
+        required: ['input'],
+        additionalProperties: false,
+        $defs: Object.assign({}, ...[...properties.values()].map((each) => each.defs), { [id]: objectJson(properties) }),
+    });
+    const validate = (value) => {
+        const issues = [];
+        const root = isObject(value) ? value : {};
+        const input = objectRead(properties, root['input'], ['input'], issues);
+        if (!isObject(value))
+            issues.push({ path: [], message: 'Expected an object.' });
+        // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- each property of O was read by its check above.
+        return issues.length > 0 ? { issues } : { value: { input: input } };
+    };
+    return {
+        '~standard': Object.freeze({
+            version: 1,
+            vendor: 'ultimabase-password',
+            validate,
+            jsonSchema: { input: json, output: json },
+        }),
+    };
+}
+const string = { type: 'string' };
+const email = property(emailOf, { type: 'string', format: 'email' });
+export const signInInput = namedInput('SignIn', new Map([
+    ['email', email],
+    ['password', property(text, string)],
+]));
+export const changePasswordInput = namedInput('ChangePassword', new Map([
+    ['currentPassword', property(text, string)],
+    ['newPassword', property(passwordOf, string)],
+]));
+/** What `requestPasswordReset` takes (D-117). */
+export const requestResetInput = namedInput('RequestPasswordReset', new Map([['email', email]]));
+/** What `resetPassword` takes: the email's token and the new password (D-117). */
+export const resetPasswordInput = namedInput('ResetPassword', new Map([
+    ['token', property(text, string)],
+    ['password', property(passwordOf, string)],
+]));
+/** What `verifyEmail` takes: the email's token (D-117). */
+export const verifyEmailInput = namedInput('VerifyEmail', new Map([['token', property(text, string)]]));
+/** The email, the password and the listed user fields, by their names. */
+export const signUpInput = (fields) => namedInput('SignUp', new Map([
+    ['email', email],
+    ['password', property(passwordOf, string)],
+    ...fields,
+]));
+/** An output's schema: typed and exported, never validated (D-45). */
+export function outputSchema(node) {
+    const json = () => node;
+    return {
+        '~standard': Object.freeze({
+            version: 1,
+            vendor: 'ultimabase-password',
+            // oxlint-disable-next-line typescript/no-unsafe-type-assertion -- an output is typed by its function, never validated (D-45).
+            validate: (value) => ({ value: value }),
+            jsonSchema: { input: json, output: json },
+        }),
+    };
+}

package/dist/models.d.ts

@@ -0,0 +1,57 @@
+import type { Field, ModelOf, ScalarOptions } from 'ultimabase';
+import { PublicError } from 'ultimabase';
+export declare const hour: number;
+type HashFields = {
+    readonly userId: Field<string, {
+        readonly unique: true;
+    }>;
+    readonly hash: Field<string, ScalarOptions<string>>;
+    /** New each time the password is set, kept when it is rehashed. */
+    readonly stamp: Field<string, {
+        readonly unique: true;
+    }>;
+};
+export declare const PasswordHash: ModelOf<'PasswordHash', HashFields, []>;
+type AttemptFields = {
+    readonly subject: Field<string, ScalarOptions<string>>;
+    readonly address: Field<string, ScalarOptions<string>>;
+    readonly at: Field<Date, ScalarOptions<Date>>;
+};
+export declare const PasswordAttempt: ModelOf<'PasswordAttempt', AttemptFields, []>;
+type RequestFields = {
+    readonly kind: Field<string, ScalarOptions<string>>;
+    /** An address's network, or a user for the emails it receives. */
+    readonly subject: Field<string, ScalarOptions<string>>;
+    readonly at: Field<Date, ScalarOptions<Date>>;
+};
+export declare const PasswordRequest: ModelOf<'PasswordRequest', RequestFields, []>;
+/**
+ * What the limits count for `address`: an IPv6 address's /64 network, the
+ * IPv4 address an IPv4-mapped one holds, in any notation, any other as it is
+ * (D-114).
+ */
+export declare function networkOf(address: string): string;
+/** Where an attempt comes from; `undefined` for server code, not counted. */
+export type Attempt = {
+    readonly subject: string;
+    readonly address: string;
+} | undefined;
+/**
+ * Counts an attempt as failed until `run` succeeds, so concurrent attempts
+ * cannot pass the limit (D-113, D-114). Within 15 minutes, the 11th from one
+ * address on a subject is refused, as the 101st on it or from the address;
+ * a success clears its address's count, a busy refusal is not counted.
+ */
+export declare function limited<T>(attempt: Attempt, run: () => Promise<T>): Promise<T>;
+/** What the hourly limits count (D-114, D-117). */
+export type RequestKind = 'signUp' | 'reset' | 'verify' | 'email';
+/**
+ * Counts a request of `kind` from `subject`; past `most` within one hour,
+ * the refusal instead, and the request is not counted. It is counted before
+ * the others are, so concurrent requests cannot pass the limit (D-114).
+ */
+export declare function hourly(kind: RequestKind, subject: string, most: number): Promise<PublicError | undefined>;
+/** Refuses the eleventh request of `kind` from `address` within one hour (D-114, D-117). */
+export declare function requestLimited(kind: RequestKind, address: string): Promise<void>;
+export {};
+//# sourceMappingURL=models.d.ts.map

package/dist/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../src/models.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAuB,WAAW,EAAE,MAAM,YAAY,CAAA;AAO7D,eAAO,MAAM,IAAI,EAAE,MAAuB,CAAA;AAE1C,KAAK,UAAU,GAAG;IACjB,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAC,CAAA;IACzD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACnD,mEAAmE;IACnE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAC,CAAA;CACxD,CAAA;AAED,eAAO,MAAM,YAAY,EAAE,OAAO,CAAC,cAAc,EAAE,UAAU,EAAE,EAAE,CAQ9D,CAAA;AAEH,KAAK,aAAa,GAAG;IACpB,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACtD,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACtD,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAA;CAC7C,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,iBAAiB,EAAE,aAAa,EAAE,EAAE,CASvE,CAAA;AAEH,KAAK,aAAa,GAAG;IACpB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACnD,kEAAkE;IAClE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;IACtD,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAA;CAC7C,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,iBAAiB,EAAE,aAAa,EAAE,EAAE,CASvE,CAAA;AAEH;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAMjD;AAYD,6EAA6E;AAC7E,MAAM,MAAM,OAAO,GAClB;IAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAA;AAenE;;;;;GAKG;AACH,wBAAsB,OAAO,CAAC,CAAC,EAC9B,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACnB,OAAO,CAAC,CAAC,CAAC,CAiCZ;AAED,mDAAmD;AACnD,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;AAEjE;;;;GAIG;AACH,wBAAsB,MAAM,CAC3B,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACV,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAmBlC;AAED,4FAA4F;AAC5F,wBAAsB,cAAc,CACnC,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC,CAGf"}

package/dist/models.js

@@ -0,0 +1,122 @@
+// password's own models (D-110, D-113, D-114, D-117): each user's hash, and
+// what the sign-in limit and the hourly limits count.
+import ipaddr from 'ipaddr.js';
+import { defineModel, master, PublicError } from 'ultimabase';
+const M = { as: master };
+const limit = 10;
+const ceiling = 100;
+const window = 15 * 60 * 1000;
+const requests = 10;
+export const hour = 60 * 60 * 1000;
+export const PasswordHash = defineModel({
+    name: 'PasswordHash',
+    fields: (f) => ({
+        userId: f.string({ unique: true }),
+        hash: f.string(),
+        stamp: f.string({ unique: true }),
+    }),
+});
+export const PasswordAttempt = defineModel({
+    name: 'PasswordAttempt',
+    fields: (f) => ({
+        subject: f.string(),
+        address: f.string(),
+        at: f.dateTime(),
+    }),
+    indexes: [{ fields: ['subject', 'address'] }, { fields: ['at'] }],
+});
+export const PasswordRequest = defineModel({
+    name: 'PasswordRequest',
+    fields: (f) => ({
+        kind: f.string(),
+        subject: f.string(),
+        at: f.dateTime(),
+    }),
+    indexes: [{ fields: ['kind', 'subject'] }, { fields: ['at'] }],
+});
+/**
+ * What the limits count for `address`: an IPv6 address's /64 network, the
+ * IPv4 address an IPv4-mapped one holds, in any notation, any other as it is
+ * (D-114).
+ */
+export function networkOf(address) {
+    if (!ipaddr.IPv6.isValid(address))
+        return address;
+    const ip = ipaddr.IPv6.parse(address);
+    if (ip.isIPv4MappedAddress())
+        return ip.toIPv4Address().toString();
+    const prefix = ip.parts.slice(0, 4).map((group) => group.toString(16));
+    return `${prefix.join(':')}::/64`;
+}
+const tooMany = (oldest, span, now) => new PublicError('TOO_MANY_ATTEMPTS', 'Too many attempts: try again later.', {
+    details: {
+        retryAfter: Math.max(Math.ceil((oldest.getTime() + span - now) / 1000), 1),
+    },
+});
+/** The `n`th most recent failure but `id` matching `where`, if there is one. */
+async function nth(where, id, n) {
+    const failures = await PasswordAttempt.findMany({ where: { ...where, id: { not: id } }, orderBy: { at: 'desc' }, take: n }, M);
+    return failures[n - 1]?.at;
+}
+/**
+ * Counts an attempt as failed until `run` succeeds, so concurrent attempts
+ * cannot pass the limit (D-113, D-114). Within 15 minutes, the 11th from one
+ * address on a subject is refused, as the 101st on it or from the address;
+ * a success clears its address's count, a busy refusal is not counted.
+ */
+export async function limited(attempt, run) {
+    if (attempt === undefined)
+        return run();
+    const { subject } = attempt;
+    const address = networkOf(attempt.address);
+    const now = Date.now();
+    const since = new Date(now - window);
+    await PasswordAttempt.deleteMany({ where: { at: { lte: since } } }, M);
+    const { id } = await PasswordAttempt.create({ data: { subject, address, at: new Date(now) } }, M);
+    // Several may be reached: the latest says when to retry.
+    const [oldest] = [
+        await nth({ subject, address }, id, limit),
+        await nth({ subject }, id, ceiling),
+        await nth({ address }, id, ceiling),
+    ]
+        .filter((at) => at !== undefined)
+        .toSorted((a, b) => b.getTime() - a.getTime());
+    if (oldest !== undefined) {
+        await PasswordAttempt.deleteMany({ where: { id } }, M);
+        throw tooMany(oldest, window, now);
+    }
+    try {
+        const result = await run();
+        await PasswordAttempt.deleteMany({ where: { subject, address } }, M);
+        return result;
+    }
+    catch (error) {
+        if (error instanceof PublicError && error.code === 'TOO_MANY_ATTEMPTS') {
+            await PasswordAttempt.deleteMany({ where: { id } }, M);
+        }
+        throw error;
+    }
+}
+/**
+ * Counts a request of `kind` from `subject`; past `most` within one hour,
+ * the refusal instead, and the request is not counted. It is counted before
+ * the others are, so concurrent requests cannot pass the limit (D-114).
+ */
+export async function hourly(kind, subject, most) {
+    const now = Date.now();
+    await PasswordRequest.deleteMany({ where: { at: { lte: new Date(now - hour) } } }, M);
+    const { id } = await PasswordRequest.create({ data: { kind, subject, at: new Date(now) } }, M);
+    const where = { kind, subject, id: { not: id } };
+    const recent = await PasswordRequest.findMany({ where, orderBy: { at: 'desc' }, take: most }, M);
+    const oldest = recent[most - 1];
+    if (oldest === undefined)
+        return undefined;
+    await PasswordRequest.deleteMany({ where: { id } }, M);
+    return tooMany(oldest.at, hour, now);
+}
+/** Refuses the eleventh request of `kind` from `address` within one hour (D-114, D-117). */
+export async function requestLimited(kind, address) {
+    const refused = await hourly(kind, networkOf(address), requests);
+    if (refused !== undefined)
+        throw refused;
+}

package/dist/plugin.d.ts

@@ -0,0 +1,75 @@
+import type { Auth } from '@ultimabase/auth';
+import type { Client, Field, Identity, Payload, PluginOf, PluginTypes, Queries, Register, UseOf, UserOf } from 'ultimabase';
+import type { SignedIn } from './core.ts';
+import type { SendEmail } from './email-functions.ts';
+import type { Credentials } from './input.ts';
+/** The user fields a sign-up may take; any name before the user is registered. */
+export type UserField = Register extends {
+    readonly user: unknown;
+} ? Extract<Exclude<keyof UserOf<Register>, 'id' | 'createdAt' | 'updatedAt'>, string> : string;
+export interface PasswordOptions {
+    /** The user fields `signUp` takes besides the email and the password; `false` closes sign-up. */
+    readonly signUp?: readonly UserField[] | false;
+    /**
+     * Sends an email that carries a token: a reset or a verification link
+     * the application writes. Without it, no function sends one (D-117).
+     */
+    readonly sendEmail?: SendEmail;
+}
+type Options = {
+    readonly as?: Identity;
+};
+/** A transport's client, which counts the attempt and gets the cookie (D-115). */
+type SignInOptions = Options & {
+    readonly client?: Client;
+};
+type CreateData<F> = Parameters<Queries<F>['create']>[0]['data'];
+type UserRow<F> = Payload<F, {}>;
+/** password's commands on the user model (D-113). */
+export interface PasswordCommands<F> {
+    /** Creates the user, its account and its hash; opens no session. */
+    signUp(args: Credentials & {
+        readonly data: CreateData<F>;
+    }, options?: Options): Promise<UserRow<F>>;
+    /**
+     * Opens a session; with a `client`, counted and with its cookie as the
+     * signIn function, otherwise never limited.
+     */
+    signIn(args: Credentials, options?: SignInOptions): Promise<SignedIn<UserRow<F>>>;
+    /**
+     * Replaces the password and ends every session, as Master or as the user.
+     * It takes no current password: check the user's intent first, as
+     * changePassword does.
+     */
+    setPassword(args: {
+        readonly id: string;
+        readonly password: string;
+    }, options?: Options): Promise<void>;
+}
+/** password's types (D-57). */
+export interface Password extends PluginTypes {
+    readonly name: 'password';
+    readonly requires: Auth;
+    readonly appOptions: PasswordOptions;
+    readonly addedFields: {
+        readonly emailVerified: Field<boolean, {
+            readonly default: false;
+        }>;
+    };
+    readonly commands: PasswordCommands<this['fields']>;
+}
+/**
+ * The password sign-in method; it requires `authPlugin()`.
+ *
+ * Known and kept (D-115): `signUp` refuses a taken email with
+ * `UNIQUE_VIOLATION`, which tells that the email has an account until email
+ * verification can hide it; a hundred failures on one account within 15
+ * minutes, from any addresses, lock it for everyone, and a hundred from one
+ * address lock that address out of every account (D-114); `SignedIn`
+ * holds the token even when the cookie is set.
+ */
+export declare const passwordPlugin: PluginOf<Password>;
+/** The user model's entry: its commands, and its hash deleted with it. */
+export declare const password: UseOf<Password>;
+export {};
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,kBAAkB,CAAA;AAErD,OAAO,KAAK,EACX,MAAM,EAEN,KAAK,EACL,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,WAAW,EACX,OAAO,EACP,QAAQ,EACR,KAAK,EACL,MAAM,EACN,MAAM,YAAY,CAAA;AASnB,OAAO,KAAK,EAAE,QAAQ,EAAS,MAAM,WAAW,CAAA;AAQhD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAGrD,OAAO,KAAK,EAAE,WAAW,EAAY,MAAM,YAAY,CAAA;AAKvD,kFAAkF;AAClF,MAAM,MAAM,SAAS,GAAG,QAAQ,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GAChE,OAAO,CACP,OAAO,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,CAAC,EACjE,MAAM,CACN,GACA,MAAM,CAAA;AAET,MAAM,WAAW,eAAe;IAC/B,iGAAiG;IACjG,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,SAAS,EAAE,GAAG,KAAK,CAAA;IAC9C;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAC9B;AAED,KAAK,OAAO,GAAG;IAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAA;AACzC,kFAAkF;AAClF,KAAK,aAAa,GAAG,OAAO,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAC3D,KAAK,UAAU,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAChE,KAAK,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;AAEhC,qDAAqD;AACrD,MAAM,WAAW,gBAAgB,CAAC,CAAC;IAClC,oEAAoE;IACpE,MAAM,CACL,IAAI,EAAE,WAAW,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;KAAE,EACpD,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;IACtB;;;OAGG;IACH,MAAM,CACL,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC;;;;OAIG;IACH,WAAW,CACV,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EACxD,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,IAAI,CAAC,CAAA;CAChB;AAED,+BAA+B;AAC/B,MAAM,WAAW,QAAS,SAAQ,WAAW;IAC5C,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;IACvB,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE;QACrB,QAAQ,CAAC,aAAa,EAAE,KAAK,CAAC,OAAO,EAAE;YAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAA;SAAE,CAAC,CAAA;KACnE,CAAA;IACD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;CACnD;AAqMD;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,QAAQ,CAAqB,CAAA;AACnE,0EAA0E;AAC1E,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAkB,CAAA"}