@prismatic-io/spectral 8.1.7 → 9.0.0-rc.2

package/dist/generators/componentManifest/templates/README.md.ejs

@@ -0,0 +1,186 @@
+# <%= helpers.capitalizeFirstLetter(component.label) %> Manifest
+
+<%= component.description %>
+
+---
+
+This package contains the Component Manifest for the **<%= component.label %>** Component.
+
+## Code Native Integration (CNI) Usage
+
+### Register your component manifest in the Code Native Integration (CNI) component registry `src/componentRegistry.ts`.
+
+```typescript
+import { componentManifests } from "@prismatic-io/spectral";
+import <%= component.key %> from "<%= packageName %>";
+
+export const componentRegistry = componentManifests({
+  <%= component.key %>,
+});
+```
+
+<% if (component.trigger) { -%>
+### Using Triggers in flows
+
+**Example:**
+
+```typescript
+import { flow } from "@prismatic-io/spectral";
+
+export default flow({
+  name: "Flow Name",
+  ...
+  onTrigger: {
+    key: "<%= component.trigger.key %>",
+    component: "<%= component.key %>",
+    isPublic: <%= component.isPublic %>,
+    values: {
+      ...
+    }
+  },
+});
+```
+<% } -%>
+
+<% if (component.action) { -%>
+### Using Actions in flows
+
+The component registry is accessible on the `context` argument in the `onExecution` and `onTrigger` methods as `context.components`.
+
+**Example:**
+
+```typescript
+import { flow } from "@prismatic-io/spectral";
+
+export default flow({
+  name: "Flow Name",
+  ...
+  onExecution: async (context, params) => {
+    const { components, logger, components } = context;
+
+    const response = await components.<%= component.key %>.<%= component.action.key %>({
+      ...
+    });
+
+    return Promise.resolve({ data: response });
+  },
+});
+```
+<% } -%>
+
+<% if (component.dataSource) { -%>
+### Using Data Sources in config pages
+
+**Example:**
+
+```typescript
+import { configPage, dataSourceConfigVar } from "@prismatic-io/spectral";
+
+export const configPages = {
+  "Data Sources": configPage({
+    elements: {
+      "Custom Data Source": dataSourceConfigVar({
+        dataType: "<%= component.dataSource.type  %>",
+        stableKey: "custom-data-source",
+        dataSource: {
+          key: "<%= component.dataSource.key %>",
+          component: "<%= component.key %>",
+          isPublic: <%= component.isPublic %>,
+          values: {
+            ...
+          },
+        }
+      })
+    },
+  }),
+};
+```
+<% } -%>
+
+<% if (component.connection) { -%>
+### Using Connections in config pages
+
+**Example:**
+
+```typescript
+import { configPage, connectionConfigVar } from "@prismatic-io/spectral";
+
+export const configPages = {
+  Connections: configPage({
+    elements: {
+      "Custom Connection": connectionConfigVar({
+        dataType: "connection",
+        stableKey: "custom-connection"
+        connection: {
+          key: "<%= component.connection.key %>",
+          component: "<%= component.key %>",
+          isPublic: <%= component.isPublic %>,
+          values: {
+            ...
+          },
+        },
+    }),
+  }),
+};
+```
+<% } -%>
+
+## Development
+
+There are two modes for this package:
+
+1. **Component Manifest development package:** Use this to test the Component in the Code Native Integration (CNI) locally. Publishing the CNI with this package will fail because the Component doesn't exist in the Prismatic Platform yet. A development package is typically built with `npm run generate:manifest:dev` and identified by a `null` `signature` in the Component Manifest `index.ts` file.
+
+2. **Component Manifest production package:** Use this with the Code Native Integration (CNI) either locally or in production by publishing the CNI to the Prismatic Platform. A production package is generated by publishing the Component with `prism components:publish` command, and then generating the Component Manifest with the `generate:manifest` command. A production package is identified by a non-null `signature` in the Component Manifest `index.ts` file.
+
+### Installation with a Code Native Integration
+
+**Before publishing the CNI, the local Component package must be published to the Prismatic Platform. This generates a stable signature key for the Component Manifest, indicating it's available for use.**
+
+### Install via remote registry
+
+**For public components:**
+
+```bash
+npm install <%= packageName %>
+```
+
+**For private components:**
+
+- If you're installing from a private registry, install the `<%= packageName %>` however you normally install your packages from your own registry.
+
+**Alternatively, install from a local package or tarball.**
+
+### Link to local package
+
+**Things to keep in mind when using `npm link`:**
+
+- The node versions between the Component Manifest directory and the CNI directory must be the same.
+
+**Steps:**
+
+1. From the new `<%= packageName %>` directory, create a symlink to the global module directory:
+
+```bash
+npm link;
+```
+
+2. From the Code Native Integration directory, link the local package:
+
+```bash
+npm link <%= packageName %>;
+```
+
+### Install from local tarball package
+
+1. From the new `<%= packageName %>` directory, create a tarball package:
+
+```bash
+npm pack;
+```
+
+2. From the Code Native Integration directory, install the tarball package:
+
+```bash
+npm install [path to tarball];
+```

