@bigfootai/bigfoot-types 2.11.5 → 2.11.7

package/model.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GraphQLTypes = 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.BlockProcessingResponse = exports.BlockProcessingRequest = exports.Block = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.TenantFields = exports.Tag = exports.Provider = exports.Sync = exports.Primitive = exports.PrimitiveFields = exports.ConnectedProviderFields = exports.CredentialFields = exports.ProviderRequestFields = exports.ProviderInfoFields = 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.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.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
@@ -176,39 +177,109 @@ var RelationType;
     RelationType["SpouseOf"] = "spouseOf";
     RelationType["SubsidiaryOf"] = "subsidiaryOf";
 })(RelationType || (exports.RelationType = RelationType = {}));
-exports.ProviderInfoFields = `
+exports.HighlightQL = `
+type Highlight {
+  indexStart: Int!
+  indexEnd: Int!
+}`;
+exports.EditorQL = `
+type Editor {
+  clientType: String!
+  clientId: String!
+  tenantId: String
+}`;
+exports.SharingTagQL = `
+type SharingTag {
+  tagId: String!
+  isShared: Boolean!
+  sharingApproach: String!
+  sharingLevel: String!
+}`;
+exports.ReactionSkinToneQL = `
+type ReactionSkinTone {
+  skinTone: String!
+  tenantIds: [String]!
+}`;
+exports.ReactionQL = `
+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!
   application: String!
 }`;
-exports.ProviderRequestFields = `
+exports.ProviderRequestQL = `
 type ProviderRequest {
   providerInfo: ID!
   connectionId: String!
 }`;
-exports.CredentialFields = `
+exports.CredentialQL = `
 type Credential {
-	email: String!
-	profile: String!
-	accessToken: String!
-	refreshToken: String
-	instanceUrl: String
-	dateExpiry: Float
+  email: String!
+  profile: String!
+  accessToken: String!
+  refreshToken: String
+  instanceUrl: String
+  dateExpiry: Float
 }`;
-exports.ConnectedProviderFields = `
+exports.ConnectedProviderQL = `
 type ConnectedProvider {
-	providerId: String!
-	connectionId: String!
-	application: String!
-	credential: Credential
-	dateCreated: Float
-	dateUpdated: Float
+  providerId: String!
+  connectionId: String!
+  application: String!
+  credential: Credential
+  dateCreated: Float
+  dateUpdated: Float
+}`;
+exports.ReferenceBlockQL = `
+type ReferenceBlock {
+  id: String!
+  version: Int!
+  type: String!
+}`;
+exports.ChangesQL = `
+type Changes {
+  steps: [String]!
+  clientIds: [String]!
 }`;
 exports.PrimitiveFields = `
   _id: ID!
   dateCreated: Float!
-	dateUpdated: Float!
-	tenantIdCreated: String`;
+  dateUpdated: Float!
+  tenantIdCreated: String`;
 class Primitive {
     constructor() {
         this._id = (0, uuid_1.v4)();
@@ -246,19 +317,16 @@ class Tag extends Primitive {
     }
 }
 exports.Tag = Tag;
-exports.TenantFields = `
-type Tenant { ${exports.PrimitiveFields}
-	domainMemberships: [String]!
-	email: String!
-	emailVerified: Boolean!
-	domainIdEmail: String!
-	tagId: String!
-	picture: String
-	familyName: String
-	givenName: String
-	connectedProviders: [ConnectedProvider]
-}
-`;
+exports.TenantQL = `
+type Tenant {${exports.PrimitiveFields}
+  domainMemberships: [String]!
+  email: String!
+  domainIdEmail: String!
+  tagId: String!
+  picture: String
+  familyName: String
+  givenName: String
+}`;
 class Tenant extends Primitive {
     constructor(domainMemberships, email, emailVerified, domainIdEmail, tagId) {
         super();
@@ -286,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();
@@ -293,6 +375,14 @@ class Article extends Primitive {
     }
 }
 exports.Article = Article;
+exports.BlockFields = `${exports.PrimitiveFields}
+  editors: [Editor]!
+  sharingTags: [SharingTag]!
+  version: Float!
+  blockType: String!
+  archived: Boolean!
+  document: String
+  reactions: [Reaction]`;
 class Block extends Primitive {
     constructor(tenantIdCreated, editors, sharingTags, version, blockType) {
         super();
@@ -319,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);
@@ -333,6 +436,9 @@ class BusinessObject extends Block {
     }
 }
 exports.BusinessObject = BusinessObject;
+exports.NoteQL = `
+type Note {${exports.BlockFields}
+}`;
 class Note extends Block {
     constructor(tenantIdCreated, editors, sharingTags, version) {
         super(tenantIdCreated, editors, sharingTags, version, BlockType.Note);
@@ -340,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);
@@ -455,9 +572,24 @@ exports.Table = Table;
 //// FOR RECORDS END
 // METADATA OBJECTS END
 exports.GraphQLTypes = `
-${exports.ProviderInfoFields}
-${exports.ProviderRequestFields}
-${exports.CredentialFields}
-${exports.ConnectedProviderFields}
-${exports.TenantFields}
-`;
+${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}`;

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;
@@ -197,12 +202,25 @@ export interface Document {
 	marks?: Mark[];
 }
 
+export const EditorQL = `
+type Editor {
+  clientType: String!
+  clientId: String!
+  tenantId: String
+}`;
 export interface Editor {
 	clientType: ClientType;
 	clientId: string;
 	tenantId?: string;
 }
 
+export const SharingTagQL = `
+type SharingTag {
+  tagId: String!
+  isShared: Boolean!
+  sharingApproach: String!
+  sharingLevel: String!
+}`;
 export interface SharingTag {
 	tagId: string;
 	isShared: boolean;
@@ -223,37 +241,70 @@ export interface SharingTenant {
 	sharingLevel: SharingLevel; // Determines what tenants can do with the tag beyond tenant specific settings above
 }
 
-export interface Reaction {
-	skinTones: ReactionSkinTone[];
-	unified: string;
-}
-
+export const ReactionSkinToneQL = `
+type ReactionSkinTone {
+  skinTone: String!
+  tenantIds: [String]!
+}`;
 export interface ReactionSkinTone {
 	skinTone: string;
 	tenantIds: string[];
 }
 
+export const ReactionQL = `
+type Reaction {
+  skinTones: [ReactionSkinTone]!
+  unified: String!
+}`;
+export interface Reaction {
+	skinTones: ReactionSkinTone[];
+	unified: string;
+}
+
 export interface Step {
 	content: string;
 	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;
@@ -261,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;
@@ -271,11 +334,7 @@ export interface DateEntityEntry extends EntityEntry {
 	date: number;
 }
 
-export interface MachineLearningEntry {
-	highlights?: Highlight[];
-}
-
-export const ProviderInfoFields = `
+export const ProviderInfoQL = `
 type ProviderInfo {
   provider: String!
   application: String!
@@ -285,7 +344,7 @@ export interface ProviderInfo {
 	application: string;
 }
 
-export const ProviderRequestFields = `
+export const ProviderRequestQL = `
 type ProviderRequest {
   providerInfo: ID!
   connectionId: String!
@@ -309,14 +368,14 @@ export interface Subscriptions {
 	linkDomains: string[];
 }
 
-export const CredentialFields = `
+export const CredentialQL = `
 type Credential {
-	email: String!
-	profile: String!
-	accessToken: String!
-	refreshToken: String
-	instanceUrl: String
-	dateExpiry: Float
+  email: String!
+  profile: String!
+  accessToken: String!
+  refreshToken: String
+  instanceUrl: String
+  dateExpiry: Float
 }`;
 export interface Credential {
 	email: string;
@@ -332,14 +391,14 @@ export interface ConnectedProviderRegistration {
 	credential: Credential;
 }
 
-export const ConnectedProviderFields = `
+export const ConnectedProviderQL = `
 type ConnectedProvider {
-	providerId: String!
-	connectionId: String!
-	application: String!
-	credential: Credential
-	dateCreated: Float
-	dateUpdated: Float
+  providerId: String!
+  connectionId: String!
+  application: String!
+  credential: Credential
+  dateCreated: Float
+  dateUpdated: Float
 }`;
 export interface ConnectedProvider {
 	providerId: string;
@@ -350,12 +409,23 @@ export interface ConnectedProvider {
 	dateUpdated: number;
 }
 
+export const ReferenceBlockQL = `
+type ReferenceBlock {
+  id: String!
+  version: Int!
+  type: String!
+}`;
 export interface ReferenceBlock {
 	id: string;
 	version: number;
 	type: BlockType;
 }
 
+export const ChangesQL = `
+type Changes {
+  steps: [String]!
+  clientIds: [String]!
+}`;
 export interface Changes {
 	steps: any[];
 	clientIds: string[];
@@ -368,8 +438,8 @@ export interface PersonReference {
 export const PrimitiveFields = `
   _id: ID!
   dateCreated: Float!
-	dateUpdated: Float!
-	tenantIdCreated: String`;
+  dateUpdated: Float!
+  tenantIdCreated: String`;
 export class Primitive {
 	_id: string;
 	dateCreated: number;
@@ -436,19 +506,16 @@ export class Tag extends Primitive {
 	}
 }
 
-export const TenantFields = `
-type Tenant { ${PrimitiveFields}
-	domainMemberships: [String]!
-	email: String!
-	emailVerified: Boolean!
-	domainIdEmail: String!
-	tagId: String!
-	picture: String
-	familyName: String
-	givenName: String
-	connectedProviders: [ConnectedProvider]
-}
-`;
+export const TenantQL = `
+type Tenant {${PrimitiveFields}
+  domainMemberships: [String]!
+  email: String!
+  domainIdEmail: String!
+  tagId: String!
+  picture: String
+  familyName: String
+  givenName: String
+}`;
 export class Tenant extends Primitive {
 	domainMemberships: string[]; // The list of all domains this tenant belongs
 	email: string;
@@ -507,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;
@@ -531,6 +612,14 @@ export class Article extends Primitive {
 	}
 }
 
+export const BlockFields = `${PrimitiveFields}
+  editors: [Editor]!
+  sharingTags: [SharingTag]!
+  version: Float!
+  blockType: String!
+  archived: Boolean!
+  document: String
+  reactions: [Reaction]`;
 export class Block extends Primitive {
 	editors: Editor[];
 	sharingTags: SharingTag[];
@@ -582,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
@@ -621,6 +723,9 @@ export class BusinessObject extends Block {
 	}
 }
 
+export const NoteQL = `
+type Note {${BlockFields}
+}`;
 export class Note extends Block {
 	constructor(
 		tenantIdCreated: string,
@@ -634,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;
@@ -1082,9 +1198,24 @@ export class Table extends BusinessObject {
 // METADATA OBJECTS END
 
 export const GraphQLTypes = `
-${ProviderInfoFields}
-${ProviderRequestFields}
-${CredentialFields}
-${ConnectedProviderFields}
-${TenantFields}
-`;
+${HighlightQL}
+${EditorQL}
+${SharingTagQL}
+${ReactionSkinToneQL}
+${ReactionQL}
+${DocumentSentimentQL}
+${EntityReferenceQL}
+${ArgumentEntryQL}
+${RelationEntryQL}
+${EntityEntryQL}
+${ProviderInfoQL}
+${ProviderRequestQL}
+${CredentialQL}
+${ChangesQL}
+${ConnectedProviderQL}
+${ReferenceBlockQL}
+${ArticleQL}
+${TenantQL}
+${BusinessObjectQL}
+${NoteQL}
+${TaskQL}`;

package/package.json

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