@bigfootai/bigfoot-types 2.1.0

package/.eslintignore

@@ -0,0 +1,3 @@
+dist
+.eslintrc.mjs
+./node_modules

package/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+	"root": true,
+	"env": { "node": true, "es2020": true },
+	"extends": ["eslint:recommended", "plugin:prettier/recommended"],
+	"parserOptions": {
+		"sourceType": "module",
+		"ecmaVersion": 2021
+	},
+	"plugins": ["prettier"]
+}

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+	"semi": true,
+	"singleQuote": true,
+	"tabWidth": 4,
+	"useTabs": true,
+	"trailingComma": "es5",
+	"bracketSpacing": true,
+	"endOfLine": "lf"
+}

package/.vscode-sample/settings.json

@@ -0,0 +1,10 @@
+{
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"editor.formatOnSave": true,
+	"[typescript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	},
+	"[javascript]": {
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
+	}
+}

package/README.md

@@ -0,0 +1,51 @@
+https://auth0.com/docs/secure/security-guidance/data-security/allowlist
+https://dev.to/stanbar/writing-mongo-realm-serverless-functions-in-typescript-5fdo
+
+Need to set up API key for Auth0
+
+Adding environment variables to atlas.d.ts
+
+brew install curl
+Get the domain from here: https://manage.auth0.com/dashboard/us/dev-h40ievkvqezopsav/tenant/admins (it's bolded at the top of the page in the intro content)
+curl -s https://dev-h40ievkvqezopsav.us.auth0.com/pem | openssl x509 -pubkey -noout
+Paste the contents into the Public Key (Secret Name) in the Custom JWT authentication provider
+
+You need to get an example req.oidc.idToken from index.mjs in the server part of the bigfoot project
+Past that into this tool: https://jwt.io/#debugger-io
+Note down the "aud" property
+Put the value of that in the Audience (Optional) in the authentication provider config
+
+Auth0 stuff:
+Dev
+AUTH0_API_KEY: GCVzRnhjtBIAg0493d4v3yWCkRirft12s1BQAcHzkkcaPFKxUD9sWYeeYpYMG8sZ
+AUTH0_HANDLER_ENDPOINT: https://us-east-1.aws.data.mongodb-api.com/app/bigfootbackend-xblwe/endpoint/api/v1/tenant/auth
+
+Staging
+AUTH0_API_KEY: ADXtN68db1do3ApsdyR5EfSkLnIL2hx6NuIJEeGYB0kNlIuyKjtgeAYPIqmGyat4
+AUTH0_HANDLER_ENDPOINT: https://us-east-1.aws.data.mongodb-api.com/app/bigfootbackend-wstbt/endpoint/api/v1/tenant/auth
+
+Production
+AUTH0_API_KEY: 2OYocp1S6fIvSW3S8jQPd4iDhd8Q6syV8WqokemoKhilTn1FKix0om7Ctm0SqAH4
+AUTH0_HANDLER_ENDPOINT: https://us-east-1.aws.data.mongodb-api.com/app/bigfootbackend-gxuab/endpoint/api/v1/tenant/auth
+
+You need to set up the authentication stuff manually despite being in the deployment configuration...
+
+{
+"collection": "notes",
+"database": "bigfoot-dev",
+"filters": [
+{
+"name": "filterDocumentsForTenant",
+"query": {
+"%function": {
+"name": "filterDocumentsForTenant"
+}
+},
+"apply_when": {
+"%%user.data": {
+"%exists": "%%true"
+}
+}
+}
+]
+}

package/metadata/tables/account.json

@@ -0,0 +1,231 @@
+{
+  "label": "Account",
+  "name": "Account",
+  "references": [ "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm" ],
+  "description": "Represents an individual account, which is an organization involved with your business (such as customers, competitors, and partners).",
+  "fields": [
+    {
+      "label": "Name",
+      "name": "Name",
+      "description": "A name for this account.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "maximumCharacters": 255,
+      "order": 0,
+      "isReadOnly": false
+    },
+    {
+      "label": "Annual Revenue",
+      "name": "AnnualRevenue",
+      "description": "Estimated annual revenue of the account.",
+      "doMonitor": false,
+      "fieldType": "input",
+      "fieldVariation": "currency",
+      "order": 1,
+      "isReadOnly": false
+    },
+    {
+      "label": "Industry",
+      "name": "Industry",
+      "description": "An industry associated with this account.",
+      "doMonitor": false,
+      "fieldType": "select",
+      "order": 2,
+      "isReadOnly": false,
+      "options": [
+        {
+          "label": "Agriculture",
+          "value": "Agriculture"
+        },
+        {
+          "label": "Apparel",
+          "value": "Apparel"
+        },
+        {
+          "label": "Banking",
+          "value": "Banking"
+        },
+        {
+          "label": "Biotechnology",
+          "value": "Biotechnology"
+        },
+        {
+          "label": "Chemicals",
+          "value": "Chemicals"
+        },
+        {
+          "label": "Communications",
+          "value": "Communications"
+        },
+        {
+          "label": "Construction",
+          "value": "Construction"
+        },
+        {
+          "label": "Consulting",
+          "value": "Consulting"
+        },
+        {
+          "label": "Education",
+          "value": "Education"
+        },
+        {
+          "label": "Electronics",
+          "value": "Electronics"
+        },
+        {
+          "label": "Energy",
+          "value": "Energy"
+        },
+        {
+          "label": "Engineering",
+          "value": "Engineering"
+        },
+        {
+          "label": "Entertainment",
+          "value": "Entertainment"
+        },
+        {
+          "label": "Environmental",
+          "value": "Environmental"
+        },
+        {
+          "label": "Finance",
+          "value": "Finance"
+        },
+        {
+          "label": "Food & Beverage",
+          "value": "Food & Beverage"
+        },
+        {
+          "label": "Government",
+          "value": "Government"
+        },
+        {
+          "label": "Healthcare",
+          "value": "Healthcare"
+        },
+        {
+          "label": "Hospitality",
+          "value": "Hospitality"
+        },
+        {
+          "label": "Insurance",
+          "value": "Insurance"
+        },
+        {
+          "label": "Machinery",
+          "value": "Machinery"
+        },
+        {
+          "label": "Manufacturing",
+          "value": "Manufacturing"
+        },
+        {
+          "label": "Media",
+          "value": "Media"
+        },
+        {
+          "label": "Not For Profit",
+          "value": "Not For Profit"
+        },
+        {
+          "label": "Recreation",
+          "value": "Recreation"
+        },
+        {
+          "label": "Retail",
+          "value": "Retail"
+        },
+        {
+          "label": "Shipping",
+          "value": "Shipping"
+        },
+        {
+          "label": "Technology",
+          "value": "Technology"
+        },
+        {
+          "label": "Telecommunications",
+          "value": "Telecommunications"
+        },
+        {
+          "label": "Transportation",
+          "value": "Transportation"
+        },
+        {
+          "label": "Utilities",
+          "value": "Utilities"
+        },
+        {
+          "label": "Other",
+          "value": "Other"
+        }
+      ]
+    },
+    {
+      "label": "Phone",
+      "name": "Phone",
+      "description": "Phone number for this account.",
+      "doMonitor": false,
+      "fieldType": "input",
+      "fieldVariation": "phone",
+      "maximumCharacters": 40,
+      "order": 3,
+      "isReadOnly": false
+    },
+    {
+      "label": "Website",
+      "name": "Website",
+      "description": "The website of this account.",
+      "doMonitor": false,
+      "fieldType": "input",
+      "fieldVariation": "url",
+      "maximumCharacters": 255,
+      "order": 4,
+      "isReadOnly": false
+    },
+    {
+      "label": "Type",
+      "name": "Type",
+      "description": "Type of account.",
+      "doMonitor": true,
+      "fieldType": "select",
+      "order": 5,
+      "isReadOnly": false,
+      "options": [
+        {
+          "label": "Customer",
+          "value": "Customer"
+        },
+        {
+          "label": "Competitor",
+          "value": "Competitor"
+        },
+        {
+          "label": "Partner",
+          "value": "Partner"
+        }
+      ]
+    },
+    {
+      "label": "Owner.Name",
+      "name": "Owner",
+      "description": "Name of the User who has been assigned to work with this account.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 7,
+      "isReadOnly": false
+    },
+    {
+      "label": "Description",
+      "name": "Description",
+      "description": "Text description of the account.",
+      "doMonitor": false,
+      "fieldType": "textarea",
+      "maximumCharacters": 32000,
+      "order": 8,
+      "isReadOnly": false
+    }
+  ]
+}

package/metadata/tables/contact.json

@@ -0,0 +1,95 @@
+{
+  "label": "Contact",
+  "name": "Contact",
+  "references": [ "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm" ],
+  "description": "Represents a contact, which is a person associated with an account.",
+  "fields": [
+    {
+      "label": "First Name",
+      "name": "FirstName",
+      "description": "The first name of the contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "maximumCharacters": 40,
+      "order": 0,
+      "isReadOnly": false
+    },
+    {
+      "label": "Last Name",
+      "name": "LastName",
+      "description": "The last name of the contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "maximumCharacters": 80,
+      "order": 1,
+      "isReadOnly": false
+    },
+    {
+      "label": "Title",
+      "name": "Title",
+      "description": "A title for this contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 2,
+      "isReadOnly": false
+    },
+    {
+      "label": "Phone",
+      "name": "Phone",
+      "description": "The phone number for the contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "fieldVariation": "phone",
+      "order": 3,
+      "isReadOnly": false
+    },
+    {
+      "label": "Email",
+      "name": "Email",
+      "description": "The email address for the contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "fieldVariation": "email",
+      "order": 4,
+      "isReadOnly": false
+    },
+    {
+      "label": "Date of Birth",
+      "name": "Birthdate",
+      "description": "The date of birth of the contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "fieldVariation": "date",
+      "order": 5,
+      "isReadOnly": false
+    },
+    {
+      "label": "Account",
+      "name": "Account.Name",
+      "description": "Name of the account associated with this contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 6,
+      "isReadOnly": false
+    },
+    {
+      "label": "Owner.Name",
+      "name": "Owner",
+      "description": "Name of the User who has been assigned to work with this contact.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 7,
+      "isReadOnly": false
+    },
+    {
+      "label": "Description",
+      "name": "Description",
+      "description": "Text description of the contact.",
+      "doMonitor": false,
+      "fieldType": "textarea",
+      "maximumCharacters": 32000,
+      "order": 8,
+      "isReadOnly": false
+    }
+  ]
+}

package/metadata/tables/event.json

@@ -0,0 +1,79 @@
+{
+  "label": "Calendar Event",
+  "name": "Event",
+  "references": [ "https://developers.google.com/calendar/api/v3/reference/events" ],
+  "description": "Represents an event in a calendar.",
+  "fields": [
+    {
+      "label": "Summary",
+      "name": "Summary",
+      "description": "A summary description of the event.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "maximumCharacters": 255,
+      "order": 0,
+      "isReadOnly": false
+    },
+    {
+      "label": "Status",
+      "name": "Status",
+      "description": "The status of the event.",
+      "doMonitor": true,
+      "fieldType": "select",
+      "order": 1,
+      "isReadOnly": false,
+      "options": [
+        {
+          "label": "Confirmed",
+          "value": "Confirmed"
+        },
+        {
+          "label": "Tentative",
+          "value": "Tentative"
+        },
+        {
+          "label": "Cancelled",
+          "value": "Cancelled"
+        }
+      ]
+    },
+    {
+      "label": "Date",
+      "name": "Date",
+      "description": "Date and time for the event.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "fieldVariation": "datetime",
+      "order": 2,
+      "isReadOnly": false
+    },
+    {
+      "label": "Attendees",
+      "name": "Attendees",
+      "description": "A comma separated list of email addresses for those attending the event.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 3,
+      "isReadOnly": false
+    },
+    {
+      "label": "Attachments",
+      "name": "Attachments",
+      "description": "A comma separated list of links to any attachments.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 3,
+      "isReadOnly": false
+    },
+    {
+      "label": "Description",
+      "name": "Description",
+      "description": "Text description of the event.",
+      "doMonitor": false,
+      "fieldType": "textarea",
+      "maximumCharacters": 32000,
+      "order": 4,
+      "isReadOnly": false
+    }
+  ]
+}

package/metadata/tables/issue.json

