feat: add notes (VF-3209) (#228)

**Fixes or implements VF-000** ### Checklist - [ ] this is a breaking change and should publish a new major version - [ ] appropriate tests have been written
voiceflow · Mar 25, 2022 · 29c63ec · 29c63ec
1 parent f8721bd
commit 29c63ec
Show file tree

Hide file tree

Showing 13 changed files with 128 additions and 20 deletions.
diff --git a/packages/api-sdk/src/client.ts b/packages/api-sdk/src/client.ts
@@ -1,5 +1,5 @@
-import { ClientOptions, PublicClient } from '@api-sdk/publicclient';
-import { User } from '@api-sdk/resources';
+import { ClientOptions, PublicClient } from './publicClient';
+import { User } from './resources';
 
 export class Client extends PublicClient {
   public user: User;

diff --git a/packages/api-sdk/src/index.ts b/packages/api-sdk/src/index.ts
@@ -1,10 +1,11 @@
-import { Client } from '@api-sdk/client';
-import { ClientOptions, PublicClient } from '@api-sdk/publicclient';
 import * as s from 'superstruct';
 
-export type { Client } from '@api-sdk/client';
-export type { PublicClient } from '@api-sdk/publicclient';
-export type { Flatten } from '@api-sdk/types';
+import { Client } from './client';
+import { ClientOptions, PublicClient } from './publicClient';
+
+export type { Client } from './client';
+export type { PublicClient } from './publicClient';
+export type { Flatten } from './types';
 
 export const SParams = s.object({
   clientKey: s.string(),

diff --git a/packages/api-sdk/src/publicclient.ts → packages/api-sdk/src/publicClient.ts b/packages/api-sdk/src/publicclient.ts → packages/api-sdk/src/publicClient.ts
@@ -1,7 +1,8 @@
-import Fetch, { FetchConfig } from '@api-sdk/fetch';
-import { Analytics, APIKey, Diagram, Program, Project, PrototypeProgram, VariableState, Version } from '@api-sdk/resources';
 import { Crypto } from '@voiceflow/common';
 
+import Fetch, { FetchConfig } from './fetch';
+import { Analytics, APIKey, Diagram, Note, Program, Project, PrototypeProgram, VariableState, Version } from './resources';
+
 export interface ClientOptions {
   options?: FetchConfig;
   clientKey: string;
@@ -11,8 +12,12 @@ export interface ClientOptions {
 }
 
 export class PublicClient {
+  public note: Note;
+
   public fetch: Fetch;
 
+  public apiKey: APIKey;
+
   public project: Project;
 
   public version: Version;
@@ -23,22 +28,21 @@ export class PublicClient {
 
   public analytics: Analytics;
 
-  public apiKey: APIKey;
+  public variableState: VariableState;
 
   public prototypeProgram: PrototypeProgram;
 
-  public variableState: VariableState;
-
   constructor({ clientKey, apiEndpoint, authorization, options, analyticsEncryption }: ClientOptions) {
     this.fetch = new Fetch({ clientKey, apiEndpoint, authorization, options });
 
+    this.note = new Note(this.fetch);
     this.apiKey = new APIKey(this.fetch);
     this.project = new Project(this.fetch);
     this.version = new Version(this.fetch);
     this.program = new Program(this.fetch);
     this.diagram = new Diagram(this.fetch);
     this.analytics = new Analytics(this.fetch, { encryption: analyticsEncryption });
-    this.prototypeProgram = new PrototypeProgram(this.fetch);
     this.variableState = new VariableState(this.fetch);
+    this.prototypeProgram = new PrototypeProgram(this.fetch);
   }
 }
diff --git a/packages/api-sdk/src/resources/base.ts b/packages/api-sdk/src/resources/base.ts
@@ -2,10 +2,10 @@ import Fetcher, { FetcherOptions } from './fetcher';
 
 export type Fields = string[] | ReadonlyArray<string>;
 
-export type BaseResourceOptions<C extends Record<string, any>> = FetcherOptions<C>;
+export type BaseResourceOptions<Client extends Record<string, any>> = FetcherOptions<Client>;
 
-class BaseResource<C extends Record<string, any>> extends Fetcher<C> {
-  constructor(options: BaseResourceOptions<C>) {
+class BaseResource<Client extends Record<string, any>> extends Fetcher<Client> {
+  constructor(options: BaseResourceOptions<Client>) {
     super(options);
   }
 

diff --git a/packages/api-sdk/src/resources/index.ts b/packages/api-sdk/src/resources/index.ts
@@ -1,6 +1,7 @@
 export { default as Analytics } from './analytics';
 export { default as APIKey } from './apiKey';
 export { default as Diagram } from './diagram';
+export { default as Note } from './note';
 export { default as Program } from './program';
 export { default as Project } from './project';
 export { default as PrototypeProgram } from './prototypeProgram';

diff --git a/packages/api-sdk/src/resources/note.ts b/packages/api-sdk/src/resources/note.ts
@@ -0,0 +1,26 @@
+import Fetch from '@api-sdk/fetch';
+import { BaseModels } from '@voiceflow/base-types';
+
+import BaseResource from './base';
+
+export const ENDPOINT = 'notes';
+
+export type ModelKey = 'id';
+
+class NoteResource extends BaseResource<NoteResource> {
+  constructor(fetch: Fetch) {
+    super({ fetch, clazz: NoteResource, endpoint: ENDPOINT });
+  }
+
+  public async upsert<T extends BaseModels.BaseNote = BaseModels.BaseNote>(versionID: string, note: T): Promise<T> {
+    const { data } = await this.fetch.put<T>(`${this._getEndpoint()}/${versionID}`, { note });
+
+    return data;
+  }
+
+  public async delete(versionID: string, noteID: string): Promise<void> {
+    await this.fetch.delete(`${this._getEndpoint()}/${versionID}/${noteID}`);
+  }
+}
+
+export default NoteResource;
diff --git a/packages/api-sdk/tests/client.unit.ts b/packages/api-sdk/tests/client.unit.ts
@@ -1,10 +1,10 @@
 import { Client } from '@api-sdk/client';
 import Fetch from '@api-sdk/fetch';
-import { Analytics, APIKey, Diagram, Program, Project, PrototypeProgram, User, VariableState, Version } from '@api-sdk/resources';
+import { Analytics, APIKey, Diagram, Note, Program, Project, PrototypeProgram, User, VariableState, Version } from '@api-sdk/resources';
 import { expect } from 'chai';
 import JWT from 'jsonwebtoken';
 
-const CLIENT_RESOURCES = [Fetch, Diagram, Program, Project, Version, User, APIKey, Analytics, VariableState];
+const CLIENT_RESOURCES = [Fetch, Diagram, Program, Project, Version, User, APIKey, Analytics, VariableState, Note];
 
 const USER_HASH = 'UserHash_16chars';
 const createClient = (authorization?: string) =>

diff --git a/packages/api-sdk/tests/index.unit.ts b/packages/api-sdk/tests/index.unit.ts
@@ -1,7 +1,7 @@
 /* eslint-disable dot-notation */
 import { Client } from '@api-sdk/client';
 import ApiSDK, { SGenerateClientParams, SParams } from '@api-sdk/index';
-import { PublicClient } from '@api-sdk/publicclient';
+import { PublicClient } from '@api-sdk/publicClient';
 import { expect } from 'chai';
 import JWT from 'jsonwebtoken';
 import sinon from 'sinon';

diff --git a/packages/api-sdk/tests/resources/note.unit.ts b/packages/api-sdk/tests/resources/note.unit.ts
@@ -0,0 +1,49 @@
+import { Note } from '@api-sdk/resources';
+import { expect } from 'chai';
+import sinon from 'sinon';
+
+const NOTE = { id: 'qwe', text: 'text', mentions: [1, 2], meta: {} };
+
+const createClient = () => {
+  const fetch = {
+    get: sinon.stub(),
+    post: sinon.stub(),
+    put: sinon.stub(),
+    patch: sinon.stub(),
+    delete: sinon.stub(),
+  };
+
+  const resource = new Note(fetch as any);
+
+  return {
+    fetch,
+    resource,
+  };
+};
+
+describe('NoteResource', () => {
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('.upsert', async () => {
+    const { fetch, resource } = createClient();
+
+    fetch.put.resolves({ data: NOTE });
+
+    const data = await resource.upsert('1', NOTE as any);
+
+    expect(fetch.put.callCount).to.eql(1);
+    expect(fetch.put.args[0]).to.eql([`notes/1`, { note: NOTE }]);
+    expect(data).to.eql(NOTE);
+  });
+
+  it('.delete', async () => {
+    const { fetch, resource } = createClient();
+
+    await resource.delete('1', 'qwe');
+
+    expect(fetch.delete.callCount).to.eql(1);
+    expect(fetch.delete.args[0]).to.eql([`notes/1/qwe`]);
+  });
+});
diff --git a/packages/base-types/src/models/base/index.ts b/packages/base-types/src/models/base/index.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';
diff --git a/packages/base-types/src/models/base/intent.ts b/packages/base-types/src/models/base/intent.ts
@@ -24,4 +24,5 @@ export interface Intent {
   name: string;
   slots?: IntentSlot[];
   inputs: IntentInput[];
+  noteID?: string;
 }
diff --git a/packages/base-types/src/models/base/note.ts b/packages/base-types/src/models/base/note.ts
@@ -0,0 +1,24 @@
+import { AnyRecord } from '@base-types/types';
+
+export 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 type AnyNote = IntentNote;
diff --git a/packages/base-types/src/models/version/index.ts b/packages/base-types/src/models/version/index.ts
@@ -1,6 +1,6 @@
 import { AnyRecord } from '@base-types/types';
 
-import { BaseCommand, Intent, Slot, Variable } from '../base';
+import { BaseCommand, BaseNote, Intent, Slot, Variable } from '../base';
 import { Prototype } from './prototype';
 
 export * from './prototype';
@@ -45,6 +45,7 @@ export interface Model<_PlatformData extends PlatformData, Command extends BaseC
   rootDiagramID: string;
 
   name: string;
+  notes?: Record<string, BaseNote>;
   topics?: FolderItem[];
   folders?: Record<string, Folder>;
   variables: Variable[];