@nebutra/provider-factory 0.2.2 → 0.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebutra/provider-factory",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Neutral provider-resolution primitive: the identical 'explicit ?? env ?? detect-chain ?? fallback' selection + prod-guard shared by every provider-agnostic Nebutra package. No instantiation logic.",
   "private": false,
   "license": "MIT",
@@ -10,10 +10,14 @@
     "category": "platform",
     "summary": "Shared provider-type resolution + prod safety guard"
   },
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.ts"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
   },
   "dependencies": {},
   "devDependencies": {
@@ -34,6 +38,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
   "scripts": {
     "build": "tsup",
     "test": "vitest run",

package/.turbo/turbo-build.log

@@ -1,17 +0,0 @@
-
-> @nebutra/provider-factory@0.2.2 build /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/provider-factory
-> tsup
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.1
-CLI Using tsup config: /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/provider-factory/tsup.config.ts
-CLI Target: es2022
-CLI Cleaning output folder
-ESM Build start
-ESM dist/index.js     997.00 B
-ESM dist/index.js.map 3.97 KB
-ESM ⚡️ Build success in 19ms
-DTS Build start
-DTS ⚡️ Build success in 2777ms
-DTS dist/index.d.ts 2.53 KB

package/.turbo/turbo-test.log

@@ -1,14 +0,0 @@
-
-> @nebutra/provider-factory@0.2.1 test /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/provider-factory
-> vitest run
-
-
- RUN  v4.1.4 /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/provider-factory
-
- ✓ src/__tests__/provider-factory.test.ts (9 tests) 3ms
-
- Test Files  1 passed (1)
-      Tests  9 passed (9)
-   Start at  09:38:26
-   Duration  204ms (transform 26ms, setup 0ms, import 37ms, tests 3ms, environment 0ms)
-

package/.turbo/turbo-typecheck.log

@@ -1,4 +0,0 @@
-
-> @nebutra/provider-factory@0.2.2 typecheck /Users/tseka_luk/Documents/Nebutra-SaaS-Lab/Nebutra-Sailor/packages/platform/provider-factory
-> tsc --noEmit
-

package/src/__tests__/provider-factory.test.ts

@@ -1,110 +0,0 @@
-import { afterEach, describe, expect, it } from "vitest";
-import { assertProviderAllowed, envPresent, resolveProviderType } from "../index";
-
-const SAVED = { ...process.env };
-afterEach(() => {
-  process.env = { ...SAVED };
-});
-
-type P = "qstash" | "bullmq" | "memory";
-
-const detectors = [
-  { provider: "qstash" as P, when: envPresent("QSTASH_TOKEN") },
-  { provider: "bullmq" as P, when: envPresent("REDIS_URL") },
-];
-
-describe("resolveProviderType precedence", () => {
-  it("1. explicit config wins over everything", () => {
-    process.env.QUEUE_PROVIDER = "bullmq";
-    process.env.QSTASH_TOKEN = "x";
-    expect(
-      resolveProviderType<P>({
-        explicit: "memory",
-        envVarName: "QUEUE_PROVIDER",
-        detectors,
-        fallback: "memory",
-      }),
-    ).toBe("memory");
-  });
-
-  it("2. env var beats detection", () => {
-    process.env.QSTASH_TOKEN = "x"; // would detect qstash
-    process.env.QUEUE_PROVIDER = "bullmq";
-    expect(
-      resolveProviderType<P>({ envVarName: "QUEUE_PROVIDER", detectors, fallback: "memory" }),
-    ).toBe("bullmq");
-  });
-
-  it("3. detection chain order is honoured", () => {
-    process.env.QUEUE_PROVIDER = undefined;
-    process.env.REDIS_URL = "redis://x";
-    expect(
-      resolveProviderType<P>({ envVarName: "QUEUE_PROVIDER", detectors, fallback: "memory" }),
-    ).toBe("bullmq");
-    process.env.QSTASH_TOKEN = "x";
-    expect(
-      resolveProviderType<P>({ envVarName: "QUEUE_PROVIDER", detectors, fallback: "memory" }),
-    ).toBe("qstash"); // earlier detector wins
-  });
-
-  it("4. fallback when nothing matches", () => {
-    expect(
-      resolveProviderType<P>({ envVarName: "QUEUE_PROVIDER", detectors, fallback: "memory" }),
-    ).toBe("memory");
-  });
-
-  it("trims/ignores an empty env var", () => {
-    process.env.QUEUE_PROVIDER = "   ";
-    expect(
-      resolveProviderType<P>({ envVarName: "QUEUE_PROVIDER", detectors, fallback: "memory" }),
-    ).toBe("memory");
-  });
-});
-
-describe("envPresent", () => {
-  it("is true only for a non-empty value", () => {
-    process.env.X = "";
-    expect(envPresent("X")()).toBe(false);
-    process.env.X = "v";
-    expect(envPresent("X")()).toBe(true);
-  });
-});
-
-describe("assertProviderAllowed", () => {
-  it("throws for a disallowed provider in production unless overridden", () => {
-    process.env.NODE_ENV = "production";
-    expect(() =>
-      assertProviderAllowed("memory", {
-        disallowedInProd: ["memory"],
-        overrideEnv: "ALLOW_MEMORY",
-        hint: "configure REDIS_URL",
-      }),
-    ).toThrow(/production/);
-    process.env.ALLOW_MEMORY = "true";
-    expect(() =>
-      assertProviderAllowed("memory", {
-        disallowedInProd: ["memory"],
-        overrideEnv: "ALLOW_MEMORY",
-        hint: "configure REDIS_URL",
-      }),
-    ).not.toThrow();
-  });
-
-  it("throws the caller's exact message when provided", () => {
-    process.env.NODE_ENV = "production";
-    expect(() =>
-      assertProviderAllowed("memory", {
-        disallowedInProd: ["memory"],
-        overrideEnv: "X",
-        message: "Refusing to use the in-memory queue provider in production",
-      }),
-    ).toThrow("Refusing to use the in-memory queue provider in production");
-  });
-
-  it("never throws outside production", () => {
-    process.env.NODE_ENV = "test";
-    expect(() =>
-      assertProviderAllowed("memory", { disallowedInProd: ["memory"], overrideEnv: "X" }),
-    ).not.toThrow();
-  });
-});

package/src/index.ts

@@ -1,86 +0,0 @@
-/**
- * @nebutra/provider-factory — the neutral provider-resolution primitive.
- *
- * Every provider-agnostic Nebutra package (queue, search, notifications,
- * vault, uploads, …) repeated the exact same selection:
- *
- *   providerType = explicit ?? env[`${X}_PROVIDER`] ?? detect-chain ?? fallback
- *
- * plus a "refuse the in-memory provider in production" guard. That selection
- * is identical and domain-free; only the subsequent *instantiation* switch
- * (dynamic-importing the concrete provider) is domain-specific and stays in
- * each package. This module owns the selection, nothing else.
- */
-
-/** One auto-detection rule: pick `provider` when `when()` is true. */
-export interface ProviderDetector<T extends string> {
-  readonly provider: T;
-  readonly when: () => boolean;
-}
-
-/** `true` when the named env var is set to a non-empty (trimmed) value. */
-export function envPresent(name: string): () => boolean {
-  return () => {
-    const v = process.env[name];
-    return typeof v === "string" && v.trim().length > 0;
-  };
-}
-
-export interface ResolveProviderInput<T extends string> {
-  /** Explicit caller config — highest precedence. */
-  readonly explicit?: T | undefined;
-  /** Env var holding an explicit provider name (e.g. `QUEUE_PROVIDER`). */
-  readonly envVarName: string;
-  /** Ordered auto-detection rules; first match wins. */
-  readonly detectors: ReadonlyArray<ProviderDetector<T>>;
-  /** Used when nothing else resolves. */
-  readonly fallback: T;
-}
-
-/**
- * Resolve the provider type. Precedence: explicit → env var → detector chain
- * (in order) → fallback. An empty/whitespace env var is ignored.
- */
-export function resolveProviderType<T extends string>(input: ResolveProviderInput<T>): T {
-  if (input.explicit) return input.explicit;
-  const fromEnv = process.env[input.envVarName]?.trim();
-  if (fromEnv) return fromEnv as T;
-  for (const d of input.detectors) {
-    if (d.when()) return d.provider;
-  }
-  return input.fallback;
-}
-
-export interface ProdGuardOptions<T extends string> {
-  /** Providers that must not run in production. */
-  readonly disallowedInProd: readonly T[];
-  /** Env var that, when "true", permits the disallowed provider anyway. */
-  readonly overrideEnv: string;
-  /** Optional remediation hint appended to the default error. */
-  readonly hint?: string;
-  /**
-   * Exact error message to throw, overriding the default. Use this to keep a
-   * package's existing wording (error strings are domain copy, not shared
-   * logic — only the prod-detection is shared).
-   */
-  readonly message?: string;
-}
-
-/**
- * Refuse a disallowed provider in production unless the override env is set.
- * No-op outside `NODE_ENV==="production"`.
- */
-export function assertProviderAllowed<T extends string>(
-  provider: T,
-  opts: ProdGuardOptions<T>,
-): void {
-  if (process.env.NODE_ENV !== "production") return;
-  if (!opts.disallowedInProd.includes(provider)) return;
-  if (process.env[opts.overrideEnv] === "true") return;
-  if (opts.message) throw new Error(opts.message);
-  throw new Error(
-    `Refusing to use the "${provider}" provider in production. ` +
-      `${opts.hint ? `${opts.hint}. ` : ""}` +
-      `Set ${opts.overrideEnv}=true for an explicit temporary override.`,
-  );
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src",
-    "incremental": false
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "dist"]
-}

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  entry: ["src/index.ts"],
-  format: ["esm"],
-  dts: true,
-  clean: true,
-  sourcemap: true,
-  target: "es2022",
-});