Skip to content
StudioCMS Docs
Main Site
Live Demo

sdk/types/tableDefs

Interfaces

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

CombinedRank

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

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

Represents a combined rank with associated details.

Extends

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

Properties

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

id
'Read the “', id, '” section'
id: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:83

The unique identifier for the rank.

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

SingleRank.id

name
'Read the “', name, '” section'
name: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:84

The name associated with the rank.

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

SingleRank.name

rank
'Read the “', rank, '” section'
rank: string;

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

The rank of the entity.

SingleRank

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

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:82

Represents a single rank with an identifier and a name.

Extended by

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

Properties

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

id
'Read the “', id, '” section'
id: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:83

name
'Read the “', name, '” section'
name: string;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:84

Type Aliases

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

AvailableLists

'Read the “', AvailableLists, '” section'
type AvailableLists = "owners" | "admins" | "editors" | "visitors" | "all";

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:107

Represents the different types of user lists available in the system.

  • ‘owners’: List of owners.
  • ‘admins’: List of administrators.
  • ‘editors’: List of editors.
  • ‘visitors’: List of visitors.
  • ‘all’: List of all users.

DatabaseTables

'Read the “', DatabaseTables, '” section'
type DatabaseTables =
  | tsUsersSelect[]
  | tsOAuthAccountsSelect[]
  | tsSessionTableSelect[]
  | tsPermissionsSelect[]
  | tsSiteConfigSelect
  | tsPageDataSelect[]
  | tsPageDataTagsSelect[]
  | tsPageDataCategoriesSelect[]
  | tsPageContentSelect[]
  | tsDiffTrackingSelect[]
  | undefined;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:66

Represents the possible types of database tables used in the application.

This type is a union of several specific table selection types, each representing a different table in the database. The possible types include:

  • tsUsersSelect[]: An array of user selection objects.
  • tsOAuthAccountsSelect[]: An array of OAuth account selection objects.
  • tsSessionTableSelect[]: An array of session table selection objects.
  • tsPermissionsSelect[]: An array of permission selection objects.
  • tsSiteConfigSelect: A site configuration selection object.
  • tsPageDataSelect[]: An array of page data selection objects.
  • tsPageDataTagsSelect[]: An array of page data tags selection objects.
  • tsPageDataCategoriesSelect[]: An array of page data categories selection objects.
  • tsPageContentSelect[]: An array of page content selection objects.
  • tsDiffTrackingSelect[]: An array of diff tracking selection objects.
  • undefined: Represents an undefined state.

PageContentReturnId

'Read the “', PageContentReturnId, '” section'
type PageContentReturnId = Pick<tsPageDataSelect, "id">;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:35

Represents a type that picks the ‘id’ property from the tsPageDataSelect type. This type is used to return only the ‘id’ field from a tsPageDataSelect object.

PageDataCategoriesInsertResponse

'Read the “', PageDataCategoriesInsertResponse, '” section'
type PageDataCategoriesInsertResponse = Pick<tsPageDataCategoriesSelect, "id">;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:47

Represents the response type for inserting a new page data category. This type is a subset of tsPageDataCategoriesSelect containing only the ‘id’ field.

PageDataReturnId

'Read the “', PageDataReturnId, '” section'
type PageDataReturnId = Pick<tsPageContentSelect, "id">;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:29

Represents a type that picks the ‘id’ property from the tsPageContentSelect type.

PageDataStripped

'Read the “', PageDataStripped, '” section'
type PageDataStripped = Omit<tsPageDataSelect, "categories" | "tags" | "contributorIds">;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:24

Represents a stripped-down version of the tsPageDataSelect type, excluding the properties ‘categories’, ‘tags’, and ‘contributorIds’.

PageDataTagsInsertResponse

'Read the “', PageDataTagsInsertResponse, '” section'
type PageDataTagsInsertResponse = Pick<tsPageDataTagsSelect, "id">;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:41

Represents the response type for inserting page data tags. This type is a subset of tsPageDataTagsSelect containing only the id field.

SiteConfig

'Read the “', SiteConfig, '” section'
type SiteConfig = Omit<tsSiteConfigSelect, "id">;

Defined in: studiocms/packages/studiocms/src/sdk/types/tableDefs.ts:18

Represents a stripped-down version of the tsSiteConfigSelect type, excluding the property ‘id’.