better-supabase 0.12.0 → 0.14.0

package/dist/client-BIMg9IiF.d.ts

@@ -0,0 +1,349 @@
+/// <reference lib="esnext.temporal" />
+import { D as ValidationIssue, T as ErrorMapper, b as DbError, f as Result, t as AsyncResult } from "./result-C6jDfedy.js";
+import { n as Logger } from "./logger-DWVYUmwi.js";
+import { r as BlockTemporalOptions } from "./block-helpers-BaugZlJV.js";
+import { t as BlockTransport } from "./block-transport-d53POsem.js";
+import { n as BlockHooks } from "./block-hooks-CmjPKqQ_.js";
+import { d as FilterLimits, h as FilterQuery, i as FilterCombinator, r as FilterClock } from "./filter-query-o3b_GuyC.js";
+import { n as Controller, t as AuthPort } from "./controller-DAD4hbl4.js";
+import { n as RuleField, r as RuleFieldCatalog } from "./fields-CanaxA0U.js";
+import { n as FilterRecordField, t as FilterEvaluation } from "./filter-evaluate-C3i2bGfk.js";
+//#region src/blocks/rules/rules.d.ts
+/** What a rule runs when it matches: a kind the app handles and its settings. */
+interface RuleAction {
+  /** Such as `approvals.request` or `notifications.send`. */
+  readonly kind: string;
+  readonly config?: Readonly<Record<string, unknown>>;
+}
+interface Rule {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly subjectType: string;
+  /** The event type the rule is tested on, such as `expense.submitted`. */
+  readonly trigger: string;
+  readonly name: string;
+  readonly description: string | undefined;
+  readonly conditions: FilterQuery;
+  readonly actions: readonly RuleAction[];
+  readonly enabled: boolean;
+  /** A match ends the evaluation, so later rules for the trigger don't run. */
+  readonly stopProcessing: boolean;
+  /** The rank key rules are tested in. */
+  readonly rank: string;
+  readonly version: number;
+  readonly createdBy: string | undefined;
+  readonly updatedBy: string | undefined;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+}
+/** `save`'s input: left-out keys keep their value on an existing rule. */
+interface RuleInput {
+  readonly id?: string;
+  /** The version the editor read; a newer stored one fails with `RULE_CONFLICT`. */
+  readonly version?: number;
+  /** Required for a new rule; it can't change later. */
+  readonly subjectType?: string;
+  readonly trigger?: string;
+  readonly name?: string;
+  readonly description?: string | null;
+  readonly conditions?: FilterQuery;
+  readonly actions?: readonly RuleAction[];
+  /** Turning a rule on takes `rules.publish`. */
+  readonly enabled?: boolean;
+  readonly stopProcessing?: boolean;
+}
+interface RuleVersion {
+  readonly ruleId: string;
+  readonly version: number;
+  readonly name: string;
+  readonly conditions: FilterQuery;
+  readonly actions: readonly RuleAction[];
+  readonly savedBy: string | undefined;
+  readonly savedAt: Temporal.Instant;
+}
+/** A rule that matched, with the truth of every condition and group by node id. */
+interface RuleMatch {
+  readonly rule: Rule;
+  readonly results: Readonly<Record<string, boolean | null>>;
+}
+/** One entry of a rule's evaluation log. */
+interface RuleEvaluationEntry {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly ruleId: string;
+  readonly version: number;
+  readonly subjectType: string;
+  readonly subjectId: string | undefined;
+  readonly trigger: string;
+  readonly matched: boolean;
+  readonly results: Readonly<Record<string, boolean | null>>;
+  readonly mode: "live" | "test";
+  readonly evaluatedBy: string | undefined;
+  readonly evaluatedAt: Temporal.Instant;
+}
+interface RuleListOptions {
+  readonly subjectType?: string;
+  readonly trigger?: string;
+  readonly enabled?: boolean;
+}
+/** What `matching` and `run` test: one subject, as the trigger event saw it. */
+interface RuleSubject {
+  readonly subjectType: string;
+  readonly trigger: string;
+  /**
+   * The record the field catalog's columns read, such as the expense row with
+   * its submitter.
+   */
+  readonly subject: Readonly<Record<string, unknown>>;
+  /** The IANA zone relative dates ("today") resolve in. Default `UTC`. */
+  readonly timeZone?: string;
+}
+interface RulesOptions extends BlockTemporalOptions {
+  /** The caller's transport (`rpcTransport(supabase)`). */
+  readonly transport: BlockTransport;
+  /** The module schema, or its API schema. Default `better_supabase`. */
+  readonly schema?: string;
+  readonly mappers?: readonly ErrorMapper[];
+  /** `withBlockHooks` hooks around the client's methods. */
+  readonly hooks?: BlockHooks<Rules>;
+  /** Receives the errors `after` hooks throw. Default: `console`. */
+  readonly logger?: Logger;
+}
+interface Rules {
+  /** The field catalog, for one subject type or all of them. */
+  fields(subjectType?: string): AsyncResult<readonly RuleField[]>;
+  /** The organization's rules in evaluation order (needs `rules.read`). */
+  list(organizationId: string, options?: RuleListOptions): AsyncResult<readonly Rule[]>;
+  /** `undefined` when the caller can't read a rule with this id. */
+  get(id: string): AsyncResult<Rule | undefined>;
+  /**
+   * Creates or changes a rule. `rules.edit` covers disabled rules; enabling a
+   * rule or changing an enabled one takes `rules.publish`.
+   */
+  save(organizationId: string, input: RuleInput): AsyncResult<Rule>;
+  /** Turns a rule on or off (needs `rules.publish`). */
+  setEnabled(id: string, enabled: boolean): AsyncResult<Rule>;
+  /** Moves a rule to a rank key from `rankBetween` over its neighbours. */
+  move(id: string, rank: string): AsyncResult<Rule>;
+  /**
+   * Removes a rule with its history (needs `rules.admin`); `false` when there
+   * is none to remove.
+   */
+  remove(id: string): AsyncResult<boolean>;
+  /** Saved versions, newest first. */
+  versions(id: string): AsyncResult<readonly RuleVersion[]>;
+  /** The evaluation log, newest first. */
+  evaluations(id: string, options?: {
+    readonly before?: Temporal.Instant;
+    readonly pageSize?: number;
+  }): AsyncResult<readonly RuleEvaluationEntry[]>;
+  /** The enabled rules for the trigger that match, evaluated in the database. */
+  matching(organizationId: string, input: RuleSubject): AsyncResult<readonly RuleMatch[]>;
+  /**
+   * Runs a rule's stored conditions on a sample record and logs it as a test
+   * (needs `rules.edit`). Nothing runs; the result says what would match.
+   */
+  test(rule: Rule, subject: Readonly<Record<string, unknown>>, options?: {
+    readonly fields?: readonly RuleField[];
+    readonly subjectId?: string;
+    readonly clock?: FilterClock;
+  }): AsyncResult<FilterEvaluation>;
+}
+/** A rule row from the module's functions. */
+declare function ruleOf(value: unknown): Rule;
+/** Catalog fields in the shape `evaluateFilterQuery` reads. */
+declare function ruleRecordFields(fields: readonly RuleField[]): readonly FilterRecordField[];
+/**
+ * Tests a rule's conditions on one record in memory, the same way the
+ * database's `rule_evaluate` does. `fields` is the subject type's catalog.
+ */
+declare function evaluateRule(rule: Pick<Rule, "conditions">, subject: unknown, fields: readonly RuleField[], clock?: FilterClock): FilterEvaluation;
+/** Tenant rules as the caller: the catalog, the rules, their history and tests. */
+declare function createRules(options: RulesOptions): Rules;
+interface RulesAdminOptions extends BlockTemporalOptions {
+  /**
+   * A service-role transport: `sync_rule_fields` and `run_rules` are granted to
+   * `service_role` only.
+   */
+  readonly transport: BlockTransport;
+  readonly schema?: string;
+  readonly mappers?: readonly ErrorMapper[];
+}
+interface RulesAdmin {
+  /** Replaces the subject type's field catalog; returns how many fields it has. */
+  syncFields(catalog: RuleFieldCatalog): AsyncResult<number>;
+  /**
+   * Evaluates the enabled rules for the trigger, logs each one live and returns
+   * the matches.
+   */
+  run(organizationId: string, input: RuleSubject & {
+    readonly subjectId?: string;
+  }): AsyncResult<readonly RuleMatch[]>;
+}
+/** The field sync and live evaluation, with a service-role client. */
+declare function createRulesAdmin(options: RulesAdminOptions): RulesAdmin;
+/**
+ * What a handler receives: the action, the rule it belongs to and the dispatch
+ * context.
+ */
+interface RuleActionCall<C = unknown> {
+  readonly action: RuleAction;
+  readonly rule: Rule;
+  readonly results: Readonly<Record<string, boolean | null>>;
+  readonly context: C;
+}
+/**
+ * Runs one action kind. Return a `Result`; a throw becomes an `unexpected`
+ * error.
+ */
+type RuleActionHandler<C = unknown> = (call: RuleActionCall<C>) => Result<unknown> | PromiseLike<Result<unknown>>;
+/** The outcome of one action: its value, or the error its handler returned. */
+type RuleActionOutcome = {
+  readonly ruleId: string;
+  readonly kind: string;
+  readonly ok: true;
+  readonly value: unknown;
+} | {
+  readonly ruleId: string;
+  readonly kind: string;
+  readonly ok: false;
+  readonly error: DbError;
+};
+interface RuleDispatcherOptions<C> {
+  /** A handler per action kind, such as `approvals.request`. */
+  readonly handlers: Readonly<Record<string, RuleActionHandler<C>>>;
+}
+interface RuleDispatcher<C = unknown> {
+  /**
+   * Runs the actions of `matches` in order. A failed action doesn't stop the
+   * others; each one's outcome comes back. A kind without a handler is an
+   * `invalid_request` outcome with the hint `RULE_ACTION_UNKNOWN`.
+   */
+  dispatch(matches: readonly RuleMatch[], context: C): AsyncResult<readonly RuleActionOutcome[]>;
+}
+/** Runs matched rules' actions with the app's handlers. */
+declare function createRuleDispatcher<C = unknown>(options: RuleDispatcherOptions<C>): RuleDispatcher<C>;
+/** An outbox event as the rule sink reads it; an `OutboxEvent` fits. */
+interface RuleSinkEvent {
+  readonly id: string;
+  readonly type: string;
+  readonly payload?: unknown;
+  readonly tenant?: string | null;
+}
+/**
+ * What `load` returns for an event the rules should see: the subject and the
+ * dispatch context.
+ */
+interface RuleSinkTarget<C> {
+  readonly organizationId: string;
+  readonly subjectType: string;
+  readonly subjectId?: string;
+  /** The record the field catalog's columns read. */
+  readonly subject: Readonly<Record<string, unknown>>;
+  readonly timeZone?: string;
+  readonly context: C;
+}
+interface RuleSinkOptions<C> {
+  /** `rules.run` from `createRulesAdmin`, which logs each evaluation live. */
+  readonly rules: Pick<RulesAdmin, "run">;
+  readonly dispatcher: RuleDispatcher<C>;
+  /**
+   * Reads the subject an event is about, such as the app table row named by
+   * `payload.id`. `undefined` skips the event.
+   */
+  readonly load: (event: RuleSinkEvent) => RuleSinkTarget<C> | undefined | PromiseLike<RuleSinkTarget<C> | undefined>;
+  /** Receives each event's action outcomes, failed ones included. */
+  readonly onOutcomes?: (event: RuleSinkEvent, outcomes: readonly RuleActionOutcome[]) => void;
+}
+/**
+ * An outbox consumer handler that tests the rules whose trigger is the event's
+ * type and runs the actions of the ones that match, for
+ * `outbox.consume("rules", createRuleSink(...))`. It throws when the evaluation
+ * fails, so the outbox retries the event; a failed action goes to `onOutcomes`
+ * instead, since a retry would run the others again.
+ */
+declare function createRuleSink<C = unknown>(options: RuleSinkOptions<C>): (events: readonly RuleSinkEvent[]) => Promise<void>;
+//#endregion
+//#region src/blocks/rules/client.d.ts
+interface RuleBuilderControllerOptions {
+  readonly client: Pick<Rules, "fields" | "get" | "save">;
+  readonly auth: AuthPort;
+  readonly organizationId: string;
+  /** The rule to edit; `null` edits a new one. */
+  readonly rule: string | null;
+  /** The record type whose fields the rules test. */
+  readonly subjectType: string;
+  /** A new rule's trigger, such as `expense.submitted`. */
+  readonly trigger?: string;
+  /** The tree a new rule starts with, such as a fixed first condition. */
+  readonly initial?: FilterQuery;
+  /**
+   * Node ids the editor may not change, move or remove, such as the fixed first
+   * condition. Only the editor knows them; the stored rule doesn't.
+   */
+  readonly locked?: readonly string[];
+  /** Defaults to `RULE_LIMITS`. */
+  readonly limits?: FilterLimits;
+  /** Makes node ids. Defaults to `crypto.randomUUID()`. */
+  readonly newId?: () => string;
+}
+interface RuleBuilderSnapshot {
+  /** The stored rule; `undefined` for a new one or before the first load. */
+  readonly rule: Rule | undefined;
+  /** The subject type's field catalog; `undefined` until loaded. */
+  readonly fields: readonly RuleField[] | undefined;
+  readonly name: string;
+  readonly conditions: FilterQuery;
+  readonly actions: readonly RuleAction[];
+  readonly stopProcessing: boolean;
+  readonly locked: readonly string[];
+  /** Problems in the tree, checked against the fields once they load. */
+  readonly issues: readonly ValidationIssue[];
+  /**
+   * Whether the name, tree, actions or `stopProcessing` differ from the stored
+   * rule.
+   */
+  readonly dirty: boolean;
+  readonly loading: boolean;
+  readonly saving: boolean;
+  readonly error: DbError | undefined;
+}
+interface RuleBuilderActions {
+  /** Loads the fields and the rule again, dropping unsaved edits. */
+  readonly refresh: () => Promise<void>;
+  /** Adds a condition to `group` (the root by default) and returns its id. */
+  readonly addRule: (group?: string, field?: string) => string;
+  /** Adds an empty group to `group` (the root by default) and returns its id. */
+  readonly addGroup: (group?: string, combinator?: FilterCombinator) => string;
+  readonly remove: (id: string) => void;
+  /** Moves a node into `group`, where it ends up at `index`. */
+  readonly move: (id: string, group: string, index: number) => void;
+  readonly setField: (id: string, field: string) => void;
+  /** Keeps the value when the operator takes the same kind of value. */
+  readonly setOperator: (id: string, operator: string) => void;
+  readonly setValue: (id: string, value: unknown) => void;
+  readonly setNegated: (id: string, negated: boolean) => void;
+  readonly setCombinator: (group: string, combinator: FilterCombinator) => void;
+  readonly setName: (name: string) => void;
+  readonly setActions: (actions: readonly RuleAction[]) => void;
+  readonly setStopProcessing: (stop: boolean) => void;
+  readonly lock: (id: string) => void;
+  readonly unlock: (id: string) => void;
+  /** Drops unsaved edits. */
+  readonly reset: () => void;
+  /**
+   * Saves the rule, `enabled` turning it on or off with it. The saved rule, or
+   * `undefined` with `error` set.
+   */
+  readonly save: (options?: {
+    readonly enabled?: boolean;
+  }) => Promise<Rule | undefined>;
+}
+type RuleBuilderController = Controller<RuleBuilderSnapshot, RuleBuilderActions>;
+/**
+ * The editor state of one rule: the field catalog, the condition tree and the
+ * edits to it, with validation, dirty state and save.
+ */
+declare function createRuleBuilderController(options: RuleBuilderControllerOptions): RuleBuilderController;
+//#endregion
+export { evaluateRule as A, RulesAdmin as C, createRuleSink as D, createRuleDispatcher as E, ruleRecordFields as M, createRules as O, Rules as S, RulesOptions as T, RuleSinkEvent as _, createRuleBuilderController as a, RuleSubject as b, RuleActionCall as c, RuleDispatcher as d, RuleDispatcherOptions as f, RuleMatch as g, RuleListOptions as h, RuleBuilderSnapshot as i, ruleOf as j, createRulesAdmin as k, RuleActionHandler as l, RuleInput as m, RuleBuilderController as n, Rule as o, RuleEvaluationEntry as p, RuleBuilderControllerOptions as r, RuleAction as s, RuleBuilderActions as t, RuleActionOutcome as u, RuleSinkOptions as v, RulesAdminOptions as w, RuleVersion as x, RuleSinkTarget as y };