@prismatic-io/spectral 9.1.4 → 9.2.0

package/dist/clients/http/index.js

@@ -104,11 +104,12 @@ const createClient = ({ baseUrl, responseType, headers, timeout, params, debug =
     });
     if (debug) {
         client.interceptors.request.use((request) => {
-            const { baseURL, headers, method, timeout, url, data } = request;
+            const { baseURL, headers, method, timeout, url, data, params } = request;
             const dataSize = (0, object_sizeof_1.default)(data);
             console.log(util_1.default.types.toJSON({
                 type: "request",
                 baseURL,
+                params,
                 url,
                 headers,
                 method,

package/dist/index.d.ts

@@ -3,7 +3,7 @@
  * authors create inputs, actions, and components that can
  * be processed by the Prismatic API.
  */
-import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, DataSourceType, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, OnPremConnectionDefinition, ComponentManifest } from "./types";
+import { ActionDefinition, InputFieldDefinition, ComponentDefinition, DefaultConnectionDefinition, OAuth2ConnectionDefinition, Inputs, TriggerDefinition, ActionPerformReturn, TriggerResult, DataSourceDefinition, DataSourceType, IntegrationDefinition, Flow, ConfigPage, StandardConfigVar, ConnectionConfigVar, ConfigVarResultCollection, TriggerPayload, DataSourceConfigVar, OnPremConnectionDefinition, ComponentManifest, OrganizationActivatedConnectionConfigVar } from "./types";
 import { convertComponent } from "./serverTypes/convertComponent";
 import { convertIntegration } from "./serverTypes/convertIntegration";
 /**
@@ -50,6 +50,15 @@ export declare const dataSourceConfigVar: <TDataSourceConfigVar extends DataSour
  * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
  */
 export declare const connectionConfigVar: <T extends ConnectionConfigVar = ConnectionConfigVar>(definition: T) => T;
+/**
+ * For information on writing Code Native Integrations, see
+ * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * @param definition A Customer Connection Config Var type object.
+ * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
+ */
+export declare const organizationActivatedConnection: <T extends {
+    stableKey: string;
+}>(definition: T) => OrganizationActivatedConnectionConfigVar;
 /**
  * @param definition A Component Manifest type object.
  * @returns This function returns a component manifest object that has the shape the Prismatic API expects.

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testing = exports.util = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
+exports.testing = exports.util = exports.componentManifests = exports.oauth2Connection = exports.onPremConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.componentManifest = exports.organizationActivatedConnection = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
 const convertComponent_1 = require("./serverTypes/convertComponent");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
@@ -82,6 +82,16 @@ exports.dataSourceConfigVar = dataSourceConfigVar;
  */
 const connectionConfigVar = (definition) => definition;
 exports.connectionConfigVar = connectionConfigVar;
+/**
+ * For information on writing Code Native Integrations, see
+ * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
+ * @param definition A Customer Connection Config Var type object.
+ * @returns This function returns a connection config var object that has the shape the Prismatic API expects.
+ */
+const organizationActivatedConnection = (definition) => {
+    return Object.assign(Object.assign({}, definition), { dataType: "connection" });
+};
+exports.organizationActivatedConnection = organizationActivatedConnection;
 /**
  * @param definition A Component Manifest type object.
  * @returns This function returns a component manifest object that has the shape the Prismatic API expects.

package/dist/serverTypes/convertIntegration.d.ts

@@ -1,6 +1,8 @@
-import { IntegrationDefinition, ConfigVar, ComponentRegistry } from "../types";
+import { IntegrationDefinition, ConfigVar, Flow, ComponentRegistry } from "../types";
 import { Component as ServerComponent } from ".";
 import { RequiredConfigVariable as ServerRequiredConfigVariable } from "./integration";
 export declare const convertIntegration: (definition: IntegrationDefinition) => ServerComponent;
+/** Converts a Flow into the structure necessary for YAML generation. */
+export declare const convertFlow: (flow: Flow, componentRegistry: ComponentRegistry, referenceKey: string) => Record<string, unknown>;
 /** Converts a Config Var into the structure necessary for YAML generation. */
 export declare const convertConfigVar: (key: string, configVar: ConfigVar, referenceKey: string, componentRegistry: ComponentRegistry) => ServerRequiredConfigVariable;

package/dist/serverTypes/convertIntegration.js

@@ -12,28 +12,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertConfigVar = exports.convertIntegration = void 0;
+exports.convertConfigVar = exports.convertFlow = exports.convertIntegration = void 0;
 const yaml_1 = __importDefault(require("yaml"));
 const uuid_1 = require("uuid");
 const lodash_1 = require("lodash");
 const types_1 = require("../types");
 const convertComponent_1 = require("./convertComponent");
 const integration_1 = require("./integration");
+const lodash_2 = require("lodash");
 const convertIntegration = (definition) => {
-    var _a, _b;
+    var _a, _b, _c;
     // 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 scopedConfigVars = (_a = definition.scopedConfigVars) !== null && _a !== void 0 ? _a : {};
     const configVars = Object.values({
-        configPages: (_a = definition.configPages) !== null && _a !== void 0 ? _a : {},
-        userLevelConfigPages: (_b = definition.userLevelConfigPages) !== null && _b !== void 0 ? _b : {},
+        configPages: (_b = definition.configPages) !== null && _b !== void 0 ? _b : {},
+        userLevelConfigPages: (_c = definition.userLevelConfigPages) !== null && _c !== void 0 ? _c : {},
     }).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) {
+        if (key in acc || key in scopedConfigVars) {
             throw new Error(`Duplicate config var key: "${key}"`);
         }
         return Object.assign(Object.assign({}, acc), { [key]: element });
@@ -58,7 +60,7 @@ const convertConfigPages = (pages, userLevelConfigured) => {
                 value: key,
             }) })));
 };
