create-lacspace-app 2.1.1 → 2.2.1

package/dist/lib.d.cts

@@ -0,0 +1,68 @@
+interface TemplateDef {
+    key: string;
+    label: string;
+    description: string;
+    /** Tailwind gradient accent (from → to). */
+    accent: [string, string];
+    siteName: string;
+    siteDescription: string;
+}
+/** Options accepted by the programmatic API (see `./lib`). */
+interface GenerateOptions {
+    /** Project name — becomes the folder name and the default site name slug. Default `"my-app"`. */
+    name?: string;
+    /** Template key: one of {@link TEMPLATES} (`personal`, `business`, `ecommerce`, `saas`, `blog`, `docs`, `dashboard`, `restaurant`, `marketplace`). Default `"personal"`. */
+    template?: string;
+    /** Accent theme: a preset name, a `#hex`, or a `from,to` pair. Falls back to the template's default accent. */
+    theme?: string;
+}
+
+/** A project file map: relative path → file contents. */
+type ProjectFiles = Record<string, string>;
+/** The list of built-in templates, with their metadata. */
+declare const templates: readonly TemplateDef[];
+/** Every template key you can pass as `options.template`. */
+declare const templateKeys: readonly string[];
+/** Return the built-in templates (metadata: key, label, description, accent, defaults). */
+declare function listTemplates(): TemplateDef[];
+/** Look up one template's metadata by key, or `undefined`. */
+declare function getTemplate(key: string): TemplateDef | undefined;
+/** The names of every prebuilt section available (the CLI's `add <section>`). */
+declare function listSections(): string[];
+/**
+ * Return the source of one prebuilt section component (the file the CLI's
+ * `add <name>` would drop into `components/sections/`), or `undefined`.
+ */
+declare function getSection(name: string): string | undefined;
+/**
+ * Generate a full project as an in-memory file map (relative path → contents).
+ *
+ * **Pure** — performs no disk or network I/O, so it runs the same in Node, an
+ * edge runtime or a browser bundle. Use it for previews, snapshot tests, a
+ * server-side zip download, or to post-process files before writing them.
+ */
+declare function generateProject(options?: GenerateOptions): ProjectFiles;
+/** Options for {@link scaffold} — {@link GenerateOptions} plus where to write. */
+interface ScaffoldOptions extends GenerateOptions {
+    /** Base directory the project folder is created under. Default `process.cwd()`. */
+    cwd?: string;
+    /** Write directly into this directory instead of `<cwd>/<name>`. */
+    dir?: string;
+}
+/** What {@link scaffold} returns. */
+interface ScaffoldResult {
+    /** Absolute path the project was written to. */
+    dir: string;
+    /** Relative paths of every file written. */
+    files: string[];
+}
+/**
+ * Generate a project and **write it to disk** (Node only).
+ *
+ * Writes to `options.dir` when given, otherwise to `<cwd>/<name>`. Creates
+ * parent directories as needed. Does not install dependencies or init git —
+ * compose those yourself, or use the CLI for the full interactive flow.
+ */
+declare function scaffold(options?: ScaffoldOptions): Promise<ScaffoldResult>;
+
+export { type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getSection, getTemplate, listSections, listTemplates, scaffold, templateKeys, templates };

package/dist/lib.d.ts

@@ -0,0 +1,68 @@
+interface TemplateDef {
+    key: string;
+    label: string;
+    description: string;
+    /** Tailwind gradient accent (from → to). */
+    accent: [string, string];
+    siteName: string;
+    siteDescription: string;
+}
+/** Options accepted by the programmatic API (see `./lib`). */
+interface GenerateOptions {
+    /** Project name — becomes the folder name and the default site name slug. Default `"my-app"`. */
+    name?: string;
+    /** Template key: one of {@link TEMPLATES} (`personal`, `business`, `ecommerce`, `saas`, `blog`, `docs`, `dashboard`, `restaurant`, `marketplace`). Default `"personal"`. */
+    template?: string;
+    /** Accent theme: a preset name, a `#hex`, or a `from,to` pair. Falls back to the template's default accent. */
+    theme?: string;
+}
+
+/** A project file map: relative path → file contents. */
+type ProjectFiles = Record<string, string>;
+/** The list of built-in templates, with their metadata. */
+declare const templates: readonly TemplateDef[];
+/** Every template key you can pass as `options.template`. */
+declare const templateKeys: readonly string[];
+/** Return the built-in templates (metadata: key, label, description, accent, defaults). */
+declare function listTemplates(): TemplateDef[];
+/** Look up one template's metadata by key, or `undefined`. */
+declare function getTemplate(key: string): TemplateDef | undefined;
+/** The names of every prebuilt section available (the CLI's `add <section>`). */
+declare function listSections(): string[];
+/**
+ * Return the source of one prebuilt section component (the file the CLI's
+ * `add <name>` would drop into `components/sections/`), or `undefined`.
+ */
+declare function getSection(name: string): string | undefined;
+/**
+ * Generate a full project as an in-memory file map (relative path → contents).
+ *
+ * **Pure** — performs no disk or network I/O, so it runs the same in Node, an
+ * edge runtime or a browser bundle. Use it for previews, snapshot tests, a
+ * server-side zip download, or to post-process files before writing them.
+ */
+declare function generateProject(options?: GenerateOptions): ProjectFiles;
+/** Options for {@link scaffold} — {@link GenerateOptions} plus where to write. */
+interface ScaffoldOptions extends GenerateOptions {
+    /** Base directory the project folder is created under. Default `process.cwd()`. */
+    cwd?: string;
+    /** Write directly into this directory instead of `<cwd>/<name>`. */
+    dir?: string;
+}
+/** What {@link scaffold} returns. */
+interface ScaffoldResult {
+    /** Absolute path the project was written to. */
+    dir: string;
+    /** Relative paths of every file written. */
+    files: string[];
+}
+/**
+ * Generate a project and **write it to disk** (Node only).
+ *
+ * Writes to `options.dir` when given, otherwise to `<cwd>/<name>`. Creates
+ * parent directories as needed. Does not install dependencies or init git —
+ * compose those yourself, or use the CLI for the full interactive flow.
+ */
+declare function scaffold(options?: ScaffoldOptions): Promise<ScaffoldResult>;
+
+export { type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getSection, getTemplate, listSections, listTemplates, scaffold, templateKeys, templates };