@signageos/cli 2.5.1 → 2.6.0

package/dist/Runner/runnerFacede.js

@@ -0,0 +1,234 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureRunnerVersion = ensureRunnerVersion;
+exports.uploadCode = uploadCode;
+exports.loadSchemas = loadSchemas;
+const path = __importStar(require("path"));
+const os = __importStar(require("os"));
+const fs = __importStar(require("fs-extra"));
+const prompts_1 = __importDefault(require("prompts"));
+const chalk_1 = __importDefault(require("chalk"));
+const log_1 = require("@signageos/sdk/dist/Console/log");
+const archive_1 = require("../Lib/archive");
+const fileSystem_1 = require("../Lib/fileSystem");
+const runtimeFileSystem_1 = require("@signageos/sdk/dist/Development/runtimeFileSystem");
+const customScriptFacade_1 = require("../CustomScript/customScriptFacade");
+const PLUGIN_BUILDS_DIRNAME = 'plugin_builds';
+function ensureRunnerVersion(restApi, config, schema) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const runner = yield ensureRunner(restApi, config);
+        const runnerVersion = yield restApi.runner.version.get({ runnerUid: runner.uid, version: config.version });
+        if (runnerVersion) {
+            return runnerVersion;
+        }
+        const response = yield (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'newVersion',
+            message: `Do you want to create new runner version ${config.version}?`,
+        });
+        if (!response.newVersion) {
+            throw new Error('Runner version creation was canceled.');
+        }
+        (0, log_1.log)('info', chalk_1.default.yellow(`Creating Runner version ${config.version}`));
+        return yield restApi.runner.version.create({
+            runnerUid: runner.uid,
+            version: config.version,
+            description: config.description,
+            input: schema.input,
+            output: schema.output,
+            telemetry: schema.telemetry,
+            configDefinition: config.configDefinition,
+        });
+    });
+}
+function ensureRunner(restApi, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (config.uid) {
+            const runner = yield restApi.runner.get(config.uid);
+            if (runner) {
+                yield restApi.runner.update(runner.uid, {
+                    name: config.name,
+                    title: config.name,
+                    description: config.description,
+                });
+                return runner;
+            }
+            throw new Error(`Runner with uid "${config.uid}" not found`);
+        }
+        const response = yield (0, prompts_1.default)({
+            type: 'confirm',
+            name: 'create',
+            message: `Runner "${config.name}" does not exist. Do you want to create it?`,
+        });
+        if (!response.create) {
+            throw new Error('Runner upload was canceled.');
+        }
+        (0, log_1.log)('info', chalk_1.default.yellow(`Creating Runner "${config.name}"`));
+        const createdRunner = yield restApi.runner.create({
+            name: config.name,
+            title: config.name,
+            description: config.description,
+        });
+        // TODO ask for permission or read from CLI arg
+        (0, log_1.log)('info', chalk_1.default.yellow('Adding Runner uid to the config file'));
+        yield (0, customScriptFacade_1.addToConfigFile)(process.cwd(), { uid: createdRunner.uid });
+        return createdRunner;
+    });
+}
+function uploadCode(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ restApi, workDir, platform, config, runnerVersion, }) {
+        const { mainFile, runtime } = config;
+        const codeArchive = yield generateRunnerPlatformCodeArchive(workDir, config, runnerVersion, platform);
+        const runnerVersionPlatform = yield restApi.runner.version.platform.get({
+            runnerUid: runnerVersion.runnerUid,
+            version: runnerVersion.version,
+            platform,
+        });
+        if ((runnerVersionPlatform === null || runnerVersionPlatform === void 0 ? void 0 : runnerVersionPlatform.md5Checksum) === codeArchive.md5Checksum) {
+            (0, log_1.log)('info', chalk_1.default.yellow(`Skipping upload for ${platform} - no changes detected`));
+            return;
+        }
+        try {
+            (0, log_1.log)('info', chalk_1.default.yellow(`Uploading files for ${platform}`));
+            yield uploadCodeArchive({
+                restApi,
+                runnerVersion,
+                platform,
+                codeArchive,
+            });
+            yield restApi.runner.version.platform.update({
+                runnerUid: runnerVersion.runnerUid,
+                version: runnerVersion.version,
+                platform,
+                mainFile,
+                runtime,
+                md5Checksum: codeArchive.md5Checksum,
+            });
+        }
+        finally {
+            yield codeArchive.delete();
+        }
+    });
+}
+function uploadCodeArchive(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ restApi, runnerVersion, platform, codeArchive, }) {
+        const filePath = codeArchive.filePath;
+        const fileSize = (yield fs.stat(filePath)).size;
+        const fileStream = fs.createReadStream(filePath);
+        yield restApi.runner.version.platform.archive.upload({
+            runnerUid: runnerVersion.runnerUid,
+            version: runnerVersion.version,
+            platform,
+            md5Checksum: codeArchive.md5Checksum,
+            size: fileSize,
+            stream: fileStream,
+        });
+    });
+}
+/**
+ * Generates an archive with the code for a particular platform, defined by the provided configuration.
+ *
+ * Archive is generated and stored in the runtime /tmp/signageos/runner_scripts_builds/:uid/:version/ directory.
+ * After archive isn't needed anymore, it should be deleted using the delete method.
+ */
+function generateRunnerPlatformCodeArchive(workDir, config, runnerVersion, platform) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const buildsDir = yield ensureBuildsDirectory(runnerVersion);
+        const archiveFileName = `${platform}.zip`;
+        const archiveFilePath = path.join(buildsDir, archiveFileName);
+        yield (0, archive_1.generateZip)(workDir, config.rootDir, archiveFilePath);
+        const md5Checksum = yield (0, fileSystem_1.getFileMD5Checksum)(archiveFilePath);
+        return {
+            filePath: archiveFilePath,
+            md5Checksum,
+            delete() {
+                return __awaiter(this, void 0, void 0, function* () {
+                    yield fs.unlink(archiveFilePath);
+                });
+            },
+        };
+    });
+}
+/**
+ * Ensure that the runtime directory for runner script version exists in the current working directory.
+ *
+ * This directory is used to store temporary files generated by the CLI.
+ */
+function ensureBuildsDirectory(runnerVersion) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const runtimeDir = yield ensureRuntimeDir();
+        const buildsDir = path.join(runtimeDir, runnerVersion.runnerUid, runnerVersion.version);
+        yield fs.ensureDir(buildsDir);
+        return buildsDir;
+    });
+}
+/**
+ * Ensure that the runtime directory exists in the current working directory.
+ *
+ * This directory is used to store temporary files generated by the CLI.
+ */
+function ensureRuntimeDir() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const runtimeDir = path.join(os.tmpdir(), runtimeFileSystem_1.RUNTIME_DIRNAME, PLUGIN_BUILDS_DIRNAME);
+        yield fs.ensureDir(runtimeDir);
+        return runtimeDir;
+    });
+}
+function loadSchemas(workDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const filePath = getConfigFilePath(workDir);
+        if (!(yield fs.pathExists(filePath))) {
+            throw new Error(`Config file schema.json not found`);
+        }
+        const fileContent = fs.readFileSync(filePath, 'utf-8');
+        return JSON.parse(fileContent);
+    });
+}
+function getConfigFilePath(workDir) {
+    return path.join(workDir, 'schema.json');
+}

