@prismatic-io/spectral 10.11.4 → 10.12.0

package/dist/generators/cniComponentManifest/index.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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) {
@@ -8,12 +31,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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.fetchComponentDataForManifest = void 0;
-const axios_1 = __importDefault(require("axios"));
+const axios_1 = __importStar(require("axios"));
 const prism_1 = require("../utils/prism");
 // Helper to transform input nodes from GraphQL response to the expected format
 function transformInputNodes(inputs) {
@@ -22,7 +42,7 @@ function transformInputNodes(inputs) {
 // This function does not return a complete Component as described in ServerTypes;
 // it instead selectively returns only what's needed to generate a manifest.
 const fetchComponentDataForManifest = (_a) => __awaiter(void 0, [_a], void 0, function* ({ componentKey, isPrivate, }) {
-    var _b;
+    var _b, _c, _d;
     const accessToken = yield (0, prism_1.getPrismAccessToken)();
     const prismaticUrl = (_b = process.env.PRISMATIC_URL) !== null && _b !== void 0 ? _b : "https://app.prismatic.io";
     const query = `
@@ -138,67 +158,78 @@ const fetchComponentDataForManifest = (_a) => __awaiter(void 0, [_a], void 0, fu
         };
     }
     catch (error) {
-        throw new Error(error instanceof Error ? error.message : String(error));
+        if (error instanceof axios_1.AxiosError && ((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.errors)) {
+            throw new Error(JSON.stringify(error.response.data.errors, null, 2));
+        }
+        throw error;
     }
 });
 exports.fetchComponentDataForManifest = fetchComponentDataForManifest;
 function getComponentActions(componentId, prismaticUrl, accessToken) {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a, _b;
+        var _a, _b, _c, _d;
         let hasNextPage = true;
         let cursor = null;
         let actions = [];
         while (hasNextPage) {
-            const query = `
-      query componentActionQuery($component: ID!, $after: String) {
-        actions(component: $component, after: $after) {
-          nodes {
-            isDataSource
-            isDetailDataSource
-            dataSourceType
-            isTrigger
-            isCommonTrigger
-            key
-            label
-            description
-            inputs {
-              nodes {
-                key
-                label
-                type
-                required
-                default
-                collection
-                shown
-                onPremiseControlled
+            try {
+                const query = `
+        query componentActionQuery($component: ID!, $after: String) {
+          actions(component: $component, after: $after) {
+            nodes {
+              isDataSource
+              isDetailDataSource
+              dataSourceType
+              isTrigger
+              isCommonTrigger
+              key
+              label
+              description
+              inputs {
+                nodes {
+                  key
+                  label
+                  type
+                  required
+                  default
+                  collection
+                  shown
+                  onPremiseControlled
+                }
               }
+              examplePayload
+            }
+            pageInfo {
+              hasNextPage
+              endCursor
             }
-            examplePayload
-          }
-          pageInfo {
-            hasNextPage
-            endCursor
           }
         }
-      }
-    `;
-            const response = yield axios_1.default.post(`${prismaticUrl}/api`, {
-                query: query,
-                variables: {
-                    component: componentId,
-                    after: cursor,
-                },
-            }, {
-                headers: {
-                    Authorization: `Bearer ${accessToken}`,
-                    "Content-Type": "application/json",
-                    "Prismatic-Client": "spectral",
-                },
-            });
-            const responseActions = response.data.data.actions.nodes;
-            actions = actions.concat(responseActions);
-            hasNextPage = (_a = response.data.data.actions.pageInfo) === null || _a === void 0 ? void 0 : _a.hasNextPage;
-            cursor = (_b = response.data.data.actions.pageInfo) === null || _b === void 0 ? void 0 : _b.endCursor;
+      `;
+                const response = yield axios_1.default.post(`${prismaticUrl}/api`, {
+                    query: query,
+                    variables: {
+                        component: componentId,
+                        after: cursor,
+                    },
+                }, {
+                    headers: {
+                        Authorization: `Bearer ${accessToken}`,
+                        "Content-Type": "application/json",
+                        "Prismatic-Client": "spectral",
+                    },
+                });
+                const responseActions = response.data.data.actions.nodes;
+                actions = actions.concat(responseActions);
+                hasNextPage = (_a = response.data.data.actions.pageInfo) === null || _a === void 0 ? void 0 : _a.hasNextPage;
+                cursor = (_b = response.data.data.actions.pageInfo) === null || _b === void 0 ? void 0 : _b.endCursor;
+            }
+            catch (error) {
+                if (error instanceof axios_1.AxiosError && ((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.errors)) {
+                    throw new Error(JSON.stringify(error.response.data.errors, null, 2));
+                }
+                throw error;
+            }
         }
         return actions.sort((a, b) => a.key.localeCompare(b.key));
     });

package/dist/serverTypes/convertIntegration.js

@@ -504,6 +504,15 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
     if ((0, types_1.isJsonFormConfigVar)(configVar) || (0, types_1.isJsonFormDataSourceConfigVar)(configVar)) {
         result.meta = Object.assign(Object.assign({}, result.meta), { validationMode: (_c = configVar === null || configVar === void 0 ? void 0 : configVar.validationMode) !== null && _c !== void 0 ? _c : "ValidateAndShow" });
     }
+    if ((0, types_1.isJsonFormDataSourceConfigVar)(configVar) && configVar.dataSourceReset) {
+        result.meta = Object.assign(Object.assign({}, result.meta), { dataSourceReset: configVar.dataSourceReset.mode });
+        // Create placeholder inputs for each config variable dependency, so that
+        // the config wizard can detect if any changed and reset the data source.
+        result.inputs = (configVar.dataSourceReset.dependencies || []).reduce((acc, dep, idx) => (Object.assign(Object.assign({}, acc), { [`input${idx}`]: {
+                type: "configVar",
+                value: dep,
+            } })), {});
+    }
     if ((0, types_1.isDataSourceDefinitionConfigVar)(configVar)) {
         result.dataType = configVar.dataSourceType;
         result.dataSource = {
@@ -520,6 +529,9 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
         if (configVar.validationMode) {
             result.meta = Object.assign(Object.assign({}, result.meta), { validationMode: configVar.validationMode });
         }
+        if (configVar.dataSourceReset) {
+            result.meta = Object.assign(Object.assign({}, result.meta), { dataSourceReset: configVar.dataSourceReset.mode });
+        }
     }
     return result;
 };
@@ -688,7 +700,16 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
         return Object.assign(Object.assign({}, result), { [camelKey]: Object.assign(Object.assign({}, dataSource), { key: camelKey, display: {
                     label: key,
                     description: key,
-                }, inputs: [] }) });
+                }, inputs: 
+                // Create placeholder inputs for each config variable dependency,so that
+                // the config wizard can detect if any changed and reset the data source.
+                (0, types_1.isJsonFormDataSourceConfigVar)(configVar) && configVar.dataSourceReset
+                    ? (configVar.dataSourceReset.dependencies || []).map((dep, idx) => ({
+                        key: `input${idx}`,
+                        label: dep,
+                        type: "string",
+                    }))
+                    : [] }) });
     }, {});
     const convertedConnections = Object.entries(configVars).reduce((result, [key, configVar]) => {
         var _a;

package/dist/types/ConfigVars.d.ts

@@ -126,11 +126,18 @@ type ScheduleConfigVar = CreateStandardConfigVar<"schedule"> & {
 };
 type ObjectSelectionConfigVar = CreateStandardConfigVar<"objectSelection">;
 type ObjectFieldMapConfigVar = CreateStandardConfigVar<"objectFieldMap">;
+type DataSourceReset = {
+    /** Either always prompt a user to reset the data source when a dependent config variable changes, or always reset the data source */
+    mode: "prompt" | "always";
+    /** List of config variable names that, if changed, should trigger a reset of the JSON Form */
+    dependencies?: string[];
+};
 type JsonFormConfigVar = CreateStandardConfigVar<"jsonForm"> & {
     validationMode?: ValidationMode;
 };
 type JsonFormDataSourceDefinitionConfigVar = DataSourceDefinitionConfigVar & {
     validationMode?: ValidationMode;
+    dataSourceReset?: DataSourceReset;
 };
 type HtmlElementConfigVar = CreateStandardConfigVar<"htmlElement">;
 export type StandardConfigVar = StringConfigVar | DateConfigVar | TimestampConfigVar | PicklistConfigVar | CodeConfigVar | BooleanConfigVar | NumberConfigVar | ScheduleConfigVar | ObjectSelectionConfigVar | ObjectFieldMapConfigVar | JsonFormConfigVar | HtmlElementConfigVar;
@@ -155,6 +162,7 @@ type DataSourceDefinitionConfigVar = DataSourceType extends infer TDataSourceTyp
 type DataSourceReferenceConfigVar = ComponentRegistryDataSource extends infer TDataSourceReference extends ComponentRegistryDataSource ? Omit<BaseDataSourceConfigVar<TDataSourceReference["dataSourceType"]>, "dataSourceType"> & {
     dataSource: TDataSourceReference["reference"];
     validationMode?: ValidationMode;
+    dataSourceReset?: Omit<DataSourceReset, "dependencies">;
 } : never;
 /** Defines attributes of a data source config variable. */
 export type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "10.11.4",
+  "version": "10.12.0",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",