@protobase/client 0.3.3 → 0.3.5

package/dist/index.d.ts

@@ -5,4 +5,5 @@ import { Client, createClient } from "./client.js";
 import { ApiError, PreconditionFailedError, ProblemDetails, ProblemError, isApiError } from "./problem.js";
 import { AuthError, AuthSession, AuthSessionOptions, AuthUser, SetupStatus, createAuthSession, createStaticSession, tokenExpiry } from "./auth.js";
 import { AssistantClient, AssistantClientOptions, AssistantConnection, createAssistantClient } from "./assistant.js";
-export { ApiError, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type BatchOp, type BatchRef, type BatchResult, type Client, type ClientOptions, type Facet, type FilterInput, type Histogram, type HistogramBucket, type ListPage, type ListParams, type Meta, type MetaResult, PreconditionFailedError, type ProblemDetails, type ProblemError, type RecordOf, type RecordPermissions, type ResourcePermissions, type ResourceRef, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type Stored, createAssistantClient, createAuthSession, createClient, createStaticSession, filterText, isApiError, listWire, tokenExpiry };
+import { RuntimeClient, RuntimeClientOptions, RuntimePolicy, RuntimeStatus, createRuntimeClient } from "./runtime.js";
+export { ApiError, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type BatchOp, type BatchRef, type BatchResult, type Client, type ClientOptions, type Facet, type FilterInput, type Histogram, type HistogramBucket, type ListPage, type ListParams, type Meta, type MetaResult, PreconditionFailedError, type ProblemDetails, type ProblemError, type RecordOf, type RecordPermissions, type ResourcePermissions, type ResourceRef, type RuntimeClient, type RuntimeClientOptions, type RuntimePolicy, type RuntimeStatus, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type Stored, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, filterText, isApiError, listWire, tokenExpiry };

package/dist/index.js

@@ -3,4 +3,5 @@ import { ApiError, PreconditionFailedError, isApiError } from "./problem.js";
 import { createClient } from "./client.js";
 import { AuthError, createAuthSession, createStaticSession, tokenExpiry } from "./auth.js";
 import { createAssistantClient } from "./assistant.js";
-export { ApiError, AuthError, PreconditionFailedError, createAssistantClient, createAuthSession, createClient, createStaticSession, filterText, isApiError, listWire, tokenExpiry };
+import { createRuntimeClient } from "./runtime.js";
+export { ApiError, AuthError, PreconditionFailedError, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, filterText, isApiError, listWire, tokenExpiry };

package/dist/runtime.d.ts

@@ -0,0 +1,32 @@
+//#region src/runtime.d.ts
+export type RuntimePolicy = 'immediate' | 'weekly' | 'scheduled' | 'manual';
+/**
+ * What the runtime endpoint answers: the app's pinned `version`, the `latest` release, whether to show that an update
+ * is available (`indicator`), when the `policy` applies `latest` (`nextUpdateAt`, null when it never will or nothing
+ * is pending) and whether an update is running.
+ */
+export type RuntimeStatus = {
+  version: string;
+  latest: string;
+  updateAvailable: boolean;
+  indicator: boolean;
+  policy: RuntimePolicy;
+  nextUpdateAt: string | null;
+  updating: boolean;
+};
+export type RuntimeClientOptions = {
+  /** The runtime endpoint, as `/api/meta` names it. */
+  url: string;
+  /** The signed-in user's API token, sent as the bearer token of every request. */
+  token: () => string | undefined | Promise<string | undefined>;
+  fetch?: typeof fetch;
+};
+export type RuntimeClient = {
+  /** `GET {url}`. Rejects with `ApiError`. */
+  status: () => Promise<RuntimeStatus>;
+  /** `POST {url}/update`: applies the latest version now. Rejects with `ApiError`, status 409 when already on it or an update is running. */
+  update: () => Promise<RuntimeStatus>;
+};
+/** A client of the runtime endpoint, with the user's token. */
+export declare const createRuntimeClient: (options: RuntimeClientOptions) => RuntimeClient;
+//#endregion

package/dist/runtime.js

@@ -0,0 +1,25 @@
+import { readProblem } from "./problem.js";
+//#region src/runtime.ts
+/** A client of the runtime endpoint, with the user's token. */
+const createRuntimeClient = (options) => {
+	const base = options.url.replace(/\/+$/, "");
+	const doFetch = options.fetch ?? ((input, init) => fetch(input, init));
+	const request = async (path, method) => {
+		const token = await options.token();
+		const response = await doFetch(`${base}${path}`, {
+			method,
+			headers: {
+				accept: "application/json",
+				...token && { authorization: `Bearer ${token}` }
+			}
+		});
+		if (!response.ok) throw await readProblem(response);
+		return await response.json();
+	};
+	return {
+		status: () => request("", "GET"),
+		update: () => request("/update", "POST")
+	};
+};
+//#endregion
+export { createRuntimeClient };

package/dist/types.d.ts

@@ -62,7 +62,10 @@ export type ResourcePermissions = {
   delete: boolean;
   conditional: Array<'create' | 'update' | 'delete'>;
 };
-/** `assistant`: the assistant backend, for a caller with the `admin` or `ai` role when the app has one. */
+/**
+ * `assistant`: the assistant backend, for a caller with the `admin` or `ai` role when the app has one.
+ * `runtime`: the runtime updates endpoint, for a caller with the `admin` role when the app has one.
+ */
 export type Meta = {
   resources: ResourceModel[];
   views: ViewModel[];
@@ -72,6 +75,9 @@ export type Meta = {
   assistant?: {
     url: string;
   };
+  runtime?: {
+    url: string;
+  };
 };
 export type MetaResult = {
   status: 'modified';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/client",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Typed fetch client for the Protobase REST API.",
   "license": "Apache-2.0",
   "repository": {
@@ -21,15 +21,16 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown"
+  },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "better-auth": "^1.7.7",
-    "@protobase/layout": "0.3.3",
-    "@protobase/schema": "0.3.3"
-  },
-  "scripts": {
-    "build": "tsdown"
+    "@protobase/layout": "0.3.5",
+    "@protobase/schema": "0.3.5",
+    "better-auth": "^1.7.7"
   }
-}
+}