@olenbetong/appframe-cli 4.4.10 → 4.5.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 4.5.0
+
+### Minor Changes
+
+- e61d41b: af resources generate now reads types.json from cwd for type overrides keyed by database object name
+
+### Patch Changes
+
+- 19ef84b: af resources generate: add --output flag to write to a file and compute the correct relative import path for custom.d.ts
+- 1e0c584: Add resources.yaml config system for data objects and stored procedures
+  - `appframe-vite`: New `resources.yaml` config file support — declare all data objects and stored procedures in a single YAML file per app.
+  - `appframe-vite`: New CLI commands: `appframe-vite resources generate` (regenerate all files from config), `resources add` (interactive wizard), `resources edit [id]` (interactive editor).
+  - `appframe-vite`: Dev server now watches `resources.yaml` and auto-regenerates output files on change.
+  - `appframe-vite`: New `@olenbetong/appframe-vite/resources` package export with shared code generation utilities (`fetchAndGenerate`, `buildYamlConfig`, `parseYamlConfig`, etc.).
+  - `appframe-cli`: Remove `af resources regenerate` command (superseded by `appframe-vite resources generate`).
+  - `appframe-cli`: `af resources generate` now uses generation logic from `@olenbetong/appframe-vite/resources`.
+
+- Updated dependencies [1e0c584]
+  - @olenbetong/appframe-vite@6.2.0
+
 ## 4.4.10
 
 ### Patch Changes

package/README.md

@@ -68,6 +68,9 @@ Use `af <command> --help` for full usage with options.
 - `af resources add <id>`: Adds a data resource by DB object id. Options: `--server <host>`, `--name [name]`.
 - `af resources delete <id>`: Deletes a data resource by id or name. Options: `--server <host>`.
 
+> **Note:** To manage data objects and procedures declaratively, use the `resources.yaml` config system in `@olenbetong/appframe-vite`. See `appframe-vite resources add/edit/generate` commands.
+
+
 ### Bundles
 
 - `af bundle create`: Scaffold a new bundle project.

package/cli/af-bundle-upload.js

@@ -1,4 +1,7 @@
 "use strict";
+import { mkdirSync, renameSync, rmSync } from "node:fs";
+import { join } from "node:path";
+import AdmZip from "adm-zip";
 import chalk from "chalk";
 import { Command } from "commander";
 import { config } from "dotenv";
@@ -9,6 +12,11 @@ import { execShellCommand } from "./lib/execShellCommand.js";
 import { importJson } from "./lib/importJson.js";
 import { Server } from "./lib/Server.js";
 config({ path: `${process.cwd()}/.env`, quiet: true });
