@bigfootai/bigfoot-types 2.1.0 → 2.3.0

package/README.md

@@ -1,51 +1 @@
-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"
-}
-}
-}
-]
-}
+Nothing to see here

package/model.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Thread = exports.ExternalTask = exports.EventStatus = exports.Conference = exports.Task = exports.Block = exports.Note = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = exports.Tag = exports.Primitive = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.TagType = exports.BlockType = exports.BusinessObjectType = void 0;
+const uuid_1 = require("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
+var BusinessObjectType;
+(function (BusinessObjectType) {
+    BusinessObjectType["Event"] = "event";
+    BusinessObjectType["Task"] = "task";
+    BusinessObjectType["Document"] = "document";
+    BusinessObjectType["Record"] = "record";
+    BusinessObjectType["Conference"] = "conference";
+    BusinessObjectType["Message"] = "message";
+    BusinessObjectType["Website"] = "website";
+})(BusinessObjectType || (exports.BusinessObjectType = BusinessObjectType = {}));
+var BlockType;
+(function (BlockType) {
+    BlockType["Section"] = "section";
+    BlockType["Task"] = "task";
+    BlockType["Data"] = "data";
+})(BlockType || (exports.BlockType = BlockType = {}));
+var TagType;
+(function (TagType) {
+    TagType["Person"] = "person";
+    TagType["Topic"] = "topic";
+})(TagType || (exports.TagType = TagType = {}));
+var SharingLevel;
+(function (SharingLevel) {
+    SharingLevel[SharingLevel["ReadOnly"] = 0] = "ReadOnly";
+    SharingLevel[SharingLevel["Editor"] = 1] = "Editor";
+    SharingLevel[SharingLevel["Owner"] = 2] = "Owner";
+})(SharingLevel || (exports.SharingLevel = SharingLevel = {}));
+var TaskStatus;
+(function (TaskStatus) {
+    TaskStatus[TaskStatus["NotStarted"] = 0] = "NotStarted";
+    TaskStatus[TaskStatus["InProgress"] = 1] = "InProgress";
+    TaskStatus[TaskStatus["Completed"] = 10] = "Completed";
+})(TaskStatus || (exports.TaskStatus = TaskStatus = {}));
+var StepStatus;
+(function (StepStatus) {
+    StepStatus[StepStatus["NotStarted"] = 0] = "NotStarted";
+    StepStatus[StepStatus["Completed"] = 10] = "Completed";
+})(StepStatus || (exports.StepStatus = StepStatus = {}));
+var SharingApproach;
+(function (SharingApproach) {
+    SharingApproach[SharingApproach["Inline"] = 0] = "Inline";
+    SharingApproach[SharingApproach["Explicit"] = 1] = "Explicit";
+    SharingApproach[SharingApproach["Automated"] = 2] = "Automated";
+})(SharingApproach || (exports.SharingApproach = SharingApproach = {}));
+var InviteStatus;
+(function (InviteStatus) {
+    InviteStatus[InviteStatus["NotInvited"] = 0] = "NotInvited";
+    InviteStatus[InviteStatus["InviteSent"] = 1] = "InviteSent";
+    InviteStatus[InviteStatus["InviteAccepted"] = 2] = "InviteAccepted";
+})(InviteStatus || (exports.InviteStatus = InviteStatus = {}));
+var RecurrenceRFC;
+(function (RecurrenceRFC) {
+    RecurrenceRFC["FREQ"] = "FREQ";
+    RecurrenceRFC["UNTIL"] = "UNTIL";
+    RecurrenceRFC["COUNT"] = "COUNT";
+    RecurrenceRFC["INTERVAL"] = "INTERVAL";
+    RecurrenceRFC["BYDAY"] = "BYDAY";
+    RecurrenceRFC["BYMONTH"] = "BYMONTH";
+    RecurrenceRFC["BYMONTHDAY"] = "BYMONTHDAY";
+    RecurrenceRFC["BYYEARDAY"] = "BYYEARDAY";
+    RecurrenceRFC["BYWEEKNO"] = "BYWEEKNO";
+    RecurrenceRFC["BYHOUR"] = "BYHOUR";
+    RecurrenceRFC["BYMINUTE"] = "BYMINUTE";
+    RecurrenceRFC["BYSECOND"] = "BYSECOND";
+    RecurrenceRFC["MONDAY"] = "MO";
+    RecurrenceRFC["TUESDAY"] = "TU";
+    RecurrenceRFC["WEDNESDAY"] = "WE";
+    RecurrenceRFC["THURSDAY"] = "TH";
+    RecurrenceRFC["FRIDAY"] = "FR";
+    RecurrenceRFC["SATURDAY"] = "SA";
+    RecurrenceRFC["SUNDAY"] = "SU";
+})(RecurrenceRFC || (exports.RecurrenceRFC = RecurrenceRFC = {}));
+class Primitive {
+    constructor() {
+        this._id = (0, uuid_1.v4)();
+        const now = Date.now();
+        this.dateCreated = now;
+        this.dateUpdated = now;
+    }
+}
+exports.Primitive = Primitive;
+class Tag extends Primitive {
+}
+exports.Tag = Tag;
+class BusinessObject extends Primitive {
+}
+exports.BusinessObject = BusinessObject;
+class Tenant extends Primitive {
+}
+exports.Tenant = Tenant;
+class Domain extends Primitive {
+}
+exports.Domain = Domain;
+class Person extends Tag {
+}
+exports.Person = Person;
+class Note extends Primitive {
+}
+exports.Note = Note;
+class Block extends Note {
+}
+exports.Block = Block;
+class Task extends Block {
+}
+exports.Task = Task;
+class Conference extends BusinessObject {
+}
+exports.Conference = Conference;
+//// CONFERENCE END
+//// EVENT START
+var EventStatus;
+(function (EventStatus) {
+    EventStatus["Confirmed"] = "confirmed";
+    EventStatus["Tentative"] = "tentative";
+    EventStatus["Cancelled"] = "cancelled";
+})(EventStatus || (exports.EventStatus = EventStatus = {}));
+//// EVENT END
+//// EXTERNAL TASK START
+class ExternalTask extends BusinessObject {
+}
+exports.ExternalTask = ExternalTask;
+//// EXTERNAL TASK END
+//// MESSAGING START
+class Thread extends BusinessObject {
+}
+exports.Thread = Thread;
+class Template extends BusinessObject {
+}
+exports.Template = Template;
+//// FOR DOCUMENTS END
+//// FOR RECORDS START
+var FieldType;
+(function (FieldType) {
+    FieldType["Text"] = "input";
+    FieldType["Select"] = "select";
+    FieldType["Checkbox"] = "checkbox";
+    FieldType["Identifier"] = "identifier";
+})(FieldType || (exports.FieldType = FieldType = {}));
+var FieldVariation;
+(function (FieldVariation) {
+    FieldVariation["Multi"] = "multi";
+    FieldVariation["Password"] = "password";
+    FieldVariation["Email"] = "email";
+    FieldVariation["Date"] = "date";
+    FieldVariation["Currency"] = "currency";
+    FieldVariation["DateTime"] = "datetime";
+    FieldVariation["Phone"] = "phone";
+    FieldVariation["Url"] = "url";
+})(FieldVariation || (exports.FieldVariation = FieldVariation = {}));
+class Table extends BusinessObject {
+}
+exports.Table = Table;
+//// FOR RECORDS END
+// METADATA OBJECTS END

package/model.ts

@@ -46,8 +46,7 @@ export enum StepStatus {
 
 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
+	Explicit = 1, // The user explicitly shared the tag, or the system did, without it being in the note
 }
 
 export enum InviteStatus {

package/package.json

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

package/tsconfig.json

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