@protobase/client 0.21.7 → 0.21.8

package/dist/client.d.ts

@@ -1,7 +1,7 @@
 import { FilterInput, ListParams, MapParams } from "./query-string.js";
 import { ClientOptions } from "./transport.js";
 import { UploadProgress } from "./upload-request.js";
-import { Aggregate, AggregateParams, BatchOp, BatchResult, Facet, FormChallenge, FormProof, Histogram, HistoryPage, ListPage, MapResult, MetaResult, PublicForm, RecordOf, ResourceRef, Series, SeriesParams, Stored } from "./types.js";
+import { Aggregate, AggregateParams, BatchOp, BatchResult, CommentPage, Facet, FormChallenge, FormProof, Histogram, HistoryPage, ListPage, MapResult, MentionableUser, MetaResult, PublicForm, RecordComment, RecordOf, ResourceRef, Series, SeriesParams, Stored } from "./types.js";
 import { KeyValue } from "@protobase/schema";
 //#region src/client.d.ts
 /** How `invoke` calls a function: GET without a body, POST with one, unless `method` says otherwise. */
@@ -52,11 +52,21 @@ export declare const createClient: (options?: ClientOptions) => {
     etag?: string;
   }) => Promise<void>;
   undelete: <R extends ResourceRef>(resource: R, key: KeyValue | readonly KeyValue[]) => Promise<Stored<RecordOf<R>>>;
+  generate: <R extends ResourceRef>(resource: R, key: KeyValue | readonly KeyValue[], action: string) => Promise<Stored<RecordOf<R>>>;
   reveal: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], field: string) => Promise<unknown>;
   history: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], { pageSize, pageToken }?: {
     pageSize?: number;
     pageToken?: string;
   }) => Promise<HistoryPage>;
+  comments: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], { pageSize, pageToken }?: {
+    pageSize?: number;
+    pageToken?: string;
+  }) => Promise<CommentPage>;
+  comment: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], { body, mentions }: {
+    body: string;
+    mentions?: string[];
+  }) => Promise<RecordComment>;
+  mentionable: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], query: string) => Promise<MentionableUser[]>;
   batchWrite: (ops: BatchOp[]) => Promise<BatchResult>;
   facets: (resource: ResourceRef, field: string, o?: {
     filter?: FilterInput;

package/dist/client.js

@@ -16,6 +16,10 @@ const toPage = (body, response, origin) => ({
 	...body.photos !== void 0 && { photos: photosWithOrigin(body.photos, origin) },
 	...response.headers.get("x-protobase-warning") && { warning: response.headers.get("x-protobase-warning") }
 });
+const commentOf = ({ created_at, ...comment }) => ({
+	...comment,
+	createdAt: created_at
+});
 const etagOf = (response) => response.headers.get("etag") ?? "";
 /** A single-record response: the record without its `permissions` member, which travels beside it. */
 const storedOf = async (response, origin) => {
@@ -123,6 +127,15 @@ const createClient = (options = {}) => {
 			body: { field }
 		})).json()).value;
 	};
