@factorialco/fcode-cli 3.6.0 → 3.6.1

package/README.md

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

package/dist/commands/processes/push.js

@@ -5,6 +5,7 @@ const processes_command_1 = require("../../core/commands/processes-command");
 const types_1 = require("../../core/types");
 const cli_1 = require("../../utils/cli");
 const settings_1 = require("../../config/settings");
+const retired_app_role_1 = require("../../services/retired-app-role");
 class ProcessesPush extends processes_command_1.default {
     async pushVersioned() {
         const processes = (await this._resourceRepository.findAll()).filter((process) => process.id && !process.deletion);
@@ -25,6 +26,10 @@ class ProcessesPush extends processes_command_1.default {
         await Promise.allSettled(allPromises);
     }
     async run() {
+        const appRoleError = (0, retired_app_role_1.retiredAppRoleError)(await this.getLocalResources());
+        if (appRoleError) {
+            this.error(appRoleError);
+        }
         await super.pushResources();
         const ignoreProcessVersions = (await this.globalConfig.getSetting(settings_1.SettingKeys.IGNORE_PROCESS_VERSIONS)) === 'true';
         if (!ignoreProcessVersions) {

package/dist/core/types.d.ts

@@ -142,6 +142,10 @@ export type AppRole = 'INSTALL' | 'SETTINGS' | 'USER_FACING_FORM' | 'UNINSTALL'
 export type FormAuthMode = 'NONE' | 'FACTORIAL';
 export interface ProcessForm {
     enabled: boolean;
+    /**
+     * @deprecated Retired: push refuses it and pull no longer writes it. Kept so a metadata.json that
+     * still carries it can be read and reported.
+     */
     appRole?: AppRole;
     authMode?: FormAuthMode;
 }

package/dist/services/fcode-graphql-client.js

@@ -1019,10 +1019,9 @@ class FcodeGraphQLClient {
             metadata.webhook = webhook;
         }
         if (settings?.formSettings) {
+            // `appRole` is retired and push refuses it, so it is not written back: a role the cloud
+            // already holds stays there, and `factorial.form.appTool` carries the user-facing one.
             metadata.form = { enabled: Boolean(settings.formSettings.enabled) };
-            if (settings.formSettings.appRole && settings.formSettings.appRole !== 'NONE') {
-                metadata.form.appRole = settings.formSettings.appRole;
-            }
             if (settings.formSettings.authMode && settings.formSettings.authMode !== 'NONE') {
                 metadata.form.authMode = settings.formSettings.authMode;
             }

package/dist/services/retired-app-role.d.ts

@@ -0,0 +1,15 @@
+import { Process } from '../core/types';
+/**
+ * Refuses to push a process that still declares `form.appRole`.
+ *
+ * The role is retired: a lifecycle form is named by its reserved slug, and the form offered from
+ * the app's page is `factorial.form.appTool`. Writing the role kept agents copying it into new
+ * Apps, where it beats the slug and, set by `appTool`, took the install role away. A process that
+ * already holds a role in the cloud keeps it when the line is deleted, since a push only sends the
+ * role when metadata.json names it — so legacy Apps need no rename to push again.
+ *
+ * Inherited and deleted processes are not pushed, so they are not checked.
+ *
+ * @returns the message to fail the push with, or undefined when no process declares a role.
+ */
+export declare function retiredAppRoleError(processes: Array<Process>): string | undefined;

package/dist/services/retired-app-role.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retiredAppRoleError = retiredAppRoleError;
+const types_1 = require("../core/types");
+const LIFECYCLE_SLUGS = ['install', 'settings', 'uninstall'];
+/**
+ * Refuses to push a process that still declares `form.appRole`.
+ *
+ * The role is retired: a lifecycle form is named by its reserved slug, and the form offered from
+ * the app's page is `factorial.form.appTool`. Writing the role kept agents copying it into new
+ * Apps, where it beats the slug and, set by `appTool`, took the install role away. A process that
+ * already holds a role in the cloud keeps it when the line is deleted, since a push only sends the
+ * role when metadata.json names it — so legacy Apps need no rename to push again.
+ *
+ * Inherited and deleted processes are not pushed, so they are not checked.
+ *
+ * @returns the message to fail the push with, or undefined when no process declares a role.
+ */
+function retiredAppRoleError(processes) {
+    const offenders = processes.filter((process) => !(0, types_1.isReadOnly)(process) && process.form?.appRole && process.form.appRole !== 'NONE');
+    if (offenders.length === 0) {
+        return undefined;
+    }
+    const lines = offenders.map((process) => `  - processes/${process.slug}: ${fixFor(process)}`);
+    return [
+        '`form.appRole` is no longer supported. Remove it from metadata.json:',
+        ...lines,
+        `Install, settings and uninstall forms are the processes named ${LIFECYCLE_SLUGS.map((slug) => `'${slug}'`).join(', ')}.`,
+    ].join('\n');
+}
+function fixFor(process) {
+    const role = process.form.appRole;
+    if (role === 'USER_FACING_FORM') {
+        return 'set `factorial.form.appTool: true` instead.';
+    }
+    const slug = role.toLowerCase();
+    if (process.slug === slug) {
+        return `the '${slug}' slug already makes it the ${slug} form.`;
+    }
+    if (process.id) {
+        return `the cloud keeps the ${role} role it already has once the line is gone.`;
+    }
+    return `rename the process to '${slug}'.`;
+}

package/oclif.manifest.json

@@ -2516,5 +2516,5 @@
       ]
     }
   },
-  "version": "3.6.0"
+  "version": "3.6.1"
 }

package/package.json

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