Das SDK

Das StudioCMS SDK ist ein leistungsstarkes Werkzeug, mit dem du programmatisch mit StudioCMS interagieren kannst. Es bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du deine Inhalte mit Astro DB verwalten und bereitstellen kannst. Außerdem bildet es das Rückgrat für das StudioCMS-Dashboard.

Verwendung

Das StudioCMS SDK ist als virtuelles Modul in deinem Astro-Projekt verfügbar. Du kannst es mit der folgenden Syntax importieren:

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

Das Objekt studioCMSSDK bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du mit StudioCMS interagieren kannst. Du kannst diese Funktionen nutzen, um Inhalte in deinem Astro-Projekt zu erstellen, zu lesen, zu aktualisieren und zu löschen.

Das Objekt studioCMSSDKCached bietet eine Reihe von Funktionen und Dienstprogrammen, die es dir ermöglichen, mit dem StudioCMS SDK zu interagieren und es mit einer Caching-Schicht zu versehen. Du kannst diese Funktionen nutzen, um Inhalte in deinem Astro-Projekt zwischenzuspeichern.

StudioCMS SDK (Standard)

SDK.AUTH

Das Objekt SDK.AUTH bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du die Authentifizierung in deinem Astro-Projekt verwalten kannst. Du kannst diese Funktionen nutzen, um Benutzer zu authentifizieren, Sitzungen zu verwalten und vieles mehr.

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

Das Objekt SDK.INIT bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du das StudioCMS SDK in deinem Astro-Projekt initialisieren kannst. Du kannst diese Funktionen nutzen, um das SDK einzurichten, zu konfigurieren und vieles mehr.

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

Das Objekt SDK.GET bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du Inhalte aus Astro DB abrufen kannst. Du kannst diese Funktionen nutzen, um Inhalte nach ID, nach Typ und mehr abzurufen.

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

Das Objekt SDK.POST bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du Inhalte in Astro DB erstellen kannst. Du kannst diese Funktionen nutzen, um Inhalte nach Typ zu erstellen, Inhalte nach ID zu erstellen und vieles mehr.

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

Das Objekt SDK.UPDATE bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du Inhalte in Astro DB aktualisieren kannst. Du kannst diese Funktionen nutzen, um Inhalte nach ID zu aktualisieren, Inhalte nach Typ zu aktualisieren und vieles mehr.

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

Das Objekt SDK.DELETE bietet eine Reihe von Funktionen und Hilfsmitteln, mit denen du Inhalte aus Astro DB löschen kannst. Du kannst diese Funktionen nutzen, um Inhalte nach ID, nach Typ und mehr zu löschen.

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

Das Objekt SDK.db bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du direkt mit der Astro-DB interagieren kannst. Du kannst diese Funktionen nutzen, um die Datenbank abzufragen, benutzerdefinierte Abfragen durchzuführen und vieles mehr.

import SDK from 'studiocms:sdk';

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

Weitere Informationen über die Verwendung von db findest du im Astro DB Guide^

SDK.REST_API

Das Objekt SDK.REST_API bietet eine Reihe von Funktionen und Dienstprogrammen, die die REST-API verwendet, um mit dem StudioCMS und der Astro DB zu interagieren.

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

Das Objekt SDK.diffTracking bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du Änderungen in Astro DB verfolgen kannst. Du kannst diese Funktionen nutzen, um Änderungen an Inhalten, an Benutzern und mehr zu verfolgen.

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")'.

Nützliche Funktionen

Das StudioCMS SDK bietet auch eine Reihe von Hilfsfunktionen, mit denen du mit dem SDK interagieren kannst. Zu diesen Funktionen gehören:

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;

StudioCMS SDK (Cached)

Das StudioCMS SDK bietet auch eine gecachte Version des SDK mit einer begrenzten Untermenge der SDK-Funktionen, die eine Caching-Schicht über dem Standard-SDK enthält. Du kannst das gecachte SDK mit der folgenden Syntax importieren:

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

SDKCached.GET

Das Objekt SDKCached.GET bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du Inhalte aus der Astro-DB abrufen kannst, die mit einer Zwischenspeicherschicht versehen sind. Du kannst diese Funktionen nutzen, um Inhalte nach ID, nach Typ und mehr abzurufen.

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

Das Objekt SDKCached.CLEAR bietet eine Reihe von Funktionen und Hilfsmitteln, mit denen du den Cache im SDK-Cache löschen kannst. Du kannst diese Funktionen verwenden, um den Cache für einen bestimmten Inhaltstyp zu löschen, den Cache für eine bestimmte Inhalts-ID zu löschen und vieles mehr.

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

Das Objekt SDKCached.UPDATE bietet eine Reihe von Funktionen und Dienstprogrammen, mit denen du Inhalte in Astro DB mit einer Zwischenspeicherschicht aktualisieren kannst. Du kannst diese Funktionen nutzen, um Inhalte nach ID zu aktualisieren, Inhalte nach Typ zu aktualisieren und vieles mehr.

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

Dies ist ein Passthrough zum Standard SDK db Objekt.

Siehe SDK.db für weitere Informationen