El SDK

El SDK de StudioCMS es una herramienta poderosa que te permite interactuar con StudioCMS de forma programática. Proporciona un conjunto de funciones y utilidades que te permiten gestionar y servir tu contenido usando Astro DB. También proporciona la base para el Panel de Control de StudioCMS.

Uso

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

import SDK from 'studiocms:sdk';
// O
import SDKCached from 'studiocms:sdk/cache';
Error ts(2307)  ― Cannot find module 'studiocms:sdk/cache' or its corresponding type declarations.

El objeto studioCMSSDK proporciona un conjunto de funciones y utilidades que te permiten interactuar con StudioCMS. Puedes usar estas funciones para crear, leer, actualizar y eliminar contenido en tu proyecto Astro.

El objeto studioCMSSDKCached proporciona un conjunto de funciones y utilidades que te permiten interactuar con el SDK de StudioCMS con una capa de caché encima. Puedes usar estas funciones para almacenar en caché contenido en tu proyecto Astro.

SDK de StudioCMS (estándar)

SDK.AUTH

El objeto SDK.AUTH proporciona un conjunto de funciones y utilidades que te permiten gestionar la autenticación en tu proyecto Astro. Puedes usar estas funciones para autenticar usuarios, gestionar sesiones y más.

import SDK from 'studiocms:sdk';

const {
   oAuth,
   permission,
   session,
   user,
} = SDK.AUTH;
Error ts(2339)  ― Property 'AUTH' does not exist on type 'typeof import("studiocms:sdk")'.

SDK.INIT

El objeto SDK.INIT proporciona un conjunto de funciones y utilidades que te permiten inicializar el SDK de StudioCMS en tu proyecto Astro. Puedes usar estas funciones para configurar el SDK, configurarlo y más.

import SDK from 'studiocms:sdk';

const {
   siteConfig,
   ghostUser,
} = SDK.INIT;
Error ts(2339)  ― Property 'INIT' does not exist on type 'typeof import("studiocms:sdk")'.

SDK.GET

El objeto SDK.GET proporciona un conjunto de funciones y utilidades que te permiten recuperar contenido de Astro DB. Puedes usar estas funciones para obtener contenido por ID, obtener contenido por tipo y más.

import SDK from 'studiocms:sdk';

const {
   database,
   databaseEntry,
   databaseTable,
   permissionsLists,
   packagePages,
} = SDK.GET;
Error ts(2339)  ― Property 'GET' does not exist on type 'typeof import("studiocms:sdk")'.

SDK.POST

El objeto SDK.POST proporciona un conjunto de funciones y utilidades que te permiten crear contenido en Astro DB. Puedes usar estas funciones para crear contenido por tipo, crear contenido por ID y más.

import SDK from 'studiocms:sdk';

const {
   databaseEntry,
   databaseEntries,
} = SDK.POST;
Error ts(2339)  ― Property 'POST' does not exist on type 'typeof import("studiocms:sdk")'.

SDK.UPDATE

El objeto SDK.UPDATE proporciona un conjunto de funciones y utilidades que te permiten actualizar contenido en Astro DB. Puedes usar estas funciones para actualizar contenido por ID, actualizar contenido por tipo y más.

import SDK from 'studiocms:sdk';

const {
   page,
   pageContent,
   tags,
   categories,
   permissions,
   siteConfig,
   folder,
} = SDK.UPDATE;
Error ts(2339)  ― Property 'UPDATE' does not exist on type 'typeof import("studiocms:sdk")'.

SDK.DELETE

El objeto SDK.DELETE proporciona un conjunto de funciones y utilidades que te permiten eliminar contenido de Astro DB. Puedes usar estas funciones para eliminar contenido por ID, eliminar contenido por tipo y más.

import SDK from 'studiocms:sdk';

const {
   page,
   pageContent,
   pageContentLang,
   tags,
   categories,
   permissions,
   diffTracking,
   folder,
   user,
} = SDK.DELETE;
Error ts(2339)  ― Property 'DELETE' does not exist on type 'typeof import("studiocms:sdk")'.

SDK.db

El objeto SDK.db proporciona un conjunto de funciones y utilidades que te permiten interactuar con Astro DB directamente. Puedes usar estas funciones para consultar la base de datos, ejecutar consultas personalizadas y más.

import SDK from 'studiocms:sdk';

const { db } = SDK;
Error ts(2339)  ― Property 'db' does not exist on type 'typeof import("studiocms:sdk")'.

Para más información sobre cómo usar db consulta la Guía de Astro DB^

SDK.REST_API

El objeto SDK.REST_API proporciona un conjunto de funciones y utilidades que la API REST utiliza para interactuar con StudioCMS y Astro DB.

import SDK from 'studiocms:sdk';

const {
   tokens: {
      get: getToken,
      new: newToken,
      delete: deleteToken,
      verify: verifyToken,
   },
} = SDK.REST_API;
Error ts(2339)  ― Property 'REST_API' does not exist on type 'typeof import("studiocms:sdk")'.

SDK.diffTracking

El objeto SDK.diffTracking proporciona un conjunto de funciones y utilidades que te permiten rastrear cambios en Astro DB. Puedes usar estas funciones para rastrear cambios en contenido, rastrear cambios en usuarios y más.

import SDK from 'studiocms:sdk';

const {
   insert,
   clear,
   get,
   revertToDiff
} = SDK.diffTracking;
Error ts(2339)  ― Property 'diffTracking' does not exist on type 'typeof import("studiocms:sdk")'.

