@prismatic-io/spectral 9.0.0-rc.5 → 9.0.0-rc.7

package/dist/serverTypes/convertIntegration.js

@@ -31,34 +31,35 @@ const types_1 = require("../types");
 const convert_1 = require("./convert");
 const integration_1 = require("./integration");
 const convertIntegration = (definition) => {
-    var _a;
+    var _a, _b;
     // Generate a unique reference key that will be used to reference the
     // actions, triggers, data sources, and connections that are created
     // inline as part of the integration definition.
     const referenceKey = (0, uuid_1.v4)();
-    const configVars = Object.values((_a = definition.configPages) !== null && _a !== void 0 ? _a : {}).reduce((acc, configPage) => Object.entries(configPage.elements).reduce((acc, [key, element]) => {
+    const configVars = Object.values({
+        configPages: (_a = definition.configPages) !== null && _a !== void 0 ? _a : {},
+        userLevelConfigPages: (_b = definition.userLevelConfigPages) !== null && _b !== void 0 ? _b : {},
+    }).reduce((acc, configPages) => (Object.assign(Object.assign({}, acc), Object.values(configPages).reduce((acc, configPage) => Object.entries(configPage.elements).reduce((acc, [key, element]) => {
         // "string" elements are HTML elements and should be ignored.
         if (typeof element === "string") {
             return acc;
         }
         if (key in acc) {
-            throw new Error('Duplicate config var key "' + key + '"');
+            throw new Error(`Duplicate config var key: "${key}"`);
         }
         return Object.assign(Object.assign({}, acc), { [key]: element });
-    }, acc), {});
+    }, acc), {}))), {});
     const cniComponent = codeNativeIntegrationComponent(definition, referenceKey, configVars);
     const cniYaml = codeNativeIntegrationYaml(definition, referenceKey, configVars);
     return Object.assign(Object.assign({}, cniComponent), { codeNativeIntegrationYAML: cniYaml });
 };
 exports.convertIntegration = convertIntegration;
-const convertConfigPages = (pages) => {
+const convertConfigPages = (pages, userLevelConfigured) => {
     if (!pages || !Object.keys(pages).length) {
-        return;
+        return [];
     }
-    return Object.entries(pages).map(([name, { tagline, elements }]) => ({
-        name,
-        tagline,
-        elements: Object.entries(elements).map(([key, value]) => typeof value === "string"
+    return Object.entries(pages).map(([name, { tagline, elements }]) => (Object.assign(Object.assign({ name,
+        tagline }, (userLevelConfigured ? { userLevelConfigured } : {})), { elements: Object.entries(elements).map(([key, value]) => typeof value === "string"
             ? {
                 type: "htmlElement",
                 value,
@@ -66,10 +67,9 @@ const convertConfigPages = (pages) => {
             : {
                 type: "configVar",
                 value: key,
-            }),
-    }));
+            }) })));
 };
-const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, componentRegistry = {}, }, referenceKey, configVars) => {
+const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, userLevelConfigPages, componentRegistry = {}, }, referenceKey, configVars) => {
     // Find the preprocess flow config on the flow, if one exists.
     const preprocessFlows = flows.filter((flow) => flow.preprocessFlowConfig);
     // Do some validation of preprocess flow configs.
@@ -110,7 +110,10 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
         externalCustomerUserIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerUserIdField),
         flowNameField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.flowNameField),
         flows: flows.map((flow) => convertFlow(flow, componentRegistry, referenceKey)),
-        configPages: convertConfigPages(configPages !== null && configPages !== void 0 ? configPages : {}),
+        configPages: [
+            ...convertConfigPages(configPages, false),
+            ...convertConfigPages(userLevelConfigPages, true),
+        ],
     };
     return yaml_1.default.stringify(result);
 };

package/dist/types/IntegrationDefinition.d.ts

