@signageos/cli 4.0.3 → 4.0.4

package/README.md

@@ -80,6 +80,42 @@ identification=xxxxxxxxxxxxxxxxxxxx
 apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 ```
 
+#### Custom deployment
+
+When connecting to a non-default signageOS deployment, use the `--interactive-profile` flag during login. This will interactively prompt for connection settings:
+
+```bash
+sos login --interactive-profile
+# You will be prompted to enter:
+#   Server API URL: https://api.example.com
+#   Box URL: box.example.com
+#   Auth0 domain: auth0.example.com
+#   Auth0 client ID: <your-client-id>
+#   Auth0 audience: https://auth0.example.com/api/v2/
+```
+
+The settings are saved to `~/.sosrc` and used for all subsequent commands automatically.
+
+Alternatively, you can configure the settings directly in `~/.sosrc`:
+```ini
+apiUrl=https://api.example.com
+boxUrl=box.example.com
+auth0Domain=auth0.example.com
+auth0ClientId=<your-client-id>
+auth0Audience=https://auth0.example.com/api/v2/
+```
+
+All settings can also be overridden with environment variables (useful for CI/CD):
+
+| Environment Variable | Config Field |
+|---------------------|---------------|
+| `SOS_API_URL` | `apiUrl` |
+| `SOS_BOX_HOST` | `boxUrl` |
+| `SOS_AUTH0_DOMAIN` | `auth0Domain` |
+| `SOS_AUTH0_CLIENT_ID` | `auth0ClientId` |
+| `SOS_AUTH0_AUDIENCE` | `auth0Audience` |
+| `SOS_AUTH0_SCOPE` | `auth0Scope` |
+
 ### Applet
 ```bash
 sos applet --help

package/dist/Auth/auth0Settings.d.ts

@@ -3,6 +3,11 @@ import { Auth0Settings } from '@signageos/cli-common';
  * Auth0 settings for the signageOS CLI tool (regular API).
  *
  * These connect to the regular signageOS API (not admin API).
- * Override with environment variables for testing or custom Auth0 tenants.
+ * Precedence: environment variable > profile field in ~/.sosrc > .env default.
  */
 export declare function getAuth0Settings(): Auth0Settings;
+/**
+ * Read the Box URL from the active profile.
+ * Precedence: profile field in ~/.sosrc > environment variable (.env default).
+ */
+export declare function getBoxUrl(): string;

package/dist/Auth/auth0Settings.js

@@ -1,18 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAuth0Settings = getAuth0Settings;
+exports.getBoxUrl = getBoxUrl;
+const cli_common_1 = require("@signageos/cli-common");
+const globalArgs_1 = require("../Command/globalArgs");
 /**
  * Auth0 settings for the signageOS CLI tool (regular API).
  *
  * These connect to the regular signageOS API (not admin API).
- * Override with environment variables for testing or custom Auth0 tenants.
+ * Precedence: environment variable > profile field in ~/.sosrc > .env default.
  */
 function getAuth0Settings() {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const profile = (0, globalArgs_1.getGlobalProfile)();
     return {
-        domain: (_a = process.env.SOS_AUTH0_DOMAIN) !== null && _a !== void 0 ? _a : 'auth0.signageos.io',
-        clientId: (_b = process.env.SOS_AUTH0_CLIENT_ID) !== null && _b !== void 0 ? _b : '8AU8D3zJ4mK8gszZP3gZO0nv9DusSNjV',
-        audience: (_c = process.env.SOS_AUTH0_AUDIENCE) !== null && _c !== void 0 ? _c : 'https://sos-production.us.auth0.com/api/v2/',
-        scope: (_d = process.env.SOS_AUTH0_SCOPE) !== null && _d !== void 0 ? _d : 'openid profile email offline_access',
+        domain: (_b = (_a = (0, cli_common_1.readProfileField)('auth0Domain', profile)) !== null && _a !== void 0 ? _a : process.env.SOS_AUTH0_DOMAIN) !== null && _b !== void 0 ? _b : '',
+        clientId: (_d = (_c = (0, cli_common_1.readProfileField)('auth0ClientId', profile)) !== null && _c !== void 0 ? _c : process.env.SOS_AUTH0_CLIENT_ID) !== null && _d !== void 0 ? _d : '',
+        audience: (_f = (_e = (0, cli_common_1.readProfileField)('auth0Audience', profile)) !== null && _e !== void 0 ? _e : process.env.SOS_AUTH0_AUDIENCE) !== null && _f !== void 0 ? _f : '',
+        scope: (_h = (_g = (0, cli_common_1.readProfileField)('auth0Scope', profile)) !== null && _g !== void 0 ? _g : process.env.SOS_AUTH0_SCOPE) !== null && _h !== void 0 ? _h : '',
     };
 }
