Global

Members

(constant) ENCRYPTION_KEY

How this encryption key was generated 👇

Source:

• lib/security/encryption.js, line 13

Example

import crypto from "crypto";

crypto.randomBytes(32).toString('hex');

(constant) cookiePolicyMap

TODO: Evaluate if it's best to break these components into JSONs so we can have a single components pointing to the translations.

Source:

• lib/legal/cookies-policy/index.jsx, line 10

(constant) privacyPolicyMap

TODO: Evaluate if it's best to break these components into JSONs so we can have a single components pointing to the translations.

Source:

• lib/legal/privacy-policy/index.jsx, line 10

(constant) termsAndConditionsMap

TODO: Evaluate if it's best to break these components into JSONs so we can have a single components pointing to the translations.

Source:

• lib/legal/terms-and-conditions/index.jsx, line 10

Methods

Editor()

The editor which is used to create the annotation.

Source:

• components/editor/index.jsx, line 68

MainNavigation()

Navigation items are organized by usage order (data from G.A.)

Source:

• components/dashboard.jsx, line 138

addMissingAICommentData()

Source:

• lib/db/migrations.js, line 60

addMissingWordFreqData()

Source:

• lib/db/migrations.js, line 11

connectToDatabase()

Connects to the database and returns the database object.

Source:

• lib/db/mongodb.js, line 49

cosineSimilarity(vecA, vecB) → {number}

Function to calculate cosine similarity between two vectors

Parameters:

Source:

• lib/data-analysis/cosine-similarity.js, line 44

Returns:

Type

number

cosineSimilarityScore(seq1, seq2) → {number}

Function to calculate cosine similarity score between two strings

Parameters:

Source:

• lib/data-analysis/cosine-similarity.js, line 76

Returns:

Type

number

createComment(data) → {Promise.<{insertedId: string}>}

This method is responsible for creating a comment.

Parameters:

Source:

• lib/db/comments/writes.js, line 27

Returns:

Type

Promise.<{insertedId: string}>

createPost()

Method responsible for creating a post.

Source:

• lib/db/posts/writes.js, line 21

deleteAccount(userEmail) → {Promise.<{success: boolean}>}

Method responsible for deleting a user's account.

Parameters:

Source:

• lib/db/account/writes.js, line 25

Returns:

Type

Promise.<{success: boolean}>

deleteAllInboxMessages()

Deletes all inbox messages.

Source:

• lib/db/inbox/writes.js, line 50

deleteComment(commentId, postId) → {Promise.<any>}

This method is responsible for deleting a comment from a post.

Parameters:

Source:

• lib/db/comments/writes.js, line 153

Returns:

Type

Promise.<any>

deletePost(postId) → {Promise.<{success: boolean}>}

Method responsible for deleting a post

Parameters:

Source:

• lib/db/posts/writes.js, line 177

Returns:

Type

Promise.<{success: boolean}>

deleteSomeInboxMessages()

Deletes the inbox messages with the provided IDs.

Source:

• lib/db/inbox/writes.js, line 63

dotProduct(vecA, vecB) → {number}

Function to calculate the dot product of two vectors

Parameters:

Source:

• lib/data-analysis/cosine-similarity.js, line 9

Returns:

Type

number

generateUrlLoc(pages)

Generates an XML URL loc

Parameters:

Source:

• scripts/generate-sitemap.js, line 29

getAccountsCollection()

Connects to the database and gets the users collection.

Source:

• lib/db/mongodb.js, line 131

getAuthProps()

Must be used on every authenticated page

Source:

• lib/auth.js, line 24

Example

export default function Page(props) {
  const { serverSession } = props;

  if (serverSession?.user) {
    return <Authenticated serverSession={serverSession} />;
  }

  return <NotAuthenticated/>;
}

export async function getServerSideProps(context) {
   return getAuthProps(context);
}

getCommandOptionValue()

Get the value from the option passed into the command.

Source:

• components/editor/react-component-utils.jsx, line 15

getCommentById(commentId)

Gets a comment on a publication by its id

Parameters:

Source:

• lib/db/comments/reads.js, line 64

getComments(postId)

Gets all the comments from a publication

Parameters:

Source:

• lib/db/comments/reads.js, line 10

getCommentsByUserId(userId)

Gets all the comments from a user

Parameters:

Source:

• lib/db/comments/reads.js, line 43

getCommentsCollection()

Connects to the database and gets the comments collection.

Source:

• lib/db/mongodb.js, line 83

getCompletionsCollection()

Connects to the database and gets the completions collection.

Source:

• lib/db/mongodb.js, line 104

getCosineSimilarityCollection()

Connects to the database and gets the cosine_similarity collection.

Source:

• lib/db/mongodb.js, line 114

getInbox(userEmail)

Gets the inbox data of a user

Parameters:

Source:

• lib/db/inbox/reads.js, line 8

getInboxCollection()

Connects to the database and gets the inbox collection.

Source:

• lib/db/mongodb.js, line 97

getInboxCount(userEmail)

Gets the count of unread messages in the inbox

Parameters:

Source:

• lib/db/inbox/reads.js, line 29

getLatestPublicPosts()

Gets the latest public posts from a user

Source:

• lib/db/posts/reads.js, line 119

getMongoClient()

Gets and resolves the MongoDB client promise.

Source:

• lib/db/mongodb.js, line 63

getPostById(postId)

Get a post by its id and optionally filter the results

Parameters:

Source:

• lib/db/posts/reads.js, line 11

getPosts(userEmail)

Get all the posts from a user

Parameters:

Source:

• lib/db/posts/reads.js, line 43

getPostsCollection()

Connects to the database and gets the posts collection.

Source:

• lib/db/mongodb.js, line 76

getPostsInsights(userEmail)

Gets the insights from the posts of a user

Parameters:

Source:

• lib/db/posts/reads.js, line 83

getShortcutString()

Get a normalized shortcut as a string.

Source:

• components/editor/react-component-utils.jsx, line 60

getStar(userEmail, postId)

Gets a star from a specific publication by its id

Parameters:

Source:

• lib/db/stars/reads.js, line 77

getStarredPosts(userEmail)

Gets all the starred posts from a user

Parameters:

Source:

• lib/db/stars/reads.js, line 57

getStarsByUserEmail(userEmail)

Gets all the stars from a user

Parameters:

Source:

• lib/db/stars/reads.js, line 38

getStarsCollection()

Connects to the database and gets the stars collection.

Source:

• lib/db/mongodb.js, line 90

getUiShortcutString()

Get the string value from the available UI Shortcut.

Source:

• components/editor/react-component-utils.jsx, line 30

getUserByEmail(userEmail)

Gets an user by its email

Parameters:

Source:

• lib/db/users/reads.js, line 9

getUserById(userId)

Gets an user by its id

Parameters:

Source:

• lib/db/users/reads.js, line 30

getUsersCollection()

Connects to the database and gets the users collection.

Source:

• lib/db/mongodb.js, line 123

hasAiCommentedOnPost(postId) → {Promise.<boolean>}

Checks if the AI has commented on a post

Parameters:

Source:

• lib/db/reads.js, line 18

Returns:

Type

Promise.<boolean>

hasCommentedOnPost(userName, postId) → {Promise.<boolean>}

Checks whether a user has commented on a post or not

Parameters:

Source:

• lib/db/comments/reads.js, line 89

Returns:

Type

Promise.<boolean>

hitChiron()

Hit Chiron with data for AI training.

Source:

• lib/chiron.js, line 7

isStringArray()

Checks whether the first element in an array is a string and assumes the whole array is a string array.

Source:

• components/editor/react-component-utils.jsx, line 23

magnitude(vec) → {number}

Function to calculate the magnitude of a vector

Parameters:

Source:

• lib/data-analysis/cosine-similarity.js, line 26

Returns:

Type

number

markAllInboxMessagesAsRead()

Marks all inbox messages as read.

Source:

• lib/db/inbox/writes.js, line 29

markSomeInboxMessagesAsRead()

Marks some inbox messages as read.

Source:

• lib/db/inbox/writes.js, line 7

module:pages()

The home page and landing page.

Source:

• pages/index.jsx, line 11

module:pages/api/auth/error()

This page is shown when the user encounters an error while signing up or signing in.

Source:

• pages/auth/error.jsx, line 14

module:pages/api/auth/signin(props)

Sign in page.

Parameters:

Source:

• pages/auth/signin.jsx, line 41

module:pages/dreams(props)

The home page for logged in users.

Parameters:

Source:

• pages/dreams/index.jsx, line 19

module:pages/dreams/:dreamId(props)

Dream page.

Parameters:

Source:

• pages/dreams/[dreamId].jsx, line 20

module:pages/publish/:postId(props)

The page for editing a dream.

Parameters:

Source:

• pages/publish/[postId].jsx, line 17

searchPosts(query)

Fuzzy searches posts from all users given a query

Parameters:

Source:

• lib/db/posts/reads.js, line 143

starPost(data) → {Promise.<{insertedId: string}>}

This method is responsible for starring a post.

Parameters:

Source:

• lib/db/stars/writes.js, line 25

Returns:

Type

Promise.<{insertedId: string}>

text()

Email Text body (fallback for email clients that don't render HTML, e.g.

Source:

• pages/api/auth/[...nextauth].js, line 121

textToFreqMap(text) → {object}

Function to convert text to a frequency map

Parameters:

Source:

• lib/data-analysis/cosine-similarity.js, line 57

Returns:

Type

object

unstarPost()

This method is responsible for unstarring a post.

Source:

• lib/db/stars/writes.js, line 91

updatePost()

Updates a post, auto-saving it.

Source:

• lib/db/posts/writes.js, line 52

updatePostVisibility(postId, visibility, userEmail) → {Promise.<{success: boolean}>}

Method responsible for updating a dream's visibility.

Parameters:

Source:

• lib/db/posts/writes.js, line 98

Returns:

Type

Promise.<{success: boolean}>

updateUser(data) → {Promise.<boolean>}

Updates the user's data.

Parameters:

Source:

• lib/api/users.js, line 7

Returns:

Type

Promise.<boolean>

updateUser(userId, data)

Updates a user's account with the provided data.

Parameters:

Source:

• lib/db/users/writes.js, line 10