@conduit-client/tools 5.67.0-dev1

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2022 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2022, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/lib/commands/__tests__/generate.spec.js

@@ -0,0 +1,43 @@
+import { describe, it, expect, vi } from 'vitest';
+import { buildIncludeExclude, coerce } from '../generate';
+// this is not cooperating with vitest
+vi.mock('chalk', () => {
+    return {
+        default: vi.fn(),
+    };
+});
+describe('buildIncludeExclude', () => {
+    it('should return an IncludeExclude object with properties corresponding to return values of coerce', () => {
+        const result = buildIncludeExclude(['abc', 'def.*'], ['^ghi$']);
+        expect(result).toEqual({ include: [/abc/, /def.*/], exclude: [/^ghi$/] });
+    });
+    it('should return empty arrays when given empty arrays', () => {
+        const result = buildIncludeExclude([], []);
+        expect(result).toEqual({ include: [], exclude: [] });
+    });
+    it('should return only includes when excludes is undefined or null', () => {
+        let result = buildIncludeExclude(['abc', 'def.*'], undefined);
+        expect(result).toEqual({ include: [/abc/, /def.*/] });
+        result = buildIncludeExclude(['abc', 'def.*'], null);
+        expect(result).toEqual({ include: [/abc/, /def.*/] });
+    });
+    it('should return only excludes when includes is undefined or null', () => {
+        let result = buildIncludeExclude(undefined, ['^ghi$']);
+        expect(result).toEqual({ exclude: [/^ghi$/] });
+        result = buildIncludeExclude(null, ['^ghi$']);
+        expect(result).toEqual({ exclude: [/^ghi$/] });
+    });
+    it('should return an empty object when both are undefined or null', () => {
+        let result = buildIncludeExclude(undefined, undefined);
+        expect(result).toEqual({});
+        result = buildIncludeExclude(null, null);
+        expect(result).toEqual({});
+    });
+});
+describe('coerce', () => {
+    it('should return an array of RegExp', () => {
+        const input = ['abc', 'def.*', '^ghi$'];
+        const output = [/abc/, /def.*/, /^ghi$/];
+        expect(coerce(input)).toEqual(output);
+    });
+});

package/lib/commands/generate.js

@@ -0,0 +1,88 @@
+import { Args, Command, Flags } from '@oclif/core';
+import chalk from 'chalk';
+import { generate } from '@conduit-client/tools-core';
+import { LogLevelMap, loggerService as loggerServiceFactory } from '@conduit-client/utils';
+/**
+ * Maps an array of strings into an array of
+ * regular expressions
+ *
+ * @param configArray array of strings
+ * @returns array of RegExp
+ */
+export function coerce(configArray) {
+    const mapped = configArray.map((i) => {
+        return new RegExp(i);
+    });
+    return mapped;
+}
+/**
+ * Generates an IncludeExclude object based on arrays of strings
+ *
+ * @param include array of strings from --include options
+ * @param exclude array of strings from --exclude options
+ * @returns IncludeExclude object
+ */
+export function buildIncludeExclude(include, exclude) {
+    const includeExclude = {};
+    if (include) {
+        includeExclude.include = coerce(include);
+    }
+    if (exclude) {
+        includeExclude.exclude = coerce(exclude);
+    }
+    return includeExclude;
+}
+export class Generate extends Command {
+    async run() {
+        const { args, flags } = await this.parse(Generate);
+        const { input: inputFile, outputDir } = args;
+        const filePerType = flags.filePerType || false;
+        const loggerService = buildLoggerService(flags.logLevel);
+        try {
+            const includeExclude = buildIncludeExclude(flags.include, flags.exclude);
+            await generate(inputFile, outputDir, {
+                loggerService,
+                filePerType,
+                includeExclude,
+            });
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : `Unknown error: ${JSON.stringify(err)}`;
+            loggerService.error(`${chalk.redBright('FATAL')}: ${message || 'Previous errors caused early program termination'}`);
+            if (err instanceof Error && err.stack) {
+                loggerService.trace(`Error stack:\n${err.stack}`);
+            }
+            this.exit(1);
+        }
+    }
+}
+Generate.description = 'generates luvio resource code from an api description file';
+Generate.examples = [`$ luvio-tools generate [inputFile] [outputDir]`];
+Generate.args = {
+    input: Args.file({ exists: true, required: true, description: 'input file' }),
+    outputDir: Args.directory({ required: true, description: 'output directory' }),
+};
+Generate.flags = {
+    logLevel: Flags.string({ default: 'WARN' }),
+    filePerType: Flags.boolean({ default: false }),
+    include: Flags.string({ multiple: true, char: 'n' }),
+    exclude: Flags.string({ multiple: true, char: 'x' }),
+};
+function buildLoggerService(level) {
+    let logLevel = level.toUpperCase();
+    const loggerService = loggerServiceFactory(logLevel in LogLevelMap ? logLevel : undefined, undefined, formatLogs);
+    if (!(logLevel in LogLevelMap)) {
+        loggerService.warn(`Log level ${logLevel} not known. Must be one of ${Object.keys(LogLevelMap)}. Defaulting to WARN.`);
+    }
+    return loggerService;
+}
+const logLevelColorMap = {
+    TRACE: chalk.white,
+    DEBUG: chalk.white,
+    INFO: chalk.white,
+    WARN: chalk.yellow,
+    ERROR: chalk.red,
+};
+function formatLogs(level, message) {
+    return `${logLevelColorMap[level](level)}: ${message}`;
+}

package/lib/index.js

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/package.json

@@ -0,0 +1,45 @@
+{
+    "name": "@conduit-client/tools",
+    "version": "5.67.0-dev1",
+    "description": "CLI for Luvio Code Generation",
+    "keywords": [
+        "oclif"
+    ],
+    "homepage": "https://github.com/salesforce-experience-platform-emu/luvio-next",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/luvio-next.git",
+        "directory": "packages/@conduit-client/generation/tools"
+    },
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "type": "module",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "bin": {
+        "luvio-tools": "./bin/run.js"
+    },
+    "files": [
+        "/bin",
+        "/lib"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "clean": "rm -rf lib",
+        "test": "vitest run"
+    },
+    "dependencies": {
+        "@conduit-client/tools-core": "5.67.0-dev1",
+        "@oclif/core": "2.6.4",
+        "chalk": "^5.2.0"
+    },
+    "engines": {
+        "node": ">=8.0.0"
+    },
+    "volta": {
+        "extends": "../../../../package.json"
+    },
+    "oclif": {
+        "commands": "./lib/commands",
+        "bin": "luvio-tools"
+    }
+}