@protobase/server 0.48.0 → 0.49.1

package/dist/webhooks/table/webhooks-module.d.ts

@@ -0,0 +1,108 @@
+import { WebhooksOptions } from "./options.js";
+//#region src/webhooks/table/webhooks-module.d.ts
+/**
+ * What `webhooks` in `protobase.config.ts` adds to the app's resources: the Webhook subscriptions and Webhook deliveries
+ * pages, over a `webhooks` schema that `protobase migration` writes, and the delivery log with `deliveryLog`. Who may
+ * create subscriptions is the resources' access (`webhook_subscriptions.create`, ...); each delivers as its owner.
+ */
+export declare const webhooksModule: (options?: WebhooksOptions) => {
+  webhookDeliveryLog?: import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly subscription_id: import("@protobase/schema").Field<string | number>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly event_id: import("@protobase/schema").Field<string>;
+    readonly event_type: import("@protobase/schema").Field<string>;
+    readonly status: import("@protobase/schema").Field<"failed" | "delivered">;
+    readonly attempt: import("@protobase/schema").Field<number>;
+    readonly status_code: import("@protobase/schema").Field<number | null>;
+    readonly response: import("@protobase/schema").Field<string | null>;
+    readonly duration_ms: import("@protobase/schema").Field<number>;
+    readonly at: import("@protobase/schema").Field<string>;
+  }, import("@protobase/schema").Ref<"id", string>> | undefined;
+  webhookDeliveryLogView?: import("@protobase/schema").ViewBuilder<import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly subscription_id: import("@protobase/schema").Field<string | number>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly event_id: import("@protobase/schema").Field<string>;
+    readonly event_type: import("@protobase/schema").Field<string>;
+    readonly status: import("@protobase/schema").Field<"failed" | "delivered">;
+    readonly attempt: import("@protobase/schema").Field<number>;
+    readonly status_code: import("@protobase/schema").Field<number | null>;
+    readonly response: import("@protobase/schema").Field<string | null>;
+    readonly duration_ms: import("@protobase/schema").Field<number>;
+    readonly at: import("@protobase/schema").Field<string>;
+  }, import("@protobase/schema").Ref<"id", string>>> | undefined;
+  webhookSubscriptions: import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly name: import("@protobase/schema").Field<string>;
+    readonly events: import("@protobase/schema").Field<string>;
+    readonly url: import("@protobase/schema").Field<string>;
+    readonly filter: import("@protobase/schema").Field<string | null>;
+    readonly headers: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly payload: import("@protobase/schema").Field<"full" | "thin">;
+    readonly enabled: import("@protobase/schema").Field<boolean>;
+    readonly secret: import("@protobase/schema").Field<string>;
+    readonly previous_secret: null;
+    readonly previous_secret_until: null;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly owner_id: import("@protobase/schema").Field<string | null>;
+    readonly disabled_reason: import("@protobase/schema").Field<string | null>;
+    readonly last_success_at: import("@protobase/schema").Field<string | null>;
+    readonly failing_since: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly updated_at: import("@protobase/schema").Field<string>;
+    readonly rotate_secret: import("@protobase/schema").Field<boolean>;
+    readonly send_test: import("@protobase/schema").Field<boolean>;
+    readonly resend_failed: import("@protobase/schema").Field<boolean>;
+  }, import("@protobase/schema").Ref<"id", string>>;
+  webhookSubscriptionsView: import("@protobase/schema").ViewBuilder<import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly name: import("@protobase/schema").Field<string>;
+    readonly events: import("@protobase/schema").Field<string>;
+    readonly url: import("@protobase/schema").Field<string>;
+    readonly filter: import("@protobase/schema").Field<string | null>;
+    readonly headers: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly payload: import("@protobase/schema").Field<"full" | "thin">;
+    readonly enabled: import("@protobase/schema").Field<boolean>;
+    readonly secret: import("@protobase/schema").Field<string>;
+    readonly previous_secret: null;
+    readonly previous_secret_until: null;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly owner_id: import("@protobase/schema").Field<string | null>;
+    readonly disabled_reason: import("@protobase/schema").Field<string | null>;
+    readonly last_success_at: import("@protobase/schema").Field<string | null>;
+    readonly failing_since: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly updated_at: import("@protobase/schema").Field<string>;
+    readonly rotate_secret: import("@protobase/schema").Field<boolean>;
+    readonly send_test: import("@protobase/schema").Field<boolean>;
+    readonly resend_failed: import("@protobase/schema").Field<boolean>;
+  }, import("@protobase/schema").Ref<"id", string>>>;
+  webhookDeliveries: import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly subscription_id: import("@protobase/schema").Field<string | number>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly event_type: import("@protobase/schema").Field<string>;
+    readonly event_id: import("@protobase/schema").Field<string>;
+    readonly status: import("@protobase/schema").Field<"waiting" | "failed">;
+    readonly attempt: import("@protobase/schema").Field<number>;
+    readonly next_attempt: import("@protobase/schema").Field<string | null>;
+    readonly last_error: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly resend: import("@protobase/schema").Field<boolean>;
+  }, import("@protobase/schema").Ref<"id", string>>;
+  webhookDeliveriesView: import("@protobase/schema").ViewBuilder<import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly subscription_id: import("@protobase/schema").Field<string | number>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly event_type: import("@protobase/schema").Field<string>;
+    readonly event_id: import("@protobase/schema").Field<string>;
+    readonly status: import("@protobase/schema").Field<"waiting" | "failed">;
+    readonly attempt: import("@protobase/schema").Field<number>;
+    readonly next_attempt: import("@protobase/schema").Field<string | null>;
+    readonly last_error: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly resend: import("@protobase/schema").Field<boolean>;
+  }, import("@protobase/schema").Ref<"id", string>>>;
+};
+//#endregion

