@kensio/simnaril 0.0.0 → 0.1.1

package/dist/rest-resource-operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rest-resource-operation.d.ts","sourceRoot":"","sources":["../src/rest-resource-operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,4DAA4D;AAC5D,MAAM,WAAW,kCAAkC;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,iFAAiF;AACjF,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,OAAO,CAClB,MAAM,CAAC,yBAAyB,EAAE,kCAAkC,CAAC,CACtE,CAAC;IACF,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8CAA8C;AAC9C,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,QAAQ,CAAC;AAEb,0DAA0D;AAC1D,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM;IACtD,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,EAAE,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,GAAG,EAAE,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,IAAI,EAAE,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3D;AAED,wDAAwD;AACxD,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,OAAO;IACvE,MAAM,EAAE,CACN,OAAO,EAAE,wBAAwB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KACvD,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"rest-resource-operation.d.ts","sourceRoot":"","sources":["../src/rest-resource-operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,uEAAuE;AACvE,MAAM,MAAM,eAAe,GAAG,CAC5B,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,KACrC,MAAM,CAAC;AAEZ,iFAAiF;AACjF,MAAM,WAAW,kCAAkC;IACjD,+DAA+D;IAC/D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,2EAA2E;AAC3E,MAAM,MAAM,4BAA4B,GACpC,kCAAkC,GAClC,KAAK,CAAC;AAEV,iFAAiF;AACjF,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,OAAO,CAClB,MAAM,CAAC,yBAAyB,EAAE,4BAA4B,CAAC,CAChE,CAAC;IACF,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8CAA8C;AAC9C,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,QAAQ,CAAC;AAEb,0DAA0D;AAC1D,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM;IACtD,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,EAAE,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,GAAG,EAAE,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,IAAI,EAAE,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3D;AAED,wDAAwD;AACxD,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,OAAO;IACvE,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,CACN,OAAO,EAAE,wBAAwB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,KACvD,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/rest-resource.d.ts

@@ -10,6 +10,8 @@ export declare class RestResource<T extends object> {
     readonly path: string;
     readonly state: SimResource<T>;
     constructor(state: SimResource<T>, props: RestResourceProps);
+    /** Returns the state identity named by matched route parameters. */
+    locate(params: Readonly<Record<string, string>>): string;
     /** Adds middleware around every operation owned by this resource. */
     use(middleware: HttpMiddleware): this;
     /** Adds a named domain action under this resource's collection path. */

package/dist/rest-resource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rest-resource.d.ts","sourceRoot":"","sources":["../src/rest-resource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,8BAA8B,CAAC;AAEtC,QAAA,MAAM,cAAc,eAAiC,CAAC;AAEtD,mEAAmE;AACnE,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM;;IACxC,QAAQ,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAG/B,YAAY,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAQ1D;IAED,qEAAqE;IACrE,GAAG,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI,CAGpC;IAED,wEAAwE;IACxE,SAAS,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,EAC3C,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,GAChD,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAErD;IAED,CAAC,cAAc,CAAC,CACd,iBAAiB,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GACvE,IAAI,CAEN;IAED,yDAAyD;IACzD,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAEjB;IAED,oEAAoE;IACpE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAE3B;IAED,+DAA+D;IAC/D,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,CAEvB;IAED,kDAAkD;IAClD,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAEpC;IAED,+CAA+C;IAC/C,IAAI,IAAI,CAAC,EAAE,CAEV;IAED,8CAA8C;IAC9C,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAE/C;IAED,iDAAiD;IACjD,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,CAE1B;IAED,+CAA+C;IAC/C,KAAK,IAAI,IAAI,CAEZ;CACF;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,MAAM,EACjD,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,EACzB,iBAAiB,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GACvE,IAAI,CAEN"}
+{"version":3,"file":"rest-resource.d.ts","sourceRoot":"","sources":["../src/rest-resource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAEV,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,8BAA8B,CAAC;AAGtC,QAAA,MAAM,cAAc,eAAiC,CAAC;AAEtD,mEAAmE;AACnE,qBAAa,YAAY,CAAC,CAAC,SAAS,MAAM;;IACxC,QAAQ,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAI/B,YAAY,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAO1D;IAED,oEAAoE;IACpE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAEvD;IAED,qEAAqE;IACrE,GAAG,CAAC,UAAU,EAAE,cAAc,GAAG,IAAI,CAGpC;IAED,wEAAwE;IACxE,SAAS,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,EAC3C,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,GAChD,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAErD;IAED,CAAC,cAAc,CAAC,CACd,iBAAiB,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GACvE,IAAI,CAEN;IAED,yDAAyD;IACzD,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAEjB;IAED,oEAAoE;IACpE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAE3B;IAED,+DAA+D;IAC/D,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,CAEvB;IAED,kDAAkD;IAClD,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAEpC;IAED,+CAA+C;IAC/C,IAAI,IAAI,CAAC,EAAE,CAEV;IAED,8CAA8C;IAC9C,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAE/C;IAED,iDAAiD;IACjD,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,CAE1B;IAED,+CAA+C;IAC/C,KAAK,IAAI,IAAI,CAEZ;CACF;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,MAAM,EACjD,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,EACzB,iBAAiB,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GACvE,IAAI,CAEN"}

package/dist/rest-resource.js

@@ -1,17 +1,25 @@
 import { ResourceOperationRegistry } from "./http/resource-operation-registry.js";
+import { requirePathParameter } from "./http/path-parameter.js";
 const attachResource = Symbol("attach REST resource");
 /** Adds conventional HTTP exposure to simulated resource state. */
 export class RestResource {
     operations;
     path;
     state;
+    #locate;
     #operationRegistry;
     constructor(state, props) {
         this.state = state;
         this.path = props.path;
-        this.#operationRegistry = new ResourceOperationRegistry(this, props.operations);
+        this.#locate =
+            props.locate ?? ((params) => requirePathParameter(params, "id"));
+        this.#operationRegistry = new ResourceOperationRegistry(this, props);
         this.operations = this.#operationRegistry.operations;
     }
+    /** Returns the state identity named by matched route parameters. */
+    locate(params) {
+        return this.#locate(params);
+    }
     /** Adds middleware around every operation owned by this resource. */
     use(middleware) {
         this.#operationRegistry.use(middleware);

package/dist/rest-resource.js.map

@@ -1 +1 @@
-{"version":3,"file":"rest-resource.js","sourceRoot":"","sources":["../src/rest-resource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAQlF,MAAM,cAAc,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAEtD,mEAAmE;AACnE,MAAM,OAAO,YAAY;IACd,UAAU,CAA4B;IACtC,IAAI,CAAS;IACb,KAAK,CAAiB;IACtB,kBAAkB,CAA+B;IAE1D,YAAY,KAAqB,EAAE,KAAwB;QACzD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,kBAAkB,GAAG,IAAI,yBAAyB,CACrD,IAAI,EACJ,KAAK,CAAC,UAAU,CACjB,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC;IACvD,CAAC;IAED,qEAAqE;IACrE,GAAG,CAAC,UAA0B;QAC5B,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wEAAwE;IACxE,SAAS,CACP,IAAY,EACZ,KAAiD;QAEjD,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,CAAC,cAAc,CAAC,CACd,iBAAwE;QAExE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACpD,CAAC;IAED,yDAAyD;IACzD,IAAI,CAAC,MAAS;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,oEAAoE;IACpE,MAAM,CAAC,KAAiB;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,+DAA+D;IAC/D,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,kDAAkD;IAClD,IAAI,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,+CAA+C;IAC/C,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,8CAA8C;IAC9C,MAAM,CAAC,QAAgB,EAAE,OAAmB;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,iDAAiD;IACjD,MAAM,CAAC,QAAgB;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,+CAA+C;IAC/C,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAED,MAAM,UAAU,kBAAkB,CAChC,QAAyB,EACzB,iBAAwE;IAExE,QAAQ,CAAC,cAAc,CAAC,CAAC,iBAAiB,CAAC,CAAC;AAC9C,CAAC"}
+{"version":3,"file":"rest-resource.js","sourceRoot":"","sources":["../src/rest-resource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAQlF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,MAAM,cAAc,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAEtD,mEAAmE;AACnE,MAAM,OAAO,YAAY;IACd,UAAU,CAA4B;IACtC,IAAI,CAAS;IACb,KAAK,CAAiB;IACtB,OAAO,CAAkB;IACzB,kBAAkB,CAA+B;IAE1D,YAAY,KAAqB,EAAE,KAAwB;QACzD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO;YACV,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,EAAU,EAAE,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3E,IAAI,CAAC,kBAAkB,GAAG,IAAI,yBAAyB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC;IACvD,CAAC;IAED,oEAAoE;IACpE,MAAM,CAAC,MAAwC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,qEAAqE;IACrE,GAAG,CAAC,UAA0B;QAC5B,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wEAAwE;IACxE,SAAS,CACP,IAAY,EACZ,KAAiD;QAEjD,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,CAAC,cAAc,CAAC,CACd,iBAAwE;QAExE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACpD,CAAC;IAED,yDAAyD;IACzD,IAAI,CAAC,MAAS;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,oEAAoE;IACpE,MAAM,CAAC,KAAiB;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,+DAA+D;IAC/D,GAAG,CAAC,QAAgB;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,kDAAkD;IAClD,IAAI,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,+CAA+C;IAC/C,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,8CAA8C;IAC9C,MAAM,CAAC,QAAgB,EAAE,OAAmB;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,iDAAiD;IACjD,MAAM,CAAC,QAAgB;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,+CAA+C;IAC/C,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAED,MAAM,UAAU,kBAAkB,CAChC,QAAyB,EACzB,iBAAwE;IAExE,QAAQ,CAAC,cAAc,CAAC,CAAC,iBAAiB,CAAC,CAAC;AAC9C,CAAC"}

package/dist/unimplemented-route-error.d.ts

@@ -1,8 +1,9 @@
 /** Reports a request for which a simulated API has no operation. */
 export declare class UnimplementedRouteError extends Error {
+    readonly apiName: string;
     readonly method: string;
     readonly pathname: string;
     readonly url: string;
-    constructor(request: Request);
+    constructor(request: Request, apiName?: string);
 }
 //# sourceMappingURL=unimplemented-route-error.d.ts.map

package/dist/unimplemented-route-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unimplemented-route-error.d.ts","sourceRoot":"","sources":["../src/unimplemented-route-error.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,YAAY,OAAO,EAAE,OAAO,EAW3B;CACF"}
+{"version":3,"file":"unimplemented-route-error.d.ts","sourceRoot":"","sources":["../src/unimplemented-route-error.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,YAAY,OAAO,EAAE,OAAO,EAAE,OAAO,SAAW,EAY/C;CACF"}

package/dist/unimplemented-route-error.js

@@ -1,13 +1,15 @@
 /** Reports a request for which a simulated API has no operation. */
 export class UnimplementedRouteError extends Error {
+    apiName;
     method;
     pathname;
     url;
-    constructor(request) {
+    constructor(request, apiName = "SimApi") {
         const url = new URL(request.url);
         const method = request.method.toUpperCase();
-        super(`${method} ${request.url} reached SimApi, but SimApi has no handler for ${method} ${url.pathname}.`);
+        super(`${method} ${request.url} reached ${apiName}, but ${apiName} has no handler for ${method} ${url.pathname}.`);
         this.name = "UnimplementedRouteError";
+        this.apiName = apiName;
         this.method = method;
         this.pathname = url.pathname;
         this.url = request.url;

package/dist/unimplemented-route-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"unimplemented-route-error.js","sourceRoot":"","sources":["../src/unimplemented-route-error.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IACvC,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,GAAG,CAAS;IAErB,YAAY,OAAgB;QAC1B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAE5C,KAAK,CACH,GAAG,MAAM,IAAI,OAAO,CAAC,GAAG,kDAAkD,MAAM,IAAI,GAAG,CAAC,QAAQ,GAAG,CACpG,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;CACF"}
+{"version":3,"file":"unimplemented-route-error.js","sourceRoot":"","sources":["../src/unimplemented-route-error.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IACvC,OAAO,CAAS;IAChB,MAAM,CAAS;IACf,QAAQ,CAAS;IACjB,GAAG,CAAS;IAErB,YAAY,OAAgB,EAAE,OAAO,GAAG,QAAQ;QAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAE5C,KAAK,CACH,GAAG,MAAM,IAAI,OAAO,CAAC,GAAG,YAAY,OAAO,SAAS,OAAO,uBAAuB,MAAM,IAAI,GAAG,CAAC,QAAQ,GAAG,CAC5G,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACzB,CAAC;CACF"}

package/dist/webhooks.d.ts

@@ -0,0 +1,98 @@
+/**
+ * When a queue sends what it is given.
+ *
+ * `manual` holds every delivery until `flush` asks for it. The test decides
+ * when the hook goes out, and that is where a reader looks for the moment it
+ * did.
+ *
+ * `background` starts each delivery as it is enqueued, the way a real provider
+ * posts one without being asked. `flush` then waits for the last one to land.
+ */
+export type WebhookDeliveryTiming = "manual" | "background";
+/** Configures one outbound queue. */
+export interface SimWebhooksProps {
+    /** When deliveries go out. `manual` when none is given. */
+    readonly deliver?: WebhookDeliveryTiming;
+}
+/** One request a simulated service is holding to send. */
+export interface WebhookDelivery {
+    readonly body: string;
+    readonly headers?: Record<string, string>;
+    /** `POST` when none is given. */
+    readonly method?: string;
+    readonly url: string;
+}
+/** What one endpoint did with one delivery. */
+export type WebhookDeliveryResult = {
+    readonly delivered: true;
+    readonly delivery: WebhookDelivery;
+    readonly error: undefined;
+    /** The endpoint's answer, whatever its status. */
+    readonly response: Response;
+} | {
+    readonly delivered: false;
+    readonly delivery: WebhookDelivery;
+    /** What stopped the request from arriving. */
+    readonly error: unknown;
+    readonly response: undefined;
+};
+/**
+ * A queue of requests a simulated service sends outwards.
+ *
+ * The direction every other part of Simnaril lacks. A service that calls back
+ * into the application under test, the way Stripe posts an event or GitHub
+ * posts a push, holds the call here until a test asks for it to go.
+ *
+ * ```ts
+ * stripe.pay(sessionId);
+ * const [result] = await sim.webhooks.flush();
+ * ```
+ *
+ * Delivery is an ordinary `fetch`, so a live `SimEnvironment` routes it by
+ * origin like any other request. Registering the application's own origin as a
+ * `SimService` keeps the round trip inside the process. An origin no simulation
+ * claims never arrives, and comes back as a result whose `error` is
+ * `UnclaimedOriginError`.
+ *
+ * Holding the queue rather than sending on the spot is what makes a test
+ * readable. The arrangement, the delivery and the assertion are three lines the
+ * reader can see in order. A test that wants the same hook delivered twice
+ * enqueues it again, because `flush` empties the queue as it goes.
+ *
+ * Signing belongs to the service. Stripe's own SDK has
+ * `webhooks.generateTestHeaderString`, and a signature built anywhere else
+ * would be a second implementation to keep in step with the first.
+ */
+export declare class SimWebhooks {
+    #private;
+    constructor(props?: SimWebhooksProps);
+    /**
+     * Holds one request, or starts it, depending on when this queue delivers.
+     *
+     * A background delivery goes out behind the one before it. Deliveries are in
+     * order in both timings, and the timing decides when rather than what.
+     */
+    enqueue(delivery: WebhookDelivery): void;
+    /**
+     * What is waiting for the next flush, in the order it was enqueued.
+     *
+     * Always empty on a background queue, where nothing waits.
+     */
+    get pending(): readonly WebhookDelivery[];
+    /**
+     * Answers once everything enqueued so far has been delivered, with what each
+     * endpoint did.
+     *
+     * On the default queue this is what sends them. On a background queue they
+     * are already going, and this waits for the last one to land, the way
+     * Yulin's `backgroundTasksComplete()` does for a simulated AWS account.
+     *
+     * A result carries a `response` or an `error`, and the two mean different
+     * things. An endpoint that answered, including one answering 400 or 500, is
+     * a `response` to read the status off. `error` is for a delivery that never
+     * arrived at all, such as an unreachable host or an origin no simulation
+     * claims. A simulation exists to reproduce both, so neither throws.
+     */
+    flush(): Promise<WebhookDeliveryResult[]>;
+}
+//# sourceMappingURL=webhooks.d.ts.map

package/dist/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,YAAY,CAAC;AAE5D,qCAAqC;AACrC,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAC1C;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,iCAAiC;IACjC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED,+CAA+C;AAC/C,MAAM,MAAM,qBAAqB,GAC7B;IACE,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,kDAAkD;IAClD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B,GACD;IACE,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,8CAA8C;IAC9C,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEN;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,WAAW;;IAOtB,YAAY,KAAK,GAAE,gBAAqB,EAEvC;IAED;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,CAWvC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,SAAS,eAAe,EAAE,CAExC;IAED;;;;;;;;;;;;;OAaG;IACG,KAAK,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAE9C;CA6CF"}

package/dist/webhooks.js

@@ -0,0 +1,129 @@
+/**
+ * A queue of requests a simulated service sends outwards.
+ *
+ * The direction every other part of Simnaril lacks. A service that calls back
+ * into the application under test, the way Stripe posts an event or GitHub
+ * posts a push, holds the call here until a test asks for it to go.
+ *
+ * ```ts
+ * stripe.pay(sessionId);
+ * const [result] = await sim.webhooks.flush();
+ * ```
+ *
+ * Delivery is an ordinary `fetch`, so a live `SimEnvironment` routes it by
+ * origin like any other request. Registering the application's own origin as a
+ * `SimService` keeps the round trip inside the process. An origin no simulation
+ * claims never arrives, and comes back as a result whose `error` is
+ * `UnclaimedOriginError`.
+ *
+ * Holding the queue rather than sending on the spot is what makes a test
+ * readable. The arrangement, the delivery and the assertion are three lines the
+ * reader can see in order. A test that wants the same hook delivered twice
+ * enqueues it again, because `flush` empties the queue as it goes.
+ *
+ * Signing belongs to the service. Stripe's own SDK has
+ * `webhooks.generateTestHeaderString`, and a signature built anywhere else
+ * would be a second implementation to keep in step with the first.
+ */
+export class SimWebhooks {
+    #queued = [];
+    #sending = [];
+    #background;
+    /** The delivery each new background one queues up behind. */
+    #last = Promise.resolve();
+    constructor(props = {}) {
+        this.#background = props.deliver === "background";
+    }
+    /**
+     * Holds one request, or starts it, depending on when this queue delivers.
+     *
+     * A background delivery goes out behind the one before it. Deliveries are in
+     * order in both timings, and the timing decides when rather than what.
+     */
+    enqueue(delivery) {
+        if (!this.#background) {
+            this.#queued.push(delivery);
+            return;
+        }
+        const sending = this.#last.then(() => send(delivery));
+        this.#last = sending;
+        this.#sending.push(sending);
+    }
+    /**
+     * What is waiting for the next flush, in the order it was enqueued.
+     *
+     * Always empty on a background queue, where nothing waits.
+     */
+    get pending() {
+        return [...this.#queued];
+    }
+    /**
+     * Answers once everything enqueued so far has been delivered, with what each
+     * endpoint did.
+     *
+     * On the default queue this is what sends them. On a background queue they
+     * are already going, and this waits for the last one to land, the way
+     * Yulin's `backgroundTasksComplete()` does for a simulated AWS account.
+     *
+     * A result carries a `response` or an `error`, and the two mean different
+     * things. An endpoint that answered, including one answering 400 or 500, is
+     * a `response` to read the status off. `error` is for a delivery that never
+     * arrived at all, such as an unreachable host or an origin no simulation
+     * claims. A simulation exists to reproduce both, so neither throws.
+     */
+    async flush() {
+        return this.#background ? this.#settled() : this.#sendQueued();
+    }
+    /**
+     * Sends what is waiting.
+     *
+     * The queue is emptied before the first request goes out, so a receiver that
+     * enqueues more work leaves it for the next flush in place of extending this
+     * one. Holding a queue is for deciding when deliveries go, and a flush that
+     * chased its own tail would take that decision back.
+     */
+    async #sendQueued() {
+        const sending = this.#queued.splice(0);
+        const results = [];
+        /*
+         * One at a time on purpose. A receiver's state changes in the order the
+         * deliveries were enqueued, and `Promise.all` would hand that order to the
+         * event loop.
+         */
+        for (const delivery of sending) {
+            // oxlint-disable-next-line no-await-in-loop -- see above
+            results.push(await send(delivery));
+        }
+        return results;
+    }
+    /**
+     * Waits for the background to go quiet.
+     *
+     * A delivery a receiver enqueues while this is waiting has already started,
+     * so it is waited for too. That is the difference from a flush, and it is
+     * the point of a background queue: the test asks once, and everything the
+     * hooks set off has finished by the time it answers.
+     */
+    async #settled() {
+        const results = [];
+        while (this.#sending.length > 0) {
+            // oxlint-disable-next-line no-await-in-loop -- each round may add more
+            results.push(...(await Promise.all(this.#sending.splice(0))));
+        }
+        return results;
+    }
+}
+async function send(delivery) {
+    try {
+        const response = await fetch(delivery.url, {
+            body: delivery.body,
+            headers: delivery.headers ?? {},
+            method: delivery.method ?? "POST",
+        });
+        return { delivered: true, delivery, error: undefined, response };
+    }
+    catch (error) {
+        return { delivered: false, delivery, error, response: undefined };
+    }
+}
+//# sourceMappingURL=webhooks.js.map

package/dist/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AA4CA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,WAAW;IACb,OAAO,GAAsB,EAAE,CAAC;IAChC,QAAQ,GAAqC,EAAE,CAAC;IAChD,WAAW,CAAU;IAC9B,6DAA6D;IAC7D,KAAK,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE5C,YAAY,KAAK,GAAqB,EAAE;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,OAAO,KAAK,YAAY,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,QAAyB;QAC/B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAE5B,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEtD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,KAAK;QACT,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACvC,MAAM,OAAO,GAA4B,EAAE,CAAC;QAE5C;;;;WAIG;QACH,KAAK,MAAM,QAAQ,IAAI,OAAO,EAAE,CAAC;YAC/B,yDAAyD;YACzD,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,OAAO,GAA4B,EAAE,CAAC;QAE5C,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,uEAAuE;YACvE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAED,KAAK,UAAU,IAAI,CAAC,QAAyB;IAC3C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE;YACzC,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,EAAE;YAC/B,MAAM,EAAE,QAAQ,CAAC,MAAM,IAAI,MAAM;SAClC,CAAC,CAAC;QAEH,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;IACnE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IACpE,CAAC;AACH,CAAC"}

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@kensio/simnaril",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "description": "In-process simulation of third-party HTTP services",
   "repository": "https://github.com/KensioSoftware/simnaril",
   "bugs": "https://github.com/KensioSoftware/simnaril/issues",
+  "homepage": "https://simnaril.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {