sdk/types

Interfaces

'Read the “', Interfaces, '” section'

BaseCacheObject

'Read the “', BaseCacheObject, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:128

Represents a base cache object with a timestamp of the last cache update.

Extended by

'Read the “', Extended by, '” section'

• PageDataCacheObject
• SiteConfigCacheObject
• VersionCacheObject
• FolderTreeCacheObject
• FolderListCacheObject

Properties

'Read the “', Properties, '” section'

lastCacheUpdate

'Read the “', lastCacheUpdate, '” section'

lastCacheUpdate: Date;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:129

---

CombinedPageData

'Read the “', CombinedPageData, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:243

Represents the combined data for a page, extending the stripped page data.

CombinedPageData

Extends

'Read the “', Extends, '” section'

• PageDataStripped

Properties

'Read the “', Properties, '” section'

authorId

'Read the “', authorId, '” section'

authorId: null | string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.authorId

categories

'Read the “', categories, '” section'

categories: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  parent: null | number;
  slug: string;
 }[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:245

An array of categories selected for the page.

description

'Read the “', description, '” section'

description: string;

id

'Read the “', id, '” section'

id: number;

meta

'Read the “', meta, '” section'

meta: unknown;

name

'Read the “', name, '” section'

name: string;

parent

'Read the “', parent, '” section'

parent: null | number;

slug

'Read the “', slug, '” section'

slug: string;

contentLang

'Read the “', contentLang, '” section'

contentLang: string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.contentLang

contributorIds

'Read the “', contributorIds, '” section'

contributorIds: string[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:244

An array of contributor IDs associated with the page.

defaultContent

'Read the “', defaultContent, '” section'

defaultContent:
  | undefined
  | {
  content: null | string;
  contentId: string;
  contentLang: string;
  id: string;
};

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:248

description

'Read the “', description, '” section'

description: string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.description

draft

'Read the “', draft, '” section'

draft: null | boolean;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.draft

heroImage

'Read the “', heroImage, '” section'

heroImage: string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.heroImage

id

'Read the “', id, '” section'

id: string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.id

multiLangContent

'Read the “', multiLangContent, '” section'

multiLangContent: {
  content: null | string;
  contentId: string;
  contentLang: string;
  id: string;
 }[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:247

content

'Read the “', content, '” section'

content: null | string;

contentId

'Read the “', contentId, '” section'

contentId: string;

contentLang

'Read the “', contentLang, '” section'

contentLang: string;

id

'Read the “', id, '” section'

id: string;

package

'Read the “', package, '” section'

package: string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.package

parentFolder

'Read the “', parentFolder, '” section'

parentFolder: null | string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.parentFolder

publishedAt

'Read the “', publishedAt, '” section'

publishedAt: Date;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.publishedAt

showAuthor

'Read the “', showAuthor, '” section'

showAuthor: null | boolean;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.showAuthor

showContributors

'Read the “', showContributors, '” section'

showContributors: null | boolean;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.showContributors

showOnNav

'Read the “', showOnNav, '” section'

showOnNav: boolean;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.showOnNav

slug

'Read the “', slug, '” section'

slug: string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.slug

tags

'Read the “', tags, '” section'

tags: {
  description: string;
  id: number;
  meta: unknown;
  name: string;
  slug: string;
 }[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:246

An array of tags selected for the page.

description

'Read the “', description, '” section'

description: string;

id

'Read the “', id, '” section'

id: number;

meta

'Read the “', meta, '” section'

meta: unknown;

name

'Read the “', name, '” section'

name: string;

slug

'Read the “', slug, '” section'

slug: string;

title

'Read the “', title, '” section'

title: string;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.title

updatedAt

'Read the “', updatedAt, '” section'

updatedAt: null | Date;

Inherited from

'Read the “', Inherited from, '” section'

PageDataStripped.updatedAt

urlRoute

'Read the “', urlRoute, '” section'

urlRoute: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:249

---

CombinedUserData

'Read the “', CombinedUserData, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:227

Interface representing combined user data.

This interface extends tsUsersSelect and includes additional properties for OAuth data and permissions data.

CombinedUserData

Extends

'Read the “', Extends, '” section'

• tsUsersSelect

Properties

'Read the “', Properties, '” section'

avatar

'Read the “', avatar, '” section'

avatar: null | string;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.avatar

createdAt

'Read the “', createdAt, '” section'

createdAt: null | Date;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.createdAt

email

'Read the “', email, '” section'

email: null | string;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.email

id

'Read the “', id, '” section'

id: string;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.id

name

'Read the “', name, '” section'

name: string;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.name

oAuthData

'Read the “', oAuthData, '” section'

oAuthData:
  | undefined
  | {
  provider: string;
  providerUserId: string;
  userId: string;
 }[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:228

An array of OAuth account data or undefined.

password

'Read the “', password, '” section'

password: null | string;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.password

permissionsData

'Read the “', permissionsData, '” section'

permissionsData:
  | undefined
  | {
  rank: string;
  user: string;
};

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:229

Permissions data or undefined.

updatedAt

'Read the “', updatedAt, '” section'

updatedAt: null | Date;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.updatedAt

url

'Read the “', url, '” section'

url: null | string;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.url

username

'Read the “', username, '” section'

username: string;

Inherited from

'Read the “', Inherited from, '” section'

tsUsersSelect.username

---

DeletionResponse

'Read the “', DeletionResponse, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:258

Interface representing the response received after a deletion operation.

Properties

'Read the “', Properties, '” section'

message

'Read the “', message, '” section'

message: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:260

A message providing additional information about the deletion operation.

status

'Read the “', status, '” section'

status: "error" | "success";

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:259

The status of the deletion operation.

---

FolderListCacheObject

'Read the “', FolderListCacheObject, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:191

Represents a cache object for folder list data. Extends the BaseCacheObject interface.

FolderListCacheObject

Extends

'Read the “', Extends, '” section'

• BaseCacheObject

Properties

'Read the “', Properties, '” section'

data

'Read the “', data, '” section'

data: FolderListItem[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:192

The folder list data to be cached.

lastCacheUpdate

'Read the “', lastCacheUpdate, '” section'

lastCacheUpdate: Date;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:129

Inherited from

'Read the “', Inherited from, '” section'

BaseCacheObject.lastCacheUpdate

---

FolderListItem

'Read the “', FolderListItem, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:94

Properties

'Read the “', Properties, '” section'

id

'Read the “', id, '” section'

id: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:95

name

'Read the “', name, '” section'

name: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:96

parent?

'Read the “', parent?, '” section'

optional parent: null | string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:97

---

FolderNode

'Read the “', FolderNode, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:86

Properties

'Read the “', Properties, '” section'

children

'Read the “', children, '” section'

children: FolderNode[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:91

id

'Read the “', id, '” section'

id: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:87

name

'Read the “', name, '” section'

name: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:88

page

'Read the “', page, '” section'

page: boolean;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:89

pageData

'Read the “', pageData, '” section'

pageData:
  | null
  | CombinedPageData;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:90

---

FolderTreeCacheObject

'Read the “', FolderTreeCacheObject, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:178

Represents a cache object for folder tree data. Extends the BaseCacheObject interface.

FolderTreeCacheObject

Extends

'Read the “', Extends, '” section'

• BaseCacheObject

Properties

'Read the “', Properties, '” section'

data

'Read the “', data, '” section'

data: FolderNode[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:179

The folder tree data to be cached.

lastCacheUpdate

'Read the “', lastCacheUpdate, '” section'

lastCacheUpdate: Date;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:129

Inherited from

'Read the “', Inherited from, '” section'

BaseCacheObject.lastCacheUpdate

---

PageDataCacheObject

'Read the “', PageDataCacheObject, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:141

Represents a cache object for page data. Extends the BaseCacheObject interface.

PageDataCacheObject

Extends

'Read the “', Extends, '” section'

• BaseCacheObject

Properties

'Read the “', Properties, '” section'

data

'Read the “', data, '” section'

data: CombinedPageData;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:142

The combined page data to be cached.

lastCacheUpdate

'Read the “', lastCacheUpdate, '” section'

lastCacheUpdate: Date;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:129

Inherited from

'Read the “', Inherited from, '” section'

BaseCacheObject.lastCacheUpdate

---

PageInsert

'Read the “', PageInsert, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:266

Represents the data required to insert a new page.

Properties

'Read the “', Properties, '” section'

pageContent

'Read the “', pageContent, '” section'

pageContent: CombinedInsertContent;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:268

pageData

'Read the “', pageData, '” section'

pageData: {
  authorId: null | string;
  categories: unknown;
  contentLang: string;
  contributorIds: unknown;
  description: string;
  draft: null | boolean;
  heroImage: string;
  id: string;
  package: string;
  parentFolder: null | string;
  publishedAt: Date;
  showAuthor: null | boolean;
  showContributors: null | boolean;
  showOnNav: boolean;
  slug: string;
  tags: unknown;
  title: string;
  updatedAt: null | Date;
};

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:267

authorId?

'Read the “', authorId?, '” section'

optional authorId: null | string;

categories?

'Read the “', categories?, '” section'

optional categories: unknown;

contentLang?

'Read the “', contentLang?, '” section'

optional contentLang: string;

contributorIds?

'Read the “', contributorIds?, '” section'

optional contributorIds: unknown;

description

'Read the “', description, '” section'

description: string;

draft?

'Read the “', draft?, '” section'

optional draft: null | boolean;

heroImage?

'Read the “', heroImage?, '” section'

optional heroImage: string;

id?

'Read the “', id?, '” section'

optional id: string;

package?

'Read the “', package?, '” section'

optional package: string;

parentFolder?

'Read the “', parentFolder?, '” section'

optional parentFolder: null | string;

publishedAt?

'Read the “', publishedAt?, '” section'

optional publishedAt: Date;

showAuthor?

'Read the “', showAuthor?, '” section'

optional showAuthor: null | boolean;

showContributors?

'Read the “', showContributors?, '” section'

optional showContributors: null | boolean;

showOnNav?

'Read the “', showOnNav?, '” section'

optional showOnNav: boolean;

slug

'Read the “', slug, '” section'

slug: string;

tags?

'Read the “', tags?, '” section'

optional tags: unknown;

title

'Read the “', title, '” section'

title: string;

updatedAt?

'Read the “', updatedAt?, '” section'

optional updatedAt: null | Date;

---

SiteConfigCacheObject

'Read the “', SiteConfigCacheObject, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:154

Represents a cache object for site configuration. Extends the BaseCacheObject interface.

SiteConfigCacheObject

Extends

'Read the “', Extends, '” section'

• BaseCacheObject

Properties

'Read the “', Properties, '” section'

data

'Read the “', data, '” section'

data: SiteConfig;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:155

The site configuration data.

lastCacheUpdate

'Read the “', lastCacheUpdate, '” section'

lastCacheUpdate: Date;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:129

Inherited from

'Read the “', Inherited from, '” section'

BaseCacheObject.lastCacheUpdate

---

StudioCMSCacheObject

'Read the “', StudioCMSCacheObject, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:198

Represents a cache object that stores pages and site configuration data.

Properties

'Read the “', Properties, '” section'

pages

'Read the “', pages, '” section'

pages: Map<string, PageDataCacheObject>;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:199

siteConfig

'Read the “', siteConfig, '” section'

siteConfig:
  | undefined
  | SiteConfigCacheObject;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:200

version

'Read the “', version, '” section'

version:
  | undefined
  | VersionCacheObject;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:201

---

VersionCacheObject

'Read the “', VersionCacheObject, '” section'

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:165

Represents a cache object that includes version information.

Extends

'Read the “', Extends, '” section'

• BaseCacheObject

Properties

'Read the “', Properties, '” section'

lastCacheUpdate

'Read the “', lastCacheUpdate, '” section'

lastCacheUpdate: Date;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:129

Inherited from

'Read the “', Inherited from, '” section'

BaseCacheObject.lastCacheUpdate

version

'Read the “', version, '” section'

version: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:166

The version of the cache object.

Type Aliases

'Read the “', Type Aliases, '” section'

addDatabaseEntryInsertPage

'Read the “', addDatabaseEntryInsertPage, '” section'

type addDatabaseEntryInsertPage = {
  pageContent: PageContentReturnId[];
  pageData: PageDataReturnId[];
};

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:210

Represents the structure for adding a database entry for a page.

Type declaration

'Read the “', Type declaration, '” section'

pageContent

'Read the “', pageContent, '” section'

pageContent: PageContentReturnId[];

pageData

'Read the “', pageData, '” section'

pageData: PageDataReturnId[];

---

AstroDBVirtualModule

'Read the “', AstroDBVirtualModule, '” section'

type AstroDBVirtualModule = __module;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:100

---

MultiPageInsert

'Read the “', MultiPageInsert, '” section'

type MultiPageInsert = PageInsert[];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:274

Represents an array of PageInsert objects.

---

STUDIOCMS_SDK_CACHE

'Read the “', STUDIOCMS_SDK_CACHE, '” section'

type STUDIOCMS_SDK_CACHE = STUDIOCMS_SDK_CACHEInstance["cacheModule"];

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:123

Type representing the return type of the STUDIOCMS_SDK_CACHEModule function.

---

STUDIOCMS_SDK_CACHEConstructor

'Read the “', STUDIOCMS_SDK_CACHEConstructor, '” section'

type STUDIOCMS_SDK_CACHEConstructor = typeof StudioCMSVirtualCache;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:110

Type definition for the constructor of the StudioCMS SDK Cache.

This type represents the constructor function of the StudioCMSVirtualCache class.

---

STUDIOCMS_SDK_CACHEInstance

'Read the “', STUDIOCMS_SDK_CACHEInstance, '” section'

type STUDIOCMS_SDK_CACHEInstance = InstanceType<STUDIOCMS_SDK_CACHEConstructor>;

Defined in: studiocms/packages/studiocms/src/sdk/types/index.ts:118

Type representing an instance of the STUDIOCMS SDK cache.

This type is derived from the constructor type STUDIOCMS_SDK_CACHEConstructor. It is used to define the shape of the cache instance within the STUDIOCMS SDK.

References

'Read the “', References, '” section'

AvailableLists

'Read the “', AvailableLists, '” section'

Re-exports AvailableLists

CacheConfig

'Read the “', CacheConfig, '” section'

Re-exports CacheConfig

CombinedInsertContent

'Read the “', CombinedInsertContent, '” section'

Re-exports CombinedInsertContent

CombinedRank

'Read the “', CombinedRank, '” section'

Re-exports CombinedRank

DatabaseTables

'Read the “', DatabaseTables, '” section'

Re-exports DatabaseTables

PageContentReturnId

'Read the “', PageContentReturnId, '” section'

Re-exports PageContentReturnId

PageDataCategoriesInsertResponse

'Read the “', PageDataCategoriesInsertResponse, '” section'

Re-exports PageDataCategoriesInsertResponse

PageDataReturnId

'Read the “', PageDataReturnId, '” section'

Re-exports PageDataReturnId

PageDataStripped

'Read the “', PageDataStripped, '” section'

Re-exports PageDataStripped

PageDataTagsInsertResponse

'Read the “', PageDataTagsInsertResponse, '” section'

Re-exports PageDataTagsInsertResponse

ProcessedCacheConfig

'Read the “', ProcessedCacheConfig, '” section'

Re-exports ProcessedCacheConfig

ProcessedSDKConfig

'Read the “', ProcessedSDKConfig, '” section'

Re-exports ProcessedSDKConfig

SingleRank

'Read the “', SingleRank, '” section'

Re-exports SingleRank

SiteConfig

'Read the “', SiteConfig, '” section'

Re-exports SiteConfig

tsDiffTrackingInsert

'Read the “', tsDiffTrackingInsert, '” section'

Re-exports tsDiffTrackingInsert

tsDiffTrackingSelect

'Read the “', tsDiffTrackingSelect, '” section'

Re-exports tsDiffTrackingSelect

tsOAuthAccountsSelect

'Read the “', tsOAuthAccountsSelect, '” section'

Re-exports tsOAuthAccountsSelect

tsPageContentInsert

'Read the “', tsPageContentInsert, '” section'

Re-exports tsPageContentInsert

tsPageContentSelect

'Read the “', tsPageContentSelect, '” section'

Re-exports tsPageContentSelect

tsPageDataCategoriesInsert

'Read the “', tsPageDataCategoriesInsert, '” section'

Re-exports tsPageDataCategoriesInsert

tsPageDataCategoriesSelect

'Read the “', tsPageDataCategoriesSelect, '” section'

Re-exports tsPageDataCategoriesSelect

tsPageDataInsert

'Read the “', tsPageDataInsert, '” section'

Re-exports tsPageDataInsert

tsPageDataSelect

'Read the “', tsPageDataSelect, '” section'

Re-exports tsPageDataSelect

tsPageDataTagsInsert

'Read the “', tsPageDataTagsInsert, '” section'

Re-exports tsPageDataTagsInsert

tsPageDataTagsSelect

'Read the “', tsPageDataTagsSelect, '” section'

Re-exports tsPageDataTagsSelect

tsPageFolderInsert

'Read the “', tsPageFolderInsert, '” section'

Re-exports tsPageFolderInsert

tsPageFolderSelect

'Read the “', tsPageFolderSelect, '” section'

Re-exports tsPageFolderSelect

tsPermissionsInsert

'Read the “', tsPermissionsInsert, '” section'

Re-exports tsPermissionsInsert

tsPermissionsSelect

'Read the “', tsPermissionsSelect, '” section'

Re-exports tsPermissionsSelect

tsSessionTableInsert

'Read the “', tsSessionTableInsert, '” section'

Re-exports tsSessionTableInsert

tsSessionTableSelect

'Read the “', tsSessionTableSelect, '” section'

Re-exports tsSessionTableSelect

tsSiteConfigInsert

'Read the “', tsSiteConfigInsert, '” section'

Re-exports tsSiteConfigInsert

tsSiteConfigSelect

'Read the “', tsSiteConfigSelect, '” section'

Re-exports tsSiteConfigSelect

tsUsersInsert

'Read the “', tsUsersInsert, '” section'

Re-exports tsUsersInsert

tsUsersSelect

'Read the “', tsUsersSelect, '” section'

Re-exports tsUsersSelect

tsUsersUpdate

'Read the “', tsUsersUpdate, '” section'

Re-exports tsUsersUpdate