@protobase/server 0.3.3 → 0.3.5

package/dist/assistant/assistant-settings.js

@@ -13,6 +13,7 @@ const openRouterModel = "openrouter/auto";
 /** The roles that see the assistant: `/meta` names it, and the built-in one answers, only for a caller with one of them. */
 const assistantRoles = ["admin", "ai"];
 const seesAssistant = (roles) => assistantRoles.some((role) => roles.includes(role));
+/** `url` without a trailing slash; anything but an http(s) URL stops the server, naming `source`. */
 const checkedUrl = (url, source) => {
 	if (!URL.canParse(url)) throw new Error(`${source} is not a URL; use https://...`);
 	const { protocol } = new URL(url);
@@ -52,4 +53,4 @@ const assistantSettings = (option, env) => {
 	};
 };
 //#endregion
-export { assistantRoles, assistantSettings, assistantVariables, defaultChatsDirectory, openRouterModel, openRouterUrl, seesAssistant };
+export { assistantRoles, assistantSettings, assistantVariables, checkedUrl, defaultChatsDirectory, openRouterModel, openRouterUrl, seesAssistant };

package/dist/create-admin.js

@@ -6,6 +6,7 @@ import { authBasePath } from "./better-auth/create-auth.js";
 import { statusRoute } from "./better-auth/status-route.js";
 import { checkShell } from "./check-shell.js";
 import { checkViews } from "./check-views.js";
+import { runtimeUrl } from "./runtime/runtime-settings.js";
 import { createMeta } from "./meta.js";
 import { buildRegistry } from "./registry.js";
 import { batchRoute } from "./routes/batch.js";
@@ -32,6 +33,7 @@ const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenti
 	});
 	const systemPath = basePath.slice(0, basePath.lastIndexOf("/"));
 	const assistant = assistantSettings(options.assistant, globalThis.process?.env ?? {});
