@bigfootai/bigfoot-types 2.11.6 → 2.12.0

package/model.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Website = exports.Thread = exports.Todo = exports.Event = exports.Calendar = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.Note = exports.NoteQL = exports.BusinessObject = exports.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = exports.BlockFields = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.TenantQL = exports.Tag = exports.Provider = exports.Sync = exports.Primitive = exports.PrimitiveFields = exports.ChangesQL = exports.ConnectedProviderQL = exports.CredentialQL = exports.ProviderRequestQL = exports.ProviderInfoQL = exports.ReactionQL = exports.ReactionSkinToneQL = exports.SharingTagQL = exports.EditorQL = 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.Table = exports.FieldVariation = exports.FieldType = exports.Template = void 0;
+exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = exports.Domain = exports.Tenant = exports.TenantQL = exports.Tag = exports.Provider = exports.Sync = exports.Primitive = exports.PrimitiveFields = exports.ChangesQL = exports.ReferenceBlockQL = exports.ConnectedProviderQL = exports.CredentialQL = exports.ProviderRequestQL = exports.ProviderInfoQL = exports.EntityEntryQL = exports.MachineLearningEntryFields = exports.RelationEntryQL = exports.ArgumentEntryQL = exports.EntityReferenceQL = exports.DocumentSentimentQL = exports.ReactionQL = exports.ReactionSkinToneQL = exports.SharingTagQL = exports.EditorQL = 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.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = 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.Event = exports.Calendar = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.TaskQL = exports.Note = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -177,18 +177,23 @@ var RelationType;
     RelationType["SpouseOf"] = "spouseOf";
     RelationType["SubsidiaryOf"] = "subsidiaryOf";
 })(RelationType || (exports.RelationType = RelationType = {}));
+exports.HighlightQL = `
+type Highlight {
+  indexStart: Int!
+  indexEnd: Int!
+}`;
 exports.EditorQL = `
 type Editor {
   clientType: String!
   clientId: String!
-	tenantId: String
+  tenantId: String
 }`;
 exports.SharingTagQL = `
 type SharingTag {
   tagId: String!
   isShared: Boolean!
-	sharingApproach: String!
-	sharingLevel: String!
+  sharingApproach: String!
+  sharingLevel: String!
 }`;
 exports.ReactionSkinToneQL = `
 type ReactionSkinTone {
@@ -200,6 +205,37 @@ type Reaction {
   skinTones: [ReactionSkinTone]!
   unified: String!
 }`;
+exports.DocumentSentimentQL = `
+type DocumentSentiment {
+  name: String!
+  score: Int!
+}`;
+exports.EntityReferenceQL = `
+type EntityReference {
+  name: String!
+  type: String!
+}`;
+exports.ArgumentEntryQL = `
+type ArgumentEntry {
+  text: String!
+  highlight: Highlight!
+  entities: [EntityReference]!
+}`;
+exports.RelationEntryQL = `
+type RelationEntry {
+  type: String!
+  score: Int!
+  highlight: Highlight!
+  arguments: [ArgumentEntry]!
+}`;
+exports.MachineLearningEntryFields = `
+  highlights: [Highlight]`;
+exports.EntityEntryQL = `
+type EntityEntry {${exports.MachineLearningEntryFields}
+  name: String!
+  type: String!
+  score: Int!
+}`;
 exports.ProviderInfoQL = `
 type ProviderInfo {
   provider: String!
@@ -228,6 +264,12 @@ type ConnectedProvider {
   dateCreated: Float
   dateUpdated: Float
 }`;
+exports.ReferenceBlockQL = `
+type ReferenceBlock {
+  id: String!
+  version: Int!
+  type: String!
+}`;
 exports.ChangesQL = `
 type Changes {
   steps: [String]!
@@ -276,16 +318,14 @@ class Tag extends Primitive {
 }
 exports.Tag = Tag;
 exports.TenantQL = `
