@voiceflow/base-types 2.17.3 → 2.19.0

package/build/common/models/apiKey.d.ts

@@ -1,9 +1,17 @@
 import { AnyRecord } from "../types";
+export declare const API_KEY_PREFIX = "VF.";
+export declare enum APIKeySubType {
+    Workspace = "WS",
+    DialogManager = "DM"
+}
+export declare const isWorkspaceAPIKey: (key: unknown) => key is string;
+export declare const isDialogManagerAPIKey: (key: unknown) => key is string;
 export interface Model<Data extends AnyRecord = AnyRecord> {
     _id: string;
     creatorID: number;
     projectID?: string;
     workspaceID: string;
+    type: APIKeySubType;
     name: string;
     data?: Data;
     scopes: string[];

package/build/common/models/apiKey.js

@@ -1,2 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDialogManagerAPIKey = exports.isWorkspaceAPIKey = exports.APIKeySubType = exports.API_KEY_PREFIX = void 0;
+exports.API_KEY_PREFIX = 'VF.';
+var APIKeySubType;
+(function (APIKeySubType) {
+    APIKeySubType["Workspace"] = "WS";
+    APIKeySubType["DialogManager"] = "DM";
+})(APIKeySubType = exports.APIKeySubType || (exports.APIKeySubType = {}));
+const buildAPIKeyGuard = (type) => (key) => typeof key === 'string' && key.startsWith(`${exports.API_KEY_PREFIX}${type}.`);
+exports.isWorkspaceAPIKey = buildAPIKeyGuard(APIKeySubType.Workspace);
+exports.isDialogManagerAPIKey = buildAPIKeyGuard(APIKeySubType.DialogManager);

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

@@ -2,5 +2,6 @@ export * from './command';
 export * from './common';
 export * from './intent';
 export * from './node';
+export * from './note';
 export * from './prototype';
 export * from './slot';

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

@@ -14,5 +14,6 @@ __exportStar(require("./command"), exports);
 __exportStar(require("./common"), exports);
 __exportStar(require("./intent"), exports);
 __exportStar(require("./node"), exports);
+__exportStar(require("./note"), exports);
 __exportStar(require("./prototype"), exports);
 __exportStar(require("./slot"), exports);

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

@@ -20,4 +20,5 @@ export interface Intent {
     name: string;
     slots?: IntentSlot[];
     inputs: IntentInput[];
+    noteID?: string;
 }

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

@@ -0,0 +1,19 @@
+import { AnyRecord } from "../../types";
+export declare enum NoteType {
+    INTENT = "INTENT"
+}
+export interface BaseNote {
+    id: string;
+    type: NoteType;
+    text: string;
+    meta?: AnyRecord;
+    mentions: number[];
+}
+export interface IntentNoteMeta {
+    intentID: string;
+}
+export interface IntentNote extends BaseNote {
+    type: NoteType.INTENT;
+    meta: IntentNoteMeta;
+}
+export declare type AnyNote = IntentNote;

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteType = void 0;
+var NoteType;
+(function (NoteType) {
+    NoteType["INTENT"] = "INTENT";
+})(NoteType = exports.NoteType || (exports.NoteType = {}));

package/build/common/models/version/index.d.ts

@@ -1,5 +1,5 @@
 import { AnyRecord } from "../../types";
-import { BaseCommand, Intent, Slot, Variable } from '../base';
+import { BaseCommand, BaseNote, Intent, Slot, Variable } from '../base';
 import { Prototype } from './prototype';
 export * from './prototype';
 export interface PlatformData<Settings extends AnyRecord = AnyRecord, Publishing extends AnyRecord = AnyRecord> {
@@ -35,6 +35,7 @@ export interface Model<_PlatformData extends PlatformData, Command extends BaseC
     projectID: string;
     rootDiagramID: string;
     name: string;
+    notes?: Record<string, BaseNote>;
     topics?: FolderItem[];
     folders?: Record<string, Folder>;
     variables: Variable[];

package/build/esm/models/apiKey.d.ts

@@ -1,9 +1,17 @@
 import { AnyRecord } from "../types";
+export declare const API_KEY_PREFIX = "VF.";
+export declare enum APIKeySubType {
+    Workspace = "WS",
+    DialogManager = "DM"
+}
+export declare const isWorkspaceAPIKey: (key: unknown) => key is string;
+export declare const isDialogManagerAPIKey: (key: unknown) => key is string;
 export interface Model<Data extends AnyRecord = AnyRecord> {
     _id: string;
     creatorID: number;
     projectID?: string;
     workspaceID: string;
+    type: APIKeySubType;
     name: string;
     data?: Data;
     scopes: string[];

package/build/esm/models/apiKey.js

@@ -1 +1,9 @@
-export {};
+export const API_KEY_PREFIX = 'VF.';
+export var APIKeySubType;
+(function (APIKeySubType) {
+    APIKeySubType["Workspace"] = "WS";
+    APIKeySubType["DialogManager"] = "DM";
+})(APIKeySubType || (APIKeySubType = {}));
+const buildAPIKeyGuard = (type) => (key) => typeof key === 'string' && key.startsWith(`${API_KEY_PREFIX}${type}.`);
+export const isWorkspaceAPIKey = buildAPIKeyGuard(APIKeySubType.Workspace);
+export const isDialogManagerAPIKey = buildAPIKeyGuard(APIKeySubType.DialogManager);

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

@@ -2,5 +2,6 @@ export * from './command';
 export * from './common';
 export * from './intent';
 export * from './node';
+export * from './note';
 export * from './prototype';
 export * from './slot';

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

@@ -2,5 +2,6 @@ export * from './command';
 export * from './common';
 export * from './intent';
 export * from './node';
+export * from './note';
 export * from './prototype';
 export * from './slot';

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

@@ -20,4 +20,5 @@ export interface Intent {
     name: string;
     slots?: IntentSlot[];
     inputs: IntentInput[];
+    noteID?: string;
 }

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

@@ -0,0 +1,19 @@
+import { AnyRecord } from "../../types";
+export declare enum NoteType {
+    INTENT = "INTENT"
+}
+export interface BaseNote {
+    id: string;
+    type: NoteType;
+    text: string;
+    meta?: AnyRecord;
+    mentions: number[];
+}
+export interface IntentNoteMeta {
+    intentID: string;
+}
+export interface IntentNote extends BaseNote {
+    type: NoteType.INTENT;
+    meta: IntentNoteMeta;
+}
+export declare type AnyNote = IntentNote;

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

@@ -0,0 +1,4 @@
+export var NoteType;
+(function (NoteType) {
+    NoteType["INTENT"] = "INTENT";
+})(NoteType || (NoteType = {}));

package/build/esm/models/version/index.d.ts

@@ -1,5 +1,5 @@
 import { AnyRecord } from "../../types";
-import { BaseCommand, Intent, Slot, Variable } from '../base';
+import { BaseCommand, BaseNote, Intent, Slot, Variable } from '../base';
 import { Prototype } from './prototype';
 export * from './prototype';
 export interface PlatformData<Settings extends AnyRecord = AnyRecord, Publishing extends AnyRecord = AnyRecord> {
@@ -35,6 +35,7 @@ export interface Model<_PlatformData extends PlatformData, Command extends BaseC
     projectID: string;
     rootDiagramID: string;
     name: string;
+    notes?: Record<string, BaseNote>;
     topics?: FolderItem[];
     folders?: Record<string, Folder>;
     variables: Variable[];

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@voiceflow/base-types",
   "description": "Voiceflow base project types",
-  "version": "2.17.3",
+  "version": "2.19.0",
   "author": "Voiceflow",
   "bugs": {
     "url": "https://github.com/voiceflow/libs/issues"
   },
   "dependencies": {
-    "@voiceflow/common": "^7.23.0",
+    "@voiceflow/common": "^7.24.0",
     "slate": "0.73.0"
   },
   "files": [
@@ -43,5 +43,5 @@
     "test:smoke": "exit 0",
     "test:unit": "exit 0"
   },
-  "gitHead": "8a42f59e14588817d901cee1d3545040eefa2dee"
+  "gitHead": "309ec4587f621f372c28fa299a55bbe9471a256b"
 }