@django-stack/cli 0.5.0 → 0.7.0

package/dist/index.d.ts

@@ -18,6 +18,8 @@ interface ProductionOptions {
   domain: string;
   /** The SMTP server for outgoing mail. */
   emailUrl?: string;
+  /** Where uploads go: `s3` asks for the S3 settings (the `media` stack option). */
+  media?: string;
 }
 interface ProductionEnv {
   text: string;
@@ -37,6 +39,7 @@ export declare const STACK_OPTIONS: readonly [{
   readonly flag: "--frontend";
   readonly message: "Frontend";
   readonly description: "The frontend framework";
+  readonly bits: 4;
   readonly values: readonly [{
     readonly value: "astro";
     readonly label: "Astro";
@@ -73,6 +76,7 @@ export declare const STACK_OPTIONS: readonly [{
   readonly flag: "--postgres";
   readonly message: "Postgres version";
   readonly description: "The bundled Postgres version";
+  readonly bits: 2;
   readonly values: readonly [{
     readonly value: "stable";
     readonly label: "Stable";
@@ -89,11 +93,12 @@ export declare const STACK_OPTIONS: readonly [{
   readonly flag: "--analytics";
   readonly message: "Analytics";
   readonly description: "Page analytics";
+  readonly bits: 2;
   readonly values: readonly [{
     readonly value: "umami";
     readonly label: "Umami";
     readonly hint: "built in, private, no cookies";
-    readonly generated: false;
+    readonly generated: true;
   }, {
     readonly value: "off";
     readonly label: "Off";
@@ -104,41 +109,51 @@ export declare const STACK_OPTIONS: readonly [{
   readonly flag: "--tasks";
   readonly message: "Background tasks";
   readonly description: "The task queue";
+  readonly bits: 2;
   readonly values: readonly [{
     readonly value: "huey";
     readonly label: "Huey";
-    readonly hint: "a worker container with Valkey";
+    readonly hint: "a worker container, the queue where the cache is";
     readonly generated: true;
   }, {
     readonly value: "off";
     readonly label: "Off";
-    readonly generated: false;
+    readonly hint: "tasks run in the request, no daily backups";
+    readonly generated: true;
+  }, {
+    readonly value: "huey-valkey";
+    readonly label: "Huey on Valkey";
+    readonly hint: "the queue in Valkey";
+    readonly generated: true;
   }];
 }, {
   readonly key: "cache";
   readonly flag: "--cache";
   readonly message: "Cache";
   readonly description: "The cache backend";
+  readonly bits: 3;
   readonly values: readonly [{
     readonly value: "database";
     readonly label: "Database";
     readonly hint: "a Postgres table, nothing extra to run";
-    readonly generated: false;
+    readonly generated: true;
   }, {
     readonly value: "valkey";
     readonly label: "Valkey";
     readonly hint: "in memory, Redis-compatible";
-    readonly generated: false;
+    readonly generated: true;
   }, {
     readonly value: "off";
     readonly label: "Off";
-    readonly generated: false;
+    readonly hint: "a cache per process";
+    readonly generated: true;
   }];
 }, {
   readonly key: "notifications";
   readonly flag: "--notifications";
   readonly message: "Notifications";
   readonly description: "Notifications in the admin and by email";
+  readonly bits: 2;
   readonly values: readonly [{
     readonly value: "on";
     readonly label: "On";
@@ -154,6 +169,7 @@ export declare const STACK_OPTIONS: readonly [{
   readonly flag: "--captcha";
   readonly message: "Captcha";
   readonly description: "The built-in captcha for forms";
+  readonly bits: 2;
   readonly values: readonly [{
     readonly value: "on";
     readonly label: "On";
@@ -169,6 +185,7 @@ export declare const STACK_OPTIONS: readonly [{
   readonly flag: "--storage";
   readonly message: "Uploads in development";
   readonly description: "Where uploads go in development";
+  readonly bits: 2;
   readonly values: readonly [{
     readonly value: "local";
     readonly label: "Local files";
@@ -185,6 +202,7 @@ export declare const STACK_OPTIONS: readonly [{
   readonly flag: "--package-manager";
   readonly message: "Package manager";
   readonly description: "The frontend's package manager";
+  readonly bits: 3;
   readonly values: readonly [{
     readonly value: "pnpm";
     readonly label: "pnpm";
@@ -198,12 +216,29 @@ export declare const STACK_OPTIONS: readonly [{
     readonly label: "Bun";
     readonly generated: false;
   }];
+}, {
+  readonly key: "media";
+  readonly flag: "--media";
+  readonly message: "Uploads in production";
+  readonly description: "Where uploads go in production";
+  readonly bits: 2;
+  readonly values: readonly [{
+    readonly value: "server";
+    readonly label: "On the server";
+    readonly hint: "a Docker volume, backed up with the database";
+    readonly generated: true;
+  }, {
+    readonly value: "s3";
+    readonly label: "S3";
+    readonly hint: "any S3-compatible service; credentials later";
+    readonly generated: true;
+  }];
 }];
 type Options = (typeof STACK_OPTIONS)[number];
 type StackKey = Options["key"];
 type Stack = { [O in Options as O["key"]]: O["values"][number]["value"]; };
 export declare const DEFAULT_STACK: Stack;
-/** A preset code for a stack: the version, then one character per option, trailing defaults left out. */
+/** A preset code for a stack: always six characters, such as `b8Kq2x`. */
 export declare function encodePreset(stack: Stack): string;
 /** The stack of a preset code. Throws with a one-line reason for a bad code. */
 export declare function decodePreset(code: string): Stack;
@@ -235,10 +270,18 @@ interface ScaffoldOptions {
   databaseUrl?: string;
   /** Store uploads in the local S3 service in development, like S3 in production. */
   localS3?: boolean;
+  /** Page analytics with the bundled Umami (the `analytics` profile). */
+  analytics?: boolean;
+  /** The cache backend; the database by default. */
+  cache?: Stack["cache"];
+  /** The task queue; Huey where the cache is by default. */
+  tasks?: Stack["tasks"];
   /** A DjangoStack monorepo to take the packages from instead of the registries (for development). */
   link?: string;
   /** The time zone of the backend, such as Europe/Amsterdam. UTC by default. */
   timeZone?: string;
+  /** The development ports by `.env` variable, such as SITE_PORT; the usual ones when not set. */
+  ports?: Record<string, number>;
   /** The preset code of the stack, saved in package.json for `config`. */
   preset?: string;
   /** Where the templates are; the ones in the package by default. */
@@ -250,6 +293,10 @@ interface ScaffoldResult {
   adminPassword: string;
   files: number;
 }
+/** The `.env` values of a cache and a task queue: CACHE_URL, TASKS_URL and TASK_WORKERS. */
+export declare function cacheEnv(stack: Pick<Stack, "cache" | "tasks">): Record<string, string>;
+/** Whether `.env` values use the Valkey service (the `valkey` profile). */
+export declare function usesValkey(env: Record<string, string | undefined>): boolean;
 /** A valid project name from a directory name: `My Site` becomes `my-site`. */
 export declare function toProjectName(value: string): string;
 export declare function validateProjectName(value: string): string | undefined;

package/dist/index.js

@@ -1 +1 @@
-export { f as DEFAULT_STACK, t as FRONTENDS, p as NAMED_PRESETS, m as STACK_OPTIONS, d as VERSION, g as decodePreset, _ as encodePreset, C as generateProjectSecrets, w as generateSecret, i as normalizeDatabaseUrl, D as parseEnv, v as pendingChoices, x as productionEnv, y as resolvePreset, T as runDoctor, o as scaffold, O as setEnvValues, c as toProjectName, S as validateDomain, l as validateProjectName } from "./scaffold-DbgGYEsc.js";
+export { y as DEFAULT_STACK, i as FRONTENDS, b as NAMED_PRESETS, S as STACK_OPTIONS, v as VERSION, o as cacheEnv, w as decodePreset, T as encodePreset, k as generateProjectSecrets, A as generateSecret, l as normalizeDatabaseUrl, V as parseEnv, E as pendingChoices, n as productionEnv, D as resolvePreset, I as runDoctor, d as scaffold, U as setEnvValues, p as toProjectName, h as usesValkey, r as validateDomain, g as validateProjectName } from "./production-DBpWWx6i.js";