permdock 0.8.0 → 0.10.0

package/dist/sources-B1Os_YUu.d.ts

@@ -1,312 +0,0 @@
-import { et as MembershipSource } from "./policy-types-CCiDRZBH.js";
-import { n as RoleMap, r as RoleThrough, x as SupabaseSuspension } from "./types-ah9NlU6j.js";
-import { t as SqlQuery } from "./sql-B80DFdpG.js";
-import { c as SupabaseManifestMembership } from "./manifest-CzzWtnAb.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;
-};
-/**
- * One role source of a membership row: a key column, or a reference to a roles
- * table.
- */
-type RoleSource = string | RoleThrough | RoleMap;
-/** A role source, or several the row holds at once. */
-type RoleSpec = RoleSource | readonly RoleSource[];
-/**
- * A roles table whose tenant rows are written by tenants. A role key read
- * through it from a tenant row that is one of `declared` reads as null, so a
- * tenant cannot claim the grants of a declared role by naming a role after it.
- */
-type RoleGuard = {
-  /** `schema.table`, or `public`. */
-  readonly table: string;
-  /** The tenant column of the roles table. */
-  readonly tenant: string;
-  /**
-   * A tenant row with this column true is the application's own copy of a
-   * declared role.
-   */
-  readonly skip?: string | undefined;
-  readonly declared: readonly string[];
-};
-//#endregion
-//#region src/supabase/sources.d.ts
-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?: RoleSpec;
-    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;
-    /** A `jsonb` column of app data (`Membership.x`); never written into claims. */
-    readonly x?: 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 | RoleMap | readonly string[] | {
-    readonly sources: readonly RoleSource[];
-  };
-  /** 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;
-  /** A `jsonb` column of app data (`Membership.x`); never written into claims. */
-  readonly x?: 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 as plain columns, for Sync Streams and `powerSyncSource`; a source
-   * without it does not sync.
-   */
-  readonly stream?: MembershipStream;
-};
-/**
- * One membership source as columns a Sync Streams query can filter on. Tables
- * are `schema.table`; a `through` table is qualified in the source's schema
- * when it names none.
- */
-type MembershipStream = {
-  readonly table: string;
-  /** The user id column, or the reference to the table that holds the user id. */
-  readonly user: string | RoleThrough;
-  /** The scope column, or the scope every row is a membership of. */
-  readonly scope: {
-    readonly column: string;
-  } | {
-    readonly value: string;
-  };
-  readonly id: string;
-  /**
-   * The role sources (the row holds every non-null key), or the fixed roles
-   * every row holds.
-   */
-  readonly roles: RoleSpec | {
-    readonly value: readonly string[];
-  };
-  /** The membership kind column, or the kind every row has. */
-  readonly via?: {
-    readonly column: string;
-  } | {
-    readonly value: string;
-  };
-  readonly expiresAt?: string;
-  readonly disabledAt?: string;
-  /**
-   * A row may hold no role key: such a row is no membership, and a reader drops
-   * it.
-   */
-  readonly nullableRoles: boolean;
-  /**
-   * The guard the source reads its roles table with: a tenant row named like a
-   * declared role is no role.
-   */
-  readonly guard?: RoleGuard;
-};
-/**
- * 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 same source with the role keys of tenant rows of `guard.table` named
-   * like a declared role read as null.
-   */
-  readonly guarded?: (guard: RoleGuard) => SqlMembershipSource;
-};
-/** The part of `@supabase/server`'s `PostgresApi` a `SqlQuery` needs. */
-type SupabasePostgres = {
-  readonly queryRaw: (text: string, params?: unknown[]) => Promise<readonly Record<string, unknown>[]>;
-};
-declare function supabasePostgresQuery(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 tableMembershipSource(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 junctionMembershipSource(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 { MembershipStream as a, SupabasePostgres as c, supabasePostgresQuery as d, tableMembershipSource as f, MembershipSql as i, authzVersion as l, MembershipHolders as n, MembershipTableOptions as o, MembershipJunctionOptions as r, SqlMembershipSource as s, AUTHZ_VERSION_TABLE as t, junctionMembershipSource as u };

package/dist/supabase-hook-H-MtE9Wd.js

@@ -1 +0,0 @@
-export { i as runSupabase } from "./supabase-hook-B-yXnzUl.js";

package/dist/usage-CYeXek0p.js

@@ -1 +0,0 @@
-export { t as runUsage } from "./usage-CxEzS4ey.js";

package/dist/watch-DB42U1ib.js

@@ -1 +0,0 @@
-export { i as watchCollect } from "./watch-Cx_WciLE.js";