permdock 0.3.1 → 0.5.0

package/dist/index-C7Tw7MaW.d.ts

@@ -1,201 +0,0 @@
-import { Mr as Membership, Pr as Subject, Pt as TokenSigner, Yn as Decision, bt as RelationSource, ln as PermDock } from "./policy-IB6yxpC3.js";
-import { f as Permission, m as PermissionTree } from "./permissions-DttnqqxC.js";
-import { a as ApprovalListFilter, c as ApprovalRequest, f as ApprovalStore, i as ApprovalInspectResult, m as ApprovalVerdict, o as ApprovalListQuery, r as ApprovalCancelMeta, s as ApprovalPage } from "./types-aqOHTHcp.js";
-//#region src/approvals/errors.d.ts
-type ApprovalErrorCode = "approval-not-found" | "approval-not-pending" | "approval-expired" | "approver-unauthenticated" | "approver-is-actor" | "approver-is-principal" | "approver-not-eligible" | "approver-repeated";
-declare class ApprovalError extends Error {
-  override readonly name: "ApprovalError";
-  readonly code: ApprovalErrorCode;
-  constructor(code: ApprovalErrorCode, message: string);
-}
-/** Matches by `name` and `code`, so an error from another copy of the module still maps. */
-declare function isApprovalError(value: unknown): value is ApprovalError;
-//#endregion
-//#region src/approvals/handler.d.ts
-type ApprovalsHandlerOptions = {
-  readonly subject: (request: Request) => Subject | null | undefined | Promise<Subject | null | undefined>;
-  /** Refuse the principal even on grants that set `approval: { distinct: false }`. */
-  readonly requireDistinctApprover?: boolean;
-  readonly signer?: TokenSigner;
-  readonly audience?: string | readonly string[];
-  /** Where `relation()` approvers are read, by the request's resource id; without it they match nobody. */
-  readonly relations?: RelationSource;
-  /** The policy's permission tree, for `through` links and `includes` on relation approvers. */
-  readonly permissions?: PermissionTree;
-  /**
-   * The approver's own instance in the request's tenant, for
-   * `holder(permission)` approvers (custom roles included when the instance
-   * reads a `RoleSource`). Without it, or when it throws, they match nobody.
-   */
-  readonly permdockFor?: (approver: Subject, request: ApprovalRequest) => PermDock | Promise<PermDock>;
-};
-declare function approvalsHandler(store: ApprovalStore, options: ApprovalsHandlerOptions): (request: Request) => Promise<Response>;
-//#endregion
-//#region src/approvals/relations.d.ts
-type ApproverRelationsOptions = {
-  /** The object graph relation approvers are read from; without it they match nobody. */
-  readonly relations?: RelationSource;
-  /** The permission tree the policy declares; needed to follow `through` links and `includes`. */
-  readonly permissions?: PermissionTree;
-  readonly now?: Date;
-};
-/**
- * The relation approvers of `request` that `subject` holds on its resource,
- * keyed by `approverRelationKey`, for `ApprovalVerdict.relations`. Reads go
- * through `relations` by the request's resource id; a request without an id,
- * a missing source or a read that fails holds nothing.
- */
-declare function approverRelations(request: ApprovalRequest, subject: Subject, options: ApproverRelationsOptions): Promise<readonly string[]>;
-//#endregion
-//#region src/approvals/helpers.d.ts
-declare function summariseSubject(subject: Subject): ApprovalRequest["subject"];
-declare function requestApproval(store: ApprovalStore, decision: Extract<Decision, {
-  readonly outcome: "approval-required";
-}>, meta: {
-  readonly permission: Permission | {
-    readonly key: string;
-    readonly scope: string;
-    readonly resource: string;
-  };
-  readonly resource?: {
-    readonly type: string;
-    readonly id?: string;
-  };
-  readonly subject: Subject;
-  readonly membership?: Membership;
-  readonly adapter?: string;
-  readonly ttl?: number;
-  readonly now?: Date;
-  readonly detail?: string;
-}): Promise<ApprovalRequest>;
-/**
- * Checks `verdict.by` and resolves the request. Relation approvers are read
- * through `options.relations` unless `verdict.relations` is already set.
- */
-declare function resolveApproval(store: ApprovalStore, token: string, verdict: ApprovalVerdict, options?: ApproverRelationsOptions & {
-  readonly requireDistinctApprover?: boolean;
-  readonly permdockFor?: ApprovalsHandlerOptions["permdockFor"];
-}): Promise<ApprovalRequest>;
-declare function vouchApproval(store: ApprovalStore, token: string, verdict: {
-  readonly status: "approved" | "rejected";
-  readonly by: Subject;
-  readonly rule: string;
-  readonly note?: string;
-}): Promise<ApprovalRequest>;
-declare function inspectApproval(store: ApprovalStore, token: string, now?: Date): Promise<ApprovalInspectResult>;
-/** Inspects `token` and, when it is approved, consumes it so it resumes once. */
-declare function consumeApproval(store: ApprovalStore, token: string, now?: Date): Promise<ApprovalInspectResult>;
-/**
- * Applies a resume token to a decision. The token only matters when the
- * decision is `approval-required` and the token is the one this call was
- * issued; otherwise a new approval is requested. A matching token is consumed
- * unless `consume` is `false`, so an approval resumes exactly one call. Under
- * `staleOn: 'resource-change'`, a token issued for an earlier version of the
- * same row denies with `stale-approval`; the next call without it asks again.
- */
-declare function resumeDecision(input: {
-  readonly decision: Decision;
-  readonly permission: Permission | {
-    readonly key: string;
-    readonly scope: string;
-    readonly resource: string;
-  };
-  readonly subject: Subject;
-  readonly store: ApprovalStore | undefined;
-  readonly resource: {
-    readonly type: string;
-    readonly id?: string;
-  };
-  readonly adapter: string;
-  readonly token: string | undefined;
-  /** `false` for checks that do not run the action, such as the decision endpoint. */
-  readonly consume?: boolean;
-  readonly now?: Date;
-  /**
-   * How long a request this call opens stays open, in milliseconds; absent
-   * means the store's `ttl`, else `DEFAULT_APPROVAL_TTL_MS`. The grant's
-   * `approval.ttl` still caps it.
-   */
-  readonly ttl?: number;
-}): Promise<Decision>;
-declare function cancelApprovals(store: ApprovalStore, filter: ApprovalListFilter, meta: ApprovalCancelMeta): Promise<number>;
-declare function readApprovalHeader(headers: Headers | {
-  readonly get: (name: string) => string | null;
-}): string | undefined;
-declare function resumeFromHeader(store: ApprovalStore, headers: Headers | {
-  readonly get: (name: string) => string | null;
-}, now?: Date): Promise<ApprovalInspectResult>;
-/**
- * The token to resume `decision` with when the caller carries none: the
- * decision's own token when the store holds an approved or rejected request
- * for it, so `resumeDecision` resumes (or denies) the call without the
- * caller passing the token back. The token already binds permission,
- * resource (or the call's data when there is no row id), subject and actor.
- * A pending request counts only with `denyPending: true`, which makes the
- * call deny with `approval-pending` instead of asking again. `undefined` when
- * the decision needs no approval, there is no store, or the store has no
- * unexpired request for the token; a store that throws counts as none.
- */
-declare function storedApprovalToken(store: ApprovalStore | undefined, decision: Decision, options?: {
-  readonly denyPending?: boolean;
-  readonly now?: Date;
-}): Promise<string | undefined>;
-//#endregion
-//#region src/approvals/page.d.ts
-/** The page size of a query: `limit` within 1 to 200, 50 when absent. */
-declare function approvalPageSize(limit: number | undefined): number;
-/** Where a page starts: the `(createdAt, token)` of the last request before it. */
-type ApprovalCursorPosition = readonly [createdAt: string, token: string];
-/** The `next` cursor after `request`, for a store that pages in its own query. */
-declare function encodeApprovalCursor(request: ApprovalRequest): string;
-/** The `(createdAt, token)` position a `next` cursor names, or `null` for one that does not parse. */
-declare function decodeApprovalCursor(cursor: string): ApprovalCursorPosition | null;
-/**
- * Pages already-filtered requests in `(createdAt, token)` order, as the
- * built-in stores do: `limit` within 1 to 200 (50 when absent), `cursor` from
- * the previous page's `next`, and no items for a cursor that does not parse.
- * A custom `ApprovalStore` that filters in memory returns it from `list`.
- */
-declare function pageApprovals(matching: readonly ApprovalRequest[], query: ApprovalListQuery): ApprovalPage;
-/** Every matching request of `store`, following `next` until the last page (at most 1000 pages of 200). */
-declare function listAllApprovals(store: ApprovalStore, filter: ApprovalListFilter): Promise<ApprovalRequest[]>;
-//#endregion
-//#region src/approvals/permissions.d.ts
-/**
- * The `holder(permission)` approvers of `request` that `approver` holds, for
- * `ApprovalVerdict.permissions`: each permission key the approver's own
- * instance grants without a row. `approver` must be an instance for the
- * approving principal in the request's tenant; for any other tenant, or an
- * anonymous instance, it holds nothing. A check that throws holds nothing.
- */
-declare function approverPermissions(request: ApprovalRequest, approver: PermDock): readonly string[];
-//#endregion
-//#region src/approvals/store.d.ts
-/**
- * Refuses `by` as an approver of `request`, or returns the index of the
- * stage the approval counts for (`undefined` without `stages`). Eligibility
- * is `approvers.by` or, under `stages`, the first incomplete stage
- * (`sequential`) or any incomplete stage (`all`); `approvers.escalation.to`
- * is eligible too once the request has waited `escalation.after`. A
- * principal who already approved is refused, so one person never completes
- * two stages. `relations` are the relation approvers `by` holds on the
- * request's resource (see `ApprovalVerdict.relations`).
- */
-declare function assertApprover(request: ApprovalRequest, by: Subject, requireDistinctApprover: boolean, now?: Date, relations?: readonly string[], permissions?: readonly string[]): number | undefined;
-/**
- * The request after `verdict`, for a store to persist: a rejection resolves
- * it; an approval is appended to `approvals` and resolves it once there are
- * `approvers.quorum` (default 1). Throws an `ApprovalError` when the request
- * is not pending, has expired or `verdict.by` may not approve it. Stores
- * should write the result only when the stored row is still pending with the
- * same number of approvals, so two approvers racing both count.
- */
-declare function applyApprovalVerdict(request: ApprovalRequest, verdict: ApprovalVerdict, now?: Date): ApprovalRequest;
-type MemoryApprovalStore = ApprovalStore & {
-  readonly ttl: number;
-};
-declare function memoryApprovalStore(options?: {
-  readonly ttl?: number;
-}): MemoryApprovalStore;
-//#endregion
-export { ApproverRelationsOptions as C, ApprovalError as D, approvalsHandler as E, ApprovalErrorCode as O, vouchApproval as S, ApprovalsHandlerOptions as T, resolveApproval as _, approverPermissions as a, storedApprovalToken as b, decodeApprovalCursor as c, pageApprovals as d, cancelApprovals as f, requestApproval as g, readApprovalHeader as h, memoryApprovalStore as i, isApprovalError as k, encodeApprovalCursor as l, inspectApproval as m, applyApprovalVerdict as n, ApprovalCursorPosition as o, consumeApproval as p, assertApprover as r, approvalPageSize as s, MemoryApprovalStore as t, listAllApprovals as u, resumeDecision as v, approverRelations as w, summariseSubject as x, resumeFromHeader as y };

package/dist/instance-options-Dhhcnm3y.js

@@ -1,22 +0,0 @@
-//#region src/core/instance-options.ts
-const INSTANCE_KEYS = {
-	memberships: true,
-	relations: true,
-	entitlements: true,
-	customRoles: true,
-	policies: true,
-	approvalPolicies: true,
-	sink: true,
-	limits: true
-};
-/** The `InstanceOptions` set on `options`, without the adapter's own keys. */
-function instanceOptions(options) {
-	const picked = {};
-	for (const key of Object.keys(INSTANCE_KEYS)) {
-		const name = key;
-		if (options[name] !== void 0) picked[name] = options[name];
-	}
-	return picked;
-}
-//#endregion
-export { instanceOptions as t };

package/dist/load-DwJUafYN.js

@@ -1,2 +0,0 @@
-import { a as loadModule, o as pickNamed } from "./load-DhWEB9P1.js";
-export { loadModule, pickNamed };