@prismatic-io/spectral 10.11.5 → 10.12.0

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.5",
+  "version": "10.12.0",
   "description": "Utility library for building Prismatic connectors and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",