+	const runtime = runtimeUrl(options.runtime, globalThis.process?.env ?? {});
 	const deps = {
 		db,
 		registry,
@@ -49,7 +51,8 @@ const createAdmin = ({ resources, views = [], pages = [], userMenu, db, authenti
 			...options.defaultAccess && { defaultAccess: options.defaultAccess }
 		},
 		rowPermissions: (resource) => typeof options.rowPermissions === "object" ? !options.rowPermissions.except.includes(resource) : options.rowPermissions !== false,
-		...assistant && { assistant: assistant.kind === "external" ? assistant.url : `${systemPath}/assistant` }
+		...assistant && { assistant: assistant.kind === "external" ? assistant.url : `${systemPath}/assistant` },
+		...runtime && { runtime }
 	};
 	const meta = createMeta(deps);
 	const onError = createErrorHandler(options.onUnhandledError);

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { AdminAuth, CreateAuthOptions, UserCreatedHook, createAuth, normalizeRoles } from "./better-auth/create-auth.js";
 import { ResourceSource, configExports } from "./resource-source.js";
 import { AssistantOptions, AssistantSettings, ModelSettings, assistantRoles, assistantSettings, assistantVariables, seesAssistant } from "./assistant/assistant-settings.js";
+import { RuntimeOptions, runtimeUrl, runtimeVariable, seesRuntime } from "./runtime/runtime-settings.js";
 import { Admin, AdminOptions, AuditEvent, AuditQueue, Authenticator, PipelineHook, ScanGuardMode, Session, TenantValue, User, ViewSource, WriteEvent, WriteOperation } from "./types.js";
 import { CreateAdminInput, createAdmin } from "./create-admin.js";
 import { consoleAuditQueue } from "./audit/console-queue.js";
@@ -20,4 +21,4 @@ import { AssistantTool, ToolContext, defineTool } from "./assistant/tools.js";
 import { TurnOptions, runTurn } from "./assistant/turn.js";
 import { QueryOptions, QueryResult, runReadOnlyQuery, runReadWriteQuery } from "./assistant/run-query.js";
 import { readOnlyQueryTool, readWriteQueryTool } from "./assistant/query-tools.js";
-export { type Admin, type AdminAuth, type AdminOptions, type ApprovalAnswer, type ApprovalRequest, type AssistantBackend, type AssistantOptions, type AssistantSettings, type AssistantTool, type AuditEvent, type AuditQueue, type Authenticator, type BetterAuthAuthenticatorOptions, type ChatMessage, type ChatTextPart, type Completion, type CompletionOptions, type Conversation, type ConversationRecord, type ConversationStore, type ConversationsOptions, type CreateAdminInput, type CreateAuthOptions, HttpProblem, type IssueTokenOptions, type JwtOptions, ModelError, type ModelSettings, type NewUser, type PipelineHook, type QueryOptions, type QueryResult, type ReasoningDetail, type ReasoningEffort, type ResourceSource, type ScanGuardMode, type Session, type StoredUser, type TenantValue, type ToolCall, type ToolContext, type ToolSpec, type TurnOptions, type User, type UserCreatedHook, type ViewSource, type WriteEvent, type WriteOperation, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, badRequest, betterAuthAuthenticator, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createUser, defineTool, deleteUser, fileConversationStore, forbidden, hasUsers, issueToken, jwtAuthenticator, listUsers, maxTokenTtlSeconds, normalizeRoles, notFound, parseRoles, readOnlyQueryTool, readWriteQueryTool, requestApproval, roleChoices, runReadOnlyQuery, runReadWriteQuery, runTurn, seesAssistant, setUserBanned, setUserRole, streamChatCompletion, unauthorized, withCacheBreakpoints };
+export { type Admin, type AdminAuth, type AdminOptions, type ApprovalAnswer, type ApprovalRequest, type AssistantBackend, type AssistantOptions, type AssistantSettings, type AssistantTool, type AuditEvent, type AuditQueue, type Authenticator, type BetterAuthAuthenticatorOptions, type ChatMessage, type ChatTextPart, type Completion, type CompletionOptions, type Conversation, type ConversationRecord, type ConversationStore, type ConversationsOptions, type CreateAdminInput, type CreateAuthOptions, HttpProblem, type IssueTokenOptions, type JwtOptions, ModelError, type ModelSettings, type NewUser, type PipelineHook, type QueryOptions, type QueryResult, type ReasoningDetail, type ReasoningEffort, type ResourceSource, type RuntimeOptions, type ScanGuardMode, type Session, type StoredUser, type TenantValue, type ToolCall, type ToolContext, type ToolSpec, type TurnOptions, type User, type UserCreatedHook, type ViewSource, type WriteEvent, type WriteOperation, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, badRequest, betterAuthAuthenticator, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createUser, defineTool, deleteUser, fileConversationStore, forbidden, hasUsers, issueToken, jwtAuthenticator, listUsers, maxTokenTtlSeconds, normalizeRoles, notFound, parseRoles, readOnlyQueryTool, readWriteQueryTool, requestApproval, roleChoices, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, seesAssistant, seesRuntime, setUserBanned, setUserRole, streamChatCompletion, unauthorized, withCacheBreakpoints };

package/dist/index.js

@@ -13,9 +13,10 @@ import { runTurn } from "./assistant/turn.js";
 import { consoleAuditQueue } from "./audit/console-queue.js";
 import { createAuth, normalizeRoles } from "./better-auth/create-auth.js";
 import { createUser, deleteUser, hasUsers, listUsers, parseRoles, roleChoices, setUserBanned, setUserRole } from "./better-auth/users.js";
+import { runtimeUrl, runtimeVariable, seesRuntime } from "./runtime/runtime-settings.js";
 import { createAdmin } from "./create-admin.js";
 import { configExports } from "./resource-source.js";
 import { jwtAuthenticator } from "./auth/jwt.js";
 import { betterAuthAuthenticator } from "./better-auth/authenticator.js";
 import { issueToken, maxTokenTtlSeconds } from "./better-auth/tokens.js";
-export { HttpProblem, ModelError, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, badRequest, betterAuthAuthenticator, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createUser, defineTool, deleteUser, fileConversationStore, forbidden, hasUsers, issueToken, jwtAuthenticator, listUsers, maxTokenTtlSeconds, normalizeRoles, notFound, parseRoles, readOnlyQueryTool, readWriteQueryTool, requestApproval, roleChoices, runReadOnlyQuery, runReadWriteQuery, runTurn, seesAssistant, setUserBanned, setUserRole, streamChatCompletion, unauthorized, withCacheBreakpoints };
+export { HttpProblem, ModelError, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, badRequest, betterAuthAuthenticator, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createUser, defineTool, deleteUser, fileConversationStore, forbidden, hasUsers, issueToken, jwtAuthenticator, listUsers, maxTokenTtlSeconds, normalizeRoles, notFound, parseRoles, readOnlyQueryTool, readWriteQueryTool, requestApproval, roleChoices, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, seesAssistant, seesRuntime, setUserBanned, setUserRole, streamChatCompletion, unauthorized, withCacheBreakpoints };

package/dist/meta.js

@@ -1,6 +1,7 @@
 import { seesAssistant } from "./assistant/assistant-settings.js";
 import { sha256Hex, stableJson } from "./hash.js";
 import { requestAccess } from "./request-access.js";
+import { seesRuntime } from "./runtime/runtime-settings.js";
 import { pruneView } from "./view-access.js";
 import { prunePage } from "@protobase/layout";
 import { pickView } from "@protobase/schema";
@@ -47,7 +48,8 @@ const createMeta = (deps) => {
 				].filter((op) => resolved.operations[op] && (resolved.recordChecks.includes(op) || resolved.rowFilter[op] !== void 0))
 			}])),
 			...deps.userMenu && { userMenu: { items: deps.userMenu.items.filter(shown) } },
