El SDK

El SDK de StudioCMS es una herramienta potente que te permite interactuar con StudioCMS programáticamente. Proporciona un conjunto de funciones y utilidades que te permiten gestionar y servir tu contenido utilizando nuestro propio cliente de base de datos interno Kysely^. También proporciona la base para el Panel de Control de StudioCMS, y está construido con Effect^.

Uso básico

El SDK de StudioCMS está disponible como un módulo virtual en tu proyecto de Astro. Puedes importarlo y utilizarlo utilizando la siguiente sintaxis:

example.ts

/// <reference types="studiocms/v/types" />
// ---cut---
import { SDKCore, SDKCoreJs, runSDK } from 'studiocms:sdk';
import { Effect } from 'studiocms/effect';


// Crear el Effect utilizable
const pagesEffect = Effect.gen(function* () {
  const sdk = yield* SDKCore;

 // luego haz algo con el SDK
 return yield* sdk.GET.pages()
});

// Convertir el Effect en un "programa" JS/TS
const pagesResult1 = await runSDK(pagesEffect);


// ¡Ejecuta el SDKCoreJS con el wrapper runSDK!
const pagesResult2 = await runSDK(SDKCoreJs.GET.pages());

Utilidades disponibles

A continuación se muestra una lista de las utilidades principales proporcionadas por el SDK de StudioCMS para interactuar con la base de datos.

utils.ts

/// <reference types="studiocms/v/types" />
// ---cut---
import { SDKCoreJs } from 'studiocms:sdk';

const {
   dbService,
   cache,
   AUTH,
   CLEAR,
   CONFIG,
   DELETE,
   diffTracking,
   GET,
   INIT,
   MIDDLEWARES,
   notificationSettings,
   PLUGINS,
   POST,
   resetTokenBucket,
   REST_API,
   UPDATE,
   UTIL,
} = SDKCoreJs;

Lectura adicional

El SDK de StudioCMS está impulsado por el paquete @withstudiocms/sdk, que proporciona funcionalidad y utilidades adicionales para trabajar con StudioCMS. Para más información, consulta la documentación de los paquetes Kysely y SDK.