@bigfootai/bigfoot-types 3.0.4 → 3.1.0

package/model.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = exports.Organization = exports.Domain = exports.Tenant = exports.TenantQL = exports.Tag = exports.Provider = exports.ProviderQL = exports.Sync = exports.SyncQL = exports.Primitive = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ConnectedProviderQL = exports.CredentialQL = exports.ProviderRequestQL = exports.ProviderInfoQL = exports.EntityEntryQL = exports.RelationEntryQL = exports.ArgumentEntryQL = exports.EntityReferenceQL = exports.DocumentSentimentQL = exports.ReactionQL = exports.ReactionSkinToneQL = exports.SharingTagQL = exports.EditorQL = exports.EditorInputQL = exports.HighlightQL = 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.GraphQLTypes = exports.SearchInputQL = exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = exports.ArchiveNoteOutputQL = exports.ArchiveNoteInputQL = exports.FindNotesInputQL = exports.FindNoteInputQL = exports.UpsertNoteInputQL = exports.InsertNoteInputQL = exports.FindEventInputQL = exports.FindCalendarInputQL = exports.FindArticlesInputQL = exports.FindArticleInputQL = exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Website = exports.Thread = exports.Todo = exports.Calendar = exports.CalendarQL = exports.Event = exports.EventQL = exports.PersonAcceptanceQL = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.ConferenceQL = exports.ConferenceEntrypointQL = exports.TranscriptionQL = exports.TranscriptionEntryQL = exports.Task = exports.TaskQL = exports.Note = exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFields = exports.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = void 0;
+exports.Domain = exports.Tenant = exports.TenantQL = exports.Tag = exports.Provider = exports.ProviderQL = exports.Sync = exports.SyncQL = exports.Primitive = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ConnectedProviderQL = exports.CredentialQL = exports.ProviderRequestQL = exports.ProviderInfoQL = exports.TagRecommendationQL = exports.DateEntityEntryQL = exports.EntityEntryQL = exports.EntityEntryFields = exports.RelationEntryQL = exports.ArgumentEntryQL = exports.EntityReferenceQL = exports.DocumentSentimentQL = exports.ReactionQL = exports.ReactionSkinToneQL = exports.SharingTagQL = exports.EditorQL = exports.EditorInputQL = exports.HighlightQL = exports.RelationType = exports.EntityType = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.TagRecommendationVariation = exports.TagRecommendationType = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = void 0;
+exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = exports.ArchiveNoteOutputQL = exports.ArchiveNoteInputQL = exports.FindNotesInputQL = exports.FindNoteInputQL = exports.UpsertNoteInputQL = exports.InsertNoteInputQL = exports.FindEventInputQL = exports.FindCalendarInputQL = exports.FindArticlesInputQL = exports.FindArticleInputQL = exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Website = exports.Thread = exports.Todo = exports.Calendar = exports.CalendarQL = exports.Event = exports.EventQL = exports.PersonAcceptanceQL = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.ConferenceQL = exports.ConferenceEntrypointQL = exports.TranscriptionQL = exports.TranscriptionEntryQL = exports.Task = exports.TaskQL = exports.Note = exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFields = exports.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = exports.Organization = void 0;
+exports.GraphQLTypes = exports.SearchInputQL = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -64,6 +65,17 @@ var InviteStatus;
     InviteStatus[InviteStatus["InviteSent"] = 1] = "InviteSent";
     InviteStatus[InviteStatus["InviteAccepted"] = 2] = "InviteAccepted";
 })(InviteStatus || (exports.InviteStatus = InviteStatus = {}));
+var TagRecommendationType;
+(function (TagRecommendationType) {
+    TagRecommendationType["TagMissing"] = "missing";
+    TagRecommendationType["TagCreated"] = "created";
+    TagRecommendationType["TagFound"] = "found";
+    TagRecommendationType["MultipleTagsFound"] = "multiple_found";
+})(TagRecommendationType || (exports.TagRecommendationType = TagRecommendationType = {}));
+var TagRecommendationVariation;
+(function (TagRecommendationVariation) {
+    TagRecommendationVariation["TypeChange"] = "type_change";
+})(TagRecommendationVariation || (exports.TagRecommendationVariation = TagRecommendationVariation = {}));
 var RecurrenceRFC;
 (function (RecurrenceRFC) {
     RecurrenceRFC["FREQ"] = "FREQ";
@@ -235,10 +247,22 @@ type RelationEntry {
   confidence: Int!
   arguments: [ArgumentEntry]!
 }`;
-exports.EntityEntryQL = `
-type EntityEntry {
+exports.EntityEntryFields = `
   text: String!
   confidence: Int!
+`;
+exports.EntityEntryQL = `
+type EntityEntry {${exports.EntityEntryFields}
+}`;
+exports.DateEntityEntryQL = `
+type EntityEntry {${exports.EntityEntryFields}
+  date: Float!
+}`;
+exports.TagRecommendationQL = `
+type TagRecommendation {
+  type: String!
+  tags: [EntityEntry]!
+  variation: String
 }`;
 exports.ProviderInfoQL = `
 type ProviderInfo {
@@ -391,13 +415,11 @@ type Article {${exports.PrimitiveFields}
   sentiment: DocumentSentiment
   dates: [EntityEntry]
   locations: [EntityEntry]
-  organizations: [EntityEntry]
-  names: [EntityEntry]
-  sentiments: [EntityEntry]
-  topics: [EntityEntry]
-  mentions: [EntityEntry]
-  relations: [RelationEntry]
   linkUrls: [String]
+	sharingTags: [SharingTag]
+  recommendations: [TagRecommendation]
+  relations: [RelationEntry]
+	archived: Boolean!
 }`;
 class Article extends Primitive {
     constructor(referenceBlock) {
@@ -763,6 +785,8 @@ ${exports.EntityReferenceQL}
 ${exports.ArgumentEntryQL}
 ${exports.RelationEntryQL}
 ${exports.EntityEntryQL}
+${exports.DateEntityEntryQL}
+${exports.TagRecommendationQL}
 ${exports.ProviderInfoQL}
 ${exports.ProviderRequestQL}
 ${exports.CredentialQL}

package/model.ts

@@ -61,6 +61,17 @@ export enum InviteStatus {
 	InviteAccepted = 2,
 }
 
+export enum TagRecommendationType {
+	TagMissing = 'missing',
+	TagCreated = 'created',
+	TagFound = 'found',
+	MultipleTagsFound = 'multiple_found',
+}
+
+export enum TagRecommendationVariation {
+	TypeChange = 'type_change',
+}
+
 export enum RecurrenceRFC {
 	FREQ = 'FREQ', // The frequency of the event (e.g., DAILY, WEEKLY, MONTHLY, YEARLY).
 	UNTIL = 'UNTIL', // A date until when the event should occur.
@@ -325,10 +336,12 @@ export interface MachineLearningEntry {
 	_highlights?: Highlight[];
 }
 
-export const EntityEntryQL = `
-type EntityEntry {
+export const EntityEntryFields = `
   text: String!
   confidence: Int!
+`;
+export const EntityEntryQL = `
+type EntityEntry {${EntityEntryFields}
 }`;
 export interface EntityEntry extends MachineLearningEntry {
 	text: string;
@@ -339,12 +352,29 @@ export interface EntityEntry extends MachineLearningEntry {
 	_avatar?: string;
 	_favicon?: string;
 	_friendlyName?: string;
+	_dbpedia?: string;
 }
 
+export const DateEntityEntryQL = `
+type EntityEntry {${EntityEntryFields}
+  date: Float!
+}`;
 export interface DateEntityEntry extends EntityEntry {
 	date: number;
 }
 
+export const TagRecommendationQL = `
+type TagRecommendation {
+  type: String!
+  tags: [EntityEntry]!
+  variation: String
+}`;
+export interface TagRecommendation {
+	type: TagRecommendationType;
+	tags: EntityEntry[];
+	variation?: TagRecommendationVariation;
+}
+
 export const ProviderInfoQL = `
 type ProviderInfo {
   provider: String!
@@ -603,6 +633,7 @@ export class Organization extends Tag {
 
 export class Person extends Tag {
 	email?: string;
+	avatar?: string;
 	inviteStatus?: InviteStatus;
 	tenantIdVerified?: string; // The tenant._id that claimed/verified this tag as being them
 
@@ -617,13 +648,11 @@ type Article {${PrimitiveFields}
   sentiment: DocumentSentiment
   dates: [EntityEntry]
   locations: [EntityEntry]
-  organizations: [EntityEntry]
-  names: [EntityEntry]
-  sentiments: [EntityEntry]
-  topics: [EntityEntry]
-  mentions: [EntityEntry]
-  relations: [RelationEntry]
   linkUrls: [String]
+	sharingTags: [SharingTag]
+  recommendations: [TagRecommendation]
+  relations: [RelationEntry]
+	archived: Boolean!
 }`;
 export class Article extends Primitive {
 	referenceBlock: ReferenceBlock;
@@ -631,10 +660,10 @@ export class Article extends Primitive {
 	sentiment?: DocumentSentiment;
 	dates?: EntityEntry[];
 	locations?: EntityEntry[];
-	sentiments?: EntityEntry[];
-	relations?: RelationEntry[];
 	linkUrls?: string[];
 	sharingTags?: SharingTag[];
+	recommendations?: TagRecommendation[];
+	relations?: RelationEntry[];
 	archived: boolean;
 	_changes?: Changes;
 	_tasks?: Task[];
@@ -1470,6 +1499,8 @@ ${EntityReferenceQL}
 ${ArgumentEntryQL}
 ${RelationEntryQL}
 ${EntityEntryQL}
+${DateEntityEntryQL}
+${TagRecommendationQL}
 ${ProviderInfoQL}
 ${ProviderRequestQL}
 ${CredentialQL}

package/package.json

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