@suss/contract-wrangler 0.8.0

package/LICENSE

@@ -0,0 +1,205 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable by
+      such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do not
+          modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor has
+      been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format please. Also add information on
+      how to contact you by electronic and paper mail.
+
+      If the program does not interact with users remotely through a computer
+      network, then your name and employer's name (e.g., your institution)
+      is sufficient to fill in the "name of copyright owner" field. Feel
+      free to omit the "name of employer" line if you are in no way affiliated
+      with any institution.
+
+      Copyright 2026 Nimbus Cloud AI LLC
+
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.

package/README.md

@@ -0,0 +1,63 @@
+# @suss/contract-wrangler
+
+Reads a Cloudflare `wrangler.toml` (or `wrangler.jsonc`) and says what the Worker it deploys is given.
+
+## What this package is
+
+A contract source. `suss contract --from wrangler services/api` reads the document and emits the declared side of four boundaries:
+
+```toml
+name = "greeting-router"
+main = "src/index.ts"
+
+[vars]
+GREETING_TABLE = "prod-greetings-v2"
+
+[[kv_namespaces]]
+binding = "SESSIONS"
+id = "prod-sessions"
+
+[[queues.consumers]]
+queue = "greeting-events"
+```
+
+| What the document says | What comes out |
+| --- | --- |
+| `name`, `main` | the deployable unit and the code it runs |
+| `[vars]` | the Worker's runtime configuration, names and values |
+| `[[kv_namespaces]]`, `[[r2_buckets]]`, `[[d1_databases]]` | one store each |
+| `[[queues.producers]]`, `[[queues.consumers]]` | one channel each, on `cloudflare-queues` |
+| `[env.<name>]` | the same Worker deployed again, with the top-level document as its default |
+
+## The values, not only the names
+
+A runtime-config contract usually records which variables a runtime supplies, and that is enough to say whether code reads one nobody set. A Worker needs more, because it addresses its stores through a variable:
+
+```ts
+await dynamoRequest(env, aws, "Query", { TableName: env.EDITION_TABLE });
+```
+
+Nothing at that call site says which table. The container comes out as `{EDITION_TABLE}`, which pairs with nothing until something says what the variable is. `[vars]` says it, so the summary keeps the values under `metadata.runtimeContract.envVarValues`, and the storage check grounds the access through the runtime that runs it.
+
+A value the document does not state stays out. A secret is set with `wrangler secret put` or by the deployment's own tooling, never in the file, so the reader has nothing to record and the container stays unresolved.
+
+## Environments
+
+`[env.staging]` deploys the same Worker again under its own name, `greeting-router-staging` unless the block gives a `name`. Each one gets its own summary.
+
+Wrangler replaces a whole block rather than merging it, so an environment that declares `[env.staging.vars]` supplies those variables and none of the top-level ones. A variable that comes through untouched is recorded as `globals`, which is the same provenance a SAM `Globals` section gets, and the checker judges it once for the document instead of once per deployment.
+
+## Code scope
+
+The Worker's code is the directory the document is in, and `main` says which file it enters. `main` often points at a bundle a build step writes rather than at source; an entry that matches no file leaves the directory in charge, which is what places the code either way.
+
+## Out of scope for now
+
+- **Durable Object and service bindings.** `[[durable_objects.bindings]]` and `[[services]]` are boundaries between two Workers, and pairing them needs both sides of a deployment suss does not read yet.
+- **Routes.** `routes` says which hostnames reach the Worker. The code side states no path, so a declared route would pair with nothing.
+- **Cron expressions.** `[triggers] crons` says when a Worker runs, not what it exchanges.
+- **`.dev.vars`.** It is local development configuration, and it is not what a deployment supplies.
+
+## Where it fits in suss
+
+Depends on `@suss/behavioral-ir` and `@suss/ir-core` for the bindings it writes. `@suss/framework-cloudflare-workers` reads the code side: the triggers the Worker serves and the variables it reads. The storage check in `@suss/checker` pairs a store this reader declares, or one a Terraform module declares, against the accesses that reach it.

package/dist/index.cjs

@@ -0,0 +1,376 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  CONFIGURATION_FILE_NAMES: () => CONFIGURATION_FILE_NAMES,
+  RECOGNITION: () => RECOGNITION,
+  environmentDocuments: () => environmentDocuments,
+  isConfigurationFile: () => isConfigurationFile,
+  loadConfigurationDocument: () => loadConfigurationDocument,
+  locateConfigurationFile: () => locateConfigurationFile,
+  wranglerFileToSummaries: () => wranglerFileToSummaries,
+  wranglerToSummaries: () => wranglerToSummaries
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_path2 = __toESM(require("path"), 1);
+var import_ir_core2 = require("@suss/ir-core");
+
+// src/bindings.ts
+var import_behavioral_ir = require("@suss/behavioral-ir");
+var RECOGNITION = "wrangler";
+var STORES = [
+  {
+    block: "kv_namespaces",
+    nameKey: "id",
+    storageSystem: "cloudflare-kv",
+    fieldSet: "none"
+  },
+  {
+    block: "r2_buckets",
+    nameKey: "bucket_name",
+    storageSystem: "r2",
+    fieldSet: "none"
+  },
+  {
+    block: "d1_databases",
+    nameKey: "database_name",
+    storageSystem: "d1",
+    fieldSet: "partial"
+  }
+];
+function storeSummaries(document, context) {
+  const summaries = [];
+  for (const store of STORES) {
+    for (const entry of blockEntries(document[store.block])) {
+      const summary = storeSummary(store, entry, context);
+      if (summary !== null) {
+        summaries.push(summary);
+      }
+    }
+  }
+  return summaries;
+}
+function storeSummary(store, entry, context) {
+  const container = stringOf(entry[store.nameKey]);
+  const boundAs = stringOf(entry.binding);
+  if (container === null) {
+    return null;
+  }
+  return {
+    kind: "library",
+    location: {
+      file: context.sourceFile,
+      range: { start: 1, end: 1 },
+      exportName: null
+    },
+    identity: {
+      name: `${store.block}.${boundAs ?? container}`,
+      exportPath: null,
+      boundaryBinding: (0, import_behavioral_ir.storageBinding)({
+        recognition: RECOGNITION,
+        storageSystem: store.storageSystem,
+        scope: "default",
+        container,
+        accessPath: null
+      })
+    },
+    inputs: [],
+    transitions: [],
+    gaps: [],
+    confidence: { source: "declared", level: "high" },
+    metadata: {
+      storageContract: { fieldSet: store.fieldSet, physicalTable: container },
+      ...boundAs === null ? {} : { wrangler: { binding: boundAs } }
+    }
+  };
+}
+function queueSummaries(document, context) {
+  const queues = document.queues;
+  if (queues === null || typeof queues !== "object") {
+    return [];
+  }
+  const block = queues;
+  return [
+    ...queueSide(blockEntries(block.producers), "producers", context),
+    ...queueSide(blockEntries(block.consumers), "consumers", context)
+  ];
+}
+function queueSide(entries, side, context) {
+  const summaries = [];
+  for (const entry of entries) {
+    const channel = stringOf(entry.queue);
+    if (channel === null) {
+      continue;
+    }
+    summaries.push({
+      // A producer block declares a queue the Worker sends to, which is
+      // a channel rather than a unit that runs, so it is a library. A
+      // consumer block says this Worker drains that queue.
+      kind: side === "consumers" ? "consumer" : "library",
+      location: {
+        file: context.sourceFile,
+        range: { start: 1, end: 1 },
+        exportName: null
+      },
+      identity: {
+        name: side === "consumers" ? `${context.scriptName}.queue.${channel}` : `queues.producers.${channel}`,
+        exportPath: null,
+        boundaryBinding: (0, import_behavioral_ir.messageBusBinding)({
+          recognition: RECOGNITION,
+          messageBus: "cloudflare-queues",
+          channel
+        }),
+        ...side === "consumers" ? {
+          deployableUnit: {
+            deploymentTarget: "worker",
+            instanceName: context.scriptName
+          }
+        } : {}
+      },
+      inputs: [],
+      transitions: [],
+      gaps: [],
+      confidence: { source: "declared", level: "high" },
+      metadata: { messageBus: { queue: channel } }
+    });
+  }
+  return summaries;
+}
+function blockEntries(raw) {
+  if (!Array.isArray(raw)) {
+    return [];
+  }
+  return raw.filter(
+    (entry) => entry !== null && typeof entry === "object" && !Array.isArray(entry)
+  );
+}
+function stringOf(raw) {
+  return typeof raw === "string" && raw.length > 0 ? raw : null;
+}
+
+// src/document.ts
+var import_node_fs = __toESM(require("fs"), 1);
+var import_node_path = __toESM(require("path"), 1);
+var import_jsonc_parser = require("jsonc-parser");
+var import_smol_toml = require("smol-toml");
+var CONFIGURATION_FILE_NAMES = [
+  "wrangler.jsonc",
+  "wrangler.json",
+  "wrangler.toml"
+];
+function isConfigurationFile(basename) {
+  return CONFIGURATION_FILE_NAMES.includes(basename);
+}
+function locateConfigurationFile(target) {
+  const resolved = import_node_path.default.resolve(target);
+  if (!import_node_fs.default.existsSync(resolved)) {
+    return { kind: "missing" };
+  }
+  if (import_node_fs.default.statSync(resolved).isFile()) {
+    return { kind: "file", file: resolved };
+  }
+  for (const name of CONFIGURATION_FILE_NAMES) {
+    const candidate = import_node_path.default.join(resolved, name);
+    if (import_node_fs.default.existsSync(candidate)) {
+      return { kind: "file", file: candidate };
+    }
+  }
+  return { kind: "missing" };
+}
+function loadConfigurationDocument(file) {
+  const text = import_node_fs.default.readFileSync(file, "utf8");
+  const parsed = file.endsWith(".toml") ? (0, import_smol_toml.parse)(text) : (0, import_jsonc_parser.parse)(text);
+  if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
+    throw new Error(`${file} does not contain a Wrangler configuration object`);
+  }
+  return parsed;
+}
+
+// src/runtimeConfig.ts
+var import_behavioral_ir2 = require("@suss/behavioral-ir");
+var import_ir_core = require("@suss/ir-core");
+function environmentDocuments(document) {
+  const rootName = nameOf(document) ?? "worker";
+  const deployments = [
+    {
+      scriptName: rootName,
+      environment: null,
+      merged: document,
+      inherited: /* @__PURE__ */ new Set()
+    }
+  ];
+  const environments = document.env;
+  if (environments === null || typeof environments !== "object") {
+    return deployments;
+  }
+  for (const [environment, raw] of Object.entries(environments)) {
+    if (raw === null || typeof raw !== "object") {
+      continue;
+    }
+    const overrides = raw;
+    const merged = { ...document, ...overrides };
+    delete merged.env;
+    deployments.push({
+      scriptName: nameOf(overrides) ?? `${rootName}-${environment}`,
+      environment,
+      merged,
+      inherited: inheritedNames(document, overrides)
+    });
+  }
+  return deployments;
+}
+function inheritedNames(document, overrides) {
+  if (overrides.vars !== void 0) {
+    return /* @__PURE__ */ new Set();
+  }
+  return new Set(Object.keys(varsOf(document)));
+}
+function nameOf(document) {
+  return typeof document.name === "string" && document.name.length > 0 ? document.name : null;
+}
+function varsOf(document) {
+  const vars = document.vars;
+  return vars !== null && typeof vars === "object" && !Array.isArray(vars) ? vars : {};
+}
+function runtimeConfigSummary(deployment, context) {
+  const vars = varsOf(deployment.merged);
+  const names = Object.keys(vars).sort();
+  const sources = {};
+  const values = {};
+  for (const name of names) {
+    sources[name] = deployment.inherited.has(name) ? "globals" : "template";
+    const value = vars[name];
+    if (typeof value === "string") {
+      values[name] = value;
+    }
+  }
+  const deployableUnit = {
+    deploymentTarget: "worker",
+    instanceName: deployment.scriptName
+  };
+  return {
+    kind: "library",
+    location: {
+      file: context.sourceFile,
+      range: { start: 1, end: 1 },
+      exportName: null
+    },
+    identity: {
+      name: deployment.scriptName,
+      exportPath: null,
+      boundaryBinding: (0, import_ir_core.runtimeConfigBinding)({
+        recognition: RECOGNITION,
+        ...deployableUnit
+      }),
+      deployableUnit
+    },
+    inputs: [],
+    transitions: [],
+    gaps: [],
+    confidence: { source: "declared", level: "high" },
+    metadata: (0, import_behavioral_ir2.withRuntimeContractMetadata)(
+      { codeScope: context.codeScope },
+      {
+        envVars: names,
+        envVarSources: sources,
+        ...Object.keys(values).length > 0 ? { envVarValues: values } : {}
+      }
+    )
+  };
+}
+
+// src/index.ts
+function wranglerToSummaries(document, options) {
+  const summaries = [];
+  const named = /* @__PURE__ */ new Set();
+  for (const deployment of environmentDocuments(document)) {
+    const context = {
+      sourceFile: options.source,
+      scriptName: deployment.scriptName
+    };
+    summaries.push(
+      runtimeConfigSummary(deployment, {
+        sourceFile: options.source,
+        codeScope: codeScopeFor(deployment.merged, options.codeScope)
+      })
+    );
+    for (const summary of [
+      ...storeSummaries(deployment.merged, context),
+      ...queueSummaries(deployment.merged, context)
+    ]) {
+      if (named.has(summary.identity.name)) {
+        continue;
+      }
+      named.add(summary.identity.name);
+      summaries.push(summary);
+    }
+  }
+  return summaries;
+}
+function wranglerFileToSummaries(target, options = {}) {
+  const located = locateConfigurationFile(target);
+  if (located.kind === "missing") {
+    throw new Error(`Wrangler configuration not found: ${target}`);
+  }
+  const document = loadConfigurationDocument(located.file);
+  return wranglerToSummaries(document, {
+    source: options.source ?? `${RECOGNITION}:${relativeToRun(located.file)}`,
+    codeScope: options.codeScope ?? (0, import_ir_core2.codeScopePath)(import_node_path2.default.dirname(relativeToRun(located.file)))
+  });
+}
+function relativeToRun(file) {
+  const relative = import_node_path2.default.relative(process.cwd(), import_node_path2.default.resolve(file));
+  if (relative === "" || relative.startsWith("..")) {
+    return import_node_path2.default.resolve(file).split(import_node_path2.default.sep).join("/");
+  }
+  return relative.split(import_node_path2.default.sep).join("/");
+}
+function codeScopeFor(document, scope) {
+  const main = typeof document.main === "string" ? document.main : null;
+  if (main === null) {
+    return { kind: "codeUri", path: scope };
+  }
+  const entry = (0, import_ir_core2.codeScopePath)(
+    import_node_path2.default.posix.join(scope, main.replace(/\.[cm]?[jt]sx?$/, ""))
+  );
+  return { kind: "codeUri", path: scope, entry };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CONFIGURATION_FILE_NAMES,
+  RECOGNITION,
+  environmentDocuments,
+  isConfigurationFile,
+  loadConfigurationDocument,
+  locateConfigurationFile,
+  wranglerFileToSummaries,
+  wranglerToSummaries
+});