package/dist/generators/componentManifest/templates/actions/action.ts.ejs

@@ -0,0 +1,14 @@
+<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+
+export interface <%= helpers.capitalizeFirstLetter(action.key) %>Values {
+<%- include('../partials/inputTypes.ejs', { inputs: action.inputs }) -%>
+}
+
+/**
+ * <%= action.label %>
+ *
+ * @description <%= action.description %>
+ */
+export const <%= action.key %> = <TReturn>(
+  _values: <%= helpers.capitalizeFirstLetter(action.key) %>Values
+): Promise<TReturn> => Promise.resolve<TReturn>({} as TReturn);

package/dist/generators/componentManifest/templates/actions/index.ts.ejs

@@ -0,0 +1 @@
+<%- include('../partials/importBarrel.ejs', { imports: actions }) -%>

package/dist/generators/componentManifest/templates/connections/connection.ts.ejs

@@ -0,0 +1,14 @@
+<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+
+export interface <%= helpers.capitalizeFirstLetter(connection.key) %>Values {
+<%- include('../partials/inputTypes.ejs', { inputs: connection.inputs }) -%>
+}
+
+/**
+ * <%= connection.label %>
+ *
+ * @comments <%= connection.comments %>
+ */
+export const <%= connection.key %> = <TReturn>(
+  _values: <%= helpers.capitalizeFirstLetter(connection.key) %>Values
+): Promise<TReturn> => Promise.resolve<TReturn>({} as TReturn);

package/dist/generators/componentManifest/templates/connections/index.ts.ejs

@@ -0,0 +1 @@
+<%- include('../partials/importBarrel.ejs', { imports: connections }) -%>

package/dist/generators/componentManifest/templates/dataSources/dataSource.ts.ejs

@@ -0,0 +1,14 @@
+<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+
+export interface <%= helpers.capitalizeFirstLetter(dataSource.key) %>Values {
+<%- include('../partials/inputTypes.ejs', { inputs: dataSource.inputs }) -%>
+}
+
+/**
+ * <%= dataSource.label %>
+ *
+ * @description <%= dataSource.description %>
+ */
+export const <%= dataSource.key %> = <TReturn>(
+  _values: <%= helpers.capitalizeFirstLetter(dataSource.key) %>Values
+): Promise<TReturn> => Promise.resolve<TReturn>({} as TReturn);

package/dist/generators/componentManifest/templates/dataSources/index.ts.ejs

@@ -0,0 +1 @@
+<%- include('../partials/importBarrel.ejs', { imports: dataSources }) -%>

package/dist/generators/componentManifest/templates/index.ts.ejs

@@ -0,0 +1,20 @@
+import actions from "./actions";
+import connections from "./connections";
+import dataSources from "./dataSources";
+import triggers from "./triggers";
+
+export { actions, connections, dataSources, triggers };
+
+export default {
+  key: "<%= component.key %>",
+  public: <%= component.public %>,
+  <%_ if (component.signature) { -%>
+  signature: "<%= component.signature %>",
+  <%_ } else { -%>
+  signature: null,
+  <%_ } -%>
+  actions,
+  dataSources,
+  connections,
+  triggers,
+};

package/dist/generators/componentManifest/templates/package.json.ejs

