sdk/types

Ce contenu n’est pas encore disponible dans votre langue.

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

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

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

CombinedPageData

Extends

PageDataStripped

Properties

authorId

authorId: null | string;

Inherited from

PageDataStripped.authorId

Inherited from

PageDataStripped.contentLang

contributorIds

contributorIds: string[];

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

An array of contributor IDs associated with the page.

defaultContent

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

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

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

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

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

CombinedUserData

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

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

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

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

Interface representing the response received after a deletion operation.

Properties

message

message: string;

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

A message providing additional information about the deletion operation.

status

status: "error" | "success";

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

The status of the deletion operation.

diffItem

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

Properties

diff

diff: null | string;

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

id

id: string;

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

pageContentStart

pageContentStart: string;

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

pageId

pageId: string;

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

pageMetaData

pageMetaData: unknown;

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

timestamp

timestamp: null | Date;

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

userId

userId: string;

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

diffReturn

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

Extends

Omit<diffItem, "pageMetaData">

Properties

diff

diff: null | string;

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

Inherited from

Omit.diff

id

id: string;

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

Inherited from

Omit.id

pageContentStart

pageContentStart: string;

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

Inherited from

Omit.pageContentStart

pageId

pageId: string;

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

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

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

Inherited from

Omit.timestamp

userId

userId: string;

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

Inherited from

Omit.userId

FolderListCacheObject

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

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

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

Properties

id

id: string;

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

name

name: string;

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

parent?

optional parent: null | string;

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

FolderNode

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

Properties

children

children: FolderNode[];

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

id

id: string;

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

name

name: string;

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

page

page: boolean;

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

pageData

pageData:
  | null
  | CombinedPageData;

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

FolderTreeCacheObject

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

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

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

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

Represents the data required to insert a new page.

Properties

pageContent

pageContent: CombinedInsertContent;

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

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

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

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

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

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

siteConfig

siteConfig:
  | undefined
  | SiteConfigCacheObject;

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

version

version:
  | undefined
  | VersionCacheObject;

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

VersionCacheObject

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

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

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

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

An array of page content objects with return IDs.

pageData

pageData: PageDataReturnId[];

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

An array of page data objects with return IDs.

AstroDBVirtualModule

type AstroDBVirtualModule = __module;

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

DiffReturnType<T>

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

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

Type Parameters

T

T

MultiPageInsert

type MultiPageInsert = PageInsert[];

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

Represents an array of PageInsert objects.

STUDIOCMS_SDK_CACHE

type STUDIOCMS_SDK_CACHE = STUDIOCMS_SDK_CACHEInstance["cacheModule"];

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

Type representing the return type of the STUDIOCMS_SDK_CACHEModule function.

STUDIOCMS_SDK_CACHEConstructor

type STUDIOCMS_SDK_CACHEConstructor = typeof StudioCMSVirtualCache;

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

Type definition for the constructor of the StudioCMS SDK Cache.

This type represents the constructor function of the StudioCMSVirtualCache class.

STUDIOCMS_SDK_CACHEInstance

type STUDIOCMS_SDK_CACHEInstance = InstanceType<STUDIOCMS_SDK_CACHEConstructor>;

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

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.