@protobase/client 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/auth.d.ts

@@ -0,0 +1,66 @@
+//#region src/auth.d.ts
+export type AuthUser = {
+  id: string;
+  email: string;
+  name: string;
+  role?: string | null;
+};
+/** A failed sign-in or sign-out, with Better Auth's status and code (for example `INVALID_EMAIL_OR_PASSWORD`). */
+export declare class AuthError extends Error {
+  readonly status: number;
+  readonly code?: string | undefined;
+  constructor(message: string, status: number, code?: string | undefined);
+}
+export type AuthSessionOptions = {
+  /** Origin of the server; defaults to the page's own. */
+  origin?: string;
+  /** Where Better Auth is mounted. */
+  basePath?: string;
+  fetch?: typeof fetch;
+  /** Refresh this long before the token expires. */
+  refreshMarginMs?: number;
+  /** Called when a background refresh finds the session gone. */
+  onSignedOut?: () => void;
+};
+/** The expiry of a JWT in milliseconds, read from its payload (the signature is the server's business). */
+export declare const tokenExpiry: (token: string) => number;
+/** `needsAdmin` while no user exists yet; `passwordReset` when the server can email reset links; `socialProviders` the ids of the sign-in providers, for example `github`. */
+export type SetupStatus = {
+  needsAdmin: boolean;
+  passwordReset: boolean;
+  socialProviders: string[];
+};
+/**
+ * The browser side of Better Auth: sign in with email and password, and a short-lived JWT held in memory only
+ * (never in storage), fetched with the session cookie and refreshed before it expires.
+ */
+export declare const createAuthSession: (options?: AuthSessionOptions) => {
+  token: ({ refresh }?: {
+    refresh?: boolean;
+  }) => Promise<string | undefined>;
+  /** Whether the first admin is still missing. Every server has a login, so a 404 means the URL is not a Protobase server. */
+  status: () => Promise<SetupStatus>;
+  /** The signed-in user from the session cookie, or `undefined`. */
+  session: () => Promise<AuthUser | undefined>;
+  signIn: (email: string, password: string) => Promise<AuthUser>;
+  /**
+   * Starts sign-in with a provider such as `github`: resolves with the provider's authorization URL, for the page to go to.
+   * The provider sends the browser back to `callbackURL` signed in, or with `?error=<code>`.
+   */
+  signInSocial: (provider: string, callbackURL: string) => Promise<string>;
+  signOut: () => Promise<void>;
+  /**
+   * Emails a reset link when an account has this address; the answer is the same either way. The link leads back to
+   * `redirectTo`, with `token` (or `error=INVALID_TOKEN`) added to its query.
+   */
+  requestPasswordReset: (email: string, redirectTo: string) => Promise<void>;
+  /** Sets a new password with the token from a reset link; the link works once. */
+  resetPassword: (token: string, newPassword: string) => Promise<void>;
+};
+export type AuthSession = ReturnType<typeof createAuthSession>;
+/**
+ * A session that is already signed in with a token you hold, for stories and scripts (`protobase token <email>`).
+ * It never refreshes, so use a token that outlives the run.
+ */
+export declare const createStaticSession: (token: string, user?: AuthUser) => AuthSession;
+//#endregion

package/dist/auth.js

