@bigfootai/bigfoot-types 2.11.1 → 2.11.3

package/model.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Website = exports.Thread = exports.ExternalTask = exports.Event = exports.Calendar = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.Note = exports.BusinessObject = exports.Block = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.Tag = exports.Provider = exports.Sync = exports.Primitive = exports.RelationType = exports.EntityType = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = void 0;
+exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Website = exports.Thread = exports.Todo = exports.Event = exports.Calendar = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.Note = exports.BusinessObject = exports.BusinessObjectArticle = exports.Block = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.Tag = exports.Provider = exports.Sync = exports.Primitive = exports.RelationType = exports.EntityType = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -15,6 +15,7 @@ var BlockType;
     BlockType["Calendar"] = "calendar";
     BlockType["Event"] = "event";
     BlockType["Task"] = "task";
+    BlockType["Todo"] = "todo";
     BlockType["Document"] = "document";
     BlockType["Record"] = "record";
     BlockType["Conference"] = "conference";
@@ -258,8 +259,17 @@ class Block extends Primitive {
     }
 }
 exports.Block = Block;
+class BusinessObjectArticle extends Article {
+    constructor(referenceBlock) {
+        super(referenceBlock);
+        this.processingStage = ProcessingStage.NotProcessed;
+        this.processingAttempts = 0;
+        this.dateProcessed = 0;
+    }
+}
+exports.BusinessObjectArticle = BusinessObjectArticle;
 class BusinessObject extends Block {
-    constructor(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri) {
+    constructor(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri, externalId) {
         super(tenantIdCreated, editors, sharingTags, version, blockType);
         this.processingStage = ProcessingStage.NotProcessed;
         this.processingAttempts = 0;
@@ -267,6 +277,7 @@ class BusinessObject extends Block {
         this.provider = provider;
         this.application = application;
         this.uri = uri;
+        this.externalId = externalId;
     }
 }
 exports.BusinessObject = BusinessObject;
@@ -286,8 +297,8 @@ class Task extends Block {
 }
 exports.Task = Task;
 class Conference extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, entryPoints) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Conference, provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, entryPoints) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Conference, provider, application, uri, externalId);
         this.entryPoints = entryPoints;
     }
 }
@@ -308,15 +319,15 @@ var ResponseStatus;
     ResponseStatus["Accepted"] = "accepted";
 })(ResponseStatus || (exports.ResponseStatus = ResponseStatus = {}));
 class Calendar extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, timeZone) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Calendar, provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, timeZone) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Calendar, provider, application, uri, externalId);
         this.timeZone = timeZone;
     }
 }
 exports.Calendar = Calendar;
 class Event extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, calendarId, status, dateStart, organizedBy) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Event, provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, calendarId, status, dateStart, organizedBy) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Event, provider, application, uri, externalId);
         this.calendarId = calendarId;
         this.status = status;
         this.dateStart = dateStart;
@@ -326,33 +337,33 @@ class Event extends BusinessObject {
 exports.Event = Event;
 //// EVENT END
 //// EXTERNAL TASK START
-class ExternalTask extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, status, dateDue) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Task, provider, application, uri);
+class Todo extends BusinessObject {
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, status, dateDue) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Todo, provider, application, uri, externalId);
         this.status = status;
         this.dateDue = dateDue;
     }
 }
-exports.ExternalTask = ExternalTask;
+exports.Todo = Todo;
 //// EXTERNAL TASK END
 //// MESSAGING START
 class Thread extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Thread, provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Thread, provider, application, uri, externalId);
     }
 }
 exports.Thread = Thread;
 //// MESSAGING END
 //// WEBSITE START
 class Website extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Website, provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Website, provider, application, uri, externalId);
     }
 }
 exports.Website = Website;
 class Template extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, metadata) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Template, provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, metadata) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Template, provider, application, uri, externalId);
         this.metadata = metadata;
     }
 }
@@ -378,8 +389,8 @@ var FieldVariation;
     FieldVariation["Url"] = "url";
 })(FieldVariation || (exports.FieldVariation = FieldVariation = {}));
 class Table extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, recordType, metadata, values) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Table, provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, recordType, metadata, values) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Table, provider, application, uri, externalId);
         this.recordType = recordType;
         this.metadata = metadata;
         this.values = values;

package/model.ts

@@ -12,6 +12,7 @@ export enum BlockType {
 	Calendar = 'calendar',
 	Event = 'event',
 	Task = 'task',
+	Todo = 'todo', // A task from an external application
 	Document = 'document',
 	Record = 'record',
 	Conference = 'conference',
@@ -515,6 +516,24 @@ export class Block extends Primitive {
 	}
 }
 
