@driggsby/deploy 0.2.2 → 0.2.4

package/dist/client.d.ts

@@ -45,7 +45,7 @@ export interface CreatedApp {
     url: string;
 }
 export declare function createApp(api: DeployApi, baseName: string, appName?: string): Promise<CreatedApp>;
-export declare function createVersion(api: DeployApi, slug: string, files: ManifestFile[], appName?: string): Promise<CreatedVersion>;
+export declare function createVersion(api: DeployApi, slug: string, files: ManifestFile[], appName?: string, background?: string): Promise<CreatedVersion>;
 export declare function uploadBlob(api: DeployApi, sha256: string, bytes: Uint8Array, signal?: AbortSignal): Promise<void>;
 export declare function finalizeVersion(api: DeployApi, versionId: string, live: boolean): Promise<FinalizedVersion | BlobsMissing>;
 export declare function listVersions(api: DeployApi, slug: string): Promise<VersionList>;

package/dist/client.js

@@ -43,13 +43,16 @@ export async function createApp(api, baseName, appName) {
 // app_name here is NOT a leftover of the old create-by-deploy flow: the
 // server intentionally keeps rename-on-redeploy, applying a sent app_name
 // to the existing app once the deploy is accepted.
-export async function createVersion(api, slug, files, appName) {
+export async function createVersion(api, slug, files, appName, background) {
     const body = {
         files: files.map((file) => ({ path: file.path, sha256: file.sha256, byte_size: file.byteSize })),
     };
     if (appName !== undefined) {
         body.app_name = appName;
     }
+    if (background !== undefined) {
+        body.background = background;
+    }
     const parsed = await requestJson(api, "POST", `/deploy/apps/${encodeURIComponent(slug)}/versions`, {
         json: body,
         expectedStatus: 201,

package/dist/deploy.d.ts

@@ -4,6 +4,7 @@ import { type CollectedDeploy } from "./manifest.ts";
 export interface DeployOptions {
     live: boolean;
     appName?: string;
+    background?: string;
 }
 export interface DeployOutcome {
     appSlug: string;

package/dist/deploy.js

@@ -33,7 +33,7 @@ export async function deployProjectFiles(api, projectDirectory, slug, collected,
     return { outcome, createdApp: created };
 }
 export async function deployCollectedFiles(api, slug, collected, options) {
-    const created = await createVersion(api, slug, collected.files, options.appName);
+    const created = await createVersion(api, slug, collected.files, options.appName, options.background);
     const fileBySha = new Map();
     for (const file of collected.files) {
         if (!fileBySha.has(file.sha256)) {

package/dist/entrypoint.js

@@ -55,7 +55,7 @@ export async function runDeployEntrypoint(io) {
         const baseUrl = resolveBaseUrl(io.env);
         const config = await readProjectConfig(io.cwd);
         const collected = await collectDeployFiles(config.serveDirectory);
-        const { outcome, createdApp } = await deployProjectFiles({ baseUrl, token }, io.cwd, config.slug, collected, { live: true });
+        const { outcome, createdApp } = await deployProjectFiles({ baseUrl, token }, io.cwd, config.slug, collected, { live: true, ...(config.background !== null ? { background: config.background } : {}) });
         if (createdApp !== null) {
             // The assigned slug is server text, so it prints quoted and bounded
             // like every other string this bin did not author; the whole sentence

package/dist/project-config.d.ts

@@ -3,6 +3,7 @@ export interface ProjectConfig {
     serveDirectory: string;
     serve: string;
     devCommand: string | null;
+    background: string | null;
 }
 export declare function readProjectConfig(projectDirectory: string): Promise<ProjectConfig>;
 export declare function writeAssignedSlug(projectDirectory: string, assignedSlug: string): Promise<void>;

package/dist/project-config.js

@@ -7,6 +7,9 @@ import { join, relative, resolve, isAbsolute } from "node:path";
 import { DeployError } from "./errors.js";
 import { slugProblem } from "./limits.js";
 import { quotedForTerminal } from "./terminal-text.js";
+// Exactly a bare lowercase hex color — the same shape the deploy API
+// enforces, checked locally so a typo fails fast with the fix.
+const BACKGROUND_PATTERN = /^#[0-9a-f]{6}$/;
 const MISSING_CONFIG_MESSAGE = "No driggsby.json found in this directory. Create one next to the files you\n" +
     "want to deploy:\n\n" +
     '  { "slug": "your-app-name", "serve": "." }\n\n' +
@@ -53,6 +56,20 @@ export async function readProjectConfig(projectDirectory) {
             'driggsby.json, like "." or "dist".');
     }
     const serveDirectory = await resolveServeDirectory(projectDirectory, serve);
+    // A declared background must be exactly the shape the server accepts;
+    // anything else fails here, locally, instead of as a refused deploy.
+    // Friendly slop (case, whitespace) normalizes rather than failing.
+    const rawBackground = config.background;
+    let background = null;
+    if (rawBackground !== undefined && rawBackground !== null) {
+        const normalized = typeof rawBackground === "string" ? rawBackground.trim().toLowerCase() : "";
+        if (!BACKGROUND_PATTERN.test(normalized)) {
+            throw new DeployError('The "background" field in driggsby.json must be a plain lowercase hex\n' +
+                'color like "#0b0c0f" — your app\'s own page background, so Driggsby can\n' +
+                "paint it while the app loads. Remove the field if you don't want one.");
+        }
+        background = normalized;
+    }
     // dev_command is attacker-controlled text from a cloned or generated
     // driggsby.json. Nothing executes it today; any future consumer must spawn
     // it without a shell and never let it reach one.
@@ -62,6 +79,7 @@ export async function readProjectConfig(projectDirectory) {
         serveDirectory,
         serve,
         devCommand: typeof devCommand === "string" && devCommand !== "" ? devCommand : null,
+        background,
     };
 }
 // Persists the server-assigned slug into driggsby.json, keeping every other

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driggsby/deploy",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Deploy static Driggsby apps: the deploy protocol client used by the driggsby CLI.",
   "license": "Apache-2.0",
   "repository": {