@dishantlangayan/sc-cli-core 0.1.0

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.
package/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,34 @@
1
+ @dishantlangayan/sc-cli-core
2
+ =================
3
+
4
+ Core library for the Solace Cloud CLI
5
+
6
+ [![Version](https://img.shields.io/npm/v/@dishantlangayan/sc-cli-core.svg)](https://npmjs.org/package/@dishantlangayan/sc-cli-core)
7
+ [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
8
+
9
+ # Description
10
+ The @dishantlangayan/sc-cli-core provides utilities for the Solace Cloud CLI and it's plugins.
11
+
12
+ ## ScCommand Abstract Class
13
+ The ScCommand abstract class extends [@oclif/core's Command class](https://github.com/oclif/core/blob/main/src/command.ts).
14
+
15
+ - ScCommand takes a generic type that defines the success JSON result
16
+ - Enable the json flag support by default
17
+ - Sets the base URL for making Solace Cloud API calls
18
+ - Checks if the access token is set for authentication with Solace Cloud APIs
19
+
20
+ ## ScConnection Class
21
+ The ScConnection class provide abstraction functions for Solace Cloud API REST calls. It handles the access token and base URL for each REST call, avoiding the need to set these on each Command.
22
+
23
+ # Contributing
24
+ 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.
25
+
26
+ <!-- contributingstop -->
27
+ # Authors
28
+ <!-- authors -->
29
+ See the list of [contributors](https://github.com/dishantlangayan/sc-cli-core/graphs/contributors) who participated in this project.
30
+
31
+ <!-- authorsstop -->
32
+ # License
33
+ <!-- license -->
34
+ See the [LICENSE](LICENSE.txt) file for details.
@@ -0,0 +1,44 @@
1
+ export declare enum EnvironmentVariable {
2
+ 'SC_ACCESS_TOKEN' = "SC_ACCESS_TOKEN",
3
+ 'SC_API_VERSION' = "SC_API_VERSION",
4
+ 'SC_BASE_URL' = "SC_BASE_URL"
5
+ }
6
+ export declare const DefaultBaseUrl = "https://api.solace.cloud";
7
+ /**
8
+ * An injectable abstraction on top of `process.env` with various convenience functions
9
+ * for accessing environment variables.
10
+ */
11
+ export declare class EnvVars {
12
+ private env;
13
+ constructor(env?: NodeJS.ProcessEnv);
14
+ /**
15
+ * Gets a `string` value for a given key.
16
+ *
17
+ * @param key The name of the envar.
18
+ */
19
+ getString(key: string): string | undefined;
20
+ /**
21
+ * Gets a `string` value for a given key.
22
+ *
23
+ * @param key The name of the envar.
24
+ * @param def A default value.
25
+ */
26
+ getString(key: string, def: string): string;
27
+ /**
28
+ * Sets a `string` value for a given key, or removes the current value when no value is given.
29
+ *
30
+ * @param key The name of the envar.
31
+ * @param value The value to set.
32
+ */
33
+ setString(key: string, value: string): void;
34
+ /**
35
+ * Un-sets a value for a given key.
36
+ *
37
+ * @param key The name of the environment variable.
38
+ */
39
+ unset(key: string): void;
40
+ }
41
+ /**
42
+ * The default `EnvVars` instance, which wraps `process.env`.
43
+ */
44
+ export declare const envVars: EnvVars;
@@ -0,0 +1,47 @@
1
+ export var EnvironmentVariable;
2
+ (function (EnvironmentVariable) {
3
+ EnvironmentVariable["SC_ACCESS_TOKEN"] = "SC_ACCESS_TOKEN";
4
+ EnvironmentVariable["SC_API_VERSION"] = "SC_API_VERSION";
5
+ EnvironmentVariable["SC_BASE_URL"] = "SC_BASE_URL";
6
+ })(EnvironmentVariable || (EnvironmentVariable = {}));
7
+ export const DefaultBaseUrl = 'https://api.solace.cloud';
8
+ /**
9
+ * An injectable abstraction on top of `process.env` with various convenience functions
10
+ * for accessing environment variables.
11
+ */
12
+ export class EnvVars {
13
+ env;
14
+ constructor(env = process.env || {}) {
15
+ this.env = env;
16
+ this.env = env;
17
+ }
18
+ // underlying method
19
+ getString(key, def) {
20
+ return this.env[key] ?? def;
21
+ }
22
+ /**
23
+ * Sets a `string` value for a given key, or removes the current value when no value is given.
24
+ *
25
+ * @param key The name of the envar.
26
+ * @param value The value to set.
27
+ */
28
+ setString(key, value) {
29
+ if (value === '') {
30
+ this.unset(key);
31
+ return;
32
+ }
33
+ this.env[key] = value;
34
+ }
35
+ /**
36
+ * Un-sets a value for a given key.
37
+ *
38
+ * @param key The name of the environment variable.
39
+ */
40
+ unset(key) {
41
+ delete this.env[key];
42
+ }
43
+ }
44
+ /**
45
+ * The default `EnvVars` instance, which wraps `process.env`.
46
+ */
47
+ export const envVars = new EnvVars();
@@ -0,0 +1,5 @@
1
+ export { EnvironmentVariable, envVars } from './config/env-vars.js';
2
+ export { ScCommand } from './sc-command.js';
3
+ export { ScConnection } from './util/sc-connection.js';
4
+ export { sleep } from './util/util.js';
5
+ export * from './ux/table.js';
@@ -0,0 +1,5 @@
1
+ export { EnvironmentVariable, envVars } from './config/env-vars.js';
2
+ export { ScCommand } from './sc-command.js';
3
+ export { ScConnection } from './util/sc-connection.js';
4
+ export { sleep } from './util/util.js';
5
+ export * from './ux/table.js';
@@ -0,0 +1,22 @@
1
+ import { Command, Interfaces } from '@oclif/core';
2
+ export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof ScCommand)['baseFlags'] & T['flags']>;
3
+ export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
4
+ /**
5
+ * A base command that provided common functionality for all sc commands.
6
+ *
7
+ * All implementations of this class need to implement the run() method.
8
+ *
9
+ */
10
+ export declare abstract class ScCommand<T extends typeof Command> extends Command {
11
+ static baseFlags: {
12
+ 'log-level': Interfaces.OptionFlag<"error" | "warn" | "debug" | "info" | "trace", Interfaces.CustomOptions>;
13
+ };
14
+ static enableJsonFlag: boolean;
15
+ protected args: Args<T>;
16
+ protected flags: Flags<T>;
17
+ protected catch(err: Error & {
18
+ exitCode?: number;
19
+ }): Promise<unknown>;
20
+ protected finally(_: Error | undefined): Promise<unknown>;
21
+ init(): Promise<void>;
22
+ }
@@ -0,0 +1,54 @@
1
+ import { Command, Flags } from '@oclif/core';
2
+ import { DefaultBaseUrl, EnvironmentVariable, envVars } from './config/env-vars.js';
3
+ /**
4
+ * A base command that provided common functionality for all sc commands.
5
+ *
6
+ * All implementations of this class need to implement the run() method.
7
+ *
8
+ */
9
+ export class ScCommand extends Command {
10
+ // define flags that can be inherited by any command that extends BaseCommand
11
+ static baseFlags = {
12
+ 'log-level': Flags.option({
13
+ default: 'info',
14
+ helpGroup: 'GLOBAL',
15
+ options: ['debug', 'warn', 'error', 'info', 'trace'],
16
+ summary: 'Specify level for logging.',
17
+ })(),
18
+ };
19
+ // add the --json flag
20
+ static enableJsonFlag = true;
21
+ args;
22
+ flags;
23
+ async catch(err) {
24
+ // add any custom logic to handle errors from the command
25
+ // or simply return the parent class error handling
26
+ return super.catch(err);
27
+ }
28
+ async finally(_) {
29
+ // called after run and catch regardless of whether or not the command errored
30
+ return super.finally(_);
31
+ }
32
+ async init() {
33
+ await super.init();
34
+ const { args, flags } = await this.parse({
35
+ args: this.ctor.args,
36
+ baseFlags: super.ctor.baseFlags,
37
+ enableJsonFlag: this.ctor.enableJsonFlag,
38
+ flags: this.ctor.flags,
39
+ strict: this.ctor.strict,
40
+ });
41
+ this.flags = flags;
42
+ this.args = args;
43
+ // set base url if not defined in environment variables
44
+ if (!envVars.getString(EnvironmentVariable.SC_BASE_URL)) {
45
+ this.debug(`Environment variable '${EnvironmentVariable.SC_BASE_URL}' not set, using default '${DefaultBaseUrl}'`);
46
+ envVars.setString(EnvironmentVariable.SC_BASE_URL, DefaultBaseUrl);
47
+ }
48
+ // Check if Access Token is set
49
+ const value = envVars.getString(EnvironmentVariable.SC_ACCESS_TOKEN);
50
+ if (!value) {
51
+ throw new Error(`Environment variable ${EnvironmentVariable.SC_ACCESS_TOKEN} is not set and required for any API operations.`);
52
+ }
53
+ }
54
+ }
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Parse JSON `string` data.
3
+ *
4
+ * @param data Data to parse.
5
+ */
6
+ export declare function parseJson(data: string, _throwOnEmpty?: boolean): unknown;
7
+ /**
8
+ * Finds a the key with the provided value in the JSON array and returns the JSON object.
9
+ *
10
+ * @param array The JSON array to search
11
+ * @param key The key to lookup in the array
12
+ * @param value The value of the key to match
13
+ * @returns The JSON object that matches the key and value
14
+ */
15
+ export declare function findByKey<T>(array: T[], key: keyof T, value: unknown): T | undefined;
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Parse JSON `string` data.
3
+ *
4
+ * @param data Data to parse.
5
+ */
6
+ export function parseJson(data, _throwOnEmpty = true) {
7
+ return typeof data === 'string' ? JSON.parse(data) : data;
8
+ }
9
+ /**
10
+ * Finds a the key with the provided value in the JSON array and returns the JSON object.
11
+ *
12
+ * @param array The JSON array to search
13
+ * @param key The key to lookup in the array
14
+ * @param value The value of the key to match
15
+ * @returns The JSON object that matches the key and value
16
+ */
17
+ export function findByKey(array, key, value) {
18
+ return array.find((item) => item[key] === value);
19
+ }
@@ -0,0 +1,13 @@
1
+ import { AxiosRequestConfig } from 'axios';
2
+ export declare class ScConnection {
3
+ private axiosInstance;
4
+ private endpointUrl;
5
+ constructor(baseURL?: string, accessToken?: string, timeout?: number);
6
+ delete<T>(url: string, config?: AxiosRequestConfig): Promise<T>;
7
+ get<T>(url: string, config?: AxiosRequestConfig): Promise<T>;
8
+ patch<T>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<T>;
9
+ post<T>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<T>;
10
+ put<T>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<T>;
11
+ private joinPaths;
12
+ }
13
+ export default ScConnection;
@@ -0,0 +1,52 @@
1
+ import axios from 'axios';
2
+ import { DefaultBaseUrl, EnvironmentVariable, envVars } from '../config/env-vars.js';
3
+ export class ScConnection {
4
+ axiosInstance;
5
+ endpointUrl = '';
6
+ constructor(baseURL = envVars.getString(EnvironmentVariable.SC_BASE_URL, DefaultBaseUrl), accessToken = envVars.getString(EnvironmentVariable.SC_ACCESS_TOKEN, ''), timeout = 10_000) {
7
+ const apiVersion = envVars.getString(EnvironmentVariable.SC_API_VERSION, 'v2');
8
+ this.endpointUrl = this.joinPaths(baseURL, `/api/${apiVersion}`);
9
+ this.axiosInstance = axios.create({
10
+ baseURL: this.endpointUrl,
11
+ headers: {
12
+ Authorization: `Bearer ${accessToken}`,
13
+ 'Content-Type': 'application/json',
14
+ },
15
+ timeout,
16
+ });
17
+ // Add interceptors if needed
18
+ this.axiosInstance.interceptors.response.use((response) => response, (error) => {
19
+ console.error('API Error:', error.response?.data || error.message);
20
+ return Promise.reject(error);
21
+ });
22
+ }
23
+ // DELETE request
24
+ async delete(url, config) {
25
+ const response = await this.axiosInstance.delete(url, config);
26
+ return response.data;
27
+ }
28
+ // GET request
29
+ async get(url, config) {
30
+ const response = await this.axiosInstance.get(url, config);
31
+ return response.data;
32
+ }
33
+ // PATCH request
34
+ async patch(url, data, config) {
35
+ const response = await this.axiosInstance.patch(url, data, config);
36
+ return response.data;
37
+ }
38
+ // POST request
39
+ async post(url, data, config) {
40
+ const response = await this.axiosInstance.post(url, data, config);
41
+ return response.data;
42
+ }
43
+ // PUT request
44
+ async put(url, data, config) {
45
+ const response = await this.axiosInstance.put(url, data, config);
46
+ return response.data;
47
+ }
48
+ joinPaths(base, path) {
49
+ return `${base.replace(/\/+$/, '')}/${path.replace(/^\/+/, '')}`;
50
+ }
51
+ }
52
+ export default ScConnection;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Sleep function.
3
+ * @param ms Num of milliseconds to wait
4
+ * @returns Promise that resolves after the specified time
5
+ */
6
+ export declare function sleep(ms: number): Promise<void>;
7
+ export declare const sleepModule: {
8
+ sleep: typeof sleep;
9
+ };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Sleep function.
3
+ * @param ms Num of milliseconds to wait
4
+ * @returns Promise that resolves after the specified time
5
+ */
6
+ export function sleep(ms) {
7
+ return new Promise((resolve) => {
8
+ setTimeout(resolve, ms);
9
+ });
10
+ }
11
+ export const sleepModule = { sleep };
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Formats a camel case style `string` into a title case.
3
+ *
4
+ * @param text Text to transform.
5
+ */
6
+ export declare function camelCaseToTitleCase(text: string): string;
7
+ export interface ColumnConfig {
8
+ width?: number;
9
+ wrapWord?: boolean;
10
+ }
11
+ /**
12
+ * Prints object data in a formatted key-value table.
13
+ * @param data The object data to print
14
+ * @returns Formatted table string
15
+ */
16
+ export declare function printObjectAsKeyValueTable<T extends Record<string, unknown>>(data: T): string;
17
+ export declare function renderTable<T>(data: T[][], columnConfig?: Record<number, ColumnConfig>): string;
18
+ export declare function renderKeyValueTable<T>(data: T[][], columnConfig?: Record<number, ColumnConfig>): string;
@@ -0,0 +1,47 @@
1
+ import { table } from 'table';
2
+ /**
3
+ * Formats a camel case style `string` into a title case.
4
+ *
5
+ * @param text Text to transform.
6
+ */
7
+ export function camelCaseToTitleCase(text) {
8
+ return text
9
+ .replaceAll(/(^\w|\s\w)/g, (m) => m.toUpperCase())
10
+ .replaceAll(/([A-Z][a-z]+)/g, ' $1')
11
+ .replaceAll(/\s{2,}/g, ' ')
12
+ .trim();
13
+ }
14
+ /**
15
+ * Prints object data in a formatted key-value table.
16
+ * @param data The object data to print
17
+ * @returns Formatted table string
18
+ */
19
+ export function printObjectAsKeyValueTable(data) {
20
+ const tableRows = [
21
+ ['Key', 'Value'],
22
+ ...Object.entries(data).map(([key, value]) => [camelCaseToTitleCase(key), value]),
23
+ ];
24
+ return renderKeyValueTable(tableRows);
25
+ }
26
+ export function renderTable(data, columnConfig) {
27
+ // Table config
28
+ const tableConfig = {
29
+ columns: columnConfig,
30
+ };
31
+ const tableStr = table(data, tableConfig);
32
+ return tableStr;
33
+ }
34
+ export function renderKeyValueTable(data, columnConfig) {
35
+ if (columnConfig === undefined) {
36
+ columnConfig = { 1: { width: 50, wrapWord: true } };
37
+ }
38
+ // Table config
39
+ const tableConfig = {
40
+ columns: columnConfig,
41
+ drawHorizontalLine(lineIndex, rowCount) {
42
+ return lineIndex === 0 || lineIndex === 1 || lineIndex === rowCount;
43
+ },
44
+ };
45
+ const tableStr = table(data, tableConfig);
46
+ return tableStr;
47
+ }
package/package.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "name": "@dishantlangayan/sc-cli-core",
3
+ "version": "0.1.0",
4
+ "description": "Base library for the Solace Cloud CLI and plugins",
5
+ "license": "Apache-2.0",
6
+ "author": "Dishant Langayan",
7
+ "type": "module",
8
+ "exports": {
9
+ "./ScCommand.js": "./lib/ScCommand.js",
10
+ "./ScConnection.js": "./lib/util/ScConnection.js",
11
+ ".": {
12
+ "default": "./lib/exported.js",
13
+ "types": "./lib/exported.d.ts"
14
+ }
15
+ },
16
+ "files": [
17
+ "./lib",
18
+ "./lib/**/*.ts"
19
+ ],
20
+ "scripts": {
21
+ "build": "shx rm -rf lib && tsc -b",
22
+ "lint": "eslint",
23
+ "posttest": "npm run lint",
24
+ "test": "NODE_OPTIONS=--loader=ts-node/esm mocha --require ts-node/register --extensions ts --node-env=test \"test/**/*.test.ts\""
25
+ },
26
+ "devDependencies": {
27
+ "@eslint/compat": "^1",
28
+ "@oclif/prettier-config": "^0.2.1",
29
+ "@oclif/test": "^4.1.16",
30
+ "@types/chai": "^5.2.3",
31
+ "@types/mocha": "^10.0.10",
32
+ "@types/node": "^25.0.3",
33
+ "@types/sinon": "^21.0.0",
34
+ "chai": "^6.2.2",
35
+ "eslint": "^9",
36
+ "eslint-config-oclif": "^6.0.137",
37
+ "eslint-config-prettier": "^10",
38
+ "jiti": "^2.6.1",
39
+ "mocha": "^11.3.0",
40
+ "oclif": "^4.22.73",
41
+ "shx": "^0.4.0",
42
+ "sinon": "^21.0.1",
43
+ "ts-node": "^10.9.2",
44
+ "typescript": "^5.9.3"
45
+ },
46
+ "dependencies": {
47
+ "@oclif/core": "^4.8.0",
48
+ "axios": "^1.13.2",
49
+ "table": "^6.9.0"
50
+ }
51
+ }