js-bao-wss-client 3.5.0-alpha.2 → 3.5.0-alpha.4

package/README.md

@@ -462,7 +462,7 @@ await expect(
 
 ## Quick Start
 
-> Migrating from legacy decorators? Follow `src/client/docs/js-bao-v2-migration.md` before continuing—models must now be defined with `defineModelSchema`/`createModelClass`.
+> Migrating from legacy decorators? Follow `src/client/docs/js-bao-v2-migration.md` before continuing—a model is a class that extends `BaseModel`, with a schema from `defineModelSchema` attached by `attachAndRegisterModel`.
 
 ### 1. Initialize the Client
 
@@ -472,11 +472,10 @@ await expect(
 import {
   initializeClient,
   defineModelSchema,
-  createModelClass,
+  attachAndRegisterModel,
   InferAttrs,
-  TypedModelConstructor,
 } from "js-bao-wss-client";
-import type { BaseModel } from "js-bao";
+import { BaseModel } from "js-bao";
 
 const contactSchema = defineModelSchema({
   name: "contacts",
@@ -489,9 +488,8 @@ const contactSchema = defineModelSchema({
 });
 type ContactAttrs = InferAttrs<typeof contactSchema>;
 interface Contact extends ContactAttrs, BaseModel {}
-const Contact: TypedModelConstructor<Contact> = createModelClass({
-  schema: contactSchema,
-});
+class Contact extends BaseModel {}
+attachAndRegisterModel(Contact, contactSchema);
 
 async function bootstrap() {
   const client = await initializeClient({
@@ -1914,14 +1912,22 @@ the returned subscription). To keep listening, invoke the authorizing function
 again before then and call `subscribeToChannel` with the new grant; that
 replaces the membership rather than adding a second one.
 
+### Removed Client APIs
+
+These client APIs were removed with the member routes they called. Each has a
+server-function replacement:
+
+- `client.workflows.runSync` — call a server function with `client.functions.invoke` for a result in one request.
+- `client.prompts.execute` — call a server function that runs the prompt with `ctx.prompts.run`.
+- `client.integrations.call` — call a server function that calls the integration with `ctx.integrations.call`.
+- `client.databases.listOperations`, `executeOperation`, `executeBatch`, `importBulk` and `importCsv` — call a server function that reads and writes records with `ctx.db`.
+
 ### Deprecated Client APIs
 
 These client APIs still work but are deprecated. Each has a server-function
 replacement:
 
 - `client.workflows.*` — call a server function: `client.functions.invoke` for a result, or `client.functions.start` / `getStatus` / `waitFor` for a long-running run.
-- `client.prompts.execute` — call a server function that runs the prompt with `ctx.prompts.run`.
-- `client.integrations.call` — call a server function that calls the integration with `ctx.integrations.call`.
 - `client.databases.*` — call a server function that reads and writes records with `ctx.db` and manages databases with `ctx.api.databases`; for live updates, join a channel the function publishes to.
 - `client.cronTriggers.*` — schedule a server function by declaring `[[function.triggers.cron]]` in its config.
 

package/dist/JsBaoClient.d.ts

@@ -44,7 +44,7 @@ export type { DocumentInfo, DocumentPermissionEntry, DocumentAccessResult, Docum
 export type { UserProfile, SharedDocument, SharedDocumentListResult, SharedDocumentsOptions, OwnedDocumentsOptions, } from "./api/meApi";
 export type { SessionInfo } from "./api/sessionApi";
 export type { BasicUserInfo, BatchUserProfile } from "./api/usersApi";
-export type { DatabaseInfo, DatabasePermissionEntry, DatabaseGroupPermissionEntry, GrantDatabaseGroupPermissionParams, DatabaseOwnershipTransferResult, DatabaseOperationInfo, AddManagerParams, CsvImportOptions, CsvImportProgress, CsvImportResult, ExecuteOperationOptions, DatabaseChangeEvent, DatabaseChangePayload, DatabaseSubscribeOptions, ListDatabasesOptions, DatabaseListPage, OperationType, OperationFilter, QueryDefinition, MutationOperation, MutationDefinition, CountDefinition, AggregateOperation, AggregateDefinition, PipelineStep, PipelineDefinition, ApplyToQuerySource, ApplyToQueryAction, ApplyToQueryDefinition, OperationDefinition, CreateOperationParams, UpdateOperationParams, } from "./api/databasesApi";
+export type { DatabaseInfo, DatabasePermissionEntry, DatabaseGroupPermissionEntry, GrantDatabaseGroupPermissionParams, DatabaseOwnershipTransferResult, DatabaseOperationInfo, AddManagerParams, DatabaseChangeEvent, DatabaseChangePayload, DatabaseSubscribeOptions, ListDatabasesOptions, DatabaseListPage, OperationType, OperationFilter, QueryDefinition, MutationOperation, MutationDefinition, CountDefinition, AggregateOperation, AggregateDefinition, PipelineStep, PipelineDefinition, ApplyToQuerySource, ApplyToQueryAction, ApplyToQueryDefinition, OperationDefinition, CreateOperationParams, UpdateOperationParams, } from "./api/databasesApi";
 export type { GroupInfo, GroupMemberInfo, GroupMembershipInfo, GroupDocumentInfo, GroupDatabaseInfo, ListUserMembershipsOptions, DirectGroupAdd, DeferredGroupAdd, GroupAddMemberResult, } from "./api/groupsApi";
 export type { CollectionInfo, CollectionDocumentInfo, CollectionGroupPermissionInfo, CollectionMemberInfo, CollectionAccessInfo, DocumentCollectionInfo, AddCollectionMemberParams, DirectCollectionAdd, DeferredCollectionAdd, CollectionAddMemberResult, PendingCollectionInvitationEntry, } from "./api/collectionsApi";
 export type { RuleSetInfo, RuleSetSchema, RuleSetTestResult, RuleSetDebugResult, TraceEntry, TriggerDefInfo, ModelRulesInfo, PathDeclaration, RuleLoads, RuleExpression, CategoryRules, } from "./api/ruleSetsApi";
@@ -62,7 +62,7 @@ export type { DocumentsAPI, DocumentContext, DocumentAliasesAPI, DocumentIngests
 export type { DatabasesAPI } from "./api/databasesApi";
 export type { CollectionsAPI } from "./api/collectionsApi";
 export type { AgentsAPI, AgentSessionsAPI } from "./api/agentSessionsApi";
-export type { AgentSessionMemberRole, AgentSessionMembers, AgentSessionInfo, AgentSessionListItem, ListAgentSessionsOptions, AgentSessionRenameResult, AgentSessionDeleteResult, AgentSessionMembersResult, AgentSessionStatus, AgentTurnPause, AgentSessionTurnSummary, AgentSessionInspectedTurn, AgentSessionInspectedCall, AgentSessionObjectState, AgentSessionSendBody, AgentSessionSendResult, AgentCallAnswer, AgentCallAnswerResult, AgentSessionCancelResult, AgentSessionEvent, AgentSessionEventResult, } from "./api/agentSessionsApi";
+export type { AgentSessionMemberRole, AgentSessionMembers, AgentSessionInfo, AgentSessionListItem, ListAgentSessionsOptions, AgentSessionRenameResult, AgentSessionDeleteResult, AgentSessionMembersResult, AgentSessionStatus, AgentTurnPause, AgentSessionTurnSummary, AgentSessionInspectedTurn, AgentSessionInspectedCall, AgentSessionObjectState, AgentSessionSendBody, AgentSessionSendResult, AgentCallAnswer, AgentCallAnswerResult, AgentSessionCancelResult, AgentSessionReadResult, AgentSessionEvent, AgentSessionEventResult, } from "./api/agentSessionsApi";
 export type { MeAPI } from "./api/meApi";
 export type { SessionAPI } from "./api/sessionApi";
 export type { UsersAPI } from "./api/usersApi";
@@ -120,54 +120,6 @@ export interface AnalyticsAutoEventsOptions {
     };
     sessionEnd?: boolean;
 }
-/**
- * Request passed to `client.integrations.call()`. Identifies the integration
- * by key and describes the HTTP request to send through the integration
- * proxy: method, path, query parameters, headers, and body.
- */
-export interface IntegrationCallRequest<TReq = unknown> {
-    integrationKey: string;
-    method?: string;
-    path?: string;
-    query?: Record<string, any>;
-    headers?: Record<string, string>;
-    body?: TReq;
-}
-/**
- * Response envelope resolved by `client.integrations.call()`. Carries the
- * proxied HTTP status, headers, and parsed body, plus optional trace
- * metadata (`traceId`, `durationMs`) and an `errorCode` when the call
- * failed at the proxy layer.
- */
-export interface IntegrationCallResponse<T = unknown> {
-    status: number;
-    headers: Record<string, string>;
-    body: T;
-    traceId?: string;
-    durationMs?: number;
-    errorCode?: string;
-}
-/**
- * Integrations API, available as `client.integrations`. Sends requests to
- * third-party services through integrations configured for the app, so
- * credentials stay server-side.
- * @deprecated Call a server function instead: it calls the integration with
- * `ctx.integrations.call` (see the Server Functions guide).
- */
-export interface IntegrationsAPI {
-    /**
-     * Call an integration's proxy endpoint.
-     *
-     * The optional generics are additive. `TRes` types the response body and is
-     * **first** to preserve the meaning of existing single-arg
-     * `call<MyResponse>()` call sites; `TReq` types the request `body`. Both
-     * default to `unknown`, so untyped callers must narrow before reading
-     * arbitrary properties.
-     * @deprecated Call a server function instead: it calls the integration with
-     * `ctx.integrations.call` (see the Server Functions guide).
-     */
-    call<TRes = unknown, TReq = unknown>(request: IntegrationCallRequest<TReq>): Promise<IntegrationCallResponse<TRes>>;
-}
 /**
  * Workflows API, available as `client.workflows`. Starts, monitors, and
  * terminates server-side workflow runs, and manages the client-side apply
@@ -192,30 +144,6 @@ export interface WorkflowsAPI {
     start<I = Record<string, any>>(options: Omit<StartWorkflowOptions, "input"> & {
         input?: I;
     }): Promise<StartWorkflowResult>;
-    /**
-     * Synchronously invoke a workflow and wait for the final result.
-     *
-     * Only callable on workflows marked `syncCallable: true` in their
-     * server-side definition. Use this for low-latency,
-     * short-task workflows. Long-running workflows should keep using
-     * `start()` plus the WebSocket / polling lifecycle.
-     *
-     * The promise **resolves** with the final envelope for every outcome,
-     * including engine failure and timeout — failure surfaces as
-     * `status: "failed"` (or `"timeout"` / `"terminated"`), not a thrown
-     * error. Network / transport errors still reject as usual.
-     *
-     * The optional generics `I` (input) and `O` (`output`) type the payload and
-     * the result envelope. Both are additive and default to today's
-     * untyped `Record<string, any>` / `any`, so existing callers are unaffected.
-     * The generated per-workflow `<key>(client)` factory supplies them from the
-     * workflow's `inputSchema`/`outputSchema`.
-     * @deprecated Call a server function instead: `client.functions.invoke` (see
-     * the Server Functions guide).
-     */
-    runSync<I = Record<string, any>, O = any>(options: Omit<RunSyncWorkflowOptions, "input"> & {
-        input?: I;
-    }): Promise<RunSyncWorkflowResult<O>>;
     /**
      * Get the status of a workflow run. If contextDocId is not provided, uses the
      * user's root document.
@@ -233,9 +161,6 @@ export interface WorkflowsAPI {
      * an error. `run.status` on the same response carries the recorded terminal
      * status throughout.
      *
-     * A run executed with `runSync` reports its persisted status here too, but
-     * without `output` — the `runSync` call itself already returned that.
-     *
      * The optional generic `O` types the result envelope's `output`.
      * It is additive and defaults to today's untyped `any`, so existing callers
      * are unaffected. The generated per-workflow `<key>(client)` factory supplies
@@ -353,107 +278,6 @@ export interface WorkflowsAPI {
      */
     define<O = unknown>(workflowKey: string, options: WorkflowDefineOptions<O>): void;
 }
-/**
- * Prompts API, available as `client.prompts`. Executes prompts configured
- * server-side for the app, identified by prompt key.
- * @deprecated Call a server function instead: it runs the prompt with
- * `ctx.prompts.run` (see the Server Functions guide).
- */
-export interface PromptsAPI {
-    /**
-     * Execute a prompt by key and return the result.
-     *
-     * The optional generics are additive. `V` types the
-     * `variables` bag and `R` types `rawResponse`. Both default to today's
-     * untyped shapes, so existing callers are unaffected.
-     *
-     * Every prompt carries an `accessRule` deciding who may execute it. A
-     * refusal rejects with a `JsBaoApiError` whose `status` is `403` and whose
-     * `code` is `"PROMPT_ACCESS_DENIED"` — including when the prompt has no rule
-     * stored at all, which denies every caller who is not an app admin or owner.
-     * A prompt that is not in service rejects with a `400` whose `code` is
-     * `"PROMPT_NOT_EXECUTABLE"`. Availability is a single server-owned `status`:
-     * only an `active` prompt executes here, and `primitive prompts enable`
-     * puts an inactive one back in service.
-     * @deprecated Call a server function instead: it runs the prompt with
-     * `ctx.prompts.run` (see the Server Functions guide).
-     */
-    execute<V extends object = Record<string, unknown>, R = unknown>(promptKey: string, options: ExecutePromptOptions<V>): Promise<ExecutePromptResult<R>>;
-}
-/** Options for executing a prompt */
-export interface ExecutePromptOptions<V extends object = Record<string, unknown>> {
-    /** Variables to pass to the prompt template */
-    variables: V;
-    /** Override the model specified in the prompt config */
-    modelOverride?: string;
-    /** Specific config ID to use (defaults to activeConfigId) */
-    configId?: string;
-}
-/** Result from executing a prompt */
-export interface ExecutePromptResult<R = unknown> {
-    success: boolean;
-    output: string;
-    error?: string;
-    /**
-     * The upstream provider's own HTTP status, on a failure where the call
-     * reached the provider and it answered. It does not depend on which provider
-     * the prompt's configuration names, and it is what a retry decision is made
-     * on without parsing `error`: retry on 408, 429, 502, 503 and 504; any other
-     * 4xx will fail the same way next time.
-     *
-     * Absent on success, and absent on a failure where no provider answer was
-     * observed — an unset provider key, an oversized payload, a completion that
-     * came back empty — so a number here is always the provider's own.
-     */
-    upstreamStatus?: number;
-    /**
-     * `"PROMPT_UPSTREAM_TIMEOUT"` when the provider itself ran out of time;
-     * `"PROMPT_UPSTREAM_REJECTED"` when the provider refused the request as
-     * invalid (`upstreamStatus` 400) — a setting the model does not support,
-     * such as a reasoning level, with the provider's message in `error`; fix
-     * the configuration rather than retrying;
-     * `"PROMPT_STRICT_OUTPUT_SCHEMA_MISSING"` when a strict-output config's
-     * prompt has no usable `outputSchema`, refused before the provider call; and
-     * `"PROMPT_OUTPUT_TRUNCATED"` when the completion came back empty because
-     * it spent the whole output token limit (`truncated` is `true` beside it).
-     * Absent on success and on every other provider failure, so `error` with no
-     * `errorCode` still means "the call failed for some other reason".
-     */
-    errorCode?: "PROMPT_UPSTREAM_TIMEOUT" | "PROMPT_STRICT_OUTPUT_SCHEMA_MISSING" | "PROMPT_OUTPUT_TRUNCATED" | "PROMPT_UPSTREAM_REJECTED";
-    /**
-     * `true` when the provider stopped at the output token limit (the config's
-     * `maxTokens`) before the answer was finished; absent otherwise. A cut-off
-     * answer is still `success: true`, with the partial text in `output`. On
-     * Gemini, reasoning tokens count against the same limit. Raise `maxTokens`.
-     */
-    truncated?: true;
-    metrics: {
-        durationMs: number;
-        inputTokens?: number;
-        outputTokens?: number;
-        totalTokens?: number;
-        /**
-         * The reasoning/thinking tokens the provider reports for this call,
-         * separately from `outputTokens`. It is how the effect of a config's
-         * `reasoningEffort` / `reasoningBudget` is measured: OpenRouter counts
-         * reasoning INSIDE its output tokens and Gemini counts it OUTSIDE, so
-         * neither headline number says how much of the decode was deliberation.
-         * Absent when the provider reports none.
-         */
-        reasoningTokens?: number;
-        /**
-         * What this call cost, in USD, as the provider reported it.
-         *
-         * A decisions model's case is largely economic — a fraction of a chat
-         * model's cost on the same workload — so a result that reported tokens
-         * and not price would leave the number the choice turns on off the wire.
-         * Absent when the provider reports none.
-         */
-        cost?: number;
-    };
-    rawResponse: R;
-    configId: string;
-}
 /**
  * Configuration for constructing a {@link JsBaoClient} (or calling
  * {@link initializeClient}). Only `apiUrl`, `wsUrl`, and `appId` are
@@ -1177,71 +1001,6 @@ export interface WorkflowStartedEvent {
     contextDocId?: string;
     meta?: Record<string, unknown>;
 }
-/** Options for synchronously running a workflow via `workflows.runSync`. */
-export interface RunSyncWorkflowOptions {
-    /** The workflow key identifying which workflow to run. */
-    workflowKey: string;
-    /** Input data to pass to the workflow. Defaults to {} if not provided. */
-    input?: Record<string, any>;
-    /** Key to identify this run (for idempotency). Auto-generated if not provided. */
-    runKey?: string;
-    /** Document ID to associate the run with. Defaults to the user's root document. */
-    contextDocId?: string;
-    /** User-defined metadata attached to the run (max 1KB). Returned in listRuns and runSync envelope. */
-    meta?: Record<string, unknown>;
-    /**
-     * Hard wall-clock ceiling in milliseconds. Defaults to 5000. Capped
-     * server-side to 30000 (Workers CPU budget). When exceeded, the run
-     * resolves with `status: "timeout"`.
-     */
-    timeoutMs?: number;
-    /**
-     * Optional AbortSignal. When fired before the workflow completes the
-     * run resolves with `status: "terminated"`. The promise is rejected
-     * only if the transport call itself is aborted before the request is
-     * sent — completed work still resolves.
-     */
-    signal?: AbortSignal;
-}
-/**
- * Result envelope from `workflows.runSync`. All non-transport outcomes
- * resolve with this shape — promise rejection is reserved for
- * connectivity / abort-before-send errors.
- */
-export interface RunSyncWorkflowResult<O = any> {
-    runId: string;
-    runKey: string;
-    /**
-     * Status from the run.
-     * - "completed" — workflow finished without error
-     * - "failed" — engine raised an error (see `error`)
-     * - "terminated" — caller-side AbortSignal fired mid-execution
-     * - "timeout" — server-side timeout ceiling tripped
-     * - "apply_pending" — workflow needs the client-side apply step
-     *
-     * On an idempotency hit or write-race loss (`existing: true`), runSync
-     * echoes the matched run's raw persisted `WorkflowRun.status`, which can
-     * still be transient — `"queued"`, `"running"`, or `"apply_claimed"` — so
-     * this is `WorkflowRunStatus` (the model's full set) plus the runSync-only
-     * `"timeout"` value.
-     */
-    status: WorkflowRunStatus | "timeout";
-    /** Final output of the workflow, when `status === "completed"`. */
-    output?: O;
-    /** Error message when `status === "failed"`. */
-    error?: string;
-    /**
-     * Why the workflow did not run, when `status === "skipped"`: the run's
-     * declarative lock was held and the definition declared
-     * `onContention: "ignore"`. The envelope then carries neither `output` nor
-     * `error` — nothing went wrong, the work simply did not happen.
-     */
-    skipReason?: WorkflowRunSkipReason;
-    /** Persisted `WorkflowRun` row for the call (always present on success). */
-    run?: WorkflowRun;
-    /** True if the runKey matched an existing run; no new execution occurred. */
-    existing?: boolean;
-}
 /** Options for starting a workflow */
 export interface StartWorkflowOptions {
     /** The workflow key identifying which workflow to start */
@@ -1500,7 +1259,7 @@ export interface TerminateWorkflowOptions {
  *
  * The server reconciles the run's status and returns exactly one of these
  * values — the same canonical set as {@link WorkflowRunStatus}, the
- * `workflowStatus` event, `runSync`, and the persisted `run.status`. Raw
+ * `workflowStatus` event, and the persisted `run.status`. Raw
  * platform spellings never reach the client, so no client-side mapping is
  * needed: read the value as-is.
  *
@@ -2595,12 +2354,6 @@ export declare class JsBaoClient extends Observable<any> {
     /** Sub-API for the notification inbox (list, unread count, mark read, send).
      * @group Sub-APIs */
     notifications: NotificationsAPI;
-    /** Sub-API for managing third-party integrations.
-     * @group Sub-APIs
-     * @deprecated Call a server function instead: it calls the integration with
-     * `ctx.integrations.call` (see the Server Functions guide).
-     */
-    integrations: IntegrationsAPI;
     /** Sub-API for managing and executing workflows.
      * @group Sub-APIs
      * @deprecated Call a server function instead: `client.functions.invoke` for a
@@ -2608,12 +2361,6 @@ export declare class JsBaoClient extends Observable<any> {
      * Functions guide).
      */
     workflows: WorkflowsAPI;
-    /** Sub-API for managing and executing prompts.
-     * @group Sub-APIs
-     * @deprecated Call a server function instead: it runs the prompt with
-     * `ctx.prompts.run` (see the Server Functions guide).
-     */
-    prompts: PromptsAPI;
     private workflowApplyHandlers;
     private httpClient;
     private applyingTokenFromController;
@@ -2895,16 +2642,7 @@ export declare class JsBaoClient extends Observable<any> {
      *  Used by blob downloads that return raw bytes.
      *  @group Connection */
     fetchBinary(method: string, path: string): Promise<ArrayBuffer>;
-    private makeRawRequest;
-    private callIntegration;
-    private normalizeIntegrationHeaders;
-    private createIntegrationError;
     private startWorkflow;
-    /**
-     * Synchronously invoke a workflow and wait for its terminal state. See
-     * `WorkflowsAPI.runSync` for the full contract.
-     */
-    private runSyncWorkflow;
     private getWorkflowStatus;
     /**
      * Unpack a `{ status, run, slice? }` status response into a
@@ -2958,7 +2696,6 @@ export declare class JsBaoClient extends Observable<any> {
     private getWorkflowPendingApplies;
     private defineWorkflow;
     private handleWorkflowApply;
-    private executePrompt;
     /** Check if the current user has read-only access to a document.
      * @param documentId - The document to check
      * @group Documents */
@@ -4329,8 +4066,9 @@ export declare class JsBaoClient extends Observable<any> {
      * const tags = await Tag.query({});
      * ```
      *
-     * @param model - The model class to register, built with `createModelClass`
-     *   (or `defineModelSchema` plus `attachAndRegisterModel`)
+     * @param model - The model class to register: a class extending `BaseModel`
+     *   whose schema comes from `defineModelSchema`, attached with
+     *   `attachAndRegisterModel`
      * @throws If the client is destroyed, the class has no name, another class is
      *   already registered under its name, or it belongs to another live client
      * @group Documents