@every-app/sdk 0.2.0 → 0.3.0-rc.2

package/dist/cloudflare/index.js

@@ -0,0 +1,21 @@
+/**
+ * @every-app/sdk/cloudflare — the Worker definition for an app's
+ * `cloudflare.config.ts`:
+ *
+ *   import { defineConfig } from "cf/config";
+ *   import * as entrypoint from "./src/entry.worker.ts" with { type: "cf-worker" };
+ *   import manifest from "./everyapp.config.ts";
+ *   import { everyAppWorker } from "@every-app/sdk/cloudflare";
+ *
+ *   export default defineConfig((ctx) => ({
+ *     worker: everyAppWorker({ manifest, entrypoint, ctx }),
+ *   }));
+ *
+ * This runs in Node while cf and the Vite plugin load the config, never in the
+ * Worker. Keep it self-contained: the plugin hides every file the config
+ * imports from the Worker in dev, so sharing a module with `/server` or
+ * `/internal` would break `cf dev` wherever the SDK is linked from source.
+ * (The dev keypair it hands the dev Worker is a leaf the Worker never loads.)
+ */
+export { EVERYAPP_OBSERVABILITY, everyAppAuxiliaryWorker, everyAppWorker, helperWorkerName, localD1Id, localD1Path, workflowNameFor, } from "./worker.js";
+export { BUILD_SENTINEL, resourceSentinel, sentinelDeployTarget, } from "./sentinel.js";

package/dist/cloudflare/sentinel.d.ts

@@ -0,0 +1,69 @@
+/**
+ * What a production build of an Every App app is made of in place of the
+ * install's own values. The build is tenant-neutral: whoever builds an
+ * app gets the same Build Output, with these placeholders wherever an
+ * install's Worker name, organization, gateway, identity key or resource
+ * ids belong. The installer rewrites them (`everyapp deploy` for an own
+ * Gateway, the hosted gateway's deployer for a hosted one) and refuses an
+ * output in which any survives.
+ *
+ * A leaf module with no imports, so the gateway Worker can read the same
+ * values (`@every-app/sdk/cloudflare/sentinel`) without loading the
+ * Node-only Worker builder.
+ */
+export declare const BUILD_SENTINEL: Readonly<{
+    workerName: "every-hosted--sentinel";
+    organizationId: "everyapp-hosted-deploy-sentinel";
+    /** The gateway's URL, and so the identity issuer. */
+    gatewayUrl: "https://every-hosted--sentinel.invalid";
+    publicKey: "-----BEGIN PUBLIC KEY-----\nEVERYAPPHOSTEDDEPLOYSENTINEL\n-----END PUBLIC KEY-----\n";
+}>;
+/**
+ * A manifest binding's placeholder: a D1 database's name and id, an R2
+ * bucket's name, a KV namespace's or Hyperdrive config's id. The installer
+ * rewrites each by its binding name; the value only has to be recognizable.
+ */
+export declare function resourceSentinel(binding: string): string;
+/** The fields of the manifest a build's placeholders are made for. */
+interface SentinelManifest {
+    resources?: {
+        d1?: readonly string[];
+        kv?: readonly string[];
+        r2?: readonly string[];
+        hyperdrive?: readonly {
+            readonly name: string;
+        }[];
+    };
+}
+/** Everything install-specific a Worker is built from, by binding. */
+export interface EveryAppDeployTarget {
+    /** The Worker name the gateway registry assigned to this app. */
+    workerName: string;
+    /** The organization that owns the app; scopes the AppGateway binding. */
+    organizationId: string;
+    /** The gateway's URL, which is also the identity tokens' issuer. */
+    gatewayUrl: string;
+    /** SPKI PEM public keys (current + next) that verify identity tokens. */
+    identityPublicKeys: string[];
+    /** Provisioned resources keyed by manifest binding name. */
+    resources: {
+        d1?: Record<string, {
+            name: string;
+            id: string;
+        }>;
+        kv?: Record<string, {
+            id: string;
+        }>;
+        hyperdrive?: Record<string, {
+            id: string;
+        }>;
+        /** R2 buckets by binding, under the names the registry assigned. */
+        r2?: Record<string, {
+            name: string;
+        }>;
+    };
+}
+/** The target every production build is made for: placeholders throughout. */
+export declare function sentinelDeployTarget(manifest: SentinelManifest): EveryAppDeployTarget;
+export {};
+//# sourceMappingURL=sentinel.d.ts.map