package/dist/index.d.cts

@@ -0,0 +1,133 @@
+import { BehavioralSummary } from '@suss/behavioral-ir';
+
+/**
+ * Finding and parsing a Wrangler configuration document.
+ *
+ * Wrangler accepts the same configuration in two spellings, TOML and
+ * JSONC, and prefers the JSON one where a project has both. This module
+ * settles which file a path means and hands back the parsed object; the
+ * shape of what is in it is `translate.ts`'s problem.
+ */
+/**
+ * The names Wrangler looks for, in the order it prefers them. Wrangler
+ * defines the list, so a project that spells its file otherwise passes
+ * the path to that file outright.
+ */
+declare const CONFIGURATION_FILE_NAMES: string[];
+/** Whether a file is one Wrangler would read as a Worker's configuration. */
+declare function isConfigurationFile(basename: string): boolean;
+/** One binding a Worker is given, as Wrangler writes it. */
+type WranglerRecord = Record<string, unknown>;
+/**
+ * A parsed Wrangler document, top-level and per-environment alike. The
+ * fields are Wrangler's own names, and everything is optional because
+ * every one of them is optional in the file.
+ */
+interface WranglerDocument {
+    name?: string;
+    main?: string;
+    vars?: Record<string, unknown>;
+    kv_namespaces?: WranglerRecord[];
+    r2_buckets?: WranglerRecord[];
+    d1_databases?: WranglerRecord[];
+    queues?: {
+        producers?: WranglerRecord[];
+        consumers?: WranglerRecord[];
+    };
+    env?: Record<string, WranglerDocument>;
+    [key: string]: unknown;
+}
+type DocumentLocation = {
+    kind: "file";
+    file: string;
+} | {
+    kind: "missing";
+};
+/**
+ * The configuration file a path means. A path may be the file itself or
+ * the directory a Worker lives in, since that is where a person points
+ * when they mean the Worker rather than one of its two spellings.
+ */
+declare function locateConfigurationFile(target: string): DocumentLocation;
+/** The document a file contains, read by whichever parser its suffix asks for. */
+declare function loadConfigurationDocument(file: string): WranglerDocument;
+
+/**
+ * The stores and queues a Worker is bound to, as boundary summaries.
+ *
+ * Every binding block in a Wrangler document has the same two halves:
+ * `binding`, the name the code reads it under, and a key giving the
+ * resource's own name. The code says the first, the deployment declares the
+ * second, so a summary keeps both: the container is the resource's own
+ * name, which is what another manifest declaring that resource spells,
+ * and `physicalTable` records it again for a reader.
+ */
+
+/** The manifest language recorded on every binding this reader writes. */
+declare const RECOGNITION = "wrangler";
+
+/**
+ * The configuration contract a Wrangler document declares.
+ *
+ * A Worker reads its variables off the second argument to every
+ * trigger, so the channel is the same one a Node process reads through
+ * `process.env`, and the summary is the same shape the CloudFormation
+ * reader writes for a Lambda: a runtime-config provider, one per
+ * deployment, keyed on the deployable unit.
+ *
+ * The values go on it as well as the names. A Worker addresses a store
+ * through a variable rather than by name, `TableName: env.EDITION_TABLE`,
+ * so the value is what says which store the access reaches.
+ */
+
+/** One Worker as deployed: an environment's document over the default one. */
+interface Deployment {
+    /** The name Cloudflare deploys this script under. */
+    scriptName: string;
+    /** The environment this deployment is, or null for the default one. */
+    environment: string | null;
+    /** The environment's document with the top-level one behind it. */
+    merged: WranglerDocument;
+    /** Which variables the top-level document supplied rather than this one. */
+    inherited: Set<string>;
+}
+/**
+ * Every deployment a document declares. Wrangler deploys the top-level
+ * document as one Worker and each `[env.<name>]` as another, and an
+ * environment with no `name` of its own is deployed as
+ * `<name>-<environment>`.
+ */
+declare function environmentDocuments(document: WranglerDocument): Deployment[];
+
+/**
+ * @suss/contract-wrangler: behavioral summaries from a Wrangler
+ * configuration document.
+ *
+ * A `wrangler.toml` deploys a working Worker, and before this reader
+ * existed suss saw none of it: no deployable unit, no configuration
+ * contract, no stores and no queues. `name` and `main` give the unit
+ * and the code it runs, `vars` gives the configuration, the three
+ * binding blocks give stores, `queues` gives the channels it sends on
+ * and drains, and each `env.<name>` deploys the same Worker again with
+ * the top-level document as its default. The README says how each half
+ * pairs.
+ */
+
+interface WranglerToSummariesOptions {
+    /** Override the logical source file recorded on each summary. */
+    source?: string;
+    /**
+     * The directory the Worker's code is in, relative to wherever the
+     * extraction run was pointed. Defaults to where the document is,
+     * relative to the working directory.
+     */
+    codeScope?: string;
+}
+declare function wranglerToSummaries(document: WranglerDocument, options: {
+    source: string;
+    codeScope: string;
+}): BehavioralSummary[];
+/** The path may be the document itself or the directory the Worker is in. */
+declare function wranglerFileToSummaries(target: string, options?: WranglerToSummariesOptions): BehavioralSummary[];
+
+export { CONFIGURATION_FILE_NAMES, type DocumentLocation, RECOGNITION, type WranglerDocument, type WranglerRecord, type WranglerToSummariesOptions, environmentDocuments, isConfigurationFile, loadConfigurationDocument, locateConfigurationFile, wranglerFileToSummaries, wranglerToSummaries };

