@protobase/server 0.27.0 → 0.28.0

package/dist/app-identity.d.ts

@@ -0,0 +1,12 @@
+//#region src/app-identity.d.ts
+/**
+ * The `app` section of `protobase.config.ts`: the colours the installed app shows, beside its name (`createAuth`'s
+ * `appName`) and its icons (`protobase.favicon.svg` and the PNGs beside it). Any CSS colour, such as `#0d9488`.
+ */
+export type AppIdentity = {
+  /** The colour of the installed app's title bar and of the browser's toolbar around it. */
+  themeColor?: string;
+  /** The colour of the screen an installed app shows while it starts. */
+  backgroundColor?: string;
+};
+//#endregion

package/dist/app-name.js

@@ -4,8 +4,10 @@ const appNameVariable = "PROTOBASE_APP_NAME";
 const defaultAppName = "Protobase";
 /**
 * The app's name the platform passes in `PROTOBASE_APP_NAME`, such as `Property Finder`; `undefined` when it is not
-* set. Protobase names the app with it in sign-in prompts and in the mail it sends, unless the app names itself.
+* set. Protobase names the app with it in sign-in prompts and in the mail it sends, over the name the app gives itself.
 */
 const readAppName = (env) => env["PROTOBASE_APP_NAME"]?.trim() || void 0;
+/** The name the app goes by: the platform's `PROTOBASE_APP_NAME`, which deployments rename it with, over its own `own`. */
+const appNameOver = (env, own) => readAppName(env) ?? own;
 //#endregion
-export { appNameVariable, defaultAppName, readAppName };
+export { appNameOver, appNameVariable, defaultAppName, readAppName };

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

@@ -34,8 +34,9 @@ export type CreateAuthOptions = {
   passkeyDomain?: string;
   /**
    * The app's name: authenticator apps and passkey prompts show it, the auth emails name the app with it, and the
-   * default mailer sends them from it, as the sender's display name. Defaults to the name the platform passes in
-   * `PROTOBASE_APP_NAME`, when set, and to `Protobase` otherwise (without a sender's display name).
+   * default mailer sends them from it, as the sender's display name; the tab titles, the sidebar's logo and the
+   * installed app show it too. The name the platform passes in `PROTOBASE_APP_NAME`, when set, overrides it; without
+   * either it is `Protobase` (without a sender's display name).
    */
   appName?: string;
   /** Signs cookies and encrypts the JWT private keys. Generate with `openssl rand -base64 32`. */
@@ -1294,7 +1295,7 @@ export declare const createAuth: (options: CreateAuthOptions) => import("better-
               email: string;
               emailVerified: boolean;
               name: string;
-              image?: string | null | undefined;
+              image? /** Signs cookies and encrypts the JWT private keys. Generate with `openssl rand -base64 32`. */ : string | null | undefined;
             };
           };
         }>>[];
