@signageos/cli 2.7.1 → 2.8.0

package/README.md

@@ -175,6 +175,18 @@ sos applet start
 | --detach *(optional)* | Run the applet HTTP server in the background (detached process) | false |
 | --forward-server-url *(optional)* | Custom forward server URL for `sos device connect` command. | https://forward.signageos.io |
 
+##### Local Configuration
+You can create a `sos.config.local.json` file in your applet directory to provide configuration values during local development. This file is automatically loaded when running `sos applet start` and passed to your applet as configuration.
+
+```json
+{
+  "myConfigKey": "myConfigValue",
+  "anotherSetting": true
+}
+```
+
+This is useful for testing your applet with different configuration values without having to deploy it to a device.
+
 #### Applet Tests Upload
 ```bash
 sos applet test upload

package/dist/Applet/Generate/appletGenerateCommand.js

@@ -413,11 +413,15 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
                 path: path.join(appletRootDirectory, '.sosignore'),
                 content: 'node_modules/\n',
             });
+            generateFiles.push({
+                path: path.join(appletRootDirectory, 'sos.config.local.json'),
+                content: '{}\n',
+            });
             // Initialise git repository
             if (git === GitOptions.Yes && gitFound) {
                 generateFiles.push({
                     path: path.join(appletRootDirectory, '.gitignore'),
-                    content: 'node_modules/\n./dist',
+                    content: 'node_modules/\n./dist\nsos.config.local.json',
                 });
                 yield (0, git_1.initGitRepository)(appletRootDirectory, true).catch((error) => {
                     console.error(`Git repository initialization failed: ${error}`);

package/dist/Emulator/emulatorFactory.js

@@ -57,8 +57,10 @@ const fsExtra = __importStar(require("fs-extra"));
 const chalk_1 = __importDefault(require("chalk"));
 const log_1 = require("@signageos/sdk/dist/Console/log");
 const fileSystem_1 = require("../Lib/fileSystem");
+const helper_1 = require("../helper");
 const DUMMY_CHECKSUM = '0000000000ffffffffff';
 const APPLET_DIRECTORY_PATH = '/applet';
+const SOS_CONFIG_LOCAL_FILENAME = 'sos.config.local.json';
 function createEmulator(params, organizationUid, dev) {
     return __awaiter(this, void 0, void 0, function* () {
         const { appletUid, appletVersion, emulatorServerPort, appletPath, entryFileRelativePath } = params;
@@ -84,6 +86,7 @@ function createEmulator(params, organizationUid, dev) {
                 res.redirect(`${req.originalUrl}${req.originalUrl.includes('?') ? '&' : '?'}duid=${params.emulatorUid}`);
             }
             else {
+                const localConfig = loadSosLocalConfig(appletPath);
                 const page = fsExtra.readFileSync(path.join(frontDisplayDistPath, 'index.html')).toString();
                 const script = `
 <script>
@@ -91,6 +94,7 @@ function createEmulator(params, organizationUid, dev) {
 	window.__SOS_BUNDLED_APPLET.binaryFile = location.origin + ${JSON.stringify(envVars.binaryFilePath)};
 	window.__SOS_BUNDLED_APPLET.uid = ${JSON.stringify(envVars.uid)};
 	window.__SOS_BUNDLED_APPLET.version = ${JSON.stringify(envVars.version)};
+	window.__SOS_BUNDLED_APPLET.config = ${JSON.stringify(localConfig)};
 	window.__SOS_BUNDLED_APPLET.checksum = ${JSON.stringify(envVars.checksum)};
 	window.__SOS_BUNDLED_APPLET.frontAppletVersion = ${JSON.stringify(envVars.frontAppletVersion)};
 	window.__SOS_BUNDLED_APPLET.frontAppletBinaryFile = ${JSON.stringify(envVars.frontAppletBinaryFile)};
@@ -139,3 +143,17 @@ function createEmulator(params, organizationUid, dev) {
         };
     });
 }
+function loadSosLocalConfig(appletPath) {
+    const sosConfigLocalPath = path.join(appletPath, SOS_CONFIG_LOCAL_FILENAME);
+    if (fsExtra.existsSync(sosConfigLocalPath)) {
+        try {
+            const configContent = fsExtra.readFileSync(sosConfigLocalPath, 'utf8');
+            (0, log_1.log)('info', `Loaded local config from ${SOS_CONFIG_LOCAL_FILENAME}`);
+            return JSON.parse(configContent);
+        }
+        catch (error) {
+            (0, log_1.log)('warning', `Failed to load ${SOS_CONFIG_LOCAL_FILENAME}: ${(0, helper_1.getErrorMessageFromUnknownError)(error)}`);
+        }
+    }
+    return {};
+}

package/dist/helper.d.ts

@@ -32,4 +32,5 @@ 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;
 export {};

package/dist/helper.js

@@ -25,6 +25,7 @@ exports.postResource = postResource;
 exports.putResource = putResource;
 exports.deleteResource = deleteResource;
 exports.deserializeJSON = deserializeJSON;
+exports.getErrorMessageFromUnknownError = getErrorMessageFromUnknownError;
 const querystring_1 = require("querystring");
 const RestApi_1 = __importDefault(require("@signageos/sdk/dist/RestApi/RestApi"));
 const runControlHelper_1 = require("./RunControl/runControlHelper");
@@ -115,3 +116,16 @@ 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;
+    }
+}

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.8.0",
   "main": "./dist/index.js",
   "author": "signageOS.io <dev@signageos.io>",
   "files": [