better-supabase 0.13.0 → 0.15.0

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

@@ -1,15 +1,15 @@
 /// <reference lib="esnext.temporal" />
-import { T as ErrorMapper, t as AsyncResult } from "../../result-mijqfoJN.js";
-import { t as StandardSchemaV1 } from "../../standard-16AIDny5.js";
-import { r as FieldsOf } from "../../block-fields-DnXkMney.js";
-import { R as DriveEventData, wt as Events } from "../../events-DhGgwqQA.js";
+import { T as ErrorMapper, t as AsyncResult } from "../../result-DZeA5KS6.js";
+import { t as StandardSchemaV1 } from "../../standard-DBV730sF.js";
+import { r as FieldsOf } from "../../block-fields-BE7pInWZ.js";
+import { Ct as Events, R as DriveEventData } from "../../events-vcqenSYU.js";
 import { n as Logger } from "../../logger-DWVYUmwi.js";
-import { a as dbTransport, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DBPhgF3W.js";
-import { r as BlockTemporalOptions } from "../../block-helpers-DyA5BAW4.js";
-import { n as BlockHooks } from "../../block-hooks-BadAniNI.js";
-import { s as BlockOf } from "../../define-block-MyM4lH42.js";
-import { a as Attachment, f as AttachmentStorage, m as Attachments, s as AttachmentDownload } from "../../ports-BltcWsHf.js";
-import { t as SubjectConfig } from "../../subjects-DQ2SU4cA.js";
+import { r as BlockTemporalOptions } from "../../block-helpers-CRpAHrp_.js";
+import { a as dbTransport, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DWZSJrwN.js";
+import { n as BlockHooks } from "../../block-hooks-DZN2w69m.js";
+import { Ot as Attachments, Tt as AttachmentStorage, _t as AttachmentDownload, c as BlockOf, ht as Attachment } from "../../define-block-BVcLQ3DF.js";
+import { s as ApprovalStatus } from "../../approvals-Crutd4-o.js";
+import { t as SubjectConfig } from "../../subjects-DvmQeF_F.js";
 //#region src/blocks/drive/drive.d.ts
 interface DriveOptions<S extends StandardSchemaV1 | undefined = undefined> extends BlockTemporalOptions {
   /** The caller's transport (`rpcTransport(supabase)`), so grants apply. */
@@ -81,6 +81,37 @@ interface DriveNode<F extends object = Record<never, never>> {
   readonly role: string | undefined;
   readonly starredAt: Temporal.Instant | undefined;
   readonly openedAt: Temporal.Instant | undefined;
+  /** The tags on the node, with the tags block installed. */
+  readonly labels: readonly DriveLabel[] | undefined;
+  /**
+   * The latest approval request for the file's current version, with the
+   * approvals block installed; `undefined` when there is none.
+   */
+  readonly approval: DriveApprovalState | undefined;
+}
+/** A tag on a node. */
+interface DriveLabel {
+  readonly id: string;
+  readonly name: string;
+  readonly color: string | undefined;
+}
+interface DriveApprovalState {
+  readonly id: string;
+  readonly status: ApprovalStatus;
+  readonly createdAt: Temporal.Instant;
+  readonly decidedAt: Temporal.Instant | undefined;
+}
+/** An approval request for one stored version of a file. */
+interface DriveApproval extends DriveApprovalState {
+  /** The attachment the request is for. */
+  readonly attachmentId: string;
+  /** Its revision number, with the versions block installed. */
+  readonly revision: number | undefined;
+  /** Whether that version is the file's content now. */
+  readonly current: boolean;
+  readonly step: number;
+  readonly reason: string | undefined;
+  readonly requestedBy: string | undefined;
 }
 /** A folder above a node, root first. */
 interface DriveCrumb {
@@ -247,6 +278,20 @@ interface Drive<F extends object = Record<never, never>> {
   link(token: string, options?: {
     readonly nodeId?: string;
   }): AsyncResult<DriveLinkView<F>>;
+  /** Puts a tag on the node as a label, or takes it off (`applied: false`). */
+  label(id: string, tagId: string, applied?: boolean): AsyncResult<DriveNode<F>>;
+  /** The nodes that carry a label and the caller can read, folders first. */
+  labeled(organizationId: string, tagId: string, options?: DrivePage): AsyncResult<readonly DriveNode<F>[]>;
+  /**
+   * Asks for approval of one version of a file: `attachmentId`, or the current
+   * one. The request stays with those bytes.
+   */
+  requestApproval(id: string, options?: {
+    readonly attachmentId?: string;
+    readonly reason?: string;
+  }): AsyncResult<DriveApproval>;
+  /** The file's approval requests, newest first. */
+  approvals(id: string): AsyncResult<readonly DriveApproval[]>;
   /**
    * Service role: deletes revisions' files no revision or node uses any more,
    * and removes their objects through `storage`.
@@ -310,4 +355,4 @@ export declare const driveBlock: BlockOf<"drive", typeof createDrive, DriveEvent
   readonly attachments: "optional";
 }>;
 //#endregion
-export { type BlockTransport, type Drive, type DriveBatch, type DriveBinEntry, type DriveConflict, type DriveCrumb, type DriveEvents, type DriveFile, type DriveFileType, type DriveGrant, type DriveLinkView, type DriveNode, type DriveNodeKind, type DriveOptions, type DrivePage, type DrivePrincipal, type DrivePrincipalType, type DriveRevision, type DriveStoredObject, type DriveTreeData, type DriveUpload, type NewDriveFile, type NewDriveFolder, dbTransport, rpcTransport, sqlTransport };
+export { type BlockTransport, type Drive, type DriveApproval, type DriveApprovalState, type DriveBatch, type DriveBinEntry, type DriveConflict, type DriveCrumb, type DriveEvents, type DriveFile, type DriveFileType, type DriveGrant, type DriveLabel, type DriveLinkView, type DriveNode, type DriveNodeKind, type DriveOptions, type DrivePage, type DrivePrincipal, type DrivePrincipalType, type DriveRevision, type DriveStoredObject, type DriveTreeData, type DriveUpload, type NewDriveFile, type NewDriveFolder, dbTransport, rpcTransport, sqlTransport };

package/dist/blocks/drive/index.js

@@ -1,17 +1,23 @@
-import { n as dbError } from "../../errors-D7u24ZJH.js";
-import { a as ok, r as err, t as AsyncResult } from "../../result-DIT_qp4G.js";
+import { n as dbError } from "../../errors-BVFgt8BZ.js";
 import { n as isRecord } from "../../guards-6F2bCtQR.js";
+import { a as ok, r as err, t as AsyncResult } from "../../result-ntFBW2p2.js";
 import { t as driveSqlOptions } from "../../options-DCduTMST.js";
+import { A as requiredInstant, B as dbTransport, C as optionalText, D as recordOf, H as rpcTransport, I as textOf, S as optionalInstant, U as sqlTransport, d as enumOrThrow, k as recordsOf, n as applyTemporal, o as blockCall } from "../../block-helpers-CtBdjgO4.js";
+import { r as withBlockHooks } from "../../block-hooks-BfxX3682.js";
 import { n as event, t as defineEvents } from "../../event-map-CtPFhcOp.js";
-import { i as sqlTransport, r as rpcTransport, t as dbTransport } from "../../block-transport-Ds0C2mUf.js";
-import { A as requiredInstant, C as optionalText, D as recordOf, I as textOf, S as optionalInstant, d as enumOrThrow, k as recordsOf, n as applyTemporal, o as blockCall } from "../../block-helpers-DwE32_gT.js";
-import { r as withBlockHooks } from "../../block-hooks-C1r-R2r0.js";
-import { n as blockFields } from "../../block-fields-Cwd4c8m-.js";
-import { n as defineBlock } from "../../define-block-B6Gjs57G.js";
-import { n as claimsUploads, t as claimUpload } from "../../upload-claim-DCuklVyh.js";
-import { a as stored, t as attachmentOf } from "../../attachments-CPkGJVfk.js";
+import { n as blockFields } from "../../block-fields-DE_FgpOU.js";
+import { n as defineBlock } from "../../define-block-BGqOO8B3.js";
+import { n as claimsUploads, t as claimUpload } from "../../upload-claim-B1ZU8ydB.js";
+import { o as stored, t as attachmentOf } from "../../attachments-aJYgdYtB.js";
 //#region src/blocks/drive/drive.ts
 const KINDS = ["folder", "file"];
+const APPROVAL_STATUSES = [
+	"pending",
+	"approved",
+	"rejected",
+	"cancelled",
+	"expired"
+];
 const PRINCIPALS = [
 	"user",
 	"team",
@@ -44,7 +50,34 @@ function nodeOf(value, fn) {
 		fields: isRecord(row["fields"]) ? row["fields"] : {},
 		role: optionalText(row["role"]),
 		starredAt: optionalInstant(row["starredAt"]),
-		openedAt: optionalInstant(row["openedAt"])
+		openedAt: optionalInstant(row["openedAt"]),
+		labels: Array.isArray(row["labels"]) ? recordsOf(row["labels"], fn).map((label) => ({
+			id: textOf(label["id"]),
+			name: textOf(label["name"]),
+			color: optionalText(label["color"])
+		})) : void 0,
+		approval: isRecord(row["approval"]) ? approvalStateOf(row["approval"]) : void 0
+	};
+}
+function approvalStateOf(row) {
+	return {
+		id: textOf(row["id"]),
+		status: enumOrThrow(row["status"], APPROVAL_STATUSES, "approval status"),
+		createdAt: requiredInstant(row["createdAt"], "createdAt"),
+		decidedAt: optionalInstant(row["decidedAt"])
+	};
+}
+function approvalOf(value, fn) {
+	const row = recordOf(value, fn);
+	const revision = row["revision"];
+	return {
+		...approvalStateOf(row),
+		attachmentId: textOf(row["attachmentId"]),
+		revision: revision === null || revision === void 0 ? void 0 : Number(revision),
+		current: row["current"] === true,
+		step: Number(row["step"]),
+		reason: optionalText(row["reason"]),
+		requestedBy: optionalText(row["requestedBy"])
 	};
 }
 const nodesOf = (value, fn) => recordsOf(value, fn).map((row) => nodeOf(row, fn));
@@ -142,7 +175,9 @@ const NODE_METHODS = [
 	"open",
 	"starred",
 	"recent",
-	"link"
+	"link",
+	"label",
+	"labeled"
 ];
 const isNode = (value) => typeof value["kind"] === "string" && typeof value["organizationId"] === "string";
 /**
@@ -336,6 +371,22 @@ function createDrive(options) {
 			recent: true,
 			page_size: list.pageSize ?? null
 		}),
+		label: (id, tagId, applied = true) => call("drive_label", {
+			node: id,
+			tag: tagId,
+			applied
+		}, (value) => nodeOf(value, "drive_label")),
+		labeled: (organizationId, tagId, list = {}) => page("drive_labeled", {
+			tenant: organizationId,
+			tag: tagId,
+			page_size: list.pageSize ?? null
+		}),
+		requestApproval: (id, request = {}) => call("drive_request_approval", {
+			node: id,
+			attachment: request.attachmentId ?? null,
+			reason: request.reason ?? null
+		}, (value) => approvalOf(value, "drive_request_approval")),
+		approvals: (id) => call("drive_approvals", { node: id }, (value) => recordsOf(value, "drive_approvals").map((row) => approvalOf(row, "drive_approvals"))),
 		link: (token, link = {}) => call("drive_link", {
 			token,
 			node: link.nodeId ?? null

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

@@ -1,17 +1,17 @@
 /// <reference lib="esnext.temporal" />
-import { T as ErrorMapper, t as AsyncResult } from "../../result-mijqfoJN.js";
-import { t as StandardSchemaV1 } from "../../standard-16AIDny5.js";
-import { r as FieldsOf } from "../../block-fields-DnXkMney.js";
-import { wt as Events } from "../../events-DhGgwqQA.js";
-import { g as EmployeeEventData } from "../../index-CE0p3st5.js";
+import { T as ErrorMapper, f as Result, t as AsyncResult } from "../../result-DZeA5KS6.js";
+import { t as StandardSchemaV1 } from "../../standard-DBV730sF.js";
+import { r as FieldsOf } from "../../block-fields-BE7pInWZ.js";
+import { $ as RecordRef } from "../../types-DFdg_4yN.js";
+import { Ct as Events } from "../../events-vcqenSYU.js";
+import { y as EmployeeEventData } from "../../index-CG9rA8H8.js";
 import { n as Logger } from "../../logger-DWVYUmwi.js";
-import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DBPhgF3W.js";
-import { r as BlockTemporalOptions } from "../../block-helpers-DyA5BAW4.js";
-import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-BadAniNI.js";
-import { s as BlockOf } from "../../define-block-MyM4lH42.js";
-import { t as SubjectConfig } from "../../subjects-DQ2SU4cA.js";
+import { r as BlockTemporalOptions } from "../../block-helpers-CRpAHrp_.js";
+import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DWZSJrwN.js";
+import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-DZN2w69m.js";
+import { Bt as Action, Sn as EntitySchema, c as BlockOf } from "../../define-block-BVcLQ3DF.js";
 import { n as Money } from "../../money-BNRdJQzA.js";
-import { t as RecordRef } from "../../sales-shared-DAAGwQwN.js";
+import { n as ConversionContext, t as ConversionClients } from "../../conversion-BAbucuXq.js";
 //#region src/blocks/employees/employees.d.ts
 type EmployeeStatus = "preboarding" | "active" | "on_leave" | "offboarded";
 type SalaryPeriod = "hour" | "week" | "month" | "year";
@@ -180,17 +180,6 @@ interface EmployeesOptions<S extends StandardSchemaV1 | undefined = undefined> e
  * behind employees.view_sensitive.
  */
 export declare function createEmployees<S extends StandardSchemaV1 | undefined = undefined>(options: EmployeesOptions<S>): Employees<FieldsOf<S>>;
-/**
- * The `config.subjects` entry for employees, so comments, files, tags and
- * search attach to them. Pass `schema` when the module isn't in
- * `better_supabase`.
- */
-export declare function employeesSubjects(options?: {
-  readonly schema?: string;
-  readonly url?: string;
-}): {
-  readonly employee: SubjectConfig;
-};
 //#endregion
 //#region src/blocks/employees/events.d.ts
 /** The events of the `employees` block: type to data. */
@@ -207,4 +196,33 @@ export declare const employeesEvents: Events<EmployeesEvents>;
 /** The `employees` block's manifest (ADR 0029). */
 export declare const employeesBlock: BlockOf<"employees", typeof createEmployees, EmployeesEvents>;
 //#endregion
-export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type Contract, type ContractInput, type EmergencyContact, type Employee, type EmployeeChange, type EmployeeChangeResult, type EmployeeField, type EmployeeInput, type EmployeeStatus, type Employees, type EmployeesEvents, type EmployeesOptions, type OrgChartEntry, type PrivateDetails, type PrivateDetailsInput, type RpcClient, type SalaryPeriod, dbTransport, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };
+//#region src/blocks/employees/schemas.d.ts
+/** What `create` takes, with the bounds the SQL checks. */
+export declare const employeeInputSchema: EntitySchema<EmployeeInput>;
+/**
+ * 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 employeeChangeSchema: EntitySchema<EmployeeChange>;
+//#endregion
+//#region src/blocks/employees/actions.d.ts
+/** `blocks.employees` and `blocks.relations` for one organization. */
+interface EmployeeFromApplicationClients extends ConversionClients {
+  readonly employees: {
+    fromApplication(applicationId: string, overrides?: Partial<EmployeeInput>): PromiseLike<Result<Employee>>;
+  };
+}
+interface EmployeeFromApplicationOptions {
+  /** The clients for one organization, over a service connection. */
+  readonly clients: (tenant: string) => EmployeeFromApplicationClients | PromiseLike<EmployeeFromApplicationClients>;
+  /** Overrides what the employee takes from the candidate and the job. */
+  readonly map?: (context: ConversionContext<EmployeeFromApplicationClients>) => Partial<EmployeeInput>;
+}
+/**
+ * The `employees.from_application` action, which the hiring block's default
+ * automation runs on `application.hired`: an employee in preboarding through
+ * `employees.fromApplication`, which records the `created_from` link itself.
+ */
+export declare function employeeFromApplicationAction(options: EmployeeFromApplicationOptions): Action;
+//#endregion
+export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type Contract, type ContractInput, type EmergencyContact, type Employee, type EmployeeChange, type EmployeeChangeResult, type EmployeeField, type EmployeeFromApplicationClients, type EmployeeFromApplicationOptions, type EmployeeInput, type EmployeeStatus, type Employees, type EmployeesEvents, type EmployeesOptions, type OrgChartEntry, type PrivateDetails, type PrivateDetailsInput, type RpcClient, type SalaryPeriod, dbTransport, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };

package/dist/blocks/employees/index.js

@@ -1,15 +1,16 @@
-import { t as temporal } from "../../temporal-required-Dt4mcPsi.js";
-import { a as ok, t as AsyncResult } from "../../result-DIT_qp4G.js";
 import { n as isRecord } from "../../guards-6F2bCtQR.js";
+import { t as temporal } from "../../temporal-required-Dy0GGD8E.js";
+import { a as ok, t as AsyncResult } from "../../result-ntFBW2p2.js";
 import { t as employeesSqlOptions } from "../../options-DWpz3V3F.js";
+import { B as dbTransport, C as optionalText, D as recordOf, H as rpcTransport, I as textOf, S as optionalInstant, U as sqlTransport, d as enumOrThrow, k as recordsOf, n as applyTemporal, o as blockCall } from "../../block-helpers-CtBdjgO4.js";
+import { i as wrapTransport, n as extendBlock, r as withBlockHooks } from "../../block-hooks-BfxX3682.js";
+import { n as entitySchema } from "../../entity-schema-BDv6w-OQ.js";
 import { n as event, t as defineEvents } from "../../event-map-CtPFhcOp.js";
-import { i as sqlTransport, r as rpcTransport, t as dbTransport } from "../../block-transport-Ds0C2mUf.js";
-import { C as optionalText, D as recordOf, I as textOf, S as optionalInstant, d as enumOrThrow, k as recordsOf, n as applyTemporal, o as blockCall } from "../../block-helpers-DwE32_gT.js";
-import { i as wrapTransport, n as extendBlock, r as withBlockHooks } from "../../block-hooks-C1r-R2r0.js";
-import { n as blockFields } from "../../block-fields-Cwd4c8m-.js";
-import { n as defineBlock } from "../../define-block-B6Gjs57G.js";
-import { o as optionalMoneyOf, t as amountText } from "../../money-codec-BdnIiFFX.js";
-import { i as refOf, n as compact, r as plainDate } from "../../sales-shared-CjXsy0NJ.js";
+import { n as blockFields } from "../../block-fields-DE_FgpOU.js";
+import { n as defineBlock } from "../../define-block-BGqOO8B3.js";
+import { t as defineConversionAction } from "../../conversion-Dq1S7xzE.js";
+import { o as optionalMoneyOf, t as amountText } from "../../money-codec-BzddguAQ.js";
+import { i as refOf, n as compact, r as plainDate } from "../../sales-shared-DXGFJP4g.js";
 //#region src/blocks/employees/employees.ts
 const STATUSES = [
 	"preboarding",
@@ -245,28 +246,6 @@ function createEmployees(options) {
 		...options.logger ? { logger: options.logger } : {}
 	});
 }
-/**
-* The `config.subjects` entry for employees, so comments, files, tags and
-* search attach to them. Pass `schema` when the module isn't in
-* `better_supabase`.
-*/
-function employeesSubjects(options = {}) {
-	return { employee: {
-		table: `${options.schema ?? "better_supabase"}.employees`,
-		idType: "uuid",
-		tenant: "tenant_id",
-		title: "name",
-		permissions: {
-			read: "employees.read",
-			write: "employees.write"
-		},
-		search: {
-			title: "name",
-			body: ["email", "job_title"]
-		},
-		...options.url === void 0 ? {} : { url: options.url }
-	} };
-}
 //#endregion
 //#region src/blocks/employees/events.ts
 /** The `employees` block's event types, for its manifest and `onBlockEvent`. */
@@ -277,6 +256,90 @@ const employeesEvents = defineEvents({
 	"employee.manager_changed": event()
 });
 //#endregion
+//#region src/blocks/employees/schemas.ts
+/** What `create` takes, with the bounds the SQL checks. */
+const employeeInputSchema = entitySchema({
+	title: "EmployeeInput",
+	fields: {
+		name: {
+			kind: "string",
+			minLength: 1,
+			maxLength: 200
+		},
+		email: {
+			kind: "string",
+			optional: true,
+			maxLength: 320
+		},
+		userId: {
+			kind: "uuid",
+			optional: true
+		},
+		jobTitle: {
+			kind: "string",
+			optional: true,
+			maxLength: 200
+		},
+		teamId: {
+			kind: "uuid",
+			optional: true
+		},
+		managerId: {
+			kind: "uuid",
+			optional: true
+		},
+		employmentType: {
+			kind: "string",
+			optional: true
+		},
+		status: {
+			kind: "enum",
+			values: [
+				"preboarding",
+				"active",
+				"on_leave"
+			],
+			optional: true
+		},
+		startDate: {
+			kind: "plainDate",
+			optional: true
+		},
+		endDate: {
+			kind: "plainDate",
+			optional: true
+		},
+		origin: {
+			kind: "json",
+			optional: true,
+			description: "A `{ type, id }` reference."
+		},
+		fields: {
+			kind: "json",
+			optional: true,
+			description: "The extra columns to set."
+		}
+	}
+});
+/**
+* One edit `update` takes. `field` is a built-in field or an extra column, so
+* any name passes; the SQL rejects an unknown one.
+*/
+const employeeChangeSchema = entitySchema({
+	title: "EmployeeChange",
+	fields: {
+		employeeId: { kind: "uuid" },
+		field: {
+			kind: "string",
+			minLength: 1
+		},
+		value: {
+			kind: "unknown",
+			description: "`null` clears the field."
+		}
+	}
+});
+//#endregion
 //#region src/blocks/employees/manifest.ts
 /** The `employees` block's manifest (ADR 0029). */
 const employeesBlock = defineBlock({
@@ -286,7 +349,36 @@ const employeesBlock = defineBlock({
 	events: employeesEvents,
 	create: createEmployees,
 	category: "people",
-	recipes: ["employee-directory"]
+	recipes: ["employee-directory"],
+	actions: [{
+		kind: "employees.from_application",
+		title: "Preboard the hired candidate"
+	}],
+	schemas: { employee: {
+		input: employeeInputSchema,
+		change: employeeChangeSchema
+	} }
 });
 //#endregion
-export { createEmployees, dbTransport, employeesBlock, employeesEvents, employeesSubjects, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };
+//#region src/blocks/employees/actions.ts
+/**
+* The `employees.from_application` action, which the hiring block's default
+* automation runs on `application.hired`: an employee in preboarding through
+* `employees.fromApplication`, which records the `created_from` link itself.
+*/
+function employeeFromApplicationAction(options) {
+	return defineConversionAction({
+		kind: "employees.from_application",
+		title: "Preboard the hired candidate",
+		targetType: "employee",
+		clients: options.clients,
+		map: (_, context) => options.map?.(context) ?? {},
+		create: async (overrides, { clients, source }) => {
+			const created = await clients.employees.fromApplication(source.id, overrides);
+			return created.ok ? ok({ id: created.data.id }) : created;
+		},
+		linksItself: true
+	});
+}
+//#endregion
+export { createEmployees, dbTransport, employeeChangeSchema, employeeFromApplicationAction, employeeInputSchema, employeesBlock, employeesEvents, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };

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

@@ -0,0 +1,176 @@
+/// <reference lib="esnext.temporal" />
+import { T as ErrorMapper, t as AsyncResult } from "../../result-DZeA5KS6.js";
+import { Ct as Events } from "../../events-vcqenSYU.js";
+import { S as EnrichmentEventData } from "../../index-CG9rA8H8.js";
+import { n as Logger } from "../../logger-DWVYUmwi.js";
+import { r as BlockTemporalOptions } from "../../block-helpers-CRpAHrp_.js";
+import { a as dbTransport, i as RpcClient, o as rpcTransport, s as sqlTransport, t as BlockTransport } from "../../block-transport-DWZSJrwN.js";
+import { a as BlockTransportMiddleware, d as extendBlock, f as withBlockHooks, n as BlockHooks, p as wrapTransport } from "../../block-hooks-DZN2w69m.js";
+import { c as BlockOf } from "../../define-block-BVcLQ3DF.js";
+//#region src/blocks/enrichment/providers.d.ts
+/** What a provider looks up a company by. */
+interface CompanyLookup {
+  readonly name: string;
+  readonly domain?: string;
+  readonly website?: string;
+  readonly signal?: AbortSignal;
+}
+/** What a provider looks up a person by. */
+interface PersonLookup {
+  readonly name: string;
+  readonly email?: string;
+  readonly phone?: string;
+  /** The domain of the person's primary company, when it has one. */
+  readonly companyDomain?: string;
+  readonly signal?: AbortSignal;
+}
+/**
+ * A company as a provider describes it. `domain` and `website` fill the
+ * company's empty columns; everything is stored with the result.
+ */
+interface CompanyProfile {
+  readonly name?: string;
+  readonly domain?: string;
+  readonly website?: string;
+  readonly industry?: string;
+  readonly employees?: number;
+  readonly foundedYear?: number;
+  readonly country?: string;
+  readonly city?: string;
+  readonly linkedinUrl?: string;
+  readonly description?: string;
+}
+/**
+ * A person as a provider describes them. `title` and `phone` fill the person's
+ * empty columns; everything is stored with the result.
+ */
+interface PersonProfile {
+  readonly title?: string;
+  readonly phone?: string;
+  readonly companyName?: string;
+  readonly country?: string;
+  readonly city?: string;
+  readonly linkedinUrl?: string;
+}
+/**
+ * Looks up companies and people. Versioned: a breaking change to this contract
+ * ships a new `apiVersion`. A lookup without a match returns `undefined`;
+ * errors are `DbError`s: `unauthorized` for a key the provider refuses,
+ * `rate_limited` with `retryAfter`, `network` for an outage.
+ */
+interface EnrichmentProvider {
+  readonly apiVersion: 1;
+  /** The name results are stored under, such as `peopledatalabs`. */
+  readonly name: string;
+  company(input: CompanyLookup): AsyncResult<CompanyProfile | undefined>;
+  person(input: PersonLookup): AsyncResult<PersonProfile | undefined>;
+}
+/** Checks the provider's `apiVersion` and name before the block uses it. */
+export declare function enrichmentProviderOf(provider: EnrichmentProvider): EnrichmentProvider;
+/** The bare host of a website or domain: no scheme, `www.`, port or path. */
+export declare function domainOf(value: string | undefined): string | undefined;
+interface PeopleDataLabsOptions {
+  /** A People Data Labs API key. */
+  readonly apiKey: string;
+  /** Defaults to the global `fetch`. */
+  readonly fetch?: typeof fetch;
+  /** The API origin, for a proxy or a test server. */
+  readonly baseUrl?: string;
+  /** The lowest match likelihood (1 to 10) a person lookup accepts. Default: 6. */
+  readonly minLikelihood?: number;
+}
+/**
+ * The People Data Labs company and person enrichment APIs (v5), over `fetch`. A
+ * company is matched by its website or domain and name, a person by email, name
+ * and company domain.
+ */
+export declare function peopleDataLabsEnrichment(options: PeopleDataLabsOptions): EnrichmentProvider;
+//#endregion
+//#region src/blocks/enrichment/enrichment.d.ts
+/** A company or person, by its subject type and id. */
+interface EnrichmentSubject {
+  /** The parties block's subject type: `company` or `person`, after renames. */
+  readonly type: string;
+  readonly id: string;
+}
+/** What a provider returned for a record, as stored. */
+interface EnrichmentResult {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly subjectType: string;
+  readonly subjectId: string;
+  readonly provider: string;
+  readonly status: "matched" | "not_found";
+  /** The provider's profile; `{}` when nothing matched. */
+  readonly data: Readonly<Record<string, unknown>>;
+  /** The record's columns this result filled, such as `domain` or `title`. */
+  readonly filled: readonly string[];
+  readonly fetchedAt: Temporal.Instant;
+  readonly requestedBy: string | undefined;
+}
+/** What `enrichDue` did. */
+interface EnrichmentReport {
+  readonly checked: number;
+  readonly matched: number;
+  readonly notFound: number;
+  /** Lookups the provider failed; the records stay due. */
+  readonly failed: number;
+}
+interface EnrichOptions {
+  /** Fill the record's empty columns from a match. Default: the block's `fill`. */
+  readonly fill?: boolean;
+  readonly signal?: AbortSignal;
+}
+interface Enrichment {
+  /**
+   * Looks a company or person up with the provider and stores the result. Needs
+   * `enrichment.run`. A provider error is returned and nothing is stored.
+   */
+  enrich(subject: EnrichmentSubject, options?: EnrichOptions): AsyncResult<EnrichmentResult>;
+  /**
+   * Enriches the records the provider has no result for, or one older than
+   * `staleAfter`, for a cron. Service role. Stops early when the provider rate
+   * limits or refuses the key.
+   */
+  enrichDue(options?: {
+    /** At most this many records. Default: 25. */
+    readonly limit?: number;
+    /** A Postgres interval. Default: `30 days`. */
+    readonly staleAfter?: string;
+    /** Only companies or only people. */
+    readonly subjectType?: string;
+    readonly signal?: AbortSignal;
+  }): AsyncResult<EnrichmentReport>;
+  /** A record's stored results, one per provider, newest first. */
+  of(subject: EnrichmentSubject): AsyncResult<EnrichmentResult[]>;
+}
+interface EnrichmentOptions extends BlockTemporalOptions {
+  readonly transport: BlockTransport;
+  /** Looks records up; `peopleDataLabsEnrichment`, or your own. */
+  readonly provider: EnrichmentProvider;
+  /** Fill a record's empty columns from a match. Default: true. */
+  readonly fill?: boolean;
+  /**
+   * The module schema, or its API schema: `defineBlocks` passes it from
+   * `blocks.generated.ts`.
+   */
+  readonly schema?: string;
+  readonly hooks?: NoInfer<BlockHooks<Enrichment>>;
+  readonly logger?: Logger;
+  readonly mappers?: readonly ErrorMapper[];
+}
+export declare function createEnrichment(options: EnrichmentOptions): Enrichment;
+//#endregion
+//#region src/blocks/enrichment/events.d.ts
+/** The events of the `enrichment` block: type to data. */
+type EnrichmentEvents = {
+  readonly "party.enriched": EnrichmentEventData;
+};
+/** The `enrichment` block's event types, for its manifest and `onBlockEvent`. */
+export declare const enrichmentEvents: Events<EnrichmentEvents>;
+//#endregion
+//#region src/blocks/enrichment/manifest.d.ts
+/** The `enrichment` block's manifest (ADR 0029). */
+export declare const enrichmentBlock: BlockOf<"enrichment", typeof createEnrichment, EnrichmentEvents>;
+//#endregion
+export { type BlockHooks, type BlockTransport, type BlockTransportMiddleware, type CompanyLookup, type CompanyProfile, type EnrichOptions, type Enrichment, type EnrichmentEvents, type EnrichmentOptions, type EnrichmentProvider, type EnrichmentReport, type EnrichmentResult, type EnrichmentSubject, type PeopleDataLabsOptions, type PersonLookup, type PersonProfile, type RpcClient, dbTransport, extendBlock, rpcTransport, sqlTransport, withBlockHooks, wrapTransport };