create-ragen-app 0.4.0 → 0.6.0

package/dist/worker-runtime.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Which engine runs background jobs, and what choosing BullMQ configures.
+ *
+ * Mirrors `WORKER_RUNTIME_SEAM` in `@ragenai/env`. Copied rather than imported
+ * for the reason `storage-provider.ts` gives: this package is published to npm
+ * and `@ragenai/env` is private, so depending on it would make
+ * `npm create ragen-app` unresolvable.
+ */
+export type WorkerRuntimeChoice = 'temporal' | 'bullmq';
+export declare const WORKER_RUNTIME_LABELS: Record<WorkerRuntimeChoice, string>;
+/**
+ * The published Redis port, not the standard one.
+ *
+ * `docker-compose.yml` maps Redis to 56379 for the reason Postgres is on
+ * 55432: a native Redis on 6379 answers instead of the container, and nothing
+ * about the resulting failure names a port.
+ */
+export declare const DEFAULT_REDIS_URL = "redis://localhost:56379";
+/**
+ * What the address prompt starts from — the adapter's own fallback, and what
+ * `.env.example` ships.
+ *
+ * Offered as a prefilled answer rather than written silently: right on a
+ * laptop, wrong everywhere else, and a deployed worker pointing at its own
+ * container connects to nothing and processes nothing with no error to read.
+ * Temporal left the compose file with ADR-44, so this address now names a
+ * server the operator runs — which makes it exactly the value they should see
+ * before it is written.
+ */
+export declare const DEFAULT_TEMPORAL_SERVER_ADDRESS = "localhost:7233";
+/**
+ * A password the operator never has to invent, and that is never the same
+ * twice.
+ *
+ * The dashboard is off unless both credentials are set, so an installer that
+ * left them blank would ship the runtime with no way to see the queues — which
+ * is the thing the Temporal UI used to provide for free. Writing them is the
+ * point.
+ *
+ * **Generated rather than a fixed default.** A password shipped in this
+ * repository is the same password on every install, on a port that exposes
+ * every job's payload; the first person to read the source has it everywhere.
+ * Generating costs the operator nothing — they type nothing either way — and
+ * the value is printed once so it can be put in a password manager.
+ *
+ * Short enough to retype by hand, unlike `generateSecret()`'s 64 hex
+ * characters: this one is read off a terminal and typed into a browser prompt.
+ */
+export declare function generateAdminPassword(): string;
+export declare const DEFAULT_ADMIN_USER = "admin";
+/**
+ * How many documents the worker ingests at once, written explicitly rather
+ * than left to the code's default.
+ *
+ * It matches `DEFAULT_CONCURRENCY` in `@ragenai/jobs-bullmq`, which D2 raised
+ * from 10 to 20 on the strength of the same measurement: twenty documents
+ * uploaded at once took a median of 24.9s each at 10 and 12.3s at 20, the
+ * difference sitting entirely before parsing began rather than in the work.
+ *
+ * **Written anyway, even though it now equals the default.** The number the
+ * operator has to revisit is this one — it is the first thing to lower when a
+ * provider starts rate-limiting — and a default they never see is not a knob
+ * they can find. If the two ever diverge, this line is the install's answer and
+ * the code's is the fallback for everyone else.
+ *
+ * **A constant, not a guess from the machine.** `os.cpus().length` is the
+ * tempting input and it measures the wrong thing: an ingest is almost entirely
+ * waiting — on storage, on the parser, on the embedding provider — so cores
+ * predict nothing about how many can be in flight. A number derived from
+ * hardware would look principled and mean less than this one.
+ *
+ * Written into `.env` rather than applied silently, because the ceiling that
+ * really binds is the model provider's rate limit, and the operator is the
+ * only one who knows it. A value they can see is a value they can raise.
+ */
+export declare const DEFAULT_WORKER_CONCURRENCY = "20";
+export interface WorkerRuntimeAnswers {
+    /** Blank takes `DEFAULT_TEMPORAL_SERVER_ADDRESS`. */
+    temporalServerAddress: string;
+}
+export interface WorkerRuntimeSelection {
+    choice: WorkerRuntimeChoice;
+    envUpdates: Record<string, string>;
+    /** Shown once after the install, when there is something to show. */
+    dashboard?: {
+        user: string;
+        password: string;
+        port: string;
+    };
+}
+/**
+ * **The runtime each variant cannot work without is written here**, not left to
+ * whatever `.env.example` happens to ship. `REDIS_URL` is required under
+ * BullMQ and `TEMPORAL_SERVER_ADDRESS` under Temporal, and since #1224 the
+ * producers refuse to boot without the one their runtime names — so a wizard
+ * that picks the runtime and not its address configures an install that stops
+ * at startup. `create-ragen-app-knows-the-provider-seams.test.ts` holds this to
+ * the seam.
+ */
+export declare function resolveWorkerRuntimeSelection(choice: WorkerRuntimeChoice, answers?: WorkerRuntimeAnswers): WorkerRuntimeSelection;
+//# sourceMappingURL=worker-runtime.d.ts.map

