@bigfootai/bigfoot-types 4.9.5 → 4.9.7

package/model.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CredentialQL = exports.StandardObjectsQL = exports.ProviderResponseQL = exports.ProviderRequestQL = exports.ProviderInfoQL = exports.EntityEntryQL = exports.EntityEntryFields = exports.RelationEntryQL = exports.ArgumentEntryQL = exports.EntityReferenceQL = exports.DocumentSentimentQL = exports.TaskStepQL = exports.TaskStepInputQL = exports.ReactionQL = exports.ReactionSkinToneQL = exports.BusinessObjectLinkQL = exports.BusinessObjectLinkInputQL = exports.SharingTenantQL = exports.TenantSettingQL = exports.SharingDomainQL = exports.SharingTagQL = exports.SharingTagInputQL = exports.InviteSharingTagInputQL = exports.EditorQL = exports.EditorInputQL = exports.HighlightQL = exports.RelationType = exports.EntityType = exports.RecordType = exports.ThumbsDirection = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.TagRecommendationType = exports.InviteStatus = exports.OrderByDirection = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.TaskPriority = exports.AccessType = exports.SharingLevel = exports.ClientType = exports.ExportType = exports.TagType = exports.UpsertType = exports.RecommendationType = exports.BlockType = void 0;
-exports.BlockProcessingRequest = exports.Block = exports.BlockFieldsForUpsert = exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = exports.Organization = exports.Domain = exports.DomainQL = exports.Tenant = exports.TenantQL = exports.Recommendation = exports.RecommendationQL = exports.ShareRecommendationQL = exports.UpsertRecommendationQL = exports.ConnectRecommendationQL = exports.TenantLight = exports.TenantLightQL = exports.TagRecommendationQL = exports.Tag = exports.TagQL = exports.TagFieldsJustSharing = exports.TagFieldsWithoutSharing = exports.Provider = exports.ProviderQL = exports.ProviderApplicationQL = exports.BusinessObjectLinkingToTagQL = exports.Sync = exports.SyncQL = exports.Search = exports.SearchQL = exports.Folder = exports.FolderQL = exports.Metadata = exports.MetadataQL = exports.MetadataFields = exports.SharedPrimitive = exports.SharedPrimitiveFieldsForUpsert = exports.SharedPrimitiveFields = exports.Primitive = exports.PrimitiveFieldsForUpsert = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ReferenceBlockInputQL = exports.ConnectedProviderQL = void 0;
-exports.FindArticleInputQL = exports.FindDomainInputQL = exports.FindTenantInputQL = exports.FindRecordInputQL = exports.Table = exports.TableQL = exports.Record = exports.RecordQL = exports.TableMetadata = exports.TableMetadataQL = exports.FieldValueQL = exports.FieldQL = exports.OptionQL = exports.FieldVariation = exports.FieldType = exports.Template = exports.TemplateQL = exports.DocumentMetadata = exports.DocumentMetadataQL = exports.BlockDescriptionQL = exports.Website = exports.WebsiteQL = exports.Document = exports.DocumentQL = 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.TaskFieldsForUpsert = exports.TaskFields = exports.Note = exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFields = exports.BusinessObjectIngestionRequest = exports.History = exports.BlockProcessingResponse = void 0;
-exports.GraphQLTypes = exports.UpdateTagSharingInputQL = exports.SearchInputQL = exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = exports.ArchiveSearchInputQL = exports.FindSearchesInputQL = exports.FindSearchInputQL = exports.UpsertSearchInputQL = exports.ArchiveFolderOutputQL = exports.ArchiveFolderInputQL = exports.FindFoldersInputQL = exports.FindFolderInputQL = exports.UpsertFolderInputQL = exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.UpdateTaskInputQL = exports.DeleteSharingTagInputQL = exports.SetSharingTagInputQL = exports.MergeTagInputQL = exports.ArchiveTagOutputQL = exports.ArchiveTagInputQL = exports.FindTagsInputQL = exports.FindTagInputQL = exports.UpsertTagInputQL = exports.SharingTenantInputQL = exports.SharingDomainInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = exports.ArchiveRecommendationOutputQL = exports.ArchiveRecommendationInputQL = exports.UpdateRecommendationInputQL = exports.ArchiveNoteOutputQL = exports.ArchiveNoteInputQL = exports.FindNotesInputQL = exports.FindNoteInputQL = exports.UpsertNoteInputQL = exports.FindDocumentInputQL = exports.FindEventInputQL = exports.FindCalendarInputQL = exports.FindArticlesInputQL = void 0;
+exports.BlockProcessingRequest = exports.Block = exports.BlockFieldsForUpsert = exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = exports.Organization = exports.Domain = exports.DomainQL = exports.Tenant = exports.TenantQL = exports.Recommendation = exports.RecommendationQL = exports.ShareRecommendationQL = exports.UpsertRecommendationQL = exports.ConnectRecommendationQL = exports.TenantLight = exports.TenantLightQL = exports.TagRecommendationQL = exports.Tag = exports.TagQL = exports.TagFieldsJustSharing = exports.TagFieldsWithoutSharing = exports.Provider = exports.ProviderQL = exports.ProviderApplicationQL = exports.DashboardTagSubscriptionQL = exports.Sync = exports.SyncQL = exports.Search = exports.SearchQL = exports.Folder = exports.FolderQL = exports.Metadata = exports.MetadataQL = exports.MetadataFields = exports.SharedPrimitive = exports.SharedPrimitiveFieldsForUpsert = exports.SharedPrimitiveFields = exports.Primitive = exports.PrimitiveFieldsForUpsert = exports.PrimitiveFields = exports.PersonReferenceQL = exports.PersonReferenceFields = exports.ChangesQL = exports.ChangesInputQL = exports.ReferenceBlockQL = exports.ReferenceBlockInputQL = exports.ConnectedProviderQL = void 0;
+exports.TableQL = exports.Record = exports.RecordQL = exports.TableMetadata = exports.TableMetadataQL = exports.FieldValueQL = exports.FieldQL = exports.OptionQL = exports.FieldVariation = exports.FieldType = exports.Template = exports.TemplateQL = exports.DashboardMetadata = exports.DashboardMetadataQL = exports.DocumentMetadata = exports.DocumentMetadataQL = exports.BlockDescriptionQL = exports.Website = exports.WebsiteQL = exports.Dashboard = exports.DashboardQL = exports.BlockDataQL = exports.Document = exports.DocumentQL = 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.TaskFieldsForUpsert = exports.TaskFields = exports.Note = exports.NoteQL = exports.BusinessObject = exports.BusinessObjectQL = exports.BusinessObjectFields = exports.BusinessObjectIngestionRequest = exports.History = exports.BlockProcessingResponse = void 0;
+exports.GraphQLTypes = exports.UpdateTagSharingInputQL = exports.SearchInputQL = exports.SearchTagsInputQL = exports.ArchiveSearchOutputQL = exports.ArchiveSearchInputQL = exports.FindSearchesInputQL = exports.FindSearchInputQL = exports.UpsertSearchInputQL = exports.ArchiveFolderOutputQL = exports.ArchiveFolderInputQL = exports.FindFoldersInputQL = exports.FindFolderInputQL = exports.UpsertFolderInputQL = exports.ArchiveTaskOutputQL = exports.ArchiveTaskInputQL = exports.FindTasksInputQL = exports.FindTaskInputQL = exports.UpdateTaskInputQL = exports.DeleteSharingTagInputQL = exports.SetSharingTagInputQL = exports.MergeTagInputQL = exports.ArchiveTagOutputQL = exports.ArchiveTagInputQL = exports.FindTagsInputQL = exports.FindTagInputQL = exports.UpsertTagInputQL = exports.SharingTenantInputQL = exports.SharingDomainInputQL = exports.FindSyncInputQL = exports.FindProviderInputQL = exports.ArchiveRecommendationOutputQL = exports.ArchiveRecommendationInputQL = exports.UpdateRecommendationInputQL = exports.ArchiveNoteOutputQL = exports.ArchiveNoteInputQL = exports.FindNotesInputQL = exports.FindNoteInputQL = exports.UpsertNoteInputQL = exports.FindDocumentInputQL = exports.FindEventInputQL = exports.FindCalendarInputQL = exports.FindArticlesInputQL = exports.FindArticleInputQL = exports.FindDomainInputQL = exports.FindTenantInputQL = exports.FindRecordInputQL = exports.Table = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -20,6 +20,7 @@ var BlockType;
     BlockType["Task"] = "task";
     BlockType["Todo"] = "todo";
     BlockType["Document"] = "document";
