@prismatic-io/spectral 8.1.0-preview1 → 8.1.0-preview3

package/dist/index.d.ts

@@ -14,21 +14,28 @@ import { convertIntegration } from "./serverTypes/convertIntegration";
  * @param definition An IntegrationDefinition type object.
  * @returns This function returns an integration object that has the shape the Prismatic API expects.
  */
-export declare const integration: <TConfigPages extends ConfigPages = ConfigPages, TComponents extends ComponentSelector<any> = ComponentSelector<any>>(definition: IntegrationDefinition<TConfigPages, TComponents>) => ReturnType<typeof convertIntegration>;
+export declare const integration: <TComponents extends ComponentSelector<any> = ComponentSelector<any>, TConfigPages extends ConfigPages<TComponents> = ConfigPages<TComponents>>(definition: IntegrationDefinition<TConfigPages, TComponents>) => ReturnType<typeof convertIntegration>;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-flows.
  * @param definition A Flow type object.
  * @returns This function returns a flow object that has the shape the Prismatic API expects.
  */
-export declare const flow: <TConfigPages extends ConfigPages = ConfigPages, TComponents extends ComponentSelector<any> = ComponentSelector<any>, TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TConfigPages, TComponents, TTriggerPayload> = Flow<TConfigPages, TComponents, TTriggerPayload>>(definition: T) => T;
+export declare const flow: <TConfigPages extends ConfigPages<any> = ConfigPages<any>, TComponents extends ComponentSelector<any> = ComponentSelector<any>, TTriggerPayload extends TriggerPayload = TriggerPayload, T extends Flow<TConfigPages, TComponents, TTriggerPayload> = Flow<TConfigPages, TComponents, TTriggerPayload>>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-pages.
  * @param definition A Config Page type object.
  * @returns This function returns a config page object that has the shape the Prismatic API expects.
  */
-export declare const configPage: <TComponents extends ComponentSelector<any> = ComponentSelector<any>, T extends ConfigPage<TComponents> = ConfigPage<TComponents>>(definition: T) => T;
+export declare const configPage: <T extends ConfigPage<any> = ConfigPage<any>>(definition: T) => T;
+/**
+ * @returns Helper utility to create component references.
+ */
+export declare const reference: <TComponents extends ComponentSelector<any>>() => {
+    connection: <T extends ConnectionConfigVar<TComponents>>(definition: T) => T;
+    dataSource: <T_1 extends DataSourceConfigVar<TComponents>>(definition: T_1) => T_1;
+};
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
@@ -42,14 +49,14 @@ export declare const configVar: <T extends StandardConfigVar | ScheduleConfigVar
  * @param definition A Data Source Config Var type object.
  * @returns This function returns a data source config var object that has the shape the Prismatic API expects.
  */
-export declare const dataSourceConfigVar: <TComponents extends ComponentSelector<any> = ComponentSelector<any>, T extends DataSourceConfigVar<TComponents> = DataSourceConfigVar<TComponents>>(definition: T) => T;
+export declare const dataSourceConfigVar: <T extends DataSourceConfigVar<any> = DataSourceConfigVar<any>>(definition: T) => T;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.
  * @param definition A 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 connectionConfigVar: <TComponents extends ComponentSelector<any> = ComponentSelector<any>, T extends ConnectionConfigVar<TComponents> = ConnectionConfigVar<TComponents>>(definition: T) => T;
+export declare const connectionConfigVar: <T extends ConnectionConfigVar<any> = ConnectionConfigVar<any>>(definition: T) => T;
 /**
  * This function creates a component object that can be
  * imported into the Prismatic API. For information on using

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.oauth2Connection = exports.onPremiseConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.configPage = exports.flow = exports.integration = void 0;
+exports.testing = exports.util = exports.oauth2Connection = exports.onPremiseConnection = exports.connection = exports.input = exports.dataSource = exports.trigger = exports.action = exports.component = exports.connectionConfigVar = exports.dataSourceConfigVar = exports.configVar = exports.reference = exports.configPage = exports.flow = exports.integration = void 0;
 const convert_1 = require("./serverTypes/convert");
 const convertIntegration_1 = require("./serverTypes/convertIntegration");
 /**
@@ -58,6 +58,14 @@ exports.flow = flow;
  */
 const configPage = (definition) => definition;
 exports.configPage = configPage;
+/**
+ * @returns Helper utility to create component references.
+ */
+const reference = () => ({
+    connection: (definition) => definition,
+    dataSource: (definition) => definition,
+});
+exports.reference = reference;
 /**
  * For information on writing Code Native Integrations, see
  * https://prismatic.io/docs/code-native-integrations/#adding-config-vars.

package/dist/serverTypes/convertIntegration.d.ts

@@ -1,3 +1,3 @@
 import { IntegrationDefinition, ConfigPages, ComponentSelector } from "../types";
 import { Component as ServerComponent } from ".";
-export declare const convertIntegration: (definition: IntegrationDefinition<ConfigPages, ComponentSelector<any>>) => ServerComponent;
+export declare const convertIntegration: (definition: IntegrationDefinition<ConfigPages<any>, ComponentSelector<any>>) => ServerComponent;

package/dist/testing.d.ts

@@ -63,7 +63,11 @@ declare type ToTestValues<TConfigVars extends ConfigVarResultCollection> = {
  * Invokes specified Flow of a Code Native Integration using supplied params.
  * Runs the Trigger and then the Action function and returns the result of the Action.
  */
-export declare const invokeFlow: <TConfigPages extends ConfigPages, TConfigVars extends ConfigVarResultCollection = import("./types/utils").Prettify<{ [Key in keyof (TConfigPages extends ConfigPages ? import("./types/utils").UnionToIntersection<import("./types/utils").ValueOf<TConfigPages>["elements"]> : never) as Key extends string ? Key : never]: import("./types").ElementToRuntimeType<(TConfigPages extends ConfigPages ? import("./types/utils").UnionToIntersection<import("./types/utils").ValueOf<TConfigPages>["elements"]> : never)[Key]>; }>, TConfigVarValues extends TestConfigVarValues = ToTestValues<TConfigVars>>(flow: Flow<TConfigPages, ComponentSelector<any>, import("./types").TriggerPayload>, configVars: TConfigVarValues, context?: Partial<ActionContext<TConfigVars>> | undefined, payload?: TriggerPayload | undefined) => Promise<InvokeReturn<InvokeActionPerformReturn<false, unknown>>>;
+export declare const invokeFlow: <TConfigPages extends ConfigPages<any>, TConfigVars extends ConfigVarResultCollection = import("./types/utils").Prettify<{ [Key in keyof import("./types").GetElements<TConfigPages> as Key extends string ? Key : never]: import("./types").ElementToRuntimeType<import("./types").GetElements<TConfigPages>[Key]>; }>, TConfigVarValues extends TestConfigVarValues = ToTestValues<TConfigVars>>(flow: Flow<TConfigPages, ComponentSelector<any>, import("./types").TriggerPayload>, { configVars, context, payload, }?: {
+    configVars?: TConfigVarValues | undefined;
+    context?: Partial<ActionContext<TConfigVars>> | undefined;
+    payload?: Partial<TriggerPayload> | undefined;
+}) => Promise<InvokeReturn<InvokeActionPerformReturn<false, unknown>>>;
 export declare class ComponentTestHarness<TComponent extends Component> {
     component: TComponent;
     constructor(component: TComponent);

package/dist/testing.js

@@ -178,7 +178,7 @@ const invokeDataSource = ({ perform }, params, context) => __awaiter(void 0, voi
 });
 exports.invokeDataSource = invokeDataSource;
 const createConfigVars = (values) => {
-    return Object.entries(values).reduce((result, [key, value]) => {
+    return Object.entries(values !== null && values !== void 0 ? values : {}).reduce((result, [key, value]) => {
         // Connection
         if (typeof value === "object" && "fields" in value) {
             return Object.assign(Object.assign({}, result), { [key]: Object.assign(Object.assign({}, value), { key, configVarKey: "" }) });
@@ -190,12 +190,12 @@ const createConfigVars = (values) => {
  * Invokes specified Flow of a Code Native Integration using supplied params.
  * Runs the Trigger and then the Action function and returns the result of the Action.
  */
-const invokeFlow = (flow, configVars, context, payload) => __awaiter(void 0, void 0, void 0, function* () {
+const invokeFlow = (flow, { configVars, context, payload, } = {}) => __awaiter(void 0, void 0, void 0, function* () {
     const realizedConfigVars = createConfigVars(configVars);
     const realizedContext = createActionContext(Object.assign(Object.assign({}, context), { configVars: realizedConfigVars }));
     const realizedPayload = Object.assign(Object.assign({}, (0, exports.defaultTriggerPayload)()), payload);
     const params = {
-        onTrigger: { results: null },
+        onTrigger: { results: realizedPayload },
     };
     if ("onTrigger" in flow && typeof flow.onTrigger === "function") {
         const triggerResult = yield flow.onTrigger(realizedContext, realizedPayload, params);

package/dist/types/IntegrationDefinition.d.ts

@@ -1,13 +1,13 @@
 import { DataSourceDefinition, ConnectionDefinition, ActionPerformFunction, ActionPerformReturn, TriggerEventFunction, TriggerPerformFunction, Inputs, TriggerResult, DataSourceType, TriggerPayload, Connection, JSONForm, ObjectFieldMap, ObjectSelection, ConfigVarResultCollection, Schedule } from ".";
 import { Prettify, UnionToIntersection, ValueOf } from "./utils";
-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;
-declare type GetElements<TConfigPages extends ConfigPages> = TConfigPages extends ConfigPages ? UnionToIntersection<ValueOf<TConfigPages>["elements"]> : never;
-export declare type ExtractConfigVars<TConfigPages extends ConfigPages, TElements extends ConfigPage["elements"] = GetElements<TConfigPages>> = Prettify<{
+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<any>> = TElement extends ConnectionConfigVar<any> ? Connection : TElement extends DataSourceConfigVar<any> ? ToDataSourceRuntimeType<TElement["dataSourceType"]> : TElement extends ScheduleConfigVar ? Schedule : TElement extends StandardConfigVar ? string : never;
+export declare type GetElements<TConfigPages extends ConfigPages<any>> = TConfigPages extends ConfigPages<any> ? UnionToIntersection<ValueOf<TConfigPages>["elements"]> : never;
+export declare type ExtractConfigVars<TConfigPages extends ConfigPages<any>, TElements extends ConfigPage<any>["elements"] = GetElements<TConfigPages>> = Prettify<{
     [Key in keyof TElements as Key extends string ? Key : never]: ElementToRuntimeType<TElements[Key]>;
 }>;
 /** Defines attributes of a Code-Native Integration. */
-export declare type IntegrationDefinition<TConfigPages extends ConfigPages, TComponents extends ComponentSelector<any>> = {
+export declare type IntegrationDefinition<TConfigPages extends ConfigPages<TComponents>, TComponents extends ComponentSelector<any>> = {
     /** The unique name for this Integration. */
     name: string;
     /** Optional description for this Integration. */
@@ -35,7 +35,7 @@ export declare type IntegrationDefinition<TConfigPages extends ConfigPages, TCom
     configPages?: TConfigPages;
 };
 /** Defines attributes of a Flow of a Code-Native Integration. */
-export interface Flow<TConfigPages extends ConfigPages, TComponents extends ComponentSelector<any>, TTriggerPayload extends TriggerPayload = TriggerPayload> {
+export interface Flow<TConfigPages extends ConfigPages<TComponents>, TComponents extends ComponentSelector<any>, TTriggerPayload extends TriggerPayload = TriggerPayload> {
     /** The unique name for this Flow. */
     name: string;
     /** A unique, unchanging value that is used to maintain identity for the Flow even if the name changes. */
@@ -112,26 +112,26 @@ export declare type ScheduleConfigVar = BaseConfigVar & {
 declare type DataSourceDefinitionConfigVar = BaseConfigVar & Omit<DataSourceDefinition<Inputs, ConfigVarResultCollection, DataSourceType>, "display" | "inputs" | "examplePayload">;
 declare type DataSourceReferenceConfigVar<TComponents extends ComponentSelector<any>> = BaseConfigVar & {
     dataSourceType: DataSourceType;
-    dataSource: ToComponentReferences<"dataSource", TComponents, ConfigPages>;
+    dataSource: ToComponentReferences<"dataSource", TComponents, ConfigPages<TComponents>>;
 };
 /** Defines attributes of a data source Config Var. */
-export declare type DataSourceConfigVar<TComponents extends ComponentSelector<any> = ComponentSelector<any>> = DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar<TComponents>;
+export declare type DataSourceConfigVar<TComponents extends ComponentSelector<any>> = DataSourceDefinitionConfigVar | DataSourceReferenceConfigVar<TComponents>;
 declare type ConnectionDefinitionConfigVar = BaseConfigVar & Omit<ConnectionDefinition, "label" | "comments" | "key">;
 declare type ConnectionReferenceConfigVar<TComponents extends ComponentSelector<any>> = BaseConfigVar & {
     connection: ToComponentReferences<"connection", TComponents>;
 };
 /** Defines attributes of a Config Var that represents a Connection. */
-export declare type ConnectionConfigVar<TComponents extends ComponentSelector<any> = ComponentSelector<any>> = ConnectionDefinitionConfigVar | ConnectionReferenceConfigVar<TComponents>;
-export declare type ConfigVar<TComponents extends ComponentSelector<any> = ComponentSelector<any>> = StandardConfigVar | ScheduleConfigVar | DataSourceConfigVar<TComponents> | ConnectionConfigVar<TComponents>;
-export declare const isScheduleConfigVar: (cv: ConfigVar) => cv is ScheduleConfigVar;
-export declare const isDataSourceDefinitionConfigVar: (cv: ConfigVar) => cv is DataSourceDefinitionConfigVar;
-export declare const isDataSourceReferenceConfigVar: <TComponents extends ComponentSelector<any> = ComponentSelector<any>>(cv: ConfigVar<TComponents>) => cv is DataSourceReferenceConfigVar<TComponents>;
-export declare const isConnectionDefinitionConfigVar: (cv: ConfigVar) => cv is ConnectionDefinitionConfigVar;
-export declare const isConnectionReferenceConfigVar: <TComponents extends ComponentSelector<any> = ComponentSelector<any>>(cv: ConfigVar<TComponents>) => cv is ConnectionReferenceConfigVar<TComponents>;
-export declare type ConfigPageElement<TComponents extends ComponentSelector<any> = ComponentSelector<any>> = string | ConfigVar<TComponents>;
-export declare type ConfigPages = Record<string, ConfigPage>;
+export declare type ConnectionConfigVar<TComponents extends ComponentSelector<any>> = ConnectionDefinitionConfigVar | ConnectionReferenceConfigVar<TComponents>;
+export declare type ConfigVar<TComponents extends ComponentSelector<any>> = StandardConfigVar | ScheduleConfigVar | DataSourceConfigVar<TComponents> | ConnectionConfigVar<TComponents>;
+export declare const isScheduleConfigVar: (cv: ConfigVar<any>) => cv is ScheduleConfigVar;
+export declare const isDataSourceDefinitionConfigVar: (cv: ConfigVar<any>) => cv is DataSourceDefinitionConfigVar;
+export declare const isDataSourceReferenceConfigVar: <TComponents extends ComponentSelector<any>>(cv: ConfigVar<TComponents>) => cv is DataSourceReferenceConfigVar<TComponents>;
+export declare const isConnectionDefinitionConfigVar: (cv: ConfigVar<any>) => cv is ConnectionDefinitionConfigVar;
+export declare const isConnectionReferenceConfigVar: <TComponents extends ComponentSelector<any>>(cv: ConfigVar<TComponents>) => cv is ConnectionReferenceConfigVar<TComponents>;
+export declare type ConfigPageElement<TComponents extends ComponentSelector<any>> = string | ConfigVar<TComponents>;
+export declare type ConfigPages<TComponents extends ComponentSelector<any>> = Record<string, ConfigPage<TComponents>>;
 /** Defines attributes of a Config Wizard Page used when deploying an Instance of an Integration. */
-export declare type ConfigPage<TComponents extends ComponentSelector<any> = ComponentSelector<any>> = {
+export declare type ConfigPage<TComponents extends ComponentSelector<any>> = {
     /** Elements included on this Config Page. */
     elements: Record<string, ConfigPageElement<TComponents>>;
     /** Specifies an optional tagline for this Config Page. */
@@ -184,9 +184,9 @@ export declare type CodeLanguageType = "json" | "xml" | "html";
 export declare type CollectionType = "valuelist" | "keyvaluelist";
 /** Choices of component reference types. */
 export declare type ComponentSelectorType = "trigger" | "connection" | "dataSource";
-export declare type ValueReference<TValueType, TConfigPages extends ConfigPages, TConfigVarKeys = keyof ExtractConfigVars<TConfigPages>> = {
+export declare type ValueReference<TValueType, TConfigPages extends ConfigPages<any>, TConfigVarKeys = keyof ExtractConfigVars<TConfigPages>> = {
     value: TValueType;
-} | (TConfigPages extends ConfigPages ? {
+} | (TConfigPages extends ConfigPages<any> ? {
     configVar: TConfigVarKeys;
 } : never);
 export interface ComponentSelector<TValueType> {
@@ -200,14 +200,14 @@ export interface ComponentSelector<TValueType> {
         [key: string]: TValueType;
     };
 }
-export declare type ToComponentReferences<TReferenceType extends ComponentSelectorType, TSelector extends ComponentSelector<any>, TConfigPages extends ConfigPages = never> = TSelector extends ComponentSelector<infer TValueType> ? TSelector["type"] extends TReferenceType ? {
-    component: TSelector["component"];
-    key: TSelector["key"];
+export declare type ToComponentReferences<TReferenceType extends ComponentSelectorType, TComponents extends ComponentSelector<any>, TConfigPages extends ConfigPages<TComponents> = never> = TComponents extends ComponentSelector<infer TValueType> ? TComponents["type"] extends TReferenceType ? {
+    component: TComponents["component"];
+    key: TComponents["key"];
     values: {
-        [K in keyof TSelector["values"]]: ValueReference<TValueType, TConfigPages>;
+        [K in keyof TComponents["values"]]: ValueReference<TValueType, TConfigPages>;
     };
 } : never : never;
-export interface ComponentReference<TValueType, TConfigPages extends ConfigPages> {
+export interface ComponentReference<TValueType, TConfigPages extends ConfigPages<any>> {
     component: string | {
         key: string;
         isPublic: boolean;
@@ -217,5 +217,5 @@ export interface ComponentReference<TValueType, TConfigPages extends ConfigPages
         [key: string]: ValueReference<TValueType, TConfigPages>;
     };
 }
-export declare const isComponentReference: (ref: unknown) => ref is ComponentReference<any, ConfigPages>;
+export declare const isComponentReference: (ref: unknown) => ref is ComponentReference<any, ConfigPages<any>>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/spectral",
-  "version": "8.1.0-preview1",
+  "version": "8.1.0-preview3",
   "description": "Utility library for building Prismatic components",
   "keywords": [
     "prismatic"
@@ -70,7 +70,7 @@
     "jest": "29.7.0",
     "prettier": "2.6.2",
     "ts-jest": "29.1.2",
-    "tsd": "0.20.0",
+    "tsd": "0.31.0",
     "typedoc": "0.17.7",
     "typedoc-plugin-markdown": "2.4.2",
     "typedoc-plugin-remove-references": "0.0.5",