@@ -0,0 +1,127 @@
+{
+  "label": "Issue",
+  "name": "Issue",
+  "references": [ 
+    "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_case.htm",
+    "https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-post",
+    "https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/"
+  ],
+  "description": "Represents an issue/case/ticket, which is a problem that needs to be resolved.",
+  "fields": [
+    {
+      "label": "Summary",
+      "name": "Summary",
+      "description": "A summary description of the issue.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "maximumCharacters": 255,
+      "order": 0,
+      "isReadOnly": false
+    },
+    {
+      "label": "Priority",
+      "name": "Priority",
+      "description": "The priority of the issue.",
+      "doMonitor": true,
+      "fieldType": "select",
+      "order": 1,
+      "isReadOnly": false,
+      "options": [
+        {
+          "label": "High",
+          "value": "High"
+        },
+        {
+          "label": "Medium",
+          "value": "Medium"
+        },
+        {
+          "label": "Low",
+          "value": "Low"
+        }
+      ]
+    },
+    {
+      "label": "Status",
+      "name": "Status",
+      "description": "The status of the issue.",
+      "doMonitor": true,
+      "fieldType": "select",
+      "order": 2,
+      "isReadOnly": false,
+      "options": [
+        {
+          "label": "New",
+          "value": "New"
+        },
+        {
+          "label": "Open",
+          "value": "Open"
+        },
+        {
+          "label": "Pending",
+          "value": "Pending"
+        },
+        {
+          "label": "Hold",
+          "value": "Hold"
+        },
+        {
+          "label": "Solved",
+          "value": "Solved"
+        },
+        {
+          "label": "Closed",
+          "value": "Closed"
+        }
+      ]
+    },
+    {
+      "label": "Account",
+      "name": "Account.Name",
+      "description": "Name of the account associated with this issue.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 3,
+      "isReadOnly": false
+    },
+    {
+      "label": "Contact Name",
+      "name": "Contact.Name",
+      "description": "Name of the contact associated with this issue.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 4,
+      "isReadOnly": false
+    },
+    {
+      "label": "Due Date",
+      "name": "DueDate",
+      "description": "Date and time when the issue is due to be completed.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "fieldVariation": "datetime",
+      "order": 5,
+      "isReadOnly": false
+    },
+    {
+      "label": "Owner.Name",
+      "name": "Owner",
+      "description": "Name of the User who has been assigned to work on this issue.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 6,
+      "isReadOnly": false
+    },
+    {
+      "label": "Description",
+      "name": "Description",
+      "description": "Text description of the issue.",
+      "doMonitor": false,
+      "fieldType": "textarea",
+      "maximumCharacters": 32000,
+      "order": 7,
+      "isReadOnly": false
+    }
+  ]
+}

package/metadata/tables/opportunity.json

@@ -0,0 +1,127 @@
+{
+  "label": "Opportunity",
+  "name": "Opportunity",
+  "references": [ "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm" ],
+  "description": "Represents an opportunity, which is a sale or pending deal.",
+  "fields": [
+    {
+      "label": "Name",
+      "name": "Name",
+      "description": "A name for this opportunity.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "maximumCharacters": 120,
+      "order": 0,
+      "isReadOnly": false
+    },
+    {
+      "label": "Account",
+      "name": "Account.Name",
+      "description": "Name of the account associated with this opportunity.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 1,
+      "isReadOnly": false
+    },
+    {
+      "label": "Amount",
+      "name": "Amount",
+      "description": "Estimated total sale amount.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "fieldVariation": "currency",
+      "order": 2,
+      "isReadOnly": false
+    },
+    {
+      "label": "Close Date",
+      "name": "CloseDate",
+      "description": "Date when the opportunity is expected to close.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "fieldVariation": "date",
+      "order": 3,
+      "isReadOnly": false
+    },
+    {
+      "label": "Stage",
+      "name": "StageName",
+      "description": "Current stage of this opportunity.",
+      "doMonitor": true,
+      "fieldType": "select",
+      "order": 4,
+      "isReadOnly": false,
+      "options": [
+        {
+          "label": "Prospecting",
+          "value": "Prospecting"
+        },
+        {
+          "label": "Qualification",
+          "value": "Qualification"
+        },
+        {
+          "label": "Needs Analysis",
+          "value": "Needs Analysis"
+        },
+        {
+          "label": "Value Proposition",
+          "value": "Value Proposition"
+        },
+        {
+          "label": "Id. Decision Makers",
+          "value": "Id. Decision Makers"
+        },
+        {
+          "label": "Perception Analysis",
+          "value": "Perception Analysis"
+        },
+        {
+          "label": "Proposal/Price Quote",
+          "value": "Proposal/Price Quote"
+        },
+        {
+          "label": "Negotiation/Review",
+          "value": "Negotiation/Review"
+        },
+        {
+          "label": "Closed Won",
+          "value": "Closed Won"
+        },
+        {
+          "label": "Closed Lost",
+          "value": "Closed Lost"
+        }
+      ]
+    },
+    {
+      "label": "Owner.Name",
+      "name": "Owner",
+      "description": "Name of the User who has been assigned to work on this opportunity.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "order": 5,
+      "isReadOnly": false
+    },
+    {
+      "label": "Next Step",
+      "name": "NextStep",
+      "description": "A short description of next task in closing opportunity.",
+      "doMonitor": true,
+      "fieldType": "input",
+      "maximumCharacters": 250,
+      "order": 6,
+      "isReadOnly": false
+    },
+    {
+      "label": "Description",
+      "name": "Description",
+      "description": "Text description of the opportunity.",
+      "doMonitor": false,
+      "fieldType": "textarea",
+      "maximumCharacters": 32000,
+      "order": 7,
+      "isReadOnly": false
+    }
+  ]
+}

package/model.ts

@@ -0,0 +1,380 @@
+import { v4 as uuidv4 } from 'uuid';
+
+/*
+These are the core primitives of our model. These represent the entities that show
+up in our Graph QL CRUD operations and set out the fundamental building blocks of
+the platform.
+*/
+// CORE START
+export enum BusinessObjectType {
+	Event = 'event',
+	Task = 'task',
+	Document = 'document',
+	Record = 'record',
+	Conference = 'conference',
+	Message = 'message',
+	Website = 'website',
+}
+
+export enum BlockType {
+	Section = 'section', // It's a fragment of content
+	Task = 'task', // It's a task
+	Data = 'data', // It's a record or set of records belonging to a specific metadata definition
+}
+
+export enum TagType {
+	Person = 'person',
+	Topic = 'topic',
+}
+
+export enum SharingLevel {
+	ReadOnly = 0,
+	Editor = 1,
+	Owner = 2, // Only an owner can make you an owner - and the initial creator is always the owner
+}
+
+export enum TaskStatus {
+	NotStarted = 0,
+	InProgress = 1,
+	Completed = 10,
+}
+
+export enum StepStatus {
+	NotStarted = 0,
+	Completed = 10,
+}
+
+export enum SharingApproach {
+	Inline = 0, // As in, the user has used this tag in the note
+	Explicit = 1, // The system has assigned the sharing to the tenant based on access rules
+	Automated = 2, // The settings on the tag have caused the sharing to happen
+}
+
+export enum InviteStatus {
+	NotInvited = 0,
+	InviteSent = 1,
+	InviteAccepted = 2,
+}
+
+export enum RecurrenceRFC {
+	FREQ = 'FREQ', // The frequency of the event (e.g., DAILY, WEEKLY, MONTHLY, YEARLY).
+	UNTIL = 'UNTIL', // A date until when the event should occur.
+	COUNT = 'COUNT', // How many occurrences of the event will take place.
+	INTERVAL = 'INTERVAL', // How often the event repeats within the frequency period.
+	BYDAY = 'BYDAY', // Specifies the days of the week when the event should occur.
+	BYMONTH = 'BYMONTH', // Specifies months of the year.
+	BYMONTHDAY = 'BYMONTHDAY', // Specifies days of the month.
+	BYYEARDAY = 'BYYEARDAY', // Specifies days of the year.
+	BYWEEKNO = 'BYWEEKNO', // Specifies the week numbers in the year.
+	BYHOUR = 'BYHOUR',
+	BYMINUTE = 'BYMINUTE',
+	BYSECOND = 'BYSECOND', // Specifies the time of the event.
+	MONDAY = 'MO',
+	TUESDAY = 'TU',
+	WEDNESDAY = 'WE',
+	THURSDAY = 'TH',
+	FRIDAY = 'FR',
+	SATURDAY = 'SA',
+	SUNDAY = 'SU',
+}
+
+export interface Mark {
+	type: string;
+}
+
+export interface Document {
+	attrs: Map<string, string>;
+	content: Document;
+	text: string;
+	type: string;
+	marks: Mark[];
+}
+
+export interface Editor {
+	client: string;
+	clientId: string;
+	tagId: string;
+}
+
+export interface SharingTag {
+	tagId: string;
+	isShared: boolean;
+	sharingApproach: SharingApproach;
+	sharingLevel: SharingLevel;
+}
+
+export interface SharingDomain {
+	domainId: string;
+	isArchived: boolean; // Indicates if the tag has been archived for the domain, but is shared
+	sharingLevel: SharingLevel; // Determines what domains can do with the tag beyond domain specific settings above
+}
+
+export interface SharingTenant {
+	tenantId: string;
+	hasAutoShareNotesOn: boolean; // Indicates if the tenant has auto sharing of notes switched on
+	hasAutoShareTasksOn: boolean; // Indicates if the tenant has auto sharing of tasks switched on
+	sharingLevel: SharingLevel; // Determines what tenants can do with the tag beyond tenant specific settings above
+}
+
+export interface Reaction {
+	skinTones: ReactionSkinTone[];
+	unified: string;
+}
+
+export interface ReactionSkinTone {
+	skinTone: string;
+	tenantIds: string[];
+}
+
+export interface Step {
+	content: string;
+	status: StepStatus;
+}
+
+export class Primitive {
+	_id: string;
+	dateCreated: number;
+	dateUpdated: number;
+
+	constructor() {
+		this._id = uuidv4();
+
+		const now = Date.now();
+		this.dateCreated = now;
+		this.dateUpdated = now;
+	}
+}
+
+export class Tag extends Primitive {
+	tenantIdCreated: string; // The tenant._id that created the note initially
+	alias: string;
+	friendlyName?: string;
+	sharingDomains?: SharingDomain[]; // The domains this tag is shared with plus domain settings for the tag
+	sharingTenants?: SharingTenant[]; // The tenants this tag is shared with plus tenant settings for the tag
+	tagType: TagType;
+}
+
+export class BusinessObject extends Primitive {
+	provider: string; // A unique string representing the provider e.g. "salesforce", "jira", etc
+	uri: string; // A uri to locate the specific instance of the business object
+	iconUrl?: string; // The url of an icon that represents the business object
+	externalId: string; // An identifier that allows us to do entity resolution
+	businessObjectType: BusinessObjectType;
+	externalResponse: string; // The full response from the external system that created this object
+	document: Document; // The business object formatted as a document for ML to ingest
+}
+
+export class Tenant extends Primitive {
+	domainMemberships: string[]; // The list of all domains this tenant belongs
+	email: string;
+	emailVerified: boolean;
+	domainIdEmail: string; // The domain for which the tenant is a member because of their email
+	tagId: string;
+	picture?: string;
+	familyName?: string;
+	givenName?: string;
+}
+
+export class Domain extends Primitive {
+	domain: string;
+	public: boolean;
+}
+
+export class Person extends Tag {
+	tenantIdVerified: string; // The tenant._id that claimed/verified this tag as being them
+	email: string;
+	inviteStatus?: InviteStatus;
+}
+
+export class Note extends Primitive {
+	tenantIdCreated: string; // The tenant._id that created the note initially
+	document: Document;
+	editors: Editor[]; // The list of people/devices that were used in creating this note
+	sharingTags: SharingTag[]; // The list of tags that this note is shared with
+	reactions?: Reaction[]; // Reactions from tenants to this primitive
+}
+
+export class Block extends Note {
+	blockType: BlockType; // The type of block being stored
+}
+
+export class Task extends Block {
+	status: TaskStatus;
+	steps?: Step[];
+	dateRemindMe?: Date;
+	dateDue: Date;
+	recurrence?: RecurrenceRFC[];
+}
+// 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
+export interface TranscriptionEntry {
+	person: Person;
+	text: string;
+	language: string;
+	startDate: Date;
+	endDate: Date;
+}
+
+export interface Transcription {
+	entries: TranscriptionEntry[];
+}
+
+export interface ConferenceEntrypoint {
+	entryPointType: string;
+	uri?: string;
+	label?: string;
+	pin?: string;
+	accessCode?: string;
+	meetingCode?: string;
+	passcode?: string;
+	password?: string;
+}
+
+export class Conference extends BusinessObject {
+	entryPoints: ConferenceEntrypoint[];
+	transcription: Transcription;
+}
+//// CONFERENCE END
+
+//// EVENT START
+export enum EventStatus {
+	Confirmed = 'confirmed',
+	Tentative = 'tentative',
+	Cancelled = 'cancelled',
+}
+
+export interface PersonAcceptance {
+	tagId: string;
+	accepted: boolean;
+}
+
+export interface Calendar extends BusinessObject {
+	description?: string;
+	location?: string;
+	timeZone: string;
+}
+
+export interface Event extends BusinessObject {
+	calendarId: string;
+	status: EventStatus;
+	subject?: string;
+	description?: string;
+	location: string;
+	startDate: Date;
+	endDate?: Date;
+	recurrence: RecurrenceRFC[];
+	originalStartDate: Date;
+	organizedBy: Person;
+	attendees?: PersonAcceptance[];
+	conference?: Conference;
+	businessObjectIds?: string[]; // Attachments
+}
+//// EVENT END
+
+//// EXTERNAL TASK START
+export class ExternalTask extends BusinessObject {
+	status: TaskStatus;
+	steps?: Step[];
+	dateRemindMe?: Date;
+	dateDue: Date;
+	recurrence?: RecurrenceRFC[];
+}
+//// EXTERNAL TASK END
+
+//// MESSAGING START
+export class Thread extends BusinessObject {}
+//// MESSAGING END
+
+//// WEBSITE START
+export interface Website extends BusinessObject {}
+//// WEBSITE END
+
+// BUSINESS OBJECTS END
+
+// METADATA OBJECTS START
+
+//// FOR DOCUMENTS START
+export interface BlockDescription {
+	title?: string;
+	name: string;
+	description: string;
+	blockType: BlockType;
+}
+
+export interface DocumentMetadata {
+	contentBlocks: BlockDescription[];
+}
+
+export class Template extends BusinessObject {
+	metadata: DocumentMetadata;
+}
+//// FOR DOCUMENTS END
+
+//// FOR RECORDS START
+export enum FieldType {
+	Text = 'input',
+	Select = 'select',
+	Checkbox = 'checkbox',
+	Identifier = 'identifier',
+}
+
+export enum FieldVariation {
+	Multi = 'multi',
+	Password = 'password',
+	Email = 'email',
+	Date = 'date',
+	Currency = 'currency',
+	DateTime = 'datetime',
+	Phone = 'phone',
+	Url = 'url',
+}
+
+export interface Option {
+	label: string;
+	value: string;
+}
+
+export interface Field {
+	label?: string;
+	name: string;
+	description: string;
+	doMonitor: boolean;
+	fieldType: FieldType;
+	fieldVariation?: FieldVariation;
+	order: number;
+	maximumCharacters?: number;
+	isReadOnly: boolean;
+	options?: Option[];
+}
+
+export interface FieldValue {
+	name: string;
+	previousValue: string;
+	nextValue: string;
+	value: string;
+	changed: boolean;
+}
+
+export interface TableMetadata {
+	label: string;
+	name: string;
+	description: string;
+	fields: Field[];
+}
+
+export class Table extends BusinessObject {
+	recordType: string;
+	metadata: TableMetadata;
+	values: FieldValue[];
+}
+//// FOR RECORDS END
+
+// METADATA OBJECTS END

package/package.json

@@ -0,0 +1,15 @@
+{
+	"author": "Bigfoot",
+	"name": "@bigfootai/bigfoot-types",
+	"version": "2.1.0",
+	"description": "The internal library for the types used in the Bigfoot platform",
+	"main": "index.js",
+	"license": "ISC",
+	"repository": "Notify-AI/bigfoot-types",
+	"dependencies": {
+		"uuid": "^9.0.1"
+	},
+	"devDependencies": {
+		"ts-node": "^10.9.2"
+	}
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"module": "ESNext",
+		"skipLibCheck": true,
+
+		/* Linting */
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noFallthroughCasesInSwitch": true
+	}
+}