+    BlockType["Dashboard"] = "dashboard";
     BlockType["Record"] = "record";
     BlockType["Conference"] = "conference";
     BlockType["Thread"] = "thread";
@@ -573,9 +574,9 @@ class Sync extends Primitive {
     }
 }
 exports.Sync = Sync;
-exports.BusinessObjectLinkingToTagQL = `
-type BusinessObjectLinkingToTag {
-	documentTypeSubscriptions: [String]!
+exports.DashboardTagSubscriptionQL = `
+type DashboardTagSubscription {
+	dashboardSubscriptions: [String]!
 	tagType: String!
 }`;
 exports.ProviderApplicationQL = `
@@ -588,7 +589,7 @@ type ProviderApplication {
 	linkSubscriptions: [String]
 	recordTypeSubscriptions: [String]
 	documentTypeSubscriptions: [String]
-	businessObjectLinkingToTags: [BusinessObjectLinkingToTag]
+	dashboardTagSubscriptions: [DashboardTagSubscription]
 	authentication: Boolean!
 }`;
 exports.ProviderQL = `
@@ -601,6 +602,7 @@ type Provider {${exports.PrimitiveFields}
   applications: [ProviderApplication]!
 	tableMetadata: [TableMetadata]
 	documentMetadata: [DocumentMetadata]
+	dashboardMetadata: [DashboardMetadata]
 }`;
 class Provider extends Primitive {
     constructor(name, label, description, instanceUrl, applications) {
@@ -1100,6 +1102,26 @@ class Document extends BusinessObject {
 }
 exports.Document = Document;
 //// DOCUMENT END
+//// DASHBOARD START
+exports.BlockDataQL = `
+type BlockData {
+  title: String
+	document: String
+	blockType: String!
+	metadataType: String
+}`;
+exports.DashboardQL = `
+type Dashboard {${exports.BusinessObjectFields}
+  blockData: [BlockData]
+}`;
+class Dashboard extends BusinessObject {
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, blockData) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Dashboard, provider, application, uri, externalId);
+        this.blockData = blockData;
+    }
+}
+exports.Dashboard = Dashboard;
+//// DASHBOARD END
 //// WEBSITE START
 exports.WebsiteQL = `
 type Website {${exports.BusinessObjectFields}
@@ -1138,6 +1160,18 @@ class DocumentMetadata extends Metadata {
     }
 }
 exports.DocumentMetadata = DocumentMetadata;