+/**
+ * Read the Box URL from the active profile.
+ * Precedence: profile field in ~/.sosrc > environment variable (.env default).
+ */
+function getBoxUrl() {
+    var _a, _b;
+    const profile = (0, globalArgs_1.getGlobalProfile)();
+    return (_b = (_a = (0, cli_common_1.readProfileField)('boxUrl', profile)) !== null && _a !== void 0 ? _a : process.env.SOS_BOX_HOST) !== null && _b !== void 0 ? _b : '';
+}

package/dist/Auth/loginCommand.d.ts

@@ -10,6 +10,9 @@
  * # Interactive login (opens browser for Auth0 authentication)
  * sos login
  *
+ * # Login with custom configuration (prompts for Auth0 and connection settings)
+ * sos login --interactive-profile
+ *
  * # Login with a specific profile
  * sos --profile staging login
  * ```
@@ -19,7 +22,11 @@
 export declare const login: {
     name: "login";
     description: string;
-    optionList: never[];
+    optionList: readonly [{
+        readonly name: "interactive-profile";
+        readonly type: BooleanConstructor;
+        readonly description: "Prompt for custom Auth0 and connection settings (for custom deployments)";
+    }];
     commands: never[];
-    run(): Promise<void>;
+    run(options: import("../Command/commandDefinition").CommandLineOptions<readonly Readonly<Readonly<import("command-line-args").OptionDefinition & import("command-line-usage").OptionDefinition>>[]>): Promise<void>;
 };

package/dist/Auth/loginCommand.js

@@ -17,7 +17,6 @@ const node_child_process_1 = require("node:child_process");
 const node_os_1 = require("node:os");
 const chalk_1 = __importDefault(require("chalk"));
 const prompts_1 = __importDefault(require("prompts"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
 const log_1 = require("@signageos/sdk/dist/Console/log");
 const sosControlHelper_1 = require("@signageos/sdk/dist/SosHelper/sosControlHelper");
 const cli_common_1 = require("@signageos/cli-common");
@@ -37,6 +36,13 @@ function openInBrowser(url) {
         }
     });
 }
+const LOGIN_OPTION_LIST = [
+    {
+        name: 'interactive-profile',
+        type: Boolean,
+        description: 'Prompt for custom Auth0 and connection settings (for custom deployments)',
+    },
+];
 /**
  * Authenticates the user via the Auth0 Device Authorization Flow.
  * Opens a browser-based verification page where the user logs in,
@@ -49,6 +55,9 @@ function openInBrowser(url) {
  * # Interactive login (opens browser for Auth0 authentication)
  * sos login
  *
+ * # Login with custom configuration (prompts for Auth0 and connection settings)
+ * sos login --interactive-profile
+ *
  * # Login with a specific profile
  * sos --profile staging login
  * ```
