@signageos/cli 2.6.0 → 2.7.0

package/dist/Plugin/pluginCommand.d.ts

@@ -1,3 +1,34 @@
+/**
+ * Plugin management operations for developing and deploying signageOS plugins.
+ *
+ * Plugins extend native signageOS features and integrate with system policies.
+ * They run periodically to ensure configuration is consistently enforced on devices.
+ *
+ * Plugins must implement `set` and `get` methods.
+ * Upload reads `.sosconfig.json` for configuration.
+ *
+ * @group Development:102
+ *
+ * @example
+ * ```bash
+ * # Generate a new plugin project interactively
+ * sos plugin generate
+ *
+ * # Generate plugin with all parameters (non-interactive, suitable for CI/CD)
+ * sos plugin generate --name my-plugin --description "Custom functionality" --yes
+ *
+ * # Upload plugin to signageOS platform
+ * sos plugin upload
+ *
+ * # Upload plugin non-interactively (for CI/CD pipelines)
+ * sos plugin upload --yes
+ *
+ * # Upload with specific organization
+ * sos plugin upload --organization-uid abc123def456
+ * ```
+ *
+ * @since 2.6.0
+ */
 export declare const plugin: {
     name: "plugin";
     description: string;
@@ -5,9 +36,21 @@ export declare const plugin: {
     commands: ({
         name: "generate";
         description: string;
-        optionList: never[];
+        optionList: readonly [{
+            readonly name: "name";
+            readonly type: StringConstructor;
+            readonly description: "Plugin name";
+        }, {
+            readonly name: "description";
+            readonly type: StringConstructor;
+            readonly description: "Plugin description";
+        }, {
+            readonly name: "yes";
+            readonly type: BooleanConstructor;
+            readonly description: "Skip confirmation prompts and use provided values";
+        }];
         commands: never[];
-        run(): Promise<void>;
+        run(options: import("../Command/commandDefinition").CommandLineOptions<typeof import("./Generate/pluginGenerateOptions").OPTION_LIST>): Promise<void>;
     } | {
         name: "upload";
         description: string;
@@ -19,6 +62,10 @@ export declare const plugin: {
             readonly name: "organization-uid";
             readonly type: StringConstructor;
             readonly description: "Organization UID";
+        }, {
+            readonly name: "yes";
+            readonly type: BooleanConstructor;
+            readonly description: "Skip confirmation prompts for plugin or version creation";
         }];
         commands: never[];
         run(options: import("../Command/commandDefinition").CommandLineOptions<typeof import("./Upload/pluginUploadCommand").OPTION_LIST>): Promise<void>;

package/dist/Plugin/pluginCommand.js

@@ -13,6 +13,37 @@ exports.plugin = void 0;
 const commandDefinition_1 = require("../Command/commandDefinition");
 const pluginGenerateCommand_1 = require("./Generate/pluginGenerateCommand");
 const pluginUploadCommand_1 = require("./Upload/pluginUploadCommand");
+/**
+ * Plugin management operations for developing and deploying signageOS plugins.
+ *
+ * Plugins extend native signageOS features and integrate with system policies.
+ * They run periodically to ensure configuration is consistently enforced on devices.
+ *
+ * Plugins must implement `set` and `get` methods.
+ * Upload reads `.sosconfig.json` for configuration.
+ *
+ * @group Development:102
+ *
+ * @example
+ * ```bash
+ * # Generate a new plugin project interactively
+ * sos plugin generate
+ *
+ * # Generate plugin with all parameters (non-interactive, suitable for CI/CD)
+ * sos plugin generate --name my-plugin --description "Custom functionality" --yes
+ *
+ * # Upload plugin to signageOS platform
+ * sos plugin upload
+ *
+ * # Upload plugin non-interactively (for CI/CD pipelines)
+ * sos plugin upload --yes
+ *
+ * # Upload with specific organization
+ * sos plugin upload --organization-uid abc123def456
+ * ```
+ *
+ * @since 2.6.0
+ */
 exports.plugin = (0, commandDefinition_1.createCommandDefinition)({
     name: 'plugin',
     description: 'Plugin management',

package/dist/Plugin/pluginFacade.d.ts

@@ -2,7 +2,7 @@ import z from 'zod';
 import RestApi from '@signageos/sdk/dist/RestApi/RestApi';
 import { IPluginVersion } from '@signageos/sdk/dist/RestApi/Plugin/Version/IPluginVersion';
 import { PlatformConfig } from '../CustomScript/customScriptFacade';
-export declare function ensurePluginVersion(restApi: RestApi, config: PluginConfig, schema: any): Promise<import("@signageos/sdk/dist/RestApi/Plugin/Version/PluginVersion").PluginVersion>;
+export declare function ensurePluginVersion(restApi: RestApi, config: PluginConfig, schema: any, skipConfirmation?: boolean): Promise<import("@signageos/sdk/dist/RestApi/Plugin/Version/PluginVersion").PluginVersion>;
 export declare function uploadCode({ restApi, workDir, platform, config, pluginVersion, }: {
     restApi: RestApi;
     workDir: string;

package/dist/Plugin/pluginFacade.js

@@ -61,9 +61,9 @@ 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 ensurePluginVersion(restApi, config, schema) {
+function ensurePluginVersion(restApi, config, schema, skipConfirmation) {
     return __awaiter(this, void 0, void 0, function* () {
-        const plugin = yield ensurePlugin(restApi, config);
+        const plugin = yield ensurePlugin(restApi, config, skipConfirmation);
         const pluginVersion = yield restApi.plugin.version.get({
             pluginUid: plugin.uid,
             version: config.version,
@@ -71,15 +71,20 @@ function ensurePluginVersion(restApi, config, schema) {
         if (pluginVersion) {
             return pluginVersion;
         }
-        const response = yield (0, prompts_1.default)({
-            type: 'confirm',
-            name: 'newVersion',
-            message: `Do you want to create new plugin version ${config.version}?`,
-        });
-        if (!response.newVersion) {
-            throw new Error('Plugin version creation was canceled.');
+        if (skipConfirmation) {
+            (0, log_1.log)('info', chalk_1.default.yellow(`Creating Plugin version ${config.version}`));
+        }
+        else {
+            const response = yield (0, prompts_1.default)({
+                type: 'confirm',
+                name: 'newVersion',
+                message: `Do you want to create new plugin version ${config.version}?`,
+            });
+            if (!response.newVersion) {
+                throw new Error('Plugin version creation was canceled.');
+            }
+            (0, log_1.log)('info', chalk_1.default.yellow(`Creating Plugin version ${config.version}`));
         }
-        (0, log_1.log)('info', chalk_1.default.yellow(`Creating Plugin version ${config.version}`));
         return yield restApi.plugin.version.create({
             pluginUid: plugin.uid,
             version: config.version,
@@ -89,7 +94,7 @@ function ensurePluginVersion(restApi, config, schema) {
         });
     });
 }
-function ensurePlugin(restApi, config) {
+function ensurePlugin(restApi, config, skipConfirmation) {
     return __awaiter(this, void 0, void 0, function* () {
         if (config.uid) {
             const plugin = yield restApi.plugin.get(config.uid);
@@ -103,15 +108,20 @@ function ensurePlugin(restApi, config) {
             }
             throw new Error(`Plugin with uid "${config.uid}" not found`);
         }
-        const response = yield (0, prompts_1.default)({
-            type: 'confirm',
-            name: 'create',
-            message: `Plugin "${config.name}" does not exist. Do you want to create it?`,
-        });
-        if (!response.create) {
-            throw new Error('Plugin upload was canceled.');
+        if (skipConfirmation) {
+            (0, log_1.log)('info', chalk_1.default.yellow(`Creating Plugin "${config.name}"`));
+        }
+        else {
+            const response = yield (0, prompts_1.default)({
+                type: 'confirm',
+                name: 'create',
+                message: `Plugin "${config.name}" does not exist. Do you want to create it?`,
+            });
+            if (!response.create) {
+                throw new Error('Plugin upload was canceled.');
+            }
+            (0, log_1.log)('info', chalk_1.default.yellow(`Creating Plugin "${config.name}"`));
         }
-        (0, log_1.log)('info', chalk_1.default.yellow(`Creating Plugin "${config.name}"`));
         const createdPlugin = yield restApi.plugin.create({
             name: config.name,
             title: config.name,

package/dist/Runner/Generate/runnerGenerateCommand.d.ts

@@ -1,7 +1,41 @@
+import { CommandLineOptions } from '../../Command/commandDefinition';
+import { OPTION_LIST } from './runnerGenerateOptions';
+/**
+ * Generates a local repository for developing a Runner with boilerplate code and configuration files.
+ * Sets up complete development environment with necessary dependencies and project structure.
+ *
+ * Runs interactively by default or non-interactively with `--yes` option.
+ * Requires Git to be installed and accessible.
+ *
+ * @group Development:41
+ *
+ * @example
+ * ```bash
+ * # Generate runner project interactively
+ * sos runner generate
+ *
+ * # Generate non-interactively (suitable for CI/CD)
+ * sos runner generate --name my-runner --description "My custom runner" --yes
+ * ```
+ *
+ * @since 2.6.0
+ */
 export declare const runnerGenerate: {
     name: "generate";
     description: string;
-    optionList: never[];
+    optionList: readonly [{
+        readonly name: "name";
+        readonly type: StringConstructor;
+        readonly description: "Runner name";
+    }, {
+        readonly name: "description";
+        readonly type: StringConstructor;
+        readonly description: "Runner description";
+    }, {
+        readonly name: "yes";
+        readonly type: BooleanConstructor;
+        readonly description: "Skip confirmation prompts and use provided values";
+    }];
     commands: never[];
-    run(): Promise<void>;
+    run(options: CommandLineOptions<typeof OPTION_LIST>): Promise<void>;
 };

package/dist/Runner/Generate/runnerGenerateCommand.js

@@ -19,15 +19,37 @@ const commandDefinition_1 = require("../../Command/commandDefinition");
 const git_1 = require("../../Lib/git");
 const customScriptFacade_1 = require("../../CustomScript/customScriptFacade");
 const runnerGenerateFacade_1 = require("./runnerGenerateFacade");
+const runnerGenerateOptions_1 = require("./runnerGenerateOptions");
+/**
+ * Generates a local repository for developing a Runner with boilerplate code and configuration files.
+ * Sets up complete development environment with necessary dependencies and project structure.
+ *
+ * Runs interactively by default or non-interactively with `--yes` option.
+ * Requires Git to be installed and accessible.
+ *
+ * @group Development:41
+ *
+ * @example
+ * ```bash
+ * # Generate runner project interactively
+ * sos runner generate
+ *
+ * # Generate non-interactively (suitable for CI/CD)
+ * sos runner generate --name my-runner --description "My custom runner" --yes
+ * ```
+ *
+ * @since 2.6.0
+ */
 exports.runnerGenerate = (0, commandDefinition_1.createCommandDefinition)({
     name: 'generate',
     description: 'Generates a local repository for developing a Runner',
-    optionList: [],
+    optionList: runnerGenerateOptions_1.OPTION_LIST,
     commands: [],
-    run() {
+    run(options) {
         return __awaiter(this, void 0, void 0, function* () {
             yield (0, git_1.throwErrorIfGitNotInstalled)();
-            const { targetDir, name, description } = yield (0, runnerGenerateFacade_1.askForParameters)();
+            const skipConfirmation = !!options.yes;
+            const { targetDir, name, description } = yield (0, runnerGenerateFacade_1.askForParameters)(options, skipConfirmation);
             yield (0, runnerGenerateFacade_1.downloadBoilerplateCode)(targetDir);
             yield (0, customScriptFacade_1.addToConfigFile)(targetDir, { name, description });
             (0, log_1.log)('info', `Runner ${chalk_1.default.green(name)} has been generated in ${chalk_1.default.green(targetDir)}.`);

package/dist/Runner/Generate/runnerGenerateFacade.d.ts

@@ -1,10 +1,12 @@
+import { CommandLineOptions } from '../../Command/commandDefinition';
+import { OPTION_LIST } from './runnerGenerateOptions';
 /**
- * Prompts the user for the parameters needed to generate a runner.
+ * Prompts the user for the parameters needed to generate a custom script.
  */
-export declare function askForParameters(): Promise<{
-    targetDir: any;
-    name: any;
-    description: any;
+export declare function askForParameters(options?: CommandLineOptions<typeof OPTION_LIST>, skipConfirmation?: boolean): Promise<{
+    targetDir: string;
+    name: string;
+    description: string;
 }>;
 /**
  * Downloads the latest version of the boilerplate code from the GitHub repository.

package/dist/Runner/Generate/runnerGenerateFacade.js

@@ -54,39 +54,61 @@ const fs = __importStar(require("fs-extra"));
 const log_1 = require("@signageos/sdk/dist/Console/log");
 const git_1 = require("../../Lib/git");
 /**
- * Prompts the user for the parameters needed to generate a runner.
+ * Prompts the user for the parameters needed to generate a custom script.
  */
-function askForParameters() {
-    return __awaiter(this, void 0, void 0, function* () {
+function askForParameters(options_1) {
+    return __awaiter(this, arguments, void 0, function* (options, skipConfirmation = false) {
         const throwCanceledError = () => {
             throw new Error('Runner generation was canceled.');
         };
-        const { name, description } = yield (0, prompts_1.default)([
-            {
+        // Get values from CLI options if provided
+        const nameFromOptions = options === null || options === void 0 ? void 0 : options.name;
+        const descriptionFromOptions = options === null || options === void 0 ? void 0 : options.description;
+        // Determine which prompts are needed
+        const promisesToAsk = [];
+        if (!nameFromOptions) {
+            promisesToAsk.push({
                 type: 'text',
                 name: 'name',
                 message: 'Type name',
                 min: 1,
-            },
-            {
+            });
+        }
+        if (!descriptionFromOptions) {
+            promisesToAsk.push({
                 type: 'text',
                 name: 'description',
                 message: 'Type description',
                 min: 1,
-            },
-        ], { onCancel: throwCanceledError });
+            });
+        }
+        // Only prompt if we need values
+        let promptResults = {};
+        if (promisesToAsk.length > 0) {
+            if (skipConfirmation && (nameFromOptions || descriptionFromOptions)) {
+                // If in non-interactive mode but missing required parameters, throw error
+                throw new Error('Missing required parameters. In non-interactive mode (--yes), you must provide --name and --description options.');
+            }
+            promptResults = yield (0, prompts_1.default)(promisesToAsk, { onCancel: throwCanceledError });
+        }
+        // Use CLI options or prompt results
+        const name = nameFromOptions || promptResults.name;
+        const description = descriptionFromOptions || promptResults.description;
         const targetDir = name;
         (0, log_1.log)('info', `Generating Runner with these parameters:\n` +
             `  - Directory: ${chalk_1.default.green(targetDir)}\n` +
             `  - Name: ${chalk_1.default.green(name)}\n` +
             `  - Description: ${chalk_1.default.green(description)}\n`);
-        const { confirm } = yield (0, prompts_1.default)({
-            type: 'confirm',
-            name: 'confirm',
-            message: 'Confirm',
-        });
-        if (!confirm) {
-            throwCanceledError();
+        // Skip confirmation if in non-interactive mode
+        if (!skipConfirmation) {
+            const { confirm } = yield (0, prompts_1.default)({
+                type: 'confirm',
+                name: 'confirm',
+                message: 'Confirm',
+            });
+            if (!confirm) {
+                throwCanceledError();
+            }
         }
         return {
             targetDir,

package/dist/Runner/Generate/runnerGenerateOptions.d.ts

@@ -0,0 +1,13 @@
+export declare const OPTION_LIST: readonly [{
+    readonly name: "name";
+    readonly type: StringConstructor;
+    readonly description: "Runner name";
+}, {
+    readonly name: "description";
+    readonly type: StringConstructor;
+    readonly description: "Runner description";
+}, {
+    readonly name: "yes";
+    readonly type: BooleanConstructor;
+    readonly description: "Skip confirmation prompts and use provided values";
+}];

package/dist/Runner/Generate/runnerGenerateOptions.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPTION_LIST = void 0;
+exports.OPTION_LIST = [
+    {
+        name: 'name',
+        type: String,
+        description: 'Runner name',
+    },
+    {
+        name: 'description',
+        type: String,
+        description: 'Runner description',
+    },
+    {
+        name: 'yes',
+        type: Boolean,
+        description: 'Skip confirmation prompts and use provided values',
+    },
+];

package/dist/Runner/Upload/runnerUploadCommand.d.ts

@@ -7,7 +7,31 @@ export declare const OPTION_LIST: readonly [{
     readonly name: "organization-uid";
     readonly type: StringConstructor;
     readonly description: "Organization UID";
+}, {
+    readonly name: "yes";
+    readonly type: BooleanConstructor;
+    readonly description: "Skip confirmation prompts for runner or version creation";
 }];
+/**
+ * Uploads current runner version to the signageOS platform based on configuration
+ * and schema files in the current directory. Handles runner and version management automatically.
+ *
+ * May prompt for confirmation when creating new runners or versions.
+ * Use `--yes` to skip confirmation prompts for automated deployments.
+ *
+ * @group Development:42
+ *
+ * @example
+ * ```bash
+ * # Upload runner from current directory
+ * sos runner upload
+ *
+ * # Upload with specific organization, skip prompts
+ * sos runner upload --organization-uid abc123def456 --yes
+ * ```
+ *
+ * @since 2.6.0
+ */
 export declare const runnerUpload: {
     name: "upload";
     description: string;
@@ -19,6 +43,10 @@ export declare const runnerUpload: {
         readonly name: "organization-uid";
         readonly type: StringConstructor;
         readonly description: "Organization UID";
+    }, {
+        readonly name: "yes";
+        readonly type: BooleanConstructor;
+        readonly description: "Skip confirmation prompts for runner or version creation";
     }];
     commands: never[];
     run(options: CommandLineOptions<typeof OPTION_LIST>): Promise<void>;

package/dist/Runner/Upload/runnerUploadCommand.js

@@ -23,7 +23,35 @@ const organizationFacade_1 = require("../../Organization/organizationFacade");
 const runnerFacede_1 = require("../runnerFacede");
 const customScriptFacade_1 = require("../../CustomScript/customScriptFacade");
 const Debug = (0, debug_1.default)('@signageos/cli:Runner:Upload:Command');
-exports.OPTION_LIST = [organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION, organizationFacade_1.ORGANIZATION_UID_OPTION];
+exports.OPTION_LIST = [
+    organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION,
+    organizationFacade_1.ORGANIZATION_UID_OPTION,
+    {
+        name: 'yes',
+        type: Boolean,
+        description: 'Skip confirmation prompts for runner or version creation',
+    },
+];
+/**
+ * Uploads current runner version to the signageOS platform based on configuration
+ * and schema files in the current directory. Handles runner and version management automatically.
+ *
+ * May prompt for confirmation when creating new runners or versions.
+ * Use `--yes` to skip confirmation prompts for automated deployments.
+ *
+ * @group Development:42
+ *
+ * @example
+ * ```bash
+ * # Upload runner from current directory
+ * sos runner upload
+ *
+ * # Upload with specific organization, skip prompts
+ * sos runner upload --organization-uid abc123def456 --yes
+ * ```
+ *
+ * @since 2.6.0
+ */
 exports.runnerUpload = (0, commandDefinition_1.createCommandDefinition)({
     name: 'upload',
     description: 'Uploads current runner version',
@@ -37,7 +65,8 @@ exports.runnerUpload = (0, commandDefinition_1.createCommandDefinition)({
             const restApi = yield (0, helper_1.createOrganizationRestApi)(organization);
             const config = yield (0, customScriptFacade_1.getConfig)(currentDirectory);
             const schema = yield (0, runnerFacede_1.loadSchemas)(currentDirectory);
-            const runnerVersion = yield (0, runnerFacede_1.ensureRunnerVersion)(restApi, config, schema);
+            const skipConfirmation = !!options.yes;
+            const runnerVersion = yield (0, runnerFacede_1.ensureRunnerVersion)(restApi, config, schema, skipConfirmation);
             for (const platform of Object.keys(config.platforms)) {
                 const platformConfig = config.platforms[platform];
                 if (!platformConfig) {

package/dist/Runner/runnerCommand.d.ts

@@ -1,3 +1,26 @@
+/**
+ * Runner management operations for developing and deploying signageOS runners.
+ *
+ * Runners are designed for continuous execution as background processes on devices.
+ * Once activated, they run indefinitely with active health monitoring and automatic
+ * restart capabilities for stability.
+ *
+ * Runners must implement `run`, `set`, and `get` methods.
+ * Upload reads `.sosconfig.json` for configuration.
+ *
+ * @group Development:103
+ *
+ * @example
+ * ```bash
+ * # Generate new runner project
+ * sos runner generate --name my-runner --description "Background service" --yes
+ *
+ * # Upload runner to platform
+ * sos runner upload --yes
+ * ```
+ *
+ * @since 2.6.0
+ */
 export declare const runner: {
     name: "runner";
     description: string;
@@ -5,9 +28,21 @@ export declare const runner: {
     commands: ({
         name: "generate";
         description: string;
-        optionList: never[];
+        optionList: readonly [{
+            readonly name: "name";
+            readonly type: StringConstructor;
+            readonly description: "Runner name";
+        }, {
+            readonly name: "description";
+            readonly type: StringConstructor;
+            readonly description: "Runner description";
+        }, {
+            readonly name: "yes";
+            readonly type: BooleanConstructor;
+            readonly description: "Skip confirmation prompts and use provided values";
+        }];
         commands: never[];
-        run(): Promise<void>;
+        run(options: import("../Command/commandDefinition").CommandLineOptions<typeof import("./Generate/runnerGenerateOptions").OPTION_LIST>): Promise<void>;
     } | {
         name: "upload";
         description: string;
@@ -19,6 +54,10 @@ export declare const runner: {
             readonly name: "organization-uid";
             readonly type: StringConstructor;
             readonly description: "Organization UID";
+        }, {
+            readonly name: "yes";
+            readonly type: BooleanConstructor;
+            readonly description: "Skip confirmation prompts for runner or version creation";
         }];
         commands: never[];
         run(options: import("../Command/commandDefinition").CommandLineOptions<typeof import("./Upload/runnerUploadCommand").OPTION_LIST>): Promise<void>;

package/dist/Runner/runnerCommand.js

@@ -13,6 +13,29 @@ exports.runner = void 0;
 const commandDefinition_1 = require("../Command/commandDefinition");
 const runnerGenerateCommand_1 = require("./Generate/runnerGenerateCommand");
 const runnerUploadCommand_1 = require("./Upload/runnerUploadCommand");
+/**
+ * Runner management operations for developing and deploying signageOS runners.
+ *
+ * Runners are designed for continuous execution as background processes on devices.
+ * Once activated, they run indefinitely with active health monitoring and automatic
+ * restart capabilities for stability.
+ *
+ * Runners must implement `run`, `set`, and `get` methods.
+ * Upload reads `.sosconfig.json` for configuration.
+ *
+ * @group Development:103
+ *
+ * @example
+ * ```bash
+ * # Generate new runner project
+ * sos runner generate --name my-runner --description "Background service" --yes
+ *
+ * # Upload runner to platform
+ * sos runner upload --yes
+ * ```
+ *
+ * @since 2.6.0
+ */
 exports.runner = (0, commandDefinition_1.createCommandDefinition)({
     name: 'runner',
     description: 'Runner management',

package/dist/Runner/runnerFacede.d.ts

@@ -3,7 +3,7 @@ import { PlatformConfig } from '../CustomScript/customScriptFacade';
 import { IRunnerVersion } from '@signageos/sdk/dist/RestApi/Runner/Version/IRunnerVersion';
 import z from 'zod';
 import { ConfigSchema } from '../Plugin/pluginFacade';
-export declare function ensureRunnerVersion(restApi: RestApi, config: RunnerConfig, schema: any): Promise<IRunnerVersion>;
+export declare function ensureRunnerVersion(restApi: RestApi, config: RunnerConfig, schema: any, skipConfirmation?: boolean): Promise<IRunnerVersion>;
 export declare function uploadCode({ restApi, workDir, platform, config, runnerVersion, }: {
     restApi: RestApi;
     workDir: string;