permdock 0.0.0 → 0.2.0

package/dist/sources-BcJgw0lt.d.ts

@@ -0,0 +1,192 @@
+import { gt as MembershipSource } from "./policy-CFZAr_Al.js";
+import { n as RoleThrough, y as SupabaseSuspension } from "./types-yF5LmQVD.js";
+import { o as SupabaseManifestMembership } from "./manifest-uDS9y5de.js";
+//#region src/supabase/roles.d.ts
+/** A roles table a role column references, by `schema.table`. */
+type RoleKeys = {
+  readonly table: string;
+  /** The roles table column the reference points at. */
+  readonly id: string;
+  /** The roles table column holding the role key. */
+  readonly key: string;
+  /** The referencing table's column. */
+  readonly ref: string;
+};
+//#endregion
+//#region src/supabase/sources.d.ts
+/**
+ * Runs one parameterised statement: `pg`'s `client.query` (which resolves
+ * `{ rows }`) and `postgres`'s `sql.unsafe` (which resolves the rows) both fit.
+ */
+type SqlQuery = (text: string, values: readonly unknown[]) => Promise<readonly Record<string, unknown>[] | {
+  readonly rows: readonly Record<string, unknown>[];
+}>;
+type Common = {
+  readonly table: string;
+  /** Runs the lookups; without it the source only describes SQL (for `permdock supabase hook generate`). */
+  readonly query?: SqlQuery;
+  /** Drop suspended users and memberships under suspended instances, like `rls.suspension`. */
+  readonly suspension?: SupabaseSuspension;
+};
+type MembershipTableOptions = Common & {
+  /** Column names; `user`, `scope`, `id` and `role` default to `user_id`, `scope`, `scope_id`, `role`. */
+  readonly columns?: {
+    /** The user id column, or a reference to a table that holds the user id. */
+    readonly user?: string | RoleThrough;
+    readonly scope?: string;
+    readonly id?: string;
+    /** A `jsonb` column of ancestor ids keyed by scope name. */
+    readonly within?: string;
+    /**
+     * The role key column, a reference to a roles table that holds the key,
+     * or several of them: the row holds every non-null key.
+     */
+    readonly role?: string | RoleThrough | readonly (string | RoleThrough)[];
+    readonly via?: string;
+    readonly expiresAt?: string;
+    readonly disabledAt?: string;
+    /** The principal id that wrote the membership (`grantedBy`). */
+    readonly grantedBy?: string;
+    /** Free-text justification recorded on the membership (`reason`). */
+    readonly reason?: string;
+    /** A subgroup column filling `member.group`. */
+    readonly group?: string;
+    /** A text column; the value `idp` marks the row as owned by the identity provider. */
+    readonly managedBy?: string;
+    /** A `text[]` column of seats. */
+    readonly seats?: string;
+  };
+};
+type MembershipJunctionOptions = Common & {
+  /** The declared scope every row is a membership of. */
+  readonly scope: string;
+  /** The user id column (default `user_id`), or a reference to a table that holds the user id. */
+  readonly user?: string | RoleThrough;
+  /** The column holding the scope instance id. Default `<scope>_id`. */
+  readonly id?: string;
+  /** Ancestor id columns keyed by scope name. */
+  readonly within?: Readonly<Record<string, string>>;
+  /**
+   * A role column, a reference to a roles table that holds the key, fixed
+   * roles every row holds (a contact table with no role column), or
+   * `{ sources }`: several role columns whose non-null keys the row holds.
+   */
+  readonly roles: string | RoleThrough | readonly string[] | {
+    readonly sources: readonly (string | RoleThrough)[];
+  };
+  /** The membership kind every row has (`contact`, `staff`, `partner`). */
+  readonly via?: string;
+  readonly expiresAt?: string;
+  readonly disabledAt?: string;
+  /** The principal id that wrote the membership (`grantedBy`). */
+  readonly grantedBy?: string;
+  /** Free-text justification recorded on the membership (`reason`). */
+  readonly reason?: string;
+  /** A subgroup filling `member.group`: a fixed name every row has, or a column. */
+  readonly group?: string | {
+    readonly column: string;
+  };
+  /** `idp` when the identity provider owns every row, or a text column holding `idp` per row. */
+  readonly managedBy?: "idp" | {
+    readonly column: string;
+  };
+  /** A `text[]` column of seats. */
+  readonly seats?: string;
+};
+/** What `permdock supabase hook generate` compiles; the same SQL the source runs. */
+type MembershipSql = {
+  readonly table: string;
+  /** The table's user column: the user id, or with `userThrough` the reference to the row holding it. */
+  readonly user: string;
+  /** The table that holds the user id when `user` references it; a change of that id bumps the old and the new user. */
+  readonly userThrough?: RoleKeys;
+  /** `<table>.<user>%type`: the PL/pgSQL type of the user id column, for a variable `select` compares with. */
+  readonly userType: string;
+  /**
+   * The `select` of claim rows for one user, with every filter applied.
+   * `user` must have the column's type (a `userType` variable, or an untyped
+   * `$1` Postgres infers): the column is compared uncast so its index applies.
+   * `keep` adds the `keep` column; it defaults to `keeps`, and a `union`
+   * with a source that keeps passes `true`.
+   */
+  select(user: string, keep?: boolean): string;
+  /** The `select` of member rows for one scope instance (`$1` scope, `$2` id). */
+  list(keep?: boolean): string;
+  /** A suspended scope on the source keeps permissions: rows of its suspended instances stay, with a `keep` column. */
+  readonly keeps: boolean;
+  /** A text column holding `idp` for rows the identity provider owns; `''` when every row is owned. */
+  readonly managed?: string;
+  /** Other tables the `select` reads (suspension tables). */
+  readonly reads: readonly string[];
+  /** The roles table the role column references; a key change bumps every holder's authorization version. */
+  readonly through?: RoleKeys;
+  /** Every roles table the role columns reference, `through` first. */
+  readonly throughs: readonly RoleKeys[];
+  /** Every column that decides who holds which membership: user, scope, id, `within`, role, `via` and expiry. */
+  readonly columns: readonly string[];
+  /** For a single-scope source: its scope and the scopes whose ids each row carries. */
+  readonly scope?: string;
+  readonly holds?: readonly string[];
+  /** The source's entry in the hook manifest's `memberships`. */
+  readonly manifest: SupabaseManifestMembership;
+  /** What the ownership triggers count; absent on a source that is not a table. */
+  readonly holders?: MembershipHolders;
+};
+/**
+ * The rows of a membership table, for the holder-count and transfer-only
+ * triggers `permdock rls generate` puts on it. No suspension filter: a
+ * suspended holder still holds the role.
+ */
+type MembershipHolders = {
+  /** `<table>.<id column>%type`: the type of a variable `rows` compares the id column with. */
+  readonly idType: string;
+  /** The instance id of scope `scope` the PL/pgSQL record `row` holds, as text; null on a row of another scope. */
+  id(scope: string, row: string): string;
+  /**
+   * `select id, user_id, role, via, live` over the rows of scope `scope`
+   * in `from` (default the table): one row per held role key, `live` false
+   * once expired. `id` is an expression of `idType` the id column must equal.
+   */
+  rows(scope: string, options?: {
+    readonly id?: string;
+    readonly from?: string;
+  }): string;
+};
+type SqlMembershipSource = MembershipSource & {
+  readonly sql: MembershipSql;
+};
+/** The part of `@supabase/server`'s `PostgresApi` a `SqlQuery` needs. */
+type SupabasePostgres = {
+  readonly queryRaw: (text: string, params?: unknown[]) => Promise<readonly Record<string, unknown>[]>;
+};
+/**
+ * `ctx.postgres` (from `withPostgresClient`) or `ctx.postgresAdmin` as a
+ * `SqlQuery` for `fromTable`, `fromJunction` and `supabaseApprovalStore`.
+ * `ctx.postgres` runs as the caller under RLS, so the membership tables must
+ * be readable by `authenticated`; `ctx.postgresAdmin` bypasses RLS.
+ */
+declare function fromSupabasePostgres(postgres: SupabasePostgres): SqlQuery;
+/**
+ * Memberships from one table holding every scope: a row per user, scope,
+ * instance and role (`user_id, scope, scope_id, role`), with optional
+ * `within`, `via`, expiry, owner and seat columns. Rows of the same instance
+ * merge into one membership.
+ */
+declare function fromTable(options: MembershipTableOptions): SqlMembershipSource;
+/**
+ * Memberships from a table of one scope (`customer_contacts`): every row is a
+ * membership of `scope`, with roles from a column or fixed (`['contact']`), a
+ * fixed `via`, and ancestor ids from `within` columns.
+ */
+declare function fromJunction(options: MembershipJunctionOptions): SqlMembershipSource;
+declare const AUTHZ_VERSION_TABLE = "permdock_authz_version";
+/**
+ * Reads the authorization version `permdock supabase hook generate` keeps in
+ * `<schema>.permdock_authz_version`: pass it to `claimsFirst(sources, { version })`.
+ */
+declare function authzVersion(options: {
+  readonly query: SqlQuery;
+  readonly schema?: string;
+}): NonNullable<MembershipSource["version"]>;
+//#endregion
+export { MembershipTableOptions as a, SupabasePostgres as c, fromSupabasePostgres as d, fromTable as f, MembershipSql as i, authzVersion as l, MembershipHolders as n, SqlMembershipSource as o, MembershipJunctionOptions as r, SqlQuery as s, AUTHZ_VERSION_TABLE as t, fromJunction as u };

