@sponson/sim 0.0.0-stage → 0.4.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @sponson/sim
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A local fake cloud for testing [Sponson](https://github.com/MishaBear94/Sponson#readme): subsets of the Vercel, Neon and Clerk APIs with chaos injection, started in-process with `startSim()` or from the command line with `sponson-sim`.
+
+Documentation: <https://sponson.mintlify.site>. Source and issues: [GitHub](https://github.com/MishaBear94/Sponson).

package/dist/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import { simEnv, startSim } from "./index.js";
+const args = process.argv.slice(2);
+const flag = args.indexOf("--port");
+const port = Number(flag >= 0 ? args[flag + 1] : (process.env.SPONSON_SIM_PORT ?? 4777));
+if (!Number.isInteger(port) || port < 0) {
+    console.error(`invalid port: ${flag >= 0 ? args[flag + 1] : process.env.SPONSON_SIM_PORT}`);
+    process.exit(2);
+}
+const sim = await startSim({ port });
+console.log(`sponson-sim listening on ${sim.url}`);
+// Everything the adapters need to talk to the sim, base URLs and placeholder tokens alike, ready to paste into a shell.
+console.log("# paste into another shell to point sponson at the sim:");
+for (const [k, v] of Object.entries(simEnv(sim)))
+    console.log(`export ${k}=${v}`);
+const stop = () => {
+    void sim.close().finally(() => process.exit(0));
+};
+process.on("SIGINT", stop);
+process.on("SIGTERM", stop);
+//# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACnC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,IAAI,CAAC,CAAC,CAAC;AACzF,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;IACxC,OAAO,CAAC,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC5F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AACrC,OAAO,CAAC,GAAG,CAAC,4BAA4B,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;AACnD,wHAAwH;AACxH,OAAO,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAC;AACvE,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAAE,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAElF,MAAM,IAAI,GAAG,GAAG,EAAE;IAChB,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC,CAAC;AACF,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC3B,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC"}

package/dist/chaos.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Chaos configuration: what the fake cloud does wrong on purpose, and which requests it does it to. Set it with
+ * `POST /_chaos` or a seed's `chaos:`; counters (`*_next`) decrement per matching request.
+ */
+export interface ChaosConfig {
+    latency_ms: number;
+    /** Remaining requests (matching `fail_on`) that will fail with `status`. */
+    fail_next: number;
+    status: number;
+    /** Sent as `Retry-After` (seconds) with chaos 429s. */
+    retry_after?: number;
+    /** Remaining requests (matching `fail_on`) that are performed, then answered by destroying the socket. */
+    drop_response_next: number;
+    /** Remaining requests (matching `fail_on`) that are accepted and never answered. */
+    hang_next: number;
+    /**
+     * Remaining requests (matching `fail_on`) that are held, neither performed nor answered, until released
+     * (`POST /_release` or `state.release()`); then they are performed and answered as usual. Lets a test pin
+     * one client inside a request while another runs, instead of hoping timing makes them overlap.
+     */
+    hold_next: number;
+    /**
+     * Which requests the counters above apply to: `"METHOD /path-glob"` or a list of them.
+     * Absent means every write. Reads are only affected by a rule whose method is GET.
+     */
+    fail_on?: string | string[];
+    /** Deployment mode: ok | never | fail | stale | double | cancel | delay:<seconds>. */
+    deploy: string;
+    /** QUEUED → BUILDING → READY takes this long for deployments created through the API (and `ok` auto-deploys). */
+    deploy_ms: number;
+    /** After a Neon branch create, writes to that branch and further creates in the project answer 423 for this long. */
+    neon_op_ms: number;
+    /** When > 0, Neon branches, Vercel envs and Clerk redirect URLs are listed in pages of this size. */
+    page_size: number;
+    /** Keys a Vercel bulk upsert reports under `failed` (and does not write). */
+    env_upsert_fail: string[];
+}
+/** The body of `POST /_chaos`: any chaos settings to merge, plus drift to apply immediately. */
+export interface ChaosRequest extends Partial<ChaosConfig> {
+    /** Applied immediately to state, not stored. */
+    drift?: Record<string, string>;
+}
+/** What chaos does to one request. */
+export type ChaosAction = {
+    kind: "hold";
+} | {
+    kind: "hang";
+} | {
+    kind: "drop";
+} | {
+    kind: "fail";
+    status: number;
+    headers: Record<string, string>;
+};
+/** No chaos: every request is answered normally and immediately. */
+export declare const DEFAULT_CHAOS: ChaosConfig;
+/**
+ * Every key `POST /_chaos` accepts besides `drift`; anything else is rejected so a misspelt key cannot silently
+ * do nothing.
+ */
+export declare const CHAOS_KEYS: Set<string>;
+/** A fresh default config (no shared arrays). */
+export declare function defaultChaos(): ChaosConfig;
+/**
+ * Decide what chaos does to this request, consuming one count of `c` when it does something.
+ * Writes are eligible when `fail_on` is absent or matches; reads only when a GET rule matches.
+ */
+export declare function chaosFor(c: ChaosConfig, method: string, path: string): ChaosAction | null;
+/** `"DELETE /neon/*"`: method must match exactly (or be `*`), `*` in the path matches anything. */
+export declare function matchesRule(rule: string, method: string, path: string): boolean;

package/dist/chaos.js

@@ -0,0 +1,78 @@
+/** No chaos: every request is answered normally and immediately. */
+export const DEFAULT_CHAOS = {
+    latency_ms: 0,
+    fail_next: 0,
+    status: 503,
+    drop_response_next: 0,
+    hang_next: 0,
+    hold_next: 0,
+    deploy: "ok",
+    deploy_ms: 0,
+    neon_op_ms: 0,
+    page_size: 0,
+    env_upsert_fail: [],
+};
+/**
+ * Every key `POST /_chaos` accepts besides `drift`; anything else is rejected so a misspelt key cannot silently
+ * do nothing.
+ */
+export const CHAOS_KEYS = new Set([...Object.keys(DEFAULT_CHAOS), "fail_on", "retry_after"]);
+/** A fresh default config (no shared arrays). */
+export function defaultChaos() {
+    return { ...DEFAULT_CHAOS, env_upsert_fail: [] };
+}
+/**
+ * Decide what chaos does to this request, consuming one count of `c` when it does something.
+ * Writes are eligible when `fail_on` is absent or matches; reads only when a GET rule matches.
+ */
+export function chaosFor(c, method, path) {
+    if (c.hold_next <= 0 && c.hang_next <= 0 && c.drop_response_next <= 0 && c.fail_next <= 0)
+        return null;
+    return affected(c, method, path) ? consume(c) : null;
+}
+/** Whether `fail_on` lets chaos hit this request: writes by default, reads only when a GET rule names them. */
+function affected(c, method, path) {
+    const rules = c.fail_on === undefined ? [] : Array.isArray(c.fail_on) ? c.fail_on : [c.fail_on];
+    if (method === "GET" || method === "HEAD")
+        return rules.some((r) => ruleMethod(r) === "GET" && matchesRule(r, "GET", path));
+    return rules.length === 0 || rules.some((r) => matchesRule(r, method, path));
+}
+/** Use up one pending chaos action, in the order hold, hang, drop, fail. */
+function consume(c) {
+    if (c.hold_next > 0) {
+        c.hold_next -= 1;
+        return { kind: "hold" };
+    }
+    if (c.hang_next > 0) {
+        c.hang_next -= 1;
+        return { kind: "hang" };
+    }
+    if (c.drop_response_next > 0) {
+        c.drop_response_next -= 1;
+        return { kind: "drop" };
+    }
+    if (c.fail_next > 0) {
+        c.fail_next -= 1;
+        const headers = c.status === 429 && c.retry_after !== undefined ? { "retry-after": String(c.retry_after) } : {};
+        return { kind: "fail", status: c.status, headers };
+    }
+    return null;
+}
+/** `"DELETE /neon/*"`: method must match exactly (or be `*`), `*` in the path matches anything. */
+export function matchesRule(rule, method, path) {
+    const space = rule.indexOf(" ");
+    const m = ruleMethod(rule);
+    const ruleGlob = space < 0 ? "*" : rule.slice(space + 1).trim();
+    if (m !== "*" && m !== method.toUpperCase())
+        return false;
+    const re = new RegExp("^" + ruleGlob.split("*").map(escapeRe).join(".*") + "$");
+    return re.test(path);
+}
+function escapeRe(s) {
+    return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+function ruleMethod(rule) {
+    const space = rule.indexOf(" ");
+    return (space < 0 ? rule : rule.slice(0, space)).toUpperCase();
+}
+//# sourceMappingURL=chaos.js.map

package/dist/chaos.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chaos.js","sourceRoot":"","sources":["../src/chaos.ts"],"names":[],"mappings":"AA+CA,oEAAoE;AACpE,MAAM,CAAC,MAAM,aAAa,GAAgB;IACxC,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,CAAC;IACZ,MAAM,EAAE,GAAG;IACX,kBAAkB,EAAE,CAAC;IACrB,SAAS,EAAE,CAAC;IACZ,SAAS,EAAE,CAAC;IACZ,MAAM,EAAE,IAAI;IACZ,SAAS,EAAE,CAAC;IACZ,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,CAAC;IACZ,eAAe,EAAE,EAAE;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,GAAG,CAAS,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;AAErG,iDAAiD;AACjD,MAAM,UAAU,YAAY;IAC1B,OAAO,EAAE,GAAG,aAAa,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAc,EAAE,MAAc,EAAE,IAAY;IACnE,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACvG,OAAO,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACvD,CAAC;AAED,+GAA+G;AAC/G,SAAS,QAAQ,CAAC,CAAc,EAAE,MAAc,EAAE,IAAY;IAC5D,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAChG,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5H,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,4EAA4E;AAC5E,SAAS,OAAO,CAAC,CAAc;IAC7B,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;QACpB,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC;QACjB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;QACpB,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC;QACjB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,CAAC,CAAC,kBAAkB,GAAG,CAAC,EAAE,CAAC;QAC7B,CAAC,CAAC,kBAAkB,IAAI,CAAC,CAAC;QAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;QACpB,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC;QACjB,MAAM,OAAO,GAA2B,CAAC,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxI,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;IACrD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,mGAAmG;AACnG,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,MAAc,EAAE,IAAY;IACpE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAC3B,MAAM,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAChE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,MAAM,CAAC,WAAW,EAAE;QAAE,OAAO,KAAK,CAAC;IAC1D,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;IAChF,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AAED,SAAS,QAAQ,CAAC,CAAS;IACzB,OAAO,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;AACjE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { SimState, type SimSeed } from "./state.js";
+export * from "./chaos.js";
+export * from "./provider.js";
+export * from "./state.js";
+export * from "./routes/vercel.js";
+export * from "./routes/neon.js";
+export * from "./routes/clerk.js";
+export { createSimServer } from "./server.js";
+/**
+ * A running sim: its base URL (`simEnv` turns it into adapter environment), its live state for seeding and
+ * assertions, and `close`.
+ */
+export interface SimHandle {
+    url: string;
+    port: number;
+    state: SimState;
+    close(): Promise<void>;
+}
+/** Start the fake cloud on 127.0.0.1. Port 0 picks a free one, which is what tests want. */
+export declare function startSim(opts?: {
+    port?: number;
+    seed?: Partial<SimSeed>;
+}): Promise<SimHandle>;
+/** A placeholder credential per provider (`VERCEL_TOKEN: "tok_vercel"`, …). The sim accepts any non-empty token. */
+export declare const SIM_TOKENS: Readonly<Record<string, string>>;
+/**
+ * The env that points every provider's adapter at a sim (or at a proxy in front of one): each `*_API_URL`
+ * and, unless `tokens: false`, the placeholder credentials of SIM_TOKENS.
+ */
+export declare function simEnv(sim: {
+    url: string;
+} | string, opts?: {
+    tokens?: boolean;
+}): Record<string, string>;

package/dist/index.js

@@ -0,0 +1,42 @@
+import { createSimServer } from "./server.js";
+import { providerEntries, SimState } from "./state.js";
+export * from "./chaos.js";
+export * from "./provider.js";
+export * from "./state.js";
+export * from "./routes/vercel.js";
+export * from "./routes/neon.js";
+export * from "./routes/clerk.js";
+export { createSimServer } from "./server.js";
+/** Start the fake cloud on 127.0.0.1. Port 0 picks a free one, which is what tests want. */
+export async function startSim(opts = {}) {
+    const state = new SimState(opts.seed);
+    const server = createSimServer(state);
+    await new Promise((resolve, reject) => {
+        server.once("error", reject);
+        server.listen(opts.port ?? 0, "127.0.0.1", () => resolve());
+    });
+    const port = server.address().port;
+    return {
+        url: `http://127.0.0.1:${port}`,
+        port,
+        state,
+        close: () => new Promise((resolve, reject) => {
+            server.closeAllConnections();
+            server.close((e) => (e ? reject(e) : resolve()));
+        }),
+    };
+}
+/** A placeholder credential per provider (`VERCEL_TOKEN: "tok_vercel"`, …). The sim accepts any non-empty token. */
+export const SIM_TOKENS = Object.fromEntries(providerEntries().map(([, p]) => [p.env.token, p.env.testToken]));
+/**
+ * The env that points every provider's adapter at a sim (or at a proxy in front of one): each `*_API_URL`
+ * and, unless `tokens: false`, the placeholder credentials of SIM_TOKENS.
+ */
+export function simEnv(sim, opts = {}) {
+    const base = typeof sim === "string" ? sim : sim.url;
+    const env = opts.tokens === false ? {} : { ...SIM_TOKENS };
+    for (const [name, p] of providerEntries())
+        env[p.env.url] = `${base}/${name}`;
+    return env;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAgB,MAAM,YAAY,CAAC;AAErE,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAa9C,4FAA4F;AAC5F,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,OAAmD,EAAE;IAClF,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACtC,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAI,MAAM,CAAC,OAAO,EAAkB,CAAC,IAAI,CAAC;IACpD,OAAO;QACL,GAAG,EAAE,oBAAoB,IAAI,EAAE;QAC/B,IAAI;QACJ,KAAK;QACL,KAAK,EAAE,GAAG,EAAE,CACV,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpC,MAAM,CAAC,mBAAmB,EAAE,CAAC;YAC7B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC;KACL,CAAC;AACJ,CAAC;AAED,oHAAoH;AACpH,MAAM,CAAC,MAAM,UAAU,GAAqC,MAAM,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAEjJ;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,GAA6B,EAAE,OAA6B,EAAE;IACnF,MAAM,IAAI,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IACrD,MAAM,GAAG,GAA2B,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC;IACnF,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,eAAe,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IAC9E,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/provider.d.ts

@@ -0,0 +1,99 @@
+/**
+ * The contract between the sim core (chaos, write log, ids, control endpoints) and one simulated provider.
+ * A provider lives in one `routes/<name>.ts` file: its state, its seed, its drift keys and its HTTP routes.
+ * Adding a provider = writing that file and registering it in `PROVIDERS` (state.ts).
+ */
+import type { ChaosConfig } from "./chaos.js";
+/** Who made a record: the sim itself (seed, drift, a "human in the console") or a client through the API. */
+export type CreatedBy = "sim" | "api";
+/** What a provider needs from the core. */
+export interface SimCore {
+    chaos: ChaosConfig;
+    /** Ids are unique across providers and deterministic after a reset. */
+    nextId(prefix: string): string;
+}
+/** A route's answer: status, JSON body and extra headers. Routes return one instead of writing to the socket. */
+export declare class Reply {
+    status: number;
+    body: unknown;
+    headers: Record<string, string>;
+    constructor(status: number, body: unknown, headers?: Record<string, string>);
+}
+/** One request as a provider's routes see it, after auth and chaos. */
+export interface RouteRequest {
+    method: string;
+    url: URL;
+    /** The path with the provider prefix stripped, e.g. `/v10/projects/prj_demo/env`. */
+    path: string;
+    body: unknown;
+}
+/** One `<provider>.<rest>` drift key, as `ProviderSim.drift` receives it: a change "a human made in the console". */
+export interface DriftRequest {
+    /** The whole drift key, for error messages. */
+    key: string;
+    /** The key after `<provider>.` or `<provider>:<project>.`, e.g. `env.preview.API_URL`. */
+    rest: string;
+    value: string;
+    /** `<project>` from a `<provider>:<project>.` key: only that project is affected. */
+    only?: string;
+}
+/**
+ * One simulated provider: its state, seed, drift keys and HTTP routes. Implement it in `routes/<name>.ts` and
+ * register it in `PROVIDERS` to simulate a new provider.
+ *
+ * Members are methods (not function-valued properties) so a `ProviderSim<VercelState, …>` is usable where the
+ * registry only knows `ProviderSim<unknown, unknown>`.
+ */
+export interface ProviderSim<S, Seed> {
+    /** Env var names the adapter reads its credential and base URL from, and the token the sim hands out. */
+    env: {
+        token: string;
+        url: string;
+        testToken: string;
+    };
+    /** Seed used when a reset does not name this provider. */
+    defaultSeed: Seed;
+    /** Fresh state from a seed (`undefined`: empty). Called on every reset, in registry order. */
+    reset(core: SimCore, seed: Seed | undefined): S;
+    /** Apply one drift key to the state; false when the key is not one this provider knows. */
+    drift(core: SimCore, state: S, d: DriftRequest): boolean;
+    /** Answer one authenticated, chaos-checked request under `/<name>/`. */
+    routes(core: SimCore, state: S, req: RouteRequest): Reply;
+}
+/** One page of `list` under chaos `page_size`, starting at the opaque numeric cursor. */
+export declare function page<T>(core: SimCore, list: T[], cursor: string | null, limit?: number): {
+    items: T[];
+    next: number | null;
+};
+/** The `:name` segments of a route path, e.g. `"project" | "id"` for `/v9/projects/:project/env/:id`. */
+type ParamNames<P extends string> = P extends `${string}:${infer N}/${infer Rest}` ? N | ParamNames<`/${Rest}`> : P extends `${string}:${infer N}` ? N : never;
+/** The decoded `:name` segments of a matched path, typed from the route's path literal. */
+export type PathParams<P extends string> = {
+    [K in ParamNames<P>]: string;
+};
+/** What a route's handler receives. */
+export interface RouteContext<S, Params = Record<string, string>> {
+    core: SimCore;
+    state: S;
+    params: Params;
+    url: URL;
+    body: unknown;
+}
+/** One route of a simulated provider. Build it with `route`; serve a list of them with `router`. */
+export interface Route<S> {
+    method: string;
+    path: string;
+    handle(ctx: RouteContext<S>): Reply;
+}
+/**
+ * A route: an HTTP method, a path whose `:name` segments match one non-empty path segment each, and the handler
+ * that answers it. `params` is typed from the path: `route("GET", "/projects/:project", ({ params }) => …)` gets
+ * `params.project: string`.
+ */
+export declare function route<S, P extends string>(method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE", path: P, handle: (ctx: RouteContext<S, PathParams<P>>) => Reply): Route<S>;
+/**
+ * A provider's `routes`: the first route whose method and path match answers; when none does, `fallback` (the
+ * provider's own "not found" body). Path patterns are compiled once, here.
+ */
+export declare function router<S>(routes: Array<Route<S>>, fallback: () => Reply): (core: SimCore, state: S, req: RouteRequest) => Reply;
+export {};

package/dist/provider.js

@@ -0,0 +1,62 @@
+/** A route's answer: status, JSON body and extra headers. Routes return one instead of writing to the socket. */
+export class Reply {
+    status;
+    body;
+    headers;
+    constructor(status, body, headers = {}) {
+        this.status = status;
+        this.body = body;
+        this.headers = headers;
+    }
+}
+/** One page of `list` under chaos `page_size`, starting at the opaque numeric cursor. */
+export function page(core, list, cursor, limit) {
+    // Unpaginated (the default): everything, whatever cursor the client sends.
+    if (core.chaos.page_size <= 0 && limit === undefined)
+        return { items: list, next: null };
+    const size = core.chaos.page_size > 0 ? Math.min(core.chaos.page_size, limit ?? Infinity) : (limit ?? list.length);
+    const start = cursor !== null && /^\d+$/.test(cursor) ? Number(cursor) : 0;
+    const items = list.slice(start, start + size);
+    return { items, next: start + size < list.length ? start + size : null };
+}
+/**
+ * A route: an HTTP method, a path whose `:name` segments match one non-empty path segment each, and the handler
+ * that answers it. `params` is typed from the path: `route("GET", "/projects/:project", ({ params }) => …)` gets
+ * `params.project: string`.
+ */
+export function route(method, path, handle) {
+    // `router` only calls a handler with the params its own path declares.
+    return { method, path, handle: handle };
+}
+/**
+ * A provider's `routes`: the first route whose method and path match answers; when none does, `fallback` (the
+ * provider's own "not found" body). Path patterns are compiled once, here.
+ */
+export function router(routes, fallback) {
+    const compiled = routes.map((r) => {
+        const names = [];
+        const source = r.path
+            .split("/")
+            .map((seg) => {
+            if (!seg.startsWith(":"))
+                return seg.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+            names.push(seg.slice(1));
+            return "([^/]+)";
+        })
+            .join("/");
+        return { route: r, pattern: new RegExp(`^${source}$`), names };
+    });
+    return (core, state, req) => {
+        for (const { route: r, pattern, names } of compiled) {
+            if (r.method !== req.method)
+                continue;
+            const m = pattern.exec(req.path);
+            if (!m)
+                continue;
+            const params = Object.fromEntries(names.map((n, i) => [n, decodeURIComponent(m[i + 1])]));
+            return r.handle({ core, state, params, url: req.url, body: req.body });
+        }
+        return fallback();
+    };
+}
+//# sourceMappingURL=provider.js.map

package/dist/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAiBA,iHAAiH;AACjH,MAAM,OAAO,KAAK;IAEP;IACA;IACA;IAHT,YACS,MAAc,EACd,IAAa,EACb,UAAkC,EAAE;QAFpC,WAAM,GAAN,MAAM,CAAQ;QACd,SAAI,GAAJ,IAAI,CAAS;QACb,YAAO,GAAP,OAAO,CAA6B;IAC1C,CAAC;CACL;AA0CD,yFAAyF;AACzF,MAAM,UAAU,IAAI,CAAI,IAAa,EAAE,IAAS,EAAE,MAAqB,EAAE,KAAc;IACrF,2EAA2E;IAC3E,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACzF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IACnH,MAAM,KAAK,GAAG,MAAM,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;IAC9C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAC3E,CAAC;AAwBD;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAsB,MAAmD,EAAE,IAAO,EAAE,MAAsD;IAC7J,uEAAuE;IACvE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAA4B,EAAE,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAI,MAAuB,EAAE,QAAqB;IACtE,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAChC,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI;aAClB,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACX,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,OAAO,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;YAC5E,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;IACjE,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QAC1B,KAAK,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,QAAQ,EAAE,CAAC;YACpD,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM;gBAAE,SAAS;YACtC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,CAAC,CAAC;gBAAE,SAAS;YACjB,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3F,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,QAAQ,EAAE,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC"}