create-lacspace-app 2.5.0 → 2.7.0

package/dist/lib.d.cts

@@ -34,6 +34,39 @@ interface FeatureDef {
     nextSteps: string[];
     /** Optional "learn more" URL for `LEARN.md`. */
     learn?: string;
+    /**
+     * When true, this add-on needs the full-stack backend (a database + a real API).
+     * Requesting it in `static` mode automatically upgrades the project to `dynamic`.
+     */
+    requiresBackend?: boolean;
+    /**
+     * Optional backend (Express) contribution — applied **only in dynamic mode**.
+     * Lets an add-on drop backend files, register routes, add backend deps and
+     * document backend env vars. See {@link FeatureBackend}.
+     */
+    backend?: (ctx: Ctx) => FeatureBackend;
+}
+/** An add-on's contribution to the `backend/` workspace (dynamic mode only). */
+interface FeatureBackend {
+    /** Files under `backend/` — e.g. `"src/routes/payments.ts"`, `"src/models/payment.ts"`. */
+    files?: Record<string, string>;
+    /** Extra backend deps, merged into `backend/package.json`. */
+    deps?: Record<string, string>;
+    /** Express route groups this add-on mounts (assembled in `src/routes/index.ts`). */
+    routes?: FeatureRoute[];
+    /** Extra root `.env.example` entries — `NAME: "explanatory comment"`. */
+    env?: Record<string, string>;
+}
+/** One Express route group registered by a backend add-on. */
+interface FeatureRoute {
+    /** Mount path, e.g. `"/payments"`. */
+    path: string;
+    /** The exact import line, e.g. `import paymentRoutes from "./payments.js";`. */
+    importLine: string;
+    /** The router identifier used in `app.use`, e.g. `"paymentRoutes"`. */
+    handler: string;
+    /** Protect the group with the shared `requireAuth` middleware. */
+    auth?: boolean;
 }
 interface Ctx {
     name: string;
@@ -129,4 +162,4 @@ interface ScaffoldResult {
  */
 declare function scaffold(options?: ScaffoldOptions): Promise<ScaffoldResult>;
 
-export { type FeatureDef, type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getFeature, getSection, getTemplate, listFeatures, listSections, listTemplates, scaffold, templateKeys, templates };
+export { type FeatureBackend, type FeatureDef, type FeatureRoute, type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getFeature, getSection, getTemplate, listFeatures, listSections, listTemplates, scaffold, templateKeys, templates };

package/dist/lib.d.ts

@@ -34,6 +34,39 @@ interface FeatureDef {
     nextSteps: string[];
     /** Optional "learn more" URL for `LEARN.md`. */
     learn?: string;
+    /**
+     * When true, this add-on needs the full-stack backend (a database + a real API).
+     * Requesting it in `static` mode automatically upgrades the project to `dynamic`.
+     */
+    requiresBackend?: boolean;
+    /**
+     * Optional backend (Express) contribution — applied **only in dynamic mode**.
+     * Lets an add-on drop backend files, register routes, add backend deps and
+     * document backend env vars. See {@link FeatureBackend}.
+     */
+    backend?: (ctx: Ctx) => FeatureBackend;
+}
+/** An add-on's contribution to the `backend/` workspace (dynamic mode only). */
+interface FeatureBackend {
+    /** Files under `backend/` — e.g. `"src/routes/payments.ts"`, `"src/models/payment.ts"`. */
+    files?: Record<string, string>;
+    /** Extra backend deps, merged into `backend/package.json`. */
+    deps?: Record<string, string>;
+    /** Express route groups this add-on mounts (assembled in `src/routes/index.ts`). */
+    routes?: FeatureRoute[];
+    /** Extra root `.env.example` entries — `NAME: "explanatory comment"`. */
+    env?: Record<string, string>;
+}
+/** One Express route group registered by a backend add-on. */
+interface FeatureRoute {
+    /** Mount path, e.g. `"/payments"`. */
+    path: string;
+    /** The exact import line, e.g. `import paymentRoutes from "./payments.js";`. */
+    importLine: string;
+    /** The router identifier used in `app.use`, e.g. `"paymentRoutes"`. */
+    handler: string;
+    /** Protect the group with the shared `requireAuth` middleware. */
+    auth?: boolean;
 }
 interface Ctx {
     name: string;
@@ -129,4 +162,4 @@ interface ScaffoldResult {
  */
 declare function scaffold(options?: ScaffoldOptions): Promise<ScaffoldResult>;
 
-export { type FeatureDef, type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getFeature, getSection, getTemplate, listFeatures, listSections, listTemplates, scaffold, templateKeys, templates };
+export { type FeatureBackend, type FeatureDef, type FeatureRoute, type GenerateOptions, type ProjectFiles, type ScaffoldOptions, type ScaffoldResult, type TemplateDef, generateProject, getFeature, getSection, getTemplate, listFeatures, listSections, listTemplates, scaffold, templateKeys, templates };