Saltearse al contenido

sdk/sdkCore

Esta página aún no está disponible en tu idioma.

Defined in: studiocms/packages/studiocms/src/sdk/sdkCore.ts:139^

The SDKCore class serves as the central service aggregator for the StudioCMS SDK. It extends Effect.Service and provides a unified interface to various sub-services such as folder tree management, generators, parsers, user management, collectors, database operations, REST API handlers, authentication, notification settings, and more.

  • All dependencies are injected and made available through the service.
  • The returned object from the effect contains all core SDK functions and sub-services.
  • Static members Provide and Cache are available for effect provisioning and caching context.
const sdk = yield* Effect.service(SDKCore);
const pageData = yield* sdk.collectPageData(...);
  • Effect.Service
  • CacheContext
  • any

new SDKCore(): SDKCore

SDKCore

Effect.Service<SDKCore>()('studiocms/sdk/SDKCore', {
dependencies: [
SDKCore_FolderTree.Default,
SDKCore_Generators.Default,
SDKCore_Parsers.Default,
SDKCore_Users.Default,
SDKCore_Collectors.Default,
SDKCore_CLEAR.Default,
SDKCore_DELETE.Default,
SDKCore_UPDATE.Default,
SDKCore_POST.Default,
SDKCore_REST_API.Default,
SDKCore_GET.Default,
SDKCore_ResetTokenBucket.Default,
SDKCore_DiffTracking.Default,
SDKCore_NotificationSettings.Default,
SDKCore_AUTH.Default,
SDKCore_INIT.Default,
AstroDB.Default,
],
effect: Effect.gen(function () {
// Get Services
const [
{
getFullPath,
findNodeByPath,
findNodesAlongPath,
findNodesAlongPathToId,
findNodeById,
addPageToFolderTree,
buildFolderTree,
getAvailableFolders,
},
{ generateRandomIDNumber, generateRandomPassword, generateToken, testToken },
{ parseIdNumberArray, parseIdStringArray },
{ combineRanks, verifyRank, clearUserReferences },
{ collectCategories, collectTags, collectPageData, collectUserData },
dbService,
CLEAR,
DELETE,
UPDATE,
POST,
REST_API,
GET,
resetTokenBucket,
diffTracking,
notificationSettings,
AUTH,
INIT,
] = yield Effect.all([
SDKCore_FolderTree,
SDKCore_Generators,
SDKCore_Parsers,
SDKCore_Users,
SDKCore_Collectors,
AstroDB,
SDKCore_CLEAR,
SDKCore_DELETE,
SDKCore_UPDATE,
SDKCore_POST,
SDKCore_REST_API,
SDKCore_GET,
SDKCore_ResetTokenBucket,
SDKCore_DiffTracking,
SDKCore_NotificationSettings,
SDKCore_AUTH,
SDKCore_INIT,
]);
// Breakout service functions that need to be returned in this.
const { db } = dbService;
return {
db,
dbService,
getFullPath,
findNodeByPath,
findNodesAlongPath,
findNodesAlongPathToId,
findNodeById,
addPageToFolderTree,
generateRandomIDNumber,
generateRandomPassword,
generateToken,
testToken,
parseIdNumberArray,
parseIdStringArray,
combineRanks,
verifyRank,
buildFolderTree,
getAvailableFolders,
clearUserReferences,
collectCategories,
collectTags,
collectPageData,
collectUserData,
resetTokenBucket,
diffTracking,
notificationSettings,
CLEAR,
DELETE,
REST_API,
POST,
UPDATE,
GET,
AUTH,
INIT,
};
}),
}).constructor

static Cache: any;

Defined in: studiocms/packages/studiocms/src/sdk/sdkCore.ts:278^

Static cache context for SDKCore-related data.

static Provide: any;

Defined in: studiocms/packages/studiocms/src/sdk/sdkCore.ts:261^

Static method to provide the default SDKCore service.