@cxtms/cx-schema 1.9.15 → 1.9.21

package/README.md

@@ -5,7 +5,7 @@
 [![Build Status](https://github.com/cargoxplorer/cx-schema/workflows/Publish%20to%20npm/badge.svg)](https://github.com/cargoxplorer/cx-schema/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-Schema validation package for CargoXplorer YAML modules and workflows. This package provides comprehensive validation for YAML-based configurations used in the CargoXplorer Transportation Management System (TMS).
+Schema validation package for CXTMS YAML modules and workflows. This package provides comprehensive validation for YAML-based configurations used in CXTMS.
 
 ## Features
 

package/dist/cli.js

@@ -47,10 +47,55 @@ const https = __importStar(require("https"));
 const crypto = __importStar(require("crypto"));
 const os = __importStar(require("os"));
 const chalk_1 = __importDefault(require("chalk"));
+const update_notifier_1 = __importDefault(require("update-notifier"));
 const yaml_1 = __importStar(require("yaml"));
 const validator_1 = require("./validator");
 const workflowValidator_1 = require("./workflowValidator");
 const extractUtils_1 = require("./extractUtils");
+const pkg = require('../package.json');
+function checkForUpdates() {
+    try {
+        (0, update_notifier_1.default)({
+            pkg,
+            updateCheckInterval: 1000 * 60 * 60 * 24,
+        }).notify({ isGlobal: true });
+    }
+    catch {
+        // Update check must never break the CLI.
+    }
+}
+const CX_SKILL_NAMES = ['cxtms-developer', 'cxtms-module-builder', 'cxtms-workflow-builder'];
+function findCxProjectRoot() {
+    let dir = process.cwd();
+    while (dir !== path.dirname(dir)) {
+        if (fs.existsSync(path.join(dir, 'app.yaml')))
+            return dir;
+        dir = path.dirname(dir);
+    }
+    return null;
+}
+function checkSkillsInstalled(command) {
+    if (command === 'install-skills' || command === 'init')
+        return;
+    try {
+        const projectRoot = findCxProjectRoot();
+        if (!projectRoot)
+            return;
+        const missing = CX_SKILL_NAMES.filter(name => !fs.existsSync(path.join(projectRoot, '.claude', 'skills', name)));
+        if (missing.length === 0)
+            return;
+        console.error('');
+        console.error(chalk_1.default.yellow('╔═══════════════════════════════════════════════════════════╗'));
+        console.error(chalk_1.default.yellow('║  cxtms skills are not installed in this project.          ║'));
+        console.error(chalk_1.default.yellow('╚═══════════════════════════════════════════════════════════╝'));
+        console.error(chalk_1.default.yellow(`  Missing: ${missing.join(', ')}`));
+        console.error(chalk_1.default.cyan('  Install: ') + chalk_1.default.bold('npx cxtms install-skills'));
+        console.error('');
+    }
+    catch {
+        // Skills check must never break the CLI.
+    }
+}
 // ============================================================================
 // .env loader — load KEY=VALUE pairs from .env in CWD into process.env
 // ============================================================================
@@ -89,11 +134,11 @@ const PROGRAM_NAME = 'cxtms';
 const HELP_TEXT = `
 ${chalk_1.default.bold.cyan('╔═══════════════════════════════════════════════════════════════════════════╗')}
 ${chalk_1.default.bold.cyan('║')}                     ${chalk_1.default.bold.white('CX SCHEMA VALIDATOR')} ${chalk_1.default.gray(`v${VERSION}`)}                         ${chalk_1.default.bold.cyan('║')}
-${chalk_1.default.bold.cyan('║')}          ${chalk_1.default.gray('Unified validation for CargoXplorer YAML files')}               ${chalk_1.default.bold.cyan('║')}
+${chalk_1.default.bold.cyan('║')}          ${chalk_1.default.gray('Unified validation for CXTMS YAML files')}               ${chalk_1.default.bold.cyan('║')}
 ${chalk_1.default.bold.cyan('╚═══════════════════════════════════════════════════════════════════════════╝')}
 
 ${chalk_1.default.bold.yellow('DESCRIPTION:')}
-  Validates CargoXplorer YAML module and workflow files against JSON Schema
+  Validates CXTMS YAML module and workflow files against JSON Schema
   definitions. Provides detailed error feedback with examples and schema
   references to help fix validation issues.
 
@@ -116,7 +161,7 @@ ${chalk_1.default.bold.yellow('COMMANDS:')}
   ${chalk_1.default.green('orgs')}            List, select, or set active organization
   ${chalk_1.default.green('appmodule')}       Manage app modules on a CX server (deploy, undeploy)
   ${chalk_1.default.green('workflow')}        Manage workflows on a CX server (deploy, undeploy, execute, logs, log)
-  ${chalk_1.default.green('publish')}         Publish all modules and workflows to a CX server
+  ${chalk_1.default.green('deploy-all')}      Deploy all modules and workflows to a CX server
   ${chalk_1.default.green('app')}             Manage app manifests (install/upgrade from git, release to git, list)
   ${chalk_1.default.green('query')}           Run a GraphQL query against the CX server
   ${chalk_1.default.green('gql')}             Explore GraphQL schema (types, queries, mutations)
@@ -150,9 +195,9 @@ ${chalk_1.default.bold.yellow('OPTIONS:')}
   ${chalk_1.default.green('--console')}              Print workflow log to stdout
   ${chalk_1.default.green('--json')}                 Download JSON log instead of text
   ${chalk_1.default.green('-m, --message <msg>')}     Release message for app release (required)
-  ${chalk_1.default.green('-b, --branch <branch>')}   Branch override for app install/publish
-  ${chalk_1.default.green('--force')}                Force install (even if same version) or publish all
-  ${chalk_1.default.green('--skip-changed')}         Skip modules with unpublished changes during install
+  ${chalk_1.default.green('-b, --branch <branch>')}   Branch override for app install/release
+  ${chalk_1.default.green('--force')}                Force install (even if same version) or release all
+  ${chalk_1.default.green('--skip-changed')}         Skip modules with unreleased changes during install
 
 ${chalk_1.default.bold.yellow('VALIDATION EXAMPLES:')}
   ${chalk_1.default.gray('# Validate a module YAML file')}
@@ -283,16 +328,16 @@ ${chalk_1.default.bold.yellow('WORKFLOW COMMANDS:')}
   ${chalk_1.default.cyan(`${PROGRAM_NAME} workflow log <executionId> --json`)}            ${chalk_1.default.gray('# download JSON log (more detail)')}
   ${chalk_1.default.cyan(`${PROGRAM_NAME} workflow log <executionId> --json --console`)}  ${chalk_1.default.gray('# JSON log to stdout')}
 
-${chalk_1.default.bold.yellow('PUBLISH COMMANDS:')}
-  ${chalk_1.default.gray('# Publish all modules and workflows from current project')}
-  ${chalk_1.default.cyan(`${PROGRAM_NAME} publish`)}
+${chalk_1.default.bold.yellow('DEPLOY-ALL COMMANDS:')}
+  ${chalk_1.default.gray('# Deploy all modules and workflows from current project to the CX server')}
+  ${chalk_1.default.cyan(`${PROGRAM_NAME} deploy-all`)}
 
-  ${chalk_1.default.gray('# Publish only a specific feature directory')}
-  ${chalk_1.default.cyan(`${PROGRAM_NAME} publish --feature billing`)}
-  ${chalk_1.default.cyan(`${PROGRAM_NAME} publish billing`)}
+  ${chalk_1.default.gray('# Deploy only a specific feature directory')}
+  ${chalk_1.default.cyan(`${PROGRAM_NAME} deploy-all --feature billing`)}
+  ${chalk_1.default.cyan(`${PROGRAM_NAME} deploy-all billing`)}
 
-  ${chalk_1.default.gray('# Publish with explicit org ID')}
-  ${chalk_1.default.cyan(`${PROGRAM_NAME} publish --org 42`)}
+  ${chalk_1.default.gray('# Deploy with explicit org ID')}
+  ${chalk_1.default.cyan(`${PROGRAM_NAME} deploy-all --org 42`)}
 
 ${chalk_1.default.bold.yellow('APP COMMANDS:')}
   ${chalk_1.default.gray('# Install/refresh app from git repository into the CX server')}
@@ -319,7 +364,7 @@ ${chalk_1.default.bold.yellow('APP COMMANDS:')}
   ${chalk_1.default.cyan(`${PROGRAM_NAME} app release -m "Update billing" workflows/a.yaml modules/b.yaml`)}
 
   ${chalk_1.default.gray('# Force release all modules and workflows')}
-  ${chalk_1.default.cyan(`${PROGRAM_NAME} app release -m "Full republish" --force`)}
+  ${chalk_1.default.cyan(`${PROGRAM_NAME} app release -m "Full re-release" --force`)}
 
   ${chalk_1.default.gray('# List installed app manifests on the server')}
   ${chalk_1.default.cyan(`${PROGRAM_NAME} app list`)}
@@ -349,8 +394,8 @@ ${chalk_1.default.bold.yellow('GRAPHQL SCHEMA EXPLORATION:')}
   ${chalk_1.default.cyan(`${PROGRAM_NAME} gql type AuditChangeEntry`)}
 
 ${chalk_1.default.bold.yellow('VALIDATION TYPES:')}
-  ${chalk_1.default.bold('module')}     - CargoXplorer UI module definitions (components, routes, entities)
-  ${chalk_1.default.bold('workflow')}   - CargoXplorer workflow definitions (activities, tasks, triggers)
+  ${chalk_1.default.bold('module')}     - CXTMS UI module definitions (components, routes, entities)
+  ${chalk_1.default.bold('workflow')}   - CXTMS workflow definitions (activities, tasks, triggers)
   ${chalk_1.default.bold('auto')}       - Auto-detect based on file content (checks for 'workflow:' vs 'module:')
 
 ${chalk_1.default.bold.yellow('OUTPUT FORMATS:')}
@@ -521,9 +566,9 @@ repository: ""
 `;
 }
 function generateReadme() {
-    return `# CargoXplorer Application
+    return `# CXTMS Application
 
-This project contains CargoXplorer modules and workflows.
+This project contains CXTMS modules and workflows.
 
 ## Project Structure
 
@@ -590,15 +635,15 @@ npx cxtms example workflow
 
 ## Documentation
 
-- [CX Schema CLI Documentation](https://docs.cargoxplorer.com/docs/documents/cx-schema-cli)
-- [Module Development Guide](https://docs.cargoxplorer.com/docs/development/app-modules)
-- [Workflow Development Guide](https://docs.cargoxplorer.com/docs/development/workflows)
+- [CX Schema CLI Documentation](https://cxtms.com/docs/documents/cx-schema-cli)
+- [Module Development Guide](https://cxtms.com/docs/development/app-modules)
+- [Workflow Development Guide](https://cxtms.com/docs/development/workflows)
 `;
 }
 function generateAgentsMd() {
-    return `# AI Assistant Instructions for CargoXplorer Development
+    return `# AI Assistant Instructions for CXTMS Development
 
-This file provides instructions for AI assistants (like Claude, GPT, Copilot) when working with this CargoXplorer project.
+This file provides instructions for AI assistants (like Claude, GPT, Copilot) when working with this CXTMS project.
 
 ## Validation Commands
 
@@ -1477,9 +1522,9 @@ function runUpdate() {
 const CX_CLAUDE_MARKER = '<!-- cx-schema-instructions -->';
 function generateClaudeMdContent() {
     return `${CX_CLAUDE_MARKER}
-## CargoXplorer Project
+## CXTMS Project
 
-This is a CargoXplorer (CX) application. Modules and workflows are defined as YAML files validated against JSON schemas provided by \`@cxtms/cx-schema\`.
+This is a CXTMS (CX) application. Modules and workflows are defined as YAML files validated against JSON schemas provided by \`@cxtms/cx-schema\`.
 
 ### Project Structure
 
@@ -2834,7 +2879,7 @@ async function runPatSetup() {
         console.log(chalk_1.default.gray('  Or set `server` in app.yaml instead of CXTMS_SERVER.'));
     }
 }
-async function runPublish(featureDir, orgOverride) {
+async function runDeployAll(featureDir, orgOverride) {
     const session = resolveSession();
     const domain = session.domain;
     const token = session.access_token;
@@ -2848,7 +2893,7 @@ async function runPublish(featureDir, orgOverride) {
     const appYaml = yaml_1.default.parse(fs.readFileSync(appYamlPath, 'utf-8'));
     const appManifestId = appYaml?.id;
     const appName = appYaml?.name || 'unknown';
-    console.log(chalk_1.default.bold.cyan('\n  Publish\n'));
+    console.log(chalk_1.default.bold.cyan('\n  Deploy All\n'));
     console.log(chalk_1.default.gray(`  Server:  ${new URL(domain).hostname}`));
     console.log(chalk_1.default.gray(`  Org:     ${orgId}`));
     console.log(chalk_1.default.gray(`  App:     ${appName}`));
@@ -2858,7 +2903,7 @@ async function runPublish(featureDir, orgOverride) {
     console.log('');
     // Step 1: Create or update app manifest
     if (appManifestId) {
-        console.log(chalk_1.default.gray('  Publishing app manifest...'));
+        console.log(chalk_1.default.gray('  Deploying app manifest...'));
         try {
             const checkData = await graphqlRequest(domain, token, `
         query ($organizationId: Int!, $appManifestId: UUID!) {
@@ -2947,14 +2992,14 @@ async function runPublish(featureDir, orgOverride) {
     // Summary
     console.log('');
     if (failed === 0) {
-        console.log(chalk_1.default.green(`  ✓ Published ${succeeded} file(s) successfully\n`));
+        console.log(chalk_1.default.green(`  ✓ Deployed ${succeeded} file(s) successfully\n`));
     }
     else {
-        console.log(chalk_1.default.yellow(`  Published ${succeeded} file(s), ${failed} failed\n`));
+        console.log(chalk_1.default.yellow(`  Deployed ${succeeded} file(s), ${failed} failed\n`));
     }
 }
 // ============================================================================
-// App Manifest Commands (install from git, publish to git, list)
+// App Manifest Commands (install from git, release to git, list)
 // ============================================================================
 function readAppYaml() {
     const appYamlPath = path.join(process.cwd(), 'app.yaml');
@@ -3015,7 +3060,7 @@ async function runAppInstall(orgOverride, branch, force, skipChanged) {
         if (manifest) {
             console.log(chalk_1.default.green(`  ✓ Installed ${manifest.name} v${manifest.currentVersion}`));
             if (manifest.hasUnpublishedChanges) {
-                console.log(chalk_1.default.yellow(`    Has unpublished changes`));
+                console.log(chalk_1.default.yellow(`    Has unreleased changes`));
             }
         }
         else {
@@ -3028,7 +3073,7 @@ async function runAppInstall(orgOverride, branch, force, skipChanged) {
     }
     console.log('');
 }
-async function runAppPublish(orgOverride, message, branch, force, targetFiles) {
+async function runAppRelease(orgOverride, message, branch, force, targetFiles) {
     const session = resolveSession();
     const domain = session.domain;
     const token = session.access_token;
@@ -3081,15 +3126,15 @@ async function runAppPublish(orgOverride, message, branch, force, targetFiles) {
     }
     console.log('');
     try {
-        const publishValues = {
+        const releaseValues = {
             message: message || undefined,
             branch: branch || undefined,
             force: force || false,
         };
         if (workflowIds.length > 0)
-            publishValues.workflowIds = workflowIds;
+            releaseValues.workflowIds = workflowIds;
         if (moduleIds.length > 0)
-            publishValues.moduleIds = moduleIds;
+            releaseValues.moduleIds = moduleIds;
         const data = await graphqlRequest(domain, token, `
       mutation ($input: PublishAppManifestInput!) {
         publishAppManifest(input: $input) {
@@ -3105,19 +3150,19 @@ async function runAppPublish(orgOverride, message, branch, force, targetFiles) {
             input: {
                 organizationId: orgId,
                 appManifestId,
-                values: publishValues,
+                values: releaseValues,
             }
         });
         const manifest = data?.publishAppManifest?.appManifest;
         if (manifest) {
-            console.log(chalk_1.default.green(`  ✓ Published ${manifest.name} v${manifest.currentVersion}`));
+            console.log(chalk_1.default.green(`  ✓ Released ${manifest.name} v${manifest.currentVersion}`));
         }
         else {
-            console.log(chalk_1.default.green('  ✓ Publish completed'));
+            console.log(chalk_1.default.green('  ✓ Release completed'));
         }
     }
     catch (e) {
-        console.error(chalk_1.default.red(`  ✗ Publish failed: ${e.message}`));
+        console.error(chalk_1.default.red(`  ✗ Release failed: ${e.message}`));
         process.exit(1);
     }
     console.log('');
@@ -3157,7 +3202,7 @@ async function runAppList(orgOverride) {
             if (!app.isEnabled)
                 flags.push(chalk_1.default.red('disabled'));
             if (app.hasUnpublishedChanges)
-                flags.push(chalk_1.default.yellow('unpublished'));
+                flags.push(chalk_1.default.yellow('unreleased'));
             if (app.isUpdateAvailable)
                 flags.push(chalk_1.default.cyan('update available'));
             const flagStr = flags.length > 0 ? ` [${flags.join(', ')}]` : '';
@@ -3583,7 +3628,7 @@ function parseArgs(args) {
         reportFormat: 'json'
     };
     // Check for commands
-    const commands = ['validate', 'schema', 'example', 'list', 'help', 'version', 'report', 'init', 'create', 'extract', 'sync-schemas', 'install-skills', 'update', 'setup-claude', 'login', 'logout', 'pat', 'appmodule', 'orgs', 'workflow', 'publish', 'query', 'gql', 'app'];
+    const commands = ['validate', 'schema', 'example', 'list', 'help', 'version', 'report', 'init', 'create', 'extract', 'sync-schemas', 'install-skills', 'update', 'setup-claude', 'login', 'logout', 'pat', 'appmodule', 'orgs', 'workflow', 'deploy-all', 'query', 'gql', 'app'];
     if (args.length > 0 && commands.includes(args[0])) {
         command = args[0];
         args = args.slice(1);
@@ -4463,8 +4508,10 @@ async function validateFile(filePath, options, schemasPath) {
 // Main
 // ============================================================================
 async function main() {
+    checkForUpdates();
     const args = process.argv.slice(2);
     const { command, files, options } = parseArgs(args);
+    checkSkillsInstalled(command);
     // Handle help
     if (options.help) {
         if (command === 'schema') {
@@ -4599,9 +4646,9 @@ async function main() {
         }
         process.exit(0);
     }
-    // Handle publish command (no schemas needed)
-    if (command === 'publish') {
-        await runPublish(files[0] || options.feature, options.orgId);
+    // Handle deploy-all command (no schemas needed)
+    if (command === 'deploy-all') {
+        await runDeployAll(files[0] || options.feature, options.orgId);
         process.exit(0);
     }
     // Handle app command (no schemas needed)
@@ -4610,8 +4657,8 @@ async function main() {
         if (sub === 'install' || sub === 'upgrade') {
             await runAppInstall(options.orgId, options.branch, options.force, options.skipChanged);
         }
-        else if (sub === 'release' || sub === 'publish') {
-            await runAppPublish(options.orgId, options.message, options.branch, options.force, files.slice(1));
+        else if (sub === 'release') {
+            await runAppRelease(options.orgId, options.message, options.branch, options.force, files.slice(1));
         }
         else if (sub === 'list' || !sub) {
             await runAppList(options.orgId);