-type Tenant { ${exports.PrimitiveFields}
+type Tenant {${exports.PrimitiveFields}
   domainMemberships: [String]!
   email: String!
-  emailVerified: Boolean!
   domainIdEmail: String!
   tagId: String!
   picture: String
   familyName: String
   givenName: String
-  connectedProviders: [ConnectedProvider]
 }`;
 class Tenant extends Primitive {
     constructor(domainMemberships, email, emailVerified, domainIdEmail, tagId) {
@@ -314,6 +354,20 @@ class Person extends Tag {
     }
 }
 exports.Person = Person;
+exports.ArticleQL = `
+type Article {${exports.PrimitiveFields}
+  referenceBlock: ReferenceBlock!
+  sentiment: DocumentSentiment
+  dates: [EntityEntry]
+  locations: [EntityEntry]
+  organizations: [EntityEntry]
+  names: [EntityEntry]
+  sentiments: [EntityEntry]
+  topics: [EntityEntry]
+  mentions: [EntityEntry]
+  relations: [RelationEntry]
+  linkUrls: [String]
+}`;
 class Article extends Primitive {
     constructor(referenceBlock) {
         super();
@@ -321,17 +375,14 @@ class Article extends Primitive {
     }
 }
 exports.Article = Article;
-exports.BlockFields = `
+exports.BlockFields = `${exports.PrimitiveFields}
   editors: [Editor]!
   sharingTags: [SharingTag]!
   version: Float!
   blockType: String!
-	archived: Boolean!
-	_ignoreUpdate: Boolean!
-	document: String
-	changes: Changes
-	_sharedTags: [String]
-	reactions: [Reaction]`;
+  archived: Boolean!
+  document: String
+  reactions: [Reaction]`;
 class Block extends Primitive {
     constructor(tenantIdCreated, editors, sharingTags, version, blockType) {
         super();
@@ -358,6 +409,19 @@ class BlockProcessingResponse {
     }
 }
 exports.BlockProcessingResponse = BlockProcessingResponse;
+exports.BusinessObjectQL = `
+type BusinessObject {${exports.BlockFields}
+  provider: String!
+  application: String!
+  uri: String!
+  processingStage: String!
+  processingAttempts: Int!
+  dateProcessed: Float!
+  externalId: String!
+  processingReason: String
+  iconUrl: String
+  parentId: String
+}`;
 class BusinessObject extends Block {
     constructor(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri, externalId) {
         super(tenantIdCreated, editors, sharingTags, version, blockType);
@@ -373,7 +437,7 @@ class BusinessObject extends Block {
 }
 exports.BusinessObject = BusinessObject;
 exports.NoteQL = `
-type Note { ${exports.BlockFields}
+type Note {${exports.BlockFields}
 }`;
 class Note extends Block {
     constructor(tenantIdCreated, editors, sharingTags, version) {
@@ -382,6 +446,17 @@ class Note extends Block {
     }
 }
 exports.Note = Note;
+exports.TaskQL = `
+type Task {${exports.BlockFields}
+  status: String!
+  dueDate: Int!
+  originNoteId: String!
+  snoozed: Boolean!
+  dateRemindMe: Int
+  recurrence: [String]
+  parentId: String
+  groupId: String
+}`;
 class Task extends Block {
     constructor(tenantIdCreated, editors, sharingTags, version, originNoteId, dateDue) {
         super(tenantIdCreated, editors, sharingTags, version, BlockType.Task);
@@ -496,16 +571,111 @@ class Table extends BusinessObject {
 exports.Table = Table;
 //// FOR RECORDS END
 // METADATA OBJECTS END
+// API OBJECTS START
+exports.FindArticleInputQL = `
+type FindArticleInput {
+  originBlockId: String!
+  type: String!
+}`;
+exports.FindArticlesInputQL = `
+type FindArticlesInput {
+  originBlockId: String!
+  type: String!
+}`;
+exports.FindCalendarInputQL = `
+type FindCalendarInput {
+  _id: String!
+}`;
+exports.FindEventInputQL = `
+type FindEventInput {
+  _id: String!
+}`;
+exports.InsertNoteInputQL = `
+type InsertNoteInput {
+  document: String!
+  editor: Editor!
+  changes: Changes!
+}`;
+exports.UpsertNoteInputQL = `
+type UpsertNoteInput {
+  _id: String!
+  document: String!
+  editor: Editor!
+  changes: Changes!
+}`;
+exports.FindNoteInputQL = `
+type FindNoteInput {
+  _id: String!
+  archived: Boolean
+}`;
+exports.FindNotesInputQL = `
+type FindNotesInput {
+  tagIds: [String]
+  archived: Boolean
+}`;
+exports.ArchiveNoteInputQL = `
+type ArchiveNoteInput {
+  _id: String!
+  archived: Boolean
+}`;
+exports.FindProviderInputQL = `
+type FindProviderInput {
+  provider: String!
+}`;
+exports.FindSyncInputQL = `
+type FindSyncInput {
+  _id: String!
+}`;
+exports.FindTaskInputQL = `
+type FindTaskInput {
+  _id: String!
+	archived: Boolean
+}`;
+exports.FindTasksInputQL = `
+type FindTasksInput {
+  originNoteId: String
+  tagIds: [String]
+	archived: Boolean
+}`;
+exports.ArchiveTaskInputQL = `
+type ArchiveTaskInput {
+  _id: String!
+	archived: Boolean
+}`;
+// THE GRAPH QL DEFINITIONS
 exports.GraphQLTypes = `
+${exports.HighlightQL}
 ${exports.EditorQL}
 ${exports.SharingTagQL}
 ${exports.ReactionSkinToneQL}
 ${exports.ReactionQL}
+${exports.DocumentSentimentQL}
+${exports.EntityReferenceQL}
+${exports.ArgumentEntryQL}
+${exports.RelationEntryQL}
+${exports.EntityEntryQL}
 ${exports.ProviderInfoQL}
 ${exports.ProviderRequestQL}
 ${exports.CredentialQL}
 ${exports.ChangesQL}
 ${exports.ConnectedProviderQL}
+${exports.ReferenceBlockQL}
+${exports.ArticleQL}
 ${exports.TenantQL}
+${exports.BusinessObjectQL}
 ${exports.NoteQL}
-`;
+${exports.TaskQL}
+${exports.FindArticleInputQL}
+${exports.FindArticlesInputQL}
+${exports.FindCalendarInputQL}
+${exports.FindEventInputQL}
+${exports.InsertNoteInputQL}
+${exports.UpsertNoteInputQL}
+${exports.FindNoteInputQL}
+${exports.FindNotesInputQL}
+${exports.ArchiveNoteInputQL}
+${exports.FindProviderInputQL}
+${exports.FindSyncInputQL}
+${exports.FindTaskInputQL}
+${exports.FindTasksInputQL}
+${exports.ArchiveTaskInputQL}`;

package/model.ts

@@ -184,6 +184,11 @@ export interface Mark {
 	attrs?: Attrs;
 }
 
+export const HighlightQL = `
+type Highlight {
+  indexStart: Int!
+  indexEnd: Int!
+}`;
 export interface Highlight {
 	indexStart: number;
 	indexEnd: number;
@@ -201,7 +206,7 @@ export const EditorQL = `
 type Editor {
   clientType: String!
   clientId: String!
-	tenantId: String
+  tenantId: String
 }`;
 export interface Editor {
 	clientType: ClientType;
@@ -213,8 +218,8 @@ export const SharingTagQL = `
 type SharingTag {
   tagId: String!
   isShared: Boolean!
-	sharingApproach: String!
-	sharingLevel: String!
+  sharingApproach: String!
+  sharingLevel: String!
 }`;
 export interface SharingTag {
 	tagId: string;
@@ -261,22 +266,45 @@ export interface Step {
 	status: StepStatus;
 }
 
+export const DocumentSentimentQL = `
+type DocumentSentiment {
+  name: String!
+  score: Int!
+}`;
 export interface DocumentSentiment {
 	name: string;
 	score: number;
 }
 
+export const EntityReferenceQL = `
+type EntityReference {
+  name: String!
+  type: String!
+}`;
 export interface EntityReference {
 	name: string;
 	type: EntityType;
 }
 
+export const ArgumentEntryQL = `
+type ArgumentEntry {
+  text: String!
+  highlight: Highlight!
+  entities: [EntityReference]!
+}`;
 export interface ArgumentEntry {
 	text: string;
 	highlight: Highlight;
 	entities: EntityReference[];
 }
 
+export const RelationEntryQL = `
+type RelationEntry {
+  type: String!
+  score: Int!
+  highlight: Highlight!
+  arguments: [ArgumentEntry]!
+}`;
 export interface RelationEntry {
 	type: RelationType;
 	score: number;
@@ -284,6 +312,18 @@ export interface RelationEntry {
 	arguments: ArgumentEntry[];
 }
 
+export const MachineLearningEntryFields = `
+  highlights: [Highlight]`;
+export interface MachineLearningEntry {
+	highlights?: Highlight[];
+}
+
+export const EntityEntryQL = `
+type EntityEntry {${MachineLearningEntryFields}
+  name: String!
+  type: String!
+  score: Int!
+}`;
 export interface EntityEntry extends MachineLearningEntry {
 	name: string;
 	type: EntityType;
@@ -294,10 +334,6 @@ export interface DateEntityEntry extends EntityEntry {
 	date: number;
 }
 
-export interface MachineLearningEntry {
-	highlights?: Highlight[];
-}
-
 export const ProviderInfoQL = `
 type ProviderInfo {
   provider: String!
@@ -373,6 +409,12 @@ export interface ConnectedProvider {
 	dateUpdated: number;
 }
 
+export const ReferenceBlockQL = `
+type ReferenceBlock {
+  id: String!
+  version: Int!
+  type: String!
+}`;
 export interface ReferenceBlock {
 	id: string;
 	version: number;
@@ -465,16 +507,14 @@ export class Tag extends Primitive {
 }
 
 export const TenantQL = `
-type Tenant { ${PrimitiveFields}
+type Tenant {${PrimitiveFields}
   domainMemberships: [String]!
   email: String!
-  emailVerified: Boolean!
   domainIdEmail: String!
   tagId: String!
   picture: String
   familyName: String
   givenName: String
-  connectedProviders: [ConnectedProvider]
 }`;
 export class Tenant extends Primitive {
 	domainMemberships: string[]; // The list of all domains this tenant belongs
@@ -534,6 +574,20 @@ export class Person extends Tag {
 	}
 }
 
+export const ArticleQL = `
+type Article {${PrimitiveFields}
+  referenceBlock: ReferenceBlock!
+  sentiment: DocumentSentiment
+  dates: [EntityEntry]
+  locations: [EntityEntry]
+  organizations: [EntityEntry]
+  names: [EntityEntry]
+  sentiments: [EntityEntry]
+  topics: [EntityEntry]
+  mentions: [EntityEntry]
+  relations: [RelationEntry]
+  linkUrls: [String]
+}`;
 export class Article extends Primitive {
 	referenceBlock: ReferenceBlock;
 	changes?: Changes;
@@ -558,17 +612,14 @@ export class Article extends Primitive {
 	}
 }
 
-export const BlockFields = `
+export const BlockFields = `${PrimitiveFields}
   editors: [Editor]!
   sharingTags: [SharingTag]!
   version: Float!
   blockType: String!
-	archived: Boolean!
-	_ignoreUpdate: Boolean!
-	document: String
-	changes: Changes
-	_sharedTags: [String]
-	reactions: [Reaction]`;
+  archived: Boolean!
+  document: String
+  reactions: [Reaction]`;
 export class Block extends Primitive {
 	editors: Editor[];
 	sharingTags: SharingTag[];
@@ -620,6 +671,19 @@ export class BlockProcessingResponse {
 	}
 }
 
+export const BusinessObjectQL = `
+type BusinessObject {${BlockFields}
+  provider: String!
+  application: String!
+  uri: String!
+  processingStage: String!
+  processingAttempts: Int!
+  dateProcessed: Float!
+  externalId: String!
+  processingReason: String
+  iconUrl: String
+  parentId: String
+}`;
 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
@@ -660,7 +724,7 @@ export class BusinessObject extends Block {
 }
 
 export const NoteQL = `
-type Note { ${BlockFields}
+type Note {${BlockFields}
 }`;
 export class Note extends Block {
 	constructor(
@@ -675,6 +739,17 @@ export class Note extends Block {
 	}
 }
 
+export const TaskQL = `
+type Task {${BlockFields}
+  status: String!
+  dueDate: Int!
+  originNoteId: String!
+  snoozed: Boolean!
+  dateRemindMe: Int
+  recurrence: [String]
+  parentId: String
+  groupId: String
+}`;
 export class Task extends Block {
 	status: TaskStatus;
 	dateDue: number;
@@ -1122,16 +1197,181 @@ export class Table extends BusinessObject {
 
 // METADATA OBJECTS END
 
+// API OBJECTS START
+export const FindArticleInputQL = `
+type FindArticleInput {
+  originBlockId: String!
+  type: String!
+}`;
+export interface FindArticleInput {
+	originBlockId: string;
+	type: BlockType;
+}
+
+export const FindArticlesInputQL = `
+type FindArticlesInput {
+  originBlockId: String!
+  type: String!
+}`;
+export interface FindArticlesInput {
+	originBlockId: string;
+	type: BlockType;
+}
+
+export const FindCalendarInputQL = `
+type FindCalendarInput {
+  _id: String!
+}`;
+export interface FindCalendarInput {
+	_id: string;
+}
+
+export const FindEventInputQL = `
+type FindEventInput {
+  _id: String!
+}`;
+export interface FindEventInput {
+	_id: string;
+}
+
+export const InsertNoteInputQL = `
+type InsertNoteInput {
+  document: String!
+  editor: Editor!
+  changes: Changes!
+}`;
+export interface InsertNoteInput {
+	document: string;
+	editor: Editor;
+	changes: Changes;
+}
+
+export const UpsertNoteInputQL = `
+type UpsertNoteInput {
+  _id: String!
+  document: String!
+  editor: Editor!
+  changes: Changes!
+}`;
+export interface UpsertNoteInput {
+	_id: string;
+	document: string;
+	editor: Editor;
+	version: number;
+}
+
+export const FindNoteInputQL = `
+type FindNoteInput {
+  _id: String!
+  archived: Boolean
+}`;
+export interface FindNoteInput {
+	_id: string;
+	archived?: boolean;
+}
+
+export const FindNotesInputQL = `
+type FindNotesInput {
+  tagIds: [String]
+  archived: Boolean
+}`;
+export interface FindNotesInput {
+	tagIds?: string[];
+	archived?: boolean;
+}
+
+export const ArchiveNoteInputQL = `
+type ArchiveNoteInput {
+  _id: String!
+  archived: Boolean
+}`;
+export interface ArchiveNoteInput {
+	_id: string;
+	archive?: boolean;
+}
+
+export const FindProviderInputQL = `
+type FindProviderInput {
+  provider: String!
+}`;
+export interface FindProviderInput {
+	provider: string;
+}
+
+export const FindSyncInputQL = `
+type FindSyncInput {
+  _id: String!
+}`;
+export interface FindSyncInput {
+	_id: string;
+}
+
+export const FindTaskInputQL = `
+type FindTaskInput {
+  _id: String!
+	archived: Boolean
+}`;
+export interface FindTaskInput {
+	_id: string;
+	archived?: boolean;
+}
+
+export const FindTasksInputQL = `
+type FindTasksInput {
+  originNoteId: String
+  tagIds: [String]
+	archived: Boolean
+}`;
+export interface FindTasksInput {
+	originNoteId?: string;
+	tagIds?: string[];
+	archived?: boolean;
+}
+
+export const ArchiveTaskInputQL = `
+type ArchiveTaskInput {
+  _id: String!
+	archived: Boolean
+}`;
+export interface ArchiveTaskInput {
+	_id: string;
+	archive?: boolean;
+}
+
+// THE GRAPH QL DEFINITIONS
 export const GraphQLTypes = `
+${HighlightQL}
 ${EditorQL}
 ${SharingTagQL}
 ${ReactionSkinToneQL}
 ${ReactionQL}
+${DocumentSentimentQL}
+${EntityReferenceQL}
+${ArgumentEntryQL}
+${RelationEntryQL}
+${EntityEntryQL}
 ${ProviderInfoQL}
 ${ProviderRequestQL}
 ${CredentialQL}
 ${ChangesQL}
 ${ConnectedProviderQL}
+${ReferenceBlockQL}
+${ArticleQL}
 ${TenantQL}
+${BusinessObjectQL}
 ${NoteQL}
-`;
+${TaskQL}
+${FindArticleInputQL}
+${FindArticlesInputQL}
+${FindCalendarInputQL}
+${FindEventInputQL}
+${InsertNoteInputQL}
+${UpsertNoteInputQL}
+${FindNoteInputQL}
+${FindNotesInputQL}
+${ArchiveNoteInputQL}
+${FindProviderInputQL}
+${FindSyncInputQL}
+${FindTaskInputQL}
+${FindTasksInputQL}
+${ArchiveTaskInputQL}`;

package/package.json

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