@factorialco/fcode-cli 2.3.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@factorialco/fcode-cli",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "packageManager": "pnpm@11.7.0",
   "description": "Factorial Code Command Line Interface",
   "homepage": "https://code.factorialhr.com/docs/cli/",
@@ -33,6 +33,7 @@
     "@oclif/core": "^4.0.37",
     "@oclif/plugin-help": "^6.2.36",
     "chalk": "^4.1.2",
+    "diff": "^5.2.0",
     "dotenv": "^16.4.7",
     "fs-extra": "^11.2.0",
     "lodash": "^4.17.21",
@@ -53,6 +54,7 @@
     "@oclif/test": "^4.1.15",
     "@types/chai": "^4.3.20",
     "@types/cli-table": "^0.3.4",
+    "@types/diff": "^5.2.3",
     "@types/fs-extra": "^11.0.4",
     "@types/lodash": "^4.17.21",
     "@types/mocha": "^10.0.10",
@@ -103,8 +105,8 @@
       "variables": {
         "description": "Manage variables resources"
       },
-      "settings": {
-        "description": "Manage CLI settings"
+      "config": {
+        "description": "Manage CLI configuration"
       },
       "dependencies": {
         "description": "Manage dependencies resources"
@@ -112,16 +114,19 @@
       "remote": {
         "description": "Manage remote team workspaces"
       },
-      "team": {
-        "description": "Manage team settings (timezone, error handler, inheritance) and team versions",
+      "settings": {
+        "description": "Manage workspace settings (timezone, error handler, inheritance) and workspace versions",
         "subtopics": {
           "versions": {
-            "description": "Manage team versions across every owned process and module"
+            "description": "Manage workspace versions across every owned process and module"
           },
           "aliases": {
-            "description": "Manage team version aliases (e.g. production)"
+            "description": "Manage workspace version aliases (e.g. production)"
           }
         }
+      },
+      "team": {
+        "description": "Work with every App your development team owns, in one folder"
       }
     }
   },

package/dist/commands/team/push.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const color_1 = require("@oclif/color");
-const api_client_command_1 = require("../../core/commands/api-client-command");
-const team_1 = require("../../repositories/team");
-const types_1 = require("../../core/types");
-const cli_1 = require("../../utils/cli");
-class TeamPushCommand extends api_client_command_1.default {
-    constructor() {
-        super(...arguments);
-        this._teamRepository = new team_1.default();
-    }
-    async run() {
-        const { flags: { force }, } = await this.parse(TeamPushCommand);
-        if (!this._teamRepository.exists()) {
-            return;
-        }
-        cli_1.default.log(color_1.default.cyan('\n☁️  pushing team settings...'));
-        const team = await this._teamRepository.find();
-        const storedHash = await this.workspaceConfig.getTeamStoredHash();
-        if (!force && storedHash === team.contentHash) {
-            cli_1.default.log('Team settings already up to date');
-            return;
-        }
-        // team.json's `versions`/`aliases` fields are pull-only and intentionally left out of the
-        // update payload: team versions and aliases are only written through the explicit
-        // team:versions/team:aliases commands.
-        const update = { parentTeamSlugs: team.parentTeamSlugs };
-        if (team.zoneId !== undefined) {
-            update.zoneId = team.zoneId;
-        }
-        if (team.errorHandlerConfig) {
-            const processId = await this._teamRepository.resolveSlugToId(team.errorHandlerConfig.processSlug);
-            update.executionErrorHandlerConfig = { processId, tag: team.errorHandlerConfig.tag ?? null };
-        }
-        // Sent unconditionally, null arm included: team.json is the source of truth, so removing
-        // webhookAuth from it must clear the cloud configuration rather than leave it dangling.
-        update.webhookAuth = team.webhookAuth
-            ? { headerName: team.webhookAuth.headerName ?? null, variableKey: team.webhookAuth.variableKey }
-            : { variableKey: null };
-        // Sent unconditionally for the same reason as webhookAuth: team.json is the source of truth,
-        // so removing primaryLocale from it must clear the cloud setting. Empty string is the clear.
-        update.primaryLocale = team.primaryLocale ?? '';
-        await this._fcodeGraphQLClient.pushTeam(update);
-        await this.workspaceConfig.setTeamStoredHash(team.contentHash);
-        cli_1.default.log(color_1.default.green('✅ team settings pushed'));
-    }
-}
-TeamPushCommand.description = 'Update cloud team settings (timezone, error handler, inheritance, webhook auth) from team.json';
-TeamPushCommand.examples = ['$ fcode team:push'];
-TeamPushCommand.flags = types_1.ForceFlag;
-exports.default = TeamPushCommand;

package/dist/commands/team/versions/create.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@oclif/core");
-const color_1 = require("@oclif/color");
-const api_client_command_1 = require("../../../core/commands/api-client-command");
-const pull_1 = require("../../pull");
-const cli_1 = require("../../../utils/cli");
-class TeamVersionsCreateCommand extends api_client_command_1.default {
-    async run() {
-        const { args: { tag }, flags: { comment }, } = await this.parse(TeamVersionsCreateCommand);
-        cli_1.default.log(color_1.default.cyan(`\n🏷️  publishing team version ${tag}...`));
-        const teamVersion = await this._fcodeGraphQLClient.createTeamVersion(tag, comment);
-        const failedCount = this.logManifest(teamVersion);
-        // Refresh the local workspace: per-entity versions/<tag>/ folders and team.json.
-        await pull_1.default.run([]);
-        // Release pipelines must be able to detect an incomplete version. Re-running the
-        // command converges: it publishes only what is still missing.
-        if (failedCount > 0) {
-            this.error(`team version ${tag} published with ${failedCount} failed entities`, { exit: 1 });
-        }
-    }
-    logManifest(teamVersion) {
-        const created = teamVersion.manifest.filter(({ outcome }) => outcome === 'CREATED');
-        const skipped = teamVersion.manifest.filter(({ outcome }) => outcome === 'SKIPPED_EXISTS');
-        const failed = teamVersion.manifest.filter(({ outcome }) => outcome === 'FAILED');
-        cli_1.default.log(color_1.default.green(`✅ ${created.length} created`) + `, ${skipped.length} skipped (tag already exists)` + (failed.length > 0 ? `, ${color_1.default.red(`${failed.length} failed`)}` : ''));
-        for (const entry of failed) {
-            cli_1.default.error(`${entry.resourceType.toLowerCase()} ${entry.slug} — ${entry.error ?? 'unknown error'}`);
-        }
-        return failed.length;
-    }
-}
-TeamVersionsCreateCommand.description = 'Publish a team version: creates a version with the tag on every owned process and module ' +
-    '(existing tags are skipped) and pins bare module imports in the published snapshots';
-TeamVersionsCreateCommand.examples = ['$ fcode team:versions:create v1.0.0', '$ fcode team:versions:create v1.0.0 --comment "First stable release"'];
-TeamVersionsCreateCommand.args = {
-    tag: core_1.Args.string({ description: 'version tag to publish (e.g. v1.0.0)', required: true }),
-};
-TeamVersionsCreateCommand.flags = {
-    comment: core_1.Flags.string({ char: 'c', description: 'comment describing the version' }),
-};
-exports.default = TeamVersionsCreateCommand;

package/dist/repositories/team.d.ts

@@ -1,31 +0,0 @@
-import { RawTeamSettings, Team, TeamVersion, TeamVersionAlias } from '../core/types';
-import WorkspaceConfig from '../config/workspace';
-/**
- * Reads/writes the singleton team.json (timezone, error handler, inheritance, webhook auth) at the
- * workspace root. Unlike collection resources this is not a ResourceRepositoryBase:
- * there is exactly one team, so there is no slug-keyed collection to manage.
- *
- * team.json references the error-handler process by slug for portability; the cloud
- * references it by id, so this repository resolves slug<->id against the tracked
- * process metadata in .fcode/.
- */
-export default class TeamRepository {
-    protected workspaceConfig: WorkspaceConfig;
-    exists(): boolean;
-    find(): Promise<Team>;
-    save(team: Team): void;
-    /** Builds a Team from the cloud's raw settings, resolving the error-handler id to a slug. */
-    fromRaw(raw: RawTeamSettings): Promise<Team>;
-    /**
-     * Writes the cloud's team versions and aliases into the Team as the pull-only team.json
-     * fields (sorted for stable git diffs). These fields never enter the content hash and are
-     * stripped from pushes: all writes go through the team:versions/team:aliases commands.
-     */
-    applyCloudVersioning(team: Team, versions: TeamVersion[], aliases: TeamVersionAlias[]): void;
-    resolveSlugToId(processSlug: string): Promise<string>;
-    resolveIdToSlug(processId: string): Promise<string>;
-    private parseErrorHandler;
-    /** A configuration without a variable key is meaningless, so it is read as absent. */
-    private parseWebhookAuth;
-    private toFile;
-}

package/dist/repositories/team.js

@@ -1,127 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs-extra");
-const types_1 = require("../core/types");
-const workspace_1 = require("../config/workspace");
-const file_utils_1 = require("../utils/file-utils");
-const TEAM_FILENAME = 'team.json';
-/**
- * Reads/writes the singleton team.json (timezone, error handler, inheritance, webhook auth) at the
- * workspace root. Unlike collection resources this is not a ResourceRepositoryBase:
- * there is exactly one team, so there is no slug-keyed collection to manage.
- *
- * team.json references the error-handler process by slug for portability; the cloud
- * references it by id, so this repository resolves slug<->id against the tracked
- * process metadata in .fcode/.
- */
-class TeamRepository {
-    constructor() {
-        this.workspaceConfig = new workspace_1.default();
-    }
-    exists() {
-        return fs.pathExistsSync(TEAM_FILENAME);
-    }
-    async find() {
-        const slug = await this.workspaceConfig.getActiveTeamSlug();
-        let raw = {};
-        try {
-            raw = fs.readJsonSync(TEAM_FILENAME) || {};
-        }
-        catch { }
-        const parentTeamSlugs = Array.isArray(raw.parentTeamSlugs) ? raw.parentTeamSlugs : [];
-        const team = new types_1.Team(slug, parentTeamSlugs, raw.zoneId, this.parseErrorHandler(raw.errorHandlerConfig), this.parseWebhookAuth(raw.webhookAuth), typeof raw.primaryLocale === 'string' && raw.primaryLocale.length > 0 ? raw.primaryLocale : undefined);
-        // Parsed so a find()+save() round-trip does not drop the pull-only fields.
-        if (Array.isArray(raw.versions)) {
-            team.versions = raw.versions;
-        }
-        if (Array.isArray(raw.aliases)) {
-            team.aliases = raw.aliases;
-        }
-        return team;
-    }
-    save(team) {
-        (0, file_utils_1.outputFileSyncIfChanged)(TEAM_FILENAME, JSON.stringify(this.toFile(team), null, 2));
-    }
-    /** Builds a Team from the cloud's raw settings, resolving the error-handler id to a slug. */
-    async fromRaw(raw) {
-        let errorHandlerConfig;
-        if (raw.errorHandlerConfig?.processId) {
-            errorHandlerConfig = {
-                processSlug: await this.resolveIdToSlug(raw.errorHandlerConfig.processId),
-                tag: raw.errorHandlerConfig.tag ?? null,
-            };
-        }
-        return new types_1.Team(raw.slug, raw.parentTeamSlugs ?? [], raw.zoneId, errorHandlerConfig, this.parseWebhookAuth(raw.webhookAuth), raw.primaryLocale ?? undefined);
-    }
-    /**
-     * Writes the cloud's team versions and aliases into the Team as the pull-only team.json
-     * fields (sorted for stable git diffs). These fields never enter the content hash and are
-     * stripped from pushes: all writes go through the team:versions/team:aliases commands.
-     */
-    applyCloudVersioning(team, versions, aliases) {
-        team.versions = versions
-            .map((version) => {
-            const entry = { tag: version.tag, createdAt: version.createdAt };
-            if (version.comment) {
-                entry.comment = version.comment;
-            }
-            return entry;
-        })
-            .sort((a, b) => a.createdAt.localeCompare(b.createdAt));
-        team.aliases = aliases
-            .map((alias) => ({ name: alias.name, tag: alias.tag }))
-            .sort((a, b) => a.name.localeCompare(b.name));
-    }
-    async resolveSlugToId(processSlug) {
-        const { processes } = await this.workspaceConfig.getActiveTeam();
-        return processes[processSlug]?.id ?? processSlug;
-    }
-    async resolveIdToSlug(processId) {
-        const { processes } = await this.workspaceConfig.getActiveTeam();
-        const match = Object.values(processes).find((process) => process.id === processId);
-        return match?.slug ?? processId;
-    }
-    parseErrorHandler(raw) {
-        if (!raw || !raw.processSlug) {
-            return undefined;
-        }
-        return { processSlug: raw.processSlug, tag: raw.tag ?? null };
-    }
-    /** A configuration without a variable key is meaningless, so it is read as absent. */
-    parseWebhookAuth(raw) {
-        if (!raw || typeof raw.variableKey !== 'string' || raw.variableKey.length === 0) {
-            return undefined;
-        }
-        const webhookAuth = { variableKey: raw.variableKey };
-        // The default header is left out so a pull writes the minimal form.
-        if (typeof raw.headerName === 'string' && raw.headerName.length > 0 && raw.headerName !== types_1.DEFAULT_WEBHOOK_AUTH_HEADER) {
-            webhookAuth.headerName = raw.headerName;
-        }
-        return webhookAuth;
-    }
-    toFile(team) {
-        const file = { parentTeamSlugs: team.parentTeamSlugs ?? [] };
-        if (team.zoneId !== undefined) {
-            file.zoneId = team.zoneId;
-        }
-        if (team.errorHandlerConfig !== undefined) {
-            file.errorHandlerConfig = team.errorHandlerConfig;
-        }
-        // Last, so adding webhook auth to an existing team.json is a purely additive diff.
-        if (team.webhookAuth !== undefined) {
-            file.webhookAuth = team.webhookAuth;
-        }
-        if (team.primaryLocale !== undefined) {
-            file.primaryLocale = team.primaryLocale;
-        }
-        // Pull-only global versioning fields, appended after the pushable settings.
-        if (team.versions !== undefined) {
-            file.versions = team.versions;
-        }
-        if (team.aliases !== undefined) {
-            file.aliases = team.aliases;
-        }
-        return file;
-    }
-}
-exports.default = TeamRepository;