@dishantlangayan/sc-plugin-broker 0.1.0

package/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,268 @@
+@dishantlangayan/sc-plugin-broker
+=================
+
+Commands to interact with Solace Event Broker.
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/@dishantlangayan/sc-plugin-broker.svg)](https://npmjs.org/package/@dishantlangayan/sc-plugin-broker)
+[![Downloads/week](https://img.shields.io/npm/dw/@dishantlangayan/sc-plugin-broker.svg)](https://npmjs.org/package/@dishantlangayan/sc-plugin-broker)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Resources](#resources)
+* [Contributing](#contributing)
+* [Authors](#authors)
+* [License](#license)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @dishantlangayan/sc-plugin-broker
+$ sc COMMAND
+running command...
+$ sc (--version)
+@dishantlangayan/sc-plugin-broker/0.1.0 darwin-arm64 node-v24.1.0
+$ sc --help [COMMAND]
+USAGE
+  $ sc COMMAND
+...
+```
+<!-- usagestop -->
+# Resources
+<!-- resources -->
+This is not an officially supported Solace product.
+
+For more information try these resources:
+- Ask the [Solace Community](https://solace.community)
+- The Solace Developer Portal website at: https://solace.dev
+
+<!-- resourcesstop -->
+# Contributing
+<!-- contributing -->
+Contributions are encouraged! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+<!-- contributingstop -->
+# Authors
+<!-- authors -->
+See the list of [contributors](https://github.com/dishantlangayan/sc-plugin-broker/graphs/contributors) who participated in this project.
+
+<!-- authorsstop -->
+# License
+<!-- license -->
+See the [LICENSE](LICENSE.txt) file for details.
+
+<!-- licensestop -->
+# Commands
+<!-- commands -->
+* [`sc broker login basic`](#sc-broker-login-basic)
+* [`sc broker login cloud`](#sc-broker-login-cloud)
+* [`sc broker login list`](#sc-broker-login-list)
+* [`sc broker logout`](#sc-broker-logout)
+* [`sc broker queue create`](#sc-broker-queue-create)
+
+## `sc broker login basic`
+
+Login to a Solace Event Broker using Basic authentication.
+
+```
+USAGE
+  $ sc broker login basic -b <value> -p <value> -u <value> [--json] [--log-level debug|warn|error|info|trace]
+    [--no-prompt] [-d]
+
+FLAGS
+  -b, --broker-name=<value>  (required) Name/identifier for the broker
+  -d, --set-default          Set this broker as the default
+  -p, --semp-port=<value>    (required) SEMP port number (1-65535)
+  -u, --semp-url=<value>     (required) SEMP endpoint URL (must start with http:// or https://)
+      --no-prompt            Read credentials from SC_SEMP_USERNAME and SC_SEMP_PASSWORD environment variables
+
+GLOBAL FLAGS
+  --json                Format output as json.
+  --log-level=<option>  [default: info] Specify level for logging.
+                        <options: debug|warn|error|info|trace>
+
+DESCRIPTION
+  Login to a Solace Event Broker using Basic authentication.
+
+  Stores broker credentials securely using encrypted local storage.
+  Credentials are base64-encoded and encrypted before storage.
+
+  If a broker with the same name already exists, you'll be prompted to overwrite.
+
+  Required SEMP permissions: Varies by operations you intend to perform
+
+EXAMPLES
+  $ sc broker login basic --broker-name=dev-broker --semp-url=https://localhost --semp-port=8080
+
+  $ sc broker login basic --broker-name=ci-broker --semp-url=http://192.168.1.100 --semp-port=8080 --no-prompt
+
+  $ sc broker login basic --broker-name=default-broker --semp-url=https://broker.example.com --semp-port=943 --set-default
+```
+
+_See code: [src/commands/broker/login/basic.ts](https://github.com/dishantlangayan/sc-plugin-broker/blob/v0.1.0/src/commands/broker/login/basic.ts)_
+
+## `sc broker login cloud`
+
+Login to a Solace Cloud Event Broker using Cloud API credentials.
+
+```
+USAGE
+  $ sc broker login cloud -b <value> [--json] [--log-level debug|warn|error|info|trace] [--no-prompt] [-o <value>] [-d]
+
+FLAGS
+  -b, --broker-name=<value>  (required) Name of the broker in Solace Cloud
+  -d, --set-default          Set this broker as the default
+  -o, --org-name=<value>     Solace Cloud organization name (uses default org if not specified)
+      --no-prompt            Skip confirmation prompts for overwriting existing broker
+
+GLOBAL FLAGS
+  --json                Format output as json.
+  --log-level=<option>  [default: info] Specify level for logging.
+                        <options: debug|warn|error|info|trace>
+
+DESCRIPTION
+  Login to a Solace Cloud Event Broker using Cloud API credentials.
+
+  Retrieves SEMP credentials automatically from Solace Cloud REST API.
+  Requires prior authentication to Solace Cloud (org:login).
+
+  The command will:
+  1. Look up the broker by name in your Solace Cloud organization
+  2. Retrieve SEMP endpoint details and credentials from Cloud API
+  3. Store encrypted broker credentials locally for future use
+
+  Required Cloud API permissions: Read access to Event Broker Services
+
+EXAMPLES
+  $ sc broker login cloud --broker-name=production-broker
+
+  $ sc broker login cloud --broker-name=dev-broker --set-default
+
+  $ sc broker login cloud --broker-name=staging-broker --org-name=my-org
+
+  $ sc broker login cloud --broker-name=prod --no-prompt
+```
+
+_See code: [src/commands/broker/login/cloud.ts](https://github.com/dishantlangayan/sc-plugin-broker/blob/v0.1.0/src/commands/broker/login/cloud.ts)_
+
+## `sc broker login list`
+
+List all authenticated brokers.
+
+```
+USAGE
+  $ sc broker login list [--json] [--log-level debug|warn|error|info|trace]
+
+GLOBAL FLAGS
+  --json                Format output as json.
+  --log-level=<option>  [default: info] Specify level for logging.
+                        <options: debug|warn|error|info|trace>
+
+DESCRIPTION
+  List all authenticated brokers.
+
+  Displays brokers you have logged into, including their authentication type, SEMP endpoints, and which one is set as
+  default.
+
+EXAMPLES
+  $ sc broker login list
+```
+
+_See code: [src/commands/broker/login/list.ts](https://github.com/dishantlangayan/sc-plugin-broker/blob/v0.1.0/src/commands/broker/login/list.ts)_
+
+## `sc broker logout`
+
+Logout from authenticated brokers.
+
+```
+USAGE
+  $ sc broker logout [--json] [--log-level debug|warn|error|info|trace] [-a | -b <value>] [--no-prompt]
+
+FLAGS
+  -a, --all                  Logout from all brokers
+  -b, --broker-name=<value>  Broker name to logout from
+      --no-prompt            Skip confirmation prompt and assume Yes
+
+GLOBAL FLAGS
+  --json                Format output as json.
+  --log-level=<option>  [default: info] Specify level for logging.
+                        <options: debug|warn|error|info|trace>
+
+DESCRIPTION
+  Logout from authenticated brokers.
+
+  Removes locally stored broker credentials.
+  Interactive mode allows selection with arrow keys and spacebar.
+
+EXAMPLES
+  $ sc broker logout
+
+  $ sc broker logout --broker-name=dev-broker
+
+  $ sc broker logout --all
+
+  $ sc broker logout --broker-name=prod --no-prompt
+```
+
+_See code: [src/commands/broker/logout.ts](https://github.com/dishantlangayan/sc-plugin-broker/blob/v0.1.0/src/commands/broker/logout.ts)_
+
+## `sc broker queue create`
+
+Create a Queue on a Solace Event Broker.
+
+```
+USAGE
+  $ sc broker queue create -v <value> -q <value> [--json] [--log-level debug|warn|error|info|trace] [-a
+    exclusive|non-exclusive] [-b <value>] [-n <value>] [--dead-msg-queue <value>] [--egress-enabled] [--ingress-enabled]
+    [-s <value>] [--max-redelivery-count <value>] [--max-ttl <value>] [-o <value>] [-p
+    consume|delete|modify-topic|no-access|read-only] [--respect-ttl-enabled]
+
+FLAGS
+  -a, --access-type=<option>          The access type for the queue.
+                                      <options: exclusive|non-exclusive>
+  -b, --broker-id=<value>             Stored broker identifier.
+  -n, --broker-name=<value>           Stored broker name.
+  -o, --owner=<value>                 The client username that owns the queue and has permission equivalent to delete.
+  -p, --permission=<option>           [default: consume] The permission level for all consumers of the queue, excluding
+                                      the owner.
+                                      <options: consume|delete|modify-topic|no-access|read-only>
+  -q, --queue-name=<value>            (required) The name of the queue to create.
+  -s, --max-msg-spool-usage=<value>   The maximum message spool usage allowed by the queue, in megabytes (MB).
+  -v, --msg-vpn-name=<value>          (required) The name of the Message VPN.
+      --dead-msg-queue=<value>        The name of the Dead Message Queue.
+      --[no-]egress-enabled           Enable or disable egress (message consumption) from the queue.
+      --[no-]ingress-enabled          Enable or disable ingress (message reception) to the queue.
+      --max-redelivery-count=<value>  The maximum number of times a message will be redelivered before it is discarded
+                                      or moved to the DMQ.
+      --max-ttl=<value>               The maximum time in seconds a message can stay in the queue when
+                                      respect-ttl-enabled is true.
+      --[no-]respect-ttl-enabled      Enable or disable the respecting of the time-to-live (TTL) for messages.
+
+GLOBAL FLAGS
+  --json                Format output as json.
+  --log-level=<option>  [default: info] Specify level for logging.
+                        <options: debug|warn|error|info|trace>
+
+DESCRIPTION
+  Create a Queue on a Solace Event Broker.
+
+  Any 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
+  $ sc broker queue create --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default
+
+  $ sc broker queue create --broker-id=dev-broker --queue-name=myQueue --msg-vpn-name=default --access-type=non-exclusive
+
+  $ sc broker queue create --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default --owner=user1 --permission=consume
+
+  $ sc broker queue create --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default --max-msg-spool-usage=1024 --egress-enabled --ingress-enabled
+
+  $ sc broker queue create --broker-name=dev-broker --queue-name=myQueue --msg-vpn-name=default --dead-msg-queue=#DEAD_MSG_QUEUE --max-redelivery-count=3
+```
+
+_See code: [src/commands/broker/queue/create.ts](https://github.com/dishantlangayan/sc-plugin-broker/blob/v0.1.0/src/commands/broker/queue/create.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/broker/login/basic.d.ts

@@ -0,0 +1,54 @@
+import { BrokerAuth, ScCommand } from '@dishantlangayan/sc-cli-core';
+export default class BrokerLoginBasic extends ScCommand<typeof BrokerLoginBasic> {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        'broker-name': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'no-prompt': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'semp-port': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        'semp-url': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'set-default': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<BrokerAuth>;
+    /**
+     * Creates broker authentication configuration object
+     */
+    private createBrokerAuth;
+    /**
+     * Displays success message after login
+     */
+    private displaySuccessMessage;
+    /**
+     * Encodes username and password to base64 for basic authentication
+     */
+    private encodeBasicAuth;
+    /**
+     * Checks if broker exists and handles overwrite confirmation
+     */
+    private handleExistingBroker;
+    /**
+     * Handles errors during login process
+     */
+    private handleLoginError;
+    /**
+     * Obtains credentials from environment variables or user prompts
+     */
+    private obtainCredentials;
+    /**
+     * Prompts user for confirmation with Y/n (default Yes)
+     */
+    private promptForConfirmation;
+    /**
+     * Prompts user for password with hidden input
+     */
+    private promptForPassword;
+    /**
+     * Prompts user for username
+     */
+    private promptForUsername;
+    /**
+     * Validates command inputs
+     */
+    private validateInputs;
+}