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

generateUrlLoc(pages)

Generates an XML URL loc

Parameters:

Source:

• scripts/generate-sitemap.js, line 29

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

getCommentById(commentId)

Gets a comment on a publication by its id

Parameters:

Source:

• lib/db/reads.js, line 360

getDreamById(dreamId)

Get a dream by its id and optionally filter the results

Parameters:

Source:

• lib/db/reads.js, line 16

getInbox(userEmail)

Gets the inbox data of a user

Parameters:

Source:

• lib/db/reads.js, line 324

getInboxCount(userEmail)

Gets the count of unread messages in the inbox

Parameters:

Source:

• lib/db/reads.js, line 345

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

getStar(userEmail, postId)

Gets a star from a specific publication by its id

Parameters:

Source:

• lib/db/reads.js, line 384

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

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

Checks if the AI has commented on a dream

Parameters:

Source:

• lib/db/reads.js, line 427

Returns:

Type

Promise.<boolean>

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

Checks whether a user has commented on a post or not

Parameters:

Source:

• lib/db/reads.js, line 411

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

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

text()

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

Source:

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

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

Updates the user's data.

Parameters:

Source:

• lib/api.js, line 96

Returns:

Type

Promise.<boolean>