+	/**
+	* Runs the record's AI action `action` (`a.ai`): the model writes the action's field from its prompt, as the caller.
+	* Resolves to the record as written; a record changed while the model answered rejects with `PreconditionFailedError`.
+	*/
+	const generate = async (resource, key, action) => storedOf(await send({
+		method: "POST",
+		path: `${keyPath(resource, key)}:generate`,
+		body: { action }
+	}), origin);
 	/** A page of a record's changes, newest first, for a resource with `.history()`; `pageToken` is the previous page's `nextPageToken`. */
 	const history = async (resource, key, { pageSize, pageToken } = {}) => {
 		const query = queryString({
@@ -142,6 +155,39 @@ const createClient = (options = {}) => {
 			nextPageToken: body.next_page_token
 		};
 	};
+	/** A page of a record's comments, newest first, for a resource with `.comments()`; `pageToken` is the previous page's `nextPageToken`. */
+	const comments = async (resource, key, { pageSize, pageToken } = {}) => {
+		const query = queryString({
+			page_size: pageSize,
+			page_token: pageToken || void 0
+		});
+		const body = await (await send({
+			method: "GET",
+			path: `${keyPath(resource, key)}:comments`,
+			query
+		})).json();
+		return {
+			items: body.items.map(commentOf),
+			nextPageToken: body.next_page_token
+		};
+	};
+	/** Adds the caller's comment to a record, mentioning the users `mentions` names, who are emailed a link to it. */
+	const comment = async (resource, key, { body, mentions = [] }) => commentOf(await (await send({
+		method: "POST",
+		path: `${keyPath(resource, key)}:comments`,
+		body: {
+			body,
+			mentions
+		}
+	})).json());
+	/** The users a comment on a record may mention whose name contains `query`, at most 8, by name. */
+	const mentionable = async (resource, key, query) => {
+		return (await (await send({
+			method: "GET",
+			path: `${keyPath(resource, key)}:mentionable`,
+			query: queryString({ q: query })
+		})).json()).items;
+	};
 	/** Applies several writes atomically (`POST /api/v1:batchWrite`), for example a record and its lines on Save. */
 	const batchWrite = async (ops) => {
 		const keyText = (key) => typeof key === "object" && key !== null && "$ref" in key ? key : encodeKey(key);
@@ -359,8 +405,12 @@ const createClient = (options = {}) => {
 		update,
 		remove,
 		undelete,
+		generate,
 		reveal,
 		history,
+		comments,
+		comment,
+		mentionable,
 		batchWrite,
 		facets,
 		aggregate,

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { FilterInput, ListParams, MapParams, filterText, listWire } from "./query-string.js";
 import { ClientOptions } from "./transport.js";
 import { UploadProgress } from "./upload-request.js";
-import { Aggregate, AggregateGroup, AggregateParams, BatchOp, BatchRef, BatchResult, Facet, FormChallenge, FormProof, Histogram, HistogramBucket, HistoryChange, HistoryPage, ListPage, MapBounds, MapBucket, MapLayerModel, MapResult, Meta, MetaResult, PluginRef, PublicForm, RecordOf, RecordPermissions, RecordPhotos, RelatedLabels, ResourcePermissions, ResourceRef, Series, SeriesParams, SeriesPoint, SourceRef, Stored, StoredFile, StoredFileVariant } from "./types.js";
+import { Aggregate, AggregateGroup, AggregateParams, BatchOp, BatchRef, BatchResult, CommentPage, CommentPerson, Facet, FormChallenge, FormProof, Histogram, HistogramBucket, HistoryChange, HistoryPage, ListPage, MapBounds, MapBucket, MapLayerModel, MapResult, MentionableUser, Meta, MetaResult, PluginRef, PublicForm, RecordComment, RecordOf, RecordPermissions, RecordPhotos, RelatedLabels, ResourcePermissions, ResourceRef, Series, SeriesParams, SeriesPoint, SourceRef, Stored, StoredFile, StoredFileVariant } from "./types.js";
 import { Client, InvokeOptions, UploadOptions, UploadResult, createClient } from "./client.js";
 import { ApiError, PreconditionFailedError, ProblemDetails, ProblemError, isApiError } from "./problem.js";
 import { fileUrl } from "./file-urls.js";
@@ -18,4 +18,4 @@ import { AuthSession, AuthSessionOptions, createAuthSession, tokenExpiry } from
 import { createStaticSession } from "./static-session.js";
 import { AssistantClient, AssistantClientOptions, AssistantConnection, createAssistantClient } from "./assistant.js";
 import { RuntimeClient, RuntimeClientOptions, RuntimeLastUpdate, RuntimePolicy, RuntimeStatus, RuntimeUpdateStage, createRuntimeClient } from "./runtime.js";
-export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, ApiError, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type BatchOp, type BatchRef, type BatchResult, type Client, type ClientOptions, type CurrentOrganization, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type Meta, type MetaResult, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationRole, type OrganizationsClient, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type ProblemDetails, type ProblemError, type PublicForm, type RecordOf, type RecordPermissions, type RecordPhotos, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimeLastUpdate, type RuntimePolicy, type RuntimeStatus, type RuntimeUpdateStage, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type SignInMethod, type SignInPolicy, type SignInPolicyClient, type SignInPolicyState, type SignInResult, type SignInRule, type SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };
+export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, ApiError, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type BatchOp, type BatchRef, type BatchResult, type Client, type ClientOptions, type CommentPage, type CommentPerson, type CurrentOrganization, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type MentionableUser, type Meta, type MetaResult, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationRole, type OrganizationsClient, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type ProblemDetails, type ProblemError, type PublicForm, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimeLastUpdate, type RuntimePolicy, type RuntimeStatus, type RuntimeUpdateStage, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type SignInMethod, type SignInPolicy, type SignInPolicyClient, type SignInPolicyState, type SignInResult, type SignInRule, type SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };

package/dist/routed-client.js

@@ -16,8 +16,12 @@ const routedClient = (own, sourceOf) => {
 		update: (resource, key, patch, etag) => to(resource).update(resource, key, patch, etag),
 		remove: (resource, key, options) => to(resource).remove(resource, key, options),
 		undelete: (resource, key) => to(resource).undelete(resource, key),
+		generate: (resource, key, action) => to(resource).generate(resource, key, action),
 		reveal: (resource, key, field) => to(resource).reveal(resource, key, field),
 		history: (resource, key, options) => to(resource).history(resource, key, options),
+		comments: (resource, key, options) => to(resource).comments(resource, key, options),
+		comment: (resource, key, input) => to(resource).comment(resource, key, input),
+		mentionable: (resource, key, query) => to(resource).mentionable(resource, key, query),
 		batchWrite: (ops) => {
 			const apis = [...new Set(ops.map((op) => to(op.resource)))];
 			if (apis.length > 1) return Promise.reject(/* @__PURE__ */ new Error(`A batch writes to one API, but these writes are for ${[...new Set(ops.map((op) => nameOf(op.resource)))].join(", ")}, which different APIs serve`));

package/dist/types.d.ts

@@ -71,6 +71,33 @@ export type FormProof = {
     derivedKey: string;
   };
 };
+/** Someone a comment names: its author or a person it mentions, with their name when the server knows it. */
+export type CommentPerson = {
+  id: string;
+  name?: string;
+};
+/** One comment on a record, as `comments` reads it. */
+export type RecordComment = {
+  id: string;
+  /** When it was written, ISO 8601. */
+  createdAt: string;
+  /** Plain text, as written. */
+  body: string;
+  author: CommentPerson;
+  /** The users it mentions, each once. */
+  mentions: CommentPerson[];
+};
+/** A page of a record's comments, newest first. */
+export type CommentPage = {
+  items: RecordComment[];
+  /** `""` on the last page. */
+  nextPageToken: string;
+};
+/** Someone a comment on a record may mention: a user who may read the record. */
+export type MentionableUser = {
+  id: string;
+  name: string;
+};
 /** A page of a record's history, newest first. */
 export type HistoryPage = {
   items: HistoryChange[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/client",
-  "version": "0.21.7",
+  "version": "0.21.8",
   "description": "Typed fetch client for the Protobase REST API.",
   "license": "Apache-2.0",
   "repository": {
@@ -30,8 +30,8 @@
   },
   "dependencies": {
     "@better-auth/passkey": "^1.7.7",
-    "@protobase/layout": "0.21.7",
-    "@protobase/schema": "0.21.7",
+    "@protobase/layout": "0.21.8",
+    "@protobase/schema": "0.21.8",
     "@simplewebauthn/browser": "^13.3.0",
     "better-auth": "^1.7.7"
   }