package/dist/sql-xdg5f4Fi.js

@@ -0,0 +1,27 @@
+//#region src/core/sql.ts
+/** A bare Postgres identifier PermDock emits unquoted-safe: letters, digits and `_`, not starting with a digit. */
+const SQL_IDENT = /^[A-Za-z_][A-Za-z0-9_]*$/u;
+/** A validated, double-quoted identifier; anything outside `SQL_IDENT` throws. */
+function quoteSqlIdent(name, prefix = "PermDock") {
+	if (!SQL_IDENT.test(name)) throw new TypeError(`${prefix}: unsafe SQL identifier '${name}'`);
+	return `"${name}"`;
+}
+/** A schema-qualified name, each part validated by `quoteSqlIdent`. */
+function quoteSqlTable(name, prefix = "PermDock") {
+	return name.split(".").map((part) => quoteSqlIdent(part, prefix)).join(".");
+}
+/** A single-quoted string literal with embedded quotes doubled. */
+function quoteSqlLiteral(value) {
+	return `'${value.replaceAll("'", "''")}'`;
+}
+/** A double-quoted identifier read back from a database, embedded quotes doubled rather than refused. */
+function escapeSqlIdent(name) {
+	return `"${name.replaceAll("\"", "\"\"")}"`;
+}
+const PLAIN_IDENT = /^[a-z_][a-z0-9_]*$/u;
+/** An identifier left bare when it is already lower snake case, otherwise quoted by `escapeSqlIdent`. */
+function sqlIdent(name) {
+	return PLAIN_IDENT.test(name) ? name : escapeSqlIdent(name);
+}
+//#endregion
+export { quoteSqlTable as a, quoteSqlLiteral as i, escapeSqlIdent as n, sqlIdent as o, quoteSqlIdent as r, SQL_IDENT as t };