@bigfootai/bigfoot-types 3.0.5 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/model.js +36 -10
  2. package/model.ts +43 -10
  3. package/package.json +1 -1
package/model.js CHANGED
@@ -1,7 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- 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;
4
- 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;
3
+ exports.Domain = exports.Tenant = exports.TenantQL = exports.TagRecommendationQL = 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.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;
4
+ 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;
5
+ exports.GraphQLTypes = exports.SearchInputQL = void 0;
5
6
  const uuid_1 = require("uuid");
6
7
  /*
7
8
  These are the core primitives of our model. These represent the entities that show
@@ -64,6 +65,18 @@ var InviteStatus;
64
65
  InviteStatus[InviteStatus["InviteSent"] = 1] = "InviteSent";
65
66
  InviteStatus[InviteStatus["InviteAccepted"] = 2] = "InviteAccepted";
66
67
  })(InviteStatus || (exports.InviteStatus = InviteStatus = {}));
68
+ var TagRecommendationType;
69
+ (function (TagRecommendationType) {
70
+ TagRecommendationType["TagMissing"] = "missing";
71
+ TagRecommendationType["TagCreated"] = "created";
72
+ TagRecommendationType["TagFound"] = "found";
73
+ TagRecommendationType["MultipleTagsFound"] = "multiple_found";
74
+ TagRecommendationType["TagCreationFailed"] = "creation_failed";
75
+ })(TagRecommendationType || (exports.TagRecommendationType = TagRecommendationType = {}));
76
+ var TagRecommendationVariation;
77
+ (function (TagRecommendationVariation) {
78
+ TagRecommendationVariation["TypeChange"] = "type_change";
79
+ })(TagRecommendationVariation || (exports.TagRecommendationVariation = TagRecommendationVariation = {}));
67
80
  var RecurrenceRFC;
68
81
  (function (RecurrenceRFC) {
69
82
  RecurrenceRFC["FREQ"] = "FREQ";
@@ -235,10 +248,16 @@ type RelationEntry {
235
248
  confidence: Int!
236
249
  arguments: [ArgumentEntry]!
237
250
  }`;
238
- exports.EntityEntryQL = `
239
- type EntityEntry {
251
+ exports.EntityEntryFields = `
240
252
  text: String!
241
253
  confidence: Int!
254
+ `;
255
+ exports.EntityEntryQL = `
256
+ type EntityEntry {${exports.EntityEntryFields}
257
+ }`;
258
+ exports.DateEntityEntryQL = `
259
+ type EntityEntry {${exports.EntityEntryFields}
260
+ date: Float!
242
261
  }`;
243
262
  exports.ProviderInfoQL = `
244
263
  type ProviderInfo {
@@ -344,6 +363,13 @@ class Tag extends Primitive {
344
363
  }
345
364
  }
346
365
  exports.Tag = Tag;
366
+ exports.TagRecommendationQL = `
367
+ type TagRecommendation {
368
+ type: String!
369
+ tags: [Tag]!
370
+ entity: EntityEntry!
371
+ variation: String
372
+ }`;
347
373
  exports.TenantQL = `
348
374
  type Tenant {${exports.PrimitiveFields}
349
375
  domainMemberships: [String]!
@@ -391,13 +417,11 @@ type Article {${exports.PrimitiveFields}
391
417
  sentiment: DocumentSentiment
392
418
  dates: [EntityEntry]
393
419
  locations: [EntityEntry]
394
- organizations: [EntityEntry]
395
- names: [EntityEntry]
396
- sentiments: [EntityEntry]
397
- topics: [EntityEntry]
398
- mentions: [EntityEntry]
399
- relations: [RelationEntry]
400
420
  linkUrls: [String]
421
+ sharingTags: [SharingTag]
422
+ recommendations: [TagRecommendation]
423
+ relations: [RelationEntry]
424
+ archived: Boolean!
401
425
  }`;
402
426
  class Article extends Primitive {
403
427
  constructor(referenceBlock) {
@@ -763,6 +787,7 @@ ${exports.EntityReferenceQL}
763
787
  ${exports.ArgumentEntryQL}
764
788
  ${exports.RelationEntryQL}
765
789
  ${exports.EntityEntryQL}
790
+ ${exports.DateEntityEntryQL}
766
791
  ${exports.ProviderInfoQL}
767
792
  ${exports.ProviderRequestQL}
768
793
  ${exports.CredentialQL}
@@ -771,6 +796,7 @@ ${exports.ChangesQL}
771
796
  ${exports.PersonReferenceQL}
772
797
  ${exports.SyncQL}
773
798
  ${exports.ProviderQL}
799
+ ${exports.TagRecommendationQL}
774
800
  ${exports.ConnectedProviderQL}
775
801
  ${exports.ReferenceBlockQL}
776
802
  ${exports.ArticleQL}
package/model.ts CHANGED
@@ -61,6 +61,18 @@ export enum InviteStatus {
61
61
  InviteAccepted = 2,
62
62
  }
63
63
 
64
+ export enum TagRecommendationType {
65
+ TagMissing = 'missing',
66
+ TagCreated = 'created',
67
+ TagFound = 'found',
68
+ MultipleTagsFound = 'multiple_found',
69
+ TagCreationFailed = 'creation_failed',
70
+ }
71
+
72
+ export enum TagRecommendationVariation {
73
+ TypeChange = 'type_change',
74
+ }
75
+
64
76
  export enum RecurrenceRFC {
65
77
  FREQ = 'FREQ', // The frequency of the event (e.g., DAILY, WEEKLY, MONTHLY, YEARLY).
66
78
  UNTIL = 'UNTIL', // A date until when the event should occur.
@@ -325,10 +337,12 @@ export interface MachineLearningEntry {
325
337
  _highlights?: Highlight[];
326
338
  }
327
339
 
328
- export const EntityEntryQL = `
329
- type EntityEntry {
340
+ export const EntityEntryFields = `
330
341
  text: String!
331
342
  confidence: Int!
343
+ `;
344
+ export const EntityEntryQL = `
345
+ type EntityEntry {${EntityEntryFields}
332
346
  }`;
333
347
  export interface EntityEntry extends MachineLearningEntry {
334
348
  text: string;
@@ -342,6 +356,10 @@ export interface EntityEntry extends MachineLearningEntry {
342
356
  _dbpedia?: string;
343
357
  }
344
358
 
359
+ export const DateEntityEntryQL = `
360
+ type EntityEntry {${EntityEntryFields}
361
+ date: Float!
362
+ }`;
345
363
  export interface DateEntityEntry extends EntityEntry {
346
364
  date: number;
347
365
  }
@@ -541,6 +559,20 @@ export class Tag extends Primitive {
541
559
  }
542
560
  }
543
561
 
562
+ export const TagRecommendationQL = `
563
+ type TagRecommendation {
564
+ type: String!
565
+ tags: [Tag]!
566
+ entity: EntityEntry!
567
+ variation: String
568
+ }`;
569
+ export interface TagRecommendation {
570
+ type: TagRecommendationType;
571
+ tags: Tag[];
572
+ entity: EntityEntry;
573
+ variation?: TagRecommendationVariation;
574
+ }
575
+
544
576
  export const TenantQL = `
545
577
  type Tenant {${PrimitiveFields}
546
578
  domainMemberships: [String]!
@@ -604,6 +636,7 @@ export class Organization extends Tag {
604
636
 
605
637
  export class Person extends Tag {
606
638
  email?: string;
639
+ avatar?: string;
607
640
  inviteStatus?: InviteStatus;
608
641
  tenantIdVerified?: string; // The tenant._id that claimed/verified this tag as being them
609
642
 
@@ -618,13 +651,11 @@ type Article {${PrimitiveFields}
618
651
  sentiment: DocumentSentiment
619
652
  dates: [EntityEntry]
620
653
  locations: [EntityEntry]
621
- organizations: [EntityEntry]
622
- names: [EntityEntry]
623
- sentiments: [EntityEntry]
624
- topics: [EntityEntry]
625
- mentions: [EntityEntry]
626
- relations: [RelationEntry]
627
654
  linkUrls: [String]
655
+ sharingTags: [SharingTag]
656
+ recommendations: [TagRecommendation]
657
+ relations: [RelationEntry]
658
+ archived: Boolean!
628
659
  }`;
629
660
  export class Article extends Primitive {
630
661
  referenceBlock: ReferenceBlock;
@@ -632,10 +663,10 @@ export class Article extends Primitive {
632
663
  sentiment?: DocumentSentiment;
633
664
  dates?: EntityEntry[];
634
665
  locations?: EntityEntry[];
635
- sentiments?: EntityEntry[];
636
- relations?: RelationEntry[];
637
666
  linkUrls?: string[];
638
667
  sharingTags?: SharingTag[];
668
+ recommendations?: TagRecommendation[];
669
+ relations?: RelationEntry[];
639
670
  archived: boolean;
640
671
  _changes?: Changes;
641
672
  _tasks?: Task[];
@@ -1471,6 +1502,7 @@ ${EntityReferenceQL}
1471
1502
  ${ArgumentEntryQL}
1472
1503
  ${RelationEntryQL}
1473
1504
  ${EntityEntryQL}
1505
+ ${DateEntityEntryQL}
1474
1506
  ${ProviderInfoQL}
1475
1507
  ${ProviderRequestQL}
1476
1508
  ${CredentialQL}
@@ -1479,6 +1511,7 @@ ${ChangesQL}
1479
1511
  ${PersonReferenceQL}
1480
1512
  ${SyncQL}
1481
1513
  ${ProviderQL}
1514
+ ${TagRecommendationQL}
1482
1515
  ${ConnectedProviderQL}
1483
1516
  ${ReferenceBlockQL}
1484
1517
  ${ArticleQL}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "Bigfoot",
3
3
  "name": "@bigfootai/bigfoot-types",
4
- "version": "3.0.5",
4
+ "version": "3.1.1",
5
5
  "description": "The internal library for the types used in the Bigfoot platform",
6
6
  "main": "model.js",
7
7
  "license": "ISC",