lib/routeMap

Variables

StudioCMSRoutes

const StudioCMSRoutes: {
  authLinks: {
     auth0Callback: string;
     auth0Index: string;
     discordCallback: string;
     discordIndex: string;
     forgotPasswordAPI: string;
     githubCallback: string;
     githubIndex: string;
     googleCallback: string;
     googleIndex: string;
     loginAPI: string;
     loginURL: string;
     logoutAPI: string;
     logoutURL: string;
     registerAPI: string;
     signupURL: string;
    };
  endpointLinks: {
     apiTokens: string;
     config: string;
     content: {
        diff: string;
        folder: string;
        page: string;
       };
     createResetLink: string;
     emailNotificationSettingsSite: string;
     mailer: {
        config: string;
        testEmail: string;
       };
     newUsers: {
        create: string;
        invite: string;
       };
     partials: {
        editor: string;
        livePreviewBox: string;
        render: string;
        userListItems: string;
       };
     plugins: string;
     profile: string;
     resendVerificationEmail: string;
     resetPassword: string;
     searchList: string;
     updateUserNotifications: string;
     users: string;
     verifyEmail: string;
     verifySession: string;
    };
  fts: {
     step1: string;
     step2: string;
    };
  mainLinks: {
     baseSiteURL: string;
     contentManagement: string;
     contentManagementCreate: string;
     contentManagementDiff: string;
     contentManagementEdit: string;
     contentManagementFolderCreate: string;
     contentManagementFolderEdit: string;
     createPage: string;
     dashboardIndex: string;
     passwordReset: string;
     plugins: string;
     siteConfiguration: string;
     smtpConfiguration: string;
     unverifiedEmail: string;
     userManagement: string;
     userManagementEdit: string;
     userProfile: string;
    };
  sdk: {
     fallback_pages: string;
     pages: string;
     updateLatestVersionCache: string;
    };
};

Defined in: studiocms/packages/studiocms/src/lib/routeMap.ts:91

An object containing various route mappings for the StudioCMS application.

Type declaration

authLinks

authLinks: {
  auth0Callback: string;
  auth0Index: string;
  discordCallback: string;
  discordIndex: string;
  forgotPasswordAPI: string;
  githubCallback: string;
  githubIndex: string;
  googleCallback: string;
  googleIndex: string;
  loginAPI: string;
  loginURL: string;
  logoutAPI: string;
  logoutURL: string;
  registerAPI: string;
  signupURL: string;
};

authLinks.auth0Callback

auth0Callback: string;

API route for Auth0 authentication callback.

authLinks.auth0Index

auth0Index: string;

API route for Auth0 authentication index.

authLinks.discordCallback

discordCallback: string;

API route for Discord authentication callback.

authLinks.discordIndex

discordIndex: string;

API route for Discord authentication index.

authLinks.forgotPasswordAPI

forgotPasswordAPI: string;

authLinks.githubCallback

githubCallback: string;

API route for GitHub authentication callback.

authLinks.githubIndex

githubIndex: string;

API route for GitHub authentication index.

authLinks.googleCallback

googleCallback: string;

API route for Google authentication callback.

authLinks.googleIndex

googleIndex: string;

API route for Google authentication index.

authLinks.loginAPI

loginAPI: string;

API route for logging in.

authLinks.loginURL

loginURL: string;

URL for the login page.

authLinks.logoutAPI

logoutAPI: string;

API route for logging out.

authLinks.logoutURL

logoutURL: string;

URL for the logout page.

authLinks.registerAPI

registerAPI: string;

API route for registering a new user.

authLinks.signupURL

signupURL: string;

URL for the signup page.

endpointLinks

endpointLinks: {
  apiTokens: string;
  config: string;
  content: {
     diff: string;
     folder: string;
     page: string;
    };
  createResetLink: string;
  emailNotificationSettingsSite: string;
  mailer: {
     config: string;
     testEmail: string;
    };
  newUsers: {
     create: string;
     invite: string;
    };
  partials: {
     editor: string;
     livePreviewBox: string;
     render: string;
     userListItems: string;
    };
  plugins: string;
  profile: string;
  resendVerificationEmail: string;
  resetPassword: string;
  searchList: string;
  updateUserNotifications: string;
  users: string;
  verifyEmail: string;
  verifySession: string;
};

endpointLinks.apiTokens

apiTokens: string;

API route for fetching API tokens.

endpointLinks.config

config: string;

API route for fetching configuration.

endpointLinks.content

content: {
  diff: string;
  folder: string;
  page: string;
};

endpointLinks.content.diff

diff: string;

endpointLinks.content.folder

folder: string;

API route for fetching folder content.

endpointLinks.content.page

page: string;

API route for fetching page content.

endpointLinks.createResetLink

createResetLink: string;

API route for creating a password reset link.

endpointLinks.emailNotificationSettingsSite

emailNotificationSettingsSite: string;

endpointLinks.mailer

mailer: {
  config: string;
  testEmail: string;
};

API routes for the mailer configuration.

endpointLinks.mailer.config

config: string;

API route for updating the mailer configuration

endpointLinks.mailer.testEmail

testEmail: string;

API route for testing the mailer configuration.

endpointLinks.newUsers

newUsers: {
  create: string;
  invite: string;
};

endpointLinks.newUsers.create

create: string;

API route for creating a new user.

endpointLinks.newUsers.invite

invite: string;

API route for inviting a new user.

endpointLinks.partials

partials: {
  editor: string;
  livePreviewBox: string;
  render: string;
  userListItems: string;
};

endpointLinks.partials.editor

editor: string;

API route for the editor.

endpointLinks.partials.livePreviewBox

livePreviewBox: string;

API route for live preview box rendering.

endpointLinks.partials.render

render: string;

API route for rendering content.

endpointLinks.partials.userListItems

userListItems: string;

API route for fetching user list items.

endpointLinks.plugins

plugins: string;

API route for fetching plugins.

endpointLinks.profile

profile: string;

API route for fetching user profile.

endpointLinks.resendVerificationEmail

resendVerificationEmail: string;

endpointLinks.resetPassword

resetPassword: string;

API route for resetting password.

endpointLinks.searchList

searchList: string;

API route for searching lists.

endpointLinks.updateUserNotifications

updateUserNotifications: string;

endpointLinks.users

users: string;

API route for fetching users.

endpointLinks.verifyEmail

verifyEmail: string;

endpointLinks.verifySession

verifySession: string;

API route for verifying a user session.

fts

fts: {
  step1: string;
  step2: string;
};

fts.step1

step1: string;

API route for step 1 of the FTS process.

fts.step2

step2: string;

API route for step 2 of the FTS process.

mainLinks

mainLinks: {
  baseSiteURL: string;
  contentManagement: string;
  contentManagementCreate: string;
  contentManagementDiff: string;
  contentManagementEdit: string;
  contentManagementFolderCreate: string;
  contentManagementFolderEdit: string;
  createPage: string;
  dashboardIndex: string;
  passwordReset: string;
  plugins: string;
  siteConfiguration: string;
  smtpConfiguration: string;
  unverifiedEmail: string;
  userManagement: string;
  userManagementEdit: string;
  userProfile: string;
};

mainLinks.baseSiteURL

baseSiteURL: string;

Base URL for the non-dashboard site.

mainLinks.contentManagement

contentManagement: string;

URL for the content management page.

mainLinks.contentManagementCreate

contentManagementCreate: string;

URL for creating content in the content management page.

mainLinks.contentManagementDiff

contentManagementDiff: string;

URL for viewing content differences in the content management page.

mainLinks.contentManagementEdit

contentManagementEdit: string;

URL for editing content in the content management page.

mainLinks.contentManagementFolderCreate

contentManagementFolderCreate: string;

URL for creating a folder in the content management page.

mainLinks.contentManagementFolderEdit

contentManagementFolderEdit: string;

URL for editing a folder in the content management page.

mainLinks.createPage

createPage: string;

URL for creating a new page.

mainLinks.dashboardIndex

dashboardIndex: string;

URL for the dashboard index.

mainLinks.passwordReset

passwordReset: string;

mainLinks.plugins

plugins: string;

URL for the plugins page.

mainLinks.siteConfiguration

siteConfiguration: string;

URL for the site configuration page.

mainLinks.smtpConfiguration

smtpConfiguration: string;

URL for the smtp configuration page.

mainLinks.unverifiedEmail

unverifiedEmail: string;

URL for unverified email page.

mainLinks.userManagement

userManagement: string;

URL for the user management page.

mainLinks.userManagementEdit

userManagementEdit: string;

URL for editing user management details.

mainLinks.userProfile

userProfile: string;

URL for the user profile page.

sdk

sdk: {
  fallback_pages: string;
  pages: string;
  updateLatestVersionCache: string;
};

sdk.fallback_pages

fallback_pages: string;

SDK route for fetching fallback list of pages.

sdk.pages

pages: string;

SDK route for listing pages.

sdk.updateLatestVersionCache

updateLatestVersionCache: string;

SDK route for updating the latest version cache.

Functions

getDeleteRoute()

function getDeleteRoute(slug: string): string

Defined in: studiocms/packages/studiocms/src/lib/routeMap.ts:34

Generates a delete route for a given page slug.

Parameters

slug

string

The slug of the page to be deleted.

Returns

string

The complete delete route for the specified page.

---

getEditRoute()

function getEditRoute(slug: string): string

Defined in: studiocms/packages/studiocms/src/lib/routeMap.ts:24

Generates the edit route for a given page slug.

Parameters

slug

string

The slug of the page to generate the edit route for.

Returns

string

The edit route as a string.

---

getSluggedRoute()

function getSluggedRoute(url: string, slug: string): string

Defined in: studiocms/packages/studiocms/src/lib/routeMap.ts:14

Generates a slugged route by appending the provided slug to the given URL.

Parameters

url

string

The base URL to which the slug will be appended.

slug

string

The slug to append to the base URL.

Returns

string

The complete slugged route as a string.

---

makeDashboardRoute()

function makeDashboardRoute(route?: string): string

Defined in: studiocms/packages/studiocms/src/lib/routeMap.ts:54

Generates a URL for the dashboard route.

Parameters

route?

string

An optional string representing the specific route to append to the dashboard URL.

Returns

string

The generated dashboard URL as a string.

---

makeNonDashboardRoute()

function makeNonDashboardRoute(route?: string): string

Defined in: studiocms/packages/studiocms/src/lib/routeMap.ts:44

Generates a non-dashboard route URL.

Parameters

route?

string

The optional route string to be appended. If not provided, a default route will be used.

Returns

string

The generated non-dashboard route URL as a string.