@signageos/cli 2.3.1 → 2.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (127) hide show
  1. package/README.md +1 -0
  2. package/dist/Applet/Build/appletBuildCommand.js +28 -72
  3. package/dist/Applet/Generate/Templates/rspack.config.mjs.template +12 -12
  4. package/dist/Applet/Generate/appletGenerateCommand.d.ts +23 -62
  5. package/dist/Applet/Generate/appletGenerateCommand.js +398 -365
  6. package/dist/Applet/Start/appletStartCommand.js +69 -131
  7. package/dist/Applet/Test/Upload/appletTestRunCommand.js +89 -177
  8. package/dist/Applet/Test/Upload/appletTestRunFacade.js +4 -27
  9. package/dist/Applet/Test/Upload/appletTestUploadCommand.js +98 -223
  10. package/dist/Applet/Test/Upload/appletTestUploadFacade.js +39 -102
  11. package/dist/Applet/Test/appletTestCommand.js +6 -36
  12. package/dist/Applet/Upload/appletUploadCommand.js +199 -305
  13. package/dist/Applet/Upload/appletUploadCommandHelper.js +103 -138
  14. package/dist/Applet/Upload/appletUploadFacade.d.ts +2 -2
  15. package/dist/Applet/Upload/appletUploadFacade.js +172 -263
  16. package/dist/Applet/Upload/appletUploadFacadeHelper.js +39 -52
  17. package/dist/Applet/appletCommand.d.ts +22 -62
  18. package/dist/Applet/appletCommand.js +9 -39
  19. package/dist/Applet/appletErrors.js +5 -24
  20. package/dist/Applet/appletFacade.js +106 -141
  21. package/dist/Applet/appletServerHelper.js +16 -53
  22. package/dist/Auth/loginCommand.js +96 -137
  23. package/dist/Cache/tmpCache.js +35 -13
  24. package/dist/Cli/helper.js +1 -2
  25. package/dist/Cli/packageVersion.js +82 -123
  26. package/dist/Command/commandDefinition.js +0 -1
  27. package/dist/Command/commandProcessor.js +40 -129
  28. package/dist/Command/globalArgs.js +7 -5
  29. package/dist/CommandLine/IProgressBar.js +0 -1
  30. package/dist/CommandLine/progressBarFactory.js +31 -11
  31. package/dist/CustomScript/Generate/customScriptGenerateCommand.js +17 -56
  32. package/dist/CustomScript/Generate/customScriptGenerateFacade.js +82 -106
  33. package/dist/CustomScript/Upload/customScriptUploadCommand.js +44 -120
  34. package/dist/CustomScript/customScriptCommand.js +6 -36
  35. package/dist/CustomScript/customScriptFacade.js +175 -294
  36. package/dist/Device/Connect/connectCommand.js +72 -136
  37. package/dist/Device/Content/setContentCommand.js +33 -78
  38. package/dist/Device/PowerAction/powerActionCommand.js +22 -65
  39. package/dist/Device/deviceCommand.js +7 -37
  40. package/dist/Device/deviceFacade.js +67 -123
  41. package/dist/Emulator/IEmulator.js +0 -1
  42. package/dist/Emulator/createDomain.js +33 -12
  43. package/dist/Emulator/emulatorFacade.js +74 -131
  44. package/dist/Emulator/emulatorFactory.js +112 -124
  45. package/dist/Firmware/Upload/firmwareUploadCommand.js +133 -221
  46. package/dist/Firmware/Upload/firmwareUploadFacade.js +64 -110
  47. package/dist/Firmware/Upload/firmwareUploadHelper.js +27 -5
  48. package/dist/Firmware/firmwareCommand.js +5 -35
  49. package/dist/Lib/archive.js +45 -60
  50. package/dist/Lib/childProcess.js +27 -5
  51. package/dist/Lib/fileSystem.js +62 -82
  52. package/dist/Lib/git.d.ts +1 -1
  53. package/dist/Lib/git.js +44 -82
  54. package/dist/Organization/Get/organizationGetCommand.js +14 -50
  55. package/dist/Organization/List/organizationListCommand.js +12 -46
  56. package/dist/Organization/SetDefault/organizationSetDefaultCommand.js +18 -56
  57. package/dist/Organization/organizationCommand.js +7 -37
  58. package/dist/Organization/organizationFacade.js +97 -172
  59. package/dist/RunControl/runControlHelper.js +11 -60
  60. package/dist/Timer/wait.js +1 -2
  61. package/dist/Timing/List/timingListCommand.js +20 -62
  62. package/dist/Timing/timingCommand.js +5 -35
  63. package/dist/generalCommand.js +1 -2
  64. package/dist/helper.js +48 -109
  65. package/dist/index.js +15 -45
  66. package/dist/parameters.js +17 -40
  67. package/package.json +16 -18
  68. package/dist/Applet/Build/appletBuildCommand.js.map +0 -1
  69. package/dist/Applet/Generate/appletGenerateCommand.js.map +0 -1
  70. package/dist/Applet/Start/appletStartCommand.js.map +0 -1
  71. package/dist/Applet/Test/Upload/appletTestRunCommand.js.map +0 -1
  72. package/dist/Applet/Test/Upload/appletTestRunFacade.js.map +0 -1
  73. package/dist/Applet/Test/Upload/appletTestUploadCommand.js.map +0 -1
  74. package/dist/Applet/Test/Upload/appletTestUploadFacade.js.map +0 -1
  75. package/dist/Applet/Test/appletTestCommand.js.map +0 -1
  76. package/dist/Applet/Upload/appletUploadCommand.js.map +0 -1
  77. package/dist/Applet/Upload/appletUploadCommandHelper.js.map +0 -1
  78. package/dist/Applet/Upload/appletUploadFacade.js.map +0 -1
  79. package/dist/Applet/Upload/appletUploadFacadeHelper.js.map +0 -1
  80. package/dist/Applet/appletCommand.js.map +0 -1
  81. package/dist/Applet/appletErrors.js.map +0 -1
  82. package/dist/Applet/appletFacade.js.map +0 -1
  83. package/dist/Applet/appletServerHelper.js.map +0 -1
  84. package/dist/Auth/loginCommand.js.map +0 -1
  85. package/dist/Cache/tmpCache.js.map +0 -1
  86. package/dist/Cli/helper.js.map +0 -1
  87. package/dist/Cli/packageVersion.js.map +0 -1
  88. package/dist/Command/commandDefinition.js.map +0 -1
  89. package/dist/Command/commandProcessor.js.map +0 -1
  90. package/dist/Command/globalArgs.js.map +0 -1
  91. package/dist/CommandLine/IProgressBar.js.map +0 -1
  92. package/dist/CommandLine/progressBarFactory.js.map +0 -1
  93. package/dist/CustomScript/Generate/customScriptGenerateCommand.js.map +0 -1
  94. package/dist/CustomScript/Generate/customScriptGenerateFacade.js.map +0 -1
  95. package/dist/CustomScript/Upload/customScriptUploadCommand.js.map +0 -1
  96. package/dist/CustomScript/customScriptCommand.js.map +0 -1
  97. package/dist/CustomScript/customScriptFacade.js.map +0 -1
  98. package/dist/Device/Connect/connectCommand.js.map +0 -1
  99. package/dist/Device/Content/setContentCommand.js.map +0 -1
  100. package/dist/Device/PowerAction/powerActionCommand.js.map +0 -1
  101. package/dist/Device/deviceCommand.js.map +0 -1
  102. package/dist/Device/deviceFacade.js.map +0 -1
  103. package/dist/Emulator/IEmulator.js.map +0 -1
  104. package/dist/Emulator/createDomain.js.map +0 -1
  105. package/dist/Emulator/emulatorFacade.js.map +0 -1
  106. package/dist/Emulator/emulatorFactory.js.map +0 -1
  107. package/dist/Firmware/Upload/firmwareUploadCommand.js.map +0 -1
  108. package/dist/Firmware/Upload/firmwareUploadFacade.js.map +0 -1
  109. package/dist/Firmware/Upload/firmwareUploadHelper.js.map +0 -1
  110. package/dist/Firmware/firmwareCommand.js.map +0 -1
  111. package/dist/Lib/archive.js.map +0 -1
  112. package/dist/Lib/childProcess.js.map +0 -1
  113. package/dist/Lib/fileSystem.js.map +0 -1
  114. package/dist/Lib/git.js.map +0 -1
  115. package/dist/Organization/Get/organizationGetCommand.js.map +0 -1
  116. package/dist/Organization/List/organizationListCommand.js.map +0 -1
  117. package/dist/Organization/SetDefault/organizationSetDefaultCommand.js.map +0 -1
  118. package/dist/Organization/organizationCommand.js.map +0 -1
  119. package/dist/Organization/organizationFacade.js.map +0 -1
  120. package/dist/RunControl/runControlHelper.js.map +0 -1
  121. package/dist/Timer/wait.js.map +0 -1
  122. package/dist/Timing/List/timingListCommand.js.map +0 -1
  123. package/dist/Timing/timingCommand.js.map +0 -1
  124. package/dist/generalCommand.js.map +0 -1
  125. package/dist/helper.js.map +0 -1
  126. package/dist/index.js.map +0 -1
  127. package/dist/parameters.js.map +0 -1