Funciones Utilitarias

El SDK de StudioCMS también proporciona un conjunto de funciones utilitarias que puedes usar para interactuar con el SDK. Estas funciones incluyen:

import SDK from 'studiocms:sdk';

const {
  addPageToFolderTree,
Error ts(2339)  ― Property 'addPageToFolderTree' does not exist on type 'typeof import("studiocms:sdk")'.
  findNodeById,
Error ts(2339)  ― Property 'findNodeById' does not exist on type 'typeof import("studiocms:sdk")'.
  findNodeByPath,
Error ts(2339)  ― Property 'findNodeByPath' does not exist on type 'typeof import("studiocms:sdk")'.
  findNodesAlongPath,
Error ts(2339)  ― Property 'findNodesAlongPath' does not exist on type 'typeof import("studiocms:sdk")'.
  getFullPath,
Error ts(2339)  ― Property 'getFullPath' does not exist on type 'typeof import("studiocms:sdk")'.
  parseIdNumberArray,
Error ts(2339)  ― Property 'parseIdNumberArray' does not exist on type 'typeof import("studiocms:sdk")'.
  parseIdStringArray,
Error ts(2339)  ― Property 'parseIdStringArray' does not exist on type 'typeof import("studiocms:sdk")'.
  generateRandomIDNumber,
Error ts(2339)  ― Property 'generateRandomIDNumber' does not exist on type 'typeof import("studiocms:sdk")'.
  generateToken,
Error ts(2339)  ― Property 'generateToken' does not exist on type 'typeof import("studiocms:sdk")'.
  testToken,
Error ts(2339)  ― Property 'testToken' does not exist on type 'typeof import("studiocms:sdk")'.
  combineRanks,
Error ts(2339)  ― Property 'combineRanks' does not exist on type 'typeof import("studiocms:sdk")'.
  verifyRank,
Error ts(2339)  ― Property 'verifyRank' does not exist on type 'typeof import("studiocms:sdk")'.
  buildFolderTree,
Error ts(2339)  ― Property 'buildFolderTree' does not exist on type 'typeof import("studiocms:sdk")'.
  getAvailableFolders,
Error ts(2339)  ― Property 'getAvailableFolders' does not exist on type 'typeof import("studiocms:sdk")'.
  clearUserReferences,
Error ts(2339)  ― Property 'clearUserReferences' does not exist on type 'typeof import("studiocms:sdk")'.
  collectCategories,
Error ts(2339)  ― Property 'collectCategories' does not exist on type 'typeof import("studiocms:sdk")'.
  collectTags,
Error ts(2339)  ― Property 'collectTags' does not exist on type 'typeof import("studiocms:sdk")'.
  collectPageData,
Error ts(2339)  ― Property 'collectPageData' does not exist on type 'typeof import("studiocms:sdk")'.
  collectUserData,
Error ts(2339)  ― Property 'collectUserData' does not exist on type 'typeof import("studiocms:sdk")'.
  generateRandomPassword,
Error ts(2339)  ― Property 'generateRandomPassword' does not exist on type 'typeof import("studiocms:sdk")'.
} = SDK;

SDK de StudioCMS (Caché)

El SDK de StudioCMS también proporciona una versión en caché del SDK con un subconjunto limitado de las características del SDK que incluye una capa de caché sobre el SDK estándar. Puedes importar el SDK en caché usando la siguiente sintaxis:

import SDKCached from 'studiocms:sdk/cache';
Error ts(2307)  ― Cannot find module 'studiocms:sdk/cache' or its corresponding type declarations.

SDKCached.GET

El objeto SDKCached.GET proporciona un conjunto de funciones y utilidades que te permiten recuperar contenido de Astro DB con una capa de caché encima. Puedes usar estas funciones para obtener contenido por ID, obtener contenido por tipo y más.

import SDKCached from 'studiocms:sdk/cache';
Error ts(2307)  ― Cannot find module 'studiocms:sdk/cache' or its corresponding type declarations.

const {
   page,
   pages,
   siteConfig,
   latestVersion,
   folderTree,
   pageFolderTree,
   folderList,
   folder,
} = SDKCached.GET;

SDKCached.CLEAR

El objeto SDKCached.CLEAR proporciona un conjunto de funciones y utilidades que te permiten limpiar la caché en el SDK en caché. Puedes usar estas funciones para limpiar la caché de un tipo de contenido específico, limpiar la caché de un ID de contenido específico y más.

import SDKCached from 'studiocms:sdk/cache';
Error ts(2307)  ― Cannot find module 'studiocms:sdk/cache' or its corresponding type declarations.

const {
   page,
   pages,
   latestVersion,
   folderTree,
   folderList,
} = SDKCached.CLEAR;

SDKCached.UPDATE

El objeto SDKCached.UPDATE proporciona un conjunto de funciones y utilidades que te permiten actualizar contenido en Astro DB con una capa de caché encima. Puedes usar estas funciones para actualizar contenido por ID, actualizar contenido por tipo y más.

import SDKCached from 'studiocms:sdk/cache';
Error ts(2307)  ― Cannot find module 'studiocms:sdk/cache' or its corresponding type declarations.

const {
   page,
   siteConfig,
   latestVersion,
   folderTree,
   folderList,
   folder,
} = SDKCached.UPDATE;

SDKCached.db

Este es un paso directo al objeto db del SDK estándar.

Ver SDK.db para más información