+export class BusinessObjectArticle extends Article {
+	processingStage: ProcessingStage; // Indicates if the business object has been processed yet
+	processingAttempts: number; // Indicates the number of attempts made to process this business object
+	dateProcessed: number; // The date this document was last processed
+	processingReason?: string; // The reason the processing is at this stage
+	externalResponse?: any; // The full response from the external system that created this object
+	iconUrl?: string | null; // The url of an icon that represents the business object
+	parentId?: string | null; // The business object that is the parent of this business object
+
+	constructor(referenceBlock: ReferenceBlock) {
+		super(referenceBlock);
+
+		this.processingStage = ProcessingStage.NotProcessed;
+		this.processingAttempts = 0;
+		this.dateProcessed = 0;
+	}
+}
+
 export class BusinessObject extends Block {
 	provider: string; // A unique string representing the provider e.g. "salesforce", "atlassian", etc
 	application: string; // A unique string representing the provider application e.g. "service", "jira", etc
@@ -522,12 +541,12 @@ export class BusinessObject extends Block {
 	processingStage: ProcessingStage; // Indicates if the business object has been processed yet
 	processingAttempts: number; // Indicates the number of attempts made to process this business object
 	dateProcessed: number; // The date this document was last processed
-	processingReason: string; // The reason the processing is at this stage
+	externalId: string; // An external identifier that can help us match the records
+	processingReason?: string; // The reason the processing is at this stage
 	externalResponse?: any; // The full response from the external system that created this object
 	iconUrl?: string | null; // The url of an icon that represents the business object
 	document?: any | null; // The business object formatted as a document for ML to ingest
 	parentId?: string | null; // The business object that is the parent of this business object
-	linkUrls?: string[]; // Any links in the business object which can be used to understand relationships between objects
 	credential?: Credential; // Only sent for processing requests
 
 	constructor(
@@ -538,7 +557,8 @@ export class BusinessObject extends Block {
 		blockType: BlockType,
 		provider: string,
 		application: string,
-		uri: string
+		uri: string,
+		externalId: string
 	) {
 		super(tenantIdCreated, editors, sharingTags, version, blockType);
 
@@ -549,6 +569,7 @@ export class BusinessObject extends Block {
 		this.provider = provider;
 		this.application = application;
 		this.uri = uri;
+		this.externalId = externalId;
 	}
 }
 
@@ -634,6 +655,7 @@ export class Conference extends BusinessObject {
 		provider: string,
 		application: string,
 		uri: string,
+		externalId: string,
 		entryPoints: ConferenceEntrypoint[]
 	) {
 		super(
@@ -644,7 +666,8 @@ export class Conference extends BusinessObject {
 			BlockType.Conference,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 
 		this.entryPoints = entryPoints;
@@ -703,6 +726,7 @@ export class Calendar extends BusinessObject {
 		provider: string,
 		application: string,
 		uri: string,
+		externalId: string,
 		timeZone: string
 	) {
 		super(
@@ -713,7 +737,8 @@ export class Calendar extends BusinessObject {
 			BlockType.Calendar,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 
 		this.timeZone = timeZone;
@@ -743,6 +768,7 @@ export class Event extends BusinessObject {
 		provider: string,
 		application: string,
 		uri: string,
+		externalId: string,
 		calendarId: string,
 		status: EventStatus,
 		dateStart: number,
@@ -756,7 +782,8 @@ export class Event extends BusinessObject {
 			BlockType.Event,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 
 		this.calendarId = calendarId;
@@ -768,7 +795,7 @@ export class Event extends BusinessObject {
 //// EVENT END
 
 //// EXTERNAL TASK START
-export class ExternalTask extends BusinessObject {
+export class Todo extends BusinessObject {
 	status: TaskStatus;
 	dateDue: number;
 	steps?: Step[];
@@ -783,6 +810,7 @@ export class ExternalTask extends BusinessObject {
 		provider: string,
 		application: string,
 		uri: string,
+		externalId: string,
 		status: TaskStatus,
 		dateDue: number
 	) {
@@ -791,10 +819,11 @@ export class ExternalTask extends BusinessObject {
 			editors,
 			sharingTags,
 			version,
-			BlockType.Task,
+			BlockType.Todo,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 
 		this.status = status;
@@ -812,7 +841,8 @@ export class Thread extends BusinessObject {
 		version: number,
 		provider: string,
 		application: string,
-		uri: string
+		uri: string,
+		externalId: string
 	) {
 		super(
 			tenantIdCreated,
@@ -822,7 +852,8 @@ export class Thread extends BusinessObject {
 			BlockType.Thread,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 	}
 }
@@ -841,7 +872,8 @@ export class Website extends BusinessObject {
 		version: number,
 		provider: string,
 		application: string,
-		uri: string
+		uri: string,
+		externalId: string
 	) {
 		super(
 			tenantIdCreated,
@@ -851,7 +883,8 @@ export class Website extends BusinessObject {
 			BlockType.Website,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 	}
 }
@@ -884,6 +917,7 @@ export class Template extends BusinessObject {
 		provider: string,
 		application: string,
 		uri: string,
+		externalId: string,
 		metadata: DocumentMetadata
 	) {
 		super(
@@ -894,7 +928,8 @@ export class Template extends BusinessObject {
 			BlockType.Template,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 
 		this.metadata = metadata;
@@ -967,6 +1002,7 @@ export class Table extends BusinessObject {
 		provider: string,
 		application: string,
 		uri: string,
+		externalId: string,
 		recordType: string,
 		metadata: TableMetadata,
 		values: FieldValue[]
@@ -979,7 +1015,8 @@ export class Table extends BusinessObject {
 			BlockType.Table,
 			provider,
 			application,
-			uri
+			uri,
+			externalId
 		);
 
 		this.recordType = recordType;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"author": "Bigfoot",
 	"name": "@bigfootai/bigfoot-types",
-	"version": "2.11.1",
+	"version": "2.11.3",
 	"description": "The internal library for the types used in the Bigfoot platform",
 	"main": "model.js",
 	"license": "ISC",