wardens 0.5.0 → 0.5.1-2024-07-29.a37451d

package/src/{types.ts → utility-types.ts}

@@ -1,4 +1,6 @@
-import type ResourceContext from './resource-context';
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { ContextHandle } from './inherited-context';
+import type ResourceScope from './resource-scope';
 
 /**
  * Represents an arbitrary stateful resource that is asynchronously provisioned
@@ -6,14 +8,14 @@ import type ResourceContext from './resource-context';
  * first tears down the children.
  */
 export interface ResourceFactory<Value extends object> {
-  (resource: ResourceContext): Promise<Resource<Value>>;
+  (resource: ResourceScope): Promise<Resource<Value>>;
 }
 
 export interface ParametrizedResourceFactory<
   Value extends object,
   Args extends Array<unknown>,
 > {
-  (resource: ResourceContext, ...args: Args): Promise<Resource<Value>>;
+  (resource: ResourceScope, ...args: Args): Promise<Resource<Value>>;
 }
 
 export interface Resource<Value extends object> {
@@ -25,6 +27,10 @@ export interface Resource<Value extends object> {
 }
 
 /** The `value` type returned when creating a resource. */
-export type ResourceHandle<Factory extends ResourceFactory<object>> = Awaited<
-  ReturnType<Factory>
->['value'];
+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,86 +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]
-
-## [0.5.0]
-
-### 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.0...HEAD
-[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

package/src/__tests__/resource-context.test.ts

@@ -1,75 +0,0 @@
-import ResourceContext from '../resource-context';
-import { create } from '../allocation';
-
-describe('ResourceContext', () => {
-  async function Test() {
-    return { value: {} };
-  }
-
-  it('can spawn children of its own', async () => {
-    const Child = async () => ({
-      value: { child: true },
-    });
-
-    const Parent = async (resource: ResourceContext) => {
-      return { value: await resource.create(Child) };
-    };
-
-    await expect(create(Parent)).resolves.toEqual({ child: true });
-  });
-
-  it('can deallocate child resources on demand', async () => {
-    const spy = vi.fn();
-
-    const Child = async () => ({
-      value: { child: true },
-      destroy: spy,
-    });
-
-    const Parent = async (resource: ResourceContext) => {
-      const child = await resource.create(Child);
-      await resource.destroy(child);
-
-      return {
-        value: { parent: true },
-      };
-    };
-
-    await expect(create(Parent)).resolves.toEqual({ parent: true });
-    expect(spy).toHaveBeenCalled();
-  });
-
-  it('fails to destroy resources owned by someone else', async () => {
-    const test = await create(Test);
-
-    const Sneaky = async (resource: ResourceContext) => {
-      await resource.destroy(test);
-      return { value: {} };
-    };
-
-    await expect(create(Sneaky)).rejects.toThrow(/do not own/i);
-  });
-
-  it('binds create/destroy handlers to the class instance', async () => {
-    async function Allocator({ create, destroy }: ResourceContext) {
-      const test = await create(Test);
-      await destroy(test);
-
-      return { value: [] };
-    }
-
-    await expect(create(Allocator)).resolves.not.toThrow();
-  });
-
-  it('indicates if a resource was already destroyed', async () => {
-    async function Allocator(resource: ResourceContext) {
-      const test = await resource.create(Test);
-      await resource.destroy(test);
-      await resource.destroy(test);
-
-      return { value: [] };
-    }
-
-    await expect(create(Allocator)).rejects.toThrow(/already destroyed/i);
-  });
-});

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

@@ -1,19 +0,0 @@
-import { create, ResourceHandle } from '../';
-
-describe('Utility types', () => {
-  describe('ResourceHandle', () => {
-    it('infers the correct type', async () => {
-      async function Test() {
-        return {
-          value: { hello: 'world' },
-        };
-      }
-
-      const test = await create(Test);
-
-      expectTypeOf(test).toEqualTypeOf<ResourceHandle<typeof Test>>({
-        hello: 'world',
-      });
-    });
-  });
-});