package/dist/index.d.ts

@@ -0,0 +1,133 @@
+import { BehavioralSummary } from '@suss/behavioral-ir';
+
+/**
+ * Finding and parsing a Wrangler configuration document.
+ *
+ * Wrangler accepts the same configuration in two spellings, TOML and
+ * JSONC, and prefers the JSON one where a project has both. This module
+ * settles which file a path means and hands back the parsed object; the
+ * shape of what is in it is `translate.ts`'s problem.
+ */
+/**
+ * The names Wrangler looks for, in the order it prefers them. Wrangler
+ * defines the list, so a project that spells its file otherwise passes
+ * the path to that file outright.
+ */
+declare const CONFIGURATION_FILE_NAMES: string[];
+/** Whether a file is one Wrangler would read as a Worker's configuration. */
+declare function isConfigurationFile(basename: string): boolean;
+/** One binding a Worker is given, as Wrangler writes it. */
+type WranglerRecord = Record<string, unknown>;
+/**
+ * A parsed Wrangler document, top-level and per-environment alike. The
+ * fields are Wrangler's own names, and everything is optional because
+ * every one of them is optional in the file.
+ */
+interface WranglerDocument {
+    name?: string;
+    main?: string;
+    vars?: Record<string, unknown>;
+    kv_namespaces?: WranglerRecord[];
+    r2_buckets?: WranglerRecord[];
+    d1_databases?: WranglerRecord[];
+    queues?: {
+        producers?: WranglerRecord[];
+        consumers?: WranglerRecord[];
+    };
+    env?: Record<string, WranglerDocument>;
+    [key: string]: unknown;
+}
+type DocumentLocation = {
+    kind: "file";
+    file: string;
+} | {
+    kind: "missing";
+};
+/**
+ * The configuration file a path means. A path may be the file itself or
+ * the directory a Worker lives in, since that is where a person points
+ * when they mean the Worker rather than one of its two spellings.
+ */
+declare function locateConfigurationFile(target: string): DocumentLocation;
+/** The document a file contains, read by whichever parser its suffix asks for. */
+declare function loadConfigurationDocument(file: string): WranglerDocument;
+
+/**
+ * The stores and queues a Worker is bound to, as boundary summaries.
+ *
+ * Every binding block in a Wrangler document has the same two halves:
+ * `binding`, the name the code reads it under, and a key giving the
+ * resource's own name. The code says the first, the deployment declares the
+ * second, so a summary keeps both: the container is the resource's own
+ * name, which is what another manifest declaring that resource spells,
+ * and `physicalTable` records it again for a reader.
+ */
+
+/** The manifest language recorded on every binding this reader writes. */
+declare const RECOGNITION = "wrangler";
+
+/**
+ * The configuration contract a Wrangler document declares.
+ *
+ * A Worker reads its variables off the second argument to every
+ * trigger, so the channel is the same one a Node process reads through
+ * `process.env`, and the summary is the same shape the CloudFormation
+ * reader writes for a Lambda: a runtime-config provider, one per
+ * deployment, keyed on the deployable unit.
+ *
+ * The values go on it as well as the names. A Worker addresses a store
+ * through a variable rather than by name, `TableName: env.EDITION_TABLE`,
+ * so the value is what says which store the access reaches.
+ */
+
+/** One Worker as deployed: an environment's document over the default one. */
+interface Deployment {
+    /** The name Cloudflare deploys this script under. */
+    scriptName: string;
+    /** The environment this deployment is, or null for the default one. */
+    environment: string | null;
+    /** The environment's document with the top-level one behind it. */
+    merged: WranglerDocument;
+    /** Which variables the top-level document supplied rather than this one. */
+    inherited: Set<string>;
+}
+/**
+ * Every deployment a document declares. Wrangler deploys the top-level
+ * document as one Worker and each `[env.<name>]` as another, and an
+ * environment with no `name` of its own is deployed as
+ * `<name>-<environment>`.
+ */
+declare function environmentDocuments(document: WranglerDocument): Deployment[];
+
+/**
+ * @suss/contract-wrangler: behavioral summaries from a Wrangler
+ * configuration document.
+ *
+ * A `wrangler.toml` deploys a working Worker, and before this reader
+ * existed suss saw none of it: no deployable unit, no configuration
+ * contract, no stores and no queues. `name` and `main` give the unit
+ * and the code it runs, `vars` gives the configuration, the three
+ * binding blocks give stores, `queues` gives the channels it sends on
+ * and drains, and each `env.<name>` deploys the same Worker again with
+ * the top-level document as its default. The README says how each half
+ * pairs.
+ */
+
+interface WranglerToSummariesOptions {
+    /** Override the logical source file recorded on each summary. */
+    source?: string;
+    /**
+     * The directory the Worker's code is in, relative to wherever the
+     * extraction run was pointed. Defaults to where the document is,
+     * relative to the working directory.
+     */
+    codeScope?: string;
+}
+declare function wranglerToSummaries(document: WranglerDocument, options: {
+    source: string;
+    codeScope: string;
+}): BehavioralSummary[];
+/** The path may be the document itself or the directory the Worker is in. */
+declare function wranglerFileToSummaries(target: string, options?: WranglerToSummariesOptions): BehavioralSummary[];
+
+export { CONFIGURATION_FILE_NAMES, type DocumentLocation, RECOGNITION, type WranglerDocument, type WranglerRecord, type WranglerToSummariesOptions, environmentDocuments, isConfigurationFile, loadConfigurationDocument, locateConfigurationFile, wranglerFileToSummaries, wranglerToSummaries };