package/dist/worker-runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-runtime.d.ts","sourceRoot":"","sources":["../src/worker-runtime.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AAEH,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAC;AAExD,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAIrE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,4BAA4B,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,+BAA+B,mBAAmB,CAAC;AAEhE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qBAAqB,IAAI,MAAM,CAE9C;AAED,eAAO,MAAM,kBAAkB,UAAU,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,0BAA0B,OAAO,CAAC;AAE/C,MAAM,WAAW,oBAAoB;IACnC,qDAAqD;IACrD,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,qEAAqE;IACrE,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,sBAAsB,CAgCxB"}

package/dist/worker-runtime.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_WORKER_CONCURRENCY = exports.DEFAULT_ADMIN_USER = exports.DEFAULT_TEMPORAL_SERVER_ADDRESS = exports.DEFAULT_REDIS_URL = exports.WORKER_RUNTIME_LABELS = void 0;
+exports.generateAdminPassword = generateAdminPassword;
+exports.resolveWorkerRuntimeSelection = resolveWorkerRuntimeSelection;
+const node_crypto_1 = require("node:crypto");
+exports.WORKER_RUNTIME_LABELS = {
+    bullmq: 'BullMQ — the default. Runs on the Redis this install already has.',
+    temporal: 'Temporal — durable execution, on a server you run yourself (ADR-44).',
+};
+/**
+ * The published Redis port, not the standard one.
+ *
+ * `docker-compose.yml` maps Redis to 56379 for the reason Postgres is on
+ * 55432: a native Redis on 6379 answers instead of the container, and nothing
+ * about the resulting failure names a port.
+ */
+exports.DEFAULT_REDIS_URL = 'redis://localhost:56379';
+/**
+ * What the address prompt starts from — the adapter's own fallback, and what
+ * `.env.example` ships.
+ *
+ * Offered as a prefilled answer rather than written silently: right on a
+ * laptop, wrong everywhere else, and a deployed worker pointing at its own
+ * container connects to nothing and processes nothing with no error to read.
+ * Temporal left the compose file with ADR-44, so this address now names a
+ * server the operator runs — which makes it exactly the value they should see
+ * before it is written.
+ */
+exports.DEFAULT_TEMPORAL_SERVER_ADDRESS = 'localhost:7233';
+/**
+ * A password the operator never has to invent, and that is never the same
+ * twice.
+ *
+ * The dashboard is off unless both credentials are set, so an installer that
+ * left them blank would ship the runtime with no way to see the queues — which
+ * is the thing the Temporal UI used to provide for free. Writing them is the
+ * point.
+ *
+ * **Generated rather than a fixed default.** A password shipped in this
+ * repository is the same password on every install, on a port that exposes
+ * every job's payload; the first person to read the source has it everywhere.
+ * Generating costs the operator nothing — they type nothing either way — and
+ * the value is printed once so it can be put in a password manager.
+ *
+ * Short enough to retype by hand, unlike `generateSecret()`'s 64 hex
+ * characters: this one is read off a terminal and typed into a browser prompt.
+ */
+function generateAdminPassword() {
+    return (0, node_crypto_1.randomBytes)(12).toString('base64url');
+}
+exports.DEFAULT_ADMIN_USER = 'admin';
+/**
+ * How many documents the worker ingests at once, written explicitly rather
+ * than left to the code's default.
+ *
+ * It matches `DEFAULT_CONCURRENCY` in `@ragenai/jobs-bullmq`, which D2 raised
+ * from 10 to 20 on the strength of the same measurement: twenty documents
+ * uploaded at once took a median of 24.9s each at 10 and 12.3s at 20, the
+ * difference sitting entirely before parsing began rather than in the work.
+ *
+ * **Written anyway, even though it now equals the default.** The number the
+ * operator has to revisit is this one — it is the first thing to lower when a
+ * provider starts rate-limiting — and a default they never see is not a knob
+ * they can find. If the two ever diverge, this line is the install's answer and
+ * the code's is the fallback for everyone else.
+ *
+ * **A constant, not a guess from the machine.** `os.cpus().length` is the
+ * tempting input and it measures the wrong thing: an ingest is almost entirely
+ * waiting — on storage, on the parser, on the embedding provider — so cores
+ * predict nothing about how many can be in flight. A number derived from
+ * hardware would look principled and mean less than this one.
+ *
+ * Written into `.env` rather than applied silently, because the ceiling that
+ * really binds is the model provider's rate limit, and the operator is the
+ * only one who knows it. A value they can see is a value they can raise.
+ */
+exports.DEFAULT_WORKER_CONCURRENCY = '20';
+/**
+ * **The runtime each variant cannot work without is written here**, not left to
+ * whatever `.env.example` happens to ship. `REDIS_URL` is required under
+ * BullMQ and `TEMPORAL_SERVER_ADDRESS` under Temporal, and since #1224 the
+ * producers refuse to boot without the one their runtime names — so a wizard
+ * that picks the runtime and not its address configures an install that stops
+ * at startup. `create-ragen-app-knows-the-provider-seams.test.ts` holds this to
+ * the seam.
+ */
+function resolveWorkerRuntimeSelection(choice, answers) {
+    // Only an explicit `temporal` leaves the default. The fallback used to point
+    // the other way, when Temporal was what the compose file ran; now an
+    // unexpected value — a future variant, a mistyped flag — lands on the runtime
+    // this install actually ships, rather than on one that is no longer there.
+    if (choice === 'temporal') {
+        return {
+            choice: 'temporal',
+            envUpdates: {
+                WORKER_RUNTIME: 'temporal',
+                TEMPORAL_SERVER_ADDRESS: answers?.temporalServerAddress.trim() ||
+                    exports.DEFAULT_TEMPORAL_SERVER_ADDRESS,
+            },
+        };
+    }
+    const password = generateAdminPassword();
+    const port = '8090';
+    return {
+        choice: 'bullmq',
+        envUpdates: {
+            WORKER_RUNTIME: 'bullmq',
+            REDIS_URL: exports.DEFAULT_REDIS_URL,
+            WORKER_CONCURRENCY: exports.DEFAULT_WORKER_CONCURRENCY,
+            WORKER_ADMIN_USER: exports.DEFAULT_ADMIN_USER,
+            WORKER_ADMIN_PASSWORD: password,
+            WORKER_ADMIN_PORT: port,
+        },
+        dashboard: { user: exports.DEFAULT_ADMIN_USER, password, port },
+    };
+}
+//# sourceMappingURL=worker-runtime.js.map