@@ -0,0 +1,160 @@
+import { createAuthClient } from "better-auth/client";
+import { jwtClient } from "better-auth/client/plugins";
+//#region src/auth.ts
+/** A failed sign-in or sign-out, with Better Auth's status and code (for example `INVALID_EMAIL_OR_PASSWORD`). */
+var AuthError = class extends Error {
+	status;
+	code;
+	constructor(message, status, code) {
+		super(message);
+		this.status = status;
+		this.code = code;
+		this.name = "AuthError";
+	}
+};
+/** The expiry of a JWT in milliseconds, read from its payload (the signature is the server's business). */
+const tokenExpiry = (token) => {
+	const payload = token.split(".")[1];
+	if (!payload) throw new Error("Not a JWT");
+	const json = JSON.parse(atob(payload.replace(/-/g, "+").replace(/_/g, "/")));
+	if (typeof json.exp !== "number") throw new Error("The token has no expiry");
+	return json.exp * 1e3;
+};
+/**
+* The browser side of Better Auth: sign in with email and password, and a short-lived JWT held in memory only
+* (never in storage), fetched with the session cookie and refreshed before it expires.
+*/
+const createAuthSession = (options = {}) => {
+	const origin = options.origin ?? globalThis.location?.origin ?? "http://localhost";
+	const basePath = options.basePath ?? "/api/auth";
+	const margin = options.refreshMarginMs ?? 6e4;
+	const doFetch = options.fetch ?? ((input, init) => fetch(input, init));
+	const client = createAuthClient({
+		baseURL: origin,
+		basePath,
+		plugins: [jwtClient()],
+		fetchOptions: { customFetchImpl: doFetch }
+	});
+	let cached;
+	let pending;
+	let timer;
+	const forget = () => {
+		cached = void 0;
+		clearTimeout(timer);
+	};
+	const load = async () => {
+		const { data } = await client.$fetch("/token");
+		if (!data?.token) {
+			forget();
+			return;
+		}
+		cached = {
+			token: data.token,
+			expiresAt: tokenExpiry(data.token)
+		};
+		clearTimeout(timer);
+		timer = setTimeout(() => void token({ refresh: true }).then((fresh) => fresh || options.onSignedOut?.()), Math.max(1e3, cached.expiresAt - Date.now() - margin));
+		return cached.token;
+	};
+	/** The bearer token; a cached one is reused until it is within the margin of expiring. `undefined` when signed out. */
+	const token = async ({ refresh = false } = {}) => {
+		if (!refresh && cached && cached.expiresAt - Date.now() > margin) return cached.token;
+		pending ??= load().finally(() => {
+			pending = void 0;
+		});
+		return pending;
+	};
+	return {
+		token,
+		/** Whether the first admin is still missing. Every server has a login, so a 404 means the URL is not a Protobase server. */
+		status: async () => {
+			const response = await doFetch(`${origin}${basePath}/status`);
+			if (response.status === 404) throw new AuthError("This server has no sign-in. Is the API URL right?", 404);
+			if (!response.ok) throw new AuthError("Could not read the sign-in status", response.status);
+			const body = await response.json();
+			return {
+				needsAdmin: Boolean(body.needsAdmin),
+				passwordReset: Boolean(body.passwordReset),
+				socialProviders: body.socialProviders ?? []
+			};
+		},
+		/** The signed-in user from the session cookie, or `undefined`. */
+		session: async () => {
+			const { data } = await client.getSession();
+			return data?.user;
+		},
+		signIn: async (email, password) => {
+			const { data, error } = await client.signIn.email({
+				email,
+				password
+			});
+			if (error || !data) throw new AuthError(error?.message || "Sign-in failed", error?.status ?? 500, error?.code);
+			await token({ refresh: true });
+			return data.user;
+		},
+		/**
+		* Starts sign-in with a provider such as `github`: resolves with the provider's authorization URL, for the page to go to.
+		* The provider sends the browser back to `callbackURL` signed in, or with `?error=<code>`.
+		*/
+		signInSocial: async (provider, callbackURL) => {
+			const { data, error } = await client.signIn.social({
+				provider,
+				callbackURL,
+				errorCallbackURL: callbackURL,
+				disableRedirect: true
+			});
+			if (error || !data?.url) throw new AuthError(error?.message || "Sign-in failed", error?.status ?? 500, error?.code);
+			return data.url;
+		},
+		signOut: async () => {
+			forget();
+			await client.signOut();
+		},
+		/**
+		* Emails a reset link when an account has this address; the answer is the same either way. The link leads back to
+		* `redirectTo`, with `token` (or `error=INVALID_TOKEN`) added to its query.
+		*/
+		requestPasswordReset: async (email, redirectTo) => {
+			const { error } = await client.requestPasswordReset({
+				email,
+				redirectTo
+			});
+			if (error) throw new AuthError(error.message || "Could not send the reset link", error.status, error.code);
+		},
+		/** Sets a new password with the token from a reset link; the link works once. */
+		resetPassword: async (token, newPassword) => {
+			const { error } = await client.resetPassword({
+				token,
+				newPassword
+			});
+			if (error) throw new AuthError(error.message || "Could not set the password", error.status, error.code);
+		}
+	};
+};
+/**
+* A session that is already signed in with a token you hold, for stories and scripts (`protobase token <email>`).
+* It never refreshes, so use a token that outlives the run.
+*/
+const createStaticSession = (token, user = {
+	id: "token",
+	email: "token",
+	name: "API token",
+	role: null
+}) => ({
+	token: async () => token,
+	status: async () => ({
+		needsAdmin: false,
+		passwordReset: false,
+		socialProviders: []
+	}),
+	session: async () => user,
+	signIn: async () => user,
+	signInSocial: async () => {
+		throw new AuthError("A static session cannot sign in with a provider", 400);
+	},
+	signOut: async () => void 0,
+	requestPasswordReset: async () => void 0,
+	resetPassword: async () => void 0
+});
+//#endregion
+export { AuthError, createAuthSession, createStaticSession, tokenExpiry };