package/dist/webhooks/table/webhooks-module.js

@@ -0,0 +1,11 @@
+import { webhooksSchema } from "./options.js";
+import { webhookResources } from "@protobase/schema/internal";
+//#region src/webhooks/table/webhooks-module.ts
+/**
+* What `webhooks` in `protobase.config.ts` adds to the app's resources: the Webhook subscriptions and Webhook deliveries
+* pages, over a `webhooks` schema that `protobase migration` writes, and the delivery log with `deliveryLog`. Who may
+* create subscriptions is the resources' access (`webhook_subscriptions.create`, ...); each delivers as its owner.
+*/
+const webhooksModule = (options = {}) => webhookResources(webhooksSchema(options), { deliveryLog: Boolean(options.deliveryLog) });
+//#endregion
+export { webhooksModule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.48.0",
+  "version": "0.49.1",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -19,7 +19,8 @@
     "./auth-store": "./dist/auth-store.js",
     "./config-exports": "./dist/config-exports.js",
     "./email": "./dist/email.js",
-    "./vapid": "./dist/vapid.js"
+    "./vapid": "./dist/vapid.js",
+    "./internal": "./dist/internal.js"
   },
   "types": "./dist/index.d.ts",
   "files": [
@@ -39,9 +40,9 @@
     "@better-auth/passkey": "^1.7.12",
     "@better-auth/sso": "^1.7.12",
     "@modelcontextprotocol/server": "^2.3.1",
-    "@protobase/layout": "0.48.0",
-    "@protobase/query": "0.48.0",
-    "@protobase/schema": "0.48.0",
+    "@protobase/layout": "0.49.1",
+    "@protobase/query": "0.49.1",
+    "@protobase/schema": "0.49.1",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@sentry/core": "^11.7.0",

package/dist/notifications/plugin.d.ts

@@ -1,13 +0,0 @@
-import { NotificationsOptions } from "./options.js";
-import { ProjectConfig } from "../project-config.js";
-//#region src/notifications/plugin.d.ts
-/**
- * Notifications: `extends: [notifications()]` in `protobase.config.ts`. It keeps each user's devices, in the
- * `notifications.devices` table that `protobase migration` writes or in the `store` given, and serves the endpoints
- * through which a signed-in user registers and removes their own (`devicesPath`). It keeps each user's inbox
- * notifications in the `notifications.history` table or the `historyStore` given, and serves the endpoints through which
- * a signed-in user lists theirs and marks them read (`historyPath`). It delivers through `senders`, by default the
- * built-in ones whose environment is set (see `notificationSenders`).
- */
-export declare const notifications: (options?: NotificationsOptions) => ProjectConfig;
-//#endregion

package/dist/notifications/plugin.js

@@ -1,16 +0,0 @@
-import { checkNotificationsOptions } from "./options.js";
-//#region src/notifications/plugin.ts
-/**
-* Notifications: `extends: [notifications()]` in `protobase.config.ts`. It keeps each user's devices, in the
-* `notifications.devices` table that `protobase migration` writes or in the `store` given, and serves the endpoints
-* through which a signed-in user registers and removes their own (`devicesPath`). It keeps each user's inbox
-* notifications in the `notifications.history` table or the `historyStore` given, and serves the endpoints through which
-* a signed-in user lists theirs and marks them read (`historyPath`). It delivers through `senders`, by default the
-* built-in ones whose environment is set (see `notificationSenders`).
-*/
-const notifications = (options = {}) => ({
-	name: "protobase-notifications",
-	notifications: checkNotificationsOptions(options)
-});
-//#endregion
-export { notifications };

package/dist/project-config.d.ts

@@ -1,54 +0,0 @@
-import { MobileConfig } from "./mobile-config.js";
-import { AppIdentity } from "./app-identity.js";
-import { EventsOptions } from "./changes/events-options.js";
-import { Authenticator } from "./types.js";
-import { HistoryOptions } from "./history/options.js";
-import { WebhooksOptions } from "./webhooks/table/options.js";
-import { NotificationsOptions } from "./notifications/options.js";
-import { FilesOptions } from "./files/options.js";
-import { FunctionSource } from "./functions/define-function.js";
-import { AdminOptions } from "./admin-options.js";
-import { AdminAuth } from "./better-auth/create-auth.js";
-import { Db } from "@protobase/query";
-//#region src/project-config.d.ts
-/** What `protobase.config.ts` may default-export. Everything is optional. */
-export type ProjectConfig = {
-  /** Names the config in errors, such as two configs defining the same tool; an extension should set it. */
-  name?: string;
-  /** Configs this one extends: merged in order before it (see `mergeConfig`). */
-  extends?: ProjectConfig[];
-  /** The config module, e.g. `import * as config from './config'`; default: ./config/index.ts and ./config/*\/ui.ts. */
-  config?: Record<string, unknown>;
-  db?: Db;
-  authenticate?: Authenticator;
-  /** A Better Auth instance; createAdmin mounts its routes under /api/auth. */
-  auth?: AdminAuth;
-  /** The API functions, each served at `/api/functions/<name>`; default: one per file in ./functions. */
-  functions?: Record<string, FunctionSource>;
-  /** Where file fields keep their bytes: providers by name, retention and the signing secret (see `FilesOptions`). */
-  files?: FilesOptions;
-  /** Where the changes that resources' events are raised from are captured (see `EventsOptions`). */
-  events?: EventsOptions;
-  /** How long the history of resources with `.history()` is kept (see `HistoryOptions`). */
-  history?: HistoryOptions;
-  /** Webhook subscriptions made in the admin app; set by `extends: [webhooks()]` (see `WebhooksOptions`). */
-  webhooks?: WebhooksOptions;
-  /** Notifications and each user's devices; set by `extends: [notifications()]` (see `NotificationsOptions`). */
-  notifications?: NotificationsOptions;
-  /** The module of the app's jobs, e.g. `import * as jobs from './config/jobs'`: every `defineJob` it exports. */
-  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`. */
-export declare const defineConfig: (config: ProjectConfig) => ProjectConfig;
-/**
- * One config from several, each after the ones it `extends`, the last being the app's own. Named things are all kept:
- * resources, views and pages of the config modules, functions, jobs, assistant tools, file providers; one name defined by two configs is an error naming
- * both. Write hooks run in the same order. Every other value is the last config's that sets it, so the app's own wins.
- */
-export declare const mergeConfig: (...configs: ProjectConfig[]) => ProjectConfig;
-//#endregion

package/dist/project-config.js

@@ -1,182 +0,0 @@
-import { jobDefinitions } from "./jobs/define-job.js";
-import { isSubscription } from "./webhooks/subscription.js";
-import { isPageDefinition } from "@protobase/layout";
-//#region src/project-config.ts
-/** Typed identity, for `export default defineConfig({ extends: [...], config, auth, ... })` in `protobase.config.ts`. */
-const defineConfig = (config) => config;
-const lastSet = (objects) => Object.fromEntries(objects.flatMap((object) => Object.entries(object)).filter(([, value]) => value !== void 0));
-const flatten = (config, label) => [...(config.extends ?? []).flatMap((parent, index) => flatten(parent, parent.name ?? `${label} extends[${index}]`)), {
-	config,
-	label
-}];
-const checkUnique = (kind, entries) => {
-	const seen = /* @__PURE__ */ new Map();
-	for (const { name, value, label } of entries) {
-		const first = seen.get(name);
-		if (first && first.value !== value) throw new Error(`${kind} "${name}" is defined twice, ${first.label === label ? `in ${label}` : `by ${first.label} and by ${label}`}; rename one of them`);
-		if (!first) seen.set(name, {
-			value,
-			label
-		});
-	}
-};
-const mergedModule = (named) => {
-	const withModule = named.filter(({ config }) => config.config);
-	if (withModule.length === 0) return void 0;
-	const exports = withModule.flatMap(({ config, label }) => Object.entries(config.config).map(([key, value]) => ({
-		key,
-		value,
-		label
-	})));
-	const values = exports.map((entry) => ({
-		...entry,
-		value: entry.value
-	}));
-	checkUnique("The resource", values.filter(({ value }) => typeof value?.recordSchema === "function" && typeof value.toModel === "function").map(({ value, label }) => ({
-		name: String(value.toModel().name),
-		value,
-		label
-	})));
-	checkUnique("The page", exports.filter(({ value }) => isPageDefinition(value)).map(({ value, label }) => ({
-		name: value.name,
-		value,
-		label
-	})));
-	checkUnique("The subscription", exports.filter(({ value }) => isSubscription(value)).map(({ value, label }) => ({
-		name: value.name,
-		value,
-		label
-	})));
-	const menus = values.filter(({ value }) => typeof value?.toUserMenuModel === "function");
-	if (new Set(menus.map(({ value }) => value)).size > 1) throw new Error(`Only one config may export a user menu; ${menus.map(({ label }) => label).join(" and ")} each do`);
-	const module = {};
-	const own = withModule.at(-1).label;
-	for (const { key, value, label } of exports) {
-		if (Object.values(module).includes(value)) continue;
-		module[label === own ? key : `${label}:${key}`] = value;
-	}
-	return module;
-};
-const mergedAssistant = (named) => {
-	const options = named.map(({ config, label }) => ({
-		assistant: config.options?.assistant,
-		label
-	})).filter(({ assistant }) => assistant !== void 0);
-	if (options.length === 0) return void 0;
-	if (options.at(-1).assistant === false) return false;
-	const after = options.slice(options.findLastIndex(({ assistant }) => assistant === false) + 1);
-	const tools = after.flatMap(({ assistant, label }) => (assistant.tools ?? []).map((tool) => ({
-		tool,
-		label
-	})));
-	checkUnique("The assistant tool", tools.map(({ tool, label }) => ({
-		name: tool.name,
-		value: tool,
-		label
-	})));
-	return {
-		...lastSet(after.map(({ assistant }) => assistant)),
-		...tools.length > 0 && { tools: tools.map(({ tool }) => tool) }
-	};
-};
-const mergedFunctions = (named) => {
-	const all = named.flatMap(({ config, label }) => Object.entries(config.functions ?? {}).map(([name, value]) => ({
-		name,
-		value,
-		label
-	})));
-	if (all.length === 0) return void 0;
-	checkUnique("The function", all);
-	return Object.fromEntries(all.map(({ name, value }) => [name, value]));
-};
-const mergedFiles = (named) => {
-	const all = named.flatMap(({ config, label }) => config.files ? [{
-		files: config.files,
-		label
-	}] : []);
-	if (all.length === 0) return void 0;
-	const providers = all.flatMap(({ files, label }) => Object.entries(files.providers ?? {}).map(([name, value]) => ({
-		name,
-		value,
-		label
-	})));
-	checkUnique("The file provider", providers);
-	const trustedHosts = [...new Set(all.flatMap(({ files }) => files.trustedHosts ?? []))];
-	const { retention, secret, sharp } = lastSet(all.map(({ files }) => ({
-		retention: files.retention,
-		secret: files.secret,
-		sharp: files.sharp
-	})));
-	return {
-		...providers.length > 0 && { providers: Object.fromEntries(providers.map(({ name, value }) => [name, value])) },
-		...retention !== void 0 && { retention },
-		...secret !== void 0 && { secret },
-		...sharp !== void 0 && { sharp },
-		...trustedHosts.length > 0 && { trustedHosts }
-	};
-};
-const mergedJobs = (named) => {
-	const all = named.flatMap(({ config, label }) => jobDefinitions(config.jobs ?? {}).map((value) => ({
-		name: value.name,
-		value,
-		label
-	})));
-	if (all.length === 0) return void 0;
-	checkUnique("The job", all);
-	return Object.fromEntries(all.map(({ name, value }) => [name, value]));
-};
-const mergedOptions = (named) => {
-	const all = named.flatMap(({ config }) => config.options ? [config.options] : []);
-	if (all.length === 0) return void 0;
-	const writeHooks = all.flatMap((options) => options.writeHooks ?? []);
-	const assistant = mergedAssistant(named);
-	return {
-		...lastSet(all),
-		...writeHooks.length > 0 && { writeHooks },
-		...assistant !== void 0 && { assistant }
-	};
-};
-/**
-* One config from several, each after the ones it `extends`, the last being the app's own. Named things are all kept:
-* resources, views and pages of the config modules, functions, jobs, assistant tools, file providers; one name defined by two configs is an error naming
-* both. Write hooks run in the same order. Every other value is the last config's that sets it, so the app's own wins.
-*/
-const mergeConfig = (...configs) => {
-	const named = configs.flatMap((config, index) => flatten(config, config.name ?? `config ${index + 1}`));
-	const { db, authenticate, auth, events, history, webhooks, notifications, mobile, app } = lastSet(named.map(({ config }) => ({
-		db: config.db,
-		authenticate: config.authenticate,
-		auth: config.auth,
-		events: config.events,
-		history: config.history,
-		webhooks: config.webhooks,
-		notifications: config.notifications,
-		mobile: config.mobile,
-		app: config.app
-	})));
-	const module = mergedModule(named);
-	const functions = mergedFunctions(named);
-	const files = mergedFiles(named);
-	const jobs = mergedJobs(named);
-	const options = mergedOptions(named);
-	const name = configs.at(-1)?.name;
-	return {
-		...name && { name },
-		...module && { config: module },
-		...db && { db },
-		...authenticate && { authenticate },
-		...auth && { auth },
-		...functions && { functions },
-		...files && { files },
-		...events && { events },
-		...history && { history },
-		...webhooks && { webhooks },
-		...notifications && { notifications },
-		...jobs && { jobs },
-		...mobile && { mobile },
-		...app && { app },
-		...options && { options }
-	};
-};
-//#endregion
-export { defineConfig, mergeConfig };

package/dist/webhooks/table/plugin.d.ts

@@ -1,10 +0,0 @@
-import { WebhooksOptions } from "./options.js";
-import { ProjectConfig } from "../../project-config.js";
-//#region src/webhooks/table/plugin.d.ts
-/**
- * Webhook subscriptions made in the admin app: `extends: [webhooks()]` in `protobase.config.ts`. It adds the Webhook
- * subscriptions and Webhook deliveries pages, over a `webhooks` schema that `protobase migration` writes. Who may
- * create subscriptions is the resources' access (`webhook_subscriptions.create`, ...); each delivers as its owner.
- */
-export declare const webhooks: (options?: WebhooksOptions) => ProjectConfig;
-//#endregion

package/dist/webhooks/table/plugin.js

@@ -1,18 +0,0 @@
-import { webhooksSchema } from "./options.js";
-import { webhookResources } from "@protobase/schema/internal";
-//#region src/webhooks/table/plugin.ts
-/**
-* Webhook subscriptions made in the admin app: `extends: [webhooks()]` in `protobase.config.ts`. It adds the Webhook
-* subscriptions and Webhook deliveries pages, over a `webhooks` schema that `protobase migration` writes. Who may
-* create subscriptions is the resources' access (`webhook_subscriptions.create`, ...); each delivers as its owner.
-*/
-const webhooks = (options = {}) => {
-	const schema = webhooksSchema(options);
-	return {
-		name: "protobase-webhooks",
-		config: webhookResources(schema, { deliveryLog: Boolean(options.deliveryLog) }),
-		webhooks: options
-	};
-};
-//#endregion
-export { webhooks };