@protobase/schema 0.9.0 → 0.11.0

package/dist/webhooks/webhook-resources.d.ts

@@ -13,28 +13,28 @@ export declare const webhookResources: (schema: string, { deliveryLog }?: {
 }) => {
   webhookDeliveryLog?: ResourceBuilder<{
     readonly id: Field<string>;
-    readonly subscriptionId: Field<string | number>;
-    readonly tenantId: Field<string | null>;
-    readonly eventId: Field<string>;
-    readonly eventType: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_id: Field<string>;
+    readonly event_type: Field<string>;
     readonly status: Field<"failed" | "delivered">;
     readonly attempt: Field<number>;
-    readonly statusCode: Field<number | null>;
+    readonly status_code: Field<number | null>;
     readonly response: Field<string | null>;
-    readonly durationMs: Field<number>;
+    readonly duration_ms: Field<number>;
     readonly at: Field<string>;
   }, Ref<"id", string>> | undefined;
   webhookDeliveryLogView?: ViewBuilder<ResourceBuilder<{
     readonly id: Field<string>;
-    readonly subscriptionId: Field<string | number>;
-    readonly tenantId: Field<string | null>;
-    readonly eventId: Field<string>;
-    readonly eventType: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_id: Field<string>;
+    readonly event_type: Field<string>;
     readonly status: Field<"failed" | "delivered">;
     readonly attempt: Field<number>;
-    readonly statusCode: Field<number | null>;
+    readonly status_code: Field<number | null>;
     readonly response: Field<string | null>;
-    readonly durationMs: Field<number>;
+    readonly duration_ms: Field<number>;
     readonly at: Field<string>;
   }, Ref<"id", string>>> | undefined;
   webhookSubscriptions: ResourceBuilder<{
@@ -47,18 +47,18 @@ export declare const webhookResources: (schema: string, { deliveryLog }?: {
     readonly payload: Field<"full" | "thin">;
     readonly enabled: Field<boolean>;
     readonly secret: Field<string>;
-    readonly previousSecret: null;
-    readonly previousSecretUntil: null;
-    readonly tenantId: Field<string | null>;
-    readonly ownerId: Field<string | null>;
-    readonly disabledReason: Field<string | null>;
-    readonly lastSuccessAt: Field<string | null>;
-    readonly failingSince: Field<string | null>;
-    readonly createdAt: Field<string>;
-    readonly updatedAt: Field<string>;
-    readonly rotateSecret: Field<boolean>;
-    readonly sendTest: Field<boolean>;
-    readonly resendFailed: Field<boolean>;
+    readonly previous_secret: null;
+    readonly previous_secret_until: null;
+    readonly tenant_id: Field<string | null>;
+    readonly owner_id: Field<string | null>;
+    readonly disabled_reason: Field<string | null>;
+    readonly last_success_at: Field<string | null>;
+    readonly failing_since: Field<string | null>;
+    readonly created_at: Field<string>;
+    readonly updated_at: Field<string>;
+    readonly rotate_secret: Field<boolean>;
+    readonly send_test: Field<boolean>;
+    readonly resend_failed: Field<boolean>;
   }, Ref<"id", string>>;
   webhookSubscriptionsView: ViewBuilder<ResourceBuilder<{
     readonly id: Field<string>;
@@ -70,43 +70,43 @@ export declare const webhookResources: (schema: string, { deliveryLog }?: {
     readonly payload: Field<"full" | "thin">;
     readonly enabled: Field<boolean>;
     readonly secret: Field<string>;
-    readonly previousSecret: null;
-    readonly previousSecretUntil: null;
-    readonly tenantId: Field<string | null>;
-    readonly ownerId: Field<string | null>;
-    readonly disabledReason: Field<string | null>;
-    readonly lastSuccessAt: Field<string | null>;
-    readonly failingSince: Field<string | null>;
-    readonly createdAt: Field<string>;
-    readonly updatedAt: Field<string>;
-    readonly rotateSecret: Field<boolean>;
-    readonly sendTest: Field<boolean>;
-    readonly resendFailed: Field<boolean>;
+    readonly previous_secret: null;
+    readonly previous_secret_until: null;
+    readonly tenant_id: Field<string | null>;
+    readonly owner_id: Field<string | null>;
+    readonly disabled_reason: Field<string | null>;
+    readonly last_success_at: Field<string | null>;
+    readonly failing_since: Field<string | null>;
+    readonly created_at: Field<string>;
+    readonly updated_at: Field<string>;
+    readonly rotate_secret: Field<boolean>;
+    readonly send_test: Field<boolean>;
+    readonly resend_failed: Field<boolean>;
   }, Ref<"id", string>>>;
   webhookDeliveries: ResourceBuilder<{
     readonly id: Field<string>;
-    readonly subscriptionId: Field<string | number>;
-    readonly tenantId: Field<string | null>;
-    readonly eventType: Field<string>;
-    readonly eventId: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_type: Field<string>;
+    readonly event_id: Field<string>;
     readonly status: Field<"waiting" | "failed">;
     readonly attempt: Field<number>;
-    readonly nextAttempt: Field<string | null>;
-    readonly lastError: Field<string | null>;
-    readonly createdAt: Field<string>;
+    readonly next_attempt: Field<string | null>;
+    readonly last_error: Field<string | null>;
+    readonly created_at: Field<string>;
     readonly resend: Field<boolean>;
   }, Ref<"id", string>>;
   webhookDeliveriesView: ViewBuilder<ResourceBuilder<{
     readonly id: Field<string>;
-    readonly subscriptionId: Field<string | number>;
-    readonly tenantId: Field<string | null>;
-    readonly eventType: Field<string>;
-    readonly eventId: Field<string>;
+    readonly subscription_id: Field<string | number>;
+    readonly tenant_id: Field<string | null>;
+    readonly event_type: Field<string>;
+    readonly event_id: Field<string>;
     readonly status: Field<"waiting" | "failed">;
     readonly attempt: Field<number>;
-    readonly nextAttempt: Field<string | null>;
-    readonly lastError: Field<string | null>;
-    readonly createdAt: Field<string>;
+    readonly next_attempt: Field<string | null>;
+    readonly last_error: Field<string | null>;
+    readonly created_at: Field<string>;
     readonly resend: Field<boolean>;
   }, Ref<"id", string>>>;
 };

package/dist/webhooks/webhook-resources.js

@@ -4,7 +4,7 @@ import { layout } from "../layout.js";
 import { view } from "../view.js";
 //#region src/webhooks/webhook-resources.ts
 /** Webhook subscriptions: a row per subscription someone made in the admin app, scoped to their tenant. */
-const subscriptionsResource = (schema) => resource("webhookSubscriptions").table(`${schema}.subscriptions`).fields({
+const subscriptionsResource = (schema) => resource("webhook_subscriptions").table(`${schema}.subscriptions`).fields({
 	id: f.uuid().readOnly().dbDefault(),
 	name: f.text().min(1).max(100).filterable().sortable(),
 	events: f.text().min(1).max(2e3),
@@ -14,20 +14,20 @@ const subscriptionsResource = (schema) => resource("webhookSubscriptions").table
 	payload: f.enum(["full", "thin"]).default("full"),
 	enabled: f.boolean().default(true).filterable(),
 	secret: f.text().sensitive().readOnly().dbDefault(),
-	previousSecret: null,
-	previousSecretUntil: null,
-	tenantId: f.text().optional().readOnly(),
-	ownerId: f.text().optional().readOnly().dbDefault(),
-	disabledReason: f.text().optional().readOnly(),
-	lastSuccessAt: f.timestamp().optional().readOnly().sortable(),
-	failingSince: f.timestamp().optional().readOnly(),
-	createdAt: f.timestamp().readOnly().dbDefault().sortable(),
-	updatedAt: f.timestamp().readOnly().dbDefault(),
-	rotateSecret: f.boolean().default(false),
-	sendTest: f.boolean().default(false),
-	resendFailed: f.boolean().default(false)
-}).primaryKey((r) => r.id).tenant((r) => r.tenantId).owner((r) => r.ownerId).search((r) => [r.name, r.url]);
-const subscriptionsView = view("webhookSubscriptions").names({
+	previous_secret: null,
+	previous_secret_until: null,
+	tenant_id: f.text().optional().readOnly(),
+	owner_id: f.text().optional().readOnly().dbDefault(),
+	disabled_reason: f.text().optional().readOnly(),
+	last_success_at: f.timestamp().optional().readOnly().sortable(),
+	failing_since: f.timestamp().optional().readOnly(),
+	created_at: f.timestamp().readOnly().dbDefault().sortable(),
+	updated_at: f.timestamp().readOnly().dbDefault(),
+	rotate_secret: f.boolean().default(false),
+	send_test: f.boolean().default(false),
+	resend_failed: f.boolean().default(false)
+}).primaryKey((r) => r.id).tenant((r) => r.tenant_id).owner((r) => r.owner_id).search((r) => [r.name, r.url]);
+const subscriptionsView = view("webhook_subscriptions").names({
 	singular: "Webhook subscription",
 	plural: "Webhook subscriptions"
 }).icon("webhook").title((r) => r.name).help("Sends the app's events to a URL as they happen, signed with Standard Webhooks. It delivers as its owner: only the records and fields they may read.").fields((r) => ({
@@ -40,18 +40,18 @@ const subscriptionsView = view("webhookSubscriptions").names({
 		thin: "Thin"
 	}),
 	secret: r.secret.help("Receivers check the webhook-signature header with it"),
-	disabledReason: r.disabledReason.label("Disabled because"),
-	lastSuccessAt: r.lastSuccessAt.label("Last success"),
-	failingSince: r.failingSince.label("Failing since")
+	disabled_reason: r.disabled_reason.label("Disabled because"),
+	last_success_at: r.last_success_at.label("Last success"),
+	failing_since: r.failing_since.label("Failing since")
 })).list((r) => ({
 	columns: [
 		r.name,
 		r.events,
 		r.url,
 		r.enabled,
-		r.lastSuccessAt
+		r.last_success_at
 	],
-	sort: [[r.createdAt, "desc"]]
+	sort: [[r.created_at, "desc"]]
 })).layout((r) => [
 	layout.section("Subscription", [
 		r.name,
@@ -64,38 +64,38 @@ const subscriptionsView = view("webhookSubscriptions").names({
 	]),
 	layout.section("Signing", [r.secret]),
 	layout.sidebar([
-		r.lastSuccessAt,
-		r.failingSince,
-		r.disabledReason,
-		r.createdAt
+		r.last_success_at,
+		r.failing_since,
+		r.disabled_reason,
+		r.created_at
 	]),
 	layout.related("Waiting and failed deliveries", {
-		resource: "webhookDeliveries",
-		field: "subscriptionId",
+		resource: "webhook_deliveries",
+		field: "subscription_id",
 		columns: [
-			"eventType",
+			"event_type",
 			"status",
 			"attempt",
-			"nextAttempt",
-			"lastError"
+			"next_attempt",
+			"last_error"
 		]
 	})
 ]).actions((a) => [
-	a.update("sendTest", {
+	a.update("send_test", {
 		label: "Send test event",
 		icon: "send",
-		set: { sendTest: true }
+		set: { send_test: true }
 	}),
-	a.update("resendFailed", {
+	a.update("resend_failed", {
 		label: "Resend failed",
 		icon: "rotate-ccw",
-		set: { resendFailed: true },
+		set: { resend_failed: true },
 		confirm: "Try every failed delivery of this subscription once more?"
 	}),
-	a.update("rotateSecret", {
+	a.update("rotate_secret", {
 		label: "Rotate secret",
 		icon: "key-round",
-		set: { rotateSecret: true },
+		set: { rotate_secret: true },
 		confirm: "Make a new secret? The old one keeps signing too for 24 hours."
 	}),
 	a.update("disable", {
@@ -105,51 +105,51 @@ const subscriptionsView = view("webhookSubscriptions").names({
 	})
 ]);
 /** The deliveries of webhook subscriptions that wait for a retry or failed for good: delivery jobs, not a table. */
-const deliveriesResource = (schema) => resource("webhookDeliveries").table(`${schema}.deliveries`).fields({
+const deliveriesResource = (schema) => resource("webhook_deliveries").table(`${schema}.deliveries`).fields({
 	id: f.uuid().readOnly(),
-	subscriptionId: f.relation("webhookSubscriptions").readOnly().filterable(),
-	tenantId: f.text().optional().readOnly(),
-	eventType: f.text().readOnly().filterable().sortable(),
-	eventId: f.text().readOnly().filterable(),
+	subscription_id: f.relation("webhook_subscriptions").readOnly().filterable(),
+	tenant_id: f.text().optional().readOnly(),
+	event_type: f.text().readOnly().filterable().sortable(),
+	event_id: f.text().readOnly().filterable(),
 	status: f.enum(["waiting", "failed"]).readOnly().filterable(),
 	attempt: f.integer().readOnly(),
-	nextAttempt: f.timestamp().optional().readOnly().sortable(),
-	lastError: f.text().optional().readOnly(),
-	createdAt: f.timestamp().readOnly().sortable(),
+	next_attempt: f.timestamp().optional().readOnly().sortable(),
+	last_error: f.text().optional().readOnly(),
+	created_at: f.timestamp().readOnly().sortable(),
 	resend: f.boolean()
-}).primaryKey((r) => r.id).tenant((r) => r.tenantId).access({
+}).primaryKey((r) => r.id).tenant((r) => r.tenant_id).access({
 	create: () => false,
 	delete: () => false
 });
-const deliveriesView = view("webhookDeliveries").names({
+const deliveriesView = view("webhook_deliveries").names({
 	singular: "Webhook delivery",
 	plural: "Webhook deliveries"
-}).icon("send").title((r) => r.eventType).help("Deliveries that wait for their next try or failed for good. A delivery leaves the list once it succeeds.").fields((r) => ({
-	eventType: r.eventType.label("Event"),
-	eventId: r.eventId.label("Event id").format("code"),
-	nextAttempt: r.nextAttempt.label("Next try"),
-	lastError: r.lastError.label("Last error"),
+}).icon("send").title((r) => r.event_type).help("Deliveries that wait for their next try or failed for good. A delivery leaves the list once it succeeds.").fields((r) => ({
+	event_type: r.event_type.label("Event"),
+	event_id: r.event_id.label("Event id").format("code"),
+	next_attempt: r.next_attempt.label("Next try"),
+	last_error: r.last_error.label("Last error"),
 	attempt: r.attempt.label("Tries")
 })).list((r) => ({
 	columns: [
-		r.eventType,
-		r.subscriptionId,
+		r.event_type,
+		r.subscription_id,
 		r.status,
 		r.attempt,
-		r.nextAttempt,
-		r.lastError
+		r.next_attempt,
+		r.last_error
 	],
-	sort: [[r.createdAt, "desc"]]
+	sort: [[r.created_at, "desc"]]
 })).layout((r) => [layout.section("Delivery", [
-	r.subscriptionId,
-	r.eventType,
-	r.eventId,
-	r.lastError
+	r.subscription_id,
+	r.event_type,
+	r.event_id,
+	r.last_error
 ]), layout.sidebar([
 	r.status,
 	r.attempt,
-	r.nextAttempt,
-	r.createdAt
+	r.next_attempt,
+	r.created_at
 ])]).actions((a) => [a.update("resend", {
 	label: "Resend",
 	icon: "rotate-ccw",
@@ -157,39 +157,39 @@ const deliveriesView = view("webhookDeliveries").names({
 	confirm: "Try this delivery once more, from now?"
 })]);
 /** Every try of every webhook subscription's deliveries, for 30 days (`deliveryLog: true`). */
-const deliveryLogResource = (schema) => resource("webhookDeliveryLog").table(`${schema}.delivery_log`).fields({
+const deliveryLogResource = (schema) => resource("webhook_delivery_log").table(`${schema}.delivery_log`).fields({
 	id: f.bigint().readOnly(),
-	subscriptionId: f.relation("webhookSubscriptions").readOnly().filterable(),
-	tenantId: f.text().optional().readOnly(),
-	eventId: f.text().readOnly().filterable(),
-	eventType: f.text().readOnly().filterable().sortable(),
+	subscription_id: f.relation("webhook_subscriptions").readOnly().filterable(),
+	tenant_id: f.text().optional().readOnly(),
+	event_id: f.text().readOnly().filterable(),
+	event_type: f.text().readOnly().filterable().sortable(),
 	status: f.enum(["delivered", "failed"]).readOnly().filterable(),
 	attempt: f.integer().readOnly(),
-	statusCode: f.integer().optional().readOnly().filterable(),
+	status_code: f.integer().optional().readOnly().filterable(),
 	response: f.text().optional().readOnly(),
-	durationMs: f.integer().readOnly(),
+	duration_ms: f.integer().readOnly(),
 	at: f.timestamp().readOnly().filterable().sortable()
-}).primaryKey((r) => r.id).tenant((r) => r.tenantId).access({
+}).primaryKey((r) => r.id).tenant((r) => r.tenant_id).access({
 	create: () => false,
 	update: () => false,
 	delete: () => false
 });
-const deliveryLogView = view("webhookDeliveryLog").names({
+const deliveryLogView = view("webhook_delivery_log").names({
 	singular: "Webhook delivery log entry",
 	plural: "Webhook delivery log"
-}).icon("scroll-text").title((r) => r.eventType).fields((r) => ({
-	eventType: r.eventType.label("Event"),
-	statusCode: r.statusCode.label("Status code"),
-	durationMs: r.durationMs.label("Duration (ms)"),
+}).icon("scroll-text").title((r) => r.event_type).fields((r) => ({
+	event_type: r.event_type.label("Event"),
+	status_code: r.status_code.label("Status code"),
+	duration_ms: r.duration_ms.label("Duration (ms)"),
 	at: r.at.label("When")
 })).list((r) => ({
 	columns: [
 		r.at,
-		r.eventType,
-		r.subscriptionId,
+		r.event_type,
+		r.subscription_id,
 		r.status,
-		r.statusCode,
-		r.durationMs
+		r.status_code,
+		r.duration_ms
 	],
 	sort: [[r.at, "desc"]]
 }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {