@prismatic-io/spectral 9.0.6 → 9.1.0

package/dist/generators/componentManifest/getInputs.d.ts

@@ -11,6 +11,7 @@ export interface Input {
     valueType: ValueType;
     docBlock: string;
     required: boolean | undefined;
+    default: ServerTypeInput["default"];
 }
 export type ValueType = string | {
     type: string;

package/dist/generators/componentManifest/getInputs.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.INPUT_TYPE_MAP = exports.getInputs = void 0;
 const docBlock_1 = require("./docBlock");
+const getDefaultValue = (value) => {
+    if (value === undefined || value === "") {
+        return value;
+    }
+    if (typeof value === "string") {
+        return value;
+    }
+    return JSON.stringify(value);
+};
 const getInputs = ({ inputs, docBlock = docBlock_1.DOC_BLOCK_DEFAULT }) => {
     return inputs.reduce((acc, input) => {
         if ((typeof input.shown === "boolean" && input.shown === false) ||
@@ -20,6 +29,7 @@ const getInputs = ({ inputs, docBlock = docBlock_1.DOC_BLOCK_DEFAULT }) => {
                 collection: input.collection,
                 onPremControlled: input.onPremiseControlled || input.onPremControlled,
                 docBlock: docBlock(input),
+                default: getDefaultValue(input.default),
             },
         ];
     }, []);

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

@@ -6,8 +6,10 @@
     <%_ } else { -%>
     collection: undefined,
     <%_ } -%>
-    <%_ if (input.default) { -%>
-    default: <%= input.default %>,
+    <%_ if (typeof input.default !== 'undefined') { -%>
+    default: `<%- input.default %>`,
+    <%_ } else { -%>
+    default: undefined,
     <%_ } -%>
     <%_ if (input.required) { -%>
     required: <%= input.required %>,

package/dist/serverTypes/convertComponent.js

@@ -18,7 +18,7 @@ const lodash_1 = require("lodash");
 const convertInput = (key, _a) => {
     var { default: defaultValue, type, label, collection } = _a, rest = __rest(_a, ["default", "type", "label", "collection"]);
     const keyLabel = collection === "keyvaluelist" && typeof label === "object" ? label.key : undefined;
-    return Object.assign(Object.assign({}, (0, lodash_1.omit)(rest, ["onPremControlled"])), { key,
+    return Object.assign(Object.assign({}, (0, lodash_1.omit)(rest, ["onPremControlled", "permissionAndVisibilityType", "visibleToOrgDeployer"])), { key,
         type, default: defaultValue !== null && defaultValue !== void 0 ? defaultValue : types_1.InputFieldDefaultMap[type], collection, label: typeof label === "string" ? label : label.value, keyLabel, onPremiseControlled: ("onPremControlled" in rest && rest.onPremControlled) || undefined });
 };
 exports.convertInput = convertInput;

package/dist/serverTypes/convertIntegration.js

@@ -156,7 +156,7 @@ const convertConfigVarPermissionAndVisibility = ({ permissionAndVisibilityType,
     };
 };
 const convertComponentReference = (componentReference, componentRegistry, referenceType) => {
-    var _a, _b, _c;
+    var _a, _b;
     const manifest = componentRegistry[componentReference.component];
     if (!manifest) {
         throw new Error(`Component with key "${componentReference.component}" not found in component registry.`);
@@ -174,8 +174,12 @@ const convertComponentReference = (componentReference, componentRegistry, refere
         // older versions of the manifest did not contain a key so we fall back to the componentReference key
         key: (_b = manifestEntry.key) !== null && _b !== void 0 ? _b : componentReference.key,
     };
-    const inputs = Object.entries((_c = componentReference.values) !== null && _c !== void 0 ? _c : {}).reduce((result, [key, value]) => {
-        const manifestEntryInput = manifestEntry.inputs[key];
+    const inputs = Object.entries(manifestEntry.inputs).reduce((result, [key, manifestEntryInput]) => {
+        var _a, _b, _c;
+        // Retrieve the input value or default to the manifest's default value
+        const value = (_b = (_a = componentReference.values) === null || _a === void 0 ? void 0 : _a[key]) !== null && _b !== void 0 ? _b : {
+            value: (_c = manifestEntryInput.default) !== null && _c !== void 0 ? _c : "",
+        };
         const type = manifestEntryInput.collection
             ? "complex"
             : "value" in value
@@ -186,10 +190,12 @@ const convertComponentReference = (componentReference, componentRegistry, refere
                 ? Object.entries(value.value).map(([k, v]) => ({
                     name: { type: "value", value: k },
                     type: "value",
-                    value: v,
+                    value: JSON.stringify(v),
                 }))
                 : value.value;
-            const formattedValue = type === "complex" || typeof valueExpr === "string" ? valueExpr : JSON.stringify(valueExpr);
+            const formattedValue = type === "complex" || typeof valueExpr === "string"
+                ? valueExpr
+                : JSON.stringify(valueExpr);
             const meta = convertInputPermissionAndVisibility((0, lodash_1.pick)(value, ["permissionAndVisibilityType", "visibleToOrgDeployer"]));
             return Object.assign(Object.assign({}, result), { [key]: { type: type, value: formattedValue, meta } });
         }
@@ -320,10 +326,12 @@ const convertConfigVar = (key, configVar, referenceKey, componentRegistry) => {
                 if (input.shown === false) {
                     return result;
                 }
+                const meta = convertInputPermissionAndVisibility((0, lodash_1.pick)(input, ["permissionAndVisibilityType", "visibleToOrgDeployer"]));
                 const defaultValue = input.collection ? [] : "";
                 return Object.assign(Object.assign({}, result), { [key]: {
                         type: input.collection ? "complex" : "value",
                         value: input.default || defaultValue,
+                        meta,
                     } });
             }, {}),
             orgOnly,
@@ -402,12 +410,15 @@ const convertOnExecution = (onExecution, componentRegistry) => (context, params)
     // Construct the component methods from the component registry
     const componentMethods = Object.entries(componentRegistry).reduce((accumulator, [registryComponentKey, { key: componentKey, actions, public: isPublic, signature }]) => {
         const componentActions = Object.entries(actions).reduce((actionsAccumulator, [registryActionKey, action]) => {
+            const manifestActions = componentRegistry[componentKey].actions[registryActionKey];
             // Define the method to be called for the action
             const invokeAction = (values) => __awaiter(void 0, void 0, void 0, function* () {
                 var _a;
-                // Transform the input values based on the action's inputs
-                const transformedValues = Object.entries(values).reduce((transformedAccumulator, [inputKey, inputValue]) => {
-                    const { collection } = action.inputs[inputKey];
+                // Apply defaults directly within the transformation process
+                const transformedValues = Object.entries(manifestActions.inputs).reduce((transformedAccumulator, [inputKey, inputValueBase]) => {
+                    var _a;
+                    const inputValue = (_a = values[inputKey]) !== null && _a !== void 0 ? _a : inputValueBase.default;
+                    const { collection } = inputValueBase;
                     return Object.assign(Object.assign({}, transformedAccumulator), { [inputKey]: convertInputValue(inputValue, collection) });
                 }, {});
                 // Invoke the action with the transformed values

package/dist/types/ComponentManifest.d.ts

@@ -15,23 +15,23 @@ interface BaseInput {
     default?: unknown;
 }
 export interface ComponentManifestAction {
-    key: string;
+    key?: string;
     perform: (values: any) => Promise<unknown>;
     inputs: Record<string, BaseInput>;
 }
 export interface ComponentManifestTrigger {
-    key: string;
+    key?: string;
     perform: (values: any) => Promise<unknown>;
     inputs: Record<string, BaseInput>;
 }
 export interface ComponentManifestDataSource {
-    key: string;
+    key?: string;
     perform: (values: any) => Promise<unknown>;
     dataSourceType: DataSourceType;
     inputs: Record<string, BaseInput>;
 }
 export interface ComponentManifestConnection {
-    key: string;
+    key?: string;
     perform: (values: any) => Promise<unknown>;
     onPremAvailable?: boolean;
     inputs: Record<string, BaseInput & {

package/dist/types/ComponentRegistry.d.ts

@@ -1,5 +1,5 @@
-import { ComponentManifest, PermissionAndVisibilityType } from ".";
-import { Prettify, UnionToIntersection } from "./utils";
+import type { ComponentManifest, ConfigVarVisibility } from ".";
+import type { Prettify, UnionToIntersection } from "./utils";
 /**
  * Root ComponentRegistry type exposed for augmentation.
  *
@@ -19,18 +19,6 @@ export type ComponentRegistry = keyof IntegrationDefinitionComponentRegistry ext
 } : UnionToIntersection<keyof IntegrationDefinitionComponentRegistry extends infer TComponentKey ? TComponentKey extends keyof IntegrationDefinitionComponentRegistry ? {
     [Key in TComponentKey]: IntegrationDefinitionComponentRegistry[TComponentKey];
 } : never : never>;
-export interface ConnectionInputPermissionAndVisibility {
-    /**
-     * Optional value that sets the permission and visibility of the Config Var. @default "customer"
-     *
-     * "customer" - Customers can view and edit the Config Var.
-     * "embedded" - Customers cannot view or update the Config Var as the value will be set programmatically.
-     * "organization" - Customers cannot view or update the Config Var as it will always have a default value or be set by the organization.
-     */
-    permissionAndVisibilityType?: PermissionAndVisibilityType;
-    /** Optional value that specifies whether this Config Var is visible to an Organization deployer. @default true */
-    visibleToOrgDeployer?: boolean;
-}
 export type ConfigVarExpression = {
     configVar: string;
 };
@@ -42,7 +30,7 @@ type ComponentReferenceTypeValueMap<TValue, TMap extends Record<ComponentReferen
     actions: ValueExpression<TValue>;
     triggers: ValueExpression<TValue> | ConfigVarExpression;
     dataSources: ValueExpression<TValue> | ConfigVarExpression;
-    connections: (ValueExpression<TValue> | ConfigVarExpression) & ConnectionInputPermissionAndVisibility;
+    connections: (ValueExpression<TValue> | ConfigVarExpression) & ConfigVarVisibility;
 }> = TMap;
 export type ComponentReference<TComponentReference extends {
     component: string;

package/dist/types/ConfigVars.d.ts

@@ -1,5 +1,5 @@
-import { DataSourceDefinition, ConnectionDefinition, Inputs, DataSourceType, Connection, JSONForm, ObjectFieldMap, ObjectSelection, ConfigVarResultCollection, Schedule, CollectionDataSourceType, DataSourceReference, ConfigPage, ConfigPages, ConfigPageElement, ComponentRegistryDataSource, ComponentRegistryConnection, UserLevelConfigPages } from ".";
-import { Prettify, UnionToIntersection } from "./utils";
+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 { Prettify, UnionToIntersection } from "./utils";
 /** Supported data types for Config Vars. */
 export type ConfigVarDataType = "string" | "date" | "timestamp" | "picklist" | "code" | "boolean" | "number" | "schedule" | "objectSelection" | "objectFieldMap" | "jsonForm";
 type ConfigVarDataTypeDefaultValueMap<TMap extends Record<ConfigVarDataType, unknown> = {
@@ -30,14 +30,9 @@ type ConfigVarDataTypeRuntimeValueMap<TMap extends Record<ConfigVarDataType, unk
 }> = TMap;
 /** Choices of collection types for multi-value Config Vars. */
 export type CollectionType = "valuelist" | "keyvaluelist";
-export type PermissionAndVisibilityType = "customer" | "embedded" | "organization";
 type ConfigVarSingleDataType = Extract<ConfigVarDataType, "schedule" | "objectSelection" | "objectFieldMap" | "jsonForm">;
-/** Common attribute shared by all types of Config Vars. */
-type BaseConfigVar = {
-    /** A unique, unchanging value that is used to maintain identity for the Config Var even if the key changes. */
-    stableKey: string;
-    /** Optional description for this Config Var. */
-    description?: string;
+export type PermissionAndVisibilityType = "customer" | "embedded" | "organization";
+export interface ConfigVarVisibility {
     /**
      * Optional value that sets the permission and visibility of the Config Var. @default "customer"
      *
@@ -48,7 +43,26 @@ type BaseConfigVar = {
     permissionAndVisibilityType?: PermissionAndVisibilityType;
     /** Optional value that specifies whether this Config Var is visible to an Organization deployer. @default true */
     visibleToOrgDeployer?: boolean;
-};
+}
+interface ConfigVarInputVisibility {
+    /**
+     * Optional value that sets the permission and visibility of the Config Var Input. @default "customer"
+     *
+     * "customer" - Customers can view and edit the Config Var Input.
+     * "embedded" - Customers cannot view or update the Config Var Input as the value will be set programmatically.
+     * "organization" - Customers cannot view or update the Config Var Input as it will always have a default value or be set by the organization.
+     */
+    permissionAndVisibilityType?: PermissionAndVisibilityType;
+    /** Optional value that specifies whether this Config Var Input is visible to an Organization deployer. @default true */
+    visibleToOrgDeployer?: boolean;
+}
+/** Common attribute shared by all types of Config Vars. */
+type BaseConfigVar = {
+    /** A unique, unchanging value that is used to maintain identity for the Config Var even if the key changes. */
+    stableKey: string;
+    /** Optional description for this Config Var. */
+    description?: string;
+} & ConfigVarVisibility;
 type GetDynamicProperties<TValue, TCollectionType extends CollectionType | undefined> = TCollectionType extends undefined ? {
     defaultValue?: TValue;
     /** Optional value to specify the type of collection if the Config Var is multi-value. */
@@ -115,7 +129,11 @@ export type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceRefe
 type BaseConnectionConfigVar = BaseConfigVar & {
     dataType: "connection";
 };
-type ConnectionDefinitionConfigVar = BaseConnectionConfigVar & Omit<ConnectionDefinition, "label" | "comments" | "key">;
+type ConnectionDefinitionConfigVar = ConnectionDefinition extends infer TConnectionDefinitionType extends ConnectionDefinition ? TConnectionDefinitionType extends infer TConnectionDefinition extends ConnectionDefinition ? BaseConnectionConfigVar & Omit<TConnectionDefinition, "inputs" | "label" | "comments" | "key"> & {
+    inputs: {
+        [Key in keyof TConnectionDefinition["inputs"]]: TConnectionDefinition["inputs"][Key] & ConfigVarInputVisibility;
+    };
+} : never : never;
 type OnPremiseConnectionConfigTypeEnum = "allowed" | "disallowed" | "required";
 type ConnectionReferenceConfigVar = ComponentRegistryConnection extends infer TConnectionReference ? TConnectionReference extends ComponentRegistryConnection ? BaseConnectionConfigVar & {
     connection: TConnectionReference["reference"] & ("onPremAvailable" extends keyof TConnectionReference ? TConnectionReference["onPremAvailable"] extends true ? {

package/dist/types/ConnectionDefinition.d.ts

@@ -1,4 +1,4 @@
-import { ConnectionInput, OnPremConnectionInput } from ".";
+import type { ConnectionInput, OnPremConnectionInput } from ".";
 export declare enum OAuth2Type {
     ClientCredentials = "client_credentials",
     AuthorizationCode = "authorization_code"
@@ -26,8 +26,13 @@ export interface OnPremConnectionDefinition extends BaseConnectionDefinition {
         [key: string]: ConnectionInput;
     };
 }
+interface OAuth2Config {
+    overrideGrantType?: string;
+    allowedTokenParams?: string[];
+}
 interface OAuth2AuthorizationCodeConnectionDefinition extends BaseConnectionDefinition {
     oauth2Type: OAuth2Type.AuthorizationCode;
+    oauth2Config?: OAuth2Config;
     /** The PKCE method (S256 or plain) that this OAuth 2.0 connection uses (if any) */
     oauth2PkceMethod?: OAuth2PkceMethod;
     inputs: {

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 } from ".";
+import { ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, TriggerPayload, ComponentRegistry, TriggerReference, ConfigVars, ConfigPages, UserLevelConfigPages, ValueExpression, ConfigVarExpression, ActionContext } from ".";
 /** Defines attributes of a Code-Native Integration. */
 export type IntegrationDefinition = {
     /** The unique name for this Integration. */
@@ -30,6 +30,21 @@ export type IntegrationDefinition = {
     userLevelConfigPages?: UserLevelConfigPages;
     componentRegistry?: ComponentRegistry;
 };
+export type FlowOnExecution<TTriggerPayload extends TriggerPayload> = ActionPerformFunction<{
+    onTrigger: {
+        type: "data";
+        label: string;
+        clean: (value: unknown) => {
+            results: TTriggerPayload;
+        };
+    };
+}, ConfigVars, {
+    [Key in keyof ComponentRegistry]: ComponentRegistry[Key]["actions"];
+}, false, ActionPerformReturn<false, unknown>>;
+export type FlowExecutionContext = ActionContext<ConfigVars, {
+    [Key in keyof ComponentRegistry]: ComponentRegistry[Key]["actions"];
+}>;
+export type FlowExecutionContextActions = FlowExecutionContext["components"];
 /** Defines attributes of a Flow of a Code-Native Integration. */
 export interface Flow<TTriggerPayload extends TriggerPayload = TriggerPayload> {
     /** The unique name for this Flow. */
@@ -61,17 +76,7 @@ export interface Flow<TTriggerPayload extends TriggerPayload = TriggerPayload> {
     /** Specifies the function to execute when an Instance of an Integration is deleted. */
     onInstanceDelete?: TriggerEventFunction<Inputs, ConfigVars>;
     /** Specifies the main function for this Flow */
-    onExecution: ActionPerformFunction<{
-        onTrigger: {
-            type: "data";
-            label: string;
-            clean: (value: unknown) => {
-                results: TTriggerPayload;
-            };
-        };
-    }, ConfigVars, {
-        [Key in keyof ComponentRegistry]: ComponentRegistry[Key]["actions"];
-    }, false, ActionPerformReturn<false, unknown>>;
+    onExecution: FlowOnExecution<TTriggerPayload>;
 }
 /** Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration. */
 export type PreprocessFlowConfig = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "9.0.6",
+  "version": "9.1.0",
   "description": "Utility library for building Prismatic components",
   "keywords": ["prismatic"],
   "main": "dist/index.js",