@signageos/cli 2.3.2 → 2.4.0

package/README.md

@@ -1,4 +1,4 @@
-# CLI program
+# signageOS CLI
 
 signageOS command-line interface which helps you develop your applets locally and manage devices from terminal.
 
@@ -12,6 +12,39 @@ sos --help
 cli tool allows you to run commands interactively for best user experience, please use standard bash terminal on *nix systems
 and [gitbash](https://gitforwindows.org/), run it in [windows terminal](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab).
 
+### Autocomplete
+signageOS CLI offers tab completion for commands and options, which enhances the user experience by making it easier to discover and use available commands.
+
+#### Installation
+To enable autocomplete in your shell, use the following command:
+```sh
+sos autocomplete install
+```
+
+This will install a completion script in your home directory and add a source line to your shell configuration file (`.zshrc`, `.bashrc`, or `.bash_profile`, depending on your shell).
+
+To start using autocomplete immediately without restarting your terminal, run:
+```sh
+source ~/.sos-completion.sh
+```
+
+#### Usage
+Once autocomplete is installed, you can use the TAB key to discover and complete commands:
+```sh
+sos [TAB]          # Show all top-level commands
+sos applet [TAB]   # Show all applet subcommands
+sos applet up[TAB] # Autocomplete to "sos applet upload"
+```
+
+#### Uninstallation
+If you want to disable autocomplete, use:
+```sh
+sos autocomplete uninstall
+```
+
+This will remove the completion script and the source line from your shell configuration file.
+
+
 ## Test
 ```bash
 cp .env.amy .env
@@ -22,7 +55,7 @@ npm test
 ### General
 | Argument                   | Description                     | Default value                                     |
 |----------------------------|---------------------------------|---------------------------------------------------|
-| --api-url *(optional)*     | URL address to use for REST API | ${SOS_API_URL~'https://api.signageos.io'}         |
+| --api-url *(optional)*     | URL address to use for REST API | ${SOS_API_URL='https://api.signageos.io'}         |
 | --profile *(optional)*     | Profile used for separation of credentials and other configurations set in the `~/.sosrc` file | ${SOS_PROFILE}         |
 
 ### Login
@@ -32,21 +65,21 @@ npm test
 ```bash
 sos login
 ```
-- Login account to allow use REST API commands
+- Login account to allow you to use REST API commands
 - Logged account credentials are stored in `~/.sosrc` file.
-- You override login credentials using environment variables `SOS_API_IDENTIFICATION` & `SOS_API_SECURITY_TOKEN`. Go to https://box.signageos.io/settings to generate the token.
+- You can override login credentials using environment variables `SOS_API_IDENTIFICATION` & `SOS_API_SECURITY_TOKEN`. Go to https://box.signageos.io/settings to generate the token.
 
 | Argument                   | Description                     | Default value  |
 |----------------------------|---------------------------------|----------------|
 | --username *(required)*    | Username or e-mail user for box | STDIN          |
 
 #### Run control file
-There are file created when run command `sos login` in the path `~/.sosrc`. This file contains by default only following values (as default profile is used).
+There is a file created when running command `sos login` in the path `~/.sosrc`. This file contains by default only the following values (as default profile is used).
 ```ini
 identification=xxxxxxxxxxxxxxxxxxxx
 apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 ```
-If you'd like to manage more accounts/configurations on one machine, you can use environment variable `SOS_PROFILE` or argument `--profile`. The configuration file will uses a INI section `profile xxxx` for the profile named `xxxx`. You can use as many profiles as you want.
+If you'd like to manage more accounts/configurations on one machine, you can use environment variable `SOS_PROFILE` or argument `--profile`. The configuration file will use an INI section `profile xxxx` for the profile named `xxxx`. You can use as many profiles as you want.
 ```ini
 [profile xxxx]
 identification=xxxxxxxxxxxxxxxxxxxx
@@ -79,9 +112,9 @@ npm run build
 | --packager *(optional)*     | Use preferred package manager "npm", "pnpm", "bun", "yarn"    | npm            |
 
 > ! Windows users note:
-> There are unresolved issue with NPX tool on Windows clients when your username contains spaces (e.g.: `John Doe`).
+> There is an unresolved issue with NPX tool on Windows clients when your username contains spaces (e.g.: `John Doe`).
 > https://stackoverflow.com/a/58354623/4609457
-> To prevent this issue there is simple hotfix. Run following command in your Command Line (replace `John` with your real first name):
+> To prevent this issue there is a simple hotfix. Run following command in your Command Line (replace `John` with your real first name):
 > Sometimes the Administrator privileges are required (Run as Administrator)
 ```cmd
 npm config set cache "C:\Users\John~1\AppData\Roaming\npm-cache" --global
@@ -96,7 +129,7 @@ npm run upload
 #Deprecated
 sos applet upload --applet-path=dist/index.html
 # This will upload only the one specified file
-# Rest of the files will be removed from our servers
+# The rest of the files will be removed from our servers
 ```
 - If applet is not created yet, it will create it
 - The applet version is used from `package.json`
@@ -104,7 +137,7 @@ sos applet upload --applet-path=dist/index.html
 - You can use SOS_APPLET_UID as environment variable to specify appletUid to upload to (sos.appletUid of package.json will be overlooked).
 - You can use SOS_APPLET_VERSION as environment variable to specify applet version to upload to (version of package.json will be overlooked).
 - Ignore files priority (from top to bottom) `.sosignore` > `.npmignore` > `.gitignore`
-- Only one ignore file is used or non
+- Only one ignore file is used or none
 
 | Argument                       | Description                   | Default value          |
 |--------------------------------|-------------------------------|------------------------|
@@ -139,7 +172,7 @@ sos applet start
 | --server-port *(optional)* | The custom server port for local machine server. | {RANDOM_PORT} |
 | --hot-reload *(optional)* | Enable hot reload and build of applet | false |
 | --force *(optional)* | Force start applet server of hot reload even if it is already running on a different port. Kill the running server first. | false |
-| --detach *(optional)* | Run the applet HTTP server in the background (detached proccess) | false |
+| --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 |
 
 #### Applet Tests Upload
@@ -188,12 +221,12 @@ sos organization get
 | --organization-uid *(required)* | Organization UID             | STDIN          |
 
 #### Organization Set Default
-- Sets default organization for current logged in account. This organization will be used for example in webpack plugin of applet to register emulator
-- If you not set default organization, by default will be used the organization you will be asked to select from list where you have access to.
+- Sets default organization for current logged in account. This organization will be used for example in the webpack plugin of applet to register emulator
+- If you do not set default organization, by default will be used the organization you will be asked to select from list where you have access to.
 ```bash
 sos organization set-default
 ```
-- You override default organization using environment variable `SOS_ORGANIZATION_UID`. Go to https://box.signageos.io/organizations to git the organizationUid.
+- You can override default organization using environment variable `SOS_ORGANIZATION_UID`. Go to https://box.signageos.io/organizations to get the organizationUid.
 
 | Argument                        | Description                  | Default value  |
 |---------------------------------|------------------------------|----------------|
@@ -235,7 +268,7 @@ sos device power-action
 |---------------------------------|------------------------------|
 | reload       | Applet Reload                                   |
 | displayOn    | Display power On                                |
-| displayOff   | Display power Of                                |
+| displayOff   | Display power Off                               |
 | restart      | Application restart                             |
 | disable      | Applet disable                                  |
 | enable       | Applet enable                                   |
@@ -261,19 +294,20 @@ sos device connect
 ```
 | Argument                       | Description                           | Default value          |
 |--------------------------------|---------------------------------------|------------------------|
-| --device-uid *(required)*      | Uid of device from box'               |  STDIN           |
+| --device-uid *(required)*      | Uid of device from box                |  STDIN           |
 | --applet-uid *(required)*      | Applet UID                            | STDIN |
 | --organization-uid *(required)* | Organization UID             | STDIN          |
-| --update-package-config *(optional)*      | Update package.json value `sos.appletUid` config when applet doesn't exists and is created       | false |
+| --update-package-config *(optional)*      | Update package.json value `sos.appletUid` config when applet doesn't exist and is created       | false |
 | --server-public-url *(optional)* | Public url of local machine server. Is useful when the local machine is behind a reverse proxy. | http://{CURRENT_REMOTE_ADDR}:{RANDOM_PORT} or https://forward.signageos.io/{random-hash} |
 | --use-forward-server *(optional)* | Use forward server to connect to the device instead of the local network (LAN) (https://forward.signageos.io/{random-hash}). It's useful when the device is not in the same network as the local machine. | false |
 | --server-port *(optional)* | The custom server port for local machine server. | {RANDOM_PORT} |
 | --force *(optional)* | Force start applet server even if it is already running on a different port. Kill the running server first. | false |
 | --applet-path *(optional)*     | Root path of applet project           | ${PWD}/dist            |
-| --detach *(optional)* | Run the applet HTTP server in the background (detached proccess) | false |
+| --detach *(optional)* | Run the applet HTTP server in the background (detached process) | false |
 | --forward-server-url *(optional)* | Custom forward server URL. | https://forward.signageos.io |
 | --hot-reload *(optional)* | Enable hot reload and build of applet | false |
 
+
 ## Debugging
 
 To enable debugging for the `@signageos/cli:Applet:Upload:appletUploadFacade` module, use:
@@ -288,7 +322,7 @@ If you want to enable debugging for all modules under `@signageos`, use the aste
 DEBUG=@signageos/* sos applet upload
 ```
 
-You can use `export DEBUG=@signageos/*`, though.
+You can use `export DEBUG=@signageos/*` as well.
 
 ## Contribution
 Clone the repository and install dev dependencies

package/dist/Applet/Generate/Templates/CHANGELOG.md.template

@@ -0,0 +1,7 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]