package/dist/index.js

@@ -20,6 +20,8 @@ const deviceCommand_1 = require("./Device/deviceCommand");
 const generalCommand_1 = require("./generalCommand");
 const commandDefinition_1 = require("./Command/commandDefinition");
 const customScriptCommand_1 = require("./CustomScript/customScriptCommand");
+const pluginCommand_1 = require("./Plugin/pluginCommand");
+const runnerCommand_1 = require("./Runner/runnerCommand");
 const autocompleteCommand_1 = require("./Command/Autocomplete/autocompleteCommand");
 /**
  * The root command for the signageOS CLI tool that provides comprehensive management
@@ -47,7 +49,7 @@ const index = (0, commandDefinition_1.createCommandDefinition)({
     name: 'sos',
     description: 'SignageOS CLI - The central command-line tool for deploying, managing, and debugging signageOS projects and devices',
     optionList: generalCommand_1.GENERAL_OPTION_LIST,
-    commands: [appletCommand_1.applet, loginCommand_1.login, organizationCommand_1.organization, timingCommand_1.timing, firmwareCommand_1.firmware, deviceCommand_1.device, customScriptCommand_1.customScript, autocompleteCommand_1.autocomplete],
+    commands: [appletCommand_1.applet, loginCommand_1.login, organizationCommand_1.organization, timingCommand_1.timing, firmwareCommand_1.firmware, deviceCommand_1.device, customScriptCommand_1.customScript, pluginCommand_1.plugin, runnerCommand_1.runner, autocompleteCommand_1.autocomplete],
     run() {
         return __awaiter(this, void 0, void 0, function* () {
             throw new Error('Unknown command');

package/docs/index.md

@@ -161,6 +161,8 @@ sos --api-url https://api.custom.signageos.io applet list
 - [`sos timing`](/cli/timing/) - Timing management
 - [`sos device`](/cli/device/) - Device management
 - [`sos custom-script`](/cli/custom-script/) - Custom Script management
+- [`sos plugin`](/cli/plugin/) - Plugin management
+- [`sos runner`](/cli/runner/) - Runner management
 - [`sos autocomplete`](/cli/autocomplete/) - CLI auto-completion management
 
 ## See Also

package/docs/plugin/generate/index.md

@@ -0,0 +1,43 @@
+---
+id: plugin-generate-index
+title: generate
+sidebar_position: 0
+---
+# generate
+
+Generates a local repository for developing a Plugin
+
+
+## Usage
+
+```bash
+sos plugin generate [options]
+```
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```

package/docs/plugin/index.md

@@ -0,0 +1,72 @@
+---
+id: plugin-index
+title: plugin
+sidebar_position: 0
+---
+# plugin
+
+Plugin management
+
+
+## Usage
+
+```bash
+sos plugin <subcommand> [options]
+```
+
+## Subcommands
+
+### generate
+
+Generates a local repository for developing a Plugin
+
+```bash
+sos plugin generate [options]
+```
+
+[→ See detailed documentation](/cli/plugin/generate/)
+
+### upload
+
+Uploads current plugin version
+
+```bash
+sos plugin upload [options]
+```
+
+[→ See detailed documentation](/cli/plugin/upload/)
+
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```
+
+
+## Related Commands
+
+- [`sos plugin generate`](/cli/plugin/generate/) - Generates a local repository for developing a Plugin
+- [`sos plugin upload`](/cli/plugin/upload/) - Uploads current plugin version

package/docs/plugin/upload/index.md

@@ -0,0 +1,50 @@
+---
+id: plugin-upload-index
+title: upload
+sidebar_position: 0
+---
+# upload
+
+Uploads current plugin version
+
+
+## Usage
+
+```bash
+sos plugin upload [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```

package/docs/runner/generate/index.md

@@ -0,0 +1,43 @@
+---
+id: runner-generate-index
+title: generate
+sidebar_position: 0
+---
+# generate
+
+Generates a local repository for developing a Runner
+
+
+## Usage
+
+```bash
+sos runner generate [options]
+```
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```

package/docs/runner/index.md

@@ -0,0 +1,72 @@
+---
+id: runner-index
+title: runner
+sidebar_position: 0
+---
+# runner
+
+Runner management
+
+
+## Usage
+
+```bash
+sos runner <subcommand> [options]
+```
+
+## Subcommands
+
+### generate
+
+Generates a local repository for developing a Runner
+
+```bash
+sos runner generate [options]
+```
+
+[→ See detailed documentation](/cli/runner/generate/)
+
+### upload
+
+Uploads current runner version
+
+```bash
+sos runner upload [options]
+```
+
+[→ See detailed documentation](/cli/runner/upload/)
+
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```
+
+
+## Related Commands
+
+- [`sos runner generate`](/cli/runner/generate/) - Generates a local repository for developing a Runner
+- [`sos runner upload`](/cli/runner/upload/) - Uploads current runner version

package/docs/runner/upload/index.md

@@ -0,0 +1,50 @@
+---
+id: runner-upload-index
+title: upload
+sidebar_position: 0
+---
+# upload
+
+Uploads current runner version
+
+
+## Usage
+
+```bash
+sos runner upload [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/cli",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "main": "./dist/index.js",
   "author": "signageOS.io <dev@signageos.io>",
   "files": [
@@ -78,16 +78,12 @@
     "typescript": "5.8.3",
     "unzipper": "0.12.3"
   },
-  "overrides": {
-    "cross-spawn": "^7.0.6",
-    "http-cache-semantics": "^4.2.0"
-  },
   "dependencies": {
-    "@signageos/file": "1.0.1",
-    "@signageos/sdk": "1.28.1",
+    "@signageos/file": "2.0.1",
+    "@signageos/sdk": "2.0.2",
     "archiver": "7.0.1",
     "chalk": "2.4.2",
-    "child-process-promise": "2.2.1",
+    "child-process-promise": "2.1.3",
     "cli-progress": "3.12.0",
     "command-line-args": "6.0.1",
     "command-line-usage": "7.0.3",