@signageos/cli 2.3.1 → 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
@@ -76,11 +109,12 @@ npm run build
 | --language *(optional)*     | Generate applet with "typescript" or "javascript" source code | STDIN          |
 | --bundler *(optional)*      | Generate applet with "webpack" or "rspack"                    | webpack        |
 | --git *(optional)*          | Initialize applet as git repository "yes" or "no"             | no             |
+| --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
@@ -95,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`
@@ -103,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          |
 |--------------------------------|-------------------------------|------------------------|
@@ -138,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
@@ -187,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  |
 |---------------------------------|------------------------------|----------------|
@@ -234,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                                   |
@@ -260,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:
@@ -287,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/Build/appletBuildCommand.js

@@ -8,88 +8,44 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.appletBuild = exports.OPTION_LIST = void 0;
-var chalk_1 = require("chalk");
-var commandDefinition_1 = require("../../Command/commandDefinition");
-var organizationFacade_1 = require("../../Organization/organizationFacade");
-var helper_1 = require("../../helper");
-var dist_1 = require("@signageos/sdk/dist");
-var appletFacade_1 = require("../appletFacade");
-var log_1 = require("@signageos/sdk/dist/Console/log");
-var Debug = require("debug");
-var debug = Debug('@signageos/cli:Applet:Build:appletBuildCommand');
+const chalk_1 = __importDefault(require("chalk"));
+const commandDefinition_1 = require("../../Command/commandDefinition");
+const organizationFacade_1 = require("../../Organization/organizationFacade");
+const helper_1 = require("../../helper");
+const dist_1 = require("@signageos/sdk/dist");
+const appletFacade_1 = require("../appletFacade");
+const log_1 = require("@signageos/sdk/dist/Console/log");
+const debug_1 = __importDefault(require("debug"));
+const Debug = (0, debug_1.default)('@signageos/cli:Applet:Build:appletBuildCommand');
 exports.OPTION_LIST = [organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION, organizationFacade_1.ORGANIZATION_UID_OPTION, appletFacade_1.APPLET_UID_OPTION];
 exports.appletBuild = (0, commandDefinition_1.createCommandDefinition)({
     name: 'build',
     description: 'Build applet locally. The result is a zip file in the /tmp/signageos directory.',
     optionList: exports.OPTION_LIST,
     commands: [],
-    run: function (options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var currentDirectory, organizationUid, organization, restApi, dev, appletUid, appletVersion, build;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        currentDirectory = process.cwd();
-                        return [4 /*yield*/, (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options)];
-                    case 1:
-                        organizationUid = _a.sent();
-                        return [4 /*yield*/, (0, organizationFacade_1.getOrganization)(organizationUid)];
-                    case 2:
-                        organization = _a.sent();
-                        return [4 /*yield*/, (0, helper_1.createOrganizationRestApi)(organization)];
-                    case 3:
-                        restApi = _a.sent();
-                        dev = (0, dist_1.createDevelopment)({
-                            organizationUid: organization.uid,
-                        });
-                        return [4 /*yield*/, (0, appletFacade_1.getAppletUid)(restApi, options)];
-                    case 4:
-                        appletUid = _a.sent();
-                        return [4 /*yield*/, (0, appletFacade_1.getAppletVersion)(currentDirectory)];
-                    case 5:
-                        appletVersion = _a.sent();
-                        return [4 /*yield*/, dev.applet.build.build({
-                                appletUid: appletUid,
-                                appletVersion: appletVersion,
-                                appletPath: currentDirectory,
-                            })];
-                    case 6:
-                        build = _a.sent();
-                        (0, log_1.log)('info', "Applet ".concat(chalk_1.default.green(appletUid), "@").concat(chalk_1.default.green(appletVersion), " was built successfully into \"").concat(chalk_1.default.green(build.packageArchivePath), "\"."));
-                        debug('Applet build result:', build);
-                        return [2 /*return*/];
-                }
+    run(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const currentDirectory = process.cwd();
+            const organizationUid = yield (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options);
+            const organization = yield (0, organizationFacade_1.getOrganization)(organizationUid);
+            const restApi = yield (0, helper_1.createOrganizationRestApi)(organization);
+            const dev = (0, dist_1.createDevelopment)({
+                organizationUid: organization.uid,
             });
+            const appletUid = yield (0, appletFacade_1.getAppletUid)(restApi, options);
+            const appletVersion = yield (0, appletFacade_1.getAppletVersion)(currentDirectory);
+            const build = yield dev.applet.build.build({
+                appletUid,
+                appletVersion,
+                appletPath: currentDirectory,
+            });
+            (0, log_1.log)('info', `Applet ${chalk_1.default.green(appletUid)}@${chalk_1.default.green(appletVersion)} was built successfully into "${chalk_1.default.green(build.packageArchivePath)}".`);
+            Debug('Applet build result:', build);
         });
     },
 });
-//# sourceMappingURL=appletBuildCommand.js.map

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/Templates/rspack.config.mjs.template

@@ -18,22 +18,22 @@ export default defineConfig({
 	},
 	module: {
 		rules: [
-			{
-				test: /\.js$/,
-				exclude: /node_modules/,
-				use: {
-					loader: 'babel-loader',
-					options: {
-						presets: ['@babel/preset-env'], // Ensure ES5 transpilation
-						cacheDirectory: true, // Speed up subsequent builds
-					},
-				},
-			},
 			{
 				test: /^(.(?!.module.css))*.css$/,
 				use: ['style-loader', 'css-loader'],
 			},
-			{ test: /\.tsx?$/, loader: 'ts-loader' },
+			{
+				test: /\.(tsx?|js)$/,
+				loader: 'builtin:swc-loader',
+				options: {
+				  jsc: {
+					parser: {
+					  syntax: 'typescript',
+					},
+					target: 'es5',
+				  },
+				},
+			},
 		],
 	},
 	plugins: [

package/dist/Applet/Generate/appletGenerateCommand.d.ts

@@ -1,35 +1,15 @@
 import { CommandLineOptions } from '../../Command/commandDefinition';
-declare const OPTION_LIST: readonly [{
-    readonly name: "name";
-    readonly type: StringConstructor;
-    readonly description: `Applet name. Match RegExp: ${string}`;
-}, {
-    readonly name: "applet-version";
-    readonly type: StringConstructor;
-    readonly description: "Applet initial version. Use semantic version";
-    readonly defaultValue: "0.0.0";
-}, {
-    readonly name: "target-dir";
-    readonly type: StringConstructor;
-    readonly description: "Directory where will be the applet generated to";
-}, {
-    readonly name: "npm-registry";
-    readonly type: StringConstructor;
-    readonly description: "NPM registry URL. If you have your private npm registry";
-}, {
-    readonly name: "language";
-    readonly type: StringConstructor;
-    readonly description: "Generate applet with \"typescript\" or \"javascript\" source code";
-}, {
-    readonly name: "bundler";
-    readonly type: StringConstructor;
-    readonly description: "Generate applet with \"webpack\" (default) or \"rspack\"";
-}, {
-    readonly name: "git";
-    readonly type: StringConstructor;
-    readonly description: "Init applet as git repository \"no\" (default) or \"yes\"";
-    readonly defaultValue: "no";
-}];
+declare const OPTION_LIST: ({
+    name: string;
+    type: StringConstructor;
+    description: string;
+    defaultValue?: undefined;
+} | {
+    name: string;
+    type: StringConstructor;
+    description: string;
+    defaultValue: string;
+})[];
 /**
  * Command definition for generating a new applet.
  * This command facilitates the creation of a basic applet sample with configurable options such as
@@ -43,6 +23,7 @@ declare const OPTION_LIST: readonly [{
  * @param {string} options.language - The language of the applet (typescript or javascript)
  * @param {string} options.bundler - The bundler to use (webpack or rspack)
  * @param {string} options.git - Whether to initialize a git repository (yes or no)
+ * @param {string} options.packager - Whether to manage packages with npm, pnpm, bun or yarn
  * @returns {Promise<void>} - A promise that resolves when the applet is generated
  * @example
  * appletGenerate.run({
@@ -58,37 +39,17 @@ declare const OPTION_LIST: readonly [{
 export declare const appletGenerate: {
     name: "generate";
     description: string;
-    optionList: readonly [{
-        readonly name: "name";
-        readonly type: StringConstructor;
-        readonly description: `Applet name. Match RegExp: ${string}`;
-    }, {
-        readonly name: "applet-version";
-        readonly type: StringConstructor;
-        readonly description: "Applet initial version. Use semantic version";
-        readonly defaultValue: "0.0.0";
-    }, {
-        readonly name: "target-dir";
-        readonly type: StringConstructor;
-        readonly description: "Directory where will be the applet generated to";
-    }, {
-        readonly name: "npm-registry";
-        readonly type: StringConstructor;
-        readonly description: "NPM registry URL. If you have your private npm registry";
-    }, {
-        readonly name: "language";
-        readonly type: StringConstructor;
-        readonly description: "Generate applet with \"typescript\" or \"javascript\" source code";
-    }, {
-        readonly name: "bundler";
-        readonly type: StringConstructor;
-        readonly description: "Generate applet with \"webpack\" (default) or \"rspack\"";
-    }, {
-        readonly name: "git";
-        readonly type: StringConstructor;
-        readonly description: "Init applet as git repository \"no\" (default) or \"yes\"";
-        readonly defaultValue: "no";
-    }];
+    optionList: ({
+        name: string;
+        type: StringConstructor;
+        description: string;
+        defaultValue?: undefined;
+    } | {
+        name: string;
+        type: StringConstructor;
+        description: string;
+        defaultValue: string;
+    })[];
     commands: never[];
     run(options: CommandLineOptions<typeof OPTION_LIST>): Promise<void>;
 };