package/dist/Applet/Generate/Templates/README.md.template

@@ -0,0 +1,3 @@
+# SignageOS Applet
+
+A digital signage applet for displaying ...

package/dist/Applet/Generate/appletGenerateCommand.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+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) {
@@ -288,7 +298,7 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
                         prepare: 'pnpm run clean && pnpm run build',
                         upload: 'sos applet upload',
                         clean: 'pnpx rimraf dist',
-                        escheck: 'pnpx es-check --module es5 dist/**/*.js',
+                        escheck: 'pnpx es-check --module es5 "./dist/**/*.js"',
                         postbuild: 'pnpm run escheck',
                     };
                     break;
@@ -298,7 +308,7 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
                         prepare: 'yarn run clean && yarn run build',
                         upload: 'sos applet upload',
                         clean: 'npx rimraf dist',
-                        escheck: 'npx es-check --module es5 dist/**/*.js',
+                        escheck: 'npx es-check --module es5 "./dist/**/*.js"',
                         postbuild: 'npm run escheck',
                     };
                     break;
@@ -308,7 +318,7 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
                         prepare: 'bun run clean && bun run build',
                         upload: 'sos applet upload',
                         clean: 'bunx rimraf dist',
-                        escheck: 'bunx es-check --module es5 dist/**/*.js',
+                        escheck: 'bunx es-check --module es5 "./dist/**/*.js"',
                         postbuild: 'bun run escheck',
                     };
                     break;
