@pikku/kysely 0.13.29 → 0.13.31

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 0.13.31
+
+### Patch Changes
+
+- 01c0209: `@pikku/kysely` re-exports `Kysely`, `PostgresDialect` and `CamelCasePlugin` from its own copy of kysely. The local-services codegen writes these imports into a project, so it now opens and types the database with the same kysely copy the generated services were built against, instead of a second copy the project may resolve on its own.
+- 5bce779: Webhook trigger sources are off until someone turns them on, and addons declare their own.
+
+  An addon calls `wireTriggerWebhookSource` in its own package, and an app that wires the addon gets the source (its route included) without declaring it: named and routed after the addon's namespace, so two instances get one each. A source the app declares under the same name wins.
+
+  Every source now has an `enabled` switch in the `triggerSourceStore`, off by default. `reconcileTriggerSources` registers only enabled sources and records each one's `baseUrl` and `labelPrefix`; a disabled source's route answers 404 without running `receive`. New in core: `enableTriggerSource` registers a source with its provider and `disableTriggerSource` stops it receiving, then tears it down, both at the recorded address unless one is given. The admin addon exposes them as `triggerSourceEnable` and `triggerSourceDisable`. The `pikkuTriggerSource` table gains `enabled`, `baseUrl` and `labelPrefix`: run `pikku db generate` for the migration.
+
+- Updated dependencies [dfcd351]
+- Updated dependencies [cf40182]
+- Updated dependencies [5bce779]
+- Updated dependencies [5bce779]
+  - @pikku/core@0.12.130
+
+## 0.13.30
+
+### Patch Changes
+
+- 658f047: A declared webhook source is a registered one. `reconcileTriggerSources` sets up every declared source with its provider (check, then setup where missing or drifted) and `teardownTriggerSources` removes named ones, recording what was registered in a `TriggerSourceStore` (in-memory, or `KyselyTriggerSourceStore` on `pikku_trigger_source`). The admin addon exposes list, reconcile, teardown and forget under the new `admin:triggers` scopes.
+- Updated dependencies [658f047]
+- Updated dependencies [de63ab2]
+- Updated dependencies [658f047]
+- Updated dependencies [658f047]
+- Updated dependencies [658f047]
+- Updated dependencies [658f047]
+  - @pikku/core@0.12.128
+
 ## 0.13.29
 
 ### Patch Changes

package/dist/src/index.d.ts

@@ -14,12 +14,14 @@ export { KyselyScopeService } from './kysely-scope-service.js';
 export { KyselyFeatureFlagStore } from './kysely-feature-flag-store.js';
 export type { KyselyFeatureFlagStoreOptions } from './kysely-feature-flag-store.js';
 export { KyselyWebhookService } from './kysely-webhook-service.js';
+export { KyselyTriggerSourceStore } from './kysely-trigger-source-store.js';
 export { KyselyIncomingWebhookService } from './kysely-incoming-webhook-service.js';
 export { createAuditedKysely, type CreateAuditedKyselyOptions, } from './create-audited-kysely.js';
 export { KyselyAuditService } from './kysely-audit-service.js';
 export { KyselyAnalyticsService } from './kysely-analytics-service.js';
 export { KyselyVirtualUserRunStore } from './kysely-virtual-user-run-store.js';
 export { KyselyVirtualUserScheduleStore } from './kysely-virtual-user-schedule-store.js';
+export { CamelCasePlugin, Kysely, PostgresDialect } from 'kysely';
 export { SerializePlugin, BaseSerializePlugin, type Serializer, type Deserializer, } from './serialize-plugin.js';
 export { createCoercionPlugin, type ColumnKind, type CoercionMap, type CreateCoercionPluginOptions, } from './coercion-plugin.js';
 export { createClassificationPlugin, type CreateClassificationPluginOptions, } from './classification-plugin.js';

package/dist/src/index.js

@@ -13,12 +13,17 @@ export { KyselySessionStore } from './kysely-session-store.js';
 export { KyselyScopeService } from './kysely-scope-service.js';
 export { KyselyFeatureFlagStore } from './kysely-feature-flag-store.js';
 export { KyselyWebhookService } from './kysely-webhook-service.js';
+export { KyselyTriggerSourceStore } from './kysely-trigger-source-store.js';
 export { KyselyIncomingWebhookService } from './kysely-incoming-webhook-service.js';
 export { createAuditedKysely, } from './create-audited-kysely.js';
 export { KyselyAuditService } from './kysely-audit-service.js';
 export { KyselyAnalyticsService } from './kysely-analytics-service.js';
 export { KyselyVirtualUserRunStore } from './kysely-virtual-user-run-store.js';
 export { KyselyVirtualUserScheduleStore } from './kysely-virtual-user-schedule-store.js';
+// Re-exported so a generated file that constructs the services above opens and
+// types its database with the same copy of kysely those services were built
+// against, rather than a second copy the project may resolve on its own.
+export { CamelCasePlugin, Kysely, PostgresDialect } from 'kysely';
 export { SerializePlugin, BaseSerializePlugin, } from './serialize-plugin.js';
 export { createCoercionPlugin, } from './coercion-plugin.js';
 export { createClassificationPlugin, } from './classification-plugin.js';

package/dist/src/kysely-tables.d.ts

@@ -236,6 +236,20 @@ export interface PikkuFeatureFlagsTable {
     note: string | null;
     updatedAt: Generated<Date>;
 }
+/** What a declared trigger source registered with its provider. */
+export interface PikkuTriggerSourceTable {
+    name: string;
+    kind: string;
+    baseUrl: string | null;
+    labelPrefix: string | null;
+    declared: Generated<boolean>;
+    enabled: Generated<boolean>;
+    status: string | null;
+    /** The last setup's provider identifiers as JSON; never a secret. */
+    state: string | null;
+    detail: string | null;
+    updatedAt: Generated<Date>;
+}
 /** One subject's short-circuit, in either direction, over a flag's rollout. */
 export interface PikkuFeatureFlagOverridesTable {
     flag: string;
@@ -421,6 +435,7 @@ export interface KyselyPikkuDB {
     pikkuUserScope: PikkuUserScopeTable;
     pikkuFeatureFlags: PikkuFeatureFlagsTable;
     pikkuFeatureFlagOverrides: PikkuFeatureFlagOverridesTable;
+    pikkuTriggerSource: PikkuTriggerSourceTable;
     channels: ChannelsTable;
     channelSubscriptions: ChannelSubscriptionsTable;
     workflowRuns: WorkflowRunsTable;

package/dist/src/kysely-trigger-source-store.d.ts

@@ -0,0 +1,15 @@
+import type { DeclaredTriggerSource, TriggerSourceResult, TriggerSourceRow, TriggerSourceStore } from '@pikku/core/services';
+import type { Kysely } from 'kysely';
+import type { KyselyPikkuDB } from './kysely-tables.js';
+export declare class KyselyTriggerSourceStore implements TriggerSourceStore {
+    private db;
+    private initialized;
+    constructor(db: Kysely<KyselyPikkuDB>);
+    init(): Promise<void>;
+    syncTriggerSources(sources: DeclaredTriggerSource[]): Promise<void>;
+    listTriggerSources(): Promise<TriggerSourceRow[]>;
+    getTriggerSource(name: string): Promise<TriggerSourceRow | null>;
+    recordTriggerSource(name: string, result: TriggerSourceResult): Promise<void>;
+    setTriggerSourceEnabled(name: string, enabled: boolean): Promise<void>;
+    deleteTriggerSource(name: string): Promise<void>;
+}

package/dist/src/kysely-trigger-source-store.js

@@ -0,0 +1,109 @@
+import { requirePikkuSchema } from './schema/index.js';
+import { triggerSourceSchema } from './schema/trigger-source.schema.js';
+const parseState = (value) => {
+    if (!value)
+        return null;
+    if (typeof value !== 'string')
+        return value;
+    try {
+        return JSON.parse(value);
+    }
+    catch {
+        return null;
+    }
+};
+const toRow = (row) => ({
+    name: row.name,
+    kind: row.kind,
+    baseUrl: row.baseUrl,
+    labelPrefix: row.labelPrefix,
+    declared: !!row.declared,
+    enabled: !!row.enabled,
+    status: row.status,
+    state: parseState(row.state),
+    detail: row.detail,
+    updatedAt: row.updatedAt ? new Date(row.updatedAt).toISOString() : null,
+});
+export class KyselyTriggerSourceStore {
+    db;
+    initialized = false;
+    constructor(db) {
+        this.db = db;
+    }
+    async init() {
+        if (this.initialized)
+            return;
+        await requirePikkuSchema(this.db, triggerSourceSchema);
+        this.initialized = true;
+    }
+    async syncTriggerSources(sources) {
+        await this.db.transaction().execute(async (trx) => {
+            for (const { name, kind, baseUrl, labelPrefix } of sources) {
+                const address = {
+                    ...(baseUrl !== undefined ? { baseUrl } : {}),
+                    ...(labelPrefix !== undefined ? { labelPrefix } : {}),
+                };
+                await trx
+                    .insertInto('pikkuTriggerSource')
+                    .values({ name, kind, declared: true, ...address })
+                    .onConflict((oc) => oc.column('name').doUpdateSet({ kind, declared: true, ...address }))
+                    .execute();
+            }
+            const markStale = trx
+                .updateTable('pikkuTriggerSource')
+                .set({ declared: false });
+            await (sources.length > 0
+                ? markStale.where('name', 'not in', sources.map((s) => s.name))
+                : markStale).execute();
+        });
+    }
+    async listTriggerSources() {
+        const rows = await this.db
+            .selectFrom('pikkuTriggerSource')
+            .selectAll()
+            .orderBy('name')
+            .execute();
+        return rows.map(toRow);
+    }
+    async getTriggerSource(name) {
+        const row = await this.db
+            .selectFrom('pikkuTriggerSource')
+            .selectAll()
+            .where('name', '=', name)
+            .executeTakeFirst();
+        return row ? toRow(row) : null;
+    }
+    async recordTriggerSource(name, result) {
+        const { numUpdatedRows } = await this.db
+            .updateTable('pikkuTriggerSource')
+            .set({
+            status: result.status,
+            ...(result.state !== undefined
+                ? { state: result.state ? JSON.stringify(result.state) : null }
+                : {}),
+            detail: result.detail ?? null,
+            updatedAt: new Date(),
+        })
+            .where('name', '=', name)
+            .executeTakeFirst();
+        if (!numUpdatedRows) {
+            throw new Error(`Unknown trigger source: ${name}`);
+        }
+    }
+    async setTriggerSourceEnabled(name, enabled) {
+        const { numUpdatedRows } = await this.db
+            .updateTable('pikkuTriggerSource')
+            .set({ enabled })
+            .where('name', '=', name)
+            .executeTakeFirst();
+        if (!numUpdatedRows) {
+            throw new Error(`Unknown trigger source: ${name}`);
+        }
+    }
+    async deleteTriggerSource(name) {
+        await this.db
+            .deleteFrom('pikkuTriggerSource')
+            .where('name', '=', name)
+            .execute();
+    }
+}

package/dist/src/schema/index.d.ts

@@ -24,6 +24,7 @@ export { channelSchema } from './channel.schema.js';
 export { credentialSchema } from './credential.schema.js';
 export { deploymentSchema } from './deployment.schema.js';
 export { flagSchema } from './flag.schema.js';
+export { triggerSourceSchema } from './trigger-source.schema.js';
 export { incomingWebhookSchema } from './incoming-webhook.schema.js';
 export { scopeSchema } from './scope.schema.js';
 export { secretSchema } from './secret.schema.js';

package/dist/src/schema/index.js

@@ -8,6 +8,7 @@ import { credentialSchema } from './credential.schema.js';
 import { deploymentSchema } from './deployment.schema.js';
 import { scopeSchema } from './scope.schema.js';
 import { flagSchema } from './flag.schema.js';
+import { triggerSourceSchema } from './trigger-source.schema.js';
 import { incomingWebhookSchema } from './incoming-webhook.schema.js';
 import { secretSchema } from './secret.schema.js';
 import { sessionSchema } from './session.schema.js';
@@ -42,6 +43,7 @@ export const pikkuSchemas = [
     agentSchema,
     scopeSchema,
     flagSchema,
+    triggerSourceSchema,
     auditSchema,
     analyticsSchema,
     virtualUserSchema,
@@ -54,6 +56,7 @@ export { channelSchema } from './channel.schema.js';
 export { credentialSchema } from './credential.schema.js';
 export { deploymentSchema } from './deployment.schema.js';
 export { flagSchema } from './flag.schema.js';
+export { triggerSourceSchema } from './trigger-source.schema.js';
 export { incomingWebhookSchema } from './incoming-webhook.schema.js';
 export { scopeSchema } from './scope.schema.js';
 export { secretSchema } from './secret.schema.js';

package/dist/src/schema/trigger-source.schema.d.ts

@@ -0,0 +1,6 @@
+import type { PikkuSchema } from './pikku-schema.types.js';
+/**
+ * What each declared trigger source registered with its provider. `state` holds provider identifiers only: a signing secret a
+ * provider issues goes to the credential service.
+ */
+export declare const triggerSourceSchema: PikkuSchema;

package/dist/src/schema/trigger-source.schema.js

@@ -0,0 +1,23 @@
+import { sql } from 'kysely';
+/**
+ * What each declared trigger source registered with its provider. `state` holds provider identifiers only: a signing secret a
+ * provider issues goes to the credential service.
+ */
+export const triggerSourceSchema = {
+    name: 'trigger-source',
+    ownedBy: ['triggerSourceStore'],
+    statements: [
+        (db) => db.schema
+            .createTable('pikkuTriggerSource')
+            .addColumn('name', 'text', (col) => col.primaryKey())
+            .addColumn('kind', 'text', (col) => col.notNull())
+            .addColumn('baseUrl', 'text')
+            .addColumn('labelPrefix', 'text')
+            .addColumn('declared', 'boolean', (col) => col.defaultTo(true).notNull())
+            .addColumn('enabled', 'boolean', (col) => col.defaultTo(false).notNull())
+            .addColumn('status', 'text')
+            .addColumn('state', 'text')
+            .addColumn('detail', 'text')
+            .addColumn('updatedAt', 'timestamp', (col) => col.defaultTo(sql `CURRENT_TIMESTAMP`).notNull()),
+    ],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/kysely",
-  "version": "0.13.29",
+  "version": "0.13.31",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pikkujs/pikku.git",
@@ -26,7 +26,7 @@
     "prepublishOnly": "bun run build"
   },
   "peerDependencies": {
-    "@pikku/core": "^0.12.125"
+    "@pikku/core": "^0.12.130"
   },
   "dependencies": {
     "kysely": "^0.29.5"