Le SDK

Le SDK de StudioCMS est un outil puissant qui vous permet d’interagir avec StudioCMS par programmation. Il fournit un ensemble de fonctions et d’utilitaires pour gérer et diffuser votre contenu via notre propre client de base de données interne Kysely^. Il constitue également la base du tableau de bord StudioCMS et est basé sur Effect^.

Utilisation de base

Le SDK de StudioCMS est disponible sous forme de module virtuel dans votre projet Astro. Vous pouvez l’importer et l’utiliser avec la syntaxe suivante :

example.ts

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


// Créer l’Effect utilisable
const pagesEffect = Effect.gen(function* () {
  const sdk = yield* SDKCore;

 // alors faire quelque chose avec le SDK
 return yield* sdk.GET.pages()
});

// Convertir l’Effect en un programme JS/TS
const pagesResult1 = await runSDK(pagesEffect);


// Exécutez simplement le SDKCoreJS avec le wrapper runSDK !
const pagesResult2 = await runSDK(SDKCoreJs.GET.pages());

Utilitaires disponibles

Voici une liste des principaux utilitaires fournis par le SDK de StudioCMS pour interagir avec la base de données.

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;

Lectures complémentaires

Le SDK de StudioCMS est alimenté par le paquet @withstudiocms/sdk, qui fournit des fonctionnalités et des utilitaires supplémentaires pour travailler avec StudioCMS. Pour plus d’informations, consultez la documentation des packages Kysely et SDK.