@stardeck-customer-apps/compose 0.1.0 → 0.3.0

package/dist/index.d.mts

@@ -1,3 +1,44 @@
+import { z } from 'zod';
+
+/** A data store connected to a project, as the composition rail consumes it. */
+type ConnectedStore = {
+    storeId: string;
+    slug: string;
+    bindingKey: string | null;
+    accessLevel: "read" | "write" | "admin";
+};
+
+/**
+ * Repo-relative inputs file: the platform's two database reads, as JSON.
+ *
+ * `@stardeck-customer-apps/compose` runs inside a customer app with no platform
+ * database, so the two facts the rail reads from one — the data stores connected
+ * to the app and each Module's install row — reach it through this file. The
+ * platform writes it (`writeComposeInputs`), compose reads it
+ * (`readComposeInputs`); the schema below is the single definition both sides
+ * parse against, so a drift on the writing side fails in lib rather than as an
+ * unexplained empty datastore binding inside a fork's build.
+ */
+declare const COMPOSE_INPUTS_PATH = "apps/web/stardeck.compose.json";
+declare const composeInputsSchema: z.ZodObject<{
+    connectedStores: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        storeId: z.ZodString;
+        slug: z.ZodString;
+        bindingKey: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+        accessLevel: z.ZodEnum<{
+            read: "read";
+            write: "write";
+            admin: "admin";
+        }>;
+    }, z.core.$strict>>>;
+    installs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        installedVersion: z.ZodString;
+        datastoreBindings: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+type ComposeInputsFile = z.infer<typeof composeInputsSchema>;
+type ComposeInputsInstall = ComposeInputsFile["installs"][string];
+
 interface ComposeOptions {
     /** Repo root of the customer app (the directory holding `apps/web`). */
     cwd: string;
@@ -16,11 +57,36 @@ interface ComposeResult {
     deletes: number;
     /** Directories removed by `prune` (excluded Modules + orphaned enhancements). */
     pruned: number;
+    /** Stub paths listed in the generated `src/app/.gitignore`. */
+    /** Null when a partial (`--enabled`) compose left the committed list untouched. */
+    gitignoreEntries: number | null;
 }
+
+interface ComposeInputs {
+    connectedStores: ConnectedStore[];
+    installs: Record<string, ComposeInputsInstall>;
+}
+/**
+ * The platform rail resolves data-store bindings and installed versions from
+ * its database. A standalone app has none, so compose reads the same two facts
+ * from a file the platform writes at deploy time (or a developer writes by
+ * hand). Absent file: no stores, every version `unreleased`. A malformed file
+ * is fatal — silently composing empty bindings is how an app loses its stores.
+ */
+declare function readComposeInputs(cwd: string): ComposeInputs;
+/** Compose needs the TypeScript API the emitters parse route entries with. */
+declare function assertSupportedTypescript(versionMajorMinor: string): void;
+/**
+ * gitignore patterns are fnmatch, so a Next.js path segment is not a literal:
+ * `[lang]` is a character class and `/[lang]/…/page.tsx` ignores nothing.
+ * Escapes every metacharacter, plus a leading `#`/`!` (the caller's `/` prefix
+ * rules those out today; a total helper keeps it that way).
+ */
+declare function escapeGitignore(pattern: string): string;
 /**
  * Regenerate the Module-rail artifacts (the five `src/*.gen.ts` files and every
  * route/endpoint stub under `src/app`) for the app rooted at `options.cwd`.
  */
 declare function compose(options: ComposeOptions): Promise<ComposeResult>;
 
-export { type ComposeOptions, type ComposeResult, compose };
+export { COMPOSE_INPUTS_PATH, type ComposeInputs, type ComposeOptions, type ComposeResult, assertSupportedTypescript, compose, escapeGitignore, readComposeInputs };

package/dist/index.d.ts

@@ -1,3 +1,44 @@
+import { z } from 'zod';
+
+/** A data store connected to a project, as the composition rail consumes it. */
+type ConnectedStore = {
+    storeId: string;
+    slug: string;
+    bindingKey: string | null;
+    accessLevel: "read" | "write" | "admin";
+};
+
+/**
+ * Repo-relative inputs file: the platform's two database reads, as JSON.
+ *
+ * `@stardeck-customer-apps/compose` runs inside a customer app with no platform
+ * database, so the two facts the rail reads from one — the data stores connected
+ * to the app and each Module's install row — reach it through this file. The
+ * platform writes it (`writeComposeInputs`), compose reads it
+ * (`readComposeInputs`); the schema below is the single definition both sides
+ * parse against, so a drift on the writing side fails in lib rather than as an
+ * unexplained empty datastore binding inside a fork's build.
+ */
+declare const COMPOSE_INPUTS_PATH = "apps/web/stardeck.compose.json";
+declare const composeInputsSchema: z.ZodObject<{
+    connectedStores: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        storeId: z.ZodString;
+        slug: z.ZodString;
+        bindingKey: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+        accessLevel: z.ZodEnum<{
+            read: "read";
+            write: "write";
+            admin: "admin";
+        }>;
+    }, z.core.$strict>>>;
+    installs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        installedVersion: z.ZodString;
+        datastoreBindings: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+type ComposeInputsFile = z.infer<typeof composeInputsSchema>;
+type ComposeInputsInstall = ComposeInputsFile["installs"][string];
+
 interface ComposeOptions {
     /** Repo root of the customer app (the directory holding `apps/web`). */
     cwd: string;
@@ -16,11 +57,36 @@ interface ComposeResult {
     deletes: number;
     /** Directories removed by `prune` (excluded Modules + orphaned enhancements). */
     pruned: number;
+    /** Stub paths listed in the generated `src/app/.gitignore`. */
+    /** Null when a partial (`--enabled`) compose left the committed list untouched. */
+    gitignoreEntries: number | null;
 }
+
+interface ComposeInputs {
+    connectedStores: ConnectedStore[];
+    installs: Record<string, ComposeInputsInstall>;
+}
+/**
+ * The platform rail resolves data-store bindings and installed versions from
+ * its database. A standalone app has none, so compose reads the same two facts
+ * from a file the platform writes at deploy time (or a developer writes by
+ * hand). Absent file: no stores, every version `unreleased`. A malformed file
+ * is fatal — silently composing empty bindings is how an app loses its stores.
+ */
+declare function readComposeInputs(cwd: string): ComposeInputs;
+/** Compose needs the TypeScript API the emitters parse route entries with. */
+declare function assertSupportedTypescript(versionMajorMinor: string): void;
+/**
+ * gitignore patterns are fnmatch, so a Next.js path segment is not a literal:
+ * `[lang]` is a character class and `/[lang]/…/page.tsx` ignores nothing.
+ * Escapes every metacharacter, plus a leading `#`/`!` (the caller's `/` prefix
+ * rules those out today; a total helper keeps it that way).
+ */
+declare function escapeGitignore(pattern: string): string;
 /**
  * Regenerate the Module-rail artifacts (the five `src/*.gen.ts` files and every
  * route/endpoint stub under `src/app`) for the app rooted at `options.cwd`.
  */
 declare function compose(options: ComposeOptions): Promise<ComposeResult>;
 
-export { type ComposeOptions, type ComposeResult, compose };
+export { COMPOSE_INPUTS_PATH, type ComposeInputs, type ComposeOptions, type ComposeResult, assertSupportedTypescript, compose, escapeGitignore, readComposeInputs };