@@ -0,0 +1,23 @@
+{
+  "name": "<%= packageName %>",
+  "version": "<%= helpers.generatePackageJsonVersion() %>",
+  "main": "dist/index.js",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc",
+    "prepare": "npm run build"
+  },
+  "files": [
+    "dist/"
+  ],
+  "devDependencies": {
+    "@prismatic-io/spectral": "<%= spectralVersion %>",
+    "typescript": "<%= typescriptVersion %>"
+  },
+  "peerDependencies": {
+    "@prismatic-io/spectral": ">= <%= spectralVersion %>"
+  }<% if (registry) { %>,
+  "publishConfig": {
+    "registry": "<%= registry %>"
+  }<% } %>
+}

package/dist/generators/componentManifest/templates/partials/importBarrel.ejs

@@ -0,0 +1,9 @@
+<% imports.forEach((item) => { -%>
+import { <%= item.key %> } from "./<%= item.key %>";
+<% }); -%>
+
+export default {
+  <%_ imports.forEach((item) => { -%>
+  <%= item.key %>,
+  <%_ }); -%>
+}

package/dist/generators/componentManifest/templates/partials/imports.ejs

@@ -0,0 +1 @@
+<%- helpers.createDependencyImports({ imports }) -%>

package/dist/generators/componentManifest/templates/partials/inputTypes.ejs

@@ -0,0 +1,10 @@
+<% inputs.forEach((input) => { -%>
+  /**
+   * <%= input.label %>
+   *
+   <%_ input.properties.forEach((property) => { -%>
+   * @<%= property.key %> <%- property.value %>
+   <%_ }); -%>
+   */
+  <%= input.key %><%= input.required ? "" : "?" %>: <%- input.type.type ? input.type.type : input.type %>;
+<% }); -%>

package/dist/generators/componentManifest/templates/triggers/index.ts.ejs

@@ -0,0 +1 @@
+<%- include('../partials/importBarrel.ejs', { imports: triggers }) -%>

package/dist/generators/componentManifest/templates/triggers/trigger.ts.ejs

@@ -0,0 +1,14 @@
+<%- include('../partials/imports.ejs', { imports, helpers }) -%>
+
+export interface <%= helpers.capitalizeFirstLetter(trigger.key) %>Values {
+<%- include('../partials/inputTypes.ejs', { inputs: trigger.inputs }) -%>
+}
+
+/**
+ * <%= trigger.label %>
+ *
+ * @description <%= trigger.description %>
+ */
+export const <%= trigger.key %> = <TReturn>(
+  _values: <%= helpers.capitalizeFirstLetter(trigger.key) %>Values
+): Promise<TReturn> => Promise.resolve<TReturn>({} as TReturn);

package/dist/generators/componentManifest/templates/tsconfig.json.ejs

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "lib": ["esnext", "DOM"],
+    "strict": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "outDir": "dist",
+    "skipLibCheck": true
+  },
+  "include": ["src"],
+}

package/dist/generators/utils/capitalizeFirstLetter.d.ts

@@ -0,0 +1 @@
+export declare const capitalizeFirstLetter: (value: string) => string;

package/dist/generators/utils/capitalizeFirstLetter.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capitalizeFirstLetter = void 0;
+const capitalizeFirstLetter = (value) => value ? value.charAt(0).toUpperCase() + value.slice(1) : value;
+exports.capitalizeFirstLetter = capitalizeFirstLetter;

package/dist/generators/utils/createDependencyImports.d.ts

@@ -0,0 +1,5 @@
+import { Imports } from "../componentManifest/getImports";
+export interface CreateDependencyImportsProps {
+    imports: Imports;
+}
+export declare const createDependencyImports: ({ imports, }: CreateDependencyImportsProps) => string[];

package/dist/generators/utils/createDependencyImports.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDependencyImports = void 0;
+const createDependencyImports = ({ imports, }) => {
+    return Object.entries(imports).map(([module, types]) => {
+        return `import type { ${types.join(", ")} } from "${module}";`;
+    });
+};
+exports.createDependencyImports = createDependencyImports;

package/dist/generators/utils/createFlagHelpText.d.ts