package/dist/client.d.ts

@@ -0,0 +1,37 @@
+import { FilterInput, ListParams } from "./query-string.js";
+import { ClientOptions } from "./transport.js";
+import { BatchOp, BatchResult, Facet, Histogram, ListPage, MetaResult, RecordOf, ResourceRef, Series, SeriesParams, Stored } from "./types.js";
+import { KeyValue } from "@protobase/schema";
+//#region src/client.d.ts
+export declare const createClient: (options?: ClientOptions) => {
+  list: <R extends ResourceRef>(resource: R, params?: ListParams) => Promise<ListPage<RecordOf<R>>>;
+  search: <R extends ResourceRef>(resource: R, params?: ListParams) => Promise<ListPage<RecordOf<R>>>;
+  get: <R extends ResourceRef>(resource: R, key: KeyValue | readonly KeyValue[]) => Promise<Stored<RecordOf<R>>>;
+  create: <R extends ResourceRef>(resource: R, body: Partial<RecordOf<R>>) => Promise<Stored<RecordOf<R>> & {
+    location: string;
+  }>;
+  update: <R extends ResourceRef>(resource: R, key: KeyValue | readonly KeyValue[], patch: Partial<RecordOf<R>>, etag: string) => Promise<Stored<RecordOf<R>>>;
+  remove: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], { etag }?: {
+    etag?: string;
+  }) => Promise<void>;
+  undelete: <R extends ResourceRef>(resource: R, key: KeyValue | readonly KeyValue[]) => Promise<Stored<RecordOf<R>>>;
+  reveal: (resource: ResourceRef, key: KeyValue | readonly KeyValue[], field: string) => Promise<unknown>;
+  batchWrite: (ops: BatchOp[]) => Promise<BatchResult>;
+  facets: (resource: ResourceRef, field: string, o?: {
+    filter?: FilterInput;
+    limit?: number;
+  }) => Promise<Facet[]>;
+  series: (resource: ResourceRef, params: SeriesParams & {
+    filter?: FilterInput;
+  }) => Promise<Series>;
+  histogram: (resource: ResourceRef, field: string, o?: {
+    filter?: FilterInput;
+    buckets?: number;
+  }) => Promise<Histogram>;
+  seek: <R extends ResourceRef>(resource: R, params: ListParams & {
+    position: number;
+  }) => Promise<ListPage<RecordOf<R>>>;
+  meta: (etag?: string) => Promise<MetaResult>;
+};
+export type Client = ReturnType<typeof createClient>;
+//#endregion

package/dist/client.js

