wardens 0.6.0-rc.3 → 0.6.0-rc.4-2024-07-28.92dafd2

package/dist/wardens.cjs

@@ -1 +1 @@
-"use strict";var R=Object.defineProperty;var B=(e,t,r)=>t in e?R(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r;var f=(e,t,r)=>(B(e,typeof t!="symbol"?t+"":t,r),r),j=(e,t,r)=>{if(!t.has(e))throw TypeError("Cannot "+r)};var s=(e,t,r)=>(j(e,t,"read from private field"),r?r.call(e):t.get(e)),d=(e,t,r)=>{if(t.has(e))throw TypeError("Cannot add the same private member more than once");t instanceof WeakSet?t.add(e):t.set(e,r)},h=(e,t,r,o)=>(j(e,t,"write to private field"),o?o.call(e,r):t.set(e,r),r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function M(e){const t=new WeakMap;return new Proxy(e,{get(r,o){const n=Reflect.get(r,o,r);if(typeof n=="function"){if(t.has(n)===!1){const a=n.bind(r);Object.defineProperties(a,Object.getOwnPropertyDescriptors(n)),t.set(n,a)}return t.get(n)}return n},set(r,o,n){return Reflect.set(r,o,n,r)}})}const g=new WeakMap,k=new WeakSet,E=new WeakSet;function A(e){return Proxy.revocable(e,{})}var C,w;class x{constructor(t){d(this,C,Symbol("Context ID"));d(this,w,void 0);h(this,w,t)}static getId(t){return s(t,C)}static getDefaultValue(t){var r;return s(r=t,w).call(r)}}C=new WeakMap,w=new WeakMap;const T=e=>new x(e);var y,l,p,i;class V{constructor(t,r,o){d(this,y,new WeakSet);d(this,l,void 0);d(this,p,void 0);d(this,i,void 0);f(this,"create",async(t,...r)=>{if(s(this,p).enforced)throw new Error("Cannot create new resources after teardown.");const o=Object.create(s(this,i)),n=await P(o,t,...r);return s(this,l).add(n),n});f(this,"destroy",async t=>{if(s(this,y).has(t))throw new Error("Resource already destroyed.");if(!s(this,l).has(t))throw new Error("You do not own this resource.");s(this,l).delete(t),s(this,y).add(t),await m(t)});f(this,"setContext",(t,r)=>(s(this,i)[x.getId(t)]=r,r));f(this,"getContext",t=>{const r=x.getId(t);return r in s(this,i)?s(this,i)[r]:x.getDefaultValue(t)});h(this,i,t),h(this,l,r),h(this,p,o)}}y=new WeakMap,l=new WeakMap,p=new WeakMap,i=new WeakMap;const P=async(e,t,...r)=>{const o={enforced:!1},n=new Set,a=new V(e,n,o);let c;try{c=await t(a,...r)}catch(S){const O=Array.from(n).reverse(),v=(await Promise.allSettled(O.map(u=>a.destroy(u)))).filter(u=>u.status==="rejected");throw v.length?D(v.map(u=>u.reason),{cause:S}):S}const W=c.value,{proxy:b,revoke:I}=A(W);return k.add(b),g.set(b,{curfew:o,resource:c,children:n,revoke:I}),b},m=async e=>{if(!k.has(e))throw new Error("Cannot destroy object. It is not a resource.");const t=g.get(e);if(t){g.delete(e),t.revoke();let r={status:"fulfilled",value:void 0};if(t.resource.destroy)try{await t.resource.destroy()}catch(c){r={status:"rejected",reason:c}}t.curfew.enforced=!0;const o=Array.from(t.children).reverse().map(m),n=await Promise.allSettled(o),a=[r].concat(n).filter(c=>c.status==="rejected");if(a.length)throw D(a.map(c=>c.reason))}},D=(e,t)=>e.length===1?e[0]:new H(e,t);class H extends Error{constructor(t,r){super("Some resources could not be destroyed. See the `failures` property for details.",r),this.failures=t}}const U=async(e,...t)=>{const o=await P(Object.create(null),e,...t);return E.add(o),o},Y=async e=>{if(g.has(e)&&!E.has(e))throw new Error("Cannot destroy child resource. It is owned by another scope.");return m(e)};exports.bindContext=M;exports.create=U;exports.createContext=T;exports.destroy=Y;
+"use strict";var B=Object.defineProperty;var j=e=>{throw TypeError(e)};var M=(e,t,r)=>t in e?B(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r;var f=(e,t,r)=>M(e,typeof t!="symbol"?t+"":t,r),k=(e,t,r)=>t.has(e)||j("Cannot "+r);var s=(e,t,r)=>(k(e,t,"read from private field"),r?r.call(e):t.get(e)),d=(e,t,r)=>t.has(e)?j("Cannot add the same private member more than once"):t instanceof WeakSet?t.add(e):t.set(e,r),h=(e,t,r,o)=>(k(e,t,"write to private field"),o?o.call(e,r):t.set(e,r),r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function A(e){const t=new WeakMap;return new Proxy(e,{get(r,o){const n=Reflect.get(r,o,r);if(typeof n=="function"){if(t.has(n)===!1){const a=n.bind(r);Object.defineProperties(a,Object.getOwnPropertyDescriptors(n)),t.set(n,a)}return t.get(n)}return n},set(r,o,n){return Reflect.set(r,o,n,r)}})}const g=new WeakMap,E=new WeakSet,P=new WeakSet;function T(e){return Proxy.revocable(e,{})}var C,w;class x{constructor(t){d(this,C,Symbol("Context ID"));d(this,w);h(this,w,t)}static getId(t){return s(t,C)}static getDefaultValue(t){var r;return s(r=t,w).call(r)}}C=new WeakMap,w=new WeakMap;const V=e=>new x(e);var y,l,p,i;class H{constructor(t,r,o){d(this,y,new WeakSet);d(this,l);d(this,p);d(this,i);f(this,"create",async(t,...r)=>{if(s(this,p).enforced)throw new Error("Cannot create new resources after teardown.");const o=Object.create(s(this,i)),n=await D(o,t,...r);return s(this,l).add(n),n});f(this,"destroy",async t=>{if(s(this,y).has(t))throw new Error("Resource already destroyed.");if(!s(this,l).has(t))throw new Error("You do not own this resource.");s(this,l).delete(t),s(this,y).add(t),await m(t)});f(this,"setContext",(t,r)=>(s(this,i)[x.getId(t)]=r,r));f(this,"getContext",t=>{const r=x.getId(t);return r in s(this,i)?s(this,i)[r]:x.getDefaultValue(t)});h(this,i,t),h(this,l,r),h(this,p,o)}}y=new WeakMap,l=new WeakMap,p=new WeakMap,i=new WeakMap;const D=async(e,t,...r)=>{const o={enforced:!1},n=new Set,a=new H(e,n,o);let c;try{c=await t(a,...r)}catch(S){const R=Array.from(n).reverse(),v=(await Promise.allSettled(R.map(u=>a.destroy(u)))).filter(u=>u.status==="rejected");throw v.length?W(v.map(u=>u.reason),{cause:S}):S}const I=c.value,{proxy:b,revoke:O}=T(I);return E.add(b),g.set(b,{curfew:o,resource:c,children:n,revoke:O}),b},m=async e=>{if(!E.has(e))throw new Error("Cannot destroy object. It is not a resource.");const t=g.get(e);if(t){g.delete(e),t.revoke();let r={status:"fulfilled",value:void 0};if(t.resource.destroy)try{await t.resource.destroy()}catch(c){r={status:"rejected",reason:c}}t.curfew.enforced=!0;const o=Array.from(t.children).reverse().map(m),n=await Promise.allSettled(o),a=[r].concat(n).filter(c=>c.status==="rejected");if(a.length)throw W(a.map(c=>c.reason))}},W=(e,t)=>e.length===1?e[0]:new U(e,t);class U extends Error{constructor(t,r){super("Some resources could not be destroyed. See the `failures` property for details.",r),this.failures=t}}const Y=async(e,...t)=>{const o=await D(Object.create(null),e,...t);return P.add(o),o},q=async e=>{if(g.has(e)&&!P.has(e))throw new Error("Cannot destroy child resource. It is owned by another scope.");return m(e)};exports.bindContext=A;exports.create=Y;exports.createContext=V;exports.destroy=q;

package/dist/wardens.js

@@ -1,15 +1,11 @@
-var O = Object.defineProperty;
-var B = (e, t, r) => t in e ? O(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
-var h = (e, t, r) => (B(e, typeof t != "symbol" ? t + "" : t, r), r), j = (e, t, r) => {
-  if (!t.has(e))
-    throw TypeError("Cannot " + r);
+var B = Object.defineProperty;
+var j = (e) => {
+  throw TypeError(e);
 };
-var n = (e, t, r) => (j(e, t, "read from private field"), r ? r.call(e) : t.get(e)), d = (e, t, r) => {
-  if (t.has(e))
-    throw TypeError("Cannot add the same private member more than once");
-  t instanceof WeakSet ? t.add(e) : t.set(e, r);
-}, f = (e, t, r, o) => (j(e, t, "write to private field"), o ? o.call(e, r) : t.set(e, r), r);
-function U(e) {
+var A = (e, t, r) => t in e ? B(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
+var h = (e, t, r) => A(e, typeof t != "symbol" ? t + "" : t, r), k = (e, t, r) => t.has(e) || j("Cannot " + r);
+var n = (e, t, r) => (k(e, t, "read from private field"), r ? r.call(e) : t.get(e)), d = (e, t, r) => t.has(e) ? j("Cannot add the same private member more than once") : t instanceof WeakSet ? t.add(e) : t.set(e, r), f = (e, t, r, o) => (k(e, t, "write to private field"), o ? o.call(e, r) : t.set(e, r), r);
+function Y(e) {
   const t = /* @__PURE__ */ new WeakMap();
   return new Proxy(e, {
     get(r, o) {
@@ -31,15 +27,15 @@ function U(e) {
     }
   });
 }
-const g = /* @__PURE__ */ new WeakMap(), k = /* @__PURE__ */ new WeakSet(), E = /* @__PURE__ */ new WeakSet();
-function A(e) {
+const g = /* @__PURE__ */ new WeakMap(), E = /* @__PURE__ */ new WeakSet(), D = /* @__PURE__ */ new WeakSet();
+function M(e) {
   return Proxy.revocable(e, {});
 }
 var m, w;
 class x {
   constructor(t) {
     d(this, m, Symbol("Context ID"));
-    d(this, w, void 0);
+    d(this, w);
     f(this, w, t);
   }
   static getId(t) {
@@ -51,19 +47,19 @@ class x {
   }
 }
 m = new WeakMap(), w = new WeakMap();
-const Y = (e) => new x(e);
+const q = (e) => new x(e);
 var y, l, p, i;
-class M {
+class V {
   constructor(t, r, o) {
     d(this, y, /* @__PURE__ */ new WeakSet());
-    d(this, l, void 0);
-    d(this, p, void 0);
-    d(this, i, void 0);
+    d(this, l);
+    d(this, p);
+    d(this, i);
     /** Provision an owned resource and make sure it doesn't outlive us. */
     h(this, "create", async (t, ...r) => {
       if (n(this, p).enforced)
         throw new Error("Cannot create new resources after teardown.");
-      const o = Object.create(n(this, i)), s = await D(o, t, ...r);
+      const o = Object.create(n(this, i)), s = await P(o, t, ...r);
       return n(this, l).add(s), s;
     });
     /**
@@ -88,31 +84,31 @@ class M {
   }
 }
 y = new WeakMap(), l = new WeakMap(), p = new WeakMap(), i = new WeakMap();
-const D = async (e, t, ...r) => {
-  const o = { enforced: !1 }, s = /* @__PURE__ */ new Set(), a = new M(e, s, o);
+const P = async (e, t, ...r) => {
+  const o = { enforced: !1 }, s = /* @__PURE__ */ new Set(), a = new V(e, s, o);
   let c;
   try {
     c = await t(a, ...r);
   } catch (S) {
-    const R = Array.from(s).reverse(), v = (await Promise.allSettled(
-      R.map((u) => a.destroy(u))
+    const O = Array.from(s).reverse(), v = (await Promise.allSettled(
+      O.map((u) => a.destroy(u))
     )).filter(
       (u) => u.status === "rejected"
     );
-    throw v.length ? P(
+    throw v.length ? W(
       v.map((u) => u.reason),
       { cause: S }
     ) : S;
   }
-  const W = c.value, { proxy: C, revoke: I } = A(W);
-  return k.add(C), g.set(C, {
+  const I = c.value, { proxy: C, revoke: R } = M(I);
+  return E.add(C), g.set(C, {
     curfew: o,
     resource: c,
     children: s,
-    revoke: I
+    revoke: R
   }), C;
 }, b = async (e) => {
-  if (!k.has(e))
+  if (!E.has(e))
     throw new Error("Cannot destroy object. It is not a resource.");
   const t = g.get(e);
   if (t) {
@@ -132,10 +128,10 @@ const D = async (e, t, ...r) => {
       (c) => c.status === "rejected"
     );
     if (a.length)
-      throw P(a.map((c) => c.reason));
+      throw W(a.map((c) => c.reason));
   }
-}, P = (e, t) => e.length === 1 ? e[0] : new V(e, t);
-class V extends Error {
+}, W = (e, t) => e.length === 1 ? e[0] : new H(e, t);
+class H extends Error {
   constructor(t, r) {
     super(
       "Some resources could not be destroyed. See the `failures` property for details.",
@@ -143,19 +139,19 @@ class V extends Error {
     ), this.failures = t;
   }
 }
-const q = async (e, ...t) => {
-  const o = await D(/* @__PURE__ */ Object.create(null), e, ...t);
-  return E.add(o), o;
-}, z = async (e) => {
-  if (g.has(e) && !E.has(e))
+const z = async (e, ...t) => {
+  const o = await P(/* @__PURE__ */ Object.create(null), e, ...t);
+  return D.add(o), o;
+}, F = async (e) => {
+  if (g.has(e) && !D.has(e))
     throw new Error(
       "Cannot destroy child resource. It is owned by another scope."
     );
   return b(e);
 };
 export {
-  U as bindContext,
-  q as create,
-  Y as createContext,
-  z as destroy
+  Y as bindContext,
+  z as create,
+  q as createContext,
+  F as destroy
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wardens",
-  "version": "0.6.0-rc.3",
+  "version": "0.6.0-rc.4-2024-07-28.92dafd2",
   "description": "A framework for resource management",
   "type": "module",
   "main": "./dist/wardens.cjs",
@@ -31,12 +31,13 @@
   ],
   "scripts": {
     "prepack": "tsc && vite build",
-    "test": "./bin/run-tests",
+    "test": "./scripts/run-tests",
     "test:lint": "eslint src --color",
-    "test:unit": "vitest --color",
-    "test:types": "vitest typecheck --color",
+    "test:unit": "vitest --color --typecheck",
     "test:fmt": "prettier --check src --color",
-    "dev": "vite build --watch"
+    "print-pkg-version": "echo ${npm_package_version}",
+    "release:candidate": "./scripts/publish-rc",
+    "release:stable": "./scripts/publish-stable"
   },
   "husky": {
     "hooks": {
@@ -53,41 +54,17 @@
     "singleQuote": true,
     "trailingComma": "all"
   },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-      "sourceType": "module"
-    },
-    "overrides": [
-      {
-        "files": [
-          "./**/__tests__/*.ts{x,}"
-        ],
-        "rules": {
-          "@typescript-eslint/no-explicit-any": "off"
-        }
-      }
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended"
-    ],
-    "rules": {
-      "@typescript-eslint/explicit-module-boundary-types": "off",
-      "@typescript-eslint/no-non-null-assertion": "off",
-      "@typescript-eslint/no-unused-vars": "error",
-      "no-prototype-builtins": "off"
-    }
-  },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "6.4.1",
-    "@typescript-eslint/parser": "6.4.1",
-    "eslint": "8.48.0",
-    "husky": "8.0.3",
-    "lint-staged": "14.0.1",
-    "prettier": "2.8.8",
-    "typescript": "5.2.2",
-    "vite": "4.4.9",
-    "vitest": "^0.34.0"
+    "@eslint/js": "^9.7.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.0.0",
+    "eslint": "^9.7.0",
+    "husky": "^9.1.3",
+    "lint-staged": "^15.2.7",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.0.0-alpha.54",
+    "vite": "^5.3.5",
+    "vitest": "^2.0.0"
   }
 }

package/src/__tests__/root-lifecycle.test.ts

@@ -58,7 +58,7 @@ describe('roots', () => {
 
   describe('destroy', () => {
     it('deallocates the resource', async () => {
-      const spy = vi.fn<[], void>();
+      const spy = vi.fn<() => void>();
       const Test = async () => ({
         value: {},
         destroy: spy,

package/src/__tests__/roots.test.ts

@@ -58,7 +58,7 @@ describe('roots', () => {
 
   describe('destroy', () => {
     it('deallocates the resource', async () => {
-      const spy = vi.fn<[], void>();
+      const spy = vi.fn<() => void>();
       const Test = async () => ({
         value: {},
         destroy: spy,

package/src/__tests__/utility-types.test-d.ts

@@ -1,4 +1,10 @@
-import { create, ResourceScope, ResourceHandle } from '../';
+import {
+  create,
+  ResourceScope,
+  ResourceHandle,
+  createContext,
+  ContextType,
+} from '../';
 
 describe('Utility types', () => {
   describe('ResourceHandle', () => {
@@ -29,4 +35,22 @@ describe('Utility types', () => {
       });
     });
   });
+
+  describe('ContextType', () => {
+    it('returns the type contained in context', async () => {
+      const Context = createContext(() => ({
+        hello: 'world',
+      }));
+
+      async function Test({ getContext }: ResourceScope) {
+        return { value: getContext(Context) };
+      }
+
+      const value = await create(Test);
+
+      expectTypeOf(value).toEqualTypeOf<ContextType<typeof Context>>({
+        hello: 'any string, really',
+      });
+    });
+  });
 });

package/src/index.ts

@@ -1,5 +1,5 @@
 export { default as bindContext } from './bind-context';
 export { createRoot as create, destroyRoot as destroy } from './root-lifecycle';
 export { createContext } from './inherited-context';
-export type { Resource, ResourceHandle } from './utility-types';
+export type { Resource, ResourceHandle, ContextType } from './utility-types';
 export type { default as ResourceScope } from './resource-scope';

package/src/resource-lifecycle.ts

@@ -119,7 +119,10 @@ const reduceToSingleError = (errors: Array<Error>, options?: ErrorOptions) => {
 
 /** Happens when 2 or more child resources cannot be destroyed. */
 class BulkDestroyError extends Error {
-  constructor(public failures: Array<unknown>, options?: ErrorOptions) {
+  constructor(
+    public failures: Array<unknown>,
+    options?: ErrorOptions,
+  ) {
     super(
       'Some resources could not be destroyed. See the `failures` property for details.',
       options,

package/src/utility-types.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import type { ContextHandle } from './inherited-context';
 import type ResourceScope from './resource-scope';
 
 /**
@@ -29,3 +30,7 @@ export interface Resource<Value extends object> {
 export type ResourceHandle<
   Factory extends ParametrizedResourceFactory<object, Array<any>>,
 > = Awaited<ReturnType<Factory>>['value'];
+
+/** The type returned when you call `getContext`. */
+export type ContextType<Handle extends ContextHandle<unknown>> =
+  Handle extends ContextHandle<infer Value> ? Value : never;

package/CHANGELOG.md

@@ -1,103 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-### Added
-
-- New context API carries state down the tree without plumbing through arguments.
-
-### Changed
-
-- Renamed public type `ResourceContext` to `ResourceScope`.
-- `destroy(...)` is no longer allowed to destroy child resources, only roots.
-- Added tree-shaking metadata. This is useful for bundle analysis tools.
-
-## [0.5.1] - 2023-08-12
-
-### Fixed
-
-- Added support for parametrized resources in `ResourceHandle<T>`.
-
-## [0.5.0] - 2023-08-12
-
-### Changed
-
-- Wardens is now published with ESM (`type=module`). It should be backwards compatible.
-- Now `destroy(...)` throws if you pass an object that wasn't constructed with `create(...)`.
-
-### Fixed
-
-- If a resource fails while initializing, now all intermediate child resources are destroyed as well.
-- If a resource fails while being destroyed, now its child resources are destroyed as well.
-- Resources can no longer provision child resources after teardown. This closes a loophole where resources could escape destruction.
-
-### Added
-
-- New `ResourceHandle<T>` utility type represents the value returned when creating a resource.
-
-## [0.4.1] - 2023-01-14
-
-### Fixed
-
-- Newer versions of TypeScript complained about signatures in `bindContext(...)`.
-
-## [0.4.0] - 2022-06-19
-
-### Added
-
-- Support for provisioning resources through async functions instead of `Resource` subclasses. This offers better type safety around null conditions.
-- A new `Resource` utility type is exported. The new functional API expects you to return this interface.
-
-### Removed
-
-- The `Resource` abstract class was removed. Use async functions instead.
-- The `Controls<...>` utility type was removed. Import the type you need from the module instead.
-
-## [0.3.0] - 2022-06-04
-
-### Changed
-
-- Prevent use of `allocate(...)`/`deallocate(...)` outside a resource subclass.
-- Renamed `enter()` and `leave()` to `create()` and `destroy()`.
-- Renamed `mount()` and `unmount()` to `create()` and `destroy()`.
-
-### Removed
-
-- Second type parameter to `Resource` is gone. Arguments to `enter(...)` are now inferred.
-- No more default implementations for `enter(...)`/`leave(...)` on resources.
-
-## [0.2.0] - 2022-05-24
-
-### Fixed
-
-- `mount(...)` and `allocate(...)` no longer require a config argument if the resource doesn't explicitly define one.
-
-### Added
-
-- `enter(...)` now supports variable arguments.
-
-### Changed
-
-- The second generic parameter of `Resource` was a config parameter, but now it's an argument tuple.
-- The `ExternalControls` utility type was renamed to `Controls`.
-
-## [0.1.0] - 2022-05-22
-
-### Added
-
-- Resource class for modeling asynchronously provisioned resources
-- `mount`/`unmount` hooks to provision resources
-- `allocate`/`deallocate` for creating hierarchies of resources
-
-[Unreleased]: https://github.com/PsychoLlama/wardens/compare/v0.5.1...HEAD
-[0.5.1]: https://github.com/PsychoLlama/wardens/compare/v0.5.0...v0.5.1
-[0.5.0]: https://github.com/PsychoLlama/wardens/compare/v0.4.1...v0.5.0
-[0.4.1]: https://github.com/PsychoLlama/wardens/compare/v0.4.0...v0.4.1
-[0.4.0]: https://github.com/PsychoLlama/wardens/compare/v0.3.0...v0.4.0
-[0.3.0]: https://github.com/PsychoLlama/wardens/compare/v0.2.0...v0.3.0
-[0.2.0]: https://github.com/PsychoLlama/wardens/compare/v0.1.0...v0.2.0
-[0.1.0]: https://github.com/PsychoLlama/wardens/releases/tag/v0.1.0