@codefast/di-testing 0.0.0 → 0.1.1

package/src/mocking/spy.ts

@@ -2,6 +2,8 @@
 
 /**
  * One recorded invocation's outcome — a returned value or a thrown error.
+ *
+ * @since 0.1.0
  */
 export interface SpyResult {
   readonly type: "return" | "throw";
@@ -12,6 +14,8 @@ export interface SpyResult {
  * The call log a spy exposes for assertions.
  *
  * @typeParam Args - The spy's argument tuple.
+ *
+ * @since 0.1.0
  */
 export interface SpyState<Args extends ReadonlyArray<unknown>> {
   readonly calls: ReadonlyArray<Args>;
@@ -24,6 +28,8 @@ export interface SpyState<Args extends ReadonlyArray<unknown>> {
  *
  * @remarks `Return` defaults to `any` so a spy drops into any typed method slot, exactly as Vitest's
  * own mock type does — the package's one deliberate `any`.
+ *
+ * @since 0.1.0
  */
 export interface Spy<Args extends ReadonlyArray<unknown> = ReadonlyArray<unknown>, Return = any> {
   (...args: Args): Return;
@@ -40,6 +46,8 @@ export interface Spy<Args extends ReadonlyArray<unknown> = ReadonlyArray<unknown
 
 /**
  * Creates a fresh zero-dependency spy that records its calls and returns `undefined` until configured.
+ *
+ * @since 0.1.0
  */
 export function createSpy(): Spy {
   const calls: Array<ReadonlyArray<unknown>> = [];

package/src/test-bed/bed-builder.ts

@@ -17,6 +17,8 @@ import type { InjectionIdentifier } from "#/types";
  *
  * @typeParam Backend - The spy type the mock factory produces; it flows into every `Mocked` member,
  * `mocks.get`, and the `.stub` callback, so `() => vi.fn()` yields Vitest's own mock typing.
+ *
+ * @since 0.1.0
  */
 export interface TestBedOptions<Backend extends MockFunction = Spy> {
   /** Spy factory each auto-mock property is materialized with; defaults to the built-in spy. */
@@ -31,6 +33,8 @@ export interface TestBedOptions<Backend extends MockFunction = Spy> {
  * @typeParam Dependency - The dependency's value type.
  * @typeParam Owner - The builder the chain returns to.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export interface MockOverrideBuilder<Dependency, Owner, Backend extends MockFunction = Spy> {
   /**
@@ -54,6 +58,8 @@ export interface MockOverrideBuilder<Dependency, Owner, Backend extends MockFunc
 
 /**
  * What a builder's prepare step hands the compile template: the container and the bound mock entries.
+ *
+ * @since 0.1.0
  */
 export interface PreparedBed {
   readonly container: Container;
@@ -69,6 +75,8 @@ export interface PreparedBed {
  *
  * @typeParam Class - The class under test.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export abstract class BedBuilder<Class, Backend extends MockFunction = Spy> {
   protected readonly target: Constructor<Class>;

package/src/test-bed/sociable-builder.ts

@@ -23,6 +23,8 @@ import type { InjectionIdentifier } from "#/types";
  *
  * @typeParam Class - The class under test.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export interface SociableTestBedBuilder<Class, Backend extends MockFunction = Spy> {
   /** Keeps a class-keyed collaborator real; its own dependencies follow the same exposure rules. */
@@ -46,6 +48,8 @@ type PreparedSociableBed = PreparedBed & { readonly realClasses: ReadonlySet<Con
  *
  * @typeParam Class - The class under test.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export class SociableBuilder<Class, Backend extends MockFunction = Spy>
   extends BedBuilder<Class, Backend>

package/src/test-bed/solitary-builder.ts

@@ -18,6 +18,8 @@ import type { InjectionIdentifier } from "#/types";
  *
  * @typeParam Class - The class under test.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export interface SolitaryTestBedBuilder<Class, Backend extends MockFunction = Spy> {
   /** Replaces the auto-mock for one dependency with a hand-written stub or a concrete value. */
@@ -36,6 +38,8 @@ export interface SolitaryTestBedBuilder<Class, Backend extends MockFunction = Sp
  *
  * @typeParam Class - The class under test.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export class SolitaryBuilder<Class, Backend extends MockFunction = Spy>
   extends BedBuilder<Class, Backend>

package/src/test-bed/test-bed.ts

@@ -12,6 +12,8 @@ import type { SolitaryTestBedBuilder } from "#/test-bed/solitary-builder";
 
 /**
  * The factory surface for building isolated units under test.
+ *
+ * @since 0.1.0
  */
 export interface TestBedStatic {
   /**
@@ -43,6 +45,8 @@ export interface TestBedStatic {
  *
  * @remarks `solitary` and `sociable` record the target and options only; nothing is instantiated
  * until `compile()`.
+ *
+ * @since 0.1.0
  */
 export const TestBed: TestBedStatic = {
   solitary<Class, Backend extends MockFunction = Spy>(

package/src/test-bed/unit-test-bed.ts

@@ -17,6 +17,8 @@ import type { Spy } from "#/mocking/spy";
  * A lookup from a dependency's token or class to the mock the unit was built with.
  *
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export interface UnitReference<Backend extends MockFunction = Spy> {
   /**
@@ -44,6 +46,8 @@ export interface UnitReference<Backend extends MockFunction = Spy> {
  *
  * @typeParam Class - The class under test.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export interface UnitTestBed<Class, Backend extends MockFunction = Spy> extends AsyncDisposable {
   readonly unit: Class;
@@ -59,6 +63,8 @@ export interface UnitTestBed<Class, Backend extends MockFunction = Spy> extends
  *
  * @typeParam Class - The class under test.
  * @typeParam Backend - The spy type the bed's mock factory produces.
+ *
+ * @since 0.1.0
  */
 export interface SociableUnitTestBed<Class, Backend extends MockFunction = Spy> extends UnitTestBed<Class, Backend> {
   /**
@@ -71,6 +77,8 @@ export interface SociableUnitTestBed<Class, Backend extends MockFunction = Spy>
 
 /**
  * Wraps a compiled bed with access to its exposed real collaborators.
+ *
+ * @since 0.1.0
  */
 export function createSociableUnitTestBed<Class, Backend extends MockFunction = Spy>(
   bed: UnitTestBed<Class, Backend>,
@@ -97,6 +105,8 @@ export function createSociableUnitTestBed<Class, Backend extends MockFunction =
 
 /**
  * Assembles a {@link UnitTestBed} around an instantiated unit and its bound mock entries.
+ *
+ * @since 0.1.0
  */
 export function createUnitTestBed<Class, Backend extends MockFunction = Spy>(
   unit: Class,

package/src/types.ts

@@ -9,5 +9,7 @@ import type { Constructor, Token } from "@codefast/di";
  * `mocks.get()` can map an identifier back to the mock type it produced.
  *
  * @typeParam Value - The value type the identified dependency resolves to.
+ *
+ * @since 0.1.0
  */
 export type InjectionIdentifier<Value> = Token<Value> | Constructor<Value>;