@bigfootai/bigfoot-types 2.12.0 → 2.12.2

package/model.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.BlockProcessingRequest = exports.Block = exports.BlockFields = exports.Article = exports.ArticleQL = exports.Person = 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.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.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 = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -275,6 +275,12 @@ type Changes {
   steps: [String]!
   clientIds: [String]!
 }`;
+exports.PersonReferenceFields = `
+  email: String!
+`;
+exports.PersonReferenceQL = `
+type PersonReference {${exports.PersonReferenceFields}
+}`;
 exports.PrimitiveFields = `
   _id: ID!
   dateCreated: Float!
@@ -289,6 +295,10 @@ class Primitive {
     }
 }
 exports.Primitive = Primitive;
+exports.SyncQL = `
+type Sync {${exports.PrimitiveFields}
+  providerRequest: ProviderRequest!
+}`;
 class Sync extends Primitive {
     constructor(tenantIdCreated, providerRequest) {
         super();
@@ -297,6 +307,14 @@ class Sync extends Primitive {
     }
 }
 exports.Sync = Sync;
+exports.ProviderQL = `
+type Provider {${exports.PrimitiveFields}
+  provider: String!
+  name: String!
+  description: String!
+  instanceUrl: String!
+  applications: String!
+}`;
 class Provider extends Primitive {
     constructor(provider, name, description, instanceUrl, applications) {
         super();
@@ -409,18 +427,19 @@ class BlockProcessingResponse {
     }
 }
 exports.BlockProcessingResponse = BlockProcessingResponse;
+exports.BusinessObjectFields = `${exports.PrimitiveFields}
+provider: String!
+application: String!
+uri: String!
+processingStage: String!
+processingAttempts: Int!
+dateProcessed: Float!
+externalId: String!
+processingReason: String
+iconUrl: String
+parentId: String`;
 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
+type BusinessObject {${exports.BlockFields}${exports.BusinessObjectFields}
 }`;
 class BusinessObject extends Block {
     constructor(tenantIdCreated, editors, sharingTags, version, blockType, provider, application, uri, externalId) {
@@ -468,6 +487,42 @@ class Task extends Block {
     }
 }
 exports.Task = Task;
+// CORE END
+/*
+These are the business objects we explicitly support and have a standardized description
+of across all systems. This allows these business objects to interact with each other
+regardless of underpinning system.
+*/
+// BUSINESS OBJECTS START
+//// CONFERENCE START
+exports.TranscriptionEntryQL = `
+type TranscriptionEntry {
+  person: [Person]!
+  text: String!
+  language: String!
+  startDate: Float!
+  endDate: Float!
+}`;
+exports.TranscriptionQL = `
+type Transcription {
+  entries: [TranscriptionEntry]!
+}`;
+exports.ConferenceEntrypointQL = `
+type ConferenceEntrypoint {
+  entryPointType: String!
+  uri: String
+  label: String
+  pin: String
+  accessCode: String
+  meetingCode: String
+  passcode: String
+  password: String
+}`;
+exports.ConferenceQL = `
+type Conference {${exports.BusinessObjectFields}
+  entryPoints: [ConferenceEntrypoint]!
+  transcription: Transcription
+}`;
 class Conference extends BusinessObject {
     constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, entryPoints) {
         super(tenantIdCreated, editors, sharingTags, version, BlockType.Conference, provider, application, uri, externalId);
@@ -490,13 +545,25 @@ var ResponseStatus;
     ResponseStatus["Tentative"] = "tentative";
     ResponseStatus["Accepted"] = "accepted";
 })(ResponseStatus || (exports.ResponseStatus = ResponseStatus = {}));
-class Calendar extends BusinessObject {
-    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, timeZone) {
-        super(tenantIdCreated, editors, sharingTags, version, BlockType.Calendar, provider, application, uri, externalId);
-        this.timeZone = timeZone;
-    }
-}
-exports.Calendar = Calendar;
+exports.PersonAcceptanceQL = `
+type PersonAcceptance {${exports.PersonReferenceFields}
+  responseStatus: String!
+}`;
+exports.EventQL = `
+type Event {${exports.BusinessObjectFields}
+  calendarId: String!
+  status: String!
+  dateStart: Float!
+  organizedBy: PersonReference!
+  location: String
+  dateStartOriginal: Float
+  recurrence: [String]
+  dateEnd: Float
+  subject: String
+  description: String
+  attendees: [PersonAcceptance]
+  conference: Conference
+}`;
 class Event extends BusinessObject {
     constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, calendarId, status, dateStart, organizedBy) {
         super(tenantIdCreated, editors, sharingTags, version, BlockType.Event, provider, application, uri, externalId);
@@ -507,6 +574,20 @@ class Event extends BusinessObject {
     }
 }
 exports.Event = Event;
+exports.CalendarQL = `
+type Calendar {${exports.BusinessObjectFields}
+  timeZone: String!
+  description: String
+  location: String
+  events: [Event]
+}`;
+class Calendar extends BusinessObject {
+    constructor(tenantIdCreated, editors, sharingTags, version, provider, application, uri, externalId, timeZone) {
+        super(tenantIdCreated, editors, sharingTags, version, BlockType.Calendar, provider, application, uri, externalId);
+        this.timeZone = timeZone;
+    }
+}
+exports.Calendar = Calendar;
 //// EVENT END
 //// EXTERNAL TASK START
 class Todo extends BusinessObject {
@@ -629,18 +710,18 @@ type FindSyncInput {
 exports.FindTaskInputQL = `
 type FindTaskInput {
   _id: String!
-	archived: Boolean
+  archived: Boolean
 }`;
 exports.FindTasksInputQL = `
 type FindTasksInput {
   originNoteId: String
   tagIds: [String]
-	archived: Boolean
+  archived: Boolean
 }`;
 exports.ArchiveTaskInputQL = `
 type ArchiveTaskInput {
   _id: String!
-	archived: Boolean
+  archived: Boolean
 }`;
 // THE GRAPH QL DEFINITIONS
 exports.GraphQLTypes = `
@@ -658,6 +739,9 @@ ${exports.ProviderInfoQL}
 ${exports.ProviderRequestQL}
 ${exports.CredentialQL}
 ${exports.ChangesQL}
+${exports.PersonReferenceQL}
+${exports.SyncQL}
+${exports.ProviderQL}
 ${exports.ConnectedProviderQL}
 ${exports.ReferenceBlockQL}
 ${exports.ArticleQL}
@@ -665,6 +749,12 @@ ${exports.TenantQL}
 ${exports.BusinessObjectQL}
 ${exports.NoteQL}
 ${exports.TaskQL}
+${exports.TranscriptionEntryQL}
+${exports.TranscriptionQL}
+${exports.ConferenceEntrypointQL}
+${exports.ConferenceQL}
+${exports.PersonAcceptanceQL}
+${exports.EventQL}
 ${exports.FindArticleInputQL}
 ${exports.FindArticlesInputQL}
 ${exports.FindCalendarInputQL}

package/model.ts

@@ -431,6 +431,12 @@ export interface Changes {
 	clientIds: string[];
 }
 
+export const PersonReferenceFields = `
+  email: String!
+`;
+export const PersonReferenceQL = `
+type PersonReference {${PersonReferenceFields}
+}`;
 export interface PersonReference {
 	email: string;
 }
@@ -455,6 +461,10 @@ export class Primitive {
 	}
 }
 
+export const SyncQL = `
+type Sync {${PrimitiveFields}
+  providerRequest: ProviderRequest!
+}`;
 export class Sync extends Primitive {
 	providerRequest: ProviderRequest;
 
@@ -466,6 +476,14 @@ export class Sync extends Primitive {
 	}
 }
 
+export const ProviderQL = `
+type Provider {${PrimitiveFields}
+  provider: String!
+  name: String!
+  description: String!
+  instanceUrl: String!
+  applications: String!
+}`;
 export class Provider extends Primitive {
 	provider: string;
 	name: string;
@@ -671,18 +689,19 @@ export class BlockProcessingResponse {
 	}
 }
 
+export const BusinessObjectFields = `${PrimitiveFields}
+provider: String!
+application: String!
+uri: String!
+processingStage: String!
+processingAttempts: Int!
+dateProcessed: Float!
+externalId: String!
+processingReason: String
+iconUrl: String
+parentId: String`;
 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
+type BusinessObject {${BlockFields}${BusinessObjectFields}
 }`;
 export class BusinessObject extends Block {
 	provider: string; // A unique string representing the provider e.g. "salesforce", "atlassian", etc
@@ -789,6 +808,14 @@ regardless of underpinning system.
 // BUSINESS OBJECTS START
 
 //// CONFERENCE START
+export const TranscriptionEntryQL = `
+type TranscriptionEntry {
+  person: [Person]!
+  text: String!
+  language: String!
+  startDate: Float!
+  endDate: Float!
+}`;
 export interface TranscriptionEntry {
 	person: Person;
 	text: string;
@@ -797,10 +824,25 @@ export interface TranscriptionEntry {
 	endDate: number;
 }
 
+export const TranscriptionQL = `
+type Transcription {
+  entries: [TranscriptionEntry]!
+}`;
 export interface Transcription {
 	entries: TranscriptionEntry[];
 }
 
+export const ConferenceEntrypointQL = `
+type ConferenceEntrypoint {
+  entryPointType: String!
+  uri: String
+  label: String
+  pin: String
+  accessCode: String
+  meetingCode: String
+  passcode: String
+  password: String
+}`;
 export interface ConferenceEntrypoint {
 	entryPointType: string;
 	uri?: string | null;
@@ -812,6 +854,11 @@ export interface ConferenceEntrypoint {
 	password?: string | null;
 }
 
+export const ConferenceQL = `
+type Conference {${BusinessObjectFields}
+  entryPoints: [ConferenceEntrypoint]!
+  transcription: Transcription
+}`;
 export class Conference extends BusinessObject {
 	entryPoints: ConferenceEntrypoint[];
 	transcription?: Transcription | null;
@@ -858,6 +905,10 @@ export enum ResponseStatus {
 	Accepted = 'accepted',
 }
 
+export const PersonAcceptanceQL = `
+type PersonAcceptance {${PersonReferenceFields}
+  responseStatus: String!
+}`;
 export interface PersonAcceptance extends PersonReference {
 	responseStatus: ResponseStatus;
 }
@@ -881,11 +932,34 @@ export interface CalendarProviderRequest {
 	credential: Credential;
 }
 
-export class Calendar extends BusinessObject {
-	timeZone: string;
-	description?: string | null;
+export const EventQL = `
+type Event {${BusinessObjectFields}
+  calendarId: String!
+  status: String!
+  dateStart: Float!
+  organizedBy: PersonReference!
+  location: String
+  dateStartOriginal: Float
+  recurrence: [String]
+  dateEnd: Float
+  subject: String
+  description: String
+  attendees: [PersonAcceptance]
+  conference: Conference
+}`;
+export class Event extends BusinessObject {
+	calendarId: string;
+	status: EventStatus;
+	dateStart: number;
+	organizedBy: PersonReference;
 	location?: string | null;
-	events?: Event[] | null;
+	dateStartOriginal?: number | null;
+	recurrence?: RecurrenceRFC[] | null;
+	dateEnd?: number | null;
+	subject?: string | null;
+	description?: string | null;
+	attendees?: PersonAcceptance[] | null;
+	conference?: Conference | null;
 
 	constructor(
 		tenantIdCreated: string,
@@ -896,38 +970,42 @@ export class Calendar extends BusinessObject {
 		application: string,
 		uri: string,
 		externalId: string,
-		timeZone: string
+		calendarId: string,
+		status: EventStatus,
+		dateStart: number,
+		organizedBy: PersonReference
 	) {
 		super(
 			tenantIdCreated,
 			editors,
 			sharingTags,
 			version,
-			BlockType.Calendar,
+			BlockType.Event,
 			provider,
 			application,
 			uri,
 			externalId
 		);
 
-		this.timeZone = timeZone;
+		this.calendarId = calendarId;
+		this.status = status;
+		this.dateStart = dateStart;
+		this.organizedBy = organizedBy;
 	}
 }
 
-export class Event extends BusinessObject {
-	calendarId: string;
-	status: EventStatus;
-	dateStart: number;
-	organizedBy: PersonReference;
-	location?: string | null;
-	dateStartOriginal?: number | null;
-	recurrence?: RecurrenceRFC[] | null;
-	dateEnd?: number | null;
-	subject?: string | null;
+export const CalendarQL = `
+type Calendar {${BusinessObjectFields}
+  timeZone: String!
+  description: String
+  location: String
+  events: [Event]
+}`;
+export class Calendar extends BusinessObject {
+	timeZone: string;
 	description?: string | null;
-	attendees?: PersonAcceptance[] | null;
-	conference?: Conference | null;
-	attachments?: Attachment[] | null;
+	location?: string | null;
+	events?: Event[] | null;
 
 	constructor(
 		tenantIdCreated: string,
@@ -938,27 +1016,21 @@ export class Event extends BusinessObject {
 		application: string,
 		uri: string,
 		externalId: string,
-		calendarId: string,
-		status: EventStatus,
-		dateStart: number,
-		organizedBy: PersonReference
+		timeZone: string
 	) {
 		super(
 			tenantIdCreated,
 			editors,
 			sharingTags,
 			version,
-			BlockType.Event,
+			BlockType.Calendar,
 			provider,
 			application,
 			uri,
 			externalId
 		);
 
-		this.calendarId = calendarId;
-		this.status = status;
-		this.dateStart = dateStart;
-		this.organizedBy = organizedBy;
+		this.timeZone = timeZone;
 	}
 }
 //// EVENT END
@@ -1309,7 +1381,7 @@ export interface FindSyncInput {
 export const FindTaskInputQL = `
 type FindTaskInput {
   _id: String!
-	archived: Boolean
+  archived: Boolean
 }`;
 export interface FindTaskInput {
 	_id: string;
@@ -1320,7 +1392,7 @@ export const FindTasksInputQL = `
 type FindTasksInput {
   originNoteId: String
   tagIds: [String]
-	archived: Boolean
+  archived: Boolean
 }`;
 export interface FindTasksInput {
 	originNoteId?: string;
@@ -1331,7 +1403,7 @@ export interface FindTasksInput {
 export const ArchiveTaskInputQL = `
 type ArchiveTaskInput {
   _id: String!
-	archived: Boolean
+  archived: Boolean
 }`;
 export interface ArchiveTaskInput {
 	_id: string;
@@ -1354,6 +1426,9 @@ ${ProviderInfoQL}
 ${ProviderRequestQL}
 ${CredentialQL}
 ${ChangesQL}
+${PersonReferenceQL}
+${SyncQL}
+${ProviderQL}
 ${ConnectedProviderQL}
 ${ReferenceBlockQL}
 ${ArticleQL}
@@ -1361,6 +1436,12 @@ ${TenantQL}
 ${BusinessObjectQL}
 ${NoteQL}
 ${TaskQL}
+${TranscriptionEntryQL}
+${TranscriptionQL}
+${ConferenceEntrypointQL}
+${ConferenceQL}
+${PersonAcceptanceQL}
+${EventQL}
 ${FindArticleInputQL}
 ${FindArticlesInputQL}
 ${FindCalendarInputQL}

package/package.json

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