@prismatic-io/spectral 9.0.0-rc.9 → 9.0.0

package/dist/types/IntegrationDefinition.d.ts

@@ -1,47 +1,4 @@
-import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType, TriggerPayload, Connection, JSONForm, ObjectFieldMap, ObjectSelection, ConfigVarResultCollection, Schedule, CollectionDataSourceType, ComponentManifest } from ".";
-import { Prettify, UnionToIntersection } from "./utils";
-/**
- * Root ComponentRegistry type exposed for augmentation.
- *
- * The expected interface when augmenting is:
- *
- * ```ts
- * interface IntegrationDefinitionComponentRegistry {
- *   [key: string]: ComponentManifest
- * }
- * ```
- *
- */
-export interface IntegrationDefinitionComponentRegistry {
-}
-/**
- * Root ConfigPages type exposed for augmentation.
- *
- * The expected interface when augmenting is:
- *
- * ```ts
- * interface IntegrationDefinitionConfigPages {
- *   [key: string]: ConfigPage
- * }
- * ```
- *
- */
-export interface IntegrationDefinitionConfigPages {
-}
-/**
- * Root UserLevelConfigPages type exposed for augmentation.
- *
- * The expected interface when augmenting is:
- *
- * ```ts
- * interface IntegrationDefinitionUserLevelConfigPages {
- *   [key: string]: ConfigPage
- * }
- * ```
- *
- */
-export interface IntegrationDefinitionUserLevelConfigPages {
-}
+import { ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, TriggerPayload, ComponentRegistry, TriggerReference, ConfigVars, ConfigPages, UserLevelConfigPages, ValueExpression, ConfigVarExpression } from ".";
 /** Defines attributes of a Code-Native Integration. */
 export declare type IntegrationDefinition = {
     /** The unique name for this Integration. */
@@ -116,167 +73,6 @@ export interface Flow<TTriggerPayload extends TriggerPayload = TriggerPayload> {
         [Key in keyof ComponentRegistry]: ComponentRegistry[Key]["actions"];
     }, false, ActionPerformReturn<false, unknown>>;
 }
-export declare type PermissionAndVisibilityType = "customer" | "embedded" | "organization";
-/** Common attribute shared by all types of Config Vars. */
-declare 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;
-    /**
-     * 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;
-    /** Optional default value for the Config Var. */
-    defaultValue?: string;
-    /** Optional list of picklist values if the Config Var is a multi-choice selection value. */
-    pickList?: string[];
-    /** Optional value to specify the type of collection if the Config Var is multi-value. */
-    collectionType?: CollectionType;
-};
-/** Defines attributes of a standard Config Var. */
-export declare type StandardConfigVar = BaseConfigVar & {
-    /** The data type of the Config Var. */
-    dataType: Exclude<ConfigVarDataType, "schedule" | "code">;
-};
-export declare type CodeConfigVar = BaseConfigVar & {
-    /** The data type of the Config Var. */
-    dataType: "code";
-    /** Optional default value for the Config Var. */
-    defaultValue?: string;
-    /** Optional value to specify the type of language if the Config Var is a code value. */
-    codeLanguage?: CodeLanguageType;
-};
-export declare type ScheduleConfigVar = Omit<BaseConfigVar, "collectionType"> & {
-    /** The data type of the Config Var. */
-    dataType: "schedule";
-    /** Optional default value for the Config Var. */
-    defaultValue?: string;
-    /** Optional timezone for the schedule. */
-    timeZone?: string;
-};
-export declare type ComponentRegistry = keyof IntegrationDefinitionComponentRegistry extends never ? {
-    [key: string]: ComponentManifest;
-} : UnionToIntersection<keyof IntegrationDefinitionComponentRegistry extends infer TComponentKey ? TComponentKey extends keyof IntegrationDefinitionComponentRegistry ? {
-    [Key in TComponentKey]: IntegrationDefinitionComponentRegistry[TComponentKey];
-} : never : never>;
-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;
-}
-declare type ComponentReferenceType = Extract<keyof ComponentManifest, "actions" | "triggers" | "dataSources" | "connections">;
-declare type ComponentReferenceTypeValueMap<TValue, TMap extends Record<ComponentReferenceType, unknown> = {
-    actions: ValueExpression<TValue>;
-    triggers: ValueExpression<TValue> | ConfigVarExpression;
-    dataSources: ValueExpression<TValue> | ConfigVarExpression;
-    connections: (ValueExpression<TValue> | ConfigVarExpression) & ConnectionInputPermissionAndVisibility;
-}> = TMap;
-export declare type ComponentReference<TComponentReference extends {
-    component: string;
-    isPublic: boolean;
-    key: string;
-    values?: {
-        [key: string]: ValueExpression | ConfigVarExpression;
-    };
-    template?: string;
-} = {
-    component: string;
-    isPublic: boolean;
-    key: string;
-    values?: {
-        [key: string]: ValueExpression | ConfigVarExpression;
-    };
-    template?: string;
-}> = TComponentReference;
-export declare const isComponentReference: (ref: unknown) => ref is {
-    component: string;
-    isPublic: boolean;
-    key: string;
-    values?: {
-        [key: string]: ConfigVarExpression | ValueExpression<unknown>;
-    } | undefined;
-    template?: string | undefined;
-};
-declare type ComponentReferencesByType = UnionToIntersection<ComponentReferenceType extends infer TComponentReferenceType ? TComponentReferenceType extends Extract<keyof ComponentManifest, "actions" | "triggers" | "dataSources" | "connections"> ? {
-    [Key in TComponentReferenceType]: keyof ComponentRegistry extends infer TComponentKey ? TComponentKey extends keyof ComponentRegistry ? TComponentKey extends string ? TComponentReferenceType extends keyof ComponentRegistry[TComponentKey] ? keyof ComponentRegistry[TComponentKey][TComponentReferenceType] extends infer TComponentPropertyKey ? TComponentPropertyKey extends keyof ComponentRegistry[TComponentKey][TComponentReferenceType] ? TComponentPropertyKey extends string ? "perform" extends keyof ComponentRegistry[TComponentKey][TComponentReferenceType][TComponentPropertyKey] ? ComponentRegistry[TComponentKey][TComponentReferenceType][TComponentPropertyKey]["perform"] extends (...args: any[]) => any ? Parameters<ComponentRegistry[TComponentKey][TComponentReferenceType][TComponentPropertyKey]["perform"]>[0] extends infer TInputs ? ComponentReference<{
-        component: TComponentKey;
-        isPublic: ComponentRegistry[TComponentKey]["public"];
-        key: TComponentPropertyKey;
-        values: {
-            [Key in keyof TInputs]: ComponentReferenceTypeValueMap<TInputs[Key]>[TComponentReferenceType];
-        };
-    }> : never : never : never : never : never : never : never : never : never : never;
-} : never : never>;
-export declare type TriggerReference = ComponentReferencesByType["triggers"];
-export declare type ActionReference = ComponentReferencesByType["actions"];
-export declare type DataSourceReference = ComponentReferencesByType["dataSources"];
-export declare type ConnectionReference = ComponentReferencesByType["connections"];
-declare type BaseDataSourceConfigVar = ({
-    dataSourceType: CollectionDataSourceType;
-} & BaseConfigVar) | ({
-    dataSourceType: Exclude<DataSourceType, CollectionDataSourceType>;
-} & Omit<BaseConfigVar, "collectionType">);
-declare type DataSourceDefinitionConfigVar = BaseDataSourceConfigVar & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, DataSourceType>, "display" | "inputs" | "examplePayload" | "dataSourceType" | "detailDataSource">;
-export declare type DataSourceReferenceConfigVar = BaseDataSourceConfigVar & {
-    dataSource: DataSourceReference;
-};
-/** Defines attributes of a data source Config Var. */
-export declare type DataSourceConfigVar = DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar;
-declare type BaseConnectionConfigVar = Omit<BaseConfigVar, "collectionType"> & {
-    dataType: "connection";
-};
-declare type ConnectionDefinitionConfigVar = BaseConnectionConfigVar & Omit<ConnectionDefinition, "label" | "comments" | "key">;
-declare type ConnectionReferenceConfigVar = BaseConnectionConfigVar & {
-    connection: ConnectionReference & {
-        template?: string;
-    };
-};
-/** Defines attributes of a Config Var that represents a Connection. */
-export declare type ConnectionConfigVar = ConnectionDefinitionConfigVar | ConnectionReferenceConfigVar;
-export declare type ConfigVar = StandardConfigVar | CodeConfigVar | ScheduleConfigVar | DataSourceConfigVar | ConnectionConfigVar;
-export declare const isCodeConfigVar: (cv: ConfigVar) => cv is CodeConfigVar;
-export declare const isScheduleConfigVar: (cv: ConfigVar) => cv is ScheduleConfigVar;
-export declare const isDataSourceDefinitionConfigVar: (cv: ConfigVar) => cv is DataSourceDefinitionConfigVar;
-export declare const isDataSourceReferenceConfigVar: (cv: ConfigVar) => cv is DataSourceReferenceConfigVar;
-export declare const isConnectionDefinitionConfigVar: (cv: ConfigVar) => cv is ConnectionDefinitionConfigVar;
-export declare const isConnectionReferenceConfigVar: (cv: ConfigVar) => cv is ConnectionReferenceConfigVar;
-export declare type ConfigPageElement = string | ConfigVar;
-declare type CreateConfigPages<TIntegrationDefinitionConfigPages> = keyof TIntegrationDefinitionConfigPages extends never ? {
-    [key: string]: ConfigPage;
-} : 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 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;
-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. */
-export interface ConfigPage {
-    /** Elements included on this Config Page. */
-    elements: Record<string, ConfigPageElement>;
-    /** Specifies an optional tagline for this Config Page. */
-    tagline?: string;
-}
 /** Defines attributes of a Preprocess Flow Configuration used by a Flow of an Integration. */
 export declare type PreprocessFlowConfig = {
     /** Name of the field in the data payload returned by the Preprocess Flow to use for a Flow Name. */
@@ -316,18 +112,3 @@ export declare type EndpointType = "flow_specific" | "instance_specific" | "shar
 export declare type EndpointSecurityType = "unsecured" | "customer_optional" | "customer_required" | "organization";
 /** Choices of Step Error Handlers that define the behavior when a step error occurs. */
 export declare type StepErrorHandlerType = "fail" | "ignore" | "retry";
-/** Supported data types for Config Vars. */
-export declare type ConfigVarDataType = "string" | "date" | "timestamp" | "picklist" | "schedule" | "code" | "boolean" | "number";
-/** Choices of programming languages that may be used for Config Var code values. */
-export declare type CodeLanguageType = "json" | "xml" | "html";
-/** Choices of collection types for multi-value Config Vars. */
-export declare type CollectionType = "valuelist" | "keyvaluelist";
-/** Choices of component reference types. */
-export declare type ComponentSelectorType = "trigger" | "connection" | "dataSource";
-export declare type ConfigVarExpression = {
-    configVar: string;
-};
-export declare type ValueExpression<TValueType = unknown> = {
-    value: TValueType;
-};
-export {};

package/dist/types/IntegrationDefinition.js

@@ -1,19 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isConnectionReferenceConfigVar = exports.isConnectionDefinitionConfigVar = exports.isDataSourceReferenceConfigVar = exports.isDataSourceDefinitionConfigVar = exports.isScheduleConfigVar = exports.isCodeConfigVar = exports.isComponentReference = void 0;
-const isComponentReference = (ref) => typeof ref === "object" && ref !== null && "key" in ref && "component" in ref;
-exports.isComponentReference = isComponentReference;
-const isCodeConfigVar = (cv) => "dataType" in cv && cv.dataType === "code";
-exports.isCodeConfigVar = isCodeConfigVar;
-const isScheduleConfigVar = (cv) => "dataType" in cv && cv.dataType === "schedule";
-exports.isScheduleConfigVar = isScheduleConfigVar;
-const isDataSourceDefinitionConfigVar = (cv) => "dataSourceType" in cv && "perform" in cv && typeof cv.perform === "function";
-exports.isDataSourceDefinitionConfigVar = isDataSourceDefinitionConfigVar;
-const isDataSourceReferenceConfigVar = (cv) => "dataSourceType" in cv &&
-    "dataSource" in cv &&
-    (0, exports.isComponentReference)(cv.dataSource);
-exports.isDataSourceReferenceConfigVar = isDataSourceReferenceConfigVar;
-const isConnectionDefinitionConfigVar = (cv) => "dataType" in cv && cv.dataType === "connection" && "inputs" in cv;
-exports.isConnectionDefinitionConfigVar = isConnectionDefinitionConfigVar;
-const isConnectionReferenceConfigVar = (cv) => "connection" in cv && (0, exports.isComponentReference)(cv.connection);
-exports.isConnectionReferenceConfigVar = isConnectionReferenceConfigVar;

package/dist/types/index.d.ts

@@ -4,6 +4,9 @@
  */
 export * from "./ActionDefinition";
 export * from "./ComponentDefinition";
+export * from "./ComponentRegistry";
+export * from "./ConfigPages";
+export * from "./ConfigVars";
 export * from "./ConnectionDefinition";
 export * from "./Inputs";
 export * from "./ActionPerformReturn";

package/dist/types/index.js

@@ -33,6 +33,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serverTypes = void 0;
 __exportStar(require("./ActionDefinition"), exports);
 __exportStar(require("./ComponentDefinition"), exports);
+__exportStar(require("./ComponentRegistry"), exports);
+__exportStar(require("./ConfigPages"), exports);
+__exportStar(require("./ConfigVars"), exports);
 __exportStar(require("./ConnectionDefinition"), exports);
 __exportStar(require("./Inputs"), exports);
 __exportStar(require("./ActionPerformReturn"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "9.0.0-rc.9",
+  "version": "9.0.0",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -52,6 +52,7 @@
     "jest-mock": "29.7.0",
     "lodash": "4.17.21",
     "object-sizeof": "^2.6.4",
+    "prettier": "2.6.2",
     "safe-stable-stringify": "2.3.1",
     "serialize-error": "8.1.0",
     "url-join": "5.0.0",
@@ -65,6 +66,7 @@
     "@types/jest": "29.5.12",
     "@types/lodash": "4.17.0",
     "@types/node": "14.14.35",
+    "@types/prettier": "2.6.2",
     "@types/sax": "1.2.4",
     "@types/url-join": "4.0.1",
     "@types/uuid": "8.3.4",
@@ -78,7 +80,6 @@
     "eslint-plugin-prettier": "4.0.0",
     "fast-check": "2.16.0",
     "jest": "29.7.0",
-    "prettier": "2.6.2",
     "ts-jest": "29.1.2",
     "typedoc": "0.17.7",
     "typedoc-plugin-markdown": "2.4.2",