Global

Members

(constant) ENCRYPTION_KEY

How this encryption key was generated 👇

Source:

• lib/encryption.js, line 13

Example

import crypto from "crypto";

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

Methods

Editor()

The editor which is used to create the annotation.

Source:

• components/editor/index.js, line 68

MainNavigation()

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

Source:

• components/dashboard.js, line 138

addMissingAICommentData()

Source:

• lib/db/migrations.js, line 60

addMissingWordFreqData()

Source:

• lib/db/migrations.js, line 11

completionsReviewHandler()

This endpoint is hit by Chiron after a review is completed.

Source:

• pages/api/data/completions-review.js, line 15

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

This method is responsible for creating a comment.

Parameters:

Source:

• lib/db/writes.js, line 317

Returns:

Type

Promise.<{insertedId: string}>

createDream()

Source:

• lib/db/writes.js, line 35

To Do:

• document this

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

Method responsible for deleting a user's account.

Parameters:

Source:

• lib/db/writes.js, line 224

Returns:

Type

Promise.<{success: boolean}>

deleteAllInboxMessages()

Source:

• lib/db/writes.js, line 622

To Do:

• document this

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

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

Parameters:

Source:

• lib/db/writes.js, line 443

Returns:

Type

Promise.<any>

deleteDream(dreamId) → {Promise.<{success: boolean}>}

Method responsible for deleting a dream.

Parameters:

Source:

• lib/db/writes.js, line 189

Returns:

Type

Promise.<{success: boolean}>

deleteSomeInboxMessages()

Source:

• lib/db/writes.js, line 635

To Do:

• document this

generateCompletion(dreamId, text, session, userId)

Starts the completion generation process, which is followed by a human-in-the-loop review process until it gets back to this service

session and userId params are optional because this method has two possible workflows, one using the session and the other using the userIds.

Parameters:

Source:

• lib/db/writes.js, line 708

generateUrlLoc(pages)

Generates an XML URL loc

Parameters:

Source:

• scripts/generate-sitemap.js, line 29

getAccountsCollection()

This collection is automatically generated by next-auth

Source:

• lib/mongodb.js, line 96

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.js, line 15

getDreamById(dreamId)

Get a dream by its id and optionally filter the results

Parameters:

Source:

• lib/db/reads.js, line 16

getLatestPublicDreams()

Source:

• lib/db/reads.js, line 120

getShortcutString()

Get a normalized shortcut as a string.

Source:

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

getUiShortcutString()

Get the string value from the available UI Shortcut.

Source:

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

getUserByEmail()

Source:

• lib/db/reads.js, line 142

getUserById()

Source:

• lib/db/reads.js, line 161

getUsersCollection()

This collection is automatically generated by next-auth

Source:

• lib/mongodb.js, line 89

hasAiCommentedOnDream(dreamId)

Checks if the AI has commented on a dream

Parameters:

Source:

• lib/db/reads.js, line 411

To Do:

• Make it more efficient by using a single query

hitChiron()

Hit Chiron with data for AI training.

Source:

• lib/chiron.js, line 6

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.js, line 23

markAllInboxMessagesAsRead()

Source:

• lib/db/writes.js, line 601

To Do:

• document this

markSomeInboxMessagesAsRead()

Source:

• lib/db/writes.js, line 579

To Do:

• document this

module:pages()

The home page and landing page.

Source:

• pages/index.js, 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.js, line 14

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

Sign in page.

Parameters:

Source:

• pages/auth/signin.js, line 41

module:pages/dreams(props)

The home page for logged in users.

Parameters:

Source:

• pages/dreams/index.js, line 19

module:pages/dreams/:dreamId(props)

Dream page.

Parameters:

Source:

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

module:pages/publish/:postId(props)

The page for editing a dream.

Parameters:

Source:

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

saveCompletion(completion, dreamId, userEmail, userId)

Saves a completion to the database

Parameters:

Source:

• lib/db/writes.js, line 657

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

This method is responsible for starring a dream.

Parameters:

Source:

• lib/db/writes.js, line 481

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

unstarDream()

Source:

• lib/db/writes.js, line 547

To Do:

• document this

updateDream()

Source:

• lib/db/writes.js, line 64

To Do:

• document this

updateDreamVisibility(dreamId, visibility, userEmail) → {Promise.<{success: boolean}>}

Method responsible for updating a dream's visibility.

Parameters:

Source:

• lib/db/writes.js, line 110

Returns:

Type

Promise.<{success: boolean}>