@signageos/cli 2.7.1 → 2.9.0

package/dist/Organization/organizationFacade.js

@@ -31,26 +31,59 @@ exports.NO_DEFAULT_ORGANIZATION_OPTION = {
     description: 'Prevent using the defaultOrganizationUid from ~/.sosrc',
 };
 exports.ORGANIZATION_OPTIONS = [exports.ORGANIZATION_UID_OPTION, exports.NO_DEFAULT_ORGANIZATION_OPTION];
-function getOrganizationUidOrDefaultOrSelect(options) {
-    return __awaiter(this, void 0, void 0, function* () {
+function getOrganizationUidOrDefaultOrSelect(options_1) {
+    return __awaiter(this, arguments, void 0, function* (options, skipPrompts = false) {
         const config = yield (0, runControlHelper_1.loadConfig)();
         let organizationUid = options['organization-uid'];
         if (!organizationUid && !options['no-default-organization']) {
             organizationUid = config.defaultOrganizationUid;
         }
         if (!organizationUid) {
-            organizationUid = yield selectOrganizationUid(options);
-            if (organizationUid && !options['no-default-organization']) {
-                const response = yield (0, prompts_1.default)({
-                    type: 'confirm',
-                    name: 'setDefault',
-                    message: `Do you want to set the organization as a default for current profile?`,
-                    initial: false,
-                });
-                if (response.setDefault) {
-                    yield (0, runControlHelper_1.updateConfig)({
-                        defaultOrganizationUid: organizationUid,
+            // If skipPrompts is true (e.g., --yes flag), try to auto-select
+            if (skipPrompts) {
+                const organizations = yield getOrganizations();
+                if (organizations.length === 0) {
+                    throw new Error('No organizations available. Please ensure you have access to at least one organization.');
+                }
+                if (organizations.length === 1) {
+                    // Auto-select the only available organization
+                    const org = organizations[0]; // Safe: we just checked length === 1
+                    organizationUid = org.uid;
+                    console.info(chalk_1.default.yellow(`Auto-selected organization: ${org.title} (${org.name}, ${org.uid})`));
+                    // Set as default to avoid prompts in future
+                    if (!options['no-default-organization']) {
+                        yield (0, runControlHelper_1.updateConfig)({
+                            defaultOrganizationUid: organizationUid,
+                        });
+                        console.info(chalk_1.default.green('Organization has been set as default for current profile.'));
+                    }
+                }
+                else {
+                    // Multiple organizations available - cannot auto-select safely
+                    throw new Error(`Cannot auto-select organization: Multiple organizations available (${organizations.length} found).\n` +
+                        `Please specify one of the following:\n` +
+                        `  1. Use --organization-uid <uid> flag\n` +
+                        `  2. Set default organization: sos organization set-default\n` +
+                        `  3. Remove --yes flag for interactive selection\n\n` +
+                        `Available organizations:\n` +
+                        organizations.map((org) => `  - ${org.title} (${org.name}, ${org.uid})`).join('\n'));
+                }
+            }
+            else {
+                // Interactive mode - prompt user to select
+                organizationUid = yield selectOrganizationUid(options);
+                if (organizationUid && !options['no-default-organization']) {
+                    const response = yield (0, prompts_1.default)({
+                        type: 'confirm',
+                        name: 'setDefault',
+                        message: `Do you want to set the organization as a default for current profile?`,
+                        initial: false,
                     });
+                    if (response.setDefault) {
+                        yield (0, runControlHelper_1.updateConfig)({
+                            defaultOrganizationUid: organizationUid,
+                        });
+                    }
                 }
             }
         }
@@ -70,7 +103,11 @@ function selectOrganizationUid(options) {
                     title: `${org.title} (${org.name}, ${org.uid})`,
                     value: org.uid,
                 })),
+                suggest: helper_1.autocompleteSuggest,
             });
+            if (!response.organizationUid) {
+                throw new Error('Organization selection was cancelled');
+            }
             Debug('Organization selected', response.organizationUid);
             organizationUid = response.organizationUid;
         }

package/dist/Plugin/Upload/pluginUploadCommand.js

@@ -60,7 +60,8 @@ exports.pluginUpload = (0, commandDefinition_1.createCommandDefinition)({
     run(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const currentDirectory = process.cwd();
-            const organizationUid = yield (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options);
+            const skipPrompts = options.yes;
+            const organizationUid = yield (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options, skipPrompts);
             const organization = yield (0, organizationFacade_1.getOrganization)(organizationUid);
             const restApi = yield (0, helper_1.createOrganizationRestApi)(organization);
             const config = yield (0, customScriptFacade_1.getConfig)(currentDirectory);

package/dist/RunControl/runControlHelper.d.ts

@@ -1,6 +1,12 @@
 import { IConfig } from '@signageos/sdk/dist/SosHelper/sosControlHelper';
 /** The same as loadConfig in SDK, but respect CLI --profile argument */
-export declare function loadConfig(): Promise<IConfig & Required<Pick<IConfig, "apiUrl">>>;
+export declare function loadConfig(): Promise<{
+    apiUrl: string;
+    identification?: string;
+    apiSecurityToken?: string;
+    defaultOrganizationUid?: string;
+    emulatorUid?: string;
+}>;
 /** The same as saveConfig in SDK, but respect CLI --profile argument */
 export declare function saveConfig(newConfig: IConfig): Promise<void>;
 /** The same as updateConfig in SDK, but respect CLI --profile argument */

package/dist/RunControl/runControlHelper.js

@@ -18,7 +18,25 @@ const globalArgs_1 = require("../Command/globalArgs");
 function loadConfig() {
     return __awaiter(this, void 0, void 0, function* () {
         const profile = (0, globalArgs_1.getGlobalProfile)();
-        return yield (0, sosControlHelper_1.loadConfig)({ profile });
+        const config = yield (0, sosControlHelper_1.loadConfig)({ profile });
+        // Override with environment variables if they exist.
+        // When --profile is explicitly given, skip the SOS_API_URL override so the
+        // profile's own apiUrl is used instead of the ambient environment variable.
+        const envOverride = {};
+        if (process.env.SOS_API_IDENTIFICATION) {
+            envOverride.identification = process.env.SOS_API_IDENTIFICATION;
+        }
+        if (process.env.SOS_API_SECURITY_TOKEN) {
+            envOverride.apiSecurityToken = process.env.SOS_API_SECURITY_TOKEN;
+        }
+        if (process.env.SOS_ORGANIZATION_UID) {
+            envOverride.defaultOrganizationUid = process.env.SOS_ORGANIZATION_UID;
+        }
+        if (process.env.SOS_API_URL && !profile) {
+            envOverride.apiUrl = process.env.SOS_API_URL;
+        }
+        const finalConfig = Object.assign(Object.assign({}, config), envOverride);
+        return finalConfig;
     });
 }
 /** The same as saveConfig in SDK, but respect CLI --profile argument */

package/dist/Runner/Upload/runnerUploadCommand.js

@@ -60,7 +60,8 @@ exports.runnerUpload = (0, commandDefinition_1.createCommandDefinition)({
     run(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const currentDirectory = process.cwd();
-            const organizationUid = yield (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options);
+            const skipPrompts = options.yes;
+            const organizationUid = yield (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options, skipPrompts);
             const organization = yield (0, organizationFacade_1.getOrganization)(organizationUid);
             const restApi = yield (0, helper_1.createOrganizationRestApi)(organization);
             const config = yield (0, customScriptFacade_1.getConfig)(currentDirectory);

package/dist/Timing/List/timingListCommand.js

@@ -57,9 +57,7 @@ exports.timingList = (0, commandDefinition_1.createCommandDefinition)({
             const organization = yield (0, organizationFacade_1.getOrganization)(organizationUid);
             const restApi = yield (0, helper_1.createOrganizationRestApi)(organization);
             const deviceUid = yield (0, deviceFacade_1.getDeviceUid)(restApi, options);
-            const timings = yield restApi.timing.getList({
-                deviceUid,
-            });
+            const timings = yield restApi.timing.getList({ deviceUid });
             console.info(chalk_1.default.yellow(JSON.stringify(timings, undefined, 2)));
         });
     },

package/dist/helper.d.ts

@@ -1,3 +1,4 @@
+import prompts from 'prompts';
 import RestApi from '@signageos/sdk/dist/RestApi/RestApi';
 import { ApiVersions } from '@signageos/sdk/dist/RestApi/apiVersions';
 import { IConfig } from '@signageos/sdk/dist/SosHelper/sosControlHelper';
@@ -32,4 +33,22 @@ export declare function postResource(options: IOptions, path: string, query?: an
 export declare function putResource(options: IOptions, path: string, query?: any, data?: any): Promise<Response>;
 export declare function deleteResource(options: IOptions, path: string): Promise<Response>;
 export declare function deserializeJSON(_key: string, value: any): any;
+export declare function getErrorMessageFromUnknownError(error: unknown): unknown;
+/**
+ * Custom suggest function for autocomplete prompts.
+ * Searches in both the title (display text) and value (actual value) fields.
+ * This allows users to search by UID even when it's shown in parentheses in the title.
+ *
+ * @example
+ * ```typescript
+ * const response = await prompts({
+ *     type: 'autocomplete',
+ *     name: 'deviceUid',
+ *     message: 'Select device',
+ *     choices: devices.map(d => ({ title: `${d.name} (${d.uid})`, value: d.uid })),
+ *     suggest: autocompleteSuggest,
+ * });
+ * ```
+ */
+export declare function autocompleteSuggest<T extends prompts.Choice>(input: string, choices: T[]): Promise<T[]>;
 export {};

package/dist/helper.js

@@ -25,6 +25,8 @@ exports.postResource = postResource;
 exports.putResource = putResource;
 exports.deleteResource = deleteResource;
 exports.deserializeJSON = deserializeJSON;
+exports.getErrorMessageFromUnknownError = getErrorMessageFromUnknownError;
+exports.autocompleteSuggest = autocompleteSuggest;
 const querystring_1 = require("querystring");
 const RestApi_1 = __importDefault(require("@signageos/sdk/dist/RestApi/RestApi"));
 const runControlHelper_1 = require("./RunControl/runControlHelper");
@@ -38,11 +40,18 @@ function loadApiUrl() {
     });
 }
 function getApiUrl(config) {
-    const apiUrl = (0, globalArgs_1.getGlobalApiUrl)() || config.apiUrl;
-    if (!apiUrl) {
+    // Precedence:
+    // 1. Explicit global CLI argument (--api-url)
+    // 2. Environment variable (SOS_API_URL) - for CI/CD and testing
+    // 3. Stored profile configuration (config.apiUrl from ~/.sosrc)
+    const cliUrl = (0, globalArgs_1.getGlobalApiUrl)();
+    const profileUrl = config.apiUrl;
+    const rawApiUrl = cliUrl || profileUrl;
+    if (!rawApiUrl) {
         throw new Error(`No API URL is defined. Please use --api-url or set SOS_API_URL environment variable.`);
     }
-    return apiUrl;
+    // Normalize: remove trailing slashes to avoid double '//'
+    return rawApiUrl.replace(/\/+$/, '');
 }
 function createClientVersions() {
     return {
@@ -115,3 +124,36 @@ function deserializeJSON(_key, value) {
     }
     return value;
 }
+function getErrorMessageFromUnknownError(error) {
+    if (error) {
+        if (typeof error === 'object' && 'message' in error) {
+            return error.message;
+        }
+        else {
+            return `${error}`;
+        }
+    }
+    else {
+        return null;
+    }
+}
+/**
+ * Custom suggest function for autocomplete prompts.
+ * Searches in both the title (display text) and value (actual value) fields.
+ * This allows users to search by UID even when it's shown in parentheses in the title.
+ *
+ * @example
+ * ```typescript
+ * const response = await prompts({
+ *     type: 'autocomplete',
+ *     name: 'deviceUid',
+ *     message: 'Select device',
+ *     choices: devices.map(d => ({ title: `${d.name} (${d.uid})`, value: d.uid })),
+ *     suggest: autocompleteSuggest,
+ * });
+ * ```
+ */
+function autocompleteSuggest(input, choices) {
+    const searchTerm = input.toLowerCase();
+    return Promise.resolve(choices.filter((choice) => { var _a, _b; return ((_a = choice.title) === null || _a === void 0 ? void 0 : _a.toLowerCase().includes(searchTerm)) || ((_b = choice.value) === null || _b === void 0 ? void 0 : _b.toLowerCase().includes(searchTerm)); }));
+}

package/dist/parameters.d.ts

@@ -4,7 +4,6 @@ export declare const parameters: {
     version: any;
     profile: string | undefined;
     apiUrl: string;
-    boxHost: string;
     forwardServerUrl: string | undefined;
     applet: {
         uid: string | undefined;

package/dist/parameters.js

@@ -7,7 +7,9 @@ const dotenv = require('dotenv');
 const packageConfig = require('../package.json');
 const environment = process.env.NODE_ENV || 'dev';
 const rootPath = path.normalize(__dirname + '/..');
-dotenv.config({ path: path.join(rootPath, '.env') });
+// Load environment-specific .env file
+const envFile = environment === 'test' ? '.env.test' : '.env';
+dotenv.config({ path: path.join(rootPath, envFile) });
 const configurableEnvVars = [
     'SOS_PROFILE',
     'SOS_API_IDENTIFICATION',
@@ -23,20 +25,15 @@ for (const envVar of configurableEnvVars) {
     }
 }
 const apiUrl = process.env.SOS_API_URL;
-const boxHost = process.env.SOS_BOX_HOST;
 if (!apiUrl) {
     throw new Error(`Environment variable SOS_API_URL is required`);
 }
-if (!boxHost) {
-    throw new Error(`Environment variable SOS_BOX_HOST is required`);
-}
 exports.parameters = {
     environment,
     name: packageConfig.name,
     version: packageConfig.version,
     profile: process.env.SOS_PROFILE,
     apiUrl,
-    boxHost,
     forwardServerUrl: process.env.SOS_FORWARD_SERVER_URL,
     applet: {
         uid: process.env.SOS_APPLET_UID,

package/docs/applet/upload/index.md

@@ -51,14 +51,28 @@ sos applet upload --entry-file-path src/main.js
 # Upload with organization override
 sos applet upload --organization-uid abc123def456
 
-# Skip confirmation prompts
+# Skip confirmation prompts (auto-selects if only 1 org available)
 sos applet upload --yes
 
+# CI/CD: Non-interactive upload with specific organization
+sos applet upload --yes --organization-uid abc123def456
+
 # Verbose output with detailed file information
 sos applet upload --verbose
 
 # Update package.json with new applet UID
 sos applet upload --update-package-config
+
+# Complete CI/CD example
+sos applet upload --yes --organization-uid abc123def456 --update-package-config
+```
+
+**Note for CI/CD and --yes flag:**
+When using `--yes` with multiple organizations:
+- If you have only 1 organization: it will be auto-selected
+- If you have multiple organizations: you MUST specify `--organization-uid`
+- Alternative: Set a default organization with `sos organization set-default`
+
 ```
 
 ## Advanced Usage

package/docs/index.md

@@ -32,6 +32,19 @@ npm install -g @signageos/cli
 2. **Generate a new applet**: `sos applet generate --name my-applet`
 3. **Start development**: `cd my-applet && sos applet start`
 
+### Local Configuration
+
+You can create a `sos.config.local.json` file in your applet directory to provide configuration values during local development:
+
+```json
+{
+  "myConfigKey": "myConfigValue",
+  "anotherSetting": true
+}
+```
+
+This configuration is automatically loaded when running `sos applet start` and passed to your applet, making it easy to test different configuration scenarios without deploying to a device.
+
 ## Usage
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/cli",
-  "version": "2.7.1",
+  "version": "2.9.0",
   "main": "./dist/index.js",
   "author": "signageOS.io <dev@signageos.io>",
   "files": [
@@ -21,13 +21,17 @@
     "clean-build": "npm run clean && npm run build",
     "watch": "tsc --watch",
     "check-types": "tsc --noEmit",
-    "test": "env NODE_ENV=test mocha",
-    "test:coverage": "c8 npm run test",
-    "test:windows": "cross-env NODE_ENV=test mocha",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "lint:prettier": "prettier  \"(src|tests|tools)/**/*.+(ts|tsx|json|js)\" --check",
     "lint:prettier:fix": "prettier  \"(src|tests|tools)/**/*.+(ts|tsx|json|js)\" --write",
+    "test": "npm run test:unit && npm run test:integration",
+    "test:coverage": "c8 npm run test:all",
+    "test:unit": "env NODE_ENV=test mocha",
+    "test:unit:windows": "cross-env NODE_ENV=test mocha",
+    "test:integration": "npm run clean-build && env NODE_ENV=test mocha --config .mocharc.integration.json",
+    "test:integration:windows": "npm run build && cross-env NODE_ENV=test mocha --config .mocharc.integration.json",
+    "test:integration:generate": "env NODE_ENV=test mocha --config .mocharc.integration.json --grep appletGenerateCommand",
     "test:node-versions": "./tests/integration/test-node-versions.sh",
     "test:integration:node-versions": "env NODE_ENV=test mocha --config .mocharc.node-versions.json",
     "generate:dummy-applet": "node ./tools/generate-dummy-applet.mjs",
@@ -49,7 +53,7 @@
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "1.0.2",
-    "@signageos/codestyle": "2.0.3",
+    "@signageos/codestyle": "2.1.0",
     "@types/archiver": "6.0.3",
     "@types/child-process-promise": "2.2.6",
     "@types/cli-progress": "3.11.6",
@@ -81,7 +85,7 @@
   },
   "dependencies": {
     "@signageos/file": "2.0.1",
-    "@signageos/sdk": "2.0.2",
+    "@signageos/sdk": "2.3.0",
     "archiver": "7.0.1",
     "chalk": "2.4.2",
     "child-process-promise": "2.1.3",
@@ -92,7 +96,7 @@
     "debug": "4.4.0",
     "dotenv": "16.5.0",
     "express": "5.1.0",
-    "fs-extra": "11.3.0",
+    "fs-extra": "11.3.2",
     "internal-ip": "8.0.0",
     "markdown-table": "3.0.4",
     "mime": "2.4.4",