sdk/types

Interfaces

BaseCacheObject

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

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:320^

CombinedPageData

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

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:449^

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:443^

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:450^

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:447^

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:446^

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:448^

CombinedUserData

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

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:427^

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:428^

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:459^

Interface representing the response received after a deletion operation.

Properties

message

message: string;

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

A message providing additional information about the deletion operation.

status

status: "success" | "error";

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

The status of the deletion operation.

diffItem

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

Represents a single difference item for a page, including metadata and content changes.

Properties

diff

diff: null | string;

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

The difference content as a string, or null if not available.

id

id: string;

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

Unique identifier for the diff item.

pageContentStart

pageContentStart: string;

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

The initial content of the page before the diff.

pageId

pageId: string;

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

Identifier of the page associated with the diff.

pageMetaData

pageMetaData: unknown;

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

Metadata associated with the page; type is unknown.

timestamp

timestamp: null | Date;

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

The date and time when the diff was created, or null if not set.

userId

userId: string;

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

Identifier of the user who made the change.

diffReturn

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

Represents the result of a diff operation, extending diffItem but replacing the pageMetaData property.

Remarks

The pageMetaData property contains the starting and ending states of page metadata, each represented as a partial selection of tsPageDataSelect.

See

diffItem
tsPageDataSelect

Extends

Omit<diffItem, "pageMetaData">

Properties

diff

diff: null | string;

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

Inherited from

Omit.diff

id

id: string;

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

Inherited from

Omit.id

pageContentStart

pageContentStart: string;

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

Inherited from

Omit.pageContentStart

pageId

pageId: string;

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

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:261^

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:244^

Inherited from

Omit.timestamp

userId

userId: string;

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

Inherited from

Omit.userId

EffectSchemaValidator<E>

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

Interface representing a validator for an effect schema.

Type Param

The type of the value that the schema validates.

Type Parameters

E

E extends Schema.Struct<any>

Properties

effectSchema

effectSchema: E;

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

The schema used for validation, which takes a value of type T and returns either a ParseError or never.

FolderListCacheObject

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

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:396^

The folder list data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

FolderListItem

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

Represents a folder item in a list, including its unique identifier, name, and optional parent folder.

Properties

id

id: string;

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

The unique identifier for the folder.

name

name: string;

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

The display name of the folder.

parent?

optional parent: null | string;

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

The identifier of the parent folder, or null if the folder is at the root level.

FolderNode

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

Represents a node in a folder structure, which may contain child nodes and page data.

Properties

children

children: FolderNode[];

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

Array of child folder nodes.

id

id: string;

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

Unique identifier for the folder node.

name

name: string;

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

Name of the folder node.

page

page: boolean;

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

Indicates whether this node represents a page.

pageData

pageData:
  | null
  | CombinedPageData;

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

Data associated with the page, or null if not applicable.

FolderTreeCacheObject

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

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:383^

The folder tree data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

JSONValidatorFn<T>

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

Represents a JSON validator function for a specific type.

Type Parameters

T

T

The type that the validator function checks for.

Properties

jsonFn()

jsonFn: (data: unknown) => data is T;

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

A type guard function that determines if the provided data is of type T.

Parameters

data

unknown

Returns

data is T

MetaOnlyPageDataCacheObject

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

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:346^

The combined page data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

PageDataCacheObject

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

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:333^

The combined page data to be cached.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

PageInsert

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

Represents the data required to insert a new page.

Properties

pageContent

pageContent: CombinedInsertContent;

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

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:468^

authorId

authorId: null | string;

contentLang

contentLang: string;

contributorIds

contributorIds: unknown;

description

description: string;

draft

draft: null | boolean;

heroImage

heroImage: string;

id

id: string;

package

package: string;

parentFolder

parentFolder: null | string;

publishedAt

publishedAt: Date;

showAuthor

showAuthor: null | boolean;

showContributors

showContributors: null | boolean;

showOnNav

showOnNav: boolean;

slug

slug: string;

title

title: string;

updatedAt

updatedAt: null | Date;

PluginDataCacheObject

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

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

Extends

BaseCacheObject

Properties

data

data: {
  data: unknown;
  id: string;
};

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

data

data: unknown;

id

id: string;

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

PluginDataEntry<T>

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

Represents a plugin data entry with a strongly-typed data property.

Extends

Omit<tsPluginDataSelect, "data">

Type Parameters

T

T extends object

The type of the data property.

Properties

data

data: T;

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

The plugin-specific data payload.

id

id: string;

Inherited from

Omit.id

SiteConfigCacheObject

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

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:359^

The site configuration data.

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

UsePluginDataOpts<T>

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

Options for using plugin data, extending the base options with an entry identifier.

Extends

UsePluginDataOptsBase<T>

Type Parameters

T

T extends Schema.Struct<Schema.Struct.Fields> | object

The type of the plugin data object.

Properties

entryId

entryId: string;

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

The unique identifier for the entry associated with the plugin data.

Type?

optional Type: T;

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

An optional type definition for the data.

Inherited from

UsePluginDataOptsBase.Type

validator?

optional validator: ValidatorOptions<T>;

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

Optional validator options for the data type.

Inherited from

UsePluginDataOptsBase.validator

UsePluginDataOptsBase<T>

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

Base options for using plugin data.

Extended by

UsePluginDataOpts

Type Parameters

T

T extends Schema.Struct<Schema.Struct.Fields> | object

The type of the data object.

Properties

Type?

optional Type: T;

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

An optional type definition for the data.

validator?

optional validator: ValidatorOptions<T>;

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

Optional validator options for the data type.

VersionCacheObject

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

Represents a cache object that includes version information.

Extends

BaseCacheObject

Properties

lastCacheUpdate

lastCacheUpdate: Date;

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

Inherited from

BaseCacheObject.lastCacheUpdate

version

version: string;

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

The version of the cache object.

ZodValidator<T>

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

Interface representing a validator that uses a Zod schema to validate data of type T.

Type Parameters

T

T

The type of data to be validated.

Properties

zodSchema

zodSchema: ZodType<T>;

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

The Zod schema instance used for validation.

Type Aliases

addDatabaseEntryInsertPage

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

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

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:411^

An array of page content objects with return IDs.

pageData

pageData: PageDataReturnId[];

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

An array of page data objects with return IDs.

AstroDBVirtualModule

type AstroDBVirtualModule = __module;

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

Represents the type of the virtual module imported from ‘astro:db’. This type can be used to reference the shape and exports of the Astro DB virtual module within TypeScript code, enabling type-safe interactions with its API.

CacheMap<K, V>

type CacheMap<K, V> = ReadonlyMap<K, V> & Map<K, V>;

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

Represents a cache map that combines the immutability of ReadonlyMap with the mutability of Map.

Type Parameters

K

K

The type of keys in the map.

V

V

The type of values in the map.

Remarks

This type allows both read-only and mutable operations on the map, which can be useful for scenarios where you need to enforce read-only access in some contexts while allowing mutation in others.

DiffReturnType<T>

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

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

Determines the return type based on whether the generic type T extends diffItem. If T extends diffItem, returns diffReturn; otherwise, returns an array of diffReturn.

Type Parameters

T

T

The type to check against diffItem.

Returns

diffReturn if T extends diffItem, otherwise diffReturn[].

MetaOnlyPageData

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

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

Represents page data containing only metadata fields, excluding multilingual and default content.

This type omits the multiLangContent and defaultContent properties from CombinedPageData.

MultiPageInsert

type MultiPageInsert = PageInsert[];

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

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

Determines the return type for page data cache operations based on the input type.

If the generic type T extends PageDataCacheObject, the return type is MetaOnlyPageDataCacheObject. Otherwise, the return type is an array of MetaOnlyPageDataCacheObject.

Type Parameters

T

T

The type to check against PageDataCacheObject.

PageDataReturnType<T>

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

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

Conditional type that returns either MetaOnlyPageData or an array of MetaOnlyPageData based on whether the generic type T extends CombinedPageData.

Type Parameters

T

T

The type to check against CombinedPageData.

Returns

If T extends CombinedPageData, returns MetaOnlyPageData; otherwise, returns MetaOnlyPageData[].

PaginateInput

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

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

Input parameters for paginated queries.

Properties

limit

limit: number;

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

The maximum number of items to return.

offset

offset: number;

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

The number of items to skip before starting to collect the result set.

UserPluginDataOptsImplementation<T>

type UserPluginDataOptsImplementation<T> = Partial<UsePluginDataOpts<T>>;

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

Represents a partial implementation of the UsePluginDataOpts type for a given object type T.

This type is useful when you want to provide only a subset of the properties defined in UsePluginDataOpts<T>.

Type Parameters

T

T extends Schema.Struct<Schema.Struct.Fields> | object

The object type for which the plugin data options are defined.

ValidatorOptions<T>

type ValidatorOptions<T> = T extends Schema.Struct<any> ? EffectSchemaValidator<T> :
  | JSONValidatorFn<T>
| ZodValidator<T>;

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

Represents the available validator options for a given type T.

This type is a union of supported validator types:

JSONValidatorFn<T>: A function-based JSON validator for type T.
EffectSchemaValidator<T>: A validator using the Effect schema for type T.
ZodValidator<T>: A validator using the Zod schema for type T.

Type Parameters

T

T extends Schema.Struct<any> | object

The type to be validated.

Example

// The Interface for a User type
interface User {
  id: number;
  name: string;
  email: string;
}

// Example of defining a JSON validator Fn for a User type
const userValidator: ValidatorOptions<User> = {
  jsonFn: (data: unknown): data is User => {
    return (
      typeof data === 'object' &&
      data !== null &&
      'id' in data &&
      'name' in data &&
      'email' in data &&
      typeof (data as any).id === 'number' &&
      typeof (data as any).name === 'string' &&
      typeof (data as any).email === 'string'
    );
  }
};

// Example of defining an Effect schema validator for a User type
import { Schema } from 'studiocms/effect';

const userEffectSchema = Schema.Struct({
 id: Schema.Number,
 name: Schema.String,
 email: Schema.String
});

type UserEffectSchema = (typeof userEffectSchema)['Type'];
type UserEffectSchemaFields = (typeof userEffectSchema)['fields'];

const userEffectValidator: ValidatorOptions<UserEffectSchema, UserEffectSchemaFields> = {
  effectSchema: userEffectSchema
};

// Example of defining a Zod validator for a User type
import { z } from 'astro/zod';

const userZodValidator: ValidatorOptions<User> = {
  zodSchema: z.object({
    id: z.number(),
    name: z.string(),
    email: z.string()
  })
};