-			...deps.assistant && seesAssistant(session.user.roles) && { assistant: { url: deps.assistant } }
+			...deps.assistant && seesAssistant(session.user.roles) && { assistant: { url: deps.assistant } },
+			...deps.runtime && seesRuntime(session.user.roles) && { runtime: { url: deps.runtime } }
 		};
 		return {
 			body,

package/dist/runtime/runtime-settings.d.ts

@@ -0,0 +1,14 @@
+//#region src/runtime/runtime-settings.d.ts
+/**
+ * `url`: the endpoint that reports the app's runtime version and updates it, such as a hosting platform's. The top
+ * bar shows an update button from what it answers. Falls back to `PROTOBASE_RUNTIME_URL`.
+ */
+export type RuntimeOptions = {
+  url?: string;
+};
+export declare const runtimeVariable = "PROTOBASE_RUNTIME_URL";
+/** Only an admin sees the runtime endpoint: `/meta` names it to nobody else. */
+export declare const seesRuntime: (roles: readonly string[]) => boolean;
+/** The runtime endpoint, when one is set and the option is not `false`. A value that is no http(s) URL stops the server at startup. */
+export declare const runtimeUrl: (option: RuntimeOptions | false | undefined, env: Record<string, string | undefined>) => string | undefined;
+//#endregion

package/dist/runtime/runtime-settings.js

@@ -0,0 +1,14 @@
+import { checkedUrl } from "../assistant/assistant-settings.js";
+//#region src/runtime/runtime-settings.ts
+const runtimeVariable = "PROTOBASE_RUNTIME_URL";
+/** Only an admin sees the runtime endpoint: `/meta` names it to nobody else. */
+const seesRuntime = (roles) => roles.includes("admin");
+/** The runtime endpoint, when one is set and the option is not `false`. A value that is no http(s) URL stops the server at startup. */
+const runtimeUrl = (option, env) => {
+	if (option === false) return void 0;
+	const url = (option?.url ?? env["PROTOBASE_RUNTIME_URL"])?.trim();
+	if (!url) return void 0;
+	return checkedUrl(url, option?.url === void 0 ? runtimeVariable : "options.runtime.url");
+};
+//#endregion
+export { runtimeUrl, runtimeVariable, seesRuntime };

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import { AssistantOptions } from "./assistant/assistant-settings.js";
+import { RuntimeOptions } from "./runtime/runtime-settings.js";
 import { Hono } from "hono";
 import { PageModel } from "@protobase/layout";
 import { ResolveOptions, ResourceModel, ViewModel } from "@protobase/schema";
@@ -89,6 +90,8 @@ export type AdminOptions = {
   onUnhandledError?: (error: unknown) => void;
   /** The assistant in the admin app's dock: a backend elsewhere or the built-in one (see `AssistantOptions`); `false` turns it off. */
   assistant?: AssistantOptions | false;
+  /** The runtime updates endpoint behind the top bar's update button (see `RuntimeOptions`); `false` turns it off. */
+  runtime?: RuntimeOptions | false;
 };
 export type ViewSource = {
   toModel(): ViewModel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -21,22 +21,23 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown"
+  },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
+    "@protobase/layout": "0.3.5",
+    "@protobase/query": "0.3.5",
+    "@protobase/schema": "0.3.5",
     "@scalar/hono-api-reference": "^0.12.10",
     "better-auth": "^1.7.7",
     "hono": "^4.13.13",
     "jose": "^6.2.12",
     "kysely": "^0.29.6",
     "nodemailer": "^10.0.16",
-    "zod": "^4.6.5",
-    "@protobase/query": "0.3.3",
-    "@protobase/layout": "0.3.3",
-    "@protobase/schema": "0.3.3"
-  },
-  "scripts": {
-    "build": "tsdown"
+    "zod": "^4.6.5"
   }
-}
+}