@@ -364,6 +374,14 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
                 path: path.join(appletRootDirectory, 'package.json'),
                 content: JSON.stringify(yield createPackageConfig(appletName, String(options['applet-version']), bundler, language), undefined, 2) + '\n',
             });
+            generateFiles.push({
+                path: path.join(appletRootDirectory, 'CHANGELOG.md'),
+                content: createChangelogFile(),
+            });
+            generateFiles.push({
+                path: path.join(appletRootDirectory, 'README.md'),
+                content: createReadmeFile(),
+            });
             // Configure bundler
             switch (bundler) {
                 case Bundler.Rspack:
@@ -414,12 +432,25 @@ exports.appletGenerate = (0, commandDefinition_1.createCommandDefinition)({
                 // Ensure the default .npmrc file will be loaded from project root
                 // Yarn 2+ uses .yarnrc.yml, but we can use this flag to override user's .npmrc
                 const packagerPrefix = ''; // 'NPM_CONFIG_USERCONFIG=/dev/null';
-                const configFlag = packager === Packager.Yarn ? '--no-default-rc' : '';
+                // Apply packager specific options
+                let configFlag = '';
+                switch (packager) {
+                    case Packager.Yarn:
+                        // Prevent Yarn from automatically detecting yarnrc and npmrc files
+                        configFlag = '--no-default-rc';
+                        break;
+                    case Packager.Bun:
+                        // Prevent Bun from failing on issues related to lockfile permissions
+                        configFlag = '--frozen-lockfile';
+                        break;
+                    default:
+                    // Other packagers (npm, pnpm) currently do not require any special config
+                }
                 const installCommand = packager === Packager.Yarn ? 'add' : 'install';
                 // Log the command being executed
                 console.info(`Installing dependencies: ${packagerPrefix} ${PACKAGER_EXECUTABLE} ${installCommand} ${configFlag} --save-dev ${mergedDeps.join(' ')}`);
                 const child = child_process.spawn(PACKAGER_EXECUTABLE, [packagerPrefix, installCommand, configFlag, '--save-dev', ...mergedDeps], {
-                    stdio: 'pipe',
+                    stdio: 'pipe', // Use 'pipe' to capture stdout and stderr
                     shell: true,
                 });
                 // Capture and log stdout
@@ -477,9 +508,10 @@ const createPackageConfig = (name, version, bundler, language) => __awaiter(void
     return {
         name,
         version,
+        author: '',
         main: 'dist/index.html',
         scripts: scriptDef,
-        files: ['dist'],
+        files: ['dist', 'CHANGELOG.md', 'README.md'],
         description: 'signageOS applet',
         repository: {},
         license: 'UNLICENSED',
@@ -494,6 +526,8 @@ const createIndexCss = () => importFileAsString('./Templates/index.css.template'
 const createIndexJs = () => importFileAsString('./Templates/index.js.template');
 const createIndexTs = () => createIndexJs(); // There is currently no difference
 const createTsConfig = () => importFileAsString('./Templates/tsconfig.js.template');
+const createChangelogFile = () => importFileAsString('./Templates/CHANGELOG.md.template');
+const createReadmeFile = () => importFileAsString('./Templates/README.md.template');
 const createNpmRunControl = (registryUrl) => `
 registry=${registryUrl}
 always-auth=true

package/dist/Applet/Start/appletStartCommand.js

@@ -50,8 +50,8 @@ exports.appletStart = (0, commandDefinition_1.createCommandDefinition)({
     optionList: exports.OPTION_LIST,
     commands: [],
     run(options) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const currentDirectory = process.cwd();
             const organizationUid = yield (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options);
             const entryFileAbsolutePath = yield (0, appletUploadCommandHelper_1.getAppletEntryFileAbsolutePath)(currentDirectory, options);

package/dist/Applet/Test/Upload/appletTestRunCommand.js

@@ -47,8 +47,8 @@ exports.appletTestRun = (0, commandDefinition_1.createCommandDefinition)({
     optionList: OPTION_LIST,
     commands: [],
     run(options) {
-        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             const skipConfirmation = !!options.yes;
             let tests = options.test;
             const currentDirectory = process.cwd();

package/dist/Applet/Test/Upload/appletTestRunFacade.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateTestIdentifiers = void 0;
+exports.validateTestIdentifiers = validateTestIdentifiers;
 function validateTestIdentifiers(identifiers, suites) {
     const existingIdentifiers = suites.map((suite) => suite.identifier);
     for (const identifier of identifiers) {
@@ -9,4 +9,3 @@ function validateTestIdentifiers(identifiers, suites) {
         }
     }
 }
-exports.validateTestIdentifiers = validateTestIdentifiers;

package/dist/Applet/Test/Upload/appletTestUploadCommand.js

@@ -44,8 +44,8 @@ exports.appletTestUpload = (0, commandDefinition_1.createCommandDefinition)({
     optionList: OPTION_LIST,
     commands: [],
     run(options) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const isVerbose = !!options.verbose;
             const skipConfirmation = !!options.yes;
             const currentDirectory = process.cwd();
@@ -93,17 +93,17 @@ exports.appletTestUpload = (0, commandDefinition_1.createCommandDefinition)({
                 });
                 yield Promise.all([
                     ...identifiersToCreate.map((identifier) => __awaiter(this, void 0, void 0, function* () {
-                        var _b;
+                        var _a;
                         yield restApi.applet.tests.create(applet.uid, appletVersion.version, {
                             identifier,
-                            binary: (_b = testFilesContents[identifier]) !== null && _b !== void 0 ? _b : '',
+                            binary: (_a = testFilesContents[identifier]) !== null && _a !== void 0 ? _a : '',
                         });
                         progressBar.update({ add: 1 });
                     })),
                     ...identifiersToUpdate.map((identifier) => __awaiter(this, void 0, void 0, function* () {
-                        var _c;
+                        var _a;
                         yield restApi.applet.tests.update(applet.uid, appletVersion.version, identifier, {
-                            binary: (_c = testFilesContents[identifier]) !== null && _c !== void 0 ? _c : '',
+                            binary: (_a = testFilesContents[identifier]) !== null && _a !== void 0 ? _a : '',
                         });
                         progressBar.update({ add: 1 });
                     })),

package/dist/Applet/Test/Upload/appletTestUploadFacade.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+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) {
@@ -32,7 +42,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadTestFilesContents = exports.validateTestFiles = void 0;
+exports.validateTestFiles = validateTestFiles;
+exports.loadTestFilesContents = loadTestFilesContents;
 const fs = __importStar(require("fs-extra"));
 const path = __importStar(require("path"));
 function validateTestFiles(currentDirectory, testFiles) {
@@ -45,7 +56,6 @@ function validateTestFiles(currentDirectory, testFiles) {
         }
     });
 }
-exports.validateTestFiles = validateTestFiles;
 function loadTestFilesContents(currentDirectory, testFiles) {
     return __awaiter(this, void 0, void 0, function* () {
         const contentsMap = {};
@@ -57,4 +67,3 @@ function loadTestFilesContents(currentDirectory, testFiles) {
         return contentsMap;
     });
 }
-exports.loadTestFilesContents = loadTestFilesContents;

package/dist/Applet/Upload/appletUploadCommandHelper.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+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) {
@@ -35,7 +45,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppletEntryFileRelativePath = exports.getAppletEntryFileAbsolutePath = exports.getAppletBinaryFileAbsolutePath = exports.getAppletDirectoryAbsolutePath = exports.APPLET_PATH_OPTION = exports.ENTRY_FILE_PATH_OPTION = void 0;
+exports.APPLET_PATH_OPTION = exports.ENTRY_FILE_PATH_OPTION = void 0;
+exports.getAppletDirectoryAbsolutePath = getAppletDirectoryAbsolutePath;
+exports.getAppletBinaryFileAbsolutePath = getAppletBinaryFileAbsolutePath;
+exports.getAppletEntryFileAbsolutePath = getAppletEntryFileAbsolutePath;
+exports.getAppletEntryFileRelativePath = getAppletEntryFileRelativePath;
 const log_1 = require("@signageos/sdk/dist/Console/log");
 const fs = __importStar(require("fs-extra"));
 const path = __importStar(require("path"));
@@ -63,8 +77,10 @@ function getAppletDirectoryAbsolutePath(currentDirectory, options) {
         if (!path.isAbsolute(appletDirectoryPath)) {
             appletDirectoryPath = path.join(currentDirectory, appletDirectoryPath);
         }
-        if (appletDirectoryPath.length > 1 && appletDirectoryPath[appletDirectoryPath.length - 1] === '/') {
-            appletDirectoryPath = appletDirectoryPath.substring(0, appletDirectoryPath.length - 1);
+        // Handle trailing slashes (both / and \) for cross-platform compatibility
+        appletDirectoryPath = path.normalize(appletDirectoryPath);
+        if (appletDirectoryPath.length > 1 && (appletDirectoryPath.endsWith('/') || appletDirectoryPath.endsWith('\\'))) {
+            appletDirectoryPath = appletDirectoryPath.slice(0, -1);
         }
         (0, log_1.log)('info', `\nUse applet project directory path: ${appletDirectoryPath}`);
         const appletDirectoryPathExists = yield fs.pathExists(appletDirectoryPath);
@@ -78,7 +94,6 @@ function getAppletDirectoryAbsolutePath(currentDirectory, options) {
         return appletDirectoryPath;
     });
 }
-exports.getAppletDirectoryAbsolutePath = getAppletDirectoryAbsolutePath;
 function getAppletBinaryFileAbsolutePath(currentDirectory, options) {
     return __awaiter(this, void 0, void 0, function* () {
         let appletBinaryFilePath = options['applet-path'];
@@ -88,6 +103,8 @@ function getAppletBinaryFileAbsolutePath(currentDirectory, options) {
         if (!path.isAbsolute(appletBinaryFilePath)) {
             appletBinaryFilePath = path.join(currentDirectory, appletBinaryFilePath);
         }
+        // Normalize the path for cross-platform compatibility
+        appletBinaryFilePath = path.normalize(appletBinaryFilePath);
         (0, log_1.log)('info', `\nUse applet binary file: ${appletBinaryFilePath}`);
         const appletBinaryFilePathExists = yield fs.pathExists(appletBinaryFilePath);
         if (!appletBinaryFilePathExists) {
@@ -100,7 +117,6 @@ function getAppletBinaryFileAbsolutePath(currentDirectory, options) {
         return appletBinaryFilePath;
     });
 }
-exports.getAppletBinaryFileAbsolutePath = getAppletBinaryFileAbsolutePath;
 function getAppletEntryFileAbsolutePath(currentDirectory, options) {
     return __awaiter(this, void 0, void 0, function* () {
         let appletEntryFilePath = options['entry-file-path'];
@@ -114,6 +130,8 @@ function getAppletEntryFileAbsolutePath(currentDirectory, options) {
         if (!path.isAbsolute(appletEntryFilePath)) {
             appletEntryFilePath = path.join(currentDirectory, appletEntryFilePath);
         }
+        // Normalize the path for cross-platform compatibility
+        appletEntryFilePath = path.normalize(appletEntryFilePath);
         (0, log_1.log)('info', `\nUse applet entry file: ${appletEntryFilePath}`);
         const appletEntryFilePathExists = yield fs.pathExists(appletEntryFilePath);
         if (!appletEntryFilePathExists) {
@@ -126,8 +144,8 @@ function getAppletEntryFileAbsolutePath(currentDirectory, options) {
         return appletEntryFilePath;
     });
 }
-exports.getAppletEntryFileAbsolutePath = getAppletEntryFileAbsolutePath;
 function getAppletEntryFileRelativePath(entryFileAbsolutePath, appletDirectoryAbsolutePath) {
+    // Normalize paths to ensure consistent handling across platforms
     const appletDirectoryAbsolutePathNormalized = path.normalize(appletDirectoryAbsolutePath);
     const entryFileAbsolutePathNormalized = path.normalize(entryFileAbsolutePath);
     if (!path.isAbsolute(entryFileAbsolutePathNormalized)) {
@@ -136,13 +154,15 @@ function getAppletEntryFileRelativePath(entryFileAbsolutePath, appletDirectoryAb
     if (!path.isAbsolute(appletDirectoryAbsolutePathNormalized)) {
         throw new Error(`Internal Error: Try input relative applet directory path. Current path: ${appletDirectoryAbsolutePathNormalized}`);
     }
+    // Use startsWith with normalized paths for cross-platform path checking
     const isEntryFileInAppletDir = entryFileAbsolutePathNormalized.startsWith(appletDirectoryAbsolutePathNormalized);
     if (!isEntryFileInAppletDir) {
         throw new Error(`Applet entry file must be in the applet directory.` +
             `\nEntry file path: ${entryFileAbsolutePathNormalized}` +
             `\nApplet directory path: ${appletDirectoryAbsolutePathNormalized}`);
     }
-    const entryFileRelativePath = entryFileAbsolutePathNormalized.substring(appletDirectoryAbsolutePathNormalized.length + 1);
-    return entryFileRelativePath;
+    // Use path.relative to get the relative path with correct platform separators
+    const entryFileRelativePath = path.relative(appletDirectoryAbsolutePathNormalized, entryFileAbsolutePathNormalized);
+    // Ensure forward slashes for cross-platform compatibility in returned paths
+    return entryFileRelativePath.split(path.sep).join('/');
 }
-exports.getAppletEntryFileRelativePath = getAppletEntryFileRelativePath;

package/dist/Applet/Upload/appletUploadFacade.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+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) {
@@ -35,7 +45,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMultiFileFileApplet = exports.createSingleFileApplet = exports.updateMultiFileApplet = exports.updateSingleFileApplet = void 0;
+exports.createMultiFileFileApplet = exports.createSingleFileApplet = exports.updateMultiFileApplet = void 0;
+exports.updateSingleFileApplet = updateSingleFileApplet;
 const path = __importStar(require("path"));
 const fs = __importStar(require("fs-extra"));
 const chalk_1 = __importDefault(require("chalk"));
@@ -55,7 +66,6 @@ function updateSingleFileApplet(parameters) {
         });
     });
 }
-exports.updateSingleFileApplet = updateSingleFileApplet;
 const updateMultiFileApplet = (parameters) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     const { restApi, applet, progressBar } = parameters;