package/dist/index.js

@@ -0,0 +1,334 @@
+// src/index.ts
+import path2 from "path";
+import { codeScopePath } from "@suss/ir-core";
+
+// src/bindings.ts
+import { messageBusBinding, storageBinding } from "@suss/behavioral-ir";
+var RECOGNITION = "wrangler";
+var STORES = [
+  {
+    block: "kv_namespaces",
+    nameKey: "id",
+    storageSystem: "cloudflare-kv",
+    fieldSet: "none"
+  },
+  {
+    block: "r2_buckets",
+    nameKey: "bucket_name",
+    storageSystem: "r2",
+    fieldSet: "none"
+  },
+  {
+    block: "d1_databases",
+    nameKey: "database_name",
+    storageSystem: "d1",
+    fieldSet: "partial"
+  }
+];
+function storeSummaries(document, context) {
+  const summaries = [];
+  for (const store of STORES) {
+    for (const entry of blockEntries(document[store.block])) {
+      const summary = storeSummary(store, entry, context);
+      if (summary !== null) {
+        summaries.push(summary);
+      }
+    }
+  }
+  return summaries;
+}
+function storeSummary(store, entry, context) {
+  const container = stringOf(entry[store.nameKey]);
+  const boundAs = stringOf(entry.binding);
+  if (container === null) {
+    return null;
+  }
+  return {
+    kind: "library",
+    location: {
+      file: context.sourceFile,
+      range: { start: 1, end: 1 },
+      exportName: null
+    },
+    identity: {
+      name: `${store.block}.${boundAs ?? container}`,
+      exportPath: null,
+      boundaryBinding: storageBinding({
+        recognition: RECOGNITION,
+        storageSystem: store.storageSystem,
+        scope: "default",
+        container,
+        accessPath: null
+      })
+    },
+    inputs: [],
+    transitions: [],
+    gaps: [],
+    confidence: { source: "declared", level: "high" },
+    metadata: {
+      storageContract: { fieldSet: store.fieldSet, physicalTable: container },
+      ...boundAs === null ? {} : { wrangler: { binding: boundAs } }
+    }
+  };
+}
+function queueSummaries(document, context) {
+  const queues = document.queues;
+  if (queues === null || typeof queues !== "object") {
+    return [];
+  }
+  const block = queues;
+  return [
+    ...queueSide(blockEntries(block.producers), "producers", context),
+    ...queueSide(blockEntries(block.consumers), "consumers", context)
+  ];
+}
+function queueSide(entries, side, context) {
+  const summaries = [];
+  for (const entry of entries) {
+    const channel = stringOf(entry.queue);
+    if (channel === null) {
+      continue;
+    }
+    summaries.push({
+      // A producer block declares a queue the Worker sends to, which is
+      // a channel rather than a unit that runs, so it is a library. A
+      // consumer block says this Worker drains that queue.
+      kind: side === "consumers" ? "consumer" : "library",
+      location: {
+        file: context.sourceFile,
+        range: { start: 1, end: 1 },
+        exportName: null
+      },
+      identity: {
+        name: side === "consumers" ? `${context.scriptName}.queue.${channel}` : `queues.producers.${channel}`,
+        exportPath: null,
+        boundaryBinding: messageBusBinding({
+          recognition: RECOGNITION,
+          messageBus: "cloudflare-queues",
+          channel
+        }),
+        ...side === "consumers" ? {
+          deployableUnit: {
+            deploymentTarget: "worker",
+            instanceName: context.scriptName
+          }
+        } : {}
+      },
+      inputs: [],
+      transitions: [],
+      gaps: [],
+      confidence: { source: "declared", level: "high" },
+      metadata: { messageBus: { queue: channel } }
+    });
+  }
+  return summaries;
+}
+function blockEntries(raw) {
+  if (!Array.isArray(raw)) {
+    return [];
+  }
+  return raw.filter(
+    (entry) => entry !== null && typeof entry === "object" && !Array.isArray(entry)
+  );
+}
+function stringOf(raw) {
+  return typeof raw === "string" && raw.length > 0 ? raw : null;
+}
+
+// src/document.ts
+import fs from "fs";
+import path from "path";
+import { parse as parseJsonc } from "jsonc-parser";
+import { parse as parseToml } from "smol-toml";
+var CONFIGURATION_FILE_NAMES = [
+  "wrangler.jsonc",
+  "wrangler.json",
+  "wrangler.toml"
+];
+function isConfigurationFile(basename) {
+  return CONFIGURATION_FILE_NAMES.includes(basename);
+}
+function locateConfigurationFile(target) {
+  const resolved = path.resolve(target);
+  if (!fs.existsSync(resolved)) {
+    return { kind: "missing" };
+  }
+  if (fs.statSync(resolved).isFile()) {
+    return { kind: "file", file: resolved };
+  }
+  for (const name of CONFIGURATION_FILE_NAMES) {
+    const candidate = path.join(resolved, name);
+    if (fs.existsSync(candidate)) {
+      return { kind: "file", file: candidate };
+    }
+  }
+  return { kind: "missing" };
+}
+function loadConfigurationDocument(file) {
+  const text = fs.readFileSync(file, "utf8");
+  const parsed = file.endsWith(".toml") ? parseToml(text) : parseJsonc(text);
+  if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
+    throw new Error(`${file} does not contain a Wrangler configuration object`);
+  }
+  return parsed;
+}
+
+// src/runtimeConfig.ts
+import { withRuntimeContractMetadata } from "@suss/behavioral-ir";
+import { runtimeConfigBinding } from "@suss/ir-core";
+function environmentDocuments(document) {
+  const rootName = nameOf(document) ?? "worker";
+  const deployments = [
+    {
+      scriptName: rootName,
+      environment: null,
+      merged: document,
+      inherited: /* @__PURE__ */ new Set()
+    }
+  ];
+  const environments = document.env;
+  if (environments === null || typeof environments !== "object") {
+    return deployments;
+  }
+  for (const [environment, raw] of Object.entries(environments)) {
+    if (raw === null || typeof raw !== "object") {
+      continue;
+    }
+    const overrides = raw;
+    const merged = { ...document, ...overrides };
+    delete merged.env;
+    deployments.push({
+      scriptName: nameOf(overrides) ?? `${rootName}-${environment}`,
+      environment,
+      merged,
+      inherited: inheritedNames(document, overrides)
+    });
+  }
+  return deployments;
+}
+function inheritedNames(document, overrides) {
+  if (overrides.vars !== void 0) {
+    return /* @__PURE__ */ new Set();
+  }
+  return new Set(Object.keys(varsOf(document)));
+}
+function nameOf(document) {
+  return typeof document.name === "string" && document.name.length > 0 ? document.name : null;
+}
+function varsOf(document) {
+  const vars = document.vars;
+  return vars !== null && typeof vars === "object" && !Array.isArray(vars) ? vars : {};
+}
+function runtimeConfigSummary(deployment, context) {
+  const vars = varsOf(deployment.merged);
+  const names = Object.keys(vars).sort();
+  const sources = {};
+  const values = {};
+  for (const name of names) {
+    sources[name] = deployment.inherited.has(name) ? "globals" : "template";
+    const value = vars[name];
+    if (typeof value === "string") {
+      values[name] = value;
+    }
+  }
+  const deployableUnit = {
+    deploymentTarget: "worker",
+    instanceName: deployment.scriptName
+  };
+  return {
+    kind: "library",
+    location: {
+      file: context.sourceFile,
+      range: { start: 1, end: 1 },
+      exportName: null
+    },
+    identity: {
+      name: deployment.scriptName,
+      exportPath: null,
+      boundaryBinding: runtimeConfigBinding({
+        recognition: RECOGNITION,
+        ...deployableUnit
+      }),
+      deployableUnit
+    },
+    inputs: [],
+    transitions: [],
+    gaps: [],
+    confidence: { source: "declared", level: "high" },
+    metadata: withRuntimeContractMetadata(
+      { codeScope: context.codeScope },
+      {
+        envVars: names,
+        envVarSources: sources,
+        ...Object.keys(values).length > 0 ? { envVarValues: values } : {}
+      }
+    )
+  };
+}
+
+// src/index.ts
+function wranglerToSummaries(document, options) {
+  const summaries = [];
+  const named = /* @__PURE__ */ new Set();
+  for (const deployment of environmentDocuments(document)) {
+    const context = {
+      sourceFile: options.source,
+      scriptName: deployment.scriptName
+    };
+    summaries.push(
+      runtimeConfigSummary(deployment, {
+        sourceFile: options.source,
+        codeScope: codeScopeFor(deployment.merged, options.codeScope)
+      })
+    );
+    for (const summary of [
+      ...storeSummaries(deployment.merged, context),
+      ...queueSummaries(deployment.merged, context)
+    ]) {
+      if (named.has(summary.identity.name)) {
+        continue;
+      }
+      named.add(summary.identity.name);
+      summaries.push(summary);
+    }
+  }
+  return summaries;
+}
+function wranglerFileToSummaries(target, options = {}) {
+  const located = locateConfigurationFile(target);
+  if (located.kind === "missing") {
+    throw new Error(`Wrangler configuration not found: ${target}`);
+  }
+  const document = loadConfigurationDocument(located.file);
+  return wranglerToSummaries(document, {
+    source: options.source ?? `${RECOGNITION}:${relativeToRun(located.file)}`,
+    codeScope: options.codeScope ?? codeScopePath(path2.dirname(relativeToRun(located.file)))
+  });
+}
+function relativeToRun(file) {
+  const relative = path2.relative(process.cwd(), path2.resolve(file));
+  if (relative === "" || relative.startsWith("..")) {
+    return path2.resolve(file).split(path2.sep).join("/");
+  }
+  return relative.split(path2.sep).join("/");
+}
+function codeScopeFor(document, scope) {
+  const main = typeof document.main === "string" ? document.main : null;
+  if (main === null) {
+    return { kind: "codeUri", path: scope };
+  }
+  const entry = codeScopePath(
+    path2.posix.join(scope, main.replace(/\.[cm]?[jt]sx?$/, ""))
+  );
+  return { kind: "codeUri", path: scope, entry };
+}
+export {
+  CONFIGURATION_FILE_NAMES,
+  RECOGNITION,
+  environmentDocuments,
+  isConfigurationFile,
+  loadConfigurationDocument,
+  locateConfigurationFile,
+  wranglerFileToSummaries,
+  wranglerToSummaries
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@suss/contract-wrangler",
+  "version": "0.8.0",
+  "type": "module",
+  "description": "Generate suss behavioral summaries from a Cloudflare wrangler.toml or wrangler.jsonc.",
+  "keywords": [
+    "suss",
+    "behavioral-summary",
+    "cloudflare",
+    "workers",
+    "wrangler"
+  ],
+  "license": "Apache-2.0",
+  "author": "Nimbus Cloud AI LLC",
+  "homepage": "https://github.com/nimbuscloud-ai/suss/tree/main/packages/contract/wrangler#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nimbuscloud-ai/suss.git",
+    "directory": "packages/contract/wrangler"
+  },
+  "bugs": {
+    "url": "https://github.com/nimbuscloud-ai/suss/issues"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@suss/behavioral-ir": "0.8.0",
+    "@suss/ir-core": "0.8.0",
+    "jsonc-parser": "^3.3.1",
+    "smol-toml": "^1.4.2"
+  },
+  "devDependencies": {
+    "tsup": "*",
+    "typescript": "*",
+    "vitest": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}