wardens 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [0.4.1] - 2023-01-14
+
+### Fixed
+
+- Newer versions of TypeScript complained about signatures in `bindContext(...)`.
+
 ## [0.4.0] - 2022-06-19
 
 ### Added
@@ -54,7 +60,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - `mount`/`unmount` hooks to provision resources
 - `allocate`/`deallocate` for creating hierarchies of resources
 
-[Unreleased]: https://github.com/PsychoLlama/wardens/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/PsychoLlama/wardens/compare/v0.4.1...HEAD
+[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

package/README.md

@@ -1,7 +1,7 @@
 <div align="center">
   <h1>Wardens</h1>
   <p>A tiny framework for managing resources.</p>
-  <img alt="Build status" src="https://img.shields.io/github/workflow/status/PsychoLlama/wardens/Test/main" />
+  <img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/PsychoLlama/wardens/test.yml?branch=main" />
   <img alt="TypeScript" src="https://img.shields.io/npm/types/wardens" />
   <img alt="npm version" src="https://img.shields.io/npm/v/wardens" />
 </div>
@@ -14,7 +14,7 @@ Here's an example: let's say you've got a thread pool, one per CPU. Each thread
 
 ```typescript
 async function Worker() {
-  const thread = await spawn()
+  const thread = await spawn();
 
   return {
     // The value returned after initialization completes
@@ -22,24 +22,27 @@ async function Worker() {
 
     // Called when the resource is destroyed
     destroy: () => thread.close(),
-  }
+  };
 }
 ```
 
 Now define a pool that creates and manages workers:
 
 ```typescript
-async function WorkerPool({ create }: ResourceContext, config: { poolSize: number }) {
-  const promises = Array(config.poolSize).fill(Worker).map(create)
-  const threads = await Promise.all(promises)
+async function WorkerPool(
+  { create }: ResourceContext,
+  config: { poolSize: number },
+) {
+  const promises = Array(config.poolSize).fill(Worker).map(create);
+  const threads = await Promise.all(promises);
 
   return {
     // ... External API goes here ...
     value: {
       doSomeWork() {},
       doSomethingElse() {},
-    }
-  }
+    },
+  };
 }
 ```
 
@@ -48,17 +51,17 @@ Finally, create the pool:
 ```typescript
 const pool = await create(WorkerPool, {
   poolSize: cpus().length,
-})
+});
 
 // Provisioned and ready to go!
-pool.doSomeWork()
-pool.doSomethingElse()
+pool.doSomeWork();
+pool.doSomethingElse();
 ```
 
 The magic of this framework is that resources never outlive their owners. If you tear down the pool, it will deallocate everything beneath it first:
 
 ```typescript
-await destroy(pool)
+await destroy(pool);
 
 // [info] closing worker
 // [info] closing worker

package/dist/wardens.mjs

@@ -0,0 +1,87 @@
+var p = Object.defineProperty;
+var x = (n, e, t) => e in n ? p(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
+var a = (n, e, t) => (x(n, typeof e != "symbol" ? e + "" : e, t), t), f = (n, e, t) => {
+  if (!e.has(n))
+    throw TypeError("Cannot " + t);
+};
+var i = (n, e, t) => (f(n, e, "read from private field"), t ? t.call(n) : e.get(n)), y = (n, e, t) => {
+  if (e.has(n))
+    throw TypeError("Cannot add the same private member more than once");
+  e instanceof WeakSet ? e.add(n) : e.set(n, t);
+}, l = (n, e, t, o) => (f(n, e, "write to private field"), o ? o.call(n, t) : e.set(n, t), t);
+function g(n) {
+  const e = /* @__PURE__ */ new WeakMap();
+  return new Proxy(n, {
+    get(t, o) {
+      const r = Reflect.get(t, o, t);
+      if (typeof r == "function") {
+        if (e.has(r) === !1) {
+          const c = r.bind(t);
+          Object.defineProperties(
+            c,
+            Object.getOwnPropertyDescriptors(r)
+          ), e.set(r, c);
+        }
+        return e.get(r);
+      }
+      return r;
+    },
+    set(t, o, r) {
+      return Reflect.set(t, o, r, t);
+    }
+  });
+}
+const u = /* @__PURE__ */ new WeakMap();
+function m(n) {
+  return Proxy.revocable(n, {});
+}
+var s;
+class v {
+  constructor(e) {
+    y(this, s, void 0);
+    /** Provision an owned resource and make sure it doesn't outlive us. */
+    a(this, "create", async (e, ...t) => {
+      const o = await P(e, ...t);
+      return i(this, s).add(o), o;
+    });
+    /**
+     * Tear down a resource. Happens automatically when resource owners are
+     * deallocated.
+     */
+    a(this, "destroy", async (e) => {
+      if (!i(this, s).has(e))
+        throw new Error("You do not own this resource.");
+      try {
+        await w(e);
+      } finally {
+        i(this, s).delete(e);
+      }
+    });
+    l(this, s, e);
+  }
+}
+s = new WeakMap();
+async function P(n, ...e) {
+  const t = /* @__PURE__ */ new Set(), o = new v(t), r = await n(o, ...e), c = r.value, { proxy: d, revoke: h } = m(c);
+  return u.set(d, {
+    resource: r,
+    children: t,
+    revoke: h
+  }), d;
+}
+async function w(n) {
+  const e = u.get(n);
+  if (e) {
+    u.delete(n), e.revoke();
+    const t = Array.from(e.children).map(w), o = await Promise.allSettled(t);
+    e.resource.destroy && await e.resource.destroy(), o.forEach((r) => {
+      if (r.status === "rejected")
+        throw r.reason;
+    });
+  }
+}
+export {
+  g as bindContext,
+  P as create,
+  w as destroy
+};

package/dist/wardens.umd.js

@@ -1 +1 @@
-var P=Object.defineProperty;var g=(e,t,n)=>t in e?P(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;var y=(e,t,n)=>(g(e,typeof t!="symbol"?t+"":t,n),n),p=(e,t,n)=>{if(!t.has(e))throw TypeError("Cannot "+n)};var f=(e,t,n)=>(p(e,t,"read from private field"),n?n.call(e):t.get(e)),b=(e,t,n)=>{if(t.has(e))throw TypeError("Cannot add the same private member more than once");t instanceof WeakSet?t.add(e):t.set(e,n)},m=(e,t,n,u)=>(p(e,t,"write to private field"),u?u.call(e,n):t.set(e,n),n);(function(e,t){typeof exports=="object"&&typeof module!="undefined"?t(exports):typeof define=="function"&&define.amd?define(["exports"],t):(e=typeof globalThis!="undefined"?globalThis:e||self,t(e.wardens={}))})(this,function(e){var a;"use strict";function t(c){const o=new WeakMap;return new Proxy(c,{get(s,i){const r=Reflect.get(s,i,s);if(typeof r=="function"){if(o.has(r)===!1){const d=r.bind(s);Object.defineProperties(d,Object.getOwnPropertyDescriptors(r)),o.set(r,d)}return o.get(r)}return r},set(s,i,r){return Reflect.set(s,i,r,s)}})}const n=new WeakMap;function u(c){return Proxy.revocable(c,{})}class v{constructor(o){b(this,a,void 0);y(this,"create",async(o,...s)=>{const i=await h(o,...s);return f(this,a).add(i),i});y(this,"destroy",async o=>{if(!f(this,a).has(o))throw new Error("You do not own this resource.");try{await l(o)}finally{f(this,a).delete(o)}});m(this,a,o)}}a=new WeakMap;async function h(c,...o){const s=new Set,i=new v(s),r=await c(i,...o),d=r.value,{proxy:w,revoke:x}=u(d);return n.set(w,{resource:r,children:s,revoke:x}),w}async function l(c){const o=n.get(c);if(o){n.delete(c),o.revoke();const s=Array.from(o.children).map(l),i=await Promise.allSettled(s);o.resource.destroy&&await o.resource.destroy(),i.forEach(r=>{if(r.status==="rejected")throw r.reason})}}e.bindContext=t,e.create=h,e.destroy=l,Object.defineProperties(e,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
+var P=Object.defineProperty;var g=(e,t,n)=>t in e?P(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n;var l=(e,t,n)=>(g(e,typeof t!="symbol"?t+"":t,n),n),p=(e,t,n)=>{if(!t.has(e))throw TypeError("Cannot "+n)};var f=(e,t,n)=>(p(e,t,"read from private field"),n?n.call(e):t.get(e)),b=(e,t,n)=>{if(t.has(e))throw TypeError("Cannot add the same private member more than once");t instanceof WeakSet?t.add(e):t.set(e,n)},m=(e,t,n,d)=>(p(e,t,"write to private field"),d?d.call(e,n):t.set(e,n),n);(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports):typeof define=="function"&&define.amd?define(["exports"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e.wardens={}))})(this,function(e){var a;"use strict";function t(c){const o=new WeakMap;return new Proxy(c,{get(s,i){const r=Reflect.get(s,i,s);if(typeof r=="function"){if(o.has(r)===!1){const u=r.bind(s);Object.defineProperties(u,Object.getOwnPropertyDescriptors(r)),o.set(r,u)}return o.get(r)}return r},set(s,i,r){return Reflect.set(s,i,r,s)}})}const n=new WeakMap;function d(c){return Proxy.revocable(c,{})}class x{constructor(o){b(this,a,void 0);l(this,"create",async(o,...s)=>{const i=await h(o,...s);return f(this,a).add(i),i});l(this,"destroy",async o=>{if(!f(this,a).has(o))throw new Error("You do not own this resource.");try{await y(o)}finally{f(this,a).delete(o)}});m(this,a,o)}}a=new WeakMap;async function h(c,...o){const s=new Set,i=new x(s),r=await c(i,...o),u=r.value,{proxy:w,revoke:v}=d(u);return n.set(w,{resource:r,children:s,revoke:v}),w}async function y(c){const o=n.get(c);if(o){n.delete(c),o.revoke();const s=Array.from(o.children).map(y),i=await Promise.allSettled(s);o.resource.destroy&&await o.resource.destroy(),i.forEach(r=>{if(r.status==="rejected")throw r.reason})}}e.bindContext=t,e.create=h,e.destroy=y,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "wardens",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "A framework for resource management",
   "main": "./dist/wardens.umd.js",
   "module": "./dist/wardens.es.js",
+  "types": "./src/index.ts",
   "repository": "git@github.com:PsychoLlama/wardens.git",
   "author": "Jesse Gibson <JesseTheGibson@gmail.com>",
   "license": "MIT",
@@ -31,7 +32,7 @@
   "exports": {
     ".": {
       "require": "./dist/wardens.umd.js",
-      "import": "./dist/wardens.es.js"
+      "import": "./dist/wardens.mjs"
     }
   },
   "husky": {
@@ -82,17 +83,16 @@
     "preset": "ts-jest"
   },
   "devDependencies": {
-    "@types/jest": "28.1.2",
-    "@typescript-eslint/eslint-plugin": "5.28.0",
-    "@typescript-eslint/parser": "5.28.0",
-    "eslint": "8.18.0",
-    "husky": "8.0.1",
-    "jest": "28.1.1",
-    "lint-staged": "13.0.2",
-    "prettier": "2.7.1",
-    "ts-jest": "28.0.5",
-    "typescript": "4.7.4",
-    "vite": "2.9.12",
-    "vite-dts": "1.0.4"
+    "@types/jest": "29.2.5",
+    "@typescript-eslint/eslint-plugin": "5.48.1",
+    "@typescript-eslint/parser": "5.48.1",
+    "eslint": "8.31.0",
+    "husky": "8.0.3",
+    "jest": "29.3.1",
+    "lint-staged": "13.1.0",
+    "prettier": "2.8.3",
+    "ts-jest": "29.0.5",
+    "typescript": "4.9.4",
+    "vite": "4.0.4"
   }
 }

package/src/bind-context.ts

@@ -15,7 +15,7 @@
  *
  */
 export default function bindContext<T extends object>(value: T) {
-  const methodBindings = new WeakMap<Fn, Fn>();
+  const methodBindings = new WeakMap<object, AnyMethod>();
 
   return new Proxy(value, {
     get(target, property) {
@@ -48,5 +48,4 @@ export default function bindContext<T extends object>(value: T) {
   });
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type Fn = (...args: any) => any;
+type AnyMethod = (...args: Array<unknown>) => unknown;

package/dist/wardens.es.d.ts

@@ -1 +0,0 @@
-export * from "../src/index"

package/dist/wardens.es.js

@@ -1,102 +0,0 @@
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateSet = (obj, member, value, setter) => {
-  __accessCheck(obj, member, "write to private field");
-  setter ? setter.call(obj, value) : member.set(obj, value);
-  return value;
-};
-var _resources;
-function bindContext(value) {
-  const methodBindings = /* @__PURE__ */ new WeakMap();
-  return new Proxy(value, {
-    get(target, property) {
-      const value2 = Reflect.get(target, property, target);
-      if (typeof value2 === "function") {
-        if (methodBindings.has(value2) === false) {
-          const methodBinding = value2.bind(target);
-          Object.defineProperties(methodBinding, Object.getOwnPropertyDescriptors(value2));
-          methodBindings.set(value2, methodBinding);
-        }
-        return methodBindings.get(value2);
-      }
-      return value2;
-    },
-    set(target, property, newValue) {
-      return Reflect.set(target, property, newValue, target);
-    }
-  });
-}
-const resources = /* @__PURE__ */ new WeakMap();
-function wrapWithProxy(value) {
-  return Proxy.revocable(value, {});
-}
-class ResourceContext {
-  constructor(ownedResources) {
-    __privateAdd(this, _resources, void 0);
-    __publicField(this, "create", async (factory, ...args) => {
-      const controls = await create(factory, ...args);
-      __privateGet(this, _resources).add(controls);
-      return controls;
-    });
-    __publicField(this, "destroy", async (resource) => {
-      if (!__privateGet(this, _resources).has(resource)) {
-        throw new Error("You do not own this resource.");
-      }
-      try {
-        await destroy(resource);
-      } finally {
-        __privateGet(this, _resources).delete(resource);
-      }
-    });
-    __privateSet(this, _resources, ownedResources);
-  }
-}
-_resources = new WeakMap();
-async function create(provision, ...args) {
-  const children = /* @__PURE__ */ new Set();
-  const context = new ResourceContext(children);
-  const resource = await provision(context, ...args);
-  const controls = resource.value;
-  const { proxy, revoke } = wrapWithProxy(controls);
-  resources.set(proxy, {
-    resource,
-    children,
-    revoke
-  });
-  return proxy;
-}
-async function destroy(controls) {
-  const entry = resources.get(controls);
-  if (entry) {
-    resources.delete(controls);
-    entry.revoke();
-    const recursiveUnmounts = Array.from(entry.children).map(destroy);
-    const results = await Promise.allSettled(recursiveUnmounts);
-    if (entry.resource.destroy) {
-      await entry.resource.destroy();
-    }
-    results.forEach((result) => {
-      if (result.status === "rejected") {
-        throw result.reason;
-      }
-    });
-  }
-}
-export { bindContext, create, destroy };

package/dist/wardens.umd.d.ts

@@ -1 +0,0 @@
-export * from "../src/index"