package/dist/cloudflare/sentinel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentinel.d.ts","sourceRoot":"","sources":["../../src/cloudflare/sentinel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,cAAc;;;IAKzB,qDAAqD;;;EAIrD,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,sEAAsE;AACtE,UAAU,gBAAgB;IACxB,SAAS,CAAC,EAAE;QACV,EAAE,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;QACvB,EAAE,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;QACvB,EAAE,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;QACvB,UAAU,CAAC,EAAE,SAAS;YAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;KACnD,CAAC;CACH;AAED,sEAAsE;AACtE,MAAM,WAAW,oBAAoB;IACnC,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC;IACnB,yEAAyE;IACzE,cAAc,EAAE,MAAM,CAAC;IACvB,oEAAoE;IACpE,UAAU,EAAE,MAAM,CAAC;IACnB,yEAAyE;IACzE,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,4DAA4D;IAC5D,SAAS,EAAE;QACT,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAClD,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACpC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAC5C,oEAAoE;QACpE,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACvC,CAAC;CACH;AAED,8EAA8E;AAC9E,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,gBAAgB,GACzB,oBAAoB,CA2BtB"}

package/dist/cloudflare/sentinel.js

@@ -0,0 +1,50 @@
+/**
+ * What a production build of an Every App app is made of in place of the
+ * install's own values. The build is tenant-neutral: whoever builds an
+ * app gets the same Build Output, with these placeholders wherever an
+ * install's Worker name, organization, gateway, identity key or resource
+ * ids belong. The installer rewrites them (`everyapp deploy` for an own
+ * Gateway, the hosted gateway's deployer for a hosted one) and refuses an
+ * output in which any survives.
+ *
+ * A leaf module with no imports, so the gateway Worker can read the same
+ * values (`@every-app/sdk/cloudflare/sentinel`) without loading the
+ * Node-only Worker builder.
+ */
+export const BUILD_SENTINEL = Object.freeze({
+    // Holds the resource separator, so no registry Worker is ever named so
+    // and a string rewrite of it can't hit anything else.
+    workerName: "every-hosted--sentinel",
+    organizationId: "everyapp-hosted-deploy-sentinel",
+    /** The gateway's URL, and so the identity issuer. */
+    gatewayUrl: "https://every-hosted--sentinel.invalid",
+    publicKey: "-----BEGIN PUBLIC KEY-----\nEVERYAPPHOSTEDDEPLOYSENTINEL\n-----END PUBLIC KEY-----\n",
+});
+/**
+ * A manifest binding's placeholder: a D1 database's name and id, an R2
+ * bucket's name, a KV namespace's or Hyperdrive config's id. The installer
+ * rewrites each by its binding name; the value only has to be recognizable.
+ */
+export function resourceSentinel(binding) {
+    return `${BUILD_SENTINEL.workerName}--${binding}`;
+}
+/** The target every production build is made for: placeholders throughout. */
+export function sentinelDeployTarget(manifest) {
+    const byBinding = (bindings, value) => Object.fromEntries((bindings ?? []).map((binding) => [
+        binding,
+        value(resourceSentinel(binding)),
+    ]));
+    const { resources } = manifest;
+    return {
+        workerName: BUILD_SENTINEL.workerName,
+        organizationId: BUILD_SENTINEL.organizationId,
+        gatewayUrl: BUILD_SENTINEL.gatewayUrl,
+        identityPublicKeys: [BUILD_SENTINEL.publicKey],
+        resources: {
+            d1: byBinding(resources?.d1, (id) => ({ name: id, id })),
+            kv: byBinding(resources?.kv, (id) => ({ id })),
+            hyperdrive: byBinding(resources?.hyperdrive?.map((config) => config.name), (id) => ({ id })),
+            r2: byBinding(resources?.r2, (name) => ({ name })),
+        },
+    };
+}