permdock 0.7.0 → 0.8.0

package/dist/{index-CMiPH2Tv.d.ts → index-BhxEUY9J.d.ts}

@@ -1,11 +1,14 @@
-import { T as Policy, sr as Principal, ut as TokenSigner } from "./policy-types-B-F-qAZk.js";
-import { E as SsfPermDockOptions, O as SsfStreamConfiguration, T as SsfPermDock, _ as SetSubject, c as PushSetOptions, d as SetDelivery, g as SetQueue, h as SetPollHandlerOptions, k as SsfStreamStatus, m as SetEvent, p as SetError, t as CaepCommon, v as SignSetOptions } from "./types-cTos-H7p.js";
+import { T as Policy, sr as Principal, ut as TokenSigner } from "./policy-types-CCiDRZBH.js";
+import { E as SsfPermDockOptions, O as SsfStreamConfiguration, T as SsfPermDock, _ as SetSubject, c as PushSetOptions, d as SetDelivery, g as SetQueue, h as SetPollHandlerOptions, k as SsfStreamStatus, m as SetEvent, p as SetError, t as CaepCommon, v as SignSetOptions } from "./types-DjuMBNF9.js";
 //#region src/ssf/create.d.ts
 declare function createPermDock<TUser, TPrincipal extends Principal = Principal>(policy: Policy<TUser, TPrincipal>, options: SsfPermDockOptions): SsfPermDock;
 //#endregion
 //#region src/ssf/poll-client.d.ts
 type PollSetsOptions = {
-  /** The transmitter's RFC 8936 poll endpoint, the stream's `delivery.endpoint_url`. */
+  /**
+   * The transmitter's RFC 8936 poll endpoint, the stream's
+   * `delivery.endpoint_url`.
+   */
   readonly endpoint: string;
   /** The `Authorization` header value. */
   readonly authorization?: string;
@@ -20,7 +23,10 @@ type PollSetsOptions = {
   readonly fetch?: typeof fetch;
   readonly signal?: AbortSignal;
 };
-/** One SET from a poll response: its `jti` and the compact JWS, not yet verified. */
+/**
+ * One SET from a poll response: its `jti` and the compact JWS, not yet
+ * verified.
+ */
 type PolledSet = {
   readonly jti: string;
   readonly set: string;
@@ -42,22 +48,25 @@ declare function pollSets(options: PollSetsOptions): Promise<PollSetsResult>;
 //#region src/ssf/set-queue.d.ts
 /**
  * An in-process `SetQueue`: pending SETs per stream in insertion order. A
- * process restart loses them; a deployment with more than one instance needs
- * a shared queue.
+ * process restart loses them; a deployment with more than one instance needs a
+ * shared queue.
  */
 declare function memorySetQueue(): SetQueue;
 /**
- * The RFC 8936 poll endpoint over a `SetQueue`. It applies the request's
- * `acks` and `setErrs`, then answers `{ sets, moreAvailable }` with up to
- * `maxEvents` pending SETs. It answers at once whatever `returnImmediately`
- * says, which RFC 8936 section 2.4 allows.
+ * The RFC 8936 poll endpoint over a `SetQueue`. It applies the request's `acks`
+ * and `setErrs`, then answers `{ sets, moreAvailable }` with up to `maxEvents`
+ * pending SETs. It answers at once whatever `returnImmediately` says, which RFC
+ * 8936 section 2.4 allows.
  */
 declare function setPollHandler(options: SetPollHandlerOptions): (request: Request) => Promise<Response>;
 //#endregion
 //#region src/ssf/streams.d.ts
 /** One stream a transmitter holds and the receiver that created it. */
 type SsfStream = {
-  /** The receiver `ssfTransmitter`'s `authorize` answered when the stream was created. */
+  /**
+   * The receiver `ssfTransmitter`'s `authorize` answered when the stream was
+   * created.
+   */
   readonly owner: string;
   readonly configuration: SsfStreamConfiguration;
 };
@@ -68,15 +77,21 @@ type SsfStream = {
 type SsfStreamStore = {
   /** Names the implementation in errors and events. */
   readonly name?: string;
-  create(owner: string, configuration: SsfStreamConfiguration): void | Promise<void>;
-  get(streamId: string): SsfStream | null | Promise<SsfStream | null>;
-  /** Every stream of `owner`, or every stream when `owner` is absent, oldest first. */
-  list(owner?: string): readonly SsfStream[] | Promise<readonly SsfStream[]>;
-  /** Replaces the configuration of the stream `configuration.stream_id`; the owner and status stay. */
-  update(configuration: SsfStreamConfiguration): void | Promise<void>;
-  delete(streamId: string): void | Promise<void>;
-  status(streamId: string): SsfStreamStatus | null | Promise<SsfStreamStatus | null>;
-  setStatus(status: SsfStreamStatus): void | Promise<void>;
+  create: (owner: string, configuration: SsfStreamConfiguration) => void | Promise<void>;
+  get: (streamId: string) => SsfStream | null | Promise<SsfStream | null>;
+  /**
+   * Every stream of `owner`, or every stream when `owner` is absent, oldest
+   * first.
+   */
+  list: (owner?: string) => readonly SsfStream[] | Promise<readonly SsfStream[]>;
+  /**
+   * Replaces the configuration of the stream `configuration.stream_id`; the
+   * owner and status stay.
+   */
+  update: (configuration: SsfStreamConfiguration) => void | Promise<void>;
+  delete: (streamId: string) => void | Promise<void>;
+  status: (streamId: string) => SsfStreamStatus | null | Promise<SsfStreamStatus | null>;
+  setStatus: (status: SsfStreamStatus) => void | Promise<void>;
 };
 /**
  * An in-process `SsfStreamStore`. A process restart loses every stream; a
@@ -88,12 +103,18 @@ declare function memorySsfStreamStore(): SsfStreamStore;
 type SsfTransmitterOptions = {
   /** `iss` of every stream and of the metadata; the `iss` the signer writes. */
   readonly issuer: string;
-  /** The URL the handler is mounted at; endpoints are `<endpoint>/stream`, `/status`, `/verify` and `/poll`. Default `issuer`. */
+  /**
+   * The URL the handler is mounted at; endpoints are `<endpoint>/stream`,
+   * `/status`, `/verify` and `/poll`. Default `issuer`.
+   */
   readonly endpoint?: string;
   readonly streams: SsfStreamStore;
   readonly queue: SetQueue;
   readonly signer: TokenSigner;
-  /** The receiver the request's credentials authenticate, or `null` to refuse it with `401`. */
+  /**
+   * The receiver the request's credentials authenticate, or `null` to refuse it
+   * with `401`.
+   */
   readonly authorize: (request: Request) => string | null | Promise<string | null>;
   /** `aud` of a receiver's streams; default the receiver itself. */
   readonly audience?: (receiver: string) => string | readonly string[];
@@ -110,7 +131,10 @@ type FanOutSetOptions = {
   readonly signer: TokenSigner;
   readonly fetch?: typeof fetch;
 };
-/** How one stream took a SET. `queued` is `true` for a poll stream and for a paused push stream. */
+/**
+ * How one stream took a SET. `queued` is `true` for a poll stream and for a
+ * paused push stream.
+ */
 type SsfFanOut = {
   readonly stream: string;
   readonly jti: string;
@@ -119,17 +143,17 @@ type SsfFanOut = {
 };
 /**
  * Signs `event` once per distinct stream audience and delivers it to every
- * stream that is not disabled and has the event in `events_delivered`: a
- * push stream through `pushSet`, a poll stream or a paused stream into the
- * queue. Answers one row per stream that took the event.
+ * stream that is not disabled and has the event in `events_delivered`: a push
+ * stream through `pushSet`, a poll stream or a paused stream into the queue.
+ * Answers one row per stream that took the event.
  */
 declare function fanOutSet(event: SetEvent, options: FanOutSetOptions): Promise<readonly SsfFanOut[]>;
 /**
  * An SSF 1.0 transmitter as one Fetch handler, routed by path suffix:
- * `/.well-known/ssf-configuration` (section 7.1), `/stream` (8.1.1),
- * `/status` (8.1.2), `/verify` (8.1.4) and `/poll` (RFC 8936). Each receiver
- * sees only the streams it created. Disabling or deleting a stream drops its
- * pending SETs; a paused stream holds them until it is enabled again.
+ * `/.well-known/ssf-configuration` (section 7.1), `/stream` (8.1.1), `/status`
+ * (8.1.2), `/verify` (8.1.4) and `/poll` (RFC 8936). Each receiver sees only
+ * the streams it created. Disabling or deleting a stream drops its pending
+ * SETs; a paused stream holds them until it is enabled again.
  */
 declare function ssfTransmitter(options: SsfTransmitterOptions): (request: Request) => Promise<Response>;
 //#endregion
@@ -140,15 +164,15 @@ declare const SSF_PUSH_DELIVERY = "urn:ietf:rfc:8935";
 declare const SSF_POLL_DELIVERY = "urn:ietf:rfc:8936";
 /**
  * Signs one event as an RFC 8417 Security Event Token (`typ: secevent+jwt`):
- * `sub_id` is the event's subject and `events` holds exactly one entry, as
- * SSF 1.0 requires. `iss` is the signer's own.
+ * `sub_id` is the event's subject and `events` holds exactly one entry, as SSF
+ * 1.0 requires. `iss` is the signer's own.
  */
 declare function signSet(event: SetEvent, signer: TokenSigner, options: SignSetOptions): Promise<string>;
 /**
- * Pushes one SET to a receiver (RFC 8935). A `2xx` is delivery; a `400`
- * maps the receiver's `err` to a cause; `401` and `403` are
- * `authentication-failed` and `access-denied`; a network failure, a timeout,
- * a `429` or a `5xx` is `unavailable` with `retry: true`. Never throws.
+ * Pushes one SET to a receiver (RFC 8935). A `2xx` is delivery; a `400` maps
+ * the receiver's `err` to a cause; `401` and `403` are `authentication-failed`
+ * and `access-denied`; a network failure, a timeout, a `429` or a `5xx` is
+ * `unavailable` with `retry: true`. Never throws.
  */
 declare function pushSet(set: string, options: PushSetOptions): Promise<SetDelivery>;
 type CaepCredentialChange = CaepCommon & {
@@ -195,7 +219,10 @@ type RiscEvents = {
   }) => SetEvent;
   readonly credentialCompromise: (input: RiscCredentialCompromise) => SetEvent;
 };
-/** RISC 1.0 event builders for the events PermDock's receiver treats as revoking every session. */
+/**
+ * RISC 1.0 event builders for the events PermDock's receiver treats as revoking
+ * every session.
+ */
 declare const riscEvents: RiscEvents;
 /**
  * The SSF 1.0 section 8.1.4 verification event for `stream`, echoing the

package/dist/{index-DLwcuCN_.d.ts → index-Bv5iXPqU.d.ts}

@@ -1,15 +1,21 @@
-import { T as Policy, j as PolicyVocabulary, q as DecisionSink, sr as Principal, tn as DeliveryChannel } from "./policy-types-B-F-qAZk.js";
-import { u as Permission } from "./permission-types-DhNEmoRG.js";
-import { t as Operation } from "./operations-BNLes61x.js";
-import { a as PermDock, h as PrincipalSource } from "./permdock-Dco6dyCK.js";
-import { t as JsonSchemaNode } from "./json-schema-CN_iLFH2.js";
-import { _ as TransportOptions, a as DeliveryReport, c as DeliveryTransport, g as TransportMessages, i as DeliveryMessages, l as DeliveryTransports, m as Recipient, o as DeliveryResult, r as DeliverOptions, s as DeliveryTarget, y as WebhookTransport } from "./types-g7Oy6Zg4.js";
-import { l as WebhookSigner } from "./standard-webhooks-B_qRg0ws.js";
+import { T as Policy, j as PolicyVocabulary, q as DecisionSink, sr as Principal, tn as DeliveryChannel } from "./policy-types-CCiDRZBH.js";
+import { u as Permission } from "./permission-types-CAY-GU7e.js";
+import { t as Operation } from "./operations-Ci_rT6Uo.js";
+import { _ as PrincipalSource, a as PermDock } from "./permdock-B6Sf4T_S.js";
+import { t as JsonSchemaNode } from "./json-schema-BfXgnRNT.js";
+import { _ as TransportOptions, a as DeliveryReport, c as DeliveryTransport, g as TransportMessages, i as DeliveryMessages, l as DeliveryTransports, m as Recipient, o as DeliveryResult, r as DeliverOptions, s as DeliveryTarget, y as WebhookTransport } from "./types-yUuPR5Hy.js";
+import { l as WebhookSigner } from "./standard-webhooks-C-qX4mJW.js";
 //#region src/delivery/audience.d.ts
 type Audience = {
-  /** Principal ids `decideFor` grants, in discovery or candidate order, each once. */
+  /**
+   * Principal ids `decideFor` grants, in discovery or candidate order, each
+   * once.
+   */
   readonly principals: readonly string[];
-  /** `false` when `whoCan` could not list every holder: someone granted may be missing. */
+  /**
+   * `false` when `whoCan` could not list every holder: someone granted may be
+   * missing.
+   */
   readonly complete: boolean;
 };
 type AudienceOptions = {
@@ -19,8 +25,8 @@ type AudienceOptions = {
 /**
  * Who may receive a delivery about `row`: the holders `whoCan` lists (or
  * `candidates`), kept only where `decideFor` grants `permission` in the
- * sender's active tenant. A collection permission has no holders to list,
- * so it needs `candidates`; without them it is empty and incomplete.
+ * sender's active tenant. A collection permission has no holders to list, so it
+ * needs `candidates`; without them it is empty and incomplete.
  */
 declare function audience(permdock: PermDock, permission: Permission, row: unknown, options?: AudienceOptions): Promise<Audience>;
 /** One event a subscriber may receive: the permission its row needs. */
@@ -29,10 +35,9 @@ type SubscriberEvent = {
   readonly row?: unknown;
 };
 /**
- * The subscribers whose principal `decideFor` grants the event's
- * permission on its row, in their order: the per-event filter for webhook
- * endpoints and realtime channels. A subscriber without a string
- * `principal` is dropped.
+ * The subscribers whose principal `decideFor` grants the event's permission on
+ * its row, in their order: the per-event filter for webhook endpoints and
+ * realtime channels. A subscriber without a string `principal` is dropped.
  */
 declare function subscribersFor<S extends {
   readonly principal: string;
@@ -47,7 +52,10 @@ type ConnectorBase<K extends string, C> = {
   readonly config: C;
 };
 type SiemDestination = "splunk-hec" | "sentinel" | "security-lake" | "google-secops" | "elastic" | "datadog";
-/** A connector body in wire format v1 (`schemas/connector-v1.json`), one member per kind. */
+/**
+ * A connector body in wire format v1 (`schemas/connector-v1.json`), one member
+ * per kind.
+ */
 type Connector = ConnectorBase<"webhook", {
   readonly url: Https;
   readonly types?: readonly string[];
@@ -87,7 +95,10 @@ type Connector = ConnectorBase<"webhook", {
   readonly environment?: "production" | "preview" | "development";
 }>;
 type ConnectorKind = Connector["kind"];
-/** One problem with a connector body; `path` is an RFC 6901 JSON pointer into it. */
+/**
+ * One problem with a connector body; `path` is an RFC 6901 JSON pointer into
+ * it.
+ */
 type ConnectorIssue = {
   readonly path: string;
   readonly message: string;
@@ -103,8 +114,8 @@ type ParseConnectorResult = {
 declare const CONNECTOR_KINDS: readonly ConnectorKind[];
 /**
  * Checks `input` against `connector-v1.json` and answers a frozen copy, or
- * every issue with a JSON pointer. The branch is chosen by `kind`, so an
- * issue names the field rather than "no branch matched".
+ * every issue with a JSON pointer. The branch is chosen by `kind`, so an issue
+ * names the field rather than "no branch matched".
  */
 declare function parseConnector(input: unknown): ParseConnectorResult;
 //#endregion
@@ -112,7 +123,8 @@ declare function parseConnector(input: unknown): ParseConnectorResult;
 /**
  * `schemas/connector-v1.json`: the body of a PermDock Cloud connector, one
  * `oneOf` branch per kind with a closed `config`. Only the `otlp` and `siem`
- * `headers` maps hold a secret; a store seals their values and lists names only.
+ * `headers` maps hold a secret; a store seals their values and lists names
+ * only.
  */
 declare const CONNECTOR_SCHEMA: JsonSchemaNode;
 //#endregion
@@ -127,10 +139,16 @@ type MemoryDeliveryTransport<C extends DeliveryChannel> = DeliveryTransport<C> &
   readonly deliveries: readonly MemoryDelivery<C>[];
 };
 type MemoryDeliveryTransportOptions<C extends DeliveryChannel> = {
-  /** The result per delivery; defaults to `sent`. A throw propagates, as from a provider client. */
+  /**
+   * The result per delivery; defaults to `sent`. A throw propagates, as from a
+   * provider client.
+   */
   readonly respond?: (target: DeliveryTarget<C>, message: TransportMessages[C]) => DeliveryResult;
 };
-/** An in-process transport for tests and examples: it records what it would have sent. */
+/**
+ * An in-process transport for tests and examples: it records what it would have
+ * sent.
+ */
 declare function memoryDeliveryTransport<C extends DeliveryChannel>(channel: C, options?: MemoryDeliveryTransportOptions<C>): MemoryDeliveryTransport<C>;
 //#endregion
 //#region src/delivery/router.d.ts
@@ -149,12 +167,15 @@ type DeliveryPermDock<V extends PolicyVocabulary = PolicyVocabulary> = {
   /**
    * Checks every recipient against `target`'s permission on `row` with
    * `permdock.decideFor`, routes the granted ones to the transport of their
-   * channel, and writes one `delivery` event per recipient. Never rejects:
-   * a refused recipient or a transport error is a `failed` event.
+   * channel, and writes one `delivery` event per recipient. Never rejects: a
+   * refused recipient or a transport error is a `failed` event.
    */
   readonly deliver: (permdock: PermDock<V>, target: Permission | Pick<Operation, "name" | "permission">, row: unknown, recipients: readonly Recipient[], messages: Partial<DeliveryMessages>, options?: DeliverOptions) => Promise<DeliveryReport>;
 };
-/** Routes checked recipients to channel transports and records a delivery event for each. */
+/**
+ * Routes checked recipients to channel transports and records a delivery event
+ * for each.
+ */
 declare function createPermDock<TUser, TPrincipal extends Principal = Principal, V extends PolicyVocabulary = PolicyVocabulary>(_policy: Policy<TUser, TPrincipal, V>, options: DeliveryPermDockOptions): DeliveryPermDock<V>;
 //#endregion
 //#region src/delivery/target.d.ts
@@ -166,8 +187,8 @@ declare function createPermDock<TUser, TPrincipal extends Principal = Principal,
 declare function isDeliveryTarget<C extends DeliveryChannel>(value: unknown, channel: C): value is DeliveryTarget<C>;
 /**
  * An RFC 5322 `addr-spec` in dot-atom form with a DNS domain, at most 254
- * characters (RFC 5321 path limit). Quoted local parts, comments and
- * domain literals are refused.
+ * characters (RFC 5321 path limit). Quoted local parts, comments and domain
+ * literals are refused.
  */
 declare function isAddrSpec(value: string): boolean;
 //#endregion
@@ -180,9 +201,9 @@ type WebhookTransportOptions = {
 };
 /**
  * Posts each CloudEvent to the target's https endpoint as
- * `application/cloudevents+json`, signed with the Standard Webhooks
- * headers. `webhook-id` is the idempotency key, so a retry repeats it and
- * the receiver drops the duplicate. Redirects are not followed.
+ * `application/cloudevents+json`, signed with the Standard Webhooks headers.
+ * `webhook-id` is the idempotency key, so a retry repeats it and the receiver
+ * drops the duplicate. Redirects are not followed.
  */
 declare function webhookTransport(signer: WebhookSigner, options?: WebhookTransportOptions): WebhookTransport;
 //#endregion