@bigfootai/bigfoot-types 2.10.12 → 2.11.1

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.Calendar = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.Note = exports.Block = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = 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 = exports.BusinessObjectType = void 0;
+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;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -8,25 +8,20 @@ up in our Graph QL CRUD operations and set out the fundamental building blocks o
 the platform.
 */
 // CORE START
-var BusinessObjectType;
-(function (BusinessObjectType) {
-    BusinessObjectType["Calendar"] = "calendar";
-    BusinessObjectType["Event"] = "event";
-    BusinessObjectType["Task"] = "task";
-    BusinessObjectType["Document"] = "document";
-    BusinessObjectType["Record"] = "record";
-    BusinessObjectType["Conference"] = "conference";
-    BusinessObjectType["Thread"] = "thread";
-    BusinessObjectType["Website"] = "website";
-    BusinessObjectType["Template"] = "template";
-    BusinessObjectType["Table"] = "table";
-})(BusinessObjectType || (exports.BusinessObjectType = BusinessObjectType = {}));
 var BlockType;
 (function (BlockType) {
     BlockType["Note"] = "note";
     BlockType["Section"] = "section";
+    BlockType["Calendar"] = "calendar";
+    BlockType["Event"] = "event";
     BlockType["Task"] = "task";
-    BlockType["Data"] = "data";
+    BlockType["Document"] = "document";
+    BlockType["Record"] = "record";
+    BlockType["Conference"] = "conference";
+    BlockType["Thread"] = "thread";
+    BlockType["Website"] = "website";
+    BlockType["Template"] = "template";
+    BlockType["Table"] = "table";
 })(BlockType || (exports.BlockType = BlockType = {}));
 var TagType;
 (function (TagType) {
@@ -217,18 +212,6 @@ class Tag extends Primitive {
     }
 }
 exports.Tag = Tag;
-class BusinessObject extends Primitive {
-    constructor(provider, application, uri) {
-        super();
-        this.processingStage = ProcessingStage.NotProcessed;
-        this.processingAttempts = 0;
-        this.dateProcessed = 0;
-        this.provider = provider;
-        this.application = application;
-        this.uri = uri;
-    }
-}
-exports.BusinessObject = BusinessObject;
 class Tenant extends Primitive {
     constructor(domainMemberships, email, emailVerified, domainIdEmail, tagId) {
         super();
@@ -275,6 +258,18 @@ class Block extends Primitive {
     }
 }
 exports.Block = Block;
+class BusinessObject extends Block {
+    constructor(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri) {
+        super(tenantIdCreated, editors, sharingTags, version, blockType);
+        this.processingStage = ProcessingStage.NotProcessed;
+        this.processingAttempts = 0;
+        this.dateProcessed = 0;
+        this.provider = provider;
+        this.application = application;
+        this.uri = uri;
+    }
+}
+exports.BusinessObject = BusinessObject;
 class Note extends Block {
     constructor(tenantIdCreated, editors, sharingTags, version) {
         super(tenantIdCreated, editors, sharingTags, version, BlockType.Note);
@@ -291,8 +286,8 @@ class Task extends Block {
 }
 exports.Task = Task;
 class Conference extends BusinessObject {
-    constructor(provider, application, uri, entryPoints) {
-        super(provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, entryPoints) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Conference, provider, application, uri);
         this.entryPoints = entryPoints;
     }
 }
@@ -313,15 +308,15 @@ var ResponseStatus;
     ResponseStatus["Accepted"] = "accepted";
 })(ResponseStatus || (exports.ResponseStatus = ResponseStatus = {}));
 class Calendar extends BusinessObject {
-    constructor(provider, application, uri, timeZone) {
-        super(provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, timeZone) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Calendar, provider, application, uri);
         this.timeZone = timeZone;
     }
 }
 exports.Calendar = Calendar;
 class Event extends BusinessObject {
-    constructor(provider, application, uri, calendarId, status, dateStart, organizedBy) {
-        super(provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, calendarId, status, dateStart, organizedBy) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Event, provider, application, uri);
         this.calendarId = calendarId;
         this.status = status;
         this.dateStart = dateStart;
@@ -332,8 +327,8 @@ exports.Event = Event;
 //// EVENT END
 //// EXTERNAL TASK START
 class ExternalTask extends BusinessObject {
-    constructor(provider, application, uri, status, dateDue) {
-        super(provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, status, dateDue) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Task, provider, application, uri);
         this.status = status;
         this.dateDue = dateDue;
     }
@@ -342,14 +337,22 @@ exports.ExternalTask = ExternalTask;
 //// EXTERNAL TASK END
 //// MESSAGING START
 class Thread extends BusinessObject {
-    constructor(provider, application, uri) {
-        super(provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Thread, provider, application, uri);
     }
 }
 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);
+    }
+}
+exports.Website = Website;
 class Template extends BusinessObject {
-    constructor(provider, application, uri, metadata) {
-        super(provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, metadata) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Template, provider, application, uri);
         this.metadata = metadata;
     }
 }
@@ -375,8 +378,8 @@ var FieldVariation;
     FieldVariation["Url"] = "url";
 })(FieldVariation || (exports.FieldVariation = FieldVariation = {}));
 class Table extends BusinessObject {
-    constructor(provider, application, uri, recordType, metadata, values) {
-        super(provider, application, uri);
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, recordType, metadata, values) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Table, provider, application, uri);
         this.recordType = recordType;
         this.metadata = metadata;
         this.values = values;

package/model.ts

@@ -6,7 +6,9 @@ up in our Graph QL CRUD operations and set out the fundamental building blocks o
 the platform.
 */
 // CORE START
-export enum BusinessObjectType {
+export enum BlockType {
+	Note = 'note',
+	Section = 'section',
 	Calendar = 'calendar',
 	Event = 'event',
 	Task = 'task',
@@ -19,13 +21,6 @@ export enum BusinessObjectType {
 	Table = 'table',
 }
 
-export enum BlockType {
-	Note = 'note', // It's a full note
-	Section = 'section', // It's a fragment of content
-	Task = 'task', // It's a task
-	Data = 'data', // It's a record or set of records belonging to a specific metadata definition
-}
-
 export enum TagType {
 	Person = 'person',
 	Topic = 'topic',
@@ -294,14 +289,6 @@ export interface ProviderResponse {
 	providerUrl: string;
 }
 
-export interface BusinessObjectRequest {
-	businessObjectId: string;
-	linkUrl: string;
-	credential?: Credential;
-	application?: string;
-	provider?: Provider;
-}
-
 export interface StandardObjects {
 	task: boolean;
 	calendar: boolean;
@@ -415,34 +402,6 @@ export class Tag extends Primitive {
 	}
 }
 
-export class BusinessObject extends Primitive {
-	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
-	uri: string; // A uri to locate the specific instance of the business object
-	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 identifier that allows us to do entity resolution
-	businessObjectType?: BusinessObjectType;
-	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
-
-	constructor(provider: string, application: string, uri: string) {
-		super();
-
-		this.processingStage = ProcessingStage.NotProcessed;
-		this.processingAttempts = 0;
-		this.dateProcessed = 0;
-
-		this.provider = provider;
-		this.application = application;
-		this.uri = uri;
-	}
-}
-
 export class Tenant extends Primitive {
 	domainMemberships: string[]; // The list of all domains this tenant belongs
 	email: string;
@@ -556,6 +515,43 @@ export class Block extends Primitive {
 	}
 }
 
+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
+	uri: string; // A uri to locate the specific instance of the business object
+	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
+	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(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
+		blockType: BlockType,
+		provider: string,
+		application: string,
+		uri: string
+	) {
+		super(tenantIdCreated, editors, sharingTags, version, blockType);
+
+		this.processingStage = ProcessingStage.NotProcessed;
+		this.processingAttempts = 0;
+		this.dateProcessed = 0;
+
+		this.provider = provider;
+		this.application = application;
+		this.uri = uri;
+	}
+}
+
 export class Note extends Block {
 	constructor(
 		tenantIdCreated: string,
@@ -631,12 +627,25 @@ export class Conference extends BusinessObject {
 	transcription?: Transcription | null;
 
 	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
 		provider: string,
 		application: string,
 		uri: string,
 		entryPoints: ConferenceEntrypoint[]
 	) {
-		super(provider, application, uri);
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Conference,
+			provider,
+			application,
+			uri
+		);
 
 		this.entryPoints = entryPoints;
 	}
@@ -687,12 +696,25 @@ export class Calendar extends BusinessObject {
 	events?: Event[] | null;
 
 	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
 		provider: string,
 		application: string,
 		uri: string,
 		timeZone: string
 	) {
-		super(provider, application, uri);
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Calendar,
+			provider,
+			application,
+			uri
+		);
 
 		this.timeZone = timeZone;
 	}
@@ -714,6 +736,10 @@ export class Event extends BusinessObject {
 	attachments?: Attachment[] | null;
 
 	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
 		provider: string,
 		application: string,
 		uri: string,
@@ -722,7 +748,16 @@ export class Event extends BusinessObject {
 		dateStart: number,
 		organizedBy: PersonReference
 	) {
-		super(provider, application, uri);
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Event,
+			provider,
+			application,
+			uri
+		);
 
 		this.calendarId = calendarId;
 		this.status = status;
@@ -741,13 +776,26 @@ export class ExternalTask extends BusinessObject {
 	recurrence?: RecurrenceRFC[];
 
 	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
 		provider: string,
 		application: string,
 		uri: string,
 		status: TaskStatus,
 		dateDue: number
 	) {
-		super(provider, application, uri);
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Task,
+			provider,
+			application,
+			uri
+		);
 
 		this.status = status;
 		this.dateDue = dateDue;
@@ -757,14 +805,56 @@ export class ExternalTask extends BusinessObject {
 
 //// MESSAGING START
 export class Thread extends BusinessObject {
-	constructor(provider: string, application: string, uri: string) {
-		super(provider, application, uri);
+	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
+		provider: string,
+		application: string,
+		uri: string
+	) {
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Thread,
+			provider,
+			application,
+			uri
+		);
 	}
 }
 //// MESSAGING END
 
 //// WEBSITE START
-export interface Website extends BusinessObject {}
+export class Website extends BusinessObject {
+	title?: string;
+	description?: string;
+	bannerImage?: string;
+
+	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
+		provider: string,
+		application: string,
+		uri: string
+	) {
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Website,
+			provider,
+			application,
+			uri
+		);
+	}
+}
 //// WEBSITE END
 
 // BUSINESS OBJECTS END
@@ -787,12 +877,25 @@ export class Template extends BusinessObject {
 	metadata: DocumentMetadata;
 
 	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
 		provider: string,
 		application: string,
 		uri: string,
 		metadata: DocumentMetadata
 	) {
-		super(provider, application, uri);
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Template,
+			provider,
+			application,
+			uri
+		);
 
 		this.metadata = metadata;
 	}
@@ -857,6 +960,10 @@ export class Table extends BusinessObject {
 	values: FieldValue[];
 
 	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
 		provider: string,
 		application: string,
 		uri: string,
@@ -864,7 +971,16 @@ export class Table extends BusinessObject {
 		metadata: TableMetadata,
 		values: FieldValue[]
 	) {
-		super(provider, application, uri);
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Table,
+			provider,
+			application,
+			uri
+		);
 
 		this.recordType = recordType;
 		this.metadata = metadata;

package/package.json

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