@dforge-core/dforge-cli 0.1.0-rc.4 → 0.1.0-rc.6

package/README.md

@@ -91,6 +91,42 @@ dforge-cli module install --path . --code <tenant>   # full validation + install
 
 The first install runs the full server-side validator (manifest, FK targets, package-filter SQL, migration safety) — fix anything it flags, then re-run.
 
+### Programmatic use (subpath export)
+
+The pure-TS builders behind `init module` are also exposed as a library entry, so downstream packages can compose module file maps without shelling to the CLI. Used by [`@dforge-core/dforge-mcp`](https://www.npmjs.com/package/@dforge-core/dforge-mcp) to drive AI-authored modules.
+
+```ts
+import {
+	buildManifest,
+	buildEntity,
+	buildDataViews,
+	buildFolders,
+	buildMenus,
+	buildRoles,
+} from "@dforge-core/dforge-cli/templates";
+import type { ScaffoldOpts, EntitySpec } from "@dforge-core/dforge-cli/templates";
+import { randomUUID } from "node:crypto";
+
+const opts: ScaffoldOpts = {
+	path: "",
+	code: "smoke",
+	displayName: "Smoke",
+	description: "",
+	author: "",
+	license: "MIT",
+	version: "0.1.0",
+	dbSchemaVersion: "0.0.1",
+	dependencies: ["admin", "metadata"],
+	preset: "minimal",
+	entities: [{ name: "thing", label: "Thing", traits: "identity+audit" }],
+};
+
+const manifest = buildManifest(opts, randomUUID());
+// → plain JS object, ready for JSON.stringify
+```
+
+All builders are pure functions returning plain JS objects (no I/O). The subpath ships dual CJS + ESM + `.d.ts` types.
+
 ## Auth
 
 The remote `module install --url` and `marketplace publish` flows need a JWT

package/dist/lib.d.mts

@@ -0,0 +1,66 @@
+type Preset = "minimal" | "minimal-plus" | "full";
+type Traits = "identity" | "identity+audit";
+interface EntitySpec {
+    name: string;
+    label: string;
+    traits: Traits;
+}
+interface ScaffoldOpts {
+    path: string;
+    code: string;
+    displayName: string;
+    description: string;
+    author: string;
+    license: string;
+    version: string;
+    dbSchemaVersion: string;
+    dependencies: string[];
+    preset: Preset;
+    entities: EntitySpec[];
+}
+interface Manifest {
+    packageFormat: number;
+    moduleId: string;
+    code: string;
+    version: string;
+    dbSchemaVersion: string;
+    displayName: string;
+    description?: string;
+    author?: {
+        name: string;
+    };
+    license?: string;
+    dependencies?: Record<string, string>;
+    entities: Record<string, string>;
+    created?: string;
+    updated?: string;
+}
+interface Entity {
+    description: string;
+    dbObject: string;
+    toString: string;
+    traits: string[];
+    fields: Record<string, unknown>;
+}
+interface DataView {
+    viewType: string;
+    label: string;
+    dataSources: Array<{
+        entityCode: string;
+        columns: string[];
+    }>;
+}
+
+declare function buildManifest(opts: ScaffoldOpts, moduleId: string): Manifest;
+declare function buildEntity(entity: EntitySpec): Entity;
+declare function buildDataViews(entities: EntitySpec[]): Record<string, DataView>;
+declare function buildFolders(opts: ScaffoldOpts): Record<string, unknown>;
+declare function buildMenus(opts: ScaffoldOpts): Record<string, unknown>;
+declare function buildRoles(opts: ScaffoldOpts): Record<string, unknown>;
+declare function buildActions(): Record<string, unknown>;
+declare function buildSettings(): Record<string, unknown>;
+declare function buildTranslations(opts: ScaffoldOpts): Record<string, string>;
+declare function buildSeedData(): unknown[];
+declare function buildGitignore(): string;
+
+export { type DataView, type Entity, type EntitySpec, type Manifest, type Preset, type ScaffoldOpts, type Traits, buildActions, buildDataViews, buildEntity, buildFolders, buildGitignore, buildManifest, buildMenus, buildRoles, buildSeedData, buildSettings, buildTranslations };

package/dist/lib.d.ts

@@ -0,0 +1,66 @@
+type Preset = "minimal" | "minimal-plus" | "full";
+type Traits = "identity" | "identity+audit";
+interface EntitySpec {
+    name: string;
+    label: string;
+    traits: Traits;
+}
+interface ScaffoldOpts {
+    path: string;
+    code: string;
+    displayName: string;
+    description: string;
+    author: string;
+    license: string;
+    version: string;
+    dbSchemaVersion: string;
+    dependencies: string[];
+    preset: Preset;
+    entities: EntitySpec[];
+}
+interface Manifest {
+    packageFormat: number;
+    moduleId: string;
+    code: string;
+    version: string;
+    dbSchemaVersion: string;
+    displayName: string;
+    description?: string;
+    author?: {
+        name: string;
+    };
+    license?: string;
+    dependencies?: Record<string, string>;
+    entities: Record<string, string>;
+    created?: string;
+    updated?: string;
+}
+interface Entity {
+    description: string;
+    dbObject: string;
+    toString: string;
+    traits: string[];
+    fields: Record<string, unknown>;
+}
+interface DataView {
+    viewType: string;
+    label: string;
+    dataSources: Array<{
+        entityCode: string;
+        columns: string[];
+    }>;
+}
+
+declare function buildManifest(opts: ScaffoldOpts, moduleId: string): Manifest;
+declare function buildEntity(entity: EntitySpec): Entity;
+declare function buildDataViews(entities: EntitySpec[]): Record<string, DataView>;
+declare function buildFolders(opts: ScaffoldOpts): Record<string, unknown>;
+declare function buildMenus(opts: ScaffoldOpts): Record<string, unknown>;
+declare function buildRoles(opts: ScaffoldOpts): Record<string, unknown>;
+declare function buildActions(): Record<string, unknown>;
+declare function buildSettings(): Record<string, unknown>;
+declare function buildTranslations(opts: ScaffoldOpts): Record<string, string>;
+declare function buildSeedData(): unknown[];
+declare function buildGitignore(): string;
+
+export { type DataView, type Entity, type EntitySpec, type Manifest, type Preset, type ScaffoldOpts, type Traits, buildActions, buildDataViews, buildEntity, buildFolders, buildGitignore, buildManifest, buildMenus, buildRoles, buildSeedData, buildSettings, buildTranslations };

package/dist/lib.js

@@ -0,0 +1,178 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/lib.ts
+var lib_exports = {};
+__export(lib_exports, {
+  buildActions: () => buildActions,
+  buildDataViews: () => buildDataViews,
+  buildEntity: () => buildEntity,
+  buildFolders: () => buildFolders,
+  buildGitignore: () => buildGitignore,
+  buildManifest: () => buildManifest,
+  buildMenus: () => buildMenus,
+  buildRoles: () => buildRoles,
+  buildSeedData: () => buildSeedData,
+  buildSettings: () => buildSettings,
+  buildTranslations: () => buildTranslations
+});
+module.exports = __toCommonJS(lib_exports);
+
+// src/init/templates.ts
+function buildManifest(opts, moduleId) {
+  const today = (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
+  const manifest = {
+    packageFormat: 1,
+    moduleId,
+    code: opts.code,
+    version: opts.version,
+    dbSchemaVersion: opts.dbSchemaVersion,
+    displayName: opts.displayName,
+    entities: Object.fromEntries(
+      opts.entities.map((e) => [e.name, `./entities/${e.name}.json`])
+    ),
+    created: today,
+    updated: today
+  };
+  if (opts.description) manifest.description = opts.description;
+  if (opts.author) manifest.author = { name: opts.author };
+  if (opts.license) manifest.license = opts.license;
+  if (opts.dependencies.length > 0) {
+    manifest.dependencies = Object.fromEntries(
+      opts.dependencies.map((d) => [d, ">=0.0.1"])
+    );
+  }
+  return manifest;
+}
+function buildEntity(entity) {
+  const traits = entity.traits === "identity+audit" ? ["identity", "audit"] : ["identity"];
+  return {
+    description: entity.label,
+    dbObject: entity.name,
+    toString: "{id}",
+    traits,
+    fields: {}
+  };
+}
+function buildDataViews(entities) {
+  const views = {};
+  for (const e of entities) {
+    views[e.name] = {
+      viewType: "grid",
+      label: e.label,
+      dataSources: [
+        {
+          entityCode: e.name,
+          columns: []
+        }
+      ]
+    };
+  }
+  return views;
+}
+function buildFolders(opts) {
+  return {
+    [opts.code]: {
+      label: opts.displayName,
+      description: opts.description || opts.displayName,
+      icon: "bi-folder",
+      color: "#2196F3",
+      entities: Object.fromEntries(
+        opts.entities.map((e) => [
+          e.name,
+          { viewName: e.name, quickAdd: true }
+        ])
+      )
+    }
+  };
+}
+function buildMenus(opts) {
+  return {
+    [opts.code]: {
+      label: opts.displayName,
+      icon: "bi-folder",
+      children: Object.fromEntries(
+        opts.entities.map((e) => [
+          e.name,
+          {
+            itemType: "V",
+            label: e.label,
+            dataViewCode: e.name
+          }
+        ])
+      )
+    }
+  };
+}
+function buildRoles(opts) {
+  const rights = {};
+  for (const e of opts.entities) rights[e.name] = "SIUDC";
+  return {
+    [`${opts.code}.admin`]: {
+      description: `${opts.displayName} administrators`,
+      rights
+    }
+  };
+}
+function buildActions() {
+  return {};
+}
+function buildSettings() {
+  return {};
+}
+function buildTranslations(opts) {
+  const t = {};
+  t[`module.${opts.code}.label`] = opts.displayName;
+  if (opts.description) t[`module.${opts.code}.description`] = opts.description;
+  for (const e of opts.entities) {
+    t[`entity.${e.name}.label`] = e.label;
+    t[`view.${e.name}.label`] = e.label;
+    t[`menu.${e.name}.label`] = e.label;
+  }
+  return t;
+}
+function buildSeedData() {
+  return [];
+}
+function buildGitignore() {
+  return [
+    "# Built module package archives",
+    "*.dforge",
+    "",
+    "# Editor / OS noise",
+    "node_modules/",
+    ".DS_Store",
+    "*.swp",
+    ""
+  ].join("\n");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildActions,
+  buildDataViews,
+  buildEntity,
+  buildFolders,
+  buildGitignore,
+  buildManifest,
+  buildMenus,
+  buildRoles,
+  buildSeedData,
+  buildSettings,
+  buildTranslations
+});

package/dist/lib.mjs

@@ -0,0 +1,141 @@
+// src/init/templates.ts
+function buildManifest(opts, moduleId) {
+  const today = (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
+  const manifest = {
+    packageFormat: 1,
+    moduleId,
+    code: opts.code,
+    version: opts.version,
+    dbSchemaVersion: opts.dbSchemaVersion,
+    displayName: opts.displayName,
+    entities: Object.fromEntries(
+      opts.entities.map((e) => [e.name, `./entities/${e.name}.json`])
+    ),
+    created: today,
+    updated: today
+  };
+  if (opts.description) manifest.description = opts.description;
+  if (opts.author) manifest.author = { name: opts.author };
+  if (opts.license) manifest.license = opts.license;
+  if (opts.dependencies.length > 0) {
+    manifest.dependencies = Object.fromEntries(
+      opts.dependencies.map((d) => [d, ">=0.0.1"])
+    );
+  }
+  return manifest;
+}
+function buildEntity(entity) {
+  const traits = entity.traits === "identity+audit" ? ["identity", "audit"] : ["identity"];
+  return {
+    description: entity.label,
+    dbObject: entity.name,
+    toString: "{id}",
+    traits,
+    fields: {}
+  };
+}
+function buildDataViews(entities) {
+  const views = {};
+  for (const e of entities) {
+    views[e.name] = {
+      viewType: "grid",
+      label: e.label,
+      dataSources: [
+        {
+          entityCode: e.name,
+          columns: []
+        }
+      ]
+    };
+  }
+  return views;
+}
+function buildFolders(opts) {
+  return {
+    [opts.code]: {
+      label: opts.displayName,
+      description: opts.description || opts.displayName,
+      icon: "bi-folder",
+      color: "#2196F3",
+      entities: Object.fromEntries(
+        opts.entities.map((e) => [
+          e.name,
+          { viewName: e.name, quickAdd: true }
+        ])
+      )
+    }
+  };
+}
+function buildMenus(opts) {
+  return {
+    [opts.code]: {
+      label: opts.displayName,
+      icon: "bi-folder",
+      children: Object.fromEntries(
+        opts.entities.map((e) => [
+          e.name,
+          {
+            itemType: "V",
+            label: e.label,
+            dataViewCode: e.name
+          }
+        ])
+      )
+    }
+  };
+}
+function buildRoles(opts) {
+  const rights = {};
+  for (const e of opts.entities) rights[e.name] = "SIUDC";
+  return {
+    [`${opts.code}.admin`]: {
+      description: `${opts.displayName} administrators`,
+      rights
+    }
+  };
+}
+function buildActions() {
+  return {};
+}
+function buildSettings() {
+  return {};
+}
+function buildTranslations(opts) {
+  const t = {};
+  t[`module.${opts.code}.label`] = opts.displayName;
+  if (opts.description) t[`module.${opts.code}.description`] = opts.description;
+  for (const e of opts.entities) {
+    t[`entity.${e.name}.label`] = e.label;
+    t[`view.${e.name}.label`] = e.label;
+    t[`menu.${e.name}.label`] = e.label;
+  }
+  return t;
+}
+function buildSeedData() {
+  return [];
+}
+function buildGitignore() {
+  return [
+    "# Built module package archives",
+    "*.dforge",
+    "",
+    "# Editor / OS noise",
+    "node_modules/",
+    ".DS_Store",
+    "*.swp",
+    ""
+  ].join("\n");
+}
+export {
+  buildActions,
+  buildDataViews,
+  buildEntity,
+  buildFolders,
+  buildGitignore,
+  buildManifest,
+  buildMenus,
+  buildRoles,
+  buildSeedData,
+  buildSettings,
+  buildTranslations
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dforge-core/dforge-cli",
-	"version": "0.1.0-rc.4",
+	"version": "0.1.0-rc.6",
 	"description": "dForge CLI - validate, pack, publish, and install dForge modules. Distributes a single-file native binary per platform via optionalDependencies (esbuild-style).",
 	"license": "MIT",
 	"homepage": "https://github.com/iash44/dForge-core",
@@ -16,6 +16,14 @@
 		"README.md"
 	],
 	"main": "dist/cli.js",
+	"exports": {
+		".": "./dist/cli.js",
+		"./templates": {
+			"types": "./dist/lib.d.ts",
+			"import": "./dist/lib.mjs",
+			"require": "./dist/lib.js"
+		}
+	},
 	"engines": {
 		"node": ">=18"
 	},