+exports.DashboardMetadataQL = `
+type DashboardMetadata {${exports.MetadataFields}
+  blockDescriptions: [BlockDescription]!
+	exportTypes: [String]
+}`;
+class DashboardMetadata extends Metadata {
+    constructor(label, description, metadataType, classifiers, threshold, blockDescriptions) {
+        super(label, description, metadataType, classifiers, threshold);
+        this.blockDescriptions = blockDescriptions;
+    }
+}
+exports.DashboardMetadata = DashboardMetadata;
 exports.TemplateQL = `
 type Template {${exports.BusinessObjectFields}
   metadata: DocumentMetadata
@@ -1571,7 +1605,7 @@ ${exports.MetadataQL}
 ${exports.FolderQL}
 ${exports.SearchQL}
 ${exports.SyncQL}
-${exports.BusinessObjectLinkingToTagQL}
+${exports.DashboardTagSubscriptionQL}
 ${exports.ProviderApplicationQL}
 ${exports.ProviderQL}
 ${exports.TagQL}
@@ -1598,6 +1632,9 @@ ${exports.PersonAcceptanceQL}
 ${exports.EventQL}
 ${exports.CalendarQL}
 ${exports.DocumentQL}
+${exports.BlockDataQL}
+${exports.DashboardQL}
+${exports.DashboardMetadataQL}
 ${exports.WebsiteQL}
 ${exports.BlockDescriptionQL}
 ${exports.DocumentMetadataQL}

package/model.ts

@@ -14,6 +14,7 @@ export enum BlockType {
 	Task = 'task',
 	Todo = 'todo', // A task from an external application
 	Document = 'document',
+	Dashboard = 'dashboard',
 	Record = 'record',
 	Conference = 'conference',
 	Thread = 'thread',
@@ -838,13 +839,13 @@ export class Sync extends Primitive {
 	}
 }
 
-export const BusinessObjectLinkingToTagQL = `
-type BusinessObjectLinkingToTag {
-	documentTypeSubscriptions: [String]!
+export const DashboardTagSubscriptionQL = `
+type DashboardTagSubscription {
+	dashboardSubscriptions: [String]!
 	tagType: String!
 }`;
-export interface BusinessObjectLinkingToTag {
-	documentTypeSubscriptions: string[];
+export interface DashboardTagSubscription {
+	dashboardSubscriptions: string[];
 	tagType: TagType;
 }
 
@@ -858,7 +859,7 @@ type ProviderApplication {
 	linkSubscriptions: [String]
 	recordTypeSubscriptions: [String]
 	documentTypeSubscriptions: [String]
-	businessObjectLinkingToTags: [BusinessObjectLinkingToTag]
+	dashboardTagSubscriptions: [DashboardTagSubscription]
 	authentication: Boolean!
 }`;
 export interface ProviderApplication {
@@ -870,7 +871,7 @@ export interface ProviderApplication {
 	linkSubscriptions?: string[];
 	recordTypeSubscriptions?: string[];
 	documentTypeSubscriptions?: string[];
-	businessObjectLinkingToTags?: BusinessObjectLinkingToTag[];
+	dashboardTagSubscriptions?: DashboardTagSubscription[];
 	authentication: boolean;
 }
 
@@ -884,6 +885,7 @@ type Provider {${PrimitiveFields}
   applications: [ProviderApplication]!
 	tableMetadata: [TableMetadata]
 	documentMetadata: [DocumentMetadata]
+	dashboardMetadata: [DashboardMetadata]
 }`;
 export class Provider extends Primitive {
 	name: string;
@@ -894,6 +896,7 @@ export class Provider extends Primitive {
 	applications: ProviderApplication[];
 	tableMetadata?: TableMetadata[];
 	documentMetadata?: DocumentMetadata[];
+	dashboardMetadata?: DashboardMetadata[];
 
 	constructor(
 		name: string,
@@ -1916,6 +1919,56 @@ export class Document extends BusinessObject {
 }
 //// DOCUMENT END
 
+//// DASHBOARD START
+export const BlockDataQL = `
+type BlockData {
+  title: String
+	document: String
+	blockType: String!
+	metadataType: String
+}`;
+export interface BlockData {
+	title?: string;
+	document?: string;
+	blockType: BlockType;
+	metadataType?: string;
+}
+
+export const DashboardQL = `
+type Dashboard {${BusinessObjectFields}
+  blockData: [BlockData]
+}`;
+export class Dashboard extends BusinessObject {
+	blockData: BlockData[];
+
+	constructor(
+		tenantIdCreated: string,
+		editors: Editor[],
+		sharingTags: SharingTag[],
+		version: number,
+		provider: string,
+		application: string,
+		uri: string,
+		externalId: string,
+		blockData: BlockData[]
+	) {
+		super(
+			tenantIdCreated,
+			editors,
+			sharingTags,
+			version,
+			BlockType.Dashboard,
+			provider,
+			application,
+			uri,
+			externalId
+		);
+
+		this.blockData = blockData;
+	}
+}
+//// DASHBOARD END
+
 //// WEBSITE START
 export const WebsiteQL = `
 type Website {${BusinessObjectFields}
@@ -1999,6 +2052,28 @@ export class DocumentMetadata extends Metadata {
 	}
 }
 
+export const DashboardMetadataQL = `
+type DashboardMetadata {${MetadataFields}
+  blockDescriptions: [BlockDescription]!
+	exportTypes: [String]
+}`;
+export class DashboardMetadata extends Metadata {
+	blockDescriptions: BlockDescription[];
+
+	constructor(
+		label: string,
+		description: string,
+		metadataType: string,
+		classifiers: string[],
+		threshold: number,
+		blockDescriptions: BlockDescription[]
+	) {
+		super(label, description, metadataType, classifiers, threshold);
+
+		this.blockDescriptions = blockDescriptions;
+	}
+}
+
 export const TemplateQL = `
 type Template {${BusinessObjectFields}
   metadata: DocumentMetadata
@@ -2820,7 +2895,7 @@ ${MetadataQL}
 ${FolderQL}
 ${SearchQL}
 ${SyncQL}
-${BusinessObjectLinkingToTagQL}
+${DashboardTagSubscriptionQL}
 ${ProviderApplicationQL}
 ${ProviderQL}
 ${TagQL}
@@ -2847,6 +2922,9 @@ ${PersonAcceptanceQL}
 ${EventQL}
 ${CalendarQL}
 ${DocumentQL}
+${BlockDataQL}
+${DashboardQL}
+${DashboardMetadataQL}
 ${WebsiteQL}
 ${BlockDescriptionQL}
 ${DocumentMetadataQL}

package/package.json

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