@fluixi/di 0.0.0-stage → 1.0.0-alpha.101

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ibrahima Touré
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,44 @@
-# Temporary Holding Version
+# @fluixi/di
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Dependency injection for Fluixi: typed tokens, hierarchical injectors on the reactive owner tree,
+one root injector per request on the server, multi providers, resolution options, lifecycles and
+test overrides.
+
+```sh
+pnpm add @fluixi/di
+```
+
+```ts
+import { injectionToken, provideRoot, inject } from '@fluixi/di';
+
+const Api = injectionToken<ApiClient>('Api');
+provideRoot([{ provide: Api, useFactory: () => new ApiClient(env.API_URL) }]);
+
+function Tickets() {
+  const api = inject(Api);
+}
+```
+
+Packages import `@fluixi/di` and declare it as a peer dependency. Apps built with
+`@fluixi/start` may import `@fluixi/start/di`, which re-exports this package.
+
+| Export | Purpose |
+|---|---|
+| `injectionToken` | a typed token, optionally self-providing (`factory`, `scope`) |
+| `inject` | resolve from the current context, with `optional`, `self`, `skipSelf`, `host` |
+| `provide` | services for a component and its descendants |
+| `provideRoot` | services for the app: per request on the server, per page in the browser |
+| `providePlatform` | services for the whole process |
+| `provideAppInitializer`, `runAppInitializers` | work that finishes before the first render |
+| `DestroyRef`, `INJECTOR` | an injector's lifecycle, and the injector itself |
+| `runInInjectionContext`, `isInInjectionContext`, `assertInInjectionContext` | the injection context |
+| `createInjector`, `Injector` | injectors of your own |
+| `InjectionError` | thrown with the full resolution path |
+
+Tests import `createTestInjector` and `resetInjection` from `@fluixi/di/testing`.
+
+Documentation: [Dependency injection](https://docs.fluixi.com/v1/en/dependency-injection).
+
+## License
+
+MIT

package/dist/errors.cjs

@@ -0,0 +1,36 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/errors.ts
+var errors_exports = {};
+__export(errors_exports, {
+  InjectionError: () => InjectionError
+});
+module.exports = __toCommonJS(errors_exports);
+var InjectionError = class extends Error {
+  /**
+   * @param message - What went wrong, with the path rendered into it.
+   * @param path - The tokens being resolved, outermost first; the last one is the one that failed.
+   */
+  constructor(message, path) {
+    super(message);
+    this.path = path;
+    this.name = "InjectionError";
+  }
+};

package/dist/errors.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The error a resolution throws.
+ *
+ * @module
+ */
+/**
+ * Thrown when a token cannot be resolved: nothing provides it (and it has no factory), its
+ * providers depend on each other in a cycle, or it is asked of a disposed injector.
+ *
+ * The message names the whole resolution path, outermost first, so the provider that is
+ * missing can be told apart from the service that needed it: `Checkout → Payments → ApiKey`.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   inject(Checkout);
+ * } catch (error) {
+ *   if (error instanceof InjectionError) console.error(error.path); // ['Checkout', 'Payments', 'ApiKey']
+ *   throw error;
+ * }
+ * ```
+ */
+export declare class InjectionError extends Error {
+    readonly path: readonly string[];
+    /**
+     * @param message - What went wrong, with the path rendered into it.
+     * @param path - The tokens being resolved, outermost first; the last one is the one that failed.
+     */
+    constructor(message: string, path: readonly string[]);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAOrC,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE;IANlC;;;OAGG;gBAED,OAAO,EAAE,MAAM,EACN,IAAI,EAAE,SAAS,MAAM,EAAE;CAKnC"}

package/dist/errors.js

@@ -0,0 +1,34 @@
+/**
+ * The error a resolution throws.
+ *
+ * @module
+ */
+/**
+ * Thrown when a token cannot be resolved: nothing provides it (and it has no factory), its
+ * providers depend on each other in a cycle, or it is asked of a disposed injector.
+ *
+ * The message names the whole resolution path, outermost first, so the provider that is
+ * missing can be told apart from the service that needed it: `Checkout → Payments → ApiKey`.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   inject(Checkout);
+ * } catch (error) {
+ *   if (error instanceof InjectionError) console.error(error.path); // ['Checkout', 'Payments', 'ApiKey']
+ *   throw error;
+ * }
+ * ```
+ */
+export class InjectionError extends Error {
+    path;
+    /**
+     * @param message - What went wrong, with the path rendered into it.
+     * @param path - The tokens being resolved, outermost first; the last one is the one that failed.
+     */
+    constructor(message, path) {
+        super(message);
+        this.path = path;
+        this.name = 'InjectionError';
+    }
+}

package/dist/errors.mjs

@@ -0,0 +1,15 @@
+// src/errors.ts
+var InjectionError = class extends Error {
+  /**
+   * @param message - What went wrong, with the path rendered into it.
+   * @param path - The tokens being resolved, outermost first; the last one is the one that failed.
+   */
+  constructor(message, path) {
+    super(message);
+    this.path = path;
+    this.name = "InjectionError";
+  }
+};
+export {
+  InjectionError
+};

package/dist/hierarchy.cjs

@@ -0,0 +1,291 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __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), value);
+var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
+
+// src/hierarchy.ts
+var hierarchy_exports = {};
+__export(hierarchy_exports, {
+  currentInjector: () => currentInjector,
+  nearestOwnerInjector: () => nearestOwnerInjector,
+  platformInjector: () => platformInjector,
+  rootInjector: () => rootInjector
+});
+module.exports = __toCommonJS(hierarchy_exports);
+var import_dom = require("@fluixi/dom");
+var import_signal2 = require("@fluixi/reactive/signal");
+
+// src/injector.ts
+var import_signal = require("@fluixi/reactive/signal");
+
+// src/errors.ts
+var InjectionError = class extends Error {
+  /**
+   * @param message - What went wrong, with the path rendered into it.
+   * @param path - The tokens being resolved, outermost first; the last one is the one that failed.
+   */
+  constructor(message, path) {
+    super(message);
+    this.path = path;
+    this.name = "InjectionError";
+  }
+};
+
+// src/state.ts
+function freshState() {
+  return {
+    platformProviders: [],
+    rootProviders: [],
+    platform: null,
+    clientRoot: null,
+    requestRoots: /* @__PURE__ */ new WeakMap(),
+    ownerInjectors: /* @__PURE__ */ new WeakMap(),
+    moduleScopes: /* @__PURE__ */ new WeakMap(),
+    overrides: /* @__PURE__ */ new Map(),
+    explicit: null,
+    path: []
+  };
+}
+var state = globalThis[/* @__PURE__ */ Symbol.for("fluixi.di")] ??= freshState();
+
+// src/token.ts
+function injectionToken(name, options) {
+  return { id: Symbol(name), name, factory: options?.factory, scope: options?.scope ?? "root" };
+}
+
+// src/tokens.ts
+var DestroyRef = injectionToken("DestroyRef");
+var INJECTOR = injectionToken("Injector");
+
+// src/injector.ts
+var _records, _created, _hooks, _destroyed, _Injector_instances, home_fn, fromProvider_fn, build_fn, make_fn;
+var Injector = class {
+  /**
+   * @param parent - Where a token this injector does not hold is looked for next; `null` for the
+   *   top of a chain.
+   * @param kind - Where the injector sits in the hierarchy; see {@link InjectorKind}.
+   */
+  constructor(parent = null, kind = "standalone") {
+    this.parent = parent;
+    this.kind = kind;
+    __privateAdd(this, _Injector_instances);
+    __privateAdd(this, _records, /* @__PURE__ */ new Map());
+    __privateAdd(this, _created, []);
+    __privateAdd(this, _hooks, []);
+    __privateAdd(this, _destroyed, false);
+    const self = this;
+    this.destroyRef = {
+      onDestroy(fn) {
+        __privateGet(self, _hooks).push(fn);
+        return () => {
+          const i = __privateGet(self, _hooks).indexOf(fn);
+          if (i >= 0) __privateGet(self, _hooks).splice(i, 1);
+        };
+      },
+      get destroyed() {
+        return __privateGet(self, _destroyed);
+      }
+    };
+  }
+  /** Whether {@link Injector.dispose} has run. A disposed injector refuses every `get`. */
+  get destroyed() {
+    return __privateGet(this, _destroyed);
+  }
+  /**
+   * Add providers to this injector. A provider for a token already held replaces it, except
+   * `multi` providers, which extend the token's list. A provider whose token has a test override
+   * is replaced by the override.
+   *
+   * @param providers - The providers to add, in order.
+   * @returns This injector, for chaining.
+   */
+  register(providers) {
+    for (const given of providers) {
+      const p = state.overrides.get(given.provide.id) ?? given;
+      if (p.multi) {
+        const rec = __privateGet(this, _records).get(p.provide.id);
+        if (rec?.multi) {
+          rec.providers.push(p);
+          rec.built = false;
+        } else __privateGet(this, _records).set(p.provide.id, { multi: true, providers: [p], built: false, building: false, value: [] });
+      } else {
+        __privateGet(this, _records).set(p.provide.id, { multi: false, provider: p, built: false, building: false, value: void 0 });
+      }
+    }
+    return this;
+  }
+  get(token, options = {}) {
+    var _a, _b, _c;
+    if (__privateGet(this, _destroyed)) throw new InjectionError(`[fluixi/di] "${token.name}" requested from a disposed injector.`, [...state.path, token.name]);
+    if (token.id === INJECTOR.id) return this;
+    if (token.id === DestroyRef.id) return this.destroyRef;
+    let inj = options.skipSelf ? this.parent : this;
+    while (inj) {
+      const rec = __privateGet(inj, _records).get(token.id);
+      if (rec) return __privateMethod(_a = inj, _Injector_instances, build_fn).call(_a, token, rec);
+      if (options.self || options.host && inj.kind === "owner") break;
+      inj = inj.parent;
+    }
+    const override = state.overrides.get(token.id);
+    if (override && !options.self) return __privateMethod(_b = __privateMethod(this, _Injector_instances, home_fn).call(this, token.scope), _Injector_instances, fromProvider_fn).call(_b, token, override);
+    if (token.factory && !options.self && !options.host) {
+      return __privateMethod(_c = __privateMethod(this, _Injector_instances, home_fn).call(this, token.scope), _Injector_instances, fromProvider_fn).call(_c, token, { provide: token, useFactory: token.factory });
+    }
+    if (options.optional) return null;
+    const path = [...state.path, token.name];
+    throw new InjectionError(
+      `[fluixi/di] No provider for "${token.name}" (${path.join(" → ")}). Provide it in an app module, with provide() or provideRoot(), or give the token a { factory }.`,
+      path
+    );
+  }
+  /**
+   * Release this injector: run the hooks registered on its `DestroyRef`, latest first, then the
+   * `onDestroy()` method of every service it built, latest built first, then forget its
+   * providers. A hook or `onDestroy()` that throws is logged and the rest still run. Running it
+   * again does nothing.
+   *
+   * Component injectors are disposed when the component unmounts, request roots when the request
+   * ends; call it yourself only for injectors you created.
+   */
+  dispose() {
+    if (__privateGet(this, _destroyed)) return;
+    __privateSet(this, _destroyed, true);
+    const fail = (error) => console.error("[fluixi/di] a destroy hook threw:", error);
+    for (const hook of __privateGet(this, _hooks).splice(0).reverse()) {
+      try {
+        hook();
+      } catch (error) {
+        fail(error);
+      }
+    }
+    for (const value of __privateGet(this, _created).splice(0).reverse()) {
+      const service = value;
+      if (service && typeof service.onDestroy === "function") {
+        try {
+          service.onDestroy();
+        } catch (error) {
+          fail(error);
+        }
+      }
+    }
+    __privateGet(this, _records).clear();
+  }
+};
+_records = new WeakMap();
+_created = new WeakMap();
+_hooks = new WeakMap();
+_destroyed = new WeakMap();
+_Injector_instances = new WeakSet();
+/** The injector a self-providing token builds in: the nearest root, or the platform. */
+home_fn = function(scope) {
+  let inj = this;
+  if (scope === "platform") {
+    while (inj.parent) inj = inj.parent;
+    return inj.kind === "platform" ? inj : platformInjector();
+  }
+  let probe = this;
+  while (probe) {
+    if (probe.kind === "root") return probe;
+    probe = probe.parent;
+  }
+  while (inj.parent && inj.parent.kind !== "platform") inj = inj.parent;
+  return inj;
+};
+fromProvider_fn = function(token, provider) {
+  let rec = __privateGet(this, _records).get(token.id);
+  if (!rec) {
+    rec = { multi: false, provider, built: false, building: false, value: void 0 };
+    __privateGet(this, _records).set(token.id, rec);
+  }
+  return __privateMethod(this, _Injector_instances, build_fn).call(this, token, rec);
+};
+build_fn = function(token, rec) {
+  if (rec.built) return rec.value;
+  if (rec.building) {
+    const path = [...state.path, token.name];
+    throw new InjectionError(`[fluixi/di] Circular dependency: ${path.join(" → ")}.`, path);
+  }
+  rec.building = true;
+  state.path.push(token.name);
+  const previous = state.explicit;
+  state.explicit = this;
+  try {
+    if (rec.multi) {
+      rec.value = rec.providers.map((p) => __privateMethod(this, _Injector_instances, make_fn).call(this, token, p));
+    } else {
+      const module2 = state.moduleScopes.get(rec.provider);
+      rec.value = module2 ? (0, import_signal.withReactiveScope)(module2, () => __privateMethod(this, _Injector_instances, make_fn).call(this, token, rec.provider)) : __privateMethod(this, _Injector_instances, make_fn).call(this, token, rec.provider);
+    }
+    rec.built = true;
+    return rec.value;
+  } finally {
+    state.explicit = previous;
+    state.path.pop();
+    rec.building = false;
+  }
+};
+make_fn = function(token, p) {
+  if ("useValue" in p) return p.useValue;
+  if ("useExisting" in p) return this.get(p.useExisting);
+  const deps = (p.deps ?? []).map((d) => "token" in d ? this.get(d.token, d) : this.get(d));
+  const scope = (0, import_signal.openReactiveScope)({ kind: "service", name: token.name, detail: "useClass" in p ? "useClass" : "useFactory" });
+  const value = (0, import_signal.withReactiveScope)(scope, () => "useClass" in p ? new p.useClass(...deps) : p.useFactory(...deps));
+  __privateGet(this, _created).push(value);
+  return value;
+};
+
+// src/hierarchy.ts
+function platformInjector() {
+  return state.platform ??= new Injector(null, "platform").register(state.platformProviders);
+}
+function rootInjector() {
+  const ctx = (0, import_dom.getRequestContext)();
+  if (ctx) {
+    let inj = state.requestRoots.get(ctx);
+    if (!inj) {
+      const root = new Injector(platformInjector(), "root").register(state.rootProviders);
+      state.requestRoots.set(ctx, root);
+      (0, import_dom.onRequestEnd)(() => {
+        state.requestRoots.delete(ctx);
+        root.dispose();
+      });
+      inj = root;
+    }
+    return inj;
+  }
+  return state.clientRoot ??= new Injector(platformInjector(), "root").register(state.rootProviders);
+}
+function nearestOwnerInjector(owner) {
+  let o = owner;
+  while (o) {
+    const inj = state.ownerInjectors.get(o);
+    if (inj) return inj;
+    o = o.parent;
+  }
+  return null;
+}
+function currentInjector() {
+  return state.explicit ?? nearestOwnerInjector((0, import_signal2.getOwner)()) ?? rootInjector();
+}