@@ -0,0 +1,12 @@
+interface CreateFlagHelpTextProps {
+    flags: {
+        [key: string]: {
+            flag: string[];
+            description: string;
+            value: string | boolean | null;
+        };
+    };
+    command: string;
+}
+export declare const createFlagHelpText: ({ flags, command, }: CreateFlagHelpTextProps) => void;
+export {};

package/dist/generators/utils/createFlagHelpText.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFlagHelpText = void 0;
+const createFlagHelpText = ({ flags, command, }) => {
+    console.log(`Usage: ${command} [options]\n`);
+    console.log("Options:");
+    let longestFlag = 0;
+    const formattedFlags = Object.values(flags).map(({ flag: flagBase, description }) => {
+        const flag = flagBase.join(", ");
+        if (flag.length > longestFlag) {
+            longestFlag = flag.length;
+        }
+        return { flag, description };
+    });
+    formattedFlags.forEach(({ flag, description }) => {
+        console.log(`  ${flag.padEnd(longestFlag + 2)}  ${description}`);
+    });
+};
+exports.createFlagHelpText = createFlagHelpText;

package/dist/generators/utils/createTemplate.d.ts

@@ -0,0 +1,9 @@
+interface CreateTemplateProps {
+    source: string;
+    destination?: string;
+    data?: Record<string, unknown>;
+    dryRun: boolean;
+    verbose: boolean;
+}
+export declare const createTemplate: ({ source, destination, data, dryRun, verbose, }: CreateTemplateProps) => Promise<string | void>;
+export {};

package/dist/generators/utils/createTemplate.js

@@ -0,0 +1,59 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTemplate = void 0;
+const ejs_1 = require("ejs");
+const fs_extra_1 = require("fs-extra");
+const path_1 = __importDefault(require("path"));
+const createTemplate = ({ source, destination = source.replace(/\.ejs$/, ""), data = {}, dryRun, verbose, }) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!source) {
+        throw new Error("Source is required");
+    }
+    try {
+        if (path_1.default.extname(source) === ".ejs") {
+            const rendered = yield (0, ejs_1.renderFile)(source, data);
+            if (dryRun) {
+                console.info("");
+                console.info("");
+                console.info(`Rendering ${source} to ${destination}`);
+                console.info("---------------------------- Start ----------------------------");
+                console.info(rendered);
+                console.info("---------------------------- End ----------------------------");
+                console.info("");
+                return;
+            }
+            if (verbose) {
+                console.info(`Rendering ${source} to ${destination}`);
+            }
+            yield (0, fs_extra_1.outputFile)(destination, rendered, { encoding: "utf-8" });
+        }
+        else {
+            if (dryRun) {
+                console.info("");
+                console.info(`Copying ${source} to ${destination}`);
+                return;
+            }
+            if (verbose) {
+                console.info(`Copying ${source} to ${destination}`);
+            }
+            yield (0, fs_extra_1.mkdirp)(path_1.default.dirname(destination));
+            yield (0, fs_extra_1.copyFile)(source, destination);
+        }
+    }
+    catch (err) {
+        console.error(err);
+        throw err;
+    }
+});
+exports.createTemplate = createTemplate;

package/dist/generators/utils/generatePackageJsonVersion.d.ts

@@ -0,0 +1 @@
+export declare const generatePackageJsonVersion: () => string;

package/dist/generators/utils/generatePackageJsonVersion.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatePackageJsonVersion = void 0;
+const generatePackageJsonVersion = () => {
+    const now = new Date();
+    const year = now.getUTCFullYear();
+    const month = String(now.getUTCMonth() + 1);
+    const day = String(now.getUTCDate());
+    const hours = String(now.getUTCHours());
+    const minutes = String(now.getUTCMinutes());
+    const seconds = String(now.getUTCSeconds());
+    return `${year}.${month}.${day}-t-${hours}.${minutes}.${seconds}`;
+};
+exports.generatePackageJsonVersion = generatePackageJsonVersion;

package/dist/generators/utils/getComponentSignatureWithPrism.d.ts

@@ -0,0 +1 @@
+export declare const getComponentSignatureWithPrism: () => Promise<string | null>;