@@ -0,0 +1,206 @@
+import { filterText, listWire, queryString } from "./query-string.js";
+import { createTransport } from "./transport.js";
+import { encodeKey } from "@protobase/schema";
+//#region src/client.ts
+const nameOf = (resource) => typeof resource === "string" ? resource : resource.toModel().name;
+const keyPath = (resource, key) => `/${nameOf(resource)}/${encodeKey(key)}`;
+const toPage = (body, response) => ({
+	items: body.items,
+	nextPageToken: body.next_page_token,
+	totalSizeEstimate: body.total_size_estimate,
+	...body.prev_page_token !== void 0 && { prevPageToken: body.prev_page_token },
+	...body.total_size !== void 0 && { totalSize: body.total_size },
+	...response.headers.get("x-protobase-warning") && { warning: response.headers.get("x-protobase-warning") }
+});
+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) => {
+	const { permissions, ...record } = await response.json();
+	return {
+		record,
+		etag: etagOf(response),
+		...permissions && { permissions }
+	};
+};
+const createClient = (options = {}) => {
+	const send = createTransport(options);
+	const list = async (resource, params) => {
+		const response = await send({
+			method: "GET",
+			path: `/${nameOf(resource)}`,
+			query: queryString(listWire(params))
+		});
+		return toPage(await response.json(), response);
+	};
+	/** Same as `list`, with the parameters in a JSON body, for long filters. */
+	const search = async (resource, params) => {
+		const wire = listWire(params);
+		const response = await send({
+			method: "POST",
+			path: `/${nameOf(resource)}:search`,
+			body: {
+				...wire,
+				fields: params?.fields
+			}
+		});
+		return toPage(await response.json(), response);
+	};
+	const get = async (resource, key) => {
+		return storedOf(await send({
+			method: "GET",
+			path: keyPath(resource, key)
+		}));
+	};
+	const create = async (resource, body) => {
+		const response = await send({
+			method: "POST",
+			path: `/${nameOf(resource)}`,
+			body
+		});
+		return {
+			record: await response.json(),
+			etag: etagOf(response),
+			location: response.headers.get("location") ?? ""
+		};
+	};
+	/** `etag` is what `get` returned; a stale one rejects with `PreconditionFailedError`. */
+	const update = async (resource, key, patch, etag) => {
+		return storedOf(await send({
+			method: "PATCH",
+			path: keyPath(resource, key),
+			body: patch,
+			headers: { "if-match": etag }
+		}));
+	};
+	/** `etag` is the version the user saw (`*` for any); a stale one rejects with `PreconditionFailedError`. */
+	const remove = async (resource, key, { etag } = {}) => {
+		await send({
+			method: "DELETE",
+			path: keyPath(resource, key),
+			headers: etag ? { "if-match": etag } : void 0
+		});
+	};
+	/** AIP-164: brings a soft-deleted record back. A record that is not deleted answers 409. */
+	const undelete = async (resource, key) => {
+		const response = await send({
+			method: "POST",
+			path: `${keyPath(resource, key)}:undelete`
+		});
+		return {
+			record: await response.json(),
+			etag: etagOf(response)
+		};
+	};
+	/** The value of a sensitive field of one record, which the record itself never carries. The server audits every call. */
+	const reveal = async (resource, key, field) => {
+		return (await (await send({
+			method: "POST",
+			path: `${keyPath(resource, key)}:reveal`,
+			body: { field }
+		})).json()).value;
+	};
+	/** 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);
+		const wireOps = ops.map((operation) => ({
+			...operation,
+			resource: nameOf(operation.resource),
+			..."key" in operation && { key: keyText(operation.key) },
+			...operation.op === "reorder" && { keys: operation.keys.map(keyText) }
+		}));
+		return { results: (await (await send({
+			method: "POST",
+			path: ":batchWrite",
+			body: { ops: wireOps }
+		})).json()).results ?? [] };
+	};
+	const facets = async (resource, field, o = {}) => {
+		return (await (await send({
+			method: "GET",
+			path: `/${nameOf(resource)}:facets`,
+			query: queryString({
+				field,
+				filter: filterText(o.filter) || void 0,
+				limit: o.limit
+			})
+		})).json()).facets;
+	};
+	const series = async (resource, params) => {
+		const body = await (await send({
+			method: "GET",
+			path: `/${nameOf(resource)}:series`,
+			query: queryString({
+				field: params.field,
+				range: params.range,
+				from: params.from,
+				to: params.to,
+				granularity: params.granularity,
+				time_zone: params.timeZone,
+				filter: filterText(params.filter) || void 0
+			})
+		})).json();
+		return {
+			field: body.field,
+			granularity: body.granularity,
+			timeZone: body.time_zone,
+			points: body.points
+		};
+	};
+	const histogram = async (resource, field, o = {}) => {
+		return (await send({
+			method: "GET",
+			path: `/${nameOf(resource)}:histogram`,
+			query: queryString({
+				field,
+				buckets: o.buckets,
+				filter: filterText(o.filter) || void 0
+			})
+		})).json();
+	};
+	/** The page that starts at row `position` of a sort (scrollbar jumps), with the tokens of its own neighbours. Past the end it is empty. */
+	const seek = async (resource, params) => {
+		const response = await send({
+			method: "GET",
+			path: `/${nameOf(resource)}:seek`,
+			query: queryString({
+				...listWire(params),
+				position: params.position
+			})
+		});
+		return toPage(await response.json(), response);
+	};
+	/** Pass the `etag` of the last result to get `{ status: 'unchanged' }` on a `304`. */
+	const meta = async (etag) => {
+		const response = await send({
+			method: "GET",
+			path: "/meta",
+			system: true,
+			headers: etag ? { "if-none-match": etag } : void 0,
+			accept: [304]
+		});
+		if (response.status === 304) return { status: "unchanged" };
+		return {
+			status: "modified",
+			meta: await response.json(),
+			etag: etagOf(response)
+		};
+	};
+	return {
+		list,
+		search,
+		get,
+		create,
+		update,
+		remove,
+		undelete,
+		reveal,
+		batchWrite,
+		facets,
+		series,
+		histogram,
+		seek,
+		meta
+	};
+};
+//#endregion
+export { createClient };

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { FilterInput, ListParams, filterText, listWire } from "./query-string.js";
+import { ClientOptions } from "./transport.js";
+import { BatchOp, BatchRef, BatchResult, Facet, Histogram, HistogramBucket, ListPage, Meta, MetaResult, RecordOf, RecordPermissions, ResourcePermissions, ResourceRef, Series, SeriesParams, SeriesPoint, Stored } from "./types.js";
+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";
+export { ApiError, 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, createAuthSession, createClient, createStaticSession, filterText, isApiError, listWire, tokenExpiry };

