@bigfootai/bigfoot-types 2.6.13 → 2.7.0

package/model.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Thread = exports.ExternalTask = exports.Event = exports.EventStatus = exports.Conference = exports.Task = exports.Block = exports.Note = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = exports.Tag = exports.Provider = exports.Primitive = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = exports.BusinessObjectType = void 0;
+exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Thread = exports.ExternalTask = exports.Event = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.Block = exports.Note = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = exports.Tag = exports.Provider = exports.Primitive = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = exports.BusinessObjectType = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -15,8 +15,10 @@ var BusinessObjectType;
     BusinessObjectType["Document"] = "document";
     BusinessObjectType["Record"] = "record";
     BusinessObjectType["Conference"] = "conference";
-    BusinessObjectType["Message"] = "message";
+    BusinessObjectType["Thread"] = "thread";
     BusinessObjectType["Website"] = "website";
+    BusinessObjectType["Template"] = "template";
+    BusinessObjectType["Table"] = "table";
 })(BusinessObjectType || (exports.BusinessObjectType = BusinessObjectType = {}));
 var BlockType;
 (function (BlockType) {
@@ -137,14 +139,13 @@ class Tag extends Primitive {
 }
 exports.Tag = Tag;
 class BusinessObject extends Primitive {
-    constructor(provider, uri, externalId, businessObjectType, externalResponse, document) {
+    constructor(provider, uri, externalId, businessObjectType, externalResponse) {
         super();
         this.provider = provider;
         this.uri = uri;
         this.externalId = externalId;
         this.businessObjectType = businessObjectType;
         this.externalResponse = externalResponse;
-        this.document = document;
     }
 }
 exports.BusinessObject = BusinessObject;
@@ -183,10 +184,9 @@ class Article extends Primitive {
 }
 exports.Article = Article;
 class Note extends Primitive {
-    constructor(tenantIdCreated, document, editors, sharingTags, version) {
+    constructor(tenantIdCreated, editors, sharingTags, version) {
         super();
         this.tenantIdCreated = tenantIdCreated;
-        this.document = document;
         this.editors = editors;
         this.sharingTags = sharingTags;
         this.version = version;
@@ -194,26 +194,25 @@ class Note extends Primitive {
 }
 exports.Note = Note;
 class Block extends Note {
-    constructor(tenantIdCreated, document, editors, sharingTags, version, blockType, originNoteId) {
-        super(tenantIdCreated, document, editors, sharingTags, version);
+    constructor(tenantIdCreated, editors, sharingTags, version, blockType, originNoteId) {
+        super(tenantIdCreated, editors, sharingTags, version);
         this.blockType = blockType;
         this.originNoteId = originNoteId;
     }
 }
 exports.Block = Block;
 class Task extends Block {
-    constructor(tenantIdCreated, document, editors, sharingTags, version, originNoteId, dateDue) {
-        super(tenantIdCreated, document, editors, sharingTags, version, BlockType.Task, originNoteId);
+    constructor(tenantIdCreated, editors, sharingTags, version, originNoteId, dateDue) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Task, originNoteId);
         this.status = TaskStatus.NotStarted;
         this.dateDue = dateDue;
     }
 }
 exports.Task = Task;
 class Conference extends BusinessObject {
-    constructor(provider, uri, externalId, businessObjectType, externalResponse, document, entryPoints, transcription) {
-        super(provider, uri, externalId, businessObjectType, externalResponse, document);
+    constructor(provider, uri, externalId, externalResponse, entryPoints) {
+        super(provider, uri, externalId, BusinessObjectType.Conference, externalResponse);
         this.entryPoints = entryPoints;
-        this.transcription = transcription;
     }
 }
 exports.Conference = Conference;
@@ -225,9 +224,16 @@ var EventStatus;
     EventStatus["Tentative"] = "tentative";
     EventStatus["Cancelled"] = "cancelled";
 })(EventStatus || (exports.EventStatus = EventStatus = {}));
+var ResponseStatus;
+(function (ResponseStatus) {
+    ResponseStatus["NeedsAction"] = "needsAction";
+    ResponseStatus["Declined"] = "declined";
+    ResponseStatus["Tentative"] = "tentative";
+    ResponseStatus["Accepted"] = "accepted";
+})(ResponseStatus || (exports.ResponseStatus = ResponseStatus = {}));
 class Event extends BusinessObject {
-    constructor(provider, uri, externalId, businessObjectType, externalResponse, document, calendarId, status, location, startDate, organizedBy) {
-        super(provider, uri, externalId, businessObjectType, externalResponse, document);
+    constructor(provider, uri, externalId, externalResponse, calendarId, status, location, startDate, organizedBy) {
+        super(provider, uri, externalId, BusinessObjectType.Event, externalResponse);
         this.calendarId = calendarId;
         this.status = status;
         this.location = location;
@@ -239,8 +245,8 @@ exports.Event = Event;
 //// EVENT END
 //// EXTERNAL TASK START
 class ExternalTask extends BusinessObject {
-    constructor(provider, uri, externalId, businessObjectType, externalResponse, document, status, dateDue) {
-        super(provider, uri, externalId, businessObjectType, externalResponse, document);
+    constructor(provider, uri, externalId, externalResponse, status, dateDue) {
+        super(provider, uri, externalId, BusinessObjectType.Task, externalResponse);
         this.status = status;
         this.dateDue = dateDue;
     }
@@ -249,14 +255,14 @@ exports.ExternalTask = ExternalTask;
 //// EXTERNAL TASK END
 //// MESSAGING START
 class Thread extends BusinessObject {
-    constructor(provider, uri, externalId, businessObjectType, externalResponse, document) {
-        super(provider, uri, externalId, businessObjectType, externalResponse, document);
+    constructor(provider, uri, externalId, externalResponse) {
+        super(provider, uri, externalId, BusinessObjectType.Thread, externalResponse);
     }
 }
 exports.Thread = Thread;
 class Template extends BusinessObject {
-    constructor(provider, uri, externalId, businessObjectType, externalResponse, document, metadata) {
-        super(provider, uri, externalId, businessObjectType, externalResponse, document);
+    constructor(provider, uri, externalId, externalResponse, metadata) {
+        super(provider, uri, externalId, BusinessObjectType.Template, externalResponse);
         this.metadata = metadata;
     }
 }
@@ -282,8 +288,8 @@ var FieldVariation;
     FieldVariation["Url"] = "url";
 })(FieldVariation || (exports.FieldVariation = FieldVariation = {}));
 class Table extends BusinessObject {
-    constructor(provider, uri, externalId, businessObjectType, externalResponse, document, recordType, metadata, values) {
-        super(provider, uri, externalId, businessObjectType, externalResponse, document);
+    constructor(provider, uri, externalId, externalResponse, recordType, metadata, values) {
+        super(provider, uri, externalId, BusinessObjectType.Table, externalResponse);
         this.recordType = recordType;
         this.metadata = metadata;
         this.values = values;

package/model.ts

@@ -12,8 +12,10 @@ export enum BusinessObjectType {
 	Document = 'document',
 	Record = 'record',
 	Conference = 'conference',
-	Message = 'message',
+	Thread = 'thread',
 	Website = 'website',
+	Template = 'template',
+	Table = 'table',
 }
 
 export enum BlockType {
@@ -226,6 +228,10 @@ export interface Changes {
 	clientIds: string[];
 }
 
+export interface PersonReference {
+	email: string;
+}
+
 export class Primitive {
 	_id: string;
 	dateCreated: number;
@@ -287,16 +293,16 @@ export class BusinessObject extends Primitive {
 	iconUrl?: string; // The url of an icon that represents the business object
 	externalId: string; // An identifier that allows us to do entity resolution
 	businessObjectType: BusinessObjectType;
-	externalResponse: string; // The full response from the external system that created this object
-	document: Document; // The business object formatted as a document for ML to ingest
+	externalResponse: any; // The full response from the external system that created this object
+	document?: Document; // The business object formatted as a document for ML to ingest
+	parentId?: string; // The business object that is the parent of this business object
 
 	constructor(
 		provider: string,
 		uri: string,
 		externalId: string,
 		businessObjectType: BusinessObjectType,
-		externalResponse: string,
-		document: Document
+		externalResponse: any
 	) {
 		super();
 
@@ -305,7 +311,6 @@ export class BusinessObject extends Primitive {
 		this.externalId = externalId;
 		this.businessObjectType = businessObjectType;
 		this.externalResponse = externalResponse;
-		this.document = document;
 	}
 }
 
@@ -384,10 +389,10 @@ export class Article extends Primitive {
 
 export class Note extends Primitive {
 	tenantIdCreated: string;
-	document: string;
 	editors: Editor[];
 	sharingTags: SharingTag[];
 	version: number;
+	document?: any;
 	changes?: Changes;
 	_sharedTags?: string[];
 	reactions?: Reaction[];
@@ -395,7 +400,6 @@ export class Note extends Primitive {
 
 	constructor(
 		tenantIdCreated: string,
-		document: string,
 		editors: Editor[],
 		sharingTags: SharingTag[],
 		version: number
@@ -403,7 +407,6 @@ export class Note extends Primitive {
 		super();
 
 		this.tenantIdCreated = tenantIdCreated;
-		this.document = document;
 		this.editors = editors;
 		this.sharingTags = sharingTags;
 		this.version = version;
@@ -416,14 +419,13 @@ export class Block extends Note {
 
 	constructor(
 		tenantIdCreated: string,
-		document: string,
 		editors: Editor[],
 		sharingTags: SharingTag[],
 		version: number,
 		blockType: BlockType,
 		originNoteId: string
 	) {
-		super(tenantIdCreated, document, editors, sharingTags, version);
+		super(tenantIdCreated, editors, sharingTags, version);
 
 		this.blockType = blockType;
 		this.originNoteId = originNoteId;
@@ -439,7 +441,6 @@ export class Task extends Block {
 
 	constructor(
 		tenantIdCreated: string,
-		document: string,
 		editors: Editor[],
 		sharingTags: SharingTag[],
 		version: number,
@@ -448,7 +449,6 @@ export class Task extends Block {
 	) {
 		super(
 			tenantIdCreated,
-			document,
 			editors,
 			sharingTags,
 			version,
@@ -495,29 +495,24 @@ export interface ConferenceEntrypoint {
 
 export class Conference extends BusinessObject {
 	entryPoints: ConferenceEntrypoint[];
-	transcription: Transcription;
+	transcription?: Transcription;
 
 	constructor(
 		provider: string,
 		uri: string,
 		externalId: string,
-		businessObjectType: BusinessObjectType,
-		externalResponse: string,
-		document: Document,
-		entryPoints: ConferenceEntrypoint[],
-		transcription: Transcription
+		externalResponse: any,
+		entryPoints: ConferenceEntrypoint[]
 	) {
 		super(
 			provider,
 			uri,
 			externalId,
-			businessObjectType,
-			externalResponse,
-			document
+			BusinessObjectType.Conference,
+			externalResponse
 		);
 
 		this.entryPoints = entryPoints;
-		this.transcription = transcription;
 	}
 }
 //// CONFERENCE END
@@ -529,9 +524,15 @@ export enum EventStatus {
 	Cancelled = 'cancelled',
 }
 
-export interface PersonAcceptance {
-	tagId: string;
-	accepted: boolean;
+export enum ResponseStatus {
+	NeedsAction = 'needsAction',
+	Declined = 'declined',
+	Tentative = 'tentative',
+	Accepted = 'accepted',
+}
+
+export interface PersonAcceptance extends PersonReference {
+	responseStatus: ResponseStatus;
 }
 
 export interface Calendar extends BusinessObject {
@@ -544,7 +545,7 @@ export class Event extends BusinessObject {
 	calendarId: string;
 	status: EventStatus;
 	startDate: number;
-	organizedBy: Person;
+	organizedBy: PersonReference;
 	location?: string;
 	originalStartDate?: number;
 	recurrence?: RecurrenceRFC[];
@@ -559,9 +560,7 @@ export class Event extends BusinessObject {
 		provider: string,
 		uri: string,
 		externalId: string,
-		businessObjectType: BusinessObjectType,
-		externalResponse: string,
-		document: any,
+		externalResponse: any,
 		calendarId: string,
 		status: EventStatus,
 		location: string,
@@ -572,9 +571,8 @@ export class Event extends BusinessObject {
 			provider,
 			uri,
 			externalId,
-			businessObjectType,
-			externalResponse,
-			document
+			BusinessObjectType.Event,
+			externalResponse
 		);
 
 		this.calendarId = calendarId;
@@ -598,9 +596,7 @@ export class ExternalTask extends BusinessObject {
 		provider: string,
 		uri: string,
 		externalId: string,
-		businessObjectType: BusinessObjectType,
-		externalResponse: string,
-		document: Document,
+		externalResponse: any,
 		status: TaskStatus,
 		dateDue: number
 	) {
@@ -608,9 +604,8 @@ export class ExternalTask extends BusinessObject {
 			provider,
 			uri,
 			externalId,
-			businessObjectType,
-			externalResponse,
-			document
+			BusinessObjectType.Task,
+			externalResponse
 		);
 
 		this.status = status;
@@ -625,17 +620,14 @@ export class Thread extends BusinessObject {
 		provider: string,
 		uri: string,
 		externalId: string,
-		businessObjectType: BusinessObjectType,
-		externalResponse: string,
-		document: Document
+		externalResponse: any
 	) {
 		super(
 			provider,
 			uri,
 			externalId,
-			businessObjectType,
-			externalResponse,
-			document
+			BusinessObjectType.Thread,
+			externalResponse
 		);
 	}
 }
@@ -668,18 +660,15 @@ export class Template extends BusinessObject {
 		provider: string,
 		uri: string,
 		externalId: string,
-		businessObjectType: BusinessObjectType,
-		externalResponse: string,
-		document: Document,
+		externalResponse: any,
 		metadata: DocumentMetadata
 	) {
 		super(
 			provider,
 			uri,
 			externalId,
-			businessObjectType,
-			externalResponse,
-			document
+			BusinessObjectType.Template,
+			externalResponse
 		);
 
 		this.metadata = metadata;
@@ -748,9 +737,7 @@ export class Table extends BusinessObject {
 		provider: string,
 		uri: string,
 		externalId: string,
-		businessObjectType: BusinessObjectType,
-		externalResponse: string,
-		document: Document,
+		externalResponse: any,
 		recordType: string,
 		metadata: TableMetadata,
 		values: FieldValue[]
@@ -759,9 +746,8 @@ export class Table extends BusinessObject {
 			provider,
 			uri,
 			externalId,
-			businessObjectType,
-			externalResponse,
-			document
+			BusinessObjectType.Table,
+			externalResponse
 		);
 
 		this.recordType = recordType;

package/package.json

@@ -1,12 +1,15 @@
 {
 	"author": "Bigfoot",
 	"name": "@bigfootai/bigfoot-types",
-	"version": "2.6.13",
+	"version": "2.7.0",
 	"description": "The internal library for the types used in the Bigfoot platform",
 	"main": "model.js",
 	"license": "ISC",
 	"repository": "Notify-AI/bigfoot-types",
 	"dependencies": {
+		"parse5": "^7.1.2",
+		"prosemirror-model": "^1.19.4",
+		"prosemirror-schema-basic": "^1.2.2",
 		"uuid": "^9.0.1"
 	},
 	"devDependencies": {

package/utils.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseHtmlToDocument = void 0;
+const prosemirror_model_1 = require("prosemirror-model");
+const prosemirror_schema_basic_1 = require("prosemirror-schema-basic");
+const parse5_1 = require("parse5");
+const parseHtmlToDocument = (html) => {
+    // Parse the html into a DOM
+    const document = (0, parse5_1.parse)(html);
+    // Only take the body of the document
+    return prosemirror_model_1.DOMParser.fromSchema(prosemirror_schema_basic_1.schema).parse(document.nodeName['body']);
+};
+exports.parseHtmlToDocument = parseHtmlToDocument;

package/utils.ts

@@ -0,0 +1,11 @@
+import { DOMParser } from 'prosemirror-model';
+import { schema } from 'prosemirror-schema-basic';
+import { parse } from 'parse5';
+
+export const parseHtmlToDocument = (html: string): Record<string, any> => {
+	// Parse the html into a DOM
+	const document = parse(html);
+
+	// Only take the body of the document
+	return DOMParser.fromSchema(schema).parse(document.nodeName['body']);
+};