-const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, userLevelConfigPages, componentRegistry = {}, }, referenceKey, configVars) => {
+const codeNativeIntegrationYaml = ({ name, description, category, documentation, version, labels, endpointType, triggerPreprocessFlowConfig, flows, configPages, userLevelConfigPages, scopedConfigVars, 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.
@@ -76,6 +78,13 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
     if (nonPreprocessFlowTypes.includes(endpointType || "flow_specific") && !preprocessFlowConfig) {
         throw new Error("Integration with specified EndpointType must define either a Trigger Preprocess Flow Config or a Preprocess Flow.");
     }
+    const configVarMap = Object.entries(scopedConfigVars !== null && scopedConfigVars !== void 0 ? scopedConfigVars : {}).reduce((acc, [key, value]) => {
+        if (typeof value === "string") {
+            return acc;
+        }
+        return Object.assign(Object.assign({}, acc), { [key]: value });
+    }, Object.assign({}, (configVars !== null && configVars !== void 0 ? configVars : {})));
+    const requiredConfigVars = Object.entries(configVarMap).map(([key, configVar]) => (0, exports.convertConfigVar)(key, configVar, referenceKey, componentRegistry));
     // Transform the IntegrationDefinition into the structure that is appropriate
     // for generating YAML, which will then be used by the Prismatic API to import
     // the integration as a Code Native Integration.
@@ -88,13 +97,13 @@ const codeNativeIntegrationYaml = ({ name, description, category, documentation,
         documentation,
         version,
         labels,
-        requiredConfigVars: Object.entries(configVars || {}).map(([key, configVar]) => (0, exports.convertConfigVar)(key, configVar, referenceKey, componentRegistry)),
+        requiredConfigVars,
         endpointType,
         preprocessFlowName: hasPreprocessFlow ? preprocessFlows[0].name : undefined,
         externalCustomerIdField: fieldNameToReferenceInput(hasPreprocessFlow ? "onExecution" : "payload", preprocessFlowConfig === null || preprocessFlowConfig === void 0 ? void 0 : preprocessFlowConfig.externalCustomerIdField),
         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)),
+        flows: flows.map((flow) => (0, exports.convertFlow)(flow, componentRegistry, referenceKey)),
         configPages: [
             ...convertConfigPages(configPages, false),
             ...convertConfigPages(userLevelConfigPages, true),
@@ -198,11 +207,21 @@ const convertComponentReference = (componentReference, componentRegistry, refere
         inputs,
     };
 };
-const convertComponentRegistry = (componentRegistry) => Object.values(componentRegistry).map(({ key, public: isPublic, signature }) => ({
-    key,
-    signature: signature !== null && signature !== void 0 ? signature : "",
-    isPublic,
-}));
+const convertComponentRegistry = (componentRegistry, publicSupplementalComponent) => {
+    const convertedRegistry = Object.values(componentRegistry).map(({ key, public: isPublic, signature }) => ({
+        key,
+        signature: signature !== null && signature !== void 0 ? signature : "",
+        isPublic,
+    }));
+    if (publicSupplementalComponent) {
+        convertedRegistry.push({
+            key: `${publicSupplementalComponent}-triggers`,
+            isPublic: true,
+            version: "LATEST",
+        });
+    }
+    return convertedRegistry;
+};
 /**
  * Create a reference to the private component built as part of this CNI.
  *
@@ -214,6 +233,12 @@ const codeNativeIntegrationComponentReference = (referenceKey) => ({
     version: "LATEST",
     isPublic: false,
 });
+/* A flow's trigger gets wrapped in a custom component if there's a defined
+ * onTrigger function, or if any custom onInstance behavior is defined.
+ * */
+const flowUsesWrapperTrigger = (flow) => {
+    return typeof flow.onTrigger === "function" || flow.onInstanceDelete || flow.onInstanceDeploy;
+};
 /** Converts a Flow into the structure necessary for YAML generation. */
 const convertFlow = (flow, componentRegistry, referenceKey) => {
     var _a;
@@ -225,6 +250,7 @@ const convertFlow = (flow, componentRegistry, referenceKey) => {
     result.onExecution = undefined;
     result.preprocessFlowConfig = undefined;
     result.errorConfig = undefined;
+    let publicSupplementalComponent;
     const triggerStep = {
         name: "On Trigger",
         stableKey: `${flow.stableKey}-onTrigger`,
@@ -232,17 +258,21 @@ const convertFlow = (flow, componentRegistry, referenceKey) => {
         isTrigger: true,
         errorConfig: "errorConfig" in flow ? Object.assign({}, flow.errorConfig) : undefined,
     };
-    if (typeof flow.onTrigger === "function") {
+    const useWrapperTrigger = flowUsesWrapperTrigger(flow);
+    if ((0, types_1.isComponentReference)(flow.onTrigger) && !useWrapperTrigger) {
+        const { ref, inputs } = convertComponentReference(flow.onTrigger, componentRegistry, "triggers");
+        triggerStep.action = ref;
+        triggerStep.inputs = inputs;
+    }
+    else if (useWrapperTrigger) {
+        if (!flow.onTrigger) {
+            publicSupplementalComponent = flow.schedule ? "schedule" : "webhook";
+        }
         triggerStep.action = {
             key: flowFunctionKey(flow.name, "onTrigger"),
             component: codeNativeIntegrationComponentReference(referenceKey),
         };
     }
-    else if ((0, types_1.isComponentReference)(flow.onTrigger)) {
-        const { ref, inputs } = convertComponentReference(flow.onTrigger, componentRegistry, "triggers");
-        triggerStep.action = ref;
-        triggerStep.inputs = inputs;
-    }
     else {
         const hasSchedule = "schedule" in flow && typeof flow.schedule === "object";
         const key = hasSchedule ? "schedule" : "webhook";
@@ -281,9 +311,10 @@ const convertFlow = (flow, componentRegistry, referenceKey) => {
         errorConfig: "errorConfig" in flow ? Object.assign({}, flow.errorConfig) : undefined,
     };
     result.steps = [triggerStep, actionStep];
-    result.supplementalComponents = convertComponentRegistry(componentRegistry);
+    result.supplementalComponents = convertComponentRegistry(componentRegistry, publicSupplementalComponent);
     return result;
 };
+exports.convertFlow = convertFlow;
 /** Converts an input value to the expected server type by its collection type */
 const convertInputValue = (value, collectionType) => {
     if (collectionType !== "keyvaluelist") {
@@ -300,6 +331,16 @@ const convertInputValue = (value, collectionType) => {
 /** Converts a Config Var into the structure necessary for YAML generation. */
 const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
     var _a;
+    if ((0, types_1.isOrganizationActivatedConnectionConfigVar)(configVar)) {
+        const { stableKey } = (0, lodash_1.pick)(configVar, ["stableKey"]);
+        return {
+            key,
+            stableKey,
+            dataType: "connection",
+            orgOnly: false,
+            useScopedConfigVar: stableKey,
+        };
+    }
     const { orgOnly, meta } = convertConfigVarPermissionAndVisibility((0, lodash_1.pick)(configVar, ["permissionAndVisibilityType", "visibleToOrgDeployer"]));
     if ((0, types_1.isConnectionDefinitionConfigVar)(configVar)) {
         const { stableKey, description } = (0, lodash_1.pick)(configVar, ["stableKey", "description"]);
@@ -413,6 +454,58 @@ const flowFunctionKey = (flowName, functionName) => {
         .join("");
     return `${flowKey}_${functionName}`;
 };
+/* Generates component argument for invokeTrigger calls */
+const invokeTriggerComponentInput = (componentRef, onTrigger, eventName) => {
+    const { component } = componentRef;
+    const inputComponent = "signature" in componentRef.component
+        ? {
+            key: component.key,
+            signature: "signature" in component &&
+                component.signature !== null &&
+                component.signature !== void 0
+                ? component.signature
+                : "",
+            isPublic: component.isPublic,
+        }
+        : component;
+    return {
+        component: inputComponent,
+        key: onTrigger ? onTrigger.key : componentRef.key,
+        triggerEventFunctionName: eventName,
+    };
+};
+/* Generates a wrapper function that calls an existing component trigger's perform */
+const generateTriggerPerformFn = (componentRef, onTrigger) => {
+    const performFn = componentRef && typeof onTrigger !== "function"
+        ? (context, payload, params) => __awaiter(void 0, void 0, void 0, function* () {
+            // @ts-expect-error: _components isn't part of the public API
+            const { _components } = context;
+            const invokeTrigger = _components.invokeTrigger;
+            return yield invokeTrigger(invokeTriggerComponentInput(componentRef, onTrigger, "perform"), context, payload, params);
+        })
+        : onTrigger;
+    return performFn;
+};
+/** Generates a wrapper function that calls an existing component's onInstanceDeploy
+ * or onInstanceDelete, then calls the flow-defined version if it exists.
+ * Returns the deep-merged results of the two, prioritizing the custom response
+ * if there's a conflict. */
+const generateOnInstanceWrapperFn = (componentRef, onTrigger, eventName, customFn) => {
+    const onInstanceFn = componentRef && typeof onTrigger !== "function"
+        ? (context, params) => __awaiter(void 0, void 0, void 0, function* () {
+            // @ts-expect-error: _components isn't part of the public API
+            const { _components } = context;
+            const invokeTrigger = _components.invokeTrigger;
+            const invokeResponse = (yield invokeTrigger(invokeTriggerComponentInput(componentRef, onTrigger, eventName), context, null, params)) || {};
+            let customResponse = {};
+            if (customFn) {
+                customResponse = (yield customFn(context, params)) || {};
+            }
+            return (0, lodash_2.merge)(invokeResponse, customResponse);
+        })
+        : customFn;
+    return onInstanceFn;
+};
 const convertOnExecution = (onExecution, componentRegistry) => (context, params) => {
     // @ts-expect-error _components isn't part of the public API
     const { _components } = context;
@@ -463,22 +556,40 @@ const codeNativeIntegrationComponent = ({ name, iconPath, description, flows = [
                 inputs: [],
             } });
     }, {});
-    const convertedTriggers = flows.reduce((result, { name, onTrigger, onInstanceDeploy, onInstanceDelete }) => {
-        if (typeof onTrigger !== "function") {
+    const convertedTriggers = flows.reduce((result, { name, onTrigger, onInstanceDeploy, onInstanceDelete, schedule }) => {
+        if (!flowUsesWrapperTrigger({ onTrigger, onInstanceDelete, onInstanceDeploy })) {
+            // In this scenario, the user has defined an existing component trigger
+            // without any custom behavior, so we don't need to wrap anything.
             return result;
         }
         const key = flowFunctionKey(name, "onTrigger");
+        const defaultComponentKey = schedule && typeof schedule === "object" ? "schedule" : "webhook";
+        const defaultComponentRef = {
+            component: {
+                key: `${defaultComponentKey}-triggers`,
+                version: "LATEST",
+                isPublic: true,
+            },
+            key: defaultComponentKey,
+        };
+        // The component ref here is undefined if onTrigger is a function.
+        const { ref } = (0, types_1.isComponentReference)(onTrigger)
+            ? convertComponentReference(onTrigger, componentRegistry, "triggers")
+            : { ref: onTrigger ? undefined : defaultComponentRef };
+        const performFn = generateTriggerPerformFn(ref, onTrigger);
+        const deleteFn = generateOnInstanceWrapperFn(ref, onTrigger, "onInstanceDelete", onInstanceDelete);
+        const deployFn = generateOnInstanceWrapperFn(ref, onTrigger, "onInstanceDeploy", onInstanceDeploy);
         return Object.assign(Object.assign({}, result), { [key]: {
                 key,
                 display: {
                     label: `${name} - onTrigger`,
                     description: "The function that will be executed by the flow to return an HTTP response.",
                 },
-                perform: onTrigger,
-                onInstanceDeploy: onInstanceDeploy,
-                hasOnInstanceDeploy: !!onInstanceDeploy,
-                onInstanceDelete: onInstanceDelete,
-                hasOnInstanceDelete: !!onInstanceDelete,
+                perform: performFn,
+                onInstanceDeploy: deployFn,
+                hasOnInstanceDeploy: !!deployFn,
+                onInstanceDelete: deleteFn,
+                hasOnInstanceDelete: !!deleteFn,
                 inputs: [],
                 scheduleSupport: "valid",
                 synchronousResponseSupport: "valid",

package/dist/serverTypes/integration.d.ts

@@ -54,7 +54,14 @@ export interface DefaultRequiredConfigVariable {
     inputs?: Record<string, Input>;
     meta?: Record<string, unknown>;
 }
-export type RequiredConfigVariable = DefaultRequiredConfigVariable | ConnectionRequiredConfigVariable;
+export interface OrganizationActivatedConnectionRequiredConfigVariable {
+    key: string;
+    dataType: "connection";
+    orgOnly: false;
+    inputs?: never;
+    useScopedConfigVar: string;
+}
+export type RequiredConfigVariable = DefaultRequiredConfigVariable | ConnectionRequiredConfigVariable | OrganizationActivatedConnectionRequiredConfigVariable;
 export interface ConfigPage {
     name: string;
     tagline?: string;

package/dist/types/ConfigVars.d.ts

@@ -1,5 +1,5 @@
 import { ValidationMode } from "@jsonforms/core";
-import { type DataSourceDefinition, type ConnectionDefinition, type Inputs, type DataSourceType, type Connection, type JSONForm, type ObjectFieldMap, type ObjectSelection, type ConfigVarResultCollection, type Schedule, type CollectionDataSourceType, type DataSourceReference, type ConfigPage, type ConfigPages, type ConfigPageElement, type ComponentRegistryDataSource, type ComponentRegistryConnection, type UserLevelConfigPages } from ".";
+import { type DataSourceDefinition, type ConnectionDefinition, type Inputs, type DataSourceType, type Connection, type JSONForm, type ObjectFieldMap, type ObjectSelection, type ConfigVarResultCollection, type Schedule, type CollectionDataSourceType, type DataSourceReference, type ConfigPage, type ConfigPages, type ConfigPageElement, type ComponentRegistryDataSource, type ComponentRegistryConnection, type UserLevelConfigPages, type OrganizationActivatedConnectionConfigVar, type ScopedConfigVarMap } from ".";
 import type { Prettify, UnionToIntersection } from "./utils";
 /** Supported data types for Config Vars. */
 export type ConfigVarDataType = "string" | "date" | "timestamp" | "picklist" | "code" | "boolean" | "number" | "schedule" | "objectSelection" | "objectFieldMap" | "jsonForm";
@@ -161,7 +161,7 @@ type ConnectionReferenceConfigVar = ComponentRegistryConnection extends infer TC
 } : never : never;
 /** Defines attributes of a Config Var that represents a Connection. */
 export type ConnectionConfigVar = ConnectionDefinitionConfigVar | ConnectionReferenceConfigVar;
-export type ConfigVar = StandardConfigVar | DataSourceConfigVar | ConnectionConfigVar;
+export type ConfigVar = StandardConfigVar | DataSourceConfigVar | ConnectionConfigVar | OrganizationActivatedConnectionConfigVar;
 type WithCollectionType<TValue, TCollectionType extends CollectionType | undefined> = undefined | unknown extends TCollectionType ? TValue : TCollectionType extends "valuelist" ? TValue[] : Array<{
     key: string;
     value: TValue;
@@ -174,7 +174,12 @@ type ExtractConfigVars<TConfigPages extends {
 }> = 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;
-export type ConfigVars = Prettify<UnionToIntersection<ExtractConfigVars<ConfigPages>>> & Prettify<UnionToIntersection<ExtractConfigVars<UserLevelConfigPages>>>;
+type ExtractScopedConfigVars<TScopedConfigVarMap extends {
+    [key: string]: string | OrganizationActivatedConnectionConfigVar;
+}> = keyof TScopedConfigVarMap extends infer TScopedConfigVarName ? TScopedConfigVarName extends keyof TScopedConfigVarMap ? TScopedConfigVarMap[TScopedConfigVarName] extends infer TScopedConfigVar ? TScopedConfigVar extends OrganizationActivatedConnectionConfigVar ? {
+    [Key in keyof TScopedConfigVarMap as Key extends string ? TScopedConfigVarMap[Key] extends OrganizationActivatedConnectionConfigVar ? Key : never : never]: Connection;
+} : never : never : never : never;
+export type ConfigVars = Prettify<UnionToIntersection<ExtractConfigVars<ConfigPages>>> & Prettify<UnionToIntersection<ExtractConfigVars<UserLevelConfigPages>>> & Prettify<UnionToIntersection<ExtractScopedConfigVars<ScopedConfigVarMap>>>;
 export declare const isCodeConfigVar: (cv: ConfigVar) => cv is CodeConfigVar;
 export declare const isScheduleConfigVar: (cv: ConfigVar) => cv is ScheduleConfigVar;
 export declare const isJsonFormConfigVar: (cv: ConfigVar) => cv is JsonFormConfigVar;

package/dist/types/IntegrationDefinition.d.ts

@@ -1,4 +1,4 @@
-import { ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, TriggerPayload, ComponentRegistry, TriggerReference, ConfigVars, ConfigPages, UserLevelConfigPages, ValueExpression, ConfigVarExpression, ActionContext } from ".";
+import { ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, TriggerPayload, ComponentRegistry, TriggerReference, ConfigVars, ConfigPages, UserLevelConfigPages, ValueExpression, ConfigVarExpression, ActionContext, ScopedConfigVarMap } from ".";
 /** Defines attributes of a Code-Native Integration. */
 export type IntegrationDefinition = {
     /** The unique name for this Integration. */
@@ -28,6 +28,8 @@ export type IntegrationDefinition = {
     configPages?: ConfigPages;
     /** User Level Config Wizard Pages for this Integration. */
     userLevelConfigPages?: UserLevelConfigPages;
+    /** Scoped ConfigVars for this Integration. */
+    scopedConfigVars?: ScopedConfigVarMap;
     componentRegistry?: ComponentRegistry;
 };
 export type FlowOnExecution<TTriggerPayload extends TriggerPayload> = ActionPerformFunction<{

package/dist/types/ScopedConfigVars.d.ts

@@ -0,0 +1,29 @@
+import { type ConfigVar } from ".";
+import type { UnionToIntersection } from "./utils";
+export type OrganizationActivatedConnectionConfigVar = {
+    dataType: "connection";
+    stableKey: string;
+};
+export type ScopedConfigVar = OrganizationActivatedConnectionConfigVar;
+/**
+ * Root ScopedConfigVars type exposed for augmentation.
+ *
+ * The expected interface when augmenting is:
+ *
+ * ```ts
+ * interface IntegrationDefinitionScopedConfigVars {
+ *   [key: string]: OrganizationActivatedConnectionConfigVar
+ * }
+ * ```
+ *
+ */
+export interface IntegrationDefinitionScopedConfigVars {
+}
+type CreateScopedConfigVars<TScopedConfigVarMap> = keyof TScopedConfigVarMap extends never ? {
+    [key: string]: OrganizationActivatedConnectionConfigVar | string;
+} : UnionToIntersection<keyof TScopedConfigVarMap extends infer TScopedConfigVarName ? TScopedConfigVarName extends keyof TScopedConfigVarMap ? TScopedConfigVarMap[TScopedConfigVarName] extends OrganizationActivatedConnectionConfigVar ? {
+    [Key in TScopedConfigVarName]: TScopedConfigVarMap[TScopedConfigVarName];
+} : never : never : never>;
+export type ScopedConfigVarMap = CreateScopedConfigVars<IntegrationDefinitionScopedConfigVars>;
+export declare const isOrganizationActivatedConnectionConfigVar: (cv: ConfigVar) => cv is OrganizationActivatedConnectionConfigVar;
+export {};

package/dist/types/ScopedConfigVars.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOrganizationActivatedConnectionConfigVar = void 0;
+const _1 = require(".");
+const isOrganizationActivatedConnectionConfigVar = (cv) => "dataType" in cv &&
+    cv.dataType === "connection" &&
+    !(0, _1.isConnectionDefinitionConfigVar)(cv) &&
+    !(0, _1.isConnectionReferenceConfigVar)(cv);
+exports.isOrganizationActivatedConnectionConfigVar = isOrganizationActivatedConnectionConfigVar;

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export * from "./ComponentDefinition";
 export * from "./ComponentRegistry";
 export * from "./ConfigPages";
 export * from "./ConfigVars";
+export * from "./ScopedConfigVars";
 export * from "./ConnectionDefinition";
 export * from "./Inputs";
 export * from "./ActionPerformReturn";
@@ -32,4 +33,5 @@ export * from "./IntegrationAttributes";
 export * from "./FlowAttributes";
 export * from "./IntegrationDefinition";
 export * from "./ComponentManifest";
+export * from "./ScopedConfigVars";
 export * as serverTypes from "../serverTypes";

package/dist/types/index.js

@@ -36,6 +36,7 @@ __exportStar(require("./ComponentDefinition"), exports);
 __exportStar(require("./ComponentRegistry"), exports);
 __exportStar(require("./ConfigPages"), exports);
 __exportStar(require("./ConfigVars"), exports);
+__exportStar(require("./ScopedConfigVars"), exports);
 __exportStar(require("./ConnectionDefinition"), exports);
 __exportStar(require("./Inputs"), exports);
 __exportStar(require("./ActionPerformReturn"), exports);
@@ -61,4 +62,5 @@ __exportStar(require("./IntegrationAttributes"), exports);
 __exportStar(require("./FlowAttributes"), exports);
 __exportStar(require("./IntegrationDefinition"), exports);
 __exportStar(require("./ComponentManifest"), exports);
+__exportStar(require("./ScopedConfigVars"), exports);
 exports.serverTypes = __importStar(require("../serverTypes"));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "9.1.4",
-  "description": "Utility library for building Prismatic components",
+  "version": "9.2.0",
+  "description": "Utility library for building Prismatic components and code-native integrations",
   "keywords": ["prismatic"],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",