better-supabase 0.12.0 → 0.14.0

package/dist/blocks/data-lifecycle/index.d.ts

@@ -1,14 +1,14 @@
 /// <reference lib="esnext.temporal" />
-import { T as ErrorMapper, t as AsyncResult } from "../../result-BREt7qOh.js";
-import { I as DataExportEventData, K as LegalHoldEventData, Y as OrganizationDeletionEventData, wt as Events } from "../../events-P3raDX2E.js";
+import { T as ErrorMapper, t as AsyncResult } from "../../result-C6jDfedy.js";
+import { Ct as Events, F as DataExportEventData, K as LegalHoldEventData, Y as OrganizationDeletionEventData } from "../../events-DbLjvxDX.js";
 import { n as Logger } from "../../logger-DWVYUmwi.js";
-import { a as CredentialSubject, i as CredentialRef, r as CredentialProvider } from "../../provider-DXgx5oSA.js";
-import { a as dbTransport, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DezJPPA0.js";
-import { r as BlockTemporalOptions } from "../../block-helpers-CjcQM1yA.js";
-import { n as BlockHooks } from "../../block-hooks-DcPJHztl.js";
-import { g as JobHandler } from "../../types-BEEFkNFY.js";
-import { i as EventSink } from "../../cloud-event-DXkNoI6v.js";
-import { s as BlockOf } from "../../define-block-BHxLHLys.js";
+import { a as CredentialSubject, i as CredentialRef, r as CredentialProvider } from "../../provider-DmiaI1qt.js";
+import { r as BlockTemporalOptions } from "../../block-helpers-BaugZlJV.js";
+import { a as dbTransport, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-d53POsem.js";
+import { n as BlockHooks } from "../../block-hooks-CmjPKqQ_.js";
+import { g as JobHandler } from "../../types-CGUDoF5I.js";
+import { i as EventSink } from "../../cloud-event-SPyXMdcd.js";
+import { c as BlockOf } from "../../define-block-COpcS6aT.js";
 //#region src/blocks/data-lifecycle/data-lifecycle.d.ts
 interface StorageReply<T> {
   readonly data: T | null;
@@ -78,7 +78,10 @@ interface DataLifecycleOptions extends BlockTemporalOptions {
   readonly transport: BlockTransport;
   /** The caller's `supabase.storage`, for `download`. */
   readonly storage?: LifecycleStorage;
-  /** The module schema, or its API schema: `defineBlocks` passes it from `blocks.generated.ts`. Default `better_supabase`. */
+  /**
+   * The module schema, or its API schema: `defineBlocks` passes it from
+   * `blocks.generated.ts`. Default `better_supabase`.
+   */
   readonly schema?: string;
   readonly mappers?: readonly ErrorMapper[];
   /** Lifetime of a signed download URL in seconds. Default 300. */
@@ -89,7 +92,10 @@ interface DataLifecycleOptions extends BlockTemporalOptions {
   readonly logger?: Logger;
 }
 interface DataLifecycle {
-  /** Exports the caller's data, or a tenant's with `organizationId` (needs `organization.export`). */
+  /**
+   * Exports the caller's data, or a tenant's with `organizationId` (needs
+   * `organization.export`).
+   */
   requestExport(options?: {
     readonly organizationId?: string;
   }): AsyncResult<DataExport>;
@@ -98,9 +104,9 @@ interface DataLifecycle {
   /** Signed URLs for a ready export's files. */
   download(exportId: string): AsyncResult<DataExportDownload>;
   /**
-   * Disables the tenant and schedules its purge after `grace` (an
-   * interval such as `30 days` or a `Temporal.Duration`; default the
-   * module's `grace` option). Needs `organization.delete`.
+   * Disables the tenant and schedules its purge after `grace` (an interval such
+   * as `30 days` or a `Temporal.Duration`; default the module's `grace`
+   * option). Needs `organization.delete`.
    */
   requestOrganizationDeletion(organizationId: string, options?: {
     readonly grace?: Temporal.Duration | string;
@@ -115,7 +121,10 @@ export declare function createDataLifecycle(options: DataLifecycleOptions): Data
 //#endregion
 //#region src/blocks/data-lifecycle/exporter.d.ts
 interface DataExporterOptions extends BlockTemporalOptions {
-  /** A service-role transport: the export functions are granted to `service_role` only. */
+  /**
+   * A service-role transport: the export functions are granted to
+   * `service_role` only.
+   */
   readonly transport: BlockTransport;
   /** A service-role `supabase.storage`, to write the files. */
   readonly storage: LifecycleStorage;
@@ -125,9 +134,9 @@ interface DataExporterOptions extends BlockTemporalOptions {
   /** The outbox `typePrefix`. Default `dev.better-supabase`. */
   readonly typePrefix?: string;
   /**
-   * `ndjson` (default) writes one JSON object per line; `csv` writes RFC
-   * 4180 CSV with a header row, nested values as JSON and formula-looking
-   * text prefixed with `'`, for people who open exports in a spreadsheet.
+   * `ndjson` (default) writes one JSON object per line; `csv` writes RFC 4180
+   * CSV with a header row, nested values as JSON and formula-looking text
+   * prefixed with `'`, for people who open exports in a spreadsheet.
    */
   readonly format?: "ndjson" | "csv";
   readonly concurrency?: number;
@@ -138,20 +147,20 @@ interface DataExportJob {
 }
 interface DataExporter {
   /**
-   * Writes one NDJSON file per table, then marks the export ready (which
-   * emits `data_export.completed`). A failure marks it failed and returns the error.
+   * Writes one NDJSON file per table, then marks the export ready (which emits
+   * `data_export.completed`). A failure marks it failed and returns the error.
    */
   run(exportId: string, signal?: AbortSignal): AsyncResult<DataExport>;
   /**
-   * A jobs handler: `queue.work('data-exports', exporter.job)`. An export
-   * that is no longer pending or failed (cancelled, deleted, running or
-   * ready) completes the job; other errors throw so the queue retries.
+   * A jobs handler: `queue.work('data-exports', exporter.job)`. An export that
+   * is no longer pending or failed (cancelled, deleted, running or ready)
+   * completes the job; other errors throw so the queue retries.
    */
   readonly job: JobHandler<DataExportJob>;
   /**
-   * An outbox sink that runs each `data_export.requested` export. An event
-   * for an export that is no longer pending or failed is skipped, so it never
-   * holds up the events behind it; other errors throw so the relay retries.
+   * An outbox sink that runs each `data_export.requested` export. An event for
+   * an export that is no longer pending or failed is skipped, so it never holds
+   * up the events behind it; other errors throw so the relay retries.
    */
   sink(): EventSink;
 }
@@ -160,15 +169,21 @@ export declare function createDataExporter(options: DataExporterOptions): DataEx
 //#endregion
 //#region src/blocks/data-lifecycle/purger.d.ts
 interface OrganizationPurgerOptions extends BlockTemporalOptions {
-  /** A service-role transport: `purge_organization()` is granted to `service_role` only. */
+  /**
+   * A service-role transport: `purge_organization()` is granted to
+   * `service_role` only.
+   */
   readonly transport: BlockTransport;
-  /** A service-role `supabase.storage`, to remove each bucket's organization prefix. */
+  /**
+   * A service-role `supabase.storage`, to remove each bucket's organization
+   * prefix.
+   */
   readonly storage?: LifecycleStorage;
   /**
    * Buckets to clear: a name, for a bucket whose paths start with the
-   * organization id (`attachments`), or `{ bucket, path }` with a path
-   * template such as `orgs/{organizationId}/files`, or a function that
-   * returns the prefixes, for buckets laid out another way.
+   * organization id (`attachments`), or `{ bucket, path }` with a path template
+   * such as `orgs/{organizationId}/files`, or a function that returns the
+   * prefixes, for buckets laid out another way.
    */
   readonly buckets?: readonly PurgeBucket[];
   /** `createBilling(...)`, to cancel the subscription first. */
@@ -176,15 +191,15 @@ interface OrganizationPurgerOptions extends BlockTemporalOptions {
     cancelSubscription(organizationId: string): AsyncResult<unknown>;
   };
   /**
-   * Revokes the `credential_ref`s in the rows the purge deletes (provider
-   * keys, connector servers and grants, workflow credentials) before it
-   * deletes them. Only refs that carry the organization as their `tenant`
-   * are revoked; the rest are returned in `credentials.unrevoked`.
+   * Revokes the `credential_ref`s in the rows the purge deletes (provider keys,
+   * connector servers and grants, workflow credentials) before it deletes them.
+   * Only refs that carry the organization as their `tenant` are revoked; the
+   * rest are returned in `credentials.unrevoked`.
    */
   readonly credentials?: CredentialProvider;
   /**
-   * Also run the `blocks.data-lifecycle.options.anonymize` rules in
-   * `job`, after the due purges. Default false.
+   * Also run the `blocks.data-lifecycle.options.anonymize` rules in `job`,
+   * after the due purges. Default false.
    */
   readonly anonymize?: boolean;
   readonly schema?: string;
@@ -203,9 +218,9 @@ interface UnrevokedCredential {
   readonly ref: CredentialRef;
   readonly subject: CredentialSubject;
   /**
-   * `foreign`: the ref doesn't carry the organization as its tenant, so it
-   * may name a credential that someone else still uses; `no_provider`: the
-   * purger has no `credentials`; `not_revocable`: the provider can't revoke it.
+   * `foreign`: the ref doesn't carry the organization as its tenant, so it may
+   * name a credential that someone else still uses; `no_provider`: the purger
+   * has no `credentials`; `not_revocable`: the provider can't revoke it.
    */
   readonly reason: "foreign" | "no_provider" | "not_revocable";
 }
@@ -225,11 +240,14 @@ interface OrganizationPurge {
 interface OrganizationPurger {
   /**
    * Checks that the deletion is due, cancels billing, revokes the
-   * organization's credentials, removes the Storage prefixes, then deletes
-   * the rows.
+   * organization's credentials, removes the Storage prefixes, then deletes the
+   * rows.
    */
   purge(organizationId: string): AsyncResult<OrganizationPurge>;
-  /** Purges every deletion past its grace period, oldest first; stops at the first error. */
+  /**
+   * Purges every deletion past its grace period, oldest first; stops at the
+   * first error.
+   */
   purgeDue(options?: {
     readonly limit?: number;
   }): AsyncResult<readonly OrganizationPurge[]>;
@@ -245,8 +263,8 @@ interface OrganizationPurger {
     readonly limit?: number;
   }): AsyncResult<number>;
   /**
-   * Applies the `options.anonymize` rules to the rows whose time is up, at
-   * most `limit` (1000) per rule; returns the rows anonymized per table.
+   * Applies the `options.anonymize` rules to the rows whose time is up, at most
+   * `limit` (1000) per rule; returns the rows anonymized per table.
    */
   anonymizeDue(options?: {
     readonly limit?: number;
@@ -288,7 +306,10 @@ interface LegalHold {
   readonly releasedBy: string | undefined;
   readonly releasedAt: Temporal.Instant | undefined;
 }
-/** Who a policy applies to: one tenant, a plan's tenants, or every tenant (neither). */
+/**
+ * Who a policy applies to: one tenant, a plan's tenants, or every tenant
+ * (neither).
+ */
 type RetentionScope = {
   readonly organizationId: string;
   readonly plan?: never;
@@ -308,16 +329,16 @@ interface RetentionOptions extends BlockTemporalOptions {
 interface Retention {
   /**
    * Keeps `kind` for `keep` (an interval such as `7 years` or a
-   * `Temporal.Duration`), replacing the scope's earlier policy. A purge
-   * keeps rows for the policy whatever its own `older_than`.
+   * `Temporal.Duration`), replacing the scope's earlier policy. A purge keeps
+   * rows for the policy whatever its own `older_than`.
    */
   setPolicy(kind: RetentionKind, keep: Temporal.Duration | string, scope?: RetentionScope): AsyncResult<RetentionPolicy>;
   /** `false` when the scope had no policy for `kind`. */
   removePolicy(kind: RetentionKind, scope?: RetentionScope): AsyncResult<boolean>;
   policies(kind?: RetentionKind): AsyncResult<readonly RetentionPolicy[]>;
   /**
-   * Stops every purge (and the organization purge) from deleting what the
-   * hold covers: one tenant or all, one kind or all.
+   * Stops every purge (and the organization purge) from deleting what the hold
+   * covers: one tenant or all, one kind or all.
    */
   placeHold(hold: {
     readonly reason: string;
@@ -358,7 +379,10 @@ type DataLifecycleEvents = {
   readonly "legal_hold.placed": LegalHoldEventData;
   readonly "legal_hold.released": LegalHoldEventData;
 };
-/** The `data-lifecycle` block's event types, for its manifest and `onBlockEvent`. */
+/**
+ * The `data-lifecycle` block's event types, for its manifest and
+ * `onBlockEvent`.
+ */
 export declare const dataLifecycleEvents: Events<DataLifecycleEvents>;
 //#endregion
 //#region src/blocks/data-lifecycle/manifest.d.ts

package/dist/blocks/data-lifecycle/index.js

@@ -1,15 +1,14 @@
-import { n as dbError } from "../../errors-BV1SKTVs.js";
-import { a as ok, r as err, t as AsyncResult } from "../../result-DIeYscA3.js";
+import { n as dbError } from "../../errors-03ysrOt4.js";
+import { a as ok, r as err, t as AsyncResult } from "../../result-B3m7xtRY.js";
 import { n as isRecord } from "../../guards-6F2bCtQR.js";
 import { t as dataLifecycleSqlOptions } from "../../options-C239TLRF.js";
-import { t as fromStorageError } from "../../errors-D3BR8iUk.js";
-import { r as toCsv } from "../../csv-CVfXqaAu.js";
-import { n as credentialRefInTenant } from "../../provider-C-Ti38J6.js";
-import { n as event, t as defineEvents } from "../../event-map-Dy2vKHai.js";
-import { i as sqlTransport, r as rpcTransport, t as dbTransport } from "../../block-transport-J7ZepTq2.js";
-import { C as optionalText, D as recordOf, F as stringsOf, I as textOf, R as toInstant, S as optionalInstant, f as errorText, k as recordsOf, n as applyTemporal, o as blockCall } from "../../block-helpers-DkVZNDrj.js";
-import { r as withBlockHooks } from "../../block-hooks-C22vuIUd.js";
-import { n as defineBlock } from "../../define-block-B6Gjs57G.js";
+import { t as fromStorageError } from "../../errors-DZx8w-MH.js";
+import { B as dbTransport, C as optionalText, D as recordOf, F as stringsOf, H as rpcTransport, I as textOf, R as toInstant, S as optionalInstant, U as sqlTransport, f as errorText, k as recordsOf, n as applyTemporal, o as blockCall } from "../../block-helpers-CiKtrb6g.js";
+import { r as withBlockHooks } from "../../block-hooks-BymdcD0V.js";
+import { r as toCsv } from "../../csv-2rXGPNtP.js";
+import { n as credentialRefInTenant } from "../../provider-EJ0-5GwJ.js";
+import { n as event, t as defineEvents } from "../../event-map-CtPFhcOp.js";
+import { n as defineBlock } from "../../define-block-Dze77QTw.js";
 //#region src/blocks/data-lifecycle/data-lifecycle.ts
 const EXPORT_STATUSES = [
 	"pending",
@@ -60,7 +59,10 @@ function stored(reply) {
 		}
 	});
 }
-/** The table a file holds: `{id}/public.projects.ndjson` gives `public.projects`. */
+/**
+* The table a file holds: `{id}/public.projects.ndjson` gives
+* `public.projects`.
+*/
 const tableOf = (path) => path.slice(path.lastIndexOf("/") + 1).replace(/\.(ndjson|csv)$/, "");
 /** Exports and organization deletion as the caller. */
 function createDataLifecycle(options) {
@@ -422,7 +424,10 @@ function createRetention(options) {
 }
 //#endregion
 //#region src/blocks/data-lifecycle/events.ts
-/** The `data-lifecycle` block's event types, for its manifest and `onBlockEvent`. */
+/**
+* The `data-lifecycle` block's event types, for its manifest and
+* `onBlockEvent`.
+*/
 const dataLifecycleEvents = defineEvents({
 	"data_export.requested": event(),
 	"data_export.completed": event(),

package/dist/blocks/deals/index.d.ts

@@ -1,16 +1,16 @@
 /// <reference lib="esnext.temporal" />
-import { T as ErrorMapper, t as AsyncResult } from "../../result-BREt7qOh.js";
-import { wt as Events } from "../../events-P3raDX2E.js";
-import { h as DealEventData } from "../../index-BpyBH5O2.js";
+import { T as ErrorMapper, t as AsyncResult } from "../../result-C6jDfedy.js";
+import { t as StandardSchemaV1 } from "../../standard-DbQsD2xZ.js";
+import { r as FieldsOf } from "../../block-fields-3w4MZr8U.js";
+import { Ct as Events } from "../../events-DbLjvxDX.js";
+import { s as DealEventData } from "../../block-events-records-BGVyoz57.js";
 import { n as Logger } from "../../logger-DWVYUmwi.js";
-import { t as StandardSchemaV1 } from "../../standard-BcUQuUgu.js";
-import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DezJPPA0.js";
-import { r as BlockTemporalOptions } from "../../block-helpers-CjcQM1yA.js";
-import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-DcPJHztl.js";
-import { r as FieldsOf } from "../../block-fields-DnaDbgZS.js";
-import { s as BlockOf } from "../../define-block-BHxLHLys.js";
-import { t as SubjectConfig } from "../../subjects-DP-fvFkk.js";
-import { n as Money } from "../../money-DFpWzQvk.js";
+import { r as BlockTemporalOptions } from "../../block-helpers-BaugZlJV.js";
+import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-d53POsem.js";
+import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-CmjPKqQ_.js";
+import { c as BlockOf, rn as EntitySchema } from "../../define-block-COpcS6aT.js";
+import { n as Money } from "../../money-BNRdJQzA.js";
+import { t as DealForecast } from "../../deal-forecast-LwO-Z4_C.js";
 //#region src/blocks/deals/deals.d.ts
 /** How a rep calls a deal for the period. `undefined` is "not called". */
 type ForecastCategory = "commit" | "best_case" | "pipeline" | "omit";
@@ -150,25 +150,6 @@ interface DealLineInput {
   readonly taxCode?: string;
   readonly product?: DealParty;
 }
-/** The forecast call for one currency. */
-interface DealForecast {
-  readonly currency: string;
-  readonly won: Money;
-  readonly commit: Money;
-  readonly bestCase: Money;
-  readonly pipeline: Money;
-  readonly notCalled: Money;
-  readonly omit: Money;
-  /** Open deals that close after the period. */
-  readonly later: Money;
-  readonly target?: Money;
-  /** Won plus commit over the target. */
-  readonly attainment?: number;
-  readonly gap?: Money;
-  readonly owners: readonly (Omit<DealForecast, "owners" | "currency" | "target" | "attainment" | "gap"> & {
-    readonly ownerId?: string;
-  })[];
-}
 /** The checks a forecast review runs on an open deal. */
 interface DealHealth {
   readonly dealId: string;
@@ -217,8 +198,8 @@ interface DealsOptions<S extends StandardSchemaV1 | undefined = undefined> exten
   readonly schema?: string;
   /**
    * A Standard Schema for the deals' extra columns
-   * (`blocks.deals.options.extraColumns`), keyed by column name. It types
-   * and parses `fields` on reads and validates them on writes.
+   * (`blocks.deals.options.extraColumns`), keyed by column name. It types and
+   * parses `fields` on reads and validates them on writes.
    */
   readonly fields?: S;
   readonly hooks?: NoInfer<BlockHooks<Deals<FieldsOf<S>>>>;
@@ -226,21 +207,11 @@ interface DealsOptions<S extends StandardSchemaV1 | undefined = undefined> exten
   readonly mappers?: readonly ErrorMapper[];
 }
 /**
- * The deals block: deals on pipelines, with batched cell edits that reject
- * per change, won and lost through the pipeline's stages, contacts, a team,
- * line items, the forecast call and the review checks.
+ * The deals block: deals on pipelines, with batched cell edits that reject per
+ * change, won and lost through the pipeline's stages, contacts, a team, line
+ * items, the forecast call and the review checks.
  */
 export declare function createDeals<S extends StandardSchemaV1 | undefined = undefined>(options: DealsOptions<S>): Deals<FieldsOf<S>>;
-/**
- * The `config.subjects` entry for deals, so comments, tags, files, rank and
- * search attach to them. The board moves a deal by its stage id.
- */
-export declare function dealsSubjects(options?: {
-  readonly schema?: string;
-  readonly url?: string;
-}): {
-  readonly deal: SubjectConfig;
-};
 //#endregion
 //#region src/blocks/deals/events.d.ts
 /** The events of the `deals` block: type to data. */
@@ -259,4 +230,13 @@ export declare const dealsEvents: Events<DealsEvents>;
 /** The `deals` block's manifest (ADR 0029). */
 export declare const dealsBlock: BlockOf<"deals", typeof createDeals, DealsEvents>;
 //#endregion
+//#region src/blocks/deals/schemas.d.ts
+/** What `create` takes, with the bounds the SQL checks. */
+export declare const dealInputSchema: EntitySchema<DealInput>;
+/**
+ * One edit `update` takes. `field` is a built-in field or an extra column, so
+ * any name passes; the SQL rejects an unknown one.
+ */
+export declare const dealChangeSchema: EntitySchema<DealChange>;
+//#endregion
 export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type Deal, type DealChange, type DealChangeResult, type DealContact, type DealField, type DealForecast, type DealHealth, type DealInput, type DealLineInput, type DealOutcome, type DealParty, type DealTotals, type Deals, type DealsEvents, type DealsOptions, type ForecastCategory, type RpcClient, dbTransport, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };