consts

Type Aliases

CurrentRESTAPIVersions

type CurrentRESTAPIVersions = typeof currentRESTAPIVersions[number];

Defined in: studiocms/packages/studiocms/src/consts.ts:47

Current REST API Versions Type

---

StudioCMSSocials

type StudioCMSSocials = {
  discord: string;
  github: string;
  githubContributors: string;
  githubLicense: string;
};

Defined in: studiocms/packages/studiocms/src/consts.ts:80

StudioCMS Social Links Type

Properties

discord

discord: string;

Defined in: studiocms/packages/studiocms/src/consts.ts:84

github

github: string;

Defined in: studiocms/packages/studiocms/src/consts.ts:81

githubContributors

githubContributors: string;

Defined in: studiocms/packages/studiocms/src/consts.ts:83

githubLicense

githubLicense: string;

Defined in: studiocms/packages/studiocms/src/consts.ts:82

Variables

authAPIRoute()

const authAPIRoute: (route: string) => string;

Defined in: studiocms/packages/studiocms/src/consts.ts:121

Parameters

route

string

Returns

string

---

CMSMailerConfigId

const CMSMailerConfigId: string = '1';

Defined in: studiocms/packages/studiocms/src/consts.ts:12

StudioCMS Mailer Config Table Entry ID

---

CMSNotificationSettingsId

const CMSNotificationSettingsId: string = '1';

Defined in: studiocms/packages/studiocms/src/consts.ts:17

StudioCMS Notification Settings Table Entry ID

---

CMSSiteConfigId

const CMSSiteConfigId: number = 1;

Defined in: studiocms/packages/studiocms/src/consts.ts:7

StudioCMS Site Config Table Entry ID

---

currentRESTAPIVersions

const currentRESTAPIVersions: readonly ["v1"];

Defined in: studiocms/packages/studiocms/src/consts.ts:42

Current REST API Versions

---

dashboardAPIRoute()

const dashboardAPIRoute: (route: string) => string;

Defined in: studiocms/packages/studiocms/src/consts.ts:119

Parameters

route

string

Returns

string

---

defaultCacheLifeTime

const defaultCacheLifeTime: TimeString = '5m';

Defined in: studiocms/packages/studiocms/src/consts.ts:24

The default lifetime for cached items. This value is used to determine how long an item should remain in the cache before it is considered expired. This value is used in ./schemas/config/sdk.ts to set the default cache lifetime.

---

GhostUserDefaults

const GhostUserDefaults: {
  avatar: string;
  id: string;
  name: string;
  username: string;
};

Defined in: studiocms/packages/studiocms/src/consts.ts:101

Default values for a “ghost” user in StudioCMS. This user represents a deleted user in the system.

Type declaration

avatar

avatar: string = 'https://seccdn.libravatar.org/static/img/mm/80.png';

id

id: string = '_StudioCMS_Ghost_User_';

name

name: string = 'Ghost (deleted user)';

username

username: string = 'studiocms_ghost_user';

---

NotificationSettingsDefaults

const NotificationSettingsDefaults: {
  emailVerification: boolean;
  id: string;
  oAuthBypassVerification: boolean;
  requireAdminVerification: boolean;
  requireEditorVerification: boolean;
};

Defined in: studiocms/packages/studiocms/src/consts.ts:111

Default values for the site Notifications configuration.

Type declaration

emailVerification

emailVerification: boolean = false;

id

id: string = CMSNotificationSettingsId;

oAuthBypassVerification

oAuthBypassVerification: boolean = false;

requireAdminVerification

requireAdminVerification: boolean = false;

requireEditorVerification

requireEditorVerification: boolean = false;

---

routesDir

const routesDir: {
  api: (file: string) => string;
  authAPI: (file: string) => string;
  authPage: (file: string) => string;
  dashApi: (file: string) => string;
  dashRoute: (file: string) => string;
  errors: (file: string) => string;
  fts: (file: string) => string;
  mailer: (file: string) => string;
  middleware: (file: string) => string;
  sdk: (file: string) => string;
  v1Rest: (file: string) => string;
};

Defined in: studiocms/packages/studiocms/src/consts.ts:63

REST API Directory

Type declaration

api()

api: (file: string) => string;

Parameters

file

string

Returns

string

authAPI()

authAPI: (file: string) => string;

Parameters

file

string

Returns

string

authPage()

authPage: (file: string) => string;

Parameters

file

string

Returns

string

dashApi()

dashApi: (file: string) => string;

Parameters

file

string

Returns

string

dashRoute()

dashRoute: (file: string) => string;

Parameters

file

string

Returns

string

errors()

errors: (file: string) => string;

Parameters

file

string

Returns

string

fts()

fts: (file: string) => string;

Parameters

file

string

Returns

string

mailer()

mailer: (file: string) => string;

Parameters

file

string

Returns

string

middleware()

middleware: (file: string) => string;

Parameters

file

string

Returns

string

sdk()

sdk: (file: string) => string;

Parameters

file

string

Returns

string

v1Rest()

v1Rest: (file: string) => string;

Parameters

file

string

Returns

string

---

StudioCMSMarkdownDefaults

const StudioCMSMarkdownDefaults: {
  autoLinkHeadings: boolean;
  callouts: false;
  discordSubtext: boolean;
  flavor: "studiocms";
};

Defined in: studiocms/packages/studiocms/src/consts.ts:133

Type declaration

autoLinkHeadings

autoLinkHeadings: boolean = false;

callouts

callouts: false;

discordSubtext

discordSubtext: boolean = false;

flavor

flavor: "studiocms";

---

studioCMSSocials

const studioCMSSocials: StudioCMSSocials;

Defined in: studiocms/packages/studiocms/src/consts.ts:90

StudioCMS Social Links

---

versionCacheLifetime

const versionCacheLifetime: number;

Defined in: studiocms/packages/studiocms/src/consts.ts:37

The default lifetime for cached items in milliseconds. This value is used to determine how long an item should remain in the cache before it is considered expired.

Functions

makeDashboardRoute()

function makeDashboardRoute(route?: string): (path: string) => string

Defined in: studiocms/packages/studiocms/src/consts.ts:123

Parameters

route?

string

Returns

Function

Parameters

path

string

Returns

string