package/dist/index.js

@@ -0,0 +1,5 @@
+import { filterText, listWire } from "./query-string.js";
+import { ApiError, PreconditionFailedError, isApiError } from "./problem.js";
+import { createClient } from "./client.js";
+import { AuthError, createAuthSession, createStaticSession, tokenExpiry } from "./auth.js";
+export { ApiError, AuthError, PreconditionFailedError, createAuthSession, createClient, createStaticSession, filterText, isApiError, listWire, tokenExpiry };

package/dist/problem.d.ts

@@ -0,0 +1,45 @@
+//#region src/problem.d.ts
+export type ProblemError = {
+  code?: string;
+  message: string;
+  hint?: string;
+  span?: {
+    start: number;
+    end: number;
+  };
+  field?: string;
+  parameter?: string;
+  /** The index of the operation in a batch that this error belongs to. */
+  operation?: number;
+};
+export type ProblemDetails = {
+  type: string;
+  title: string;
+  status: number;
+  detail?: string;
+  instance?: string;
+  /** The query parameter a filter or `order_by` error refers to. */
+  parameter?: string;
+  errors?: ProblemError[];
+  /** The index of the operation that failed, when the request was a batch. */
+  operation?: number;
+};
+/** A non-2xx response, parsed from `application/problem+json`. */
+export declare class ApiError extends Error {
+  readonly problem: ProblemDetails;
+  constructor(problem: ProblemDetails);
+  get status(): number;
+  /** The problem slug, for example `invalid-filter` or `precondition-failed`. */
+  get slug(): string;
+  /** For a batch: the index of the operation that failed, so the UI can name it. */
+  get operation(): number | undefined;
+  get errors(): ProblemError[];
+  /** Filter errors carry the span of the offending text, so the UI can underline it. */
+  get filterErrors(): ProblemError[];
+}
+/** `412`: the record changed since it was read. */
+export declare class PreconditionFailedError extends ApiError {
+  constructor(problem: ProblemDetails);
+}
+export declare const isApiError: (error: unknown) => error is ApiError;
+//#endregion

