@protobase/server 0.12.9 → 0.12.11

package/dist/better-auth/create-auth.d.ts

@@ -2192,7 +2192,7 @@ export declare const createAuth: (options: CreateAuthOptions) => import("better-
               userId: string;
               expiresAt: Date;
               token: string;
-              ipAddress?: string | null | undefined;
+              ipAddress? /** The RP ID of new passkeys. */ : string | null | undefined;
               userAgent?: string | null | undefined;
             };
             user: Record<string, any> & {

package/dist/better-auth/create-auth.js

@@ -1,6 +1,5 @@
 import { multiHostBaseURL, readOrigins, resolveOrigins } from "./origins.js";
-import { readMailSettings } from "../mail/mail-settings.js";
-import { smtpMailer } from "../mail/smtp-mailer.js";
+import { platformMailer } from "../mail/platform-mailer.js";
 import { readOperatorSettings, resolveOperator } from "./operator-provider.js";
 import { roleDefinitions } from "./organizations/role-definitions.js";
 import { lastOrganizationField, organizationClaims, sessionOrganizationHooks } from "./organizations/session-organization.js";
@@ -27,10 +26,6 @@ const platformOperator = () => readOperatorSettings(globalThis.process?.env ?? {
 const platformSignInSettings = () => readPlatformSignIn(globalThis.process?.env ?? {});
 const platformOrigins = () => readOrigins(globalThis.process?.env ?? {});
 const platformPasskeyDomain = () => readPasskeyDomain(globalThis.process?.env ?? {});
-const platformMailer = () => {
-	const settings = readMailSettings(globalThis.process?.env ?? {});
-	return settings && smtpMailer(settings);
-};
 const tokenLifetime = "15m";
 const authBasePath = "/api/auth";
 /**

package/dist/better-auth/status-route.js

@@ -12,10 +12,11 @@ import { Hono } from "hono";
 * then; the ids of the `socialProviders` people can sign in with, so it offers "Continue with GitHub" when `github` is
 * one; `platformSignIn`, the id and name of the platform's provider when it is one of them; `staffSignIn`, the
 * operator provider's name, when staff can sign in as people; `passkeyDomains`, when people have passkeys for more than
-* one of the app's hosts, the RP IDs a passkey sign-in can ask for, the passkey domain first; and with organizations, who may create them and the roles
-* with their labels, `membership` for those a member can hold, and the roles each one's holders may also give.
+* one of the app's hosts, the RP IDs a passkey sign-in can ask for, the passkey domain first; with organizations, who may create them and the roles
+* with their labels, `membership` for those a member can hold, and the roles each one's holders may also give; and
+* `anonymous` when the project has an anonymous role, so the admin app opens for visitors before anyone signs in.
 */
-const statusRoute = (auth) => {
+const statusRoute = (auth, { anonymous = false } = {}) => {
 	const app = new Hono();
 	app.get("/status", async (c) => {
 		const context = await auth.$context;
@@ -38,6 +39,7 @@ const statusRoute = (auth) => {
 			...platformSignIn && { platformSignIn },
 			...staffSignIn && { staffSignIn },
 			...passkeyDomains.length > 1 && { passkeyDomains },
+			...anonymous && { anonymous },
 			...auth.organizations && { organizations: {
 				create: auth.organizations.create,
 				roles: auth.roleDefinitions.names.map((name) => ({

package/dist/check-views.js

@@ -26,6 +26,12 @@ const valueLabelErrors = (view, model) => Object.entries(view.fields).flatMap(([
 	if (field?.type !== "enum") return [`value labels of "${name}" need an enum field`];
 	return Object.keys(hints.valueLabels).filter((value) => !field.enumValues?.includes(value)).map((value) => `value label "${value}" is not a value of "${name}"`);
 });
+const valueColorErrors = (view, model) => Object.entries(view.fields).flatMap(([name, hints]) => {
+	if (!hints.valueColors) return [];
+	const field = model.fields[name];
+	if (field?.type !== "enum") return [`value colours of "${name}" need an enum field`];
+	return Object.keys(hints.valueColors).filter((value) => !field.enumValues?.includes(value)).map((value) => `value colour "${value}" is not a value of "${name}"`);
+});
 const linkErrors = (view, model, models, pages) => view.actions.flatMap(({ name, run }) => {
 	if (run?.kind !== "link") return [];
 	if ("href" in run) {
@@ -50,7 +56,7 @@ const widgetErrors = (view, model, fieldTypes) => Object.entries(view.fields).fl
 });
 /**
 * Fails at startup when a view uses a sensitive field where it would show empty, a display or custom section names a
-* field the resource does not have, labels values its enum does not have, shows a field with a field type of
+* field the resource does not have, labels or colours values its enum does not have, shows a field with a field type of
 * `fieldTypes` (each with the storage types it shows) that does not show it,
 * has a related section that does not fit the resources, or a link to an address the app does not have.
 */
@@ -65,6 +71,7 @@ const checkViews = (registry, views, pages = [], fieldTypes = {}) => {
 			...sensitiveErrors(view, model),
 			...unknownFieldErrors(view, model),
 			...valueLabelErrors(view, model),
+			...valueColorErrors(view, model),
 			...widgetErrors(view, model, fieldTypes),
 			...related,
 			...linkErrors(view, model, models, pageNames)

package/dist/create-admin.js

@@ -36,6 +36,7 @@ import { createScanGuard } from "./scan-guard.js";
 import { failedJobs, failedJobsView } from "./jobs/failed-jobs.js";
 import { Hono } from "hono";
 import { checkPages } from "@protobase/layout";
+import { anonymousRole } from "@protobase/schema";
 //#region src/create-admin.ts
 const declaredRoles = (auth, roles) => {
 	const names = [...auth?.roles ?? [], ...Object.keys(roles?.definitions ?? {})];
@@ -126,8 +127,10 @@ const createAdmin = ({ resources: appResources, views: appViews = [], pages = []
 	}, withAnonymous(authenticate, options.roles));
 	const system = guarded((app) => {
 		app.route("/", docsRoutes(deps));
-		app.route("/", metaRoutes(meta));
 	});
+	const metaApp = guarded((app) => {
+		app.route("/", metaRoutes(meta));
+	}, withAnonymous(authenticate, options.roles));
 	const app = new Hono();
 	app.onError(onError);
 	const corsOrigins = options.cors ?? readCorsOrigins(globalThis.process?.env ?? {});
@@ -142,7 +145,7 @@ const createAdmin = ({ resources: appResources, views: appViews = [], pages = []
 		}));
 	}
 	if (auth) {
-		app.route(authBasePath, statusRoute(auth));
+		app.route(authBasePath, statusRoute(auth, { anonymous: Object.hasOwn(options.roles?.definitions ?? {}, anonymousRole) }));
 		if (auth.organizations) app.route(authBasePath, organizationRoutes({
 			auth,
 			audit: deps.audit,
@@ -177,6 +180,7 @@ const createAdmin = ({ resources: appResources, views: appViews = [], pages = []
 	app.route("/", batchRoute(deps, authenticate, meta));
 	app.route("/", fileRoutes(deps, authenticate));
 	app.route(basePath, api);
+	app.route(`${deps.systemPath}/meta`, metaApp);
 	app.route(deps.systemPath || "/", system);
 	const webhooks = createWebhooks({
 		deps,

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { SignInPolicy, SignInRule, StaffAccessRule, defaultSignInPolicy, signInPolicyMethods } from "./better-auth/sign-in-policy.js";
 import { StaffSignIn } from "./better-auth/staff-log.js";
+import { MailMessage, Mailer } from "./mail/smtp-mailer.js";
 import { OperatorProvider, readOperatorSettings } from "./better-auth/operator-provider.js";
 import { RoleDefinition, RolesInput } from "./better-auth/organizations/role-definitions.js";
 import { OrganizationRole, StoredMember, StoredOrganization } from "./better-auth/organizations/store.js";
@@ -74,4 +75,4 @@ import { FatalJobError } from "./jobs/run-job.js";
 import { DrainResult, JobsRuntime, StartJobsOptions, startJobs } from "./jobs/runtime.js";
 import { jobsDrainApp } from "./jobs/drain-route.js";
 import { checkJobsSchema, jobsSchema, jobsSchemaMigration } from "./jobs/schema.js";
-export { type Admin, type AdminAuth, type AdminOptions, type ApiFunction, type ApprovalAnswer, type ApprovalRequest, type AssistantBackend, type AssistantOptions, type AssistantSettings, type AssistantTool, type AuditEvent, type AuditQueue, type Authenticator, type BetterAuthAuthenticatorOptions, type CapturedRow, type ChatMessage, type ChatTextPart, type CleanupEntry, type CleanupReport, type CleanupSchedule, type CoalescedChange, type Completion, type CompletionOptions, type Conversation, type ConversationRecord, type ConversationStore, type ConversationsOptions, type CorsOptions, type CorsOrigins, type CreateAdminInput, type CreateAuthOptions, type DrainResult, type EnqueueOptions, type ErrorReporter, type ErrorReportingOptions, type ErrorReportingSettings, type EventData, type EventsOptions, FatalJobError, type FileCleanupInput, type FileObject, type FileProvider, type FileStore, type FilesOptions, type FunctionApp, type FunctionCaller, type FunctionContext, type FunctionEnv, type FunctionHandler, type FunctionOptions, type FunctionRecords, type FunctionSource, HttpProblem, type IssueTokenOptions, type JobContext, type JobDefinition, type JobOptions, type JobsRuntime, type JwtOptions, type LinkedAccount, type ListParams, type LocalFilesOptions, type MemberInput, MissingCredentials, ModelError, type ModelSettings, type NewOrganization, type NewUser, type OperatorProvider, type OrganizationRole, type OrganizationsOptions, type PipelineHook, type PlatformSignIn, type PluginOption, type PluginRef, type ProjectConfig, type ProtectedFunctionOptions, type PublicFunctionContext, type PublicFunctionEnv, type PublicFunctionHandler, type PublicFunctionOptions, type QueryOptions, type QueryResult, type ReasoningDetail, type ReasoningEffort, type RecordKeyInput, type RecordPage, type ResourceChange, type ResourceSource, type RoleDefinition, type RolesInput, type RunContext, type RuntimeOptions, type ScanGuardMode, type ScheduledDelete, type Session, type SessionOrganization, type SignInPolicy, type SignInRule, type SignatureOptions, type SourceOption, type SourceRef, type StaffAccessRule, type StaffSignIn, type StandardSchema, type StandardWebhookOptions, type StartJobsOptions, type StoredMember, type StoredObject, type StoredOrganization, type StoredUser, type SubscriptionDefinition, type SubscriptionEvent, type SubscriptionOptions, type TenantValue, type ToolCall, type ToolContext, type ToolRecord, type ToolRecords, type ToolSpec, type TrustedApp, type TurnOptions, type User, type UserCreatedHook, type ViewSource, type WebhooksOptions, type WidgetOptions, type WriteEvent, type WriteOperation, addAppRoleToOwners, addMember, aspectRatio, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, authSchemaMigration, badRequest, betterAuthAuthenticator, changesMigration, checkAuthSchema, checkChanges, checkJobsSchema, checkSourceNames, checkWebhooksSchema, coalesce, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createFileCleanup, createOrganization, createUser, defaultSignInPolicy, defineConfig, defineFunction, defineJob, defineTool, deleteUser, errorReportingSettings, errorReportingVariable, eventMatcher, fileConversationStore, fileSize, fileType, forbidden, functionApp, hasUsers, imageSize, isJobDefinition, issueToken, jobDefinitions, jobsDrainApp, jobsSchema, jobsSchemaMigration, jwtAuthenticator, listOrganizations, listUsers, localFileStore, localFiles, maxTokenTtlSeconds, maxWidgetPropsBytes, mergeConfig, migrationCommand, newWebhookSecret, normalizeRoles, notFound, parseColumns, parseRoles, pluginOptions, pluginsFor, pluginsVariable, processor, readJson, readOnlyQueryTool, readOperatorSettings, readOutbox, readPlatformSignIn, readWriteQueryTool, recordOf, removeMember, requestApproval, requireEnv, resourceChange, roleChoices, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, seesAssistant, seesRuntime, setMemberRoles, setUserBanned, setUserRole, signInPolicyMethods, sourceOptions, sourcesFor, sourcesVariable, startErrorReporting, startJobs, storageCleanupSchedule, streamChatCompletion, subscription, unauthorized, verifySignature, verifyStandardWebhook, webauthnPath, webhooks, webhooksMigration, widget, withCacheBreakpoints, withTrustedApps };
+export { type Admin, type AdminAuth, type AdminOptions, type ApiFunction, type ApprovalAnswer, type ApprovalRequest, type AssistantBackend, type AssistantOptions, type AssistantSettings, type AssistantTool, type AuditEvent, type AuditQueue, type Authenticator, type BetterAuthAuthenticatorOptions, type CapturedRow, type ChatMessage, type ChatTextPart, type CleanupEntry, type CleanupReport, type CleanupSchedule, type CoalescedChange, type Completion, type CompletionOptions, type Conversation, type ConversationRecord, type ConversationStore, type ConversationsOptions, type CorsOptions, type CorsOrigins, type CreateAdminInput, type CreateAuthOptions, type DrainResult, type EnqueueOptions, type ErrorReporter, type ErrorReportingOptions, type ErrorReportingSettings, type EventData, type EventsOptions, FatalJobError, type FileCleanupInput, type FileObject, type FileProvider, type FileStore, type FilesOptions, type FunctionApp, type FunctionCaller, type FunctionContext, type FunctionEnv, type FunctionHandler, type FunctionOptions, type FunctionRecords, type FunctionSource, HttpProblem, type IssueTokenOptions, type JobContext, type JobDefinition, type JobOptions, type JobsRuntime, type JwtOptions, type LinkedAccount, type ListParams, type LocalFilesOptions, type MailMessage, type Mailer, type MemberInput, MissingCredentials, ModelError, type ModelSettings, type NewOrganization, type NewUser, type OperatorProvider, type OrganizationRole, type OrganizationsOptions, type PipelineHook, type PlatformSignIn, type PluginOption, type PluginRef, type ProjectConfig, type ProtectedFunctionOptions, type PublicFunctionContext, type PublicFunctionEnv, type PublicFunctionHandler, type PublicFunctionOptions, type QueryOptions, type QueryResult, type ReasoningDetail, type ReasoningEffort, type RecordKeyInput, type RecordPage, type ResourceChange, type ResourceSource, type RoleDefinition, type RolesInput, type RunContext, type RuntimeOptions, type ScanGuardMode, type ScheduledDelete, type Session, type SessionOrganization, type SignInPolicy, type SignInRule, type SignatureOptions, type SourceOption, type SourceRef, type StaffAccessRule, type StaffSignIn, type StandardSchema, type StandardWebhookOptions, type StartJobsOptions, type StoredMember, type StoredObject, type StoredOrganization, type StoredUser, type SubscriptionDefinition, type SubscriptionEvent, type SubscriptionOptions, type TenantValue, type ToolCall, type ToolContext, type ToolRecord, type ToolRecords, type ToolSpec, type TrustedApp, type TurnOptions, type User, type UserCreatedHook, type ViewSource, type WebhooksOptions, type WidgetOptions, type WriteEvent, type WriteOperation, addAppRoleToOwners, addMember, aspectRatio, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, authSchemaMigration, badRequest, betterAuthAuthenticator, changesMigration, checkAuthSchema, checkChanges, checkJobsSchema, checkSourceNames, checkWebhooksSchema, coalesce, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createFileCleanup, createOrganization, createUser, defaultSignInPolicy, defineConfig, defineFunction, defineJob, defineTool, deleteUser, errorReportingSettings, errorReportingVariable, eventMatcher, fileConversationStore, fileSize, fileType, forbidden, functionApp, hasUsers, imageSize, isJobDefinition, issueToken, jobDefinitions, jobsDrainApp, jobsSchema, jobsSchemaMigration, jwtAuthenticator, listOrganizations, listUsers, localFileStore, localFiles, maxTokenTtlSeconds, maxWidgetPropsBytes, mergeConfig, migrationCommand, newWebhookSecret, normalizeRoles, notFound, parseColumns, parseRoles, pluginOptions, pluginsFor, pluginsVariable, processor, readJson, readOnlyQueryTool, readOperatorSettings, readOutbox, readPlatformSignIn, readWriteQueryTool, recordOf, removeMember, requestApproval, requireEnv, resourceChange, roleChoices, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, seesAssistant, seesRuntime, setMemberRoles, setUserBanned, setUserRole, signInPolicyMethods, sourceOptions, sourcesFor, sourcesVariable, startErrorReporting, startJobs, storageCleanupSchedule, streamChatCompletion, subscription, unauthorized, verifySignature, verifyStandardWebhook, webauthnPath, webhooks, webhooksMigration, widget, withCacheBreakpoints, withTrustedApps };

package/dist/jobs/job-types.d.ts

@@ -1,3 +1,4 @@
+import { Mailer } from "../mail/smtp-mailer.js";
 import { StandardSchema } from "../functions/read-json.js";
 import { Db } from "@protobase/query";
 //#region src/jobs/job-types.d.ts
@@ -13,6 +14,8 @@ export type JobContext = {
   };
   /** Aborted when the job's timeout passes, or when the worker shuts down and its grace period ends. */
   signal: AbortSignal;
+  /** Sends plain-text mail through the app's SMTP server (`PROTOBASE_SMTP_URL`, `PROTOBASE_MAIL_FROM`); `undefined` when the app has no mail. */
+  mail?: Mailer;
 };
 export type JobOptions<Payload> = {
   /** Letters, digits, `_`, `-`, `.` and `/`; the job's queue in the `jobs` schema. */

package/dist/jobs/run-job.js

@@ -48,7 +48,7 @@ const errorOutput = (error) => error instanceof Error ? {
 * One try of one job: completed when `run` returns, failed (to be retried while attempts are left) when it throws, and
 * failed for good on a `FatalJobError` or an invalid payload.
 */
-const runJob = async (definition, job, db) => {
+const runJob = async (definition, job, db, mail) => {
 	try {
 		const payload = await checkPayload(definition, job.data ?? void 0);
 		const context = {
@@ -59,7 +59,8 @@ const runJob = async (definition, job, db) => {
 				attempt: job.retryCount + 1,
 				maxAttempts: job.retryLimit + 1
 			},
-			signal: job.signal
+			signal: job.signal,
+			...mail && { mail }
 		};
 		await throughWriteFreeze(() => definition.options.run(payload, context), job.signal);
 		return {

package/dist/jobs/runtime.d.ts

@@ -1,3 +1,4 @@
+import { Mailer } from "../mail/smtp-mailer.js";
 import { JobDefinition } from "./job-types.js";
 import { JobsEnqueuer } from "./current.js";
 import { Db } from "@protobase/query";
@@ -15,6 +16,11 @@ export type StartJobsOptions = {
   onError: (error: unknown) => void;
   /** The time recurring jobs are scheduled from; tests pass their own. */
   now?: () => Date;
+  /**
+   * What jobs send mail with (`context.mail`): by default the platform's SMTP server from `PROTOBASE_SMTP_URL` and
+   * `PROTOBASE_MAIL_FROM`, when set; `false` turns mail off whatever the environment says.
+   */
+  mailer?: Mailer | false;
 };
 /** What a drain left: whether no job is due or running any more, how many are, and when the next one is due. */
 export type DrainResult = {
@@ -42,5 +48,5 @@ export type JobsRuntime = JobsEnqueuer & {
  * that retries jobs whose worker died. It reads the jobs schema, never changes it: check it first with
  * `checkJobsSchema`. Enqueueing through `defineJob(...).enqueue` reaches the runtime started here.
  */
-export declare const startJobs: ({ db, jobs, work, pollSeconds, shutdownSeconds, onError, now }: StartJobsOptions) => Promise<JobsRuntime>;
+export declare const startJobs: ({ db, jobs, work, pollSeconds, shutdownSeconds, onError, now, mailer }: StartJobsOptions) => Promise<JobsRuntime>;
 //#endregion

package/dist/jobs/runtime.js

@@ -1,5 +1,6 @@
 import { clearCurrentJobs, setCurrentJobs } from "./current.js";
 import { jobsSchema } from "./schema.js";
+import { platformMailer } from "../mail/platform-mailer.js";
 import "./schedule.js";
 import { runJob, validatePayload } from "./run-job.js";
 import { jobsDatabase } from "./database.js";
@@ -25,7 +26,8 @@ const createBoss = (db, work) => new PgBoss({
 * that retries jobs whose worker died. It reads the jobs schema, never changes it: check it first with
 * `checkJobsSchema`. Enqueueing through `defineJob(...).enqueue` reaches the runtime started here.
 */
-const startJobs = async ({ db, jobs, work = true, pollSeconds = 2, shutdownSeconds = 30, onError, now = () => /* @__PURE__ */ new Date() }) => {
+const startJobs = async ({ db, jobs, work = true, pollSeconds = 2, shutdownSeconds = 30, onError, now = () => /* @__PURE__ */ new Date(), mailer }) => {
+	const mail = mailer === void 0 ? platformMailer() : mailer || void 0;
 	const boss = createBoss(db, work);
 	boss.on("error", onError);
 	await boss.start();
@@ -56,7 +58,7 @@ const startJobs = async ({ db, jobs, work = true, pollSeconds = 2, shutdownSecon
 		}, async ([job]) => {
 			const current = definitions.get(definition.name) ?? definition;
 			if (current.options.schedule !== void 0 && job.singletonKey === "protobase.schedule") await schedules.following(current, job.startAfter);
-			return [await runJob(current, job, db)];
+			return [await runJob(current, job, db, mail)];
 		});
 		workers.set(definition.name, {
 			id,

package/dist/mail/platform-mailer.js

@@ -0,0 +1,10 @@
+import { readMailSettings } from "./mail-settings.js";
+import { smtpMailer } from "./smtp-mailer.js";
+//#region src/mail/platform-mailer.ts
+/** The platform's SMTP server and sender from `PROTOBASE_SMTP_URL` and `PROTOBASE_MAIL_FROM`; `undefined` when mail is off. */
+const platformMailer = (env = globalThis.process?.env ?? {}) => {
+	const settings = readMailSettings(env);
+	return settings && smtpMailer(settings);
+};
+//#endregion
+export { platformMailer };

package/dist/routes/meta.js

@@ -3,7 +3,7 @@ import { Hono } from "hono";
 //#region src/routes/meta.ts
 const metaRoutes = (meta) => {
 	const app = new Hono();
-	app.get("/meta", async (c) => {
+	app.get("/", async (c) => {
 		const { body, etag } = await meta.forCaller(c.get("session"));
 		const headers = {
 			ETag: etag,

package/dist/view-access.js

@@ -30,10 +30,12 @@ const listShape = shapes.object({
 			name: shapes.data,
 			label: shapes.data,
 			icon: shapes.data,
+			image: shapes.field,
 			title: shapes.field,
 			subtitle: shapes.field,
 			badge: shapes.field,
 			meta: shapes.list(shapes.field),
+			flags: shapes.list(shapes.field),
 			card: shapes.data
 		}),
 		custom: shapes.object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.12.9",
+  "version": "0.12.11",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -30,9 +30,9 @@
   },
   "dependencies": {
     "@better-auth/passkey": "^1.7.7",
-    "@protobase/layout": "0.12.9",
-    "@protobase/query": "0.12.9",
-    "@protobase/schema": "0.12.9",
+    "@protobase/layout": "0.12.11",
+    "@protobase/query": "0.12.11",
+    "@protobase/schema": "0.12.11",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",
     "@simplewebauthn/server": "^13.3.1",