@bigfootai/bigfoot-types 2.3.3 → 2.4.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.EventStatus = exports.Conference = exports.Task = exports.Block = exports.Note = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = exports.Tag = exports.Primitive = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.TagType = exports.BlockType = exports.BusinessObjectType = void 0;
+exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Thread = exports.ExternalTask = exports.EventStatus = exports.Conference = exports.Task = exports.Block = exports.Note = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = exports.Tag = exports.Primitive = 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
@@ -29,6 +29,11 @@ var TagType;
     TagType["Person"] = "person";
     TagType["Topic"] = "topic";
 })(TagType || (exports.TagType = TagType = {}));
+var ClientType;
+(function (ClientType) {
+    ClientType["Web"] = "web";
+    ClientType["Mobile"] = "mobile";
+})(ClientType || (exports.ClientType = ClientType = {}));
 var SharingLevel;
 (function (SharingLevel) {
     SharingLevel[SharingLevel["ReadOnly"] = 0] = "ReadOnly";
@@ -50,7 +55,6 @@ var SharingApproach;
 (function (SharingApproach) {
     SharingApproach[SharingApproach["Inline"] = 0] = "Inline";
     SharingApproach[SharingApproach["Explicit"] = 1] = "Explicit";
-    SharingApproach[SharingApproach["Automated"] = 2] = "Automated";
 })(SharingApproach || (exports.SharingApproach = SharingApproach = {}));
 var InviteStatus;
 (function (InviteStatus) {

package/model.ts

@@ -82,16 +82,38 @@ export enum RecurrenceRFC {
 	SUNDAY = 'SU',
 }
 
+export enum DocumentType {
+	BlockQuote = 'blockquote',
+	Image = 'image',
+	Text = 'text',
+	Doc = 'doc',
+	Paragraph = 'paragraph',
+	HorizontalRule = 'horizontal_rule',
+	Heading = 'heading',
+	CodeBlock = 'code_block',
+	HardBreak = 'hard_break',
+}
+
+export enum MarkType {
+	Link = 'link',
+}
+
 export interface Mark {
 	type: string;
+	attrs?: Map<string, string>;
+}
+
+export interface Highlight {
+	indexStart: number;
+	indexEnd: number;
 }
 
 export interface Document {
-	attrs: Map<string, string>;
-	content: Document;
-	text: string;
+	attrs?: Map<string, string>;
+	content?: Document[];
+	text?: string;
 	type: string;
-	marks: Mark[];
+	marks?: Mark[];
 }
 
 export interface Editor {
@@ -135,6 +157,19 @@ export interface Step {
 	status: StepStatus;
 }
 
+export interface DateEntry extends MachineLearningEntry {
+	dateStart: number;
+	dateEnd: number;
+}
+
+export interface EntityEntry extends MachineLearningEntry {
+	name: string;
+}
+
+export interface MachineLearningEntry {
+	highlights: Highlight[];
+}
+
 export class Primitive {
 	_id: string;
 	dateCreated: number;
@@ -181,7 +216,7 @@ export class Tenant extends Primitive {
 
 export class Domain extends Primitive {
 	domain: string;
-	public: boolean;
+	isPublic: boolean;
 }
 
 export class Person extends Tag {
@@ -190,9 +225,24 @@ export class Person extends Tag {
 	inviteStatus?: InviteStatus;
 }
 
+export interface ReferenceNote {
+	id: string;
+	version: number;
+	text: string;
+}
+
+export class Article extends Primitive {
+	referenceNote: ReferenceNote;
+	dates?: DateEntry[];
+	locations?: EntityEntry[];
+	organizations?: EntityEntry[];
+	names?: EntityEntry[];
+	sentiments?: EntityEntry[];
+}
+
 export class Note extends Primitive {
 	tenantIdCreated: string; // The tenant._id that created the note initially
-	document: Document;
+	document: string; // The note serialized as a JSON string
 	editors: Editor[]; // The list of people/devices that were used in creating this note
 	sharingTags: SharingTag[]; // The list of tags that this note is shared with
 	_sharedTags?: string[]; // The list of tags that have sharing equal to true
@@ -207,9 +257,16 @@ export class Block extends Note {
 export class Task extends Block {
 	status: TaskStatus;
 	steps?: Step[];
-	dateRemindMe?: Date;
-	dateDue: Date;
+	dateRemindMe?: number;
+	dateDue: number;
 	recurrence?: RecurrenceRFC[];
+
+	constructor() {
+		super();
+
+		this.blockType = BlockType.Task;
+		this.status = TaskStatus.NotStarted;
+	}
 }
 // CORE END
 
@@ -225,8 +282,8 @@ export interface TranscriptionEntry {
 	person: Person;
 	text: string;
 	language: string;
-	startDate: Date;
-	endDate: Date;
+	startDate: number;
+	endDate: number;
 }
 
 export interface Transcription {
@@ -274,10 +331,10 @@ export interface Event extends BusinessObject {
 	subject?: string;
 	description?: string;
 	location: string;
-	startDate: Date;
-	endDate?: Date;
+	startDate: number;
+	endDate?: number;
 	recurrence: RecurrenceRFC[];
-	originalStartDate: Date;
+	originalStartDate: number;
 	organizedBy: Person;
 	attendees?: PersonAcceptance[];
 	conference?: Conference;
@@ -289,8 +346,8 @@ export interface Event extends BusinessObject {
 export class ExternalTask extends BusinessObject {
 	status: TaskStatus;
 	steps?: Step[];
-	dateRemindMe?: Date;
-	dateDue: Date;
+	dateRemindMe?: number;
+	dateDue: number;
 	recurrence?: RecurrenceRFC[];
 }
 //// EXTERNAL TASK END

package/package.json

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