package/dist/problem.js

@@ -0,0 +1,49 @@
+//#region src/problem.ts
+/** A non-2xx response, parsed from `application/problem+json`. */
+var ApiError = class extends Error {
+	problem;
+	constructor(problem) {
+		super(problem.detail ?? problem.title);
+		this.problem = problem;
+		this.name = "ApiError";
+	}
+	get status() {
+		return this.problem.status;
+	}
+	/** The problem slug, for example `invalid-filter` or `precondition-failed`. */
+	get slug() {
+		return this.problem.type.split(":").at(-1) ?? "";
+	}
+	/** For a batch: the index of the operation that failed, so the UI can name it. */
+	get operation() {
+		return this.problem.operation ?? this.errors.find((entry) => entry.operation !== void 0)?.operation;
+	}
+	get errors() {
+		return this.problem.errors ?? [];
+	}
+	/** Filter errors carry the span of the offending text, so the UI can underline it. */
+	get filterErrors() {
+		return this.slug === "invalid-filter" ? this.errors : [];
+	}
+};
+/** `412`: the record changed since it was read. */
+var PreconditionFailedError = class extends ApiError {
+	constructor(problem) {
+		super(problem);
+		this.name = "PreconditionFailedError";
+	}
+};
+const isApiError = (error) => error instanceof ApiError;
+const isProblem = (body) => typeof body === "object" && body !== null && "type" in body && "status" in body;
+/** Turns a failed response into a typed error; bodies that are not problem+json become a generic problem. */
+const readProblem = async (response) => {
+	const body = response.headers.get("content-type")?.includes("json") ?? false ? await response.json() : void 0;
+	const problem = isProblem(body) ? body : {
+		type: "urn:protobase:problem:unknown",
+		title: response.statusText || "Request failed",
+		status: response.status
+	};
+	return problem.status === 412 ? new PreconditionFailedError(problem) : new ApiError(problem);
+};
+//#endregion
+export { ApiError, PreconditionFailedError, isApiError, readProblem };

package/dist/query-string.d.ts

@@ -0,0 +1,23 @@
+import { FilterExpr } from "@protobase/schema";
+//#region src/query-string.d.ts
+export type FilterInput = string | FilterExpr;
+export type ListParams = {
+  filter?: FilterInput;
+  /** AIP-132 text, for example `createdAt desc`. */
+  orderBy?: string;
+  pageSize?: number;
+  pageToken?: string;
+  fields?: string[];
+  count?: 'exact';
+};
+export declare const filterText: (filter: FilterInput | undefined) => string | undefined;
+/** The snake_case parameters of `GET /{resource}` and the body of `POST /{resource}:search`. */
+export declare const listWire: (params?: ListParams) => {
+  filter: string | undefined;
+  order_by: string | undefined;
+  page_size: number | undefined;
+  page_token: string | undefined;
+  fields: string | undefined;
+  count: "exact" | undefined;
+};
+//#endregion

package/dist/query-string.js