+function createZip(sourceDir, outputFile) {
+  let zip = new AdmZip();
+  zip.addLocalFolder(sourceDir, sourceDir);
+  zip.writeZip(outputFile);
+}
 async function prepareBundle(pkgName, options) {
   try {
     let name;
@@ -74,23 +82,23 @@ async function prepareBundle(pkgName, options) {
       console.log(chalk.yellow("No bundle found..."));
     }
     console.log("Removing previous...");
-    await execShellCommand(`rm -rf ${rootOutputFolder}`);
+    rmSync(rootOutputFolder, { recursive: true, force: true });
     console.log("Packing...");
     await execShellCommand(pkgName ? `npm pack ${pkgName}` : "npm pack");
     console.log("Making output directory...");
-    await execShellCommand(`mkdir -p ${name}`);
+    mkdirSync(name, { recursive: true });
     console.log(`Extracting '${tarball}'...`);
     await execShellCommand(`tar -xvzf ${tarball} -C ${name}`);
     console.log(`Moving from 'package' to '${version}'...`);
-    await execShellCommand(`mv ${name}/package ${name}/${version}`);
+    renameSync(join(name, "package"), join(name, version));
     console.log("Zipping...");
-    await execShellCommand(`zip -r ${zipFileName} ./${rootOutputFolder}`);
+    createZip(rootOutputFolder, zipFileName);
     console.log("Cleaning...");
-    await execShellCommand(`rm -rf ${rootOutputFolder}`);
-    await execShellCommand(`rm ${tarball}`);
+    rmSync(rootOutputFolder, { recursive: true, force: true });
+    rmSync(tarball);
     if (id) {
       await server.uploadBundle(Project_ID, id, zipFileName);
-      await execShellCommand(`rm ${zipFileName}`);
+      rmSync(zipFileName);
       console.log("Done!");
     } else {
       console.log("Launching explorer...");

package/cli/af-resources-generate.js

@@ -1,280 +1,23 @@
 "use strict";
+import { writeFile } from "node:fs/promises";
+import { Client } from "@olenbetong/appframe-data";
+import {
+  buildYamlConfig,
+  fetchAndGenerate,
+  formatWithBiome
+} from "@olenbetong/appframe-vite/resources";
+import { config } from "dotenv";
 import inquirer from "inquirer";
 import { Command } from "./lib/Command.js";
 import { importJson } from "./lib/importJson.js";
 import { Server } from "./lib/Server.js";
+config({ path: `${process.cwd()}/.env`, quiet: true });
 const appPkg = await importJson("../package.json");
-function afTypeToTsType(type, dateStyle = false) {
-  switch (type) {
-    case "bigint":
-      return "bigint";
-    case "int":
-    case "decimal":
-    case "smallint":
-    case "tinyint":
-    case "float":
-    case "numeric":
-      return "number";
-    case "bit":
-      return "boolean";
-    case "datetime2":
-    case "datetime":
-    case "smalldatetime":
-    case "date":
-      if (dateStyle === "ts") {
-        return "Date";
-      } else if (dateStyle === "ts-proc") {
-        return "string | Date";
-      } else {
-        return type === "date" ? "date" : "datetime";
-      }
-    default:
-      return "string";
-  }
-}
-function getProcedureDefinition(name, procDefinition, options) {
-  let parameters = [];
-  let typeOverrides = {};
-  if (options.overrides) {
-    let overrides = options.overrides.split(",");
-    for (let override of overrides) {
-      let [param, type] = override.split(":");
-      typeOverrides[param] = type;
-    }
-  }
-  for (let parameter of procDefinition.Parameters) {
-    parameters.push({
-      name: parameter.ParamName,
-      type: afTypeToTsType(parameter.TypeName, "field"),
-      hasDefault: parameter.has_default_value,
-      required: !parameter.has_default_value && !parameter.is_nullable
-    });
-  }
-  let output = [];
-  if (!options.global) {
-    output.push(`import { ProcedureAPI } from "@olenbetong/appframe-data";`);
-    if (options.expose) {
-      output.push(`import { expose } from "@olenbetong/appframe-core";`);
-    }
-    output.push("");
-  }
-  let paramTypeName = "ProcParams";
-  let procName = "proc";
-  if (options.id) {
-    procName = options.id;
-    paramTypeName = `${options.id}Params`;
-    if (paramTypeName.startsWith("proc")) {
-      paramTypeName = paramTypeName.substring(4);
-    }
-  }
-  if (options.types) {
-    if (procDefinition.Parameters.length > 0) {
-      let typeOutput = [`export type ${paramTypeName} = {`];
-      for (let parameter of procDefinition.Parameters) {
-        let type = typeOverrides[parameter.ParamName];
-        let name2 = parameter.ParamName;
-        if (!type) {
-          type = afTypeToTsType(parameter.TypeName, "ts-proc");
-        }
-        if (parameter.has_default_value || parameter.is_nullable) {
-          type += " | null";
-          name2 += "?";
-        }
-        typeOutput.push(`	${name2}: ${type}`);
-      }
-      typeOutput.push("};");
-      output.push(typeOutput.join("\n"));
-      output.push("");
-    } else {
-      output.push(`export type ${paramTypeName} = null | undefined | Record<string, unknown>;
-`);
-    }
-  }
-  output.push(`export const ${procName} = new ${options.global ? "af." : ""}ProcedureAPI${options.types ? `<${paramTypeName}, unknown>` : ""}({
-  procedureId: "${name}",
-  parameters: ${JSON.stringify(parameters, null, 2)},
-  timeout: 30000
-});`);
-  if (options.expose) {
-    output.push("");
-    output.push(
-      `${options.global ? "af.common." : ""}expose("af.article.procedures.${procName}", ${procName}, { overwrite: true });`
-    );
-  }
-  return output.join("\n");
-}
-function getDataObjectDefinition(name, viewDefinition, options) {
-  let fields = [];
-  let includeFields = typeof options.fields === "string" ? options.fields?.split(",").filter((f) => !!f) ?? [] : [];
-  let aggregates = {};
-  if (options.aggregates) {
-    for (let aggregateDef of options.aggregates.split(",")) {
-      let [field, aggregate] = aggregateDef.split(":");
-      aggregates[field] = aggregate;
-    }
-  }
-  for (let field of viewDefinition.Parameters) {
-    if (includeFields.length > 0 && !includeFields.includes(field.Name)) {
-      continue;
-    }
-    let fieldDefinition = {
-      name: field.Name,
-      type: field.DataType,
-      nullable: field.Nullable
-    };
-    if (field.HasDefault) {
-      fieldDefinition.hasDefault = true;
-    }
-    if (field.Computed) {
-      fieldDefinition.computed = true;
-    }
-    if (field.Identity) {
-      fieldDefinition.identity = true;
-    }
-    if (aggregates[field.Name]) {
-      fieldDefinition.aggregate = aggregates[field.Name];
-    }
-    fields.push(fieldDefinition);
-  }
-  let api = "generateApiDataObject";
-  let types = "";
-  let typeName = `${options.id}Record`;
-  let typeOverrides = {};
-  if (options.overrides) {
-    let overrides = options.overrides.split(",");
-    for (let override of overrides) {
-      let [param, type] = override.split(":");
-      typeOverrides[param] = type;
-    }
-  }
-  if (typeName.startsWith("ds")) {
-    typeName = typeName.substring(2);
-  }
-  if (options.types) {
-    api = `generateApiDataObject<${typeName}>`;
-    let fieldTypes = "";
-    for (let field of fields) {
-      let type = typeOverrides[field.name];
-      if (!type) {
-        type = afTypeToTsType(field.type, "ts");
-        if (field.nullable) {
-          type += " | null";
-        }
-      }
-      fieldTypes += `  ${field.name}: ${type};
-`;
-    }
-    types = `export type ${typeName} = {
-${fieldTypes}}`;
-  }
-  if (options.global) {
-    api = `af.data.${api}`;
-  }
-  let output = "";
-  if (!options.global) {
-    output += `import { generateApiDataObject${options.sortOrder ? ", SortOrder" : ""} } from "@olenbetong/appframe-data";`;
-    if (options.expose) {
-      output += `
-import { expose } from "@olenbetong/appframe-core";`;
-    }
-    output += "\n\n";
-  }
-  if (options.master && options.master.indexOf(":") > 0) {
-    let [name2, path] = options.master.split(":");
-    output += `import { ${name2} } from "${path}";
-
-`;
-  }
-  if (options.types) {
-    output += `${types}
-
-`;
-  }
-  let linkFields = "";
-  let dsOptions = [];
-  dsOptions.push(`resource: "${name}"`);
-  if (options.unique) {
-    dsOptions.push(`uniqueName: "${options.unique}"`);
-  }
-  dsOptions.push(`id: "${options.id}"`);
-  if (options.master && options.linkFields) {
-    dsOptions.push(`masterDataObject: ${options.master.split(":")[0]}`);
-    let fields2 = options.linkFields.split(",");
-    linkFields = `linkFields: {
-		${fields2.map((field) => {
-      let [thisField, masterField] = field.split(":");
-      return `${thisField}: "${masterField ?? thisField}",`;
-    }).join("\n		")}
-	}`;
-    dsOptions.push(linkFields);
-  }
-  dsOptions.push(`allowUpdate: ${options.permissions?.includes("U") ?? false}`);
-  dsOptions.push(`allowInsert: ${options.permissions?.includes("I") ?? false}`);
-  dsOptions.push(`allowDelete: ${options.permissions?.includes("D") ?? false}`);
-  dsOptions.push(`dynamicLoading: ${options.dynamic || false}`);
-  let fieldsOption = fields.map((field) => ({
-    ...field,
-    type: afTypeToTsType(field.type, "field")
-  }));
-  dsOptions.push(`fields: ${JSON.stringify(fieldsOption, null, 2).split("\n").join("\n	")}`);
-  let parametersOption = [`maxRecords: ${options.maxRecords}`];
-  if (options.sortOrder) {
-    let sorts = options.sortOrder.split(",");
-    let sortPrefix = options.global ? "af.data.SortOrder." : "SortOrder.";
-    let sortOrder = sorts.map((sort) => {
-      let [field, order = "asc"] = sort.split(":");
-      switch (order.toLocaleLowerCase()) {
-        case "asc":
-          order = "Asc";
-          break;
-        case "desc":
-          order = "Desc";
-          break;
-        case "ascnullslast":
-          order = "AscNullsLast";
-          break;
-        case "descnullsfirst":
-          order = "DescNullsFirst";
-          break;
-      }
-      return `{ ${field}: ${sortPrefix}${order} }`;
-    }).join(", ");
-    parametersOption.push(`sortOrder: [${sortOrder}]`);
-  }
-  if (options.groupBy) {
-    parametersOption.push(`groupBy: ${JSON.stringify(options.groupBy.split(","))}`);
-  }
-  if (options.where) {
-    parametersOption.push(`whereClause: "${options.where}"`);
-  }
-  if (options.distinct) {
-    parametersOption.push(`distinctRows: true`);
-  }
-  dsOptions.push(`parameters: {
-		${parametersOption.join(",\n		")}
-	}`);
-  output += `export const ${options.id} = ${api}({
-  ${dsOptions.join(",\n	")}
-});
-`;
-  if (options.expose) {
-    let id = typeof options.expose === "string" ? options.expose : options.id;
-    if (options.global) {
-      output += `
-af.common.expose("af.article.dataObjects.${id}", ${options.id}, { overwrite: true });`;
-    } else {
-      output += `
-expose("af.article.dataObjects.${id}", ${options.id}, { overwrite: true });`;
-    }
-  }
-  return output;
-}
 async function getResourceDefinition(resourceName, options) {
-  let server = new Server("dev.obet.no");
-  let resource = await server.getResourceArgument(resourceName);
-  let definition = await server.getResourceDefinition(resource);
-  definition.Parameters = definition.Parameters.filter((p) => !["CUT", "CDL"].includes(p.Name));
   if (options.fields === true) {
+    let server2 = new Server(options.server);
+    let resource2 = await server2.getResourceArgument(resourceName);
+    let definition = await server2.getResourceDefinition(resource2);
     let response = await inquirer.prompt([
       {
         type: "checkbox",
@@ -287,31 +30,43 @@ async function getResourceDefinition(resourceName, options) {
     ]);
     options.fields = response.fields.join(",");
   }
-  let command = [`af resources generate ${resource}`];
-  if (options.id) command.push(`--id ${options.id}`);
-  if (options.unique) command.push(`--unique ${options.unique}`);
-  if (options.global) command.push("--global");
-  if (options.types) command.push("--types");
-  if (options.maxRecords && definition.ObjectType !== "P") command.push(`--max-records ${options.maxRecords}`);
-  if (options.sortOrder) command.push(`--sort-order ${options.sortOrder}`);
-  if (options.permissions) command.push(`--permissions ${options.permissions}`);
-  if (options.master) command.push(`--master ${options.master}`);
-  if (options.linkFields) command.push(`--link-fields ${options.linkFields}`);
-  if (options.expose) command.push(`--expose${typeof options.expose === "string" ? ` ${options.expose}` : ""}`);
-  if (options.dynamic) command.push(`--dynamic`);
-  if (options.overrides) command.push(`--overrides "${options.overrides}"`);
-  if (options.distinct) command.push("--distinct");
-  if (options.aggregates) command.push(`--aggregates ${options.aggregates}`);
-  if (options.groupBy) command.push(`--group-by ${options.groupBy}`);
-  if (options.where) command.push(`--where "${options.where}"`);
-  if (options.fields) command.push(`--fields ${options.fields}`);
-  console.log(`/*
+  let server = new Server(options.server);
+  let resource = await server.getResourceArgument(resourceName);
+  let { APPFRAME_LOGIN: username = "", APPFRAME_PWD: password = "" } = process.env;
+  let client = new Client(options.server);
+  await client.login(username, password);
+  let content = await fetchAndGenerate(resource, options, client);
+  if (options.output) {
+    let header = buildYamlConfig(resource, options);
+    await writeFile(options.output, `${header}
+${content}`, "utf-8");
+    await formatWithBiome(options.output);
+    console.log(`Written to ${options.output}`);
+  } else {
+    let command = [`af resources generate ${resource}`];
+    if (options.id) command.push(`--id ${options.id}`);
+    if (options.unique) command.push(`--unique ${options.unique}`);
+    if (options.global) command.push("--global");
+    if (options.types) command.push("--types");
+    if (options.maxRecords) command.push(`--max-records ${options.maxRecords}`);
+    if (options.sortOrder) command.push(`--sort-order ${options.sortOrder}`);
+    if (options.permissions) command.push(`--permissions ${options.permissions}`);
+    if (options.master) command.push(`--master ${options.master}`);
+    if (options.linkFields) command.push(`--link-fields ${options.linkFields}`);
+    if (options.expose) command.push(`--expose${typeof options.expose === "string" ? ` ${options.expose}` : ""}`);
+    if (options.dynamic) command.push("--dynamic");
+    if (options.overrides) command.push(`--overrides "${options.overrides}"`);
+    if (options.distinct) command.push("--distinct");
+    if (options.aggregates) command.push(`--aggregates ${options.aggregates}`);
+    if (options.groupBy) command.push(`--group-by ${options.groupBy}`);
+    if (options.where) command.push(`--where "${options.where}"`);
+    if (options.fields) command.push(`--fields ${options.fields}`);
+    console.log(`/*
 auto-generated by CLI:
 ${command.join(" \\\n ")}
 */`);
-  console.log(
-    definition.ObjectType === "V" ? getDataObjectDefinition(resource, definition, options) : getProcedureDefinition(resource, definition, options)
-  );
+    console.log(content);
+  }
 }
 const program = new Command();
 program.version(appPkg.version).addResourceArgument().option("-i, --id <id>", "ID to use as name for the data object", "dsDataObject").option("-g, --global", "Use af.data globals to generate the data object").option("-t, --types", "Include data object types").option("-f, --fields [fields]", "Comma-separated list of fields to include").option(
@@ -332,5 +87,8 @@ program.version(appPkg.version).addResourceArgument().option("-i, --id <id>", "I
 ).option("--group-by <fields>", "Comma separated list of fields to group by").option(
   "--aggregates <fields>",
   "Comma separated list of aggregate binding for non-grouped fields, e.g. Quantity:SUM,Created:MAX"
-).option("--distinct", "Data object should fetch distinct data").option("--where <whereClause>", "Initial where clause to set on the data object").action(getResourceDefinition);
+).option("--distinct", "Data object should fetch distinct data").option("--where <whereClause>", "Initial where clause to set on the data object").option(
+  "-O, --output <path>",
+  "Write output to this file instead of stdout; also sets the correct relative import path for custom.d.ts"
+).action(getResourceDefinition);
 await program.parseAsync(process.argv);

package/package.json

@@ -5,7 +5,7 @@
     "af": "./cli/af.js"
   },
   "type": "module",
-  "version": "4.4.10",
+  "version": "4.5.0",
   "license": "MIT",
   "keywords": [
     "appframe",
@@ -13,6 +13,7 @@
     "appframe web"
   ],
   "devDependencies": {
+    "@types/adm-zip": "^0.5.8",
     "@types/d3": "^7.4.3",
     "@types/degit": "^2.8.6",
     "@types/inquirer": "^9.0.9",
@@ -22,7 +23,8 @@
     "tough-cookie": "^6.0.0"
   },
   "dependencies": {
-    "@biomejs/biome": "2.4.12",
+    "@biomejs/biome": "2.4.14",
+    "adm-zip": "^0.5.17",
     "chalk": "^5.6.2",
     "commander": "^14.0.1",
     "compare-versions": "^6.1.1",
@@ -41,7 +43,8 @@
     "signal-exit": "^4.1.0",
     "typescript": "6.0.3",
     "@olenbetong/appframe-data": "1.5.0",
-    "@olenbetong/appframe-updater": "0.4.10"
+    "@olenbetong/appframe-updater": "0.4.10",
+    "@olenbetong/appframe-vite": "6.2.0"
   },
   "optionalDependencies": {
     "keytar": "^8.3.1"

package/src/af-bundle-upload.ts

@@ -1,3 +1,6 @@
+import { mkdirSync, renameSync, rmSync } from "node:fs";
+import { join } from "node:path";
+import AdmZip from "adm-zip";
 import chalk from "chalk";
 import { Command } from "commander";
 import { config } from "dotenv";
@@ -10,6 +13,12 @@ import { Server } from "./lib/Server.js";
 
 config({ path: `${process.cwd()}/.env`, quiet: true });
 
+function createZip(sourceDir: string, outputFile: string) {
+	let zip = new AdmZip();
+	zip.addLocalFolder(sourceDir, sourceDir);
+	zip.writeZip(outputFile);
+}
+
 /**
  * @param {string} pkgName
  * @param {{ bundle?: string | null }} options
@@ -90,24 +99,24 @@ async function prepareBundle(pkgName: string, options: { bundle: string }) {
 		}
 
 		console.log("Removing previous...");
-		await execShellCommand(`rm -rf ${rootOutputFolder}`);
+		rmSync(rootOutputFolder, { recursive: true, force: true });
 		console.log("Packing...");
 		await execShellCommand(pkgName ? `npm pack ${pkgName}` : "npm pack");
 		console.log("Making output directory...");
-		await execShellCommand(`mkdir -p ${name}`);
+		mkdirSync(name, { recursive: true });
 		console.log(`Extracting '${tarball}'...`);
 		await execShellCommand(`tar -xvzf ${tarball} -C ${name}`);
 		console.log(`Moving from 'package' to '${version}'...`);
-		await execShellCommand(`mv ${name}/package ${name}/${version}`);
+		renameSync(join(name, "package"), join(name, version));
 		console.log("Zipping...");
-		await execShellCommand(`zip -r ${zipFileName} ./${rootOutputFolder}`);
+		createZip(rootOutputFolder, zipFileName);
 		console.log("Cleaning...");
-		await execShellCommand(`rm -rf ${rootOutputFolder}`);
-		await execShellCommand(`rm ${tarball}`);
+		rmSync(rootOutputFolder, { recursive: true, force: true });
+		rmSync(tarball);
 
 		if (id) {
 			await server.uploadBundle(Project_ID, id, zipFileName);
-			await execShellCommand(`rm ${zipFileName}`);
+			rmSync(zipFileName);
 			console.log("Done!");
 		} else {
 			console.log("Launching explorer...");