@binary1702/auth 0.2.5 → 0.4.0

package/dist/core/db.d.ts

@@ -1,26 +1,171 @@
 import { TABLE } from "./config.ts";
 import type { User } from "./session.ts";
-export declare function ensureSchema(): Promise<void>;
-type Row = {
+export type Statement = {
+    text: string;
+    params?: unknown[];
+};
+/** What the package needs from a database: parameterised queries, and a transaction if it has one. */
+export interface Db {
+    query<T = Record<string, unknown>>(text: string, params?: unknown[]): Promise<T[]>;
+    /** Run statements in one transaction. A store without it runs them one by one. */
+    transaction?(statements: Statement[]): Promise<void>;
+}
+/** The real store, created once per process from DATABASE_URL. */
+export declare function db(): Db;
+export type Migration = {
+    id: number;
+    name: string;
+    statements: string[];
+};
+/**
+ * Ordered, append-only. Never edit a step that has shipped: add a new
+ * one. Step 1 is the 0.2.5 schema exactly, so an existing install
+ * applies it as a no-op through IF NOT EXISTS.
+ */
+export declare const MIGRATIONS: Migration[];
+/**
+ * The package's tables have plain names (users, orgs, members, tokens).
+ * A database that already holds a `users` table of its own would be
+ * silently shared by CREATE TABLE IF NOT EXISTS, so a fresh install
+ * checks first. Pure: decides from what the store reports.
+ */
+export declare function foreignUsersTable(columns: string[]): boolean;
+export declare const FOREIGN_USERS_TABLE = "This database already has a `users` table that is not this package's. Point DATABASE_URL at a database (or Postgres schema) of its own.";
+/** The steps still to run, in order. Pure. */
+export declare function pendingSteps(applied: number[], steps?: Migration[]): Migration[];
+/** Everything a pending step needs to run, including recording that it ran. Pure. */
+export declare function migrationStatements(steps: Migration[]): Statement[];
+/**
+ * Apply pending migrations. Memoized per store and per process, so
+ * route handlers can call it on every request for free after the first.
+ * A failure clears the memo so the next call retries.
+ */
+export declare function ensureSchema(store?: Db): Promise<void>;
+export type UserRow = {
     id: string;
     email: string;
     password_hash: string;
     epoch: number;
+    /** When the email was verified, or null */
+    verified_at: string | Date | null;
 };
-export declare function findUser(email: string): Promise<Row | null>;
-export declare function createUser(email: string, passwordHash: string): Promise<User & {
+export declare function findUser(email: string, store?: Db): Promise<UserRow | null>;
+/** Two sign-ups raced on one email and the second lost: the handler answers 409. */
+export declare class DuplicateUserError extends Error {
+    constructor(email: string);
+}
+/** Postgres's unique_violation */
+export declare const isUniqueViolation: (err: unknown) => boolean;
+export declare function createUser(email: string, passwordHash: string, opts?: {
+    verified?: boolean;
+}, store?: Db): Promise<User & {
     epoch: number;
+    verified: boolean;
 }>;
+/** Replace a hash with one made under stronger parameters. No epoch bump: nothing about the session changes. */
+export declare function rehashPassword(id: string, passwordHash: string, store?: Db): Promise<void>;
+/** What a session check needs about the user: current epoch and verification. Null if the user is gone. */
+export type UserState = {
+    epoch: number;
+    verified: boolean;
+};
+export declare function userState(id: string, store?: Db): Promise<UserState | null>;
 /** The user's current session_epoch, or null if the user is gone */
-export declare function sessionEpoch(id: string): Promise<number | null>;
+export declare function sessionEpoch(id: string, store?: Db): Promise<number | null>;
+/** Everything a session needs, in one query: the user's state, their active organization, and what the admin page saved for their role. */
+export type SessionRow = UserState & {
+    id: string;
+    email: string;
+    org_id: string | null;
+    org_name: string | null;
+    role: string | null;
+    /** permissions saved on /auth/admin for this role in this organization, or null */
+    stored_org?: string[] | null;
+    /** permissions saved on /auth/admin for this role in every organization, or null */
+    stored_all?: string[] | null;
+};
+export declare function sessionRow(id: string, store?: Db): Promise<SessionRow | null>;
+export type StoredRole = {
+    scope: string;
+    name: string;
+    permissions: string[];
+    updated_at: string;
+};
+/** Every saved role, all scopes. */
+export declare function storedRoles(store?: Db): Promise<StoredRole[]>;
+/** Save what a role may do: for every organization (scope "") or one (its id). Replaces the previous list. */
+export declare function setRolePermissions(scope: string, name: string, permissions: string[], store?: Db): Promise<void>;
+/** Forget an organization's own rule for a role: it follows the rule for every organization again. False if there was none. */
+export declare function resetRole(scope: string, name: string, store?: Db): Promise<boolean>;
+/**
+ * The starting point, written once: every role from b17_auth.yaml `roles:`
+ * that has no row for every organization yet. A role the admin page has
+ * already saved is never touched. Returns the names written.
+ */
+export declare function seedRoles(defaults: Record<string, string[]>, store?: Db): Promise<string[]>;
+/** The user's role in one organization, or null when they are not a member. */
+export declare function memberRole(userId: string, orgId: string, store?: Db): Promise<string | null>;
+export type OrgRow = {
+    id: string;
+    name: string;
+    created_at: string;
+};
+export declare function createOrg(name: string, store?: Db): Promise<OrgRow>;
+/** By id (UUID) or exact name. Null if there is no such organization. */
+export declare function findOrg(idOrName: string, store?: Db): Promise<OrgRow | null>;
+export declare function listOrgs(store?: Db): Promise<(OrgRow & {
+    members: number;
+})[]>;
+/** Add or update a membership. Becomes the user's active org if they had none. */
+export declare function addMember(orgId: string, userId: string, role: string, store?: Db): Promise<void>;
+export declare function removeMember(orgId: string, userId: string, store?: Db): Promise<boolean>;
+export declare function removeOrg(orgId: string, store?: Db): Promise<boolean>;
+export type Membership = {
+    org_id: string;
+    org: string;
+    role: string;
+};
+export type AdminUser = {
+    id: string;
+    email: string;
+    created_at: string;
+    verified: boolean;
+    memberships: Membership[];
+};
+export type AdminOrg = {
+    id: string;
+    name: string;
+    created_at: string;
+    members: {
+        user_id: string;
+        email: string;
+        role: string;
+    }[];
+};
+/** Every user with their memberships, one query. */
+export declare function adminUsers(store?: Db): Promise<AdminUser[]>;
+/** Every organization with its members, one query. */
+export declare function adminOrgs(store?: Db): Promise<AdminOrg[]>;
+/** Switch the user's active organization. False unless they are a member of it: the client's choice is checked, never trusted. */
+export declare function setActiveOrg(userId: string, orgId: string, store?: Db): Promise<boolean>;
+/** Record that the user followed the verification link. Idempotent. Null if the user is gone. */
+export declare function markVerified(id: string, store?: Db): Promise<User | null>;
 /** Revoke every session of this user. False if there is no such user. */
-export declare function revokeSessions(email: string): Promise<boolean>;
+export declare function revokeSessions(email: string, store?: Db): Promise<boolean>;
 /** Delete the user. Their sessions die with the row. False if none. */
-export declare function removeUser(email: string): Promise<boolean>;
-export declare function countUsers(): Promise<number>;
-export declare function listUsers(): Promise<(User & {
+export declare function removeUser(email: string, store?: Db): Promise<boolean>;
+export declare function countUsers(store?: Db): Promise<number>;
+export declare function listUsers(store?: Db): Promise<(User & {
     created_at: string;
 })[]>;
 /** Change a password. Also revokes every session, old password's included. */
-export declare function setPassword(email: string, passwordHash: string): Promise<boolean>;
+export declare function setPassword(email: string, passwordHash: string, store?: Db): Promise<boolean>;
+/**
+ * Same, by id, for a reset link. Also marks the email verified: following
+ * the link proved the address. Returns the user with the new epoch so the
+ * caller can sign them in; null if the user is gone.
+ */
+export declare function setPasswordById(id: string, passwordHash: string, store?: Db): Promise<(User & {
+    epoch: number;
+}) | null>;
 export { TABLE };