package/dist/worker-runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-runtime.js","sourceRoot":"","sources":["../src/worker-runtime.ts"],"names":[],"mappings":";;;AA2DA,sDAEC;AAoDD,sEAmCC;AApJD,6CAA0C;AAa7B,QAAA,qBAAqB,GAAwC;IACxE,MAAM,EAAE,mEAAmE;IAC3E,QAAQ,EACN,sEAAsE;CACzE,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,iBAAiB,GAAG,yBAAyB,CAAC;AAE3D;;;;;;;;;;GAUG;AACU,QAAA,+BAA+B,GAAG,gBAAgB,CAAC;AAEhE;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,qBAAqB;IACnC,OAAO,IAAA,yBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC/C,CAAC;AAEY,QAAA,kBAAkB,GAAG,OAAO,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,0BAA0B,GAAG,IAAI,CAAC;AAc/C;;;;;;;;GAQG;AACH,SAAgB,6BAA6B,CAC3C,MAA2B,EAC3B,OAA8B;IAE9B,6EAA6E;IAC7E,qEAAqE;IACrE,8EAA8E;IAC9E,2EAA2E;IAC3E,IAAI,MAAM,KAAK,UAAU,EAAE,CAAC;QAC1B,OAAO;YACL,MAAM,EAAE,UAAU;YAClB,UAAU,EAAE;gBACV,cAAc,EAAE,UAAU;gBAC1B,uBAAuB,EACrB,OAAO,EAAE,qBAAqB,CAAC,IAAI,EAAE;oBACrC,uCAA+B;aAClC;SACF,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,qBAAqB,EAAE,CAAC;IACzC,MAAM,IAAI,GAAG,MAAM,CAAC;IAEpB,OAAO;QACL,MAAM,EAAE,QAAQ;QAChB,UAAU,EAAE;YACV,cAAc,EAAE,QAAQ;YACxB,SAAS,EAAE,yBAAiB;YAC5B,kBAAkB,EAAE,kCAA0B;YAC9C,iBAAiB,EAAE,0BAAkB;YACrC,qBAAqB,EAAE,QAAQ;YAC/B,iBAAiB,EAAE,IAAI;SACxB;QACD,SAAS,EAAE,EAAE,IAAI,EAAE,0BAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE;KACxD,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "create-ragen-app",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "private": false,
   "description": "Scaffold a self-hosted Ragen AI installation with one command",
   "license": "Apache-2.0",
   "bin": {
-    "create-ragen-app": "./dist/index.js"
+    "create-ragen-app": "dist/index.js"
   },
   "main": "./dist/index.js",
   "files": [
@@ -16,7 +16,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/webamigos/RagenAI.git",
+    "url": "git+https://github.com/webamigos/RagenAI.git",
     "directory": "packages/create-ragen-app"
   },
   "scripts": {

package/dist/litellm-config.d.ts

@@ -1,17 +0,0 @@
-/**
- * Wires a plain OpenAI or Anthropic API key into `infra/litellm/config.yaml`
- * by inserting a new `model_list` entry as text, not by parsing and
- * re-serializing the YAML. The shipped config is heavily hand-commented
- * (rationale for every model, dated notes, links) and a round-trip through a
- * YAML library would collapse or reorder all of that — a text splice right
- * after the `model_list:` key preserves everything else byte-for-byte.
- */
-export interface LiteLLMModelEntry {
-    modelName: string;
-    /** LiteLLM provider-prefixed model id, e.g. "openai/gpt-4o-mini". */
-    model: string;
-    /** Name of the env var holding the API key, e.g. "OPENAI_API_KEY". */
-    apiKeyEnvVar: string;
-}
-export declare function addLiteLLMModel(configText: string, entry: LiteLLMModelEntry): string;
-//# sourceMappingURL=litellm-config.d.ts.map

package/dist/litellm-config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"litellm-config.d.ts","sourceRoot":"","sources":["../src/litellm-config.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,iBAAiB,GACvB,MAAM,CAoBR"}

package/dist/litellm-config.js

@@ -1,28 +0,0 @@
-"use strict";
-/**
- * Wires a plain OpenAI or Anthropic API key into `infra/litellm/config.yaml`
- * by inserting a new `model_list` entry as text, not by parsing and
- * re-serializing the YAML. The shipped config is heavily hand-commented
- * (rationale for every model, dated notes, links) and a round-trip through a
- * YAML library would collapse or reorder all of that — a text splice right
- * after the `model_list:` key preserves everything else byte-for-byte.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addLiteLLMModel = addLiteLLMModel;
-function addLiteLLMModel(configText, entry) {
-    const lines = configText.split('\n');
-    const anchorIndex = lines.findIndex((line) => line.trim() === 'model_list:');
-    if (anchorIndex === -1) {
-        throw new Error('infra/litellm/config.yaml has no `model_list:` key — cannot insert a model entry.');
-    }
-    const entryLines = [
-        `  - model_name: ${entry.modelName}`,
-        '    litellm_params:',
-        `      model: ${entry.model}`,
-        `      api_key: os.environ/${entry.apiKeyEnvVar}`,
-        '',
-    ];
-    lines.splice(anchorIndex + 1, 0, ...entryLines);
-    return lines.join('\n');
-}
-//# sourceMappingURL=litellm-config.js.map

package/dist/litellm-config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"litellm-config.js","sourceRoot":"","sources":["../src/litellm-config.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAUH,0CAuBC;AAvBD,SAAgB,eAAe,CAC7B,UAAkB,EAClB,KAAwB;IAExB,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,aAAa,CAAC,CAAC;IAE7E,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,mFAAmF,CACpF,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG;QACjB,mBAAmB,KAAK,CAAC,SAAS,EAAE;QACpC,qBAAqB;QACrB,gBAAgB,KAAK,CAAC,KAAK,EAAE;QAC7B,6BAA6B,KAAK,CAAC,YAAY,EAAE;QACjD,EAAE;KACH,CAAC;IAEF,KAAK,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,UAAU,CAAC,CAAC;IAChD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}