@@ -0,0 +1,20 @@
+import { printFilter } from "@protobase/schema";
+//#region src/query-string.ts
+const filterText = (filter) => typeof filter === "string" ? filter : filter && printFilter(filter);
+/** The snake_case parameters of `GET /{resource}` and the body of `POST /{resource}:search`. */
+const listWire = (params = {}) => ({
+	filter: filterText(params.filter) || void 0,
+	order_by: params.orderBy,
+	page_size: params.pageSize,
+	page_token: params.pageToken || void 0,
+	fields: params.fields?.join(","),
+	count: params.count
+});
+const queryString = (wire) => {
+	const search = new URLSearchParams();
+	for (const [name, value] of Object.entries(wire)) if (value !== void 0) search.set(name, String(value));
+	const text = search.toString();
+	return text ? `?${text}` : "";
+};
+//#endregion
+export { filterText, listWire, queryString };

package/dist/transport.d.ts

@@ -0,0 +1,19 @@
+//#region src/transport.d.ts
+export type ClientOptions = {
+  /** Where `/api/v1` lives, without a trailing slash. Defaults to `/api/v1` on the current origin. */
+  baseUrl?: string;
+  fetch?: typeof fetch;
+  headers?: () => Record<string, string>;
+  /** Called with the `X-Meta-Version` of every response; a change means `/meta` should be refetched. */
+  onMetaVersion?: (version: string) => void;
+  /**
+   * The bearer token for a request. Called with `refresh: true` when the server answered 401, so the
+   * caller can fetch a new one; the request is then retried once.
+   */
+  token?: (options: {
+    refresh: boolean;
+  }) => Promise<string | undefined>;
+  /** Called when a request is still 401 after the retry: the session is over. */
+  onUnauthenticated?: () => void;
+};
+//#endregion

package/dist/transport.js

@@ -0,0 +1,33 @@
+import { readProblem } from "./problem.js";
+//#region src/transport.ts
+const createTransport = (options = {}) => {
+	const baseUrl = options.baseUrl ?? "/api/v1";
+	const systemUrl = baseUrl.replace(/\/[^/]*$/, "");
+	const doFetch = options.fetch ?? ((input, init) => fetch(input, init));
+	return async ({ method, path, query = "", body, headers, accept = [], system }) => {
+		const attempt = async (refresh) => {
+			const token = await options.token?.({ refresh });
+			return doFetch(`${system ? systemUrl : baseUrl}${path}${query}`, {
+				method,
+				headers: {
+					...body !== void 0 && { "content-type": "application/json" },
+					...token && { authorization: `Bearer ${token}` },
+					...options.headers?.(),
+					...headers
+				},
+				body: body === void 0 ? void 0 : JSON.stringify(body)
+			});
+		};
+		let response = await attempt(false);
+		if (response.status === 401 && options.token) {
+			response = await attempt(true);
+			if (response.status === 401) options.onUnauthenticated?.();
+		}
+		const metaVersion = response.headers.get("x-meta-version");
+		if (metaVersion) options.onMetaVersion?.(metaVersion);
+		if (!response.ok && !accept.includes(response.status)) throw await readProblem(response);
+		return response;
+	};
+};
+//#endregion
+export { createTransport };

package/dist/types.d.ts