@@ -58,35 +67,68 @@ function openInBrowser(url) {
 exports.login = (0, commandDefinition_1.createCommandDefinition)({
     name: 'login',
     description: 'Authenticate user with signageOS via Auth0',
-    optionList: [],
+    optionList: LOGIN_OPTION_LIST,
     commands: [],
-    run() {
+    run(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
+            var _a, _b, _c, _d, _e, _f;
             const profile = (0, globalArgs_1.getGlobalProfile)();
             const configFilePath = (0, sosControlHelper_1.getConfigFilePath)();
-            // Detect a new (non-existent) named profile and prompt for the API URL
-            if (profile) {
-                const exists = (yield fs_extra_1.default.pathExists(configFilePath)) && (0, cli_common_1.profileExists)(profile);
-                if (!exists) {
-                    (0, log_1.log)('info', `Profile "${profile}" does not exist in ${configFilePath}. Please enter the server API URL to create it.`);
-                    const { inputApiUrl } = yield (0, prompts_1.default)({
-                        type: 'text',
-                        name: 'inputApiUrl',
-                        message: 'Server API URL',
-                        initial: 'https://api.signageos.io',
-                        validate: (v) => (v.startsWith('http') ? true : 'Must be a valid URL starting with http'),
-                    });
-                    if (!inputApiUrl) {
-                        throw new Error('API URL is required to log in.');
-                    }
-                    (0, cli_common_1.writeProfileField)('apiUrl', inputApiUrl.replace(/\/+$/, ''), profile);
+            const interactiveProfile = options['interactive-profile'];
+            if (interactiveProfile) {
+                (0, log_1.log)('info', `Setting up custom connection settings in ${configFilePath}.`);
+                const { inputApiUrl } = yield (0, prompts_1.default)({
+                    type: 'text',
+                    name: 'inputApiUrl',
+                    message: 'Server API URL',
+                    initial: (_a = process.env.SOS_API_URL) !== null && _a !== void 0 ? _a : 'https://api.signageos.io',
+                    validate: (v) => (v.startsWith('http') ? true : 'Must be a valid URL starting with http'),
+                });
+                if (!inputApiUrl) {
+                    throw new Error('API URL is required to log in.');
+                }
+                (0, cli_common_1.writeProfileField)('apiUrl', inputApiUrl.replace(/\/+$/, ''), profile);
+                const { inputBoxUrl } = yield (0, prompts_1.default)({
+                    type: 'text',
+                    name: 'inputBoxUrl',
+                    message: 'Box URL',
+                    initial: (_b = process.env.SOS_BOX_HOST) !== null && _b !== void 0 ? _b : 'box.signageos.io',
+                });
+                if (inputBoxUrl) {
+                    (0, cli_common_1.writeProfileField)('boxUrl', inputBoxUrl.replace(/\/+$/, ''), profile);
+                }
+                const { inputAuth0Domain } = yield (0, prompts_1.default)({
+                    type: 'text',
+                    name: 'inputAuth0Domain',
+                    message: 'Auth0 domain',
+                    initial: (_c = process.env.SOS_AUTH0_DOMAIN) !== null && _c !== void 0 ? _c : 'auth0.signageos.io',
+                });
+                if (inputAuth0Domain) {
+                    (0, cli_common_1.writeProfileField)('auth0Domain', inputAuth0Domain, profile);
+                }
+                const { inputAuth0ClientId } = yield (0, prompts_1.default)({
+                    type: 'text',
+                    name: 'inputAuth0ClientId',
+                    message: 'Auth0 client ID',
+                    initial: (_d = process.env.SOS_AUTH0_CLIENT_ID) !== null && _d !== void 0 ? _d : '',
+                });
+                if (inputAuth0ClientId) {
+                    (0, cli_common_1.writeProfileField)('auth0ClientId', inputAuth0ClientId, profile);
+                }
+                const { inputAuth0Audience } = yield (0, prompts_1.default)({
+                    type: 'text',
+                    name: 'inputAuth0Audience',
+                    message: 'Auth0 audience',
+                    initial: (_e = process.env.SOS_AUTH0_AUDIENCE) !== null && _e !== void 0 ? _e : '',
+                });
+                if (inputAuth0Audience) {
+                    (0, cli_common_1.writeProfileField)('auth0Audience', inputAuth0Audience, profile);
                 }
             }
             const auth0 = (0, auth0Settings_1.getAuth0Settings)();
             (0, log_1.log)('info', 'Starting Auth0 Device Authorization Flow...');
             const deviceCode = yield (0, cli_common_1.requestDeviceCode)(auth0);
-            const verificationUrl = (_a = deviceCode.verification_uri_complete) !== null && _a !== void 0 ? _a : deviceCode.verification_uri;
+            const verificationUrl = (_f = deviceCode.verification_uri_complete) !== null && _f !== void 0 ? _f : deviceCode.verification_uri;
             // Try to open the verification URL in the default browser
             openInBrowser(verificationUrl);
             console.info('');

package/docs/login/index.md

@@ -20,12 +20,21 @@ then stores the resulting JWT tokens in `~/.sosrc`.
 sos login [options]
 ```
 
+## Options
+
+| Option                  | Description                                                                        |
+| ----------------------- | ---------------------------------------------------------------------------------- |
+| `--interactive-profile` | Prompt for custom Auth0 and connection settings (for custom deployments) (boolean) |
+
 ## Examples
 
 ```bash
 # Interactive login (opens browser for Auth0 authentication)
 sos login
 
+# Login with custom configuration (prompts for Auth0 and connection settings)
+sos login --interactive-profile
+
 # Login with a specific profile
 sos --profile staging login
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/cli",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "main": "./dist/index.js",
   "author": "signageOS.io <dev@signageos.io>",
   "files": [