@@ -28,6 +28,20 @@ export interface IntegrationDefinitionComponentRegistry {
  */
 export interface IntegrationDefinitionConfigPages {
 }
+/**
+ * Root UserLevelConfigPages type exposed for augmentation.
+ *
+ * The expected interface when augmenting is:
+ *
+ * ```ts
+ * interface IntegrationDefinitionUserLevelConfigPages {
+ *   [key: string]: ConfigPage
+ * }
+ * ```
+ *
+ */
+export interface IntegrationDefinitionUserLevelConfigPages {
+}
 /** Defines attributes of a Code-Native Integration. */
 export declare type IntegrationDefinition = {
     /** The unique name for this Integration. */
@@ -55,6 +69,8 @@ export declare type IntegrationDefinition = {
     flows: Flow[];
     /** Config Wizard Pages for this Integration. */
     configPages?: ConfigPages;
+    /** User Level Config Wizard Pages for this Integration. */
+    userLevelConfigPages?: UserLevelConfigPages;
     componentRegistry?: ComponentRegistry;
 };
 /** Defines attributes of a Flow of a Code-Native Integration. */
@@ -239,14 +255,19 @@ export declare const isDataSourceReferenceConfigVar: (cv: ConfigVar) => cv is Da
 export declare const isConnectionDefinitionConfigVar: (cv: ConfigVar) => cv is ConnectionDefinitionConfigVar;
 export declare const isConnectionReferenceConfigVar: (cv: ConfigVar) => cv is ConnectionReferenceConfigVar;
 export declare type ConfigPageElement = string | ConfigVar;
-export declare type ConfigPages = keyof IntegrationDefinitionConfigPages extends never ? {
+declare type CreateConfigPages<TIntegrationDefinitionConfigPages> = keyof TIntegrationDefinitionConfigPages extends never ? {
     [key: string]: ConfigPage;
-} : UnionToIntersection<keyof IntegrationDefinitionConfigPages extends infer TPageName ? TPageName extends keyof IntegrationDefinitionConfigPages ? IntegrationDefinitionConfigPages[TPageName] extends ConfigPage ? {
-    [Key in TPageName]: IntegrationDefinitionConfigPages[TPageName];
+} : UnionToIntersection<keyof TIntegrationDefinitionConfigPages extends infer TPageName ? TPageName extends keyof TIntegrationDefinitionConfigPages ? TIntegrationDefinitionConfigPages[TPageName] extends ConfigPage ? {
+    [Key in TPageName]: TIntegrationDefinitionConfigPages[TPageName];
 } : never : never : never>;
-export declare type ConfigVars = Prettify<UnionToIntersection<keyof ConfigPages extends infer TPageName ? TPageName extends keyof ConfigPages ? ConfigPages[TPageName] extends infer TConfigPage ? TConfigPage extends ConfigPage ? {
+export declare type ConfigPages = CreateConfigPages<IntegrationDefinitionConfigPages>;
+export declare type UserLevelConfigPages = CreateConfigPages<IntegrationDefinitionUserLevelConfigPages>;
+declare type ExtractConfigVars<TConfigPages extends {
+    [key: string]: ConfigPage;
+}> = keyof TConfigPages extends infer TPageName ? TPageName extends keyof TConfigPages ? TConfigPages[TPageName] extends infer TConfigPage ? TConfigPage extends ConfigPage ? {
     [Key in keyof TConfigPage["elements"] as Key extends string ? TConfigPage["elements"][Key] extends ConfigVar ? Key : never : never]: ElementToRuntimeType<TConfigPage["elements"][Key]>;
-} : never : never : never : never>>;
+} : never : never : never : never;
+export declare type ConfigVars = Prettify<UnionToIntersection<ExtractConfigVars<ConfigPages> | ExtractConfigVars<UserLevelConfigPages>>>;
 export declare type ToDataSourceRuntimeType<TType extends DataSourceType> = TType extends "jsonForm" ? JSONForm : TType extends "objectSelection" ? ObjectSelection : TType extends "objectFieldMap" ? ObjectFieldMap : string;
 export declare type ElementToRuntimeType<TElement extends ConfigPageElement> = TElement extends ConnectionConfigVar ? Connection : TElement extends DataSourceConfigVar ? ToDataSourceRuntimeType<TElement["dataSourceType"]> : TElement extends ScheduleConfigVar ? Schedule : TElement extends StandardConfigVar ? string : never;
 /** Defines attributes of a Config Wizard Page used when deploying an Instance of an Integration. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "9.0.0-rc.5",
+  "version": "9.0.0-rc.7",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"