@signageos/cli 2.4.1 → 2.6.0-rc.0

package/docs/runner/index.md

@@ -0,0 +1,72 @@
+---
+id: runner-index
+title: runner
+sidebar_position: 0
+---
+# runner
+
+Runner management
+
+
+## Usage
+
+```bash
+sos runner <subcommand> [options]
+```
+
+## Subcommands
+
+### generate
+
+Generates a local repository for developing a Runner
+
+```bash
+sos runner generate [options]
+```
+
+[→ See detailed documentation](/cli/runner/generate/)
+
+### upload
+
+Uploads current runner version
+
+```bash
+sos runner upload [options]
+```
+
+[→ See detailed documentation](/cli/runner/upload/)
+
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```
+
+
+## Related Commands
+
+- [`sos runner generate`](/cli/runner/generate/) - Generates a local repository for developing a Runner
+- [`sos runner upload`](/cli/runner/upload/) - Uploads current runner version

package/docs/runner/upload/index.md

@@ -0,0 +1,50 @@
+---
+id: runner-upload-index
+title: upload
+sidebar_position: 0
+---
+# upload
+
+Uploads current runner version
+
+
+## Usage
+
+```bash
+sos runner upload [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```

package/docs/timing/index.md

@@ -0,0 +1,78 @@
+---
+id: timing-index
+title: timing
+sidebar_position: 40
+---
+# timing
+
+Timing management
+
+
+## Description
+
+Provides commands for managing timing configurations that control when and how
+applets are displayed on signageOS devices. Timing configurations define the
+relationship between devices, applets, and scheduling parameters.
+
+## Usage
+
+```bash
+sos timing <subcommand> [options]
+```
+
+## Subcommands
+
+### list
+
+List timing configurations assigned to a device
+
+```bash
+sos timing list [options]
+```
+
+[→ See detailed documentation](/cli/timing/list/)
+
+
+## Examples
+
+```bash
+# List timing configurations
+sos timing list
+```
+
+## Since
+
+0.3.0
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```
+
+
+## Related Commands
+
+- [`sos timing list`](/cli/timing/list/) - List timing configurations assigned to a device

package/docs/timing/list/index.md

@@ -0,0 +1,71 @@
+---
+id: timing-list-index
+title: list
+sidebar_position: 41
+---
+# list
+
+List timing configurations assigned to a device
+
+
+## Description
+
+Retrieves and displays all timing configurations that are currently assigned
+to a specific device. Timing configurations define when and how content
+(applets) should be displayed on devices, including scheduling and duration settings.
+
+## Usage
+
+```bash
+sos timing list [options]
+```
+
+## Options
+
+| Option                      | Description                                                      |
+| --------------------------- | ---------------------------------------------------------------- |
+| `--no-default-organization` | Prevent using the defaultOrganizationUid from ~/.sosrc (boolean) |
+| `--organization-uid`        | Organization UID (string)                                        |
+| `--device-uid`              | Device UID (string)                                              |
+
+## Examples
+
+```bash
+# List timings for a specific device
+sos timing list --device-uid device123
+
+# List timings with organization override
+sos timing list --device-uid device123 --organization-uid org456
+```
+
+## Since
+
+0.3.0
+
+## Global Options
+
+All commands support the following global options:
+
+| Option | Alias | Description |
+|--------|-------|-------------|
+| `--help` | `-h` | Display help information for any command |
+| `--version` | `-v` | Display the installed version of the CLI |
+| `--api-url` | `-u` | Override the API URL for REST requests |
+| `--profile` | | Use a specific profile from ~/.sosrc config |
+
+### Examples
+
+```bash
+# Show version
+sos --version
+
+# Get help for any command
+sos applet --help
+sos applet upload --help
+
+# Use custom API endpoint
+sos --api-url https://api.example.com applet upload
+
+# Use specific profile
+sos --profile production organization list
+```

package/package.json

@@ -1,35 +1,41 @@
 {
   "name": "@signageos/cli",
-  "version": "2.4.1",
+  "version": "2.6.0-rc.0",
   "main": "./dist/index.js",
+  "author": "signageOS.io <dev@signageos.io>",
   "files": [
     ".env",
     "dist",
     "README.md",
-    "package.json"
+    "package.json",
+    "docs"
   ],
   "repository": {
     "url": "https://github.com/signageos/cli",
     "type": "git"
   },
   "scripts": {
-    "build": "npx check-engine@latest && tsc && npm run build:templates",
-    "build:templates": "node tools/include-templates.js",
-    "lint": "eslint --config ./eslint.config.mjs --ext .ts,.tsx,.js ./src/",
-    "lint:fix": "eslint --config ./eslint.config.mjs --fix --ext .ts,.tsx,.js ./src/",
-    "lint:prettier": "prettier  \"(src|tests|tools)/**/*.+(ts|tsx|json|js)\" --check",
-    "lint:prettier:fix": "prettier  \"(src|tests|tools)/**/*.+(ts|tsx|json|js)\" --write",
     "clean": "rm -rf dist/*",
-    "clean-build": "npm run clean && npm run build && chmod +x dist/index.js",
+    "build": "npx check-engine@latest && tsc && npm run build:templates && npm run docs",
+    "build:templates": "node tools/include-templates.mjs",
+    "clean-build": "npm run clean && npm run build",
+    "watch": "tsc --watch",
+    "check-types": "tsc --noEmit",
     "test": "env NODE_ENV=test mocha",
-    "test:windows": "cross-env NODE_ENV=test mocha",
     "test:coverage": "c8 npm run test",
-    "watch": "tsc --watch",
-    "check": "npm run depcheck && npx --userconfig ./.npmrc @signageos/lib-ci check-deps && npm run check-circular-deps",
+    "test:windows": "cross-env NODE_ENV=test mocha",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "lint:prettier": "prettier  \"(src|tests|tools)/**/*.+(ts|tsx|json|js)\" --check",
+    "lint:prettier:fix": "prettier  \"(src|tests|tools)/**/*.+(ts|tsx|json|js)\" --write",
+    "test:node-versions": "./tests/integration/test-node-versions.sh",
+    "test:integration:node-versions": "env NODE_ENV=test mocha --config .mocharc.node-versions.json",
+    "check": "npm run depcheck && npx --userconfig ./.npmrc @signageos/lib-ci check-deps && npm run check-circular-deps && npm run check-types",
     "check-circular-deps": "npx madge@5 --circular --extensions ts ./src/",
     "depcheck": "depcheck --config .depcheckrc.json",
-    "typecheck": "tsc --noEmit",
-    "prettier:format": "prettier \"(src|tests|tools)/**/*.+(ts|js)\" --write",
+    "docs": "npm run docs:generate && npm run docs:validate",
+    "docs:generate": "tsx tools/docs/generate.ts --action=generate --filePath=src/index.ts",
+    "docs:validate": "tsx tools/docs/validate/validate-docs-links.ts",
     "postinstall": "node -e \"try{require('./postinstall.js')}catch(e){}\""
   },
   "license": "MIT",
@@ -42,7 +48,7 @@
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "1.0.2",
-    "@signageos/codestyle": "1.0.0",
+    "@signageos/codestyle": "2.0.3",
     "@types/archiver": "6.0.3",
     "@types/child-process-promise": "2.2.6",
     "@types/cli-progress": "3.11.6",
@@ -55,7 +61,6 @@
     "@types/mime": "3.0.4",
     "@types/mocha": "10.0.10",
     "@types/node": "22.15.3",
-    "@types/node-fetch": "2.6.12",
     "@types/prompts": "2.4.9",
     "@types/semver": "7.7.0",
     "@types/sinon": "17.0.4",
@@ -65,16 +70,21 @@
     "cross-env": "7.0.3",
     "depcheck": "1.4.7",
     "mocha": "11.2.2",
-    "rewiremock": "3.14.5",
+    "rewiremock": "3.14.6",
     "should": "13.2.3",
     "sinon": "20.0.0",
     "ts-node": "10.9.2",
+    "tsx": "4.20.3",
     "typescript": "5.8.3",
     "unzipper": "0.12.3"
   },
+  "overrides": {
+    "cross-spawn": "^7.0.6",
+    "http-cache-semantics": "^4.2.0"
+  },
   "dependencies": {
     "@signageos/file": "1.0.1",
-    "@signageos/sdk": "1.27.5",
+    "@signageos/sdk": "1.29.0",
     "archiver": "7.0.1",
     "chalk": "2.4.2",
     "child-process-promise": "2.2.1",
@@ -87,8 +97,8 @@
     "express": "5.1.0",
     "fs-extra": "11.3.0",
     "internal-ip": "8.0.0",
+    "markdown-table": "3.0.4",
     "mime": "2.4.4",
-    "node-fetch": "2.7.0",
     "prompts": "2.4.2",
     "semver": "7.7.1",
     "serve-static": "2.2.0",