package/dist/hierarchy.d.ts

@@ -0,0 +1,11 @@
+import { Injector } from './injector.js';
+/** The process-wide injector: `providePlatform` services and `scope: 'platform'` tokens. */
+export declare function platformInjector(): Injector;
+/**
+ * The root injector: one per request during a server render (disposed when the request ends),
+ * one per app in the browser.
+ */
+export declare function rootInjector(): Injector;
+export declare function nearestOwnerInjector(owner: any): Injector | null;
+export declare function currentInjector(): Injector;
+//# sourceMappingURL=hierarchy.d.ts.map

package/dist/hierarchy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hierarchy.d.ts","sourceRoot":"","sources":["../src/hierarchy.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC,4FAA4F;AAC5F,wBAAgB,gBAAgB,IAAI,QAAQ,CAE3C;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,QAAQ,CAgBvC;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,GAAG,GAAG,QAAQ,GAAG,IAAI,CAQhE;AAED,wBAAgB,eAAe,IAAI,QAAQ,CAE1C"}

package/dist/hierarchy.js

@@ -0,0 +1,47 @@
+/**
+ * The hierarchy of injectors: the platform (one per process), the root (one per request on the
+ * server, disposed when the request ends; one per app in the browser), and the component
+ * injectors `provide()` attaches to the reactive owner tree.
+ */
+import { getRequestContext, onRequestEnd } from '@fluixi/dom';
+import { getOwner } from '@fluixi/reactive/signal';
+import { Injector } from './injector.js';
+import { state } from './state.js';
+/** The process-wide injector: `providePlatform` services and `scope: 'platform'` tokens. */
+export function platformInjector() {
+    return (state.platform ??= new Injector(null, 'platform').register(state.platformProviders));
+}
+/**
+ * The root injector: one per request during a server render (disposed when the request ends),
+ * one per app in the browser.
+ */
+export function rootInjector() {
+    const ctx = getRequestContext();
+    if (ctx) {
+        let inj = state.requestRoots.get(ctx);
+        if (!inj) {
+            const root = new Injector(platformInjector(), 'root').register(state.rootProviders);
+            state.requestRoots.set(ctx, root);
+            onRequestEnd(() => {
+                state.requestRoots.delete(ctx);
+                root.dispose();
+            });
+            inj = root;
+        }
+        return inj;
+    }
+    return (state.clientRoot ??= new Injector(platformInjector(), 'root').register(state.rootProviders));
+}
+export function nearestOwnerInjector(owner) {
+    let o = owner;
+    while (o) {
+        const inj = state.ownerInjectors.get(o);
+        if (inj)
+            return inj;
+        o = o.parent;
+    }
+    return null;
+}
+export function currentInjector() {
+    return state.explicit ?? nearestOwnerInjector(getOwner()) ?? rootInjector();
+}