sdk/types

Interfaces

BaseCacheObject

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

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

Extended by

• PageDataCacheObject
• MetaOnlyPageDataCacheObject
• SiteConfigCacheObject
• VersionCacheObject
• FolderTreeCacheObject
• FolderListCacheObject

Properties

lastCacheUpdate

lastCacheUpdate: Date;

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

---

CombinedPageData

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

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

CombinedPageData

Extends

• PageDataStripped

Properties

authorData

authorData:
  | undefined
  | {
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  emailVerified: boolean;
  id: string;
  name: string;
  notifications: null | string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
};

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

authorId

authorId: null | string;

Inherited from

PageDataStripped.authorId

categories

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

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

An array of categories selected for the page.

description

description: string;

id

id: number;

meta

meta: unknown;

name

name: string;

parent

parent: null | number;

slug

slug: string;

contentLang

contentLang: string;

Inherited from

PageDataStripped.contentLang

contributorIds

contributorIds: string[];

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

An array of contributor IDs associated with the page.

contributorsData

contributorsData: {
  avatar: null | string;
  createdAt: null | Date;
  email: null | string;
  emailVerified: boolean;
  id: string;
  name: string;
  notifications: null | string;
  password: null | string;
  updatedAt: null | Date;
  url: null | string;
  username: string;
 }[];

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

avatar

avatar: null | string;

createdAt

createdAt: null | Date;

email

email: null | string;

emailVerified

emailVerified: boolean;

id

id: string;

name

name: string;

notifications

notifications: null | string;

password

password: null | string;

updatedAt

updatedAt: null | Date;

url

url: null | string;

username

username: string;

defaultContent

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

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

description

description: string;

Inherited from

PageDataStripped.description

draft

draft: null | boolean;

Inherited from

PageDataStripped.draft

heroImage

heroImage: string;

Inherited from

PageDataStripped.heroImage

id

id: string;

Inherited from

PageDataStripped.id

multiLangContent

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

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

content

content: null | string;

contentId

contentId: string;

contentLang

contentLang: string;

id

id: string;

package

package: string;

Inherited from

PageDataStripped.package

parentFolder

parentFolder: null | string;

Inherited from

PageDataStripped.parentFolder

publishedAt

publishedAt: Date;

Inherited from

PageDataStripped.publishedAt

showAuthor

showAuthor: null | boolean;

Inherited from

PageDataStripped.showAuthor

showContributors

showContributors: null | boolean;

Inherited from

PageDataStripped.showContributors

showOnNav

showOnNav: boolean;

Inherited from

PageDataStripped.showOnNav

slug

slug: string;

Inherited from

PageDataStripped.slug

tags

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

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

An array of tags selected for the page.

description

description: string;

id

id: number;

meta

meta: unknown;

name

name: string;

slug

slug: string;

title

title: string;

Inherited from

PageDataStripped.title

updatedAt

updatedAt: null | Date;

Inherited from

PageDataStripped.updatedAt

urlRoute

urlRoute: string;

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

---

CombinedUserData

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

Interface representing combined user data.

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

CombinedUserData

Extends

• tsUsersSelect

Properties

avatar

avatar: null | string;

Inherited from

tsUsersSelect.avatar

createdAt

createdAt: null | Date;

Inherited from

tsUsersSelect.createdAt

email

email: null | string;

Inherited from

tsUsersSelect.email

emailVerified

emailVerified: boolean;

Inherited from

tsUsersSelect.emailVerified

id

id: string;

Inherited from

tsUsersSelect.id

name

name: string;

Inherited from

tsUsersSelect.name

notifications

notifications: null | string;

Inherited from

tsUsersSelect.notifications

oAuthData

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

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

An array of OAuth account data or undefined.

password

password: null | string;

Inherited from

tsUsersSelect.password

permissionsData

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

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

Permissions data or undefined.

updatedAt

updatedAt: null | Date;

Inherited from

tsUsersSelect.updatedAt

url

url: null | string;

Inherited from

tsUsersSelect.url

username

username: string;

Inherited from

tsUsersSelect.username

---

DeletionResponse

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

Interface representing the response received after a deletion operation.

Properties

message

message: string;

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

A message providing additional information about the deletion operation.

status

status: "error" | "success";

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

The status of the deletion operation.

---

diffItem

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

Properties

diff

diff: null | string;

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

id

id: string;

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

pageContentStart

pageContentStart: string;

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

pageId

pageId: string;

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

pageMetaData

pageMetaData: unknown;

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

timestamp

timestamp: null | Date;

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

userId

userId: string;

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

---

diffReturn

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

Extends

• Omit<diffItem, "pageMetaData">

Properties

diff

diff: null | string;

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

Inherited from

Omit.diff

id

id: string;

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

Inherited from

Omit.id

pageContentStart

pageContentStart: string;

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

Inherited from

Omit.pageContentStart

pageId

pageId: string;

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

Inherited from

Omit.pageId

pageMetaData

pageMetaData: {
  end: Partial<{
     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;
    }>;
  start: Partial<{
     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:120

end

end: Partial<{
  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;
}>;

start

start: Partial<{
  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;
}>;

timestamp

timestamp: null | Date;

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

Inherited from

Omit.timestamp

userId

userId: string;

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

Inherited from

Omit.userId

---

FolderListCacheObject

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

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

FolderListCacheObject

Extends

• BaseCacheObject

Properties

data

data: FolderListItem[];

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

The folder list data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

---

FolderListItem

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

Properties

id

id: string;

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

name

name: string;

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

parent?

optional parent: null | string;

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

---

FolderNode

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

Properties

children

children: FolderNode[];

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

id

id: string;

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

name

name: string;

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

page

page: boolean;

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

pageData

pageData:
  | null
  | CombinedPageData;

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

---

FolderTreeCacheObject

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

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

FolderTreeCacheObject

Extends

• BaseCacheObject

Properties

data

data: FolderNode[];

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

The folder tree data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

---

MetaOnlyPageDataCacheObject

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

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

MetaOnlyPageDataCacheObject

Extends

• BaseCacheObject

Properties

data

data: MetaOnlyPageData;

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

The combined page data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

---

PageDataCacheObject

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

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

PageDataCacheObject

Extends

• BaseCacheObject

Properties

data

data: CombinedPageData;

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

The combined page data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

---

PageInsert

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

Represents the data required to insert a new page.

Properties

pageContent

pageContent: CombinedInsertContent;

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

pageData

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:309

authorId?

optional authorId: null | string;

categories?

optional categories: unknown;

contentLang?

optional contentLang: string;

contributorIds?

optional contributorIds: unknown;

description

description: string;

draft?

optional draft: null | boolean;

heroImage?

optional heroImage: string;

id?

optional id: string;

package?

optional package: string;

parentFolder?

optional parentFolder: null | string;

publishedAt?

optional publishedAt: Date;

showAuthor?

optional showAuthor: null | boolean;

showContributors?

optional showContributors: null | boolean;

showOnNav?

optional showOnNav: boolean;

slug

slug: string;

tags?

optional tags: unknown;

title

title: string;

updatedAt?

optional updatedAt: null | Date;

---

SiteConfigCacheObject

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

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

SiteConfigCacheObject

Extends

• BaseCacheObject

Properties

data

data: SiteConfig;

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

The site configuration data.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

---

StudioCMSCacheObject

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

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

Properties

pages

pages: Map<string, PageDataCacheObject>;

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

siteConfig

siteConfig:
  | undefined
  | SiteConfigCacheObject;

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

version

version:
  | undefined
  | VersionCacheObject;

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

---

VersionCacheObject

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

Represents a cache object that includes version information.

Extends

• BaseCacheObject

Properties

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

version

version: string;

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

The version of the cache object.

Type Aliases

addDatabaseEntryInsertPage

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

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

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

Properties

pageContent

pageContent: PageContentReturnId[];

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

An array of page content objects with return IDs.

pageData

pageData: PageDataReturnId[];

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

An array of page data objects with return IDs.

---

AstroDBVirtualModule

type AstroDBVirtualModule = __module;

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

---

DiffReturnType<T>

type DiffReturnType<T> = T extends diffItem ? diffReturn : diffReturn[];

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

Type Parameters

T

T

---

MetaOnlyPageData

type MetaOnlyPageData = Omit<CombinedPageData, "multiLangContent" | "defaultContent">;

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

---

MultiPageInsert

type MultiPageInsert = PageInsert[];

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

Represents an array of PageInsert objects.

---

PageDataCacheReturnType<T>

type PageDataCacheReturnType<T> = T extends PageDataCacheObject ? MetaOnlyPageDataCacheObject : MetaOnlyPageDataCacheObject[];

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

Type Parameters

T

T

---

PageDataReturnType<T>

type PageDataReturnType<T> = T extends CombinedPageData ? MetaOnlyPageData : MetaOnlyPageData[];

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

Type Parameters

T

T

---

PaginateInput

type PaginateInput = {
  limit: number;
  offset: number;
};

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

Properties

limit

limit: number;

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

offset

offset: number;

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

---

STUDIOCMS_SDK_CACHE

type STUDIOCMS_SDK_CACHE = typeof cacheModule;

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

Type representing the return type of the STUDIOCMS_SDK_CACHEModule function.

References

AvailableLists

Re-exports AvailableLists

---

CacheConfig

Re-exports CacheConfig

---

CombinedInsertContent

Re-exports CombinedInsertContent

---

CombinedRank

Re-exports CombinedRank

---

DatabaseTables

Re-exports DatabaseTables

---

PageContentReturnId

Re-exports PageContentReturnId

---

PageDataCategoriesInsertResponse

Re-exports PageDataCategoriesInsertResponse

---

PageDataReturnId

Re-exports PageDataReturnId

---

PageDataStripped

Re-exports PageDataStripped

---

PageDataTagsInsertResponse

Re-exports PageDataTagsInsertResponse

---

ProcessedCacheConfig

Re-exports ProcessedCacheConfig

---

ProcessedSDKConfig

Re-exports ProcessedSDKConfig

---

SingleRank

Re-exports SingleRank

---

SiteConfig

Re-exports SiteConfig

---

tsDiffTrackingInsert

Re-exports tsDiffTrackingInsert

---

tsDiffTrackingSelect

Re-exports tsDiffTrackingSelect

---

tsEmailVerificationTokensInsert

Re-exports tsEmailVerificationTokensInsert

---

tsEmailVerificationTokensSelect

Re-exports tsEmailVerificationTokensSelect

---

tsNotificationSettingsInsert

Re-exports tsNotificationSettingsInsert

---

tsNotificationSettingsSelect

Re-exports tsNotificationSettingsSelect

---

tsOAuthAccountsSelect

Re-exports tsOAuthAccountsSelect

---

tsPageContentInsert

Re-exports tsPageContentInsert

---

tsPageContentSelect

Re-exports tsPageContentSelect

---

tsPageDataCategoriesInsert

Re-exports tsPageDataCategoriesInsert

---

tsPageDataCategoriesSelect

Re-exports tsPageDataCategoriesSelect

---

tsPageDataInsert

Re-exports tsPageDataInsert

---

tsPageDataSelect

Re-exports tsPageDataSelect

---

tsPageDataTagsInsert

Re-exports tsPageDataTagsInsert

---

tsPageDataTagsSelect

Re-exports tsPageDataTagsSelect

---

tsPageFolderInsert

Re-exports tsPageFolderInsert

---

tsPageFolderSelect

Re-exports tsPageFolderSelect

---

tsPermissionsInsert

Re-exports tsPermissionsInsert

---

tsPermissionsSelect

Re-exports tsPermissionsSelect

---

tsSessionTableInsert

Re-exports tsSessionTableInsert

---

tsSessionTableSelect

Re-exports tsSessionTableSelect

---

tsSiteConfigInsert

Re-exports tsSiteConfigInsert

---

tsSiteConfigSelect

Re-exports tsSiteConfigSelect

---

tsUsersInsert

Re-exports tsUsersInsert

---

tsUsersSelect

Re-exports tsUsersSelect

---

tsUsersUpdate

Re-exports tsUsersUpdate