package/dist/generators/utils/getComponentSignatureWithPrism.js

@@ -0,0 +1,41 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getComponentSignatureWithPrism = void 0;
+const child_process_1 = require("child_process");
+const util_1 = require("util");
+const exec = (0, util_1.promisify)(child_process_1.exec);
+const getComponentSignatureWithPrism = () => __awaiter(void 0, void 0, void 0, function* () {
+    if (!(yield isPrismAvailable())) {
+        console.log("Prism must be installed");
+        process.exit(1);
+    }
+    const { stdout: signatureKey } = yield exec("prism components:signature", {
+        windowsHide: true,
+    });
+    if (!signatureKey) {
+        console.log("Failed to get component signature. Please verify your Component has been published.");
+        process.exit(1);
+    }
+    return signatureKey.replace(/\n$/, "");
+});
+exports.getComponentSignatureWithPrism = getComponentSignatureWithPrism;
+const isPrismAvailable = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        yield exec("prism --version", {
+            windowsHide: true,
+        });
+    }
+    catch (_a) {
+        return false;
+    }
+    return true;
+});

package/dist/generators/utils/getFlagBooleanValue.d.ts

@@ -0,0 +1,11 @@
+interface GetFlagBooleanValueProps {
+    args: string[];
+    flag: string;
+}
+export declare const getFlagBooleanValue: ({ args, flag, }: GetFlagBooleanValueProps) => boolean;
+interface GetFlagsBooleanValueProps {
+    args: string[];
+    flags: string[];
+}
+export declare const getFlagsBooleanValue: ({ args, flags, }: GetFlagsBooleanValueProps) => boolean;
+export {};

package/dist/generators/utils/getFlagBooleanValue.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFlagsBooleanValue = exports.getFlagBooleanValue = void 0;
+const getFlagBooleanValue = ({ args, flag, }) => {
+    return args.includes(flag);
+};
+exports.getFlagBooleanValue = getFlagBooleanValue;
+const getFlagsBooleanValue = ({ args, flags, }) => {
+    return flags.reduce((acc, flag) => {
+        const value = (0, exports.getFlagBooleanValue)({ args, flag });
+        if (typeof value === "undefined" || acc) {
+            return acc;
+        }
+        return value;
+    }, false);
+};
+exports.getFlagsBooleanValue = getFlagsBooleanValue;

package/dist/generators/utils/getFlagStringValue.d.ts

@@ -0,0 +1,11 @@
+interface GetFlagStringValueProps {
+    args: string[];
+    flag: string;
+}
+export declare const getFlagStringValue: ({ args, flag, }: GetFlagStringValueProps) => string | null;
+interface GetFlagsStringValueProps {
+    args: string[];
+    flags: string[];
+}
+export declare const getFlagsStringValue: ({ args, flags, }: GetFlagsStringValueProps) => string | null;
+export {};

package/dist/generators/utils/getFlagStringValue.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFlagsStringValue = exports.getFlagStringValue = void 0;
+const getFlagStringValue = ({ args, flag, }) => {
+    const flagIndex = args.indexOf(flag);
+    if (flagIndex === -1) {
+        return null;
+    }
+    const flagValue = args[flagIndex + 1];
+    if (!flagValue || flagValue.startsWith("--")) {
+        return null;
+    }
+    return flagValue.replace(/(^"|"$)|(^'|'$)/g, "");
+};
+exports.getFlagStringValue = getFlagStringValue;
+const getFlagsStringValue = ({ args, flags, }) => {
+    return flags.reduce((acc, flag) => {
+        const value = (0, exports.getFlagStringValue)({ args, flag });
+        if (typeof value === "undefined" || acc) {
+            return acc;
+        }
+        return value;
+    }, "");
+};
+exports.getFlagsStringValue = getFlagsStringValue;

package/dist/generators/utils/truncatePathByFolder.d.ts

@@ -0,0 +1 @@
+export declare const truncatePathByFolder: (path: string, folder: string) => string;

package/dist/generators/utils/truncatePathByFolder.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.truncatePathByFolder = void 0;
+const truncatePathByFolder = (path, folder) => path.split(folder)[1];
+exports.truncatePathByFolder = truncatePathByFolder;