@factorialco/fcode-cli 3.4.0 → 3.5.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @factorialco/fcode-cli
 $ fcode COMMAND
 running command...
 $ fcode (--version)
-@factorialco/fcode-cli/3.4.0 linux-x64 node-v22.22.3
+@factorialco/fcode-cli/3.5.0 linux-x64 node-v22.22.3
 $ fcode --help [COMMAND]
 USAGE
   $ fcode COMMAND

package/dist/core/resource-pusher.js

@@ -6,6 +6,7 @@ const resource_checker_1 = require("../services/resource-checker");
 const promise_1 = require("../utils/promise");
 const types_1 = require("./types");
 const variable_warnings_1 = require("../utils/variable-warnings");
+const file_parameter_warnings_1 = require("../utils/file-parameter-warnings");
 const global_1 = require("../config/global");
 const settings_1 = require("../config/settings");
 class ResourcePusher {
@@ -64,7 +65,10 @@ class ResourcePusher {
     async pushResource(resource) {
         try {
             if (this._repository._repositoryName === 'processes') {
-                const updatedProcess = await this._fcodeGraphQLClient.pushProcess(resource);
+                const process = resource;
+                // Only the processes being pushed are named, so each gets fixed by whoever next touches it.
+                (0, file_parameter_warnings_1.warnDeprecatedFileFields)(process.slug, (0, file_parameter_warnings_1.deprecatedFileFields)(process.script?.parametersSchema));
+                const updatedProcess = await this._fcodeGraphQLClient.pushProcess(process);
                 return this._repository.save(updatedProcess);
             }
             if (this._repository._repositoryName === 'modules') {

package/dist/utils/file-parameter-warnings.d.ts

@@ -0,0 +1,8 @@
+export interface DeprecatedFileField {
+    /** Dotted path of the property inside the schema's `properties`, e.g. `dumpFile` or `upload.file`. */
+    path: string;
+    /** Extensions taken from `ui:options.accept`, the value `x-fcode-file.accept` should carry. */
+    accept: Array<string>;
+}
+export declare function deprecatedFileFields(schema: any): Array<DeprecatedFileField>;
+export declare function warnDeprecatedFileFields(processSlug: string, fields: Array<DeprecatedFileField>): void;

package/dist/utils/file-parameter-warnings.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deprecatedFileFields = deprecatedFileFields;
+exports.warnDeprecatedFileFields = warnDeprecatedFileFields;
+const color_1 = require("@oclif/color");
+const cli_1 = require("./cli");
+// A file parameter is declared with `x-fcode-file`. `"ui:widget": "file"` is an rjsf presentation
+// key, so a property that only has the widget is still recognised as a file for now, but that
+// fallback is deprecated and will go.
+function deprecatedFileFields(schema) {
+    const fields = [];
+    collect(schema, [], fields);
+    return fields;
+}
+function collect(node, parents, fields) {
+    const properties = node?.properties;
+    if (!isObject(properties)) {
+        return;
+    }
+    for (const [key, property] of Object.entries(properties)) {
+        if (!isObject(property)) {
+            continue;
+        }
+        const path = [...parents, key];
+        if (property.ui?.['ui:widget'] === 'file' && property['x-fcode-file'] == undefined) {
+            fields.push({ path: path.join('.'), accept: acceptList(property.ui['ui:options']?.accept) });
+        }
+        collect(property, path, fields);
+        collect(property.items, path, fields);
+    }
+}
+function acceptList(accept) {
+    const values = Array.isArray(accept) ? accept : typeof accept === 'string' ? accept.split(',') : [];
+    return values.map((value) => String(value).trim()).filter((value) => value !== '');
+}
+function isObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+// Naming extensions is the habit worth teaching: accept is what tells a Factorial One agent what the
+// parameter takes. An empty list is still offered, so a field that really takes any file can say so.
+function warnDeprecatedFileFields(processSlug, fields) {
+    for (const field of fields) {
+        const fix = field.accept.length > 0
+            ? `Add "x-fcode-file": { "accept": ${extensionList(field.accept)} } to it in parametersSchema.json ` +
+                `(or { "accept": [] } if it really takes any file).`
+            : `Add "x-fcode-file" to it in parametersSchema.json, listing the extensions it takes, ` +
+                `e.g. { "accept": [".csv", ".xlsx"] }: they tell Factorial One what the parameter takes. ` +
+                `If it really takes any file, declare that with { "accept": [] }.`;
+        cli_1.default.log(color_1.default.yellow(`⚠️  '${processSlug}': parameter '${field.path}' is a file only through "ui:widget": "file", which is deprecated ` +
+            `for declaring a file and will stop working. ${fix}`));
+    }
+}
+function extensionList(extensions) {
+    return `[${extensions.map((extension) => JSON.stringify(extension)).join(', ')}]`;
+}

package/oclif.manifest.json

@@ -2516,5 +2516,5 @@
       ]
     }
   },
-  "version": "3.4.0"
+  "version": "3.5.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorialco/fcode-cli",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "packageManager": "pnpm@11.7.0",
   "description": "Factorial Code Command Line Interface",
   "homepage": "https://code.factorialhr.com/docs/cli/",