@@ -4018,7 +4019,7 @@ export declare const createAuth: (options: CreateAuthOptions) => import("better-
               userId: string;
               expiresAt: Date;
               token: string;
-              ipAddress? /** The RP ID of new passkeys. */ : string | null | undefined;
+              ipAddress?: string | null | undefined;
               userAgent?: string | null | undefined;
             };
             user: Record<string, any> & {
@@ -5971,7 +5972,7 @@ export declare const createAuth: (options: CreateAuthOptions) => import("better-
   /** The app keeps each user's metadata, in the column `users.metadata` names. */
   userMetadata: boolean;
   socialProviders: string[];
-  /** The app's name it signs in and mails as: `appName`, else `PROTOBASE_APP_NAME`, else `Protobase`. */
+  /** The app's name it signs in and mails as: `PROTOBASE_APP_NAME`, else `appName`, else `Protobase`. */
   appName: string;
   operator: string | undefined;
   platformSignIn: {

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

@@ -1,5 +1,5 @@
 import { appOrigins, multiHostBaseURL, readOrigins, resolveOrigins } from "./origins.js";
-import { defaultAppName, readAppName } from "../app-name.js";
+import { appNameOver, defaultAppName } from "../app-name.js";
 import { goTrueIssuer, goTrueKeyPair } from "../gotrue/keys.js";
 import { roleDefinitions } from "./organizations/role-definitions.js";
 import { narrowClaims } from "./roles/active-role.js";
@@ -38,7 +38,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 platformAppName = () => readAppName(globalThis.process?.env ?? {});
 const tokenLifetime = "15m";
 /**
 * Better Auth for a single-tenant admin: sign-in with a password, an emailed code or a passkey, two-factor
@@ -276,7 +275,7 @@ const createAuth = (options) => {
 	const signUpRole = options.signUp && checkSignUpRole(options.signUp.role, roles);
 	const others = roles.filter((role) => role !== "admin");
 	const defaultRole = options.defaultRole ?? (options.organizations ? "user" : others.length === 1 ? others[0] : void 0);
-	const appName = options.appName ?? platformAppName();
+	const appName = appNameOver(globalThis.process?.env ?? {}, options.appName);
 	const mailer = options.mailer === void 0 ? platformMailer(void 0, appName) : options.mailer || void 0;
 	const provider = options.operator === void 0 ? platformOperator() : options.operator || void 0;
 	const operator = provider && resolveOperator(provider);
@@ -329,7 +328,7 @@ const createAuth = (options) => {
 		/** The app keeps each user's metadata, in the column `users.metadata` names. */
 		userMetadata: Boolean(options.users?.metadata),
 		socialProviders,
-		/** The app's name it signs in and mails as: `appName`, else `PROTOBASE_APP_NAME`, else `Protobase`. */
+		/** The app's name it signs in and mails as: `PROTOBASE_APP_NAME`, else `appName`, else `Protobase`. */
 		appName: appName ?? "Protobase",
 		operator: operator?.name,
 		platformSignIn: platformSignIn && {

package/dist/create-admin.d.ts

@@ -1,4 +1,6 @@
 import { MobileConfig } from "./mobile-config.js";
+import { AppIdentity } from "./app-identity.js";
+import { AppIcons } from "./web-app/app-icons.js";
 import { AdminAuth } from "./better-auth/create-auth.js";
 import { EventsOptions } from "./changes/events-options.js";
 import { JobDefinition } from "./jobs/job-types.js";
@@ -46,6 +48,13 @@ export type CreateAdminInput = {
   webhooks?: WebhooksOptions;
   /** The app's iOS and Android build (see `MobileConfig`): the API answers its Capacitor origins through CORS. */
   mobile?: MobileConfig;
+  /** The app's colours, which its web manifest carries (see `AppIdentity`). */
+  app?: AppIdentity;
+  /**
+   * The icons the project has of its own, as `protobase build` and `protobase dev` find them beside its favicon: the
+   * web manifest names its PNGs, and `/meta` the favicon when it is the project's, which the sidebar's logo draws.
+   */
+  icons?: AppIcons;
   /**
    * The plugins the app's bundle carries, as `protobase build` writes them: its protobase.ui.tsx and its extensions'
    * UI configs, each a plugin.json path on the app's origin. `/meta` names them to everyone, before any other plugin,
@@ -72,5 +81,5 @@ export type CreateAdminInput = {
   upgradeWebSocket?: UpgradeWebSocket;
 };
 /** The admin REST API as a Hono app. It uses only Web APIs, so it runs on Node, Workers and anywhere else Hono does. */
-export declare const createAdmin: ({ resources: appResources, views: appViews, pages, userMenu, bottomBars, db, authenticate, auth, functions, files: filesOptions, events, history: historyOptions, jobs, subscriptions, webhooks: webhooksOptions, mobile, bundlePlugins, fieldTypes, options, formsDifficulty, commentUsers: givenCommentUsers, verifyToken, upgradeWebSocket }: CreateAdminInput) => Admin;
+export declare const createAdmin: ({ resources: appResources, views: appViews, pages, userMenu, bottomBars, db, authenticate, auth, functions, files: filesOptions, events, history: historyOptions, jobs, subscriptions, webhooks: webhooksOptions, mobile, app: identity, icons, bundlePlugins, fieldTypes, options, formsDifficulty, commentUsers: givenCommentUsers, verifyToken, upgradeWebSocket }: CreateAdminInput) => Admin;
 //#endregion

package/dist/create-admin.js

@@ -63,6 +63,7 @@ import { batchRoute } from "./routes/batch.js";
 import { collectionRoutes } from "./routes/collection.js";
 import { docsRoutes } from "./routes/docs.js";
 import { metaRoutes } from "./routes/meta.js";
+import { faviconPath } from "./web-app/web-manifest.js";
 import { webManifestRoute } from "./web-app/web-manifest-route.js";
 import { recordRoutes } from "./routes/record.js";
 import { createScanGuard } from "./scan-guard.js";
@@ -75,7 +76,7 @@ const declaredRoles = (auth, roles) => {
 	return names.length > 0 ? [...new Set(names)] : void 0;
 };
 /** The admin REST API as a Hono app. It uses only Web APIs, so it runs on Node, Workers and anywhere else Hono does. */
-const createAdmin = ({ resources: appResources, views: appViews = [], pages = [], userMenu, bottomBars = [], db, authenticate, auth, functions = {}, files: filesOptions, events, history: historyOptions, jobs = [], subscriptions = [], webhooks: webhooksOptions, mobile, bundlePlugins = [], fieldTypes = {}, options = {}, formsDifficulty, commentUsers: givenCommentUsers, verifyToken, upgradeWebSocket }) => {
+const createAdmin = ({ resources: appResources, views: appViews = [], pages = [], userMenu, bottomBars = [], db, authenticate, auth, functions = {}, files: filesOptions, events, history: historyOptions, jobs = [], subscriptions = [], webhooks: webhooksOptions, mobile, app: identity, icons, bundlePlugins = [], fieldTypes = {}, options = {}, formsDifficulty, commentUsers: givenCommentUsers, verifyToken, upgradeWebSocket }) => {
 	const basePath = options.basePath ?? "/api/v1";
 	const appModels = appResources.map((resource) => resource.toModel());
 	const withComments = appModels.some((model) => model.comments);
@@ -191,7 +192,7 @@ const createAdmin = ({ resources: appResources, views: appViews = [], pages = []
 		} }
 	};
 	const appName = auth?.appName ?? readAppName(globalThis.process?.env ?? {}) ?? "Protobase";
-	const meta = createMeta(deps, appName);
+	const meta = createMeta(deps, appName, icons?.favicon ? faviconPath : void 0);
 	const onError = createErrorHandler(options.onUnhandledError);
 	const guarded = (routes, caller = authenticate) => {
 		const app = new Hono();
@@ -301,7 +302,7 @@ const createAdmin = ({ resources: appResources, views: appViews = [], pages = []
 	}
 	app.route(basePath, api);
 	app.route(`${deps.systemPath}/meta`, metaApp);
-	app.route(systemPath || "/", webManifestRoute(appName));
+	app.route(systemPath || "/", webManifestRoute(appName, identity, icons));
 	app.route(deps.systemPath || "/", system);
 	const webhooks = createWebhooks({
 		deps,

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import { MobileConfig } from "./mobile-config.js";
+import { AppIdentity } from "./app-identity.js";
+import { AppIcons, PngIcon, pngIcons } from "./web-app/app-icons.js";
 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";
@@ -98,4 +100,4 @@ import { isSchedule } from "./jobs/schedule.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 ApiKeys, type ApiKeysOptions, type ApprovalAnswer, type ApprovalRequest, type AssistantBackend, type AssistantOptions, type AssistantSettings, type AssistantTool, type AuditEvent, type AuditQueue, type Authenticator, type BetterAuthAuthenticatorOptions, type Caller, type CallerOptions, type CapturedRow, type ChatMessage, type ChatTextPart, type CheckAiInput, type CleanupEntry, type CleanupReport, type CleanupSchedule, type CoalescedChange, type CommentItem, type CommentUsers, type Completion, type CompletionOptions, type Conversation, type ConversationRecord, type ConversationStore, type ConversationsOptions, type CorsOptions, type CorsOrigins, type CreateAdminInput, type CreateAuthOptions, type DrainResult, type EmailComponent, type EmailOptions, type EmailTemplate, type EnqueueOptions, type ErrorReporter, type ErrorReportingOptions, type ErrorReportingSettings, type EventData, type EventsOptions, FatalJobError, type FileCleanupInput, type FileLimits, type FileObject, type FileProvider, type FileRef, type FileStore, type FileVariantObject, type FilesOptions, type FunctionApp, type FunctionCaller, type FunctionContext, type FunctionEnv, type FunctionHandler, type FunctionOptions, type FunctionRecords, type FunctionSource, type HistoryOptions, HttpProblem, type IssueTokenOptions, type JobContext, type JobDefinition, type JobOptions, type JobsRuntime, type JwtOptions, type JwtVerifyOptions, type LinkedAccount, type ListParams, type LocalFilesOptions, type MailMessage, type Mailer, type MapLayer, type MapOptions, type MapSettings, type MemberInput, MissingCredentials, type MobileConfig, 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 RenderedEmail, type ResourceChange, type ResourceSource, type RoleDefinition, type RolesInput, type RunContext, type RuntimeOptions, type S3Bucket, type S3FilesOptions, type S3ListPage, type S3Object, type ScanGuardMode, type ScheduledDelete, type Session, type SessionOrganization, type Sharp, type SignInPolicy, type SignInRule, type SignatureOptions, type SourceOption, type SourceRef, type StaffAccessRule, type StaffSignIn, type StandardSchema, type StandardWebhookOptions, type StartJobsOptions, type StoreFileInput, 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, apiKeyCaller, apiKeySettings, apiKeyVariables, aspectRatio, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, authSchemaMigration, badRequest, beforeSignInPluginsVariable, betterAuthAuthenticator, betterAuthTokens, changesMigration, checkAi, checkAuthSchema, checkChanges, checkComments, checkComputed, checkJobsSchema, checkSourceNames, checkViewQueries, checkWebhooksSchema, coalesce, commentsMigration, computedMigration, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createFileCleanup, createOrganization, createUser, defaultAppName, defaultSignInPolicy, defineConfig, defineEmail, defineFunction, defineJob, defineTool, deleteUser, errorReportingSettings, errorReportingVariable, eventMatcher, fileConversationStore, fileSize, fileType, forbidden, formatUri, functionApp, handleDroppedConnections, hasUsers, imageSize, isBackgroundWork, isCaptured, isJobDefinition, isSchedule, issueToken, jobDefinitions, jobsDrainApp, jobsSchema, jobsSchemaMigration, jwtAuthenticator, jwtVerifier, limitedFileStore, listOrganizations, listUsers, localFileStore, localFiles, mapSettings, mapStyleUrl, mapStyleVariable, maxTokenTtlSeconds, maxWidgetPropsBytes, mergeConfig, migrationCommand, newWebhookSecret, normalizeRoles, notFound, parseColumns, parseRoles, pluginOptions, pluginsBeforeSignIn, pluginsFor, pluginsVariable, processor, readJson, readOnlyQueryTool, readOperatorSettings, readOutbox, readPlatformSignIn, readWriteQueryTool, recordOf, removeMember, renderVariant, requestApproval, requireEnv, resourceChange, roleChoices, runInBackground, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, s3FileStore, s3Files, seesAssistant, seesRuntime, setMemberRoles, setUserBanned, setUserRole, signInPolicyMethods, sourceOptions, sourcesFor, sourcesVariable, startErrorReporting, startJobs, storageCleanupSchedule, storeFile, streamChatCompletion, subscription, thumbHash, unauthorized, variantPath, verifySignature, verifyStandardWebhook, webauthnPath, webhooks, webhooksMigration, widget, withCacheBreakpoints, withTrustedApps };
+export { type Admin, type AdminAuth, type AdminOptions, type ApiFunction, type ApiKeys, type ApiKeysOptions, type AppIcons, type AppIdentity, type ApprovalAnswer, type ApprovalRequest, type AssistantBackend, type AssistantOptions, type AssistantSettings, type AssistantTool, type AuditEvent, type AuditQueue, type Authenticator, type BetterAuthAuthenticatorOptions, type Caller, type CallerOptions, type CapturedRow, type ChatMessage, type ChatTextPart, type CheckAiInput, type CleanupEntry, type CleanupReport, type CleanupSchedule, type CoalescedChange, type CommentItem, type CommentUsers, type Completion, type CompletionOptions, type Conversation, type ConversationRecord, type ConversationStore, type ConversationsOptions, type CorsOptions, type CorsOrigins, type CreateAdminInput, type CreateAuthOptions, type DrainResult, type EmailComponent, type EmailOptions, type EmailTemplate, type EnqueueOptions, type ErrorReporter, type ErrorReportingOptions, type ErrorReportingSettings, type EventData, type EventsOptions, FatalJobError, type FileCleanupInput, type FileLimits, type FileObject, type FileProvider, type FileRef, type FileStore, type FileVariantObject, type FilesOptions, type FunctionApp, type FunctionCaller, type FunctionContext, type FunctionEnv, type FunctionHandler, type FunctionOptions, type FunctionRecords, type FunctionSource, type HistoryOptions, HttpProblem, type IssueTokenOptions, type JobContext, type JobDefinition, type JobOptions, type JobsRuntime, type JwtOptions, type JwtVerifyOptions, type LinkedAccount, type ListParams, type LocalFilesOptions, type MailMessage, type Mailer, type MapLayer, type MapOptions, type MapSettings, type MemberInput, MissingCredentials, type MobileConfig, ModelError, type ModelSettings, type NewOrganization, type NewUser, type OperatorProvider, type OrganizationRole, type OrganizationsOptions, type PipelineHook, type PlatformSignIn, type PluginOption, type PluginRef, type PngIcon, 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 RenderedEmail, type ResourceChange, type ResourceSource, type RoleDefinition, type RolesInput, type RunContext, type RuntimeOptions, type S3Bucket, type S3FilesOptions, type S3ListPage, type S3Object, type ScanGuardMode, type ScheduledDelete, type Session, type SessionOrganization, type Sharp, type SignInPolicy, type SignInRule, type SignatureOptions, type SourceOption, type SourceRef, type StaffAccessRule, type StaffSignIn, type StandardSchema, type StandardWebhookOptions, type StartJobsOptions, type StoreFileInput, 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, apiKeyCaller, apiKeySettings, apiKeyVariables, aspectRatio, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, authSchemaMigration, badRequest, beforeSignInPluginsVariable, betterAuthAuthenticator, betterAuthTokens, changesMigration, checkAi, checkAuthSchema, checkChanges, checkComments, checkComputed, checkJobsSchema, checkSourceNames, checkViewQueries, checkWebhooksSchema, coalesce, commentsMigration, computedMigration, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createFileCleanup, createOrganization, createUser, defaultAppName, defaultSignInPolicy, defineConfig, defineEmail, defineFunction, defineJob, defineTool, deleteUser, errorReportingSettings, errorReportingVariable, eventMatcher, fileConversationStore, fileSize, fileType, forbidden, formatUri, functionApp, handleDroppedConnections, hasUsers, imageSize, isBackgroundWork, isCaptured, isJobDefinition, isSchedule, issueToken, jobDefinitions, jobsDrainApp, jobsSchema, jobsSchemaMigration, jwtAuthenticator, jwtVerifier, limitedFileStore, listOrganizations, listUsers, localFileStore, localFiles, mapSettings, mapStyleUrl, mapStyleVariable, maxTokenTtlSeconds, maxWidgetPropsBytes, mergeConfig, migrationCommand, newWebhookSecret, normalizeRoles, notFound, parseColumns, parseRoles, pluginOptions, pluginsBeforeSignIn, pluginsFor, pluginsVariable, pngIcons, processor, readJson, readOnlyQueryTool, readOperatorSettings, readOutbox, readPlatformSignIn, readWriteQueryTool, recordOf, removeMember, renderVariant, requestApproval, requireEnv, resourceChange, roleChoices, runInBackground, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, s3FileStore, s3Files, seesAssistant, seesRuntime, setMemberRoles, setUserBanned, setUserRole, signInPolicyMethods, sourceOptions, sourcesFor, sourcesVariable, startErrorReporting, startJobs, storageCleanupSchedule, storeFile, streamChatCompletion, subscription, thumbHash, unauthorized, variantPath, verifySignature, verifyStandardWebhook, webauthnPath, webhooks, webhooksMigration, widget, withCacheBreakpoints, withTrustedApps };

package/dist/index.js

@@ -49,6 +49,7 @@ import { beforeSignInPluginsVariable, pluginOptions, pluginsBeforeSignIn, plugin
 import { runtimeUrl, runtimeVariable, seesRuntime } from "./runtime/runtime-settings.js";
 import { checkSourceNames, sourceOptions, sourcesFor, sourcesVariable } from "./sources/source-settings.js";
 import { renderVariant, thumbHash } from "./files/images.js";
+import { pngIcons } from "./web-app/app-icons.js";
 import { createAdmin } from "./create-admin.js";
 import { handleDroppedConnections } from "./dropped-connections.js";
 import { configExports } from "./resource-source.js";
@@ -74,4 +75,4 @@ import { aspectRatio, fileSize, fileType, imageSize, processor } from "./files/p
 import { defineEmail } from "./mail/define-email.js";
 import { startJobs } from "./jobs/runtime.js";
 import { jobsDrainApp } from "./jobs/drain-route.js";
-export { FatalJobError, HttpProblem, MissingCredentials, ModelError, addAppRoleToOwners, addMember, apiKeyCaller, apiKeySettings, apiKeyVariables, aspectRatio, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, authSchemaMigration, badRequest, beforeSignInPluginsVariable, betterAuthAuthenticator, betterAuthTokens, changesMigration, checkAi, checkAuthSchema, checkChanges, checkComments, checkComputed, checkJobsSchema, checkSourceNames, checkViewQueries, checkWebhooksSchema, coalesce, commentsMigration, computedMigration, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createFileCleanup, createOrganization, createUser, defaultAppName, defaultSignInPolicy, defineConfig, defineEmail, defineFunction, defineJob, defineTool, deleteUser, errorReportingSettings, errorReportingVariable, eventMatcher, fileConversationStore, fileSize, fileType, forbidden, formatUri, functionApp, handleDroppedConnections, hasUsers, imageSize, isBackgroundWork, isCaptured, isJobDefinition, isSchedule, issueToken, jobDefinitions, jobsDrainApp, jobsSchema, jobsSchemaMigration, jwtAuthenticator, jwtVerifier, limitedFileStore, listOrganizations, listUsers, localFileStore, localFiles, mapSettings, mapStyleUrl, mapStyleVariable, maxTokenTtlSeconds, maxWidgetPropsBytes, mergeConfig, migrationCommand, newWebhookSecret, normalizeRoles, notFound, parseColumns, parseRoles, pluginOptions, pluginsBeforeSignIn, pluginsFor, pluginsVariable, processor, readJson, readOnlyQueryTool, readOperatorSettings, readOutbox, readPlatformSignIn, readWriteQueryTool, recordOf, removeMember, renderVariant, requestApproval, requireEnv, resourceChange, roleChoices, runInBackground, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, s3FileStore, s3Files, seesAssistant, seesRuntime, setMemberRoles, setUserBanned, setUserRole, signInPolicyMethods, sourceOptions, sourcesFor, sourcesVariable, startErrorReporting, startJobs, storageCleanupSchedule, storeFile, streamChatCompletion, subscription, thumbHash, unauthorized, variantPath, verifySignature, verifyStandardWebhook, webauthnPath, webhooks, webhooksMigration, widget, withCacheBreakpoints, withTrustedApps };
+export { FatalJobError, HttpProblem, MissingCredentials, ModelError, addAppRoleToOwners, addMember, apiKeyCaller, apiKeySettings, apiKeyVariables, aspectRatio, assistantProtocolRoutes, assistantRoles, assistantSettings, assistantVariables, authSchemaMigration, badRequest, beforeSignInPluginsVariable, betterAuthAuthenticator, betterAuthTokens, changesMigration, checkAi, checkAuthSchema, checkChanges, checkComments, checkComputed, checkJobsSchema, checkSourceNames, checkViewQueries, checkWebhooksSchema, coalesce, commentsMigration, computedMigration, configExports, consoleAuditQueue, conversationKey, createAdmin, createAuth, createConversations, createFileCleanup, createOrganization, createUser, defaultAppName, defaultSignInPolicy, defineConfig, defineEmail, defineFunction, defineJob, defineTool, deleteUser, errorReportingSettings, errorReportingVariable, eventMatcher, fileConversationStore, fileSize, fileType, forbidden, formatUri, functionApp, handleDroppedConnections, hasUsers, imageSize, isBackgroundWork, isCaptured, isJobDefinition, isSchedule, issueToken, jobDefinitions, jobsDrainApp, jobsSchema, jobsSchemaMigration, jwtAuthenticator, jwtVerifier, limitedFileStore, listOrganizations, listUsers, localFileStore, localFiles, mapSettings, mapStyleUrl, mapStyleVariable, maxTokenTtlSeconds, maxWidgetPropsBytes, mergeConfig, migrationCommand, newWebhookSecret, normalizeRoles, notFound, parseColumns, parseRoles, pluginOptions, pluginsBeforeSignIn, pluginsFor, pluginsVariable, pngIcons, processor, readJson, readOnlyQueryTool, readOperatorSettings, readOutbox, readPlatformSignIn, readWriteQueryTool, recordOf, removeMember, renderVariant, requestApproval, requireEnv, resourceChange, roleChoices, runInBackground, runReadOnlyQuery, runReadWriteQuery, runTurn, runtimeUrl, runtimeVariable, s3FileStore, s3Files, seesAssistant, seesRuntime, setMemberRoles, setUserBanned, setUserRole, signInPolicyMethods, sourceOptions, sourcesFor, sourcesVariable, startErrorReporting, startJobs, storageCleanupSchedule, storeFile, streamChatCompletion, subscription, thumbHash, unauthorized, variantPath, verifySignature, verifyStandardWebhook, webauthnPath, webhooks, webhooksMigration, widget, withCacheBreakpoints, withTrustedApps };

package/dist/meta.js

@@ -28,7 +28,7 @@ const modelsHash = (deps) => sha256Hex(stableJson(deps.registry.entries.map((ent
 * they could use once signed in, which keep their place in the bottom bar and the user menu.
 * The ETag hashes all of it, so it differs per user and per roles.
 */
-const createMeta = (deps, appName) => {
+const createMeta = (deps, appName, appIcon) => {
 	const base = modelsHash(deps);
 	const forCaller = async (session) => {
 		const accesses = await Promise.all(deps.registry.entries.map((entry) => requestAccess(deps, entry, session)));
@@ -62,6 +62,7 @@ const createMeta = (deps, appName) => {
 		const sources = sourcesFor(deps.sources, session.user.roles);
 		const body = {
 			appName,
+			...appIcon && { appIcon },
 			resources: visible.map((access) => access.readable),
 			views,
 			pages,

package/dist/project-config.d.ts

@@ -1,4 +1,5 @@
 import { MobileConfig } from "./mobile-config.js";
+import { AppIdentity } from "./app-identity.js";
 import { AdminAuth } from "./better-auth/create-auth.js";
 import { EventsOptions } from "./changes/events-options.js";
 import { Authenticator } from "./types.js";
@@ -35,6 +36,8 @@ export type ProjectConfig = {
   jobs?: Record<string, unknown>;
   /** The app's iOS and Android build (see `MobileConfig`): `protobase mobile` needs it, and the API answers the app's origins. */
   mobile?: MobileConfig;
+  /** The installed app's colours (see `AppIdentity`), which its web manifest carries. */
+  app?: AppIdentity;
   options?: AdminOptions;
 };
 /** Typed identity, for `export default defineConfig({ extends: [...], config, auth, ... })` in `protobase.config.ts`. */

package/dist/project-config.js

@@ -143,14 +143,15 @@ const mergedOptions = (named) => {
 */
 const mergeConfig = (...configs) => {
 	const named = configs.flatMap((config, index) => flatten(config, config.name ?? `config ${index + 1}`));
-	const { db, authenticate, auth, events, history, webhooks, mobile } = lastSet(named.map(({ config }) => ({
+	const { db, authenticate, auth, events, history, webhooks, mobile, app } = lastSet(named.map(({ config }) => ({
 		db: config.db,
 		authenticate: config.authenticate,
 		auth: config.auth,
 		events: config.events,
 		history: config.history,
 		webhooks: config.webhooks,
-		mobile: config.mobile
+		mobile: config.mobile,
+		app: config.app
 	})));
 	const module = mergedModule(named);
 	const functions = mergedFunctions(named);
@@ -171,6 +172,7 @@ const mergeConfig = (...configs) => {
 		...webhooks && { webhooks },
 		...jobs && { jobs },
 		...mobile && { mobile },
+		...app && { app },
 		...options && { options }
 	};
 };

package/dist/web-app/app-icons.d.ts

@@ -0,0 +1,31 @@
+//#region src/web-app/app-icons.d.ts
+/**
+ * The PNG icons a project may put beside its `protobase.favicon.svg`, for platforms that take no SVG, each square at
+ * `size` pixels and answered on the app's own origin at `/<file>`: Android's 192 and 512 pixel icons, a 512 pixel
+ * maskable one whose mark keeps to the middle 80%, and the 180 pixel Apple touch icon an iPhone home screen shows.
+ */
+export declare const pngIcons: {
+  readonly icon192: {
+    readonly file: "protobase.icon-192.png";
+    readonly size: 192;
+  };
+  readonly icon512: {
+    readonly file: "protobase.icon-512.png";
+    readonly size: 512;
+  };
+  readonly maskable: {
+    readonly file: "protobase.icon-maskable.png";
+    readonly size: 512;
+  };
+  readonly appleTouch: {
+    readonly file: "protobase.apple-touch-icon.png";
+    readonly size: 180;
+  };
+};
+export type PngIcon = keyof typeof pngIcons;
+/** The icons a project has of its own: `favicon` when the favicon is its own rather than Protobase's, and its PNGs. */
+export type AppIcons = {
+  favicon: boolean;
+  png: PngIcon[];
+};
+//#endregion

package/dist/web-app/app-icons.js

@@ -0,0 +1,26 @@
+//#region src/web-app/app-icons.ts
+/**
+* The PNG icons a project may put beside its `protobase.favicon.svg`, for platforms that take no SVG, each square at
+* `size` pixels and answered on the app's own origin at `/<file>`: Android's 192 and 512 pixel icons, a 512 pixel
+* maskable one whose mark keeps to the middle 80%, and the 180 pixel Apple touch icon an iPhone home screen shows.
+*/
+const pngIcons = {
+	icon192: {
+		file: "protobase.icon-192.png",
+		size: 192
+	},
+	icon512: {
+		file: "protobase.icon-512.png",
+		size: 512
+	},
+	maskable: {
+		file: "protobase.icon-maskable.png",
+		size: 512
+	},
+	appleTouch: {
+		file: "protobase.apple-touch-icon.png",
+		size: 180
+	}
+};
+//#endregion
+export { pngIcons };

package/dist/web-app/web-manifest-route.js

@@ -4,9 +4,9 @@ import { Hono } from "hono";
 /** The path under the system path (`/api`) the admin app's page links its manifest at. */
 const webManifestPath = "/manifest.webmanifest";
 /** Answers the web app manifest to anyone: the browser fetches it without the user's token, before they sign in. */
-const webManifestRoute = (appName) => {
+const webManifestRoute = (appName, identity, icons) => {
 	const app = new Hono();
-	const body = JSON.stringify(webManifest(appName));
+	const body = JSON.stringify(webManifest(appName, identity, icons));
 	app.get(webManifestPath, () => new Response(body, { headers: {
 		"content-type": "application/manifest+json",
 		"cache-control": "no-cache"

package/dist/web-app/web-manifest.js

@@ -1,22 +1,41 @@
+import { pngIcons } from "./app-icons.js";
 //#region src/web-app/web-manifest.ts
 /** Where the app's favicon is on its own origin, which `protobase build` and `protobase dev` always answer. */
 const faviconPath = "/protobase.favicon.svg";
+const manifestIcons = {
+	icon192: "any",
+	icon512: "any",
+	maskable: "maskable"
+};
+const isManifestIcon = (icon) => icon in manifestIcons;
+const manifestIcon = (icon) => {
+	const { file, size } = pngIcons[icon];
+	return {
+		src: `/${file}`,
+		sizes: `${size}x${size}`,
+		type: "image/png",
+		...manifestIcons[icon] === "maskable" && { purpose: "maskable" }
+	};
+};
 /**
 * The web app manifest that makes the admin app installable: named for the app, opening at its home page in a window
-* of its own, with the favicon as its icon. An SVG with `sizes: "any"` meets Chrome's 192 and 512 pixel icon sizes.
+* of its own, with the favicon as its icon, the project's PNGs beside it and its colours when it has them. An SVG with
+* `sizes: "any"` meets Chrome's 192 and 512 pixel icon sizes; Safari and some Android launchers take only PNGs.
 */
-const webManifest = (appName) => ({
+const webManifest = (appName, { themeColor, backgroundColor } = {}, icons) => ({
 	name: appName,
 	short_name: appName,
 	id: "/",
 	start_url: "/",
 	scope: "/",
 	display: "standalone",
+	...themeColor && { theme_color: themeColor },
+	...backgroundColor && { background_color: backgroundColor },
 	icons: [{
 		src: faviconPath,
 		sizes: "any",
 		type: "image/svg+xml"
-	}]
+	}, ...(icons?.png ?? []).filter(isManifestIcon).map(manifestIcon)]
 });
 //#endregion
 export { faviconPath, webManifest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -32,9 +32,9 @@
   "dependencies": {
     "@better-auth/passkey": "^1.7.7",
     "@better-auth/sso": "^1.7.7",
-    "@protobase/layout": "0.27.0",
-    "@protobase/query": "0.27.0",
-    "@protobase/schema": "0.27.0",
+    "@protobase/layout": "0.28.0",
+    "@protobase/query": "0.28.0",
+    "@protobase/schema": "0.28.0",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",