package/README.md CHANGED
@@ -76,6 +76,7 @@ npm run build
76
76
  | --language *(optional)* | Generate applet with "typescript" or "javascript" source code | STDIN |
77
77
  | --bundler *(optional)* | Generate applet with "webpack" or "rspack" | webpack |
78
78
  | --git *(optional)* | Initialize applet as git repository "yes" or "no" | no |
79
+ | --packager *(optional)* | Use preferred package manager "npm", "pnpm", "bun", "yarn" | npm |
79
80
 
80
81
  > ! Windows users note:
81
82
  > There are unresolved issue with NPX tool on Windows clients when your username contains spaces (e.g.: `John Doe`).
@@ -8,88 +8,44 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
8
8
  step((generator = generator.apply(thisArg, _arguments || [])).next());
9
9
  });
10
10
  };
11
- var __generator = (this && this.__generator) || function (thisArg, body) {
12
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
13
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
- function verb(n) { return function (v) { return step([n, v]); }; }
15
- function step(op) {
16
- if (f) throw new TypeError("Generator is already executing.");
17
- while (_) try {
18
- 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;
19
- if (y = 0, t) op = [op[0] & 2, t.value];
20
- switch (op[0]) {
21
- case 0: case 1: t = op; break;
22
- case 4: _.label++; return { value: op[1], done: false };
23
- case 5: _.label++; y = op[1]; op = [0]; continue;
24
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
- default:
26
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
- if (t[2]) _.ops.pop();
31
- _.trys.pop(); continue;
32
- }
33
- op = body.call(thisArg, _);
34
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
- }
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
37
13
  };
38
14
  Object.defineProperty(exports, "__esModule", { value: true });
39
15
  exports.appletBuild = exports.OPTION_LIST = void 0;
40
- var chalk_1 = require("chalk");
41
- var commandDefinition_1 = require("../../Command/commandDefinition");
42
- var organizationFacade_1 = require("../../Organization/organizationFacade");
43
- var helper_1 = require("../../helper");
44
- var dist_1 = require("@signageos/sdk/dist");
45
- var appletFacade_1 = require("../appletFacade");
46
- var log_1 = require("@signageos/sdk/dist/Console/log");
47
- var Debug = require("debug");
48
- var debug = Debug('@signageos/cli:Applet:Build:appletBuildCommand');
16
+ const chalk_1 = __importDefault(require("chalk"));
17
+ const commandDefinition_1 = require("../../Command/commandDefinition");
18
+ const organizationFacade_1 = require("../../Organization/organizationFacade");
19
+ const helper_1 = require("../../helper");
20
+ const dist_1 = require("@signageos/sdk/dist");
21
+ const appletFacade_1 = require("../appletFacade");
22
+ const log_1 = require("@signageos/sdk/dist/Console/log");
23
+ const debug_1 = __importDefault(require("debug"));
24
+ const Debug = (0, debug_1.default)('@signageos/cli:Applet:Build:appletBuildCommand');
49
25
  exports.OPTION_LIST = [organizationFacade_1.NO_DEFAULT_ORGANIZATION_OPTION, organizationFacade_1.ORGANIZATION_UID_OPTION, appletFacade_1.APPLET_UID_OPTION];
50
26
  exports.appletBuild = (0, commandDefinition_1.createCommandDefinition)({
51
27
  name: 'build',
52
28
  description: 'Build applet locally. The result is a zip file in the /tmp/signageos directory.',
53
29
  optionList: exports.OPTION_LIST,
54
30
  commands: [],
55
- run: function (options) {
56
- return __awaiter(this, void 0, void 0, function () {
57
- var currentDirectory, organizationUid, organization, restApi, dev, appletUid, appletVersion, build;
58
- return __generator(this, function (_a) {
59
- switch (_a.label) {
60
- case 0:
61
- currentDirectory = process.cwd();
62
- return [4 /*yield*/, (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options)];
63
- case 1:
64
- organizationUid = _a.sent();
65
- return [4 /*yield*/, (0, organizationFacade_1.getOrganization)(organizationUid)];
66
- case 2:
67
- organization = _a.sent();
68
- return [4 /*yield*/, (0, helper_1.createOrganizationRestApi)(organization)];
69
- case 3:
70
- restApi = _a.sent();
71
- dev = (0, dist_1.createDevelopment)({
72
- organizationUid: organization.uid,
73
- });
74
- return [4 /*yield*/, (0, appletFacade_1.getAppletUid)(restApi, options)];
75
- case 4:
76
- appletUid = _a.sent();
77
- return [4 /*yield*/, (0, appletFacade_1.getAppletVersion)(currentDirectory)];
78
- case 5:
79
- appletVersion = _a.sent();
80
- return [4 /*yield*/, dev.applet.build.build({
81
- appletUid: appletUid,
82
- appletVersion: appletVersion,
83
- appletPath: currentDirectory,
84
- })];
85
- case 6:
86
- build = _a.sent();
87
- (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), "\"."));
88
- debug('Applet build result:', build);
89
- return [2 /*return*/];
90
- }
31
+ run(options) {
32
+ return __awaiter(this, void 0, void 0, function* () {
33
+ const currentDirectory = process.cwd();
34
+ const organizationUid = yield (0, organizationFacade_1.getOrganizationUidOrDefaultOrSelect)(options);
35
+ const organization = yield (0, organizationFacade_1.getOrganization)(organizationUid);
36
+ const restApi = yield (0, helper_1.createOrganizationRestApi)(organization);
37
+ const dev = (0, dist_1.createDevelopment)({
38
+ organizationUid: organization.uid,
91
39
  });
40
+ const appletUid = yield (0, appletFacade_1.getAppletUid)(restApi, options);
41
+ const appletVersion = yield (0, appletFacade_1.getAppletVersion)(currentDirectory);
42
+ const build = yield dev.applet.build.build({
43
+ appletUid,
44
+ appletVersion,
45
+ appletPath: currentDirectory,
46
+ });
47
+ (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)}".`);
48
+ Debug('Applet build result:', build);
92
49
  });
93
50
  },
94
51
  });
95
- //# sourceMappingURL=appletBuildCommand.js.map
@@ -18,22 +18,22 @@ export default defineConfig({
18
18
  },
19
19
  module: {
20
20
  rules: [
21
- {
22
- test: /\.js$/,
23
- exclude: /node_modules/,
24
- use: {
25
- loader: 'babel-loader',
26
- options: {
27
- presets: ['@babel/preset-env'], // Ensure ES5 transpilation
28
- cacheDirectory: true, // Speed up subsequent builds
29
- },
30
- },
31
- },
32
21
  {
33
22
  test: /^(.(?!.module.css))*.css$/,
34
23
  use: ['style-loader', 'css-loader'],
35
24
  },
36
- { test: /\.tsx?$/, loader: 'ts-loader' },
25
+ {
26
+ test: /\.(tsx?|js)$/,
27
+ loader: 'builtin:swc-loader',
28
+ options: {
29
+ jsc: {
30
+ parser: {
31
+ syntax: 'typescript',
32
+ },
33
+ target: 'es5',
34
+ },
35
+ },
36
+ },
37
37
  ],
38
38
  },
39
39
  plugins: [
@@ -1,35 +1,15 @@
1
1
  import { CommandLineOptions } from '../../Command/commandDefinition';
2
- declare const OPTION_LIST: readonly [{
3
- readonly name: "name";
4
- readonly type: StringConstructor;
5
- readonly description: `Applet name. Match RegExp: ${string}`;
6
- }, {
7
- readonly name: "applet-version";
8
- readonly type: StringConstructor;
9
- readonly description: "Applet initial version. Use semantic version";
10
- readonly defaultValue: "0.0.0";
11
- }, {
12
- readonly name: "target-dir";
13
- readonly type: StringConstructor;
14
- readonly description: "Directory where will be the applet generated to";
15
- }, {
16
- readonly name: "npm-registry";
17
- readonly type: StringConstructor;
18
- readonly description: "NPM registry URL. If you have your private npm registry";
19
- }, {
20
- readonly name: "language";
21
- readonly type: StringConstructor;
22
- readonly description: "Generate applet with \"typescript\" or \"javascript\" source code";
23
- }, {
24
- readonly name: "bundler";
25
- readonly type: StringConstructor;
26
- readonly description: "Generate applet with \"webpack\" (default) or \"rspack\"";
27
- }, {
28
- readonly name: "git";
29
- readonly type: StringConstructor;
30
- readonly description: "Init applet as git repository \"no\" (default) or \"yes\"";
31
- readonly defaultValue: "no";
32
- }];
2
+ declare const OPTION_LIST: ({
3
+ name: string;
4
+ type: StringConstructor;
5
+ description: string;
6
+ defaultValue?: undefined;
7
+ } | {
8
+ name: string;
9
+ type: StringConstructor;
10
+ description: string;
11
+ defaultValue: string;
12
+ })[];
33
13
  /**
34
14
  * Command definition for generating a new applet.
35
15
  * This command facilitates the creation of a basic applet sample with configurable options such as
@@ -43,6 +23,7 @@ declare const OPTION_LIST: readonly [{
43
23
  * @param {string} options.language - The language of the applet (typescript or javascript)
44
24
  * @param {string} options.bundler - The bundler to use (webpack or rspack)
45
25
  * @param {string} options.git - Whether to initialize a git repository (yes or no)
26
+ * @param {string} options.packager - Whether to manage packages with npm, pnpm, bun or yarn
46
27
  * @returns {Promise<void>} - A promise that resolves when the applet is generated
47
28
  * @example
48
29
  * appletGenerate.run({
@@ -58,37 +39,17 @@ declare const OPTION_LIST: readonly [{
58
39
  export declare const appletGenerate: {
59
40
  name: "generate";
60
41
  description: string;
61
- optionList: readonly [{
62
- readonly name: "name";
63
- readonly type: StringConstructor;
64
- readonly description: `Applet name. Match RegExp: ${string}`;
65
- }, {
66
- readonly name: "applet-version";
67
- readonly type: StringConstructor;
68
- readonly description: "Applet initial version. Use semantic version";
69
- readonly defaultValue: "0.0.0";
70
- }, {
71
- readonly name: "target-dir";
72
- readonly type: StringConstructor;
73
- readonly description: "Directory where will be the applet generated to";
74
- }, {
75
- readonly name: "npm-registry";
76
- readonly type: StringConstructor;
77
- readonly description: "NPM registry URL. If you have your private npm registry";
78
- }, {
79
- readonly name: "language";
80
- readonly type: StringConstructor;
81
- readonly description: "Generate applet with \"typescript\" or \"javascript\" source code";
82
- }, {
83
- readonly name: "bundler";
84
- readonly type: StringConstructor;
85
- readonly description: "Generate applet with \"webpack\" (default) or \"rspack\"";
86
- }, {
87
- readonly name: "git";
88
- readonly type: StringConstructor;
89
- readonly description: "Init applet as git repository \"no\" (default) or \"yes\"";
90
- readonly defaultValue: "no";
91
- }];
42
+ optionList: ({
43
+ name: string;
44
+ type: StringConstructor;
45
+ description: string;
46
+ defaultValue?: undefined;
47
+ } | {
48
+ name: string;
49
+ type: StringConstructor;
50
+ description: string;
51
+ defaultValue: string;
52
+ })[];
92
53
  commands: never[];
93
54
  run(options: CommandLineOptions<typeof OPTION_LIST>): Promise<void>;
94
55
  };