@@ -0,0 +1,152 @@
+import { InferRecord, ResourceModel, UserMenuModel, ViewModel } from "@protobase/schema";
+import { PageModel } from "@protobase/layout";
+//#region src/types.d.ts
+/** A resource by name, or the builder from `resource(...)`, which carries its record type. */
+export type ResourceRef = string | {
+  readonly $fields: unknown;
+  toModel(): ResourceModel;
+};
+/** Records as they travel: dates are ISO text, 64-bit integers and decimals are strings. */
+export type RecordOf<R extends ResourceRef> = R extends {
+  readonly $fields: unknown;
+} ? InferRecord<R> : Record<string, unknown>;
+export type ListPage<T> = {
+  items: T[];
+  /** `""` on the last page. */
+  nextPageToken: string;
+  /** Only from `seek`; `""` on the first page. */
+  prevPageToken?: string;
+  totalSizeEstimate: number;
+  /** Only with `count: 'exact'`. */
+  totalSize?: number;
+  /** `X-Protobase-Warning`, for example a scan-guard notice. */
+  warning?: string;
+};
+export type Facet = {
+  value: string | number | boolean | null;
+  count: number;
+};
+export type SeriesPoint = {
+  bucket: string;
+  count: number;
+};
+export type Series = {
+  field: string;
+  granularity: string;
+  timeZone: string;
+  points: SeriesPoint[];
+};
+export type SeriesParams = {
+  field: string;
+  range?: '7d' | '30d' | '90d' | '1y' | 'all';
+  from?: string;
+  to?: string;
+  granularity?: 'hour' | 'day' | 'week' | 'month';
+  timeZone?: string;
+};
+export type HistogramBucket = {
+  from: number;
+  to: number;
+  count: number;
+};
+export type Histogram = {
+  min: number | null;
+  max: number | null;
+  buckets: HistogramBucket[];
+};
+/** What the signed-in user may do with a resource; `conditional` operations are decided per record by the server. */
+export type ResourcePermissions = {
+  read?: boolean;
+  create: boolean;
+  update: boolean;
+  delete: boolean;
+  conditional: Array<'create' | 'update' | 'delete'>;
+};
+export type Meta = {
+  resources: ResourceModel[];
+  views: ViewModel[];
+  pages?: PageModel[];
+  permissions?: Record<string, ResourcePermissions>;
+  userMenu?: UserMenuModel;
+};
+export type MetaResult = {
+  status: 'modified';
+  meta: Meta;
+  etag: string;
+} | {
+  status: 'unchanged';
+};
+/** What the caller may do with one record; `fields` maps each readable field to `edit` or `read`, hidden ones are absent. */
+export type RecordPermissions = {
+  update: boolean;
+  delete: boolean;
+  fields?: Record<string, 'edit' | 'read'>;
+};
+export type Stored<T> = {
+  record: T;
+  etag: string;
+  permissions?: RecordPermissions;
+};
+/** A reference to a record created earlier in the same batch (`ref` on its `create`). */
+export type BatchRef = {
+  $ref: string;
+  field?: string;
+};
+type Key = string | number | readonly (string | number)[] | BatchRef;
+/**
+ * One operation of `POST /api/v1:batchWrite`. The batch runs in a single transaction: either every operation is
+ * applied or none is, and a failure names the operation that caused it.
+ */
+export type BatchOp = {
+  op: 'create';
+  resource: ResourceRef;
+  data: Record<string, unknown>;
+  ref?: string;
+} | {
+  op: 'update';
+  resource: ResourceRef;
+  key: Key;
+  data: Record<string, unknown>;
+  etag?: string;
+} | {
+  op: 'delete';
+  resource: ResourceRef;
+  key: Key;
+  etag?: string;
+} |
+/** Renumbers `field` of the records so they sort in the order of `keys`; `etags` maps each key (as URL text) to its ETag. */
+{
+  op: 'reorder';
+  resource: ResourceRef;
+  field: string;
+  keys: Key[];
+  etags?: Record<string, string>;
+};
+/** One entry per operation, in order. A `reorder` lists every key in its final order with its new ETag. */
+export type BatchOpResult = {
+  op: 'create';
+  resource: string;
+  ref?: string;
+  record: Record<string, unknown>;
+  etag: string;
+} | {
+  op: 'update';
+  resource: string;
+  record: Record<string, unknown>;
+  etag: string;
+} | {
+  op: 'delete';
+  resource: string;
+  deleted: true;
+} | {
+  op: 'reorder';
+  resource: string;
+  records: Array<{
+    record: Record<string, unknown>;
+    etag: string;
+  }>;
+};
+export type BatchResult = {
+  results: BatchOpResult[];
+};
+//#endregion

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@protobase/client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "Typed fetch client for the Protobase REST API.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PrototeamHQ/protobase.git",
+    "directory": "packages/client"
+  },
+  "homepage": "https://docs.protobase.net",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "better-auth": "^1.7.7",
+    "@protobase/layout": "0.1.1",
+    "@protobase/schema": "0.1.1"
+  },
+  "scripts": {
+    "build": "tsdown"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.