@voiceflow/base-types 2.42.0 → 2.42.1

package/build/common/models/base/port.d.ts

@@ -9,40 +9,15 @@ export declare enum PortType {
 }
 export interface BasePort {
     id: string;
+    type: string | PortType;
     target: Nullable<string>;
-    /**
-     * @deprecated this will now be the refID value when the refType is 'builtin'
-     */
-    type?: string | PortType;
 }
-export declare enum ReferenceType {
-    /**
-     * describes a port that is not affected by step reorder operations
-     */
-    PERSISTENT = "persistent",
-    /**
-     * describes a port of a pre-defined type (next, no-match, no-reply, etc.)
-     */
-    BUILTIN = "builtin"
+export interface BaseStepPorts<Builtin extends Partial<Record<PortType, BasePort>>, Dynamic extends BasePort[] = BasePort[], ByKey extends Partial<Record<string, BasePort>> = Partial<Record<string, BasePort>>> {
+    builtIn: Builtin;
+    dynamic: Dynamic;
+    byKey: ByKey;
 }
-export interface ReferenceMixin {
-    refType: ReferenceType;
-    refID: string;
-}
-export interface PersistentReference extends ReferenceMixin {
-    refType: ReferenceType.PERSISTENT;
-}
-export interface BuiltinReference extends ReferenceMixin {
-    refType: ReferenceType.BUILTIN;
-    refID: PortType;
-}
-export declare type BaseReference = PersistentReference | BuiltinReference;
-export declare type BaseReferencePort = BasePort & BaseReference;
-export interface BaseStepPorts<_Typed extends Partial<Record<PortType, BasePort>>, Dynamic extends BasePort = BasePort, Reference extends BaseReferencePort = BaseReferencePort> {
-    dynamic: Dynamic[];
-    byRef: Reference[];
-}
-export interface AnyBaseStepPorts extends BaseStepPorts<Partial<Record<PortType, BasePort>>, BasePort, BaseReferencePort> {
+export interface AnyBaseStepPorts extends BaseStepPorts<Record<string, BasePort>, BasePort[]> {
 }
 export interface BuiltInNextPort {
     [PortType.NEXT]: BasePort;
@@ -60,15 +35,15 @@ export interface BuiltInNextFailPorts extends BuiltInNextPort, BuiltInFailPort {
 }
 export interface BuiltInNoMatchNoReplyPorts extends BuiltInNoMatchPort, BuiltInNoReplyPort {
 }
-export interface EmptyStepPorts extends BaseStepPorts<EmptyObject> {
+export interface EmptyStepPorts extends BaseStepPorts<EmptyObject, []> {
 }
-export interface NextStepPorts extends BaseStepPorts<BuiltInNextPort> {
+export interface NextStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<BuiltInNextPort, Dynamic> {
 }
-export interface SuccessFailStepPorts extends BaseStepPorts<BuiltInNextFailPorts> {
+export interface SuccessFailStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<BuiltInNextFailPorts, Dynamic> {
 }
-export interface DynamicOnlyStepPorts extends BaseStepPorts<EmptyObject> {
+export interface DynamicOnlyStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<EmptyObject, Dynamic> {
 }
-export interface NoMatchNoReplyStepPorts extends BaseStepPorts<BuiltInNoMatchNoReplyPorts> {
+export interface NoMatchNoReplyStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<BuiltInNoMatchNoReplyPorts, Dynamic> {
 }
 /**
  * @deprecated

package/build/common/models/base/port.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReferenceType = exports.PortType = void 0;
+exports.PortType = void 0;
 var PortType;
 (function (PortType) {
     PortType["FAIL"] = "fail";
@@ -10,19 +10,3 @@ var PortType;
     PortType["NO_MATCH"] = "else";
     PortType["PREVIOUS"] = "previous";
 })(PortType = exports.PortType || (exports.PortType = {}));
-var ReferenceType;
-(function (ReferenceType) {
-    /**
-     * describes a port that is not affected by step reorder operations
-     */
-    ReferenceType["PERSISTENT"] = "persistent";
-    /**
-     * describes a port of a pre-defined type (next, no-match, no-reply, etc.)
-     */
-    ReferenceType["BUILTIN"] = "builtin";
-    /**
-     * eventually we can introduce this alongside a portsV3 structure that is
-     * just an array of BaseReferencePorts
-     */
-    // DYNAMIC = 'dynamic'
-})(ReferenceType = exports.ReferenceType || (exports.ReferenceType = {}));

package/build/common/node/_v1.d.ts

@@ -12,7 +12,7 @@ export interface StepPort<Event = BaseEvent> extends BasePort {
         event?: Event;
     };
 }
-export interface StepPorts<Event> extends BaseStepPorts<{}, StepPort<Event>> {
+export interface StepPorts<Event> extends BaseStepPorts<Record<string, StepPort<Event>>, StepPort<Event>[]> {
 }
 export interface Step<Payload = unknown, Event = BaseEvent> extends BaseStep<StepData<Payload>, StepPorts<Event>, BasePortList<StepPort<Event>>> {
     type: string;

package/build/common/node/api.d.ts

@@ -41,7 +41,7 @@ export interface StepData {
     selectedAction: APIActionType;
     selectedIntegration: IntegrationType.CUSTOM_API;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface NodeData extends NodeSuccessFailID {
     action_data: {

package/build/common/node/capture.d.ts

@@ -10,7 +10,7 @@ export interface StepData extends BaseNoReplyStepData {
 export interface StepBuiltInPorts extends BuiltInNextPort, BuiltInNoReplyPort {
 }
 /** @deprecated */
-export interface StepPorts extends BaseStepPorts<StepBuiltInPorts> {
+export interface StepPorts extends BaseStepPorts<StepBuiltInPorts, []> {
 }
 /** @deprecated */
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {

package/build/common/node/captureV2.d.ts

@@ -21,7 +21,7 @@ export interface StepData extends BaseCaptureData {
 }
 export interface StepBuiltInPorts extends BuiltInNextPort, BuiltInNoMatchNoReplyPorts {
 }
-export interface StepPorts extends BaseStepPorts<StepBuiltInPorts> {
+export interface StepPorts extends BaseStepPorts<StepBuiltInPorts, []> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.CAPTURE_V2;

package/build/common/node/carousel.d.ts

@@ -19,7 +19,7 @@ export interface CarouselCard<B = CarouselButton> extends DataID {
 }
 export interface StepBuiltInPorts extends BuiltInNextPort, BuiltInNoMatchNoReplyPorts {
 }
-export interface StepPorts extends BaseStepPorts<StepBuiltInPorts> {
+export interface StepPorts extends BaseStepPorts<StepBuiltInPorts, []> {
 }
 export interface StepData extends BaseNoMatchStepData, BaseNoReplyStepData {
     layout: CarouselLayout;

package/build/common/node/code.d.ts

@@ -3,7 +3,7 @@ import { BaseNode, BaseStep, NodeSuccessFailID, SuccessFailStepPorts } from './u
 export interface StepData {
     code: string;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.CODE;

package/build/common/node/googleSheets.d.ts

@@ -33,7 +33,7 @@ export interface StepData {
     selectedAction: Nullable<GoogleSheetsActionType>;
     selectedIntegration: IntegrationType.GOOGLE_SHEETS;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.GOOGLE_SHEETS;

package/build/common/node/prompt.d.ts

@@ -6,7 +6,7 @@ export interface StepData extends BaseNoReplyStepData, BaseNoMatchStepData {
      */
     noMatches?: BaseStepNoMatch;
 }
-export interface StepPorts extends NoMatchNoReplyStepPorts {
+export interface StepPorts extends NoMatchNoReplyStepPorts<[]> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.PROMPT;

package/build/common/node/stream.d.ts

@@ -21,7 +21,7 @@ export interface StepDefaultBuiltPorts extends StepBaseBuiltInPorts {
     [PortType.PAUSE]?: BasePort;
     [PortType.PREVIOUS]?: BasePort;
 }
-export interface StepPorts<BuiltInPorts extends StepBaseBuiltInPorts = StepDefaultBuiltPorts> extends BaseStepPorts<BuiltInPorts> {
+export interface StepPorts<BuiltInPorts extends StepBaseBuiltInPorts = StepDefaultBuiltPorts> extends BaseStepPorts<BuiltInPorts, []> {
 }
 export interface Step<Data = StepData, Ports = StepPorts> extends BaseStep<Data, Ports> {
     type: NodeType.STREAM;

package/build/common/node/zapier.d.ts

@@ -9,7 +9,7 @@ export interface StepData {
     selectedAction: ZapierActionType;
     selectedIntegration: IntegrationType.ZAPIER;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface ActionData {
     user?: IntegrationUser;

package/build/esm/models/base/port.d.ts

@@ -9,40 +9,15 @@ export declare enum PortType {
 }
 export interface BasePort {
     id: string;
+    type: string | PortType;
     target: Nullable<string>;
-    /**
-     * @deprecated this will now be the refID value when the refType is 'builtin'
-     */
-    type?: string | PortType;
 }
-export declare enum ReferenceType {
-    /**
-     * describes a port that is not affected by step reorder operations
-     */
-    PERSISTENT = "persistent",
-    /**
-     * describes a port of a pre-defined type (next, no-match, no-reply, etc.)
-     */
-    BUILTIN = "builtin"
+export interface BaseStepPorts<Builtin extends Partial<Record<PortType, BasePort>>, Dynamic extends BasePort[] = BasePort[], ByKey extends Partial<Record<string, BasePort>> = Partial<Record<string, BasePort>>> {
+    builtIn: Builtin;
+    dynamic: Dynamic;
+    byKey: ByKey;
 }
-export interface ReferenceMixin {
-    refType: ReferenceType;
-    refID: string;
-}
-export interface PersistentReference extends ReferenceMixin {
-    refType: ReferenceType.PERSISTENT;
-}
-export interface BuiltinReference extends ReferenceMixin {
-    refType: ReferenceType.BUILTIN;
-    refID: PortType;
-}
-export declare type BaseReference = PersistentReference | BuiltinReference;
-export declare type BaseReferencePort = BasePort & BaseReference;
-export interface BaseStepPorts<_Typed extends Partial<Record<PortType, BasePort>>, Dynamic extends BasePort = BasePort, Reference extends BaseReferencePort = BaseReferencePort> {
-    dynamic: Dynamic[];
-    byRef: Reference[];
-}
-export interface AnyBaseStepPorts extends BaseStepPorts<Partial<Record<PortType, BasePort>>, BasePort, BaseReferencePort> {
+export interface AnyBaseStepPorts extends BaseStepPorts<Record<string, BasePort>, BasePort[]> {
 }
 export interface BuiltInNextPort {
     [PortType.NEXT]: BasePort;
@@ -60,15 +35,15 @@ export interface BuiltInNextFailPorts extends BuiltInNextPort, BuiltInFailPort {
 }
 export interface BuiltInNoMatchNoReplyPorts extends BuiltInNoMatchPort, BuiltInNoReplyPort {
 }
-export interface EmptyStepPorts extends BaseStepPorts<EmptyObject> {
+export interface EmptyStepPorts extends BaseStepPorts<EmptyObject, []> {
 }
-export interface NextStepPorts extends BaseStepPorts<BuiltInNextPort> {
+export interface NextStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<BuiltInNextPort, Dynamic> {
 }
-export interface SuccessFailStepPorts extends BaseStepPorts<BuiltInNextFailPorts> {
+export interface SuccessFailStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<BuiltInNextFailPorts, Dynamic> {
 }
-export interface DynamicOnlyStepPorts extends BaseStepPorts<EmptyObject> {
+export interface DynamicOnlyStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<EmptyObject, Dynamic> {
 }
-export interface NoMatchNoReplyStepPorts extends BaseStepPorts<BuiltInNoMatchNoReplyPorts> {
+export interface NoMatchNoReplyStepPorts<Dynamic extends BasePort[] = BasePort[]> extends BaseStepPorts<BuiltInNoMatchNoReplyPorts, Dynamic> {
 }
 /**
  * @deprecated

package/build/esm/models/base/port.js

@@ -7,19 +7,3 @@ export var PortType;
     PortType["NO_MATCH"] = "else";
     PortType["PREVIOUS"] = "previous";
 })(PortType || (PortType = {}));
-export var ReferenceType;
-(function (ReferenceType) {
-    /**
-     * describes a port that is not affected by step reorder operations
-     */
-    ReferenceType["PERSISTENT"] = "persistent";
-    /**
-     * describes a port of a pre-defined type (next, no-match, no-reply, etc.)
-     */
-    ReferenceType["BUILTIN"] = "builtin";
-    /**
-     * eventually we can introduce this alongside a portsV3 structure that is
-     * just an array of BaseReferencePorts
-     */
-    // DYNAMIC = 'dynamic'
-})(ReferenceType || (ReferenceType = {}));

package/build/esm/node/_v1.d.ts

@@ -12,7 +12,7 @@ export interface StepPort<Event = BaseEvent> extends BasePort {
         event?: Event;
     };
 }
-export interface StepPorts<Event> extends BaseStepPorts<{}, StepPort<Event>> {
+export interface StepPorts<Event> extends BaseStepPorts<Record<string, StepPort<Event>>, StepPort<Event>[]> {
 }
 export interface Step<Payload = unknown, Event = BaseEvent> extends BaseStep<StepData<Payload>, StepPorts<Event>, BasePortList<StepPort<Event>>> {
     type: string;

package/build/esm/node/api.d.ts

@@ -41,7 +41,7 @@ export interface StepData {
     selectedAction: APIActionType;
     selectedIntegration: IntegrationType.CUSTOM_API;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface NodeData extends NodeSuccessFailID {
     action_data: {

package/build/esm/node/capture.d.ts

@@ -10,7 +10,7 @@ export interface StepData extends BaseNoReplyStepData {
 export interface StepBuiltInPorts extends BuiltInNextPort, BuiltInNoReplyPort {
 }
 /** @deprecated */
-export interface StepPorts extends BaseStepPorts<StepBuiltInPorts> {
+export interface StepPorts extends BaseStepPorts<StepBuiltInPorts, []> {
 }
 /** @deprecated */
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {

package/build/esm/node/captureV2.d.ts

@@ -21,7 +21,7 @@ export interface StepData extends BaseCaptureData {
 }
 export interface StepBuiltInPorts extends BuiltInNextPort, BuiltInNoMatchNoReplyPorts {
 }
-export interface StepPorts extends BaseStepPorts<StepBuiltInPorts> {
+export interface StepPorts extends BaseStepPorts<StepBuiltInPorts, []> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.CAPTURE_V2;

package/build/esm/node/carousel.d.ts

@@ -19,7 +19,7 @@ export interface CarouselCard<B = CarouselButton> extends DataID {
 }
 export interface StepBuiltInPorts extends BuiltInNextPort, BuiltInNoMatchNoReplyPorts {
 }
-export interface StepPorts extends BaseStepPorts<StepBuiltInPorts> {
+export interface StepPorts extends BaseStepPorts<StepBuiltInPorts, []> {
 }
 export interface StepData extends BaseNoMatchStepData, BaseNoReplyStepData {
     layout: CarouselLayout;

package/build/esm/node/code.d.ts

@@ -3,7 +3,7 @@ import { BaseNode, BaseStep, NodeSuccessFailID, SuccessFailStepPorts } from './u
 export interface StepData {
     code: string;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.CODE;

package/build/esm/node/googleSheets.d.ts

@@ -33,7 +33,7 @@ export interface StepData {
     selectedAction: Nullable<GoogleSheetsActionType>;
     selectedIntegration: IntegrationType.GOOGLE_SHEETS;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.GOOGLE_SHEETS;

package/build/esm/node/prompt.d.ts

@@ -6,7 +6,7 @@ export interface StepData extends BaseNoReplyStepData, BaseNoMatchStepData {
      */
     noMatches?: BaseStepNoMatch;
 }
-export interface StepPorts extends NoMatchNoReplyStepPorts {
+export interface StepPorts extends NoMatchNoReplyStepPorts<[]> {
 }
 export interface Step<Data = StepData> extends BaseStep<Data, StepPorts> {
     type: NodeType.PROMPT;

package/build/esm/node/stream.d.ts

@@ -21,7 +21,7 @@ export interface StepDefaultBuiltPorts extends StepBaseBuiltInPorts {
     [PortType.PAUSE]?: BasePort;
     [PortType.PREVIOUS]?: BasePort;
 }
-export interface StepPorts<BuiltInPorts extends StepBaseBuiltInPorts = StepDefaultBuiltPorts> extends BaseStepPorts<BuiltInPorts> {
+export interface StepPorts<BuiltInPorts extends StepBaseBuiltInPorts = StepDefaultBuiltPorts> extends BaseStepPorts<BuiltInPorts, []> {
 }
 export interface Step<Data = StepData, Ports = StepPorts> extends BaseStep<Data, Ports> {
     type: NodeType.STREAM;

package/build/esm/node/zapier.d.ts

@@ -9,7 +9,7 @@ export interface StepData {
     selectedAction: ZapierActionType;
     selectedIntegration: IntegrationType.ZAPIER;
 }
-export interface StepPorts extends SuccessFailStepPorts {
+export interface StepPorts extends SuccessFailStepPorts<[]> {
 }
 export interface ActionData {
     user?: IntegrationUser;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@voiceflow/base-types",
   "description": "Voiceflow base project types",
-  "version": "2.42.0",
+  "version": "2.42.1",
   "author": "Voiceflow",
   "bugs": {
     "url": "https://github.com/voiceflow/libs/issues"
@@ -43,5 +43,5 @@
     "test:smoke": "exit 0",
     "test:unit": "exit 0"
   },
-  "gitHead": "73bc5adcfc124c2c6925cf4c478ff34a1141ce78"
+  "gitHead": "f57624bb299bcf11ad01cd8588d1fcd2e77dbd7e"
 }