better-supabase 0.12.0 → 0.14.0

package/dist/types-DkPE7yd2.d.ts

@@ -0,0 +1,194 @@
+/// <reference lib="esnext.temporal" />
+import { o as Message } from "./messaging-CZ6aWb10.js";
+//#region src/blocks/inbox/types.d.ts
+/** The channels an inbox can sit on. */
+type InboxChannel = "in_app" | "email" | "slack" | "teams" | "discord" | "telegram" | "whatsapp" | "messenger" | "instagram" | "sms" | "github" | "linear" | "other";
+/** `bot`: the bot answers; `human`: staff answer; `paused`: nobody answers. */
+type BotMode = "bot" | "human" | "paused";
+type ConversationStatus = "open" | "pending" | "snoozed" | "resolved";
+type ConversationPriority = "low" | "normal" | "high" | "urgent";
+type MessageDirection = "inbound" | "outbound";
+type AuthorType = "contact" | "agent" | "bot" | "system";
+type DeliveryStatus = "queued" | "sent" | "delivered" | "read" | "failed";
+interface InboxRow {
+  readonly id: string;
+  readonly tenant: string;
+  readonly name: string;
+  readonly channel: InboxChannel;
+  readonly address: string | null;
+  readonly installationId: string | null;
+  readonly botMode: BotMode;
+  readonly settings: Readonly<Record<string, unknown>>;
+  readonly createdAt: Temporal.Instant;
+  readonly archivedAt: Temporal.Instant | null;
+}
+interface Contact {
+  readonly id: string;
+  readonly tenant?: string;
+  readonly userId: string | null;
+  readonly name: string | null;
+  readonly email: string | null;
+  readonly phone: string | null;
+  readonly avatarUrl: string | null;
+  readonly metadata?: Readonly<Record<string, unknown>>;
+}
+interface Conversation {
+  readonly id: string;
+  readonly tenant: string;
+  readonly inboxId: string;
+  readonly contactId: string;
+  readonly subject: string | null;
+  readonly status: ConversationStatus;
+  readonly priority: ConversationPriority;
+  readonly assigneeId: string | null;
+  readonly teamId: string | null;
+  readonly botMode: BotMode;
+  /** The Chat SDK thread id, or `inbox:<id>` for the in-app widget. */
+  readonly threadId: string;
+  readonly snoozedUntil: Temporal.Instant | null;
+  readonly lastMessageAt: Temporal.Instant | null;
+  readonly preview: string | null;
+  readonly firstResponseAt: Temporal.Instant | null;
+  readonly resolvedAt: Temporal.Instant | null;
+  readonly metadata: Readonly<Record<string, unknown>>;
+  readonly createdAt: Temporal.Instant;
+  readonly contact: Contact | null;
+  readonly inbox: {
+    readonly id: string;
+    readonly name: string;
+    readonly channel: InboxChannel;
+  } | null;
+  /** When the caller last read it. */
+  readonly lastReadAt: Temporal.Instant | null;
+  /** When the contact last read it; `null` for contacts and before they read. */
+  readonly contactReadAt: Temporal.Instant | null;
+  /** In lists: whether a message arrived after `lastReadAt`. */
+  readonly unread?: boolean;
+}
+/**
+ * A file that arrived on a channel. The inbox stores it as a pending
+ * attachment; the service fetches it with `files.pending()` and uploads it.
+ */
+interface InboxFileSource {
+  /** Where the channel serves it. */
+  readonly url?: string;
+  /** Or a Storage object the caller already wrote. */
+  readonly path?: string;
+  /** The bucket of `path`; files migrated from the inbox are in `inbox-files`. */
+  readonly bucket?: string;
+  readonly name?: string;
+  readonly contentType?: string;
+  readonly size?: number;
+}
+/** A channel file waiting to be fetched, from `files.pending()`. */
+interface PendingInboxFile {
+  /** The attachment id: confirm it after the upload. */
+  readonly id: string;
+  readonly conversationId: string;
+  readonly messageId: string;
+  readonly tenant: string;
+  readonly bucket: string;
+  /** Where to upload it. */
+  readonly path: string;
+  readonly name: string;
+  readonly mimeType: string | undefined;
+  readonly source: InboxFileSource;
+}
+/** A Storage upload slot from `messages.createUpload`. */
+interface InboxUpload {
+  readonly id: string;
+  readonly bucket: string;
+  readonly path: string;
+}
+interface MessageDelivery {
+  readonly channel: string;
+  readonly status: DeliveryStatus;
+  readonly error: string | null;
+}
+/**
+ * A core message with the inbox's details. `kind: "note"` is an internal note
+ * only staff read.
+ */
+interface InboxMessage extends Message {
+  readonly direction: MessageDirection;
+  readonly authorType: AuthorType;
+  readonly format: "text" | "markdown";
+  readonly externalId: string | null;
+  readonly replyTo: string | null;
+  readonly metadata: Readonly<Record<string, unknown>>;
+  /** For staff: the first delivery on the channel. */
+  readonly delivery?: MessageDelivery | null;
+}
+interface ConversationEvent {
+  readonly id: string;
+  readonly type: string;
+  readonly actorId: string | null;
+  readonly data: Readonly<Record<string, unknown>>;
+  readonly createdAt: Temporal.Instant;
+}
+interface InboxCounts {
+  readonly open: number;
+  readonly mine: number;
+  readonly unassigned: number;
+  readonly unread: number;
+}
+/** What `purgeContact` erased. */
+interface PurgedContact {
+  readonly conversations: number;
+  readonly messages: number;
+  /** The erased attachments' Storage objects, for the caller to remove. */
+  readonly attachments: readonly {
+    readonly bucket: string;
+    readonly path: string;
+  }[];
+}
+interface InboundResult {
+  readonly conversationId: string;
+  readonly messageId: string;
+  readonly contactId: string;
+  readonly tenant: string;
+  /** A new conversation was opened for the thread. */
+  readonly created: boolean;
+  /** The message's `externalId` was already stored. */
+  readonly duplicate: boolean;
+}
+interface MessageTemplate {
+  readonly id: string;
+  readonly tenant: string;
+  readonly inboxId: string | null;
+  readonly name: string;
+  readonly channel: string;
+  readonly language: string;
+  readonly body: string;
+  readonly variables: readonly string[];
+  /** The provider's approved template name (WhatsApp). */
+  readonly externalId: string | null;
+}
+/** A staff reply waiting for `scheduledFor`; only its author sees it. */
+interface ScheduledInboxMessage {
+  readonly id: string;
+  readonly tenant: string;
+  readonly conversationId: string;
+  readonly authorId: string;
+  readonly body: string;
+  readonly format: "text" | "markdown" | null;
+  readonly attachments: readonly string[];
+  readonly mentions: readonly string[];
+  readonly replyTo: string | null;
+  readonly metadata: Readonly<Record<string, unknown>>;
+  readonly scheduledFor: Temporal.Instant;
+  readonly createdAt: Temporal.Instant;
+}
+interface StoredInboundEvent {
+  readonly id: string;
+  readonly adapter: string;
+  readonly externalId: string | null;
+  readonly inboxId: string | null;
+  readonly tenant: string | null;
+  readonly headers: Readonly<Record<string, string>>;
+  readonly body: string;
+  readonly attempts: number;
+  readonly receivedAt: Temporal.Instant;
+}
+//#endregion
+export { StoredInboundEvent as S, MessageDirection as _, ConversationEvent as a, PurgedContact as b, DeliveryStatus as c, InboxCounts as d, InboxFileSource as f, MessageDelivery as g, InboxUpload as h, Conversation as i, InboundResult as l, InboxRow as m, BotMode as n, ConversationPriority as o, InboxMessage as p, Contact as r, ConversationStatus as s, AuthorType as t, InboxChannel as u, MessageTemplate as v, ScheduledInboxMessage as x, PendingInboxFile as y };

package/dist/types-QHeku_6b.d.ts

@@ -0,0 +1,217 @@
+/// <reference lib="esnext.temporal" />
+import { T as ErrorMapper, 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 { n as Embedder } from "./knowledge-CFkCRxO9.js";
+//#region src/blocks/memory/types.d.ts
+type MemoryScope = "user" | "agent" | "chat" | "project" | "organization";
+type MemoryKind = "core" | "archival";
+/**
+ * Whose memory a call reads or changes. The default is the caller's own memory;
+ * `organization` memory is shared and only admins change it. The `project`
+ * scope takes a `projectId` (an ai-chat project) and no other scope does. The
+ * service role names the user in `ownerId`.
+ */
+interface MemoryNamespace {
+  readonly scope?: MemoryScope;
+  readonly agentId?: string;
+  readonly chatId?: string;
+  readonly projectId?: string;
+  readonly ownerId?: string;
+}
+interface MemoryRecord {
+  readonly id: string;
+  readonly organizationId: string;
+  readonly ownerId: string | undefined;
+  readonly scope: MemoryScope;
+  readonly agentId: string | undefined;
+  readonly chatId: string | undefined;
+  readonly projectId: string | undefined;
+  readonly kind: MemoryKind;
+  /** A path under `/memories`, for core memory. */
+  readonly path: string | undefined;
+  readonly content: string;
+  readonly version: number;
+  readonly embeddingModel: string | undefined;
+  readonly sourceMessageId: string | undefined;
+  readonly createdAt: Temporal.Instant;
+  readonly updatedAt: Temporal.Instant;
+}
+interface MemoryHit extends MemoryRecord {
+  readonly score: number;
+  /** Cosine similarity to the query embedding, when both have one. */
+  readonly similarity: number | undefined;
+}
+type MemoryView = {
+  readonly type: "file";
+  readonly path: string;
+  readonly content: string;
+  readonly version: number;
+} | {
+  readonly type: "directory";
+  readonly path: string;
+  readonly entries: readonly {
+    readonly path: string;
+    readonly size: number;
+  }[];
+};
+/** The commands of Anthropic's memory tool (`memory_20250818`). */
+type MemoryCommand = {
+  readonly command: "view";
+  readonly path: string;
+  readonly view_range?: readonly [number, number];
+} | {
+  readonly command: "create";
+  readonly path: string;
+  readonly file_text: string;
+} | {
+  readonly command: "str_replace";
+  readonly path: string;
+  readonly old_str: string;
+  readonly new_str?: string;
+} | {
+  readonly command: "insert";
+  readonly path: string;
+  readonly insert_line: number;
+  readonly insert_text: string;
+} | {
+  readonly command: "delete";
+  readonly path: string;
+} | {
+  readonly command: "rename";
+  readonly old_path: string;
+  readonly new_path: string;
+};
+interface RecalledMessage {
+  readonly chatId: string;
+  readonly messageId: string;
+  readonly similarity: number;
+}
+interface MemoryOptions extends BlockTemporalOptions {
+  /** Calls as the user: `rpcTransport(supabase)`. */
+  readonly transport: BlockTransport;
+  /** Calls as the service role, for embeddings and extracted memories. */
+  readonly service?: BlockTransport;
+  /**
+   * The module schema, or its API schema: `defineBlocks` passes it from
+   * `blocks.generated.ts`. Default `better_supabase`.
+   */
+  readonly schema?: string;
+  readonly mappers?: readonly ErrorMapper[];
+  /** Embeds archival memories, messages and queries. */
+  readonly embedder?: Embedder;
+  /** The most characters `render` returns. Default 8000. */
+  readonly maxRender?: number;
+  /** `saveExtracted` skips a fact this similar to a saved one. Default 0.92. */
+  readonly dedupeThreshold?: number;
+  /**
+   * `withBlockHooks` hooks around the methods, and around each group's under
+   * its name.
+   */
+  readonly hooks?: MemoryHooks;
+  /** Receives the errors `after` hooks throw. */
+  readonly logger?: Logger;
+}
+/**
+ * Hooks for `Memory`: the top-level methods, and `core`, `archival`, `recall`
+ * and `documents` by group.
+ */
+type MemoryHooks = BlockHooks<Memory> & {
+  readonly core?: BlockHooks<Memory["core"]>;
+  readonly archival?: BlockHooks<Memory["archival"]>;
+  readonly recall?: BlockHooks<Memory["recall"]>;
+  readonly documents?: BlockHooks<Memory["documents"]>;
+};
+interface Memory {
+  readonly core: {
+    view(organizationId: string, path?: string, ns?: MemoryNamespace): AsyncResult<MemoryView | undefined>;
+    /** Creates or overwrites a file; `expectedVersion` 0 means it must be new. */
+    write(organizationId: string, path: string, content: string, ns?: MemoryNamespace, options?: {
+      readonly expectedVersion?: number;
+    }): AsyncResult<MemoryRecord>;
+    strReplace(organizationId: string, path: string, oldText: string, newText: string, ns?: MemoryNamespace): AsyncResult<MemoryRecord>;
+    insert(organizationId: string, path: string, line: number, text: string, ns?: MemoryNamespace): AsyncResult<MemoryRecord>;
+    /** Deletes a file or a directory. Returns how many files. */
+    remove(organizationId: string, path: string, ns?: MemoryNamespace): AsyncResult<number>;
+    rename(organizationId: string, oldPath: string, newPath: string, ns?: MemoryNamespace): AsyncResult<number>;
+    list(organizationId: string, ns?: MemoryNamespace): AsyncResult<readonly MemoryRecord[]>;
+  };
+  /** Runs a memory tool command and returns the text for the model. */
+  run(organizationId: string, command: MemoryCommand, ns?: MemoryNamespace): AsyncResult<string>;
+  readonly archival: {
+    save(organizationId: string, content: string, ns?: MemoryNamespace, options?: {
+      readonly sourceMessageId?: string;
+    }): AsyncResult<MemoryRecord>;
+    search(organizationId: string, query: string, ns?: MemoryNamespace, options?: {
+      readonly k?: number;
+      readonly signal?: AbortSignal;
+    }): AsyncResult<readonly MemoryHit[]>;
+    list(organizationId: string, ns?: MemoryNamespace, options?: {
+      readonly limit?: number;
+    }): AsyncResult<readonly MemoryRecord[]>;
+    /** Deletes a memory, or marks it replaced by `supersededBy`. */
+    forget(memoryId: string, options?: {
+      readonly supersededBy?: string;
+    }): AsyncResult<boolean>;
+  };
+  readonly recall: {
+    /** Embeds a message so later chats can recall it (service role). */
+    index(message: {
+      readonly organizationId: string;
+      readonly chatId: string;
+      readonly messageId: string;
+      readonly userId: string;
+      readonly text: string;
+    }): AsyncResult<boolean>;
+    /** The caller's earlier messages closest to `query`. */
+    search(organizationId: string, query: string, options?: {
+      readonly k?: number;
+      readonly excludeChat?: string;
+      /** The service role only: whose messages. */
+      readonly ownerId?: string;
+      readonly signal?: AbortSignal;
+    }): AsyncResult<readonly RecalledMessage[]>;
+  };
+  /**
+   * Core memory as delimited text for a system prompt, cut at `maxRender`
+   * characters. Empty when there is none.
+   */
+  render(organizationId: string, ns?: MemoryNamespace): AsyncResult<string>;
+  /** Saves facts that aren't already remembered. Returns the new ones. */
+  saveExtracted(organizationId: string, facts: readonly string[], ns?: MemoryNamespace, options?: {
+    readonly sourceMessageId?: string;
+  }): AsyncResult<readonly MemoryRecord[]>;
+  /**
+   * Embeds memories edited since their last embedding (service role). Returns
+   * how many.
+   */
+  embedPending(options?: {
+    readonly batch?: number;
+    readonly signal?: AbortSignal;
+  }): AsyncResult<number>;
+  /**
+   * Documents under an opaque scope key, for agent runtimes (service role). A
+   * write names the version it read; a stale one fails with the hint
+   * `MEMORY_DOCUMENT_CONFLICT`.
+   */
+  readonly documents: {
+    read(scopeKey: string, path: string): AsyncResult<MemoryDocument | undefined>;
+    /** `expectedVersion: null` means the document must not exist yet. */
+    write(scopeKey: string, path: string, content: string, options: {
+      readonly expectedVersion: string | null;
+      /** Seconds until the document expires. */
+      readonly expiresIn?: number;
+    }): AsyncResult<MemoryDocument>;
+    /** Deletes expired documents, at most `batch`. Returns how many. */
+    purge(batch?: number): AsyncResult<number>;
+  };
+}
+interface MemoryDocument {
+  readonly content: string;
+  /** Opaque; pass it back as `expectedVersion`. */
+  readonly version: string;
+}
+//#endregion
+export { MemoryHooks as a, MemoryOptions as c, MemoryView as d, RecalledMessage as f, MemoryHit as i, MemoryRecord as l, MemoryCommand as n, MemoryKind as o, MemoryDocument as r, MemoryNamespace as s, Memory as t, MemoryScope as u };