@dishantlangayan/sc-plugin-broker 0.1.0

package/oclif.manifest.json

@@ -0,0 +1,475 @@
+{
+  "commands": {
+    "broker:logout": {
+      "aliases": [],
+      "args": {},
+      "description": "Logout from authenticated brokers.\n\nRemoves locally stored broker credentials.\nInteractive mode allows selection with arrow keys and spacebar.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --broker-name=dev-broker",
+        "<%= config.bin %> <%= command.id %> --all",
+        "<%= config.bin %> <%= command.id %> --broker-name=prod --no-prompt"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "all": {
+          "char": "a",
+          "description": "Logout from all brokers",
+          "exclusive": [
+            "broker-name"
+          ],
+          "name": "all",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "broker-name": {
+          "char": "b",
+          "description": "Broker name to logout from",
+          "exclusive": [
+            "all"
+          ],
+          "name": "broker-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "no-prompt": {
+          "description": "Skip confirmation prompt and assume Yes",
+          "name": "no-prompt",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "broker:logout",
+      "pluginAlias": "@dishantlangayan/sc-plugin-broker",
+      "pluginName": "@dishantlangayan/sc-plugin-broker",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "broker",
+        "logout.js"
+      ]
+    },
+    "broker:login:basic": {
+      "aliases": [],
+      "args": {},
+      "description": "Login to a Solace Event Broker using Basic authentication.\n\nStores broker credentials securely using encrypted local storage.\nCredentials are base64-encoded and encrypted before storage.\n\nIf a broker with the same name already exists, you'll be prompted to overwrite.\n\nRequired SEMP permissions: Varies by operations you intend to perform",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --broker-name=dev-broker --semp-url=https://localhost --semp-port=8080",
+        "<%= config.bin %> <%= command.id %> --broker-name=ci-broker --semp-url=http://192.168.1.100 --semp-port=8080 --no-prompt",
+        "<%= config.bin %> <%= command.id %> --broker-name=default-broker --semp-url=https://broker.example.com --semp-port=943 --set-default"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "broker-name": {
+          "char": "b",
+          "description": "Name/identifier for the broker",
+          "name": "broker-name",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "no-prompt": {
+          "description": "Read credentials from SC_SEMP_USERNAME and SC_SEMP_PASSWORD environment variables",
+          "name": "no-prompt",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "semp-port": {
+          "char": "p",
+          "description": "SEMP port number (1-65535)",
+          "name": "semp-port",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "semp-url": {
+          "char": "u",
+          "description": "SEMP endpoint URL (must start with http:// or https://)",
+          "name": "semp-url",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "set-default": {
+          "char": "d",
+          "description": "Set this broker as the default",
+          "name": "set-default",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "broker:login:basic",
+      "pluginAlias": "@dishantlangayan/sc-plugin-broker",
+      "pluginName": "@dishantlangayan/sc-plugin-broker",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "broker",
+        "login",
+        "basic.js"
+      ]
+    },
+    "broker:login:cloud": {
+      "aliases": [],
+      "args": {},
+      "description": "Login to a Solace Cloud Event Broker using Cloud API credentials.\n\nRetrieves SEMP credentials automatically from Solace Cloud REST API.\nRequires prior authentication to Solace Cloud (org:login).\n\nThe command will:\n1. Look up the broker by name in your Solace Cloud organization\n2. Retrieve SEMP endpoint details and credentials from Cloud API\n3. Store encrypted broker credentials locally for future use\n\nRequired Cloud API permissions: Read access to Event Broker Services",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --broker-name=production-broker",
+        "<%= config.bin %> <%= command.id %> --broker-name=dev-broker --set-default",
+        "<%= config.bin %> <%= command.id %> --broker-name=staging-broker --org-name=my-org",
+        "<%= config.bin %> <%= command.id %> --broker-name=prod --no-prompt"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "broker-name": {
+          "char": "b",
+          "description": "Name of the broker in Solace Cloud",
+          "name": "broker-name",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "no-prompt": {
+          "description": "Skip confirmation prompts for overwriting existing broker",
+          "name": "no-prompt",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "org-name": {
+          "char": "o",
+          "description": "Solace Cloud organization name (uses default org if not specified)",
+          "name": "org-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "set-default": {
+          "char": "d",
+          "description": "Set this broker as the default",
+          "name": "set-default",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "broker:login:cloud",
+      "pluginAlias": "@dishantlangayan/sc-plugin-broker",
+      "pluginName": "@dishantlangayan/sc-plugin-broker",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "broker",
+        "login",
+        "cloud.js"
+      ]
+    },
+    "broker:login:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List all authenticated brokers.\n\nDisplays brokers you have logged into, including their authentication type, SEMP endpoints, and which one is set as default.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "broker:login:list",
+      "pluginAlias": "@dishantlangayan/sc-plugin-broker",
+      "pluginName": "@dishantlangayan/sc-plugin-broker",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "broker",
+        "login",
+        "list.js"
+      ]
+    },
+    "broker:queue:create": {
+      "aliases": [],
+      "args": {},
+      "description": "Create a Queue on a Solace Event Broker.\n\nAny attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default",
+        "<%= config.bin %> <%= command.id %> --broker-id=dev-broker --queue-name=myQueue --msg-vpn-name=default --access-type=non-exclusive",
+        "<%= config.bin %> <%= command.id %> --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default --owner=user1 --permission=consume",
+        "<%= config.bin %> <%= command.id %> --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default --max-msg-spool-usage=1024 --egress-enabled --ingress-enabled",
+        "<%= config.bin %> <%= command.id %> --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default --dead-msg-queue=#DEAD_MSG_QUEUE --max-redelivery-count=3"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "access-type": {
+          "char": "a",
+          "description": "The access type for the queue.",
+          "name": "access-type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "exclusive",
+            "non-exclusive"
+          ],
+          "type": "option"
+        },
+        "broker-id": {
+          "char": "b",
+          "description": "Stored broker identifier.",
+          "name": "broker-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "broker-name": {
+          "char": "n",
+          "description": "Stored broker name.",
+          "name": "broker-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "dead-msg-queue": {
+          "description": "The name of the Dead Message Queue.",
+          "name": "dead-msg-queue",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "egress-enabled": {
+          "description": "Enable or disable egress (message consumption) from the queue.",
+          "name": "egress-enabled",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "ingress-enabled": {
+          "description": "Enable or disable ingress (message reception) to the queue.",
+          "name": "ingress-enabled",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "max-msg-spool-usage": {
+          "char": "s",
+          "description": "The maximum message spool usage allowed by the queue, in megabytes (MB).",
+          "name": "max-msg-spool-usage",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "max-redelivery-count": {
+          "description": "The maximum number of times a message will be redelivered before it is discarded or moved to the DMQ.",
+          "name": "max-redelivery-count",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "max-ttl": {
+          "description": "The maximum time in seconds a message can stay in the queue when respect-ttl-enabled is true.",
+          "name": "max-ttl",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "msg-vpn-name": {
+          "char": "v",
+          "description": "The name of the Message VPN.",
+          "name": "msg-vpn-name",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "owner": {
+          "char": "o",
+          "description": "The client username that owns the queue and has permission equivalent to delete.",
+          "name": "owner",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "permission": {
+          "char": "p",
+          "description": "The permission level for all consumers of the queue, excluding the owner.",
+          "name": "permission",
+          "default": "consume",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "consume",
+            "delete",
+            "modify-topic",
+            "no-access",
+            "read-only"
+          ],
+          "type": "option"
+        },
+        "queue-name": {
+          "char": "q",
+          "description": "The name of the queue to create.",
+          "name": "queue-name",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "respect-ttl-enabled": {
+          "description": "Enable or disable the respecting of the time-to-live (TTL) for messages.",
+          "name": "respect-ttl-enabled",
+          "allowNo": true,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "broker:queue:create",
+      "pluginAlias": "@dishantlangayan/sc-plugin-broker",
+      "pluginName": "@dishantlangayan/sc-plugin-broker",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "broker",
+        "queue",
+        "create.js"
+      ]
+    }
+  },
+  "version": "0.1.0"
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@dishantlangayan/sc-plugin-broker",
+  "description": "Commands to interact with Solace Event Broker.",
+  "version": "0.1.0",
+  "author": "Dishant Langayan",
+  "bin": {
+    "sc": "./bin/run.js"
+  },
+  "bugs": "https://github.com/dishantlangayan/sc-plugin-broker/issues",
+  "dependencies": {
+    "@dishantlangayan/sc-cli-core": "^0.7.3",
+    "@inquirer/prompts": "^8.3.0",
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "@types/sinon": "^21.0.0",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "sinon": "^21.0.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/dishantlangayan/sc-plugin-broker",
+  "keywords": [
+    "oclif",
+    "solace",
+    "cli",
+    "sc",
+    "sc-plugin"
+  ],
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "sc",
+    "dirname": "sc",
+    "commands": "./dist/commands",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "topicSeparator": " "
+  },
+  "repository": "dishantlangayan/sc-plugin-broker",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts"
+}