studiocms 0.1.0-beta.24 → 0.1.0-beta.26

package/src/{sdk → virtuals/sdk}/modules/get.ts

@@ -2,11 +2,10 @@ import { asc, eq, or } from 'astro:db';
 import config from 'studiocms:config';
 import {
 	CMSNotificationSettingsId,
-	CMSSiteConfigId,
 	GhostUserDefaults,
 	versionCacheLifetime,
-} from '../../consts.js';
-import { Effect, genLogger } from '../../effect.js';
+} from '../../../consts.js';
+import { Effect, genLogger } from '../../../effect.js';
 import {
 	FolderListMapID,
 	FolderTreeMapID,
@@ -35,7 +34,6 @@ import {
 	tsPageFolderStructure,
 	tsPermissions,
 	tsSessionTable,
-	tsSiteConfig,
 	tsUsers,
 } from '../tables.js';
 import type {
@@ -61,6 +59,7 @@ import {
 	siteConfigReturn,
 	versionReturn,
 } from '../utils.js';
+import { SDKCore_CONFIG } from './config.js';
 
 /**
  * The `SDKCore_GET` service provides a comprehensive set of data retrieval methods for the StudioCMS SDK.
@@ -107,6 +106,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 			GetVersionFromNPM.Default,
 			SDKCore_Users.Default,
 			SDKCore_Collectors.Default,
+			SDKCore_CONFIG.Default,
 		],
 		effect: genLogger('studiocms/sdk/SDKCore/modules/get/effect')(function* () {
 			const [
@@ -116,6 +116,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 				getVersionFromNPM,
 				{ combineRanks, verifyRank },
 				{ collectUserData, collectPageData },
+				{ siteConfig: sdkSiteConfig },
 			] = yield* Effect.all([
 				AstroDB,
 				CacheContext,
@@ -123,6 +124,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 				GetVersionFromNPM,
 				SDKCore_Users,
 				SDKCore_Collectors,
+				SDKCore_CONFIG,
 			]);
 
 			/**
@@ -228,18 +230,20 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 				);
 			}
 
-			function _getPageById(id: string): Effect.Effect<PageDataCacheObject, SDKCoreError, never>;
+			function _getPageById(
+				id: string
+			): Effect.Effect<PageDataCacheObject | undefined, SDKCoreError, never>;
 			function _getPageById(
 				id: string,
 				metaOnly?: boolean
-			): Effect.Effect<MetaOnlyPageDataCacheObject, SDKCoreError, never>;
+			): Effect.Effect<MetaOnlyPageDataCacheObject | undefined, SDKCoreError, never>;
 
 			/**
 			 * Retrieves a page by its ID, with an option to return only metadata.
 			 *
 			 * @param id - The ID of the page to retrieve.
 			 * @param metaOnly - If `true`, returns only metadata for the page. Defaults to `false`.
-			 * @returns An `Effect` that yields the page data or metadata, depending on `metaOnly`.
+			 * @returns An `Effect` that yields the page data or metadata, or `undefined` if no page is found.
 			 *
 			 * @throws UnknownException - If an unknown error occurs during retrieval.
 			 * @throws LibSQLDatabaseError - If a database error occurs during retrieval.
@@ -258,14 +262,6 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 						return yield* collectPageData(page, folders);
 					});
 
-				const handlePageNotFound = () =>
-					Effect.fail(
-						new SDKCoreError({
-							type: 'UNKNOWN',
-							cause: new StudioCMS_SDK_Error('Page not found in Database'),
-						})
-					);
-
 				return Effect.gen(function* () {
 					const status = yield* isCacheEnabled;
 
@@ -273,7 +269,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 						const page = yield* getPage(id);
 
 						if (!page) {
-							return yield* handlePageNotFound();
+							return undefined;
 						}
 
 						const pageData = pageDataReturn(page);
@@ -289,7 +285,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 						const page = yield* getPage(id, tree);
 
 						if (!page) {
-							return yield* handlePageNotFound();
+							return undefined;
 						}
 
 						const returnPage = pageDataReturn(page);
@@ -312,18 +308,18 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 
 			function _getPageBySlug(
 				slug: string
-			): Effect.Effect<PageDataCacheObject, SDKCoreError, never>;
+			): Effect.Effect<PageDataCacheObject | undefined, SDKCoreError, never>;
 			function _getPageBySlug(
 				slug: string,
 				metaOnly?: boolean
-			): Effect.Effect<MetaOnlyPageDataCacheObject, SDKCoreError, never>;
+			): Effect.Effect<MetaOnlyPageDataCacheObject | undefined, SDKCoreError, never>;
 
 			/**
 			 * Retrieves a page by its slug, with an option to return only metadata.
 			 *
 			 * @param slug - The slug of the page to retrieve.
 			 * @param metaOnly - If `true`, returns only metadata for the page. Defaults to `false`.
-			 * @returns An `Effect` that yields the page data or metadata, depending on `metaOnly`.
+			 * @returns An `Effect` that yields the page data or metadata, or `undefined` if no page is found.
 			 *
 			 * @throws UnknownException - If an unknown error occurs during retrieval.
 			 * @throws LibSQLDatabaseError - If a database error occurs during retrieval.
@@ -349,12 +345,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 						const page = yield* getPage(slug);
 
 						if (!page) {
-							return yield* Effect.fail(
-								new SDKCoreError({
-									type: 'UNKNOWN',
-									cause: new StudioCMS_SDK_Error('Page not found in Database'),
-								})
-							);
+							return undefined;
 						}
 
 						const pageData = pageDataReturn(page);
@@ -371,12 +362,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 						const page = yield* getPage(slug, tree);
 
 						if (!page) {
-							return yield* Effect.fail(
-								new SDKCoreError({
-									type: 'UNKNOWN',
-									cause: new StudioCMS_SDK_Error('Page not found in Database'),
-								})
-							);
+							return undefined;
 						}
 
 						const pageData = pageDataReturn(page);
@@ -512,9 +498,12 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 
 					for (const item of cacheMap) {
 						if (isCacheExpired(item)) {
-							const { data: updatedData } = yield* GET.page.byId(item.data.id);
-
-							pages.set(updatedData.id, pageDataReturn(updatedData));
+							const updated = yield* GET.page.byId(item.data.id);
+							if (!updated) {
+								pages.delete(item.data.id);
+								continue;
+							}
+							pages.set(updated.data.id, updated);
 						}
 					}
 
@@ -692,9 +681,12 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 
 					for (const item of cacheMap) {
 						if (isCacheExpired(item)) {
-							const { data: updatedData } = yield* GET.page.byId(item.data.id);
-
-							pages.set(updatedData.id, pageDataReturn(updatedData));
+							const updated = yield* GET.page.byId(item.data.id);
+							if (!updated) {
+								pages.delete(item.data.id);
+								continue;
+							}
+							pages.set(updated.data.id, updated);
 						}
 					}
 
@@ -756,10 +748,6 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 					pageDataCategories: () =>
 						dbService.execute((db) => db.select().from(tsPageDataCategories)),
 					pageContent: () => dbService.execute((db) => db.select().from(tsPageContent)),
-					siteConfig: () =>
-						dbService.execute((db) =>
-							db.select().from(tsSiteConfig).where(eq(tsSiteConfig.id, CMSSiteConfigId)).get()
-						),
 					diffTracking: () => dbService.execute((db) => db.select().from(tsDiffTracking)),
 					pageFolderStructure: () =>
 						dbService.execute((db) => db.select().from(tsPageFolderStructure)),
@@ -968,9 +956,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 						}
 
 						if (!status) {
-							const newConfig = yield* dbService.execute((db) =>
-								db.select().from(tsSiteConfig).where(eq(tsSiteConfig.id, CMSSiteConfigId)).get()
-							);
+							const newConfig = yield* sdkSiteConfig.get();
 
 							if (!newConfig) {
 								return yield* Effect.fail(
@@ -981,15 +967,13 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 								);
 							}
 
-							return siteConfigReturn(newConfig);
+							return siteConfigReturn(newConfig.data);
 						}
 
 						const currentSiteConfig = siteConfig.get(SiteConfigMapID);
 
 						if (!currentSiteConfig || isCacheExpired(currentSiteConfig)) {
-							const newConfig = yield* dbService.execute((db) =>
-								db.select().from(tsSiteConfig).where(eq(tsSiteConfig.id, CMSSiteConfigId)).get()
-							);
+							const newConfig = yield* sdkSiteConfig.get();
 
 							if (!newConfig) {
 								return yield* Effect.fail(
@@ -1000,7 +984,7 @@ export class SDKCore_GET extends Effect.Service<SDKCore_GET>()(
 								);
 							}
 
-							const returnConfig = siteConfigReturn(newConfig);
+							const returnConfig = siteConfigReturn(newConfig.data);
 
 							siteConfig.set(SiteConfigMapID, returnConfig);
 

package/src/{sdk → virtuals/sdk}/modules/init.ts

@@ -1,10 +1,7 @@
-import { CMSSiteConfigId } from '../../consts.js';
-import { Effect, genLogger } from '../../effect.js';
-import { AstroDB } from '../effect/index.js';
+import { Effect, genLogger } from '../../../effect.js';
 import { SDKCoreError, StudioCMS_SDK_Error } from '../errors.js';
-import { tsSiteConfig } from '../tables.js';
-import type { SiteConfig } from '../types/index.js';
 import { SDKCore_AUTH } from './auth.js';
+import { SDKCore_CONFIG, type StudioCMSSiteConfig } from './config.js';
 
 /**
  * Effectful service for initializing core StudioCMS modules.
@@ -29,9 +26,12 @@ import { SDKCore_AUTH } from './auth.js';
 export class SDKCore_INIT extends Effect.Service<SDKCore_INIT>()(
 	'studiocms/sdk/SDKCore/modules/init',
 	{
-		dependencies: [AstroDB.Default, SDKCore_AUTH.Default],
+		dependencies: [SDKCore_AUTH.Default, SDKCore_CONFIG.Default],
 		effect: genLogger('studiocms/sdk/SDKCore/modules/init/effect')(function* () {
-			const [dbService, AUTH] = yield* Effect.all([AstroDB, SDKCore_AUTH]);
+			const [{ siteConfig: sdkSiteConfig }, AUTH] = yield* Effect.all([
+				SDKCore_CONFIG,
+				SDKCore_AUTH,
+			]);
 
 			const INIT = {
 				/**
@@ -41,26 +41,18 @@ export class SDKCore_INIT extends Effect.Service<SDKCore_INIT>()(
 				 * @returns A promise that resolves to the inserted site configuration.
 				 * @throws {StudioCMS_SDK_Error} If an error occurs while creating the site configuration.
 				 */
-				siteConfig: (config: SiteConfig) =>
-					dbService
-						.execute((db) =>
-							db
-								.insert(tsSiteConfig)
-								.values({ ...config, id: CMSSiteConfigId })
-								.returning()
-								.get()
-						)
-						.pipe(
-							Effect.catchTags({
-								'studiocms/sdk/effect/db/LibSQLDatabaseError': (cause) =>
-									Effect.fail(
-										new SDKCoreError({
-											type: 'LibSQLDatabaseError',
-											cause: new StudioCMS_SDK_Error(`INIT.siteConfig Error: ${cause}`),
-										})
-									),
-							})
-						),
+				siteConfig: (config: Omit<StudioCMSSiteConfig, '_config_version'>) =>
+					sdkSiteConfig.init(config).pipe(
+						Effect.catchTags({
+							'studiocms/sdk/effect/db/LibSQLDatabaseError': (cause) =>
+								Effect.fail(
+									new SDKCoreError({
+										type: 'LibSQLDatabaseError',
+										cause: new StudioCMS_SDK_Error(`INIT.siteConfig Error: ${cause}`),
+									})
+								),
+						})
+					),
 				/**
 				 * Initializes the StudioCMS Ghost User.
 				 *

package/src/{sdk → virtuals/sdk}/modules/middlewares.ts

@@ -1,5 +1,5 @@
 import _logger, { isVerbose } from 'studiocms:logger';
-import { Effect, genLogger } from '../../effect.js';
+import { Effect, genLogger } from '../../../effect.js';
 import { CacheContext, isCacheEnabled } from '../utils.js';
 import { SDKCore_GET } from './get.js';
 import { SDKCore_PLUGINS } from './plugins.js';
@@ -41,14 +41,18 @@ export class SDKCore_MIDDLEWARES extends Effect.Service<SDKCore_MIDDLEWARES>()(
 				{ initPluginDataCache },
 			] = yield* Effect.all([CacheContext, SDKCore_GET, SDKCore_PLUGINS]);
 
-			const CachesToCheck = [
-				{ cache: pages, updater: () => updatePages(true) },
-				{ cache: FolderList, updater: () => updateFolderList() },
-				{ cache: folderTree, updater: () => updateFolderTree() },
-				{ cache: pageFolderTree, updater: () => updatePageFolderTree() },
-				{ cache: siteConfig, updater: () => updateSiteConfig() },
-				{ cache: pluginData, updater: () => initPluginDataCache() },
-			];
+			const Caches = new Map<
+				string,
+				// biome-ignore lint/suspicious/noExplicitAny: Allow any for cache and updater types
+				{ cache: Map<string, any>; updater: () => Effect.Effect<any, unknown, never> }
+			>([
+				['pages', { cache: pages, updater: () => updatePages(true) }],
+				['folderList', { cache: FolderList, updater: () => updateFolderList() }],
+				['folderTree', { cache: folderTree, updater: () => updateFolderTree() }],
+				['pageFolderTree', { cache: pageFolderTree, updater: () => updatePageFolderTree() }],
+				['siteConfig', { cache: siteConfig, updater: () => updateSiteConfig() }],
+				['pluginData', { cache: pluginData, updater: () => initPluginDataCache() }],
+			]);
 
 			const logger = _logger.fork('studiocms:middleware/cacheVerification');
 
@@ -67,10 +71,17 @@ export class SDKCore_MIDDLEWARES extends Effect.Service<SDKCore_MIDDLEWARES>()(
 						// Log the cache verification process
 						isVerbose && logger.info('Verifying caches...');
 
-						// Iterate through the caches and update them if they are empty
-						const todos = CachesToCheck.flatMap(({ cache, updater }) =>
-							cache.size === 0 ? [updater()] : []
-						);
+						// biome-ignore lint/suspicious/noExplicitAny: Allow any for todos type
+						const todos: Effect.Effect<any, unknown, never>[] = [];
+
+						Caches.forEach(({ cache, updater }, name) => {
+							if (cache.size === 0) {
+								isVerbose && logger.info(`Cache "${name}" is empty, updating...`);
+								todos.push(updater());
+							} else {
+								isVerbose && logger.info(`Cache "${name}" is already populated.`);
+							}
+						});
 
 						// If there are no caches to update, we log and return
 						if (todos.length === 0) {

package/src/{sdk → virtuals/sdk}/modules/notificationSettings.ts

@@ -1,10 +1,8 @@
-import { eq } from 'astro:db';
-import { CMSNotificationSettingsId, NotificationSettingsDefaults } from '../../consts.js';
-import { Effect, genLogger } from '../../effect.js';
+import { NotificationSettingsDefaults } from '../../../consts.js';
+import { Effect, genLogger } from '../../../effect.js';
 import { AstroDB } from '../effect/index.js';
 import { SDKCoreError, StudioCMS_SDK_Error } from '../errors.js';
-import { tsNotificationSettings } from '../tables.js';
-import type { tsNotificationSettingsInsert } from '../types/index.js';
+import { SDKCore_CONFIG, type StudioCMSNotificationSettings } from './config.js';
 
 /**
  * Service class for managing notification settings in the StudioCMS SDK.
@@ -34,9 +32,9 @@ import type { tsNotificationSettingsInsert } from '../types/index.js';
 export class SDKCore_NotificationSettings extends Effect.Service<SDKCore_NotificationSettings>()(
 	'studiocms/sdk/SDKCore/modules/notificationSettings',
 	{
-		dependencies: [AstroDB.Default],
+		dependencies: [AstroDB.Default, SDKCore_CONFIG.Default],
 		effect: genLogger('studiocms/sdk/SDKCore/modules/notificationSettings/effect')(function* () {
-			const dbService = yield* AstroDB;
+			const { notificationConfig } = yield* SDKCore_CONFIG;
 
 			const notificationSettings = {
 				site: {
@@ -47,23 +45,9 @@ export class SDKCore_NotificationSettings extends Effect.Service<SDKCore_Notific
 					 */
 					get: () =>
 						Effect.gen(function* () {
-							const data = yield* dbService.execute((db) =>
-								db
-									.select()
-									.from(tsNotificationSettings)
-									.where(eq(tsNotificationSettings.id, CMSNotificationSettingsId))
-									.get()
-							);
+							const data = yield* notificationConfig.get();
 
-							if (!data) {
-								return yield* dbService.execute((db) =>
-									db
-										.insert(tsNotificationSettings)
-										.values(NotificationSettingsDefaults)
-										.returning()
-										.get()
-								);
-							}
+							if (!data) return yield* notificationConfig.init(NotificationSettingsDefaults);
 
 							return data;
 						}).pipe(
@@ -86,28 +70,8 @@ export class SDKCore_NotificationSettings extends Effect.Service<SDKCore_Notific
 					 * @returns An Effect that resolves to the updated settings.
 					 * @throws SDKCoreError when a database error occurs.
 					 */
-					update: dbService.makeQuery((ex, settings: tsNotificationSettingsInsert) =>
-						ex((db) =>
-							db
-								.update(tsNotificationSettings)
-								.set(settings)
-								.where(eq(tsNotificationSettings.id, CMSNotificationSettingsId))
-								.returning()
-								.get()
-						).pipe(
-							Effect.catchTags({
-								'studiocms/sdk/effect/db/LibSQLDatabaseError': (cause) =>
-									Effect.fail(
-										new SDKCoreError({
-											type: 'LibSQLDatabaseError',
-											cause: new StudioCMS_SDK_Error(
-												`notificationSettings.site.update Error: ${cause}`
-											),
-										})
-									),
-							})
-						)
-					),
+					update: (settings: Omit<StudioCMSNotificationSettings, '_config_version'>) =>
+						notificationConfig.update(settings),
 				},
 			};
 

package/src/{sdk → virtuals/sdk}/modules/plugins.ts

@@ -1,5 +1,5 @@
 import { eq, like } from 'astro:db';
-import { Effect, genLogger, pipe, Schema } from '../../effect.js';
+import { Effect, genLogger, pipe, Schema } from '../../../effect.js';
 import { AstroDB, type LibSQLDatabaseError } from '../effect/db.js';
 import {
 	noUndefinedEntries,

package/src/{sdk → virtuals/sdk}/modules/post.ts

@@ -1,5 +1,5 @@
 import { eq } from 'astro:db';
-import { Effect, genLogger } from '../../effect.js';
+import { Effect, genLogger } from '../../../effect.js';
 import { AstroDB, SDKCore_Generators, SDKCore_Users } from '../effect/index.js';
 import { SDKCoreError, StudioCMS_SDK_Error } from '../errors.js';
 import {
@@ -22,6 +22,7 @@ import type {
 	tsPageDataTagsInsert,
 	tsPageFolderInsert,
 	tsPermissionsInsert,
+	tsPermissionsSelect,
 } from '../types/index.js';
 import {
 	_ClearUnknownError,
@@ -266,7 +267,7 @@ export class SDKCore_POST extends Effect.Service<SDKCore_POST>()(
 					 * @returns A promise that resolves to the inserted permission.
 					 * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the permission.
 					 */
-					permissions: (userId: string, rank: string) =>
+					permissions: (userId: string, rank: tsPermissionsSelect['rank']) =>
 						Effect.gen(function* () {
 							const userExists = yield* dbService.execute((db) =>
 								db.select().from(tsPermissions).where(eq(tsPermissions.user, userId)).get()
@@ -284,7 +285,7 @@ export class SDKCore_POST extends Effect.Service<SDKCore_POST>()(
 									.insert(tsPermissions)
 									.values({
 										user: userId,
-										rank,
+										rank: rank,
 									})
 									.returning({ user: tsPermissions.user, rank: tsPermissions.rank })
 							);
@@ -507,23 +508,21 @@ export class SDKCore_POST extends Effect.Service<SDKCore_POST>()(
 				page: (data: { pageData: tsPageDataInsert; pageContent: CombinedInsertContent }) =>
 					Effect.gen(function* () {
 						const status = yield* isCacheEnabled;
-
-						if (!status) {
-							const newPage = yield* POST.databaseEntry.pages(data.pageData, data.pageContent);
-
-							const { data: toReturn } = yield* GET.page.byId(newPage.pageData[0].id);
-
-							return pageDataReturn(toReturn);
-						}
-
 						const newPage = yield* POST.databaseEntry.pages(data.pageData, data.pageContent);
-
-						const { data: toReturn } = yield* GET.page.byId(newPage.pageData[0].id);
-
-						pages.set(toReturn.id, pageDataReturn(toReturn));
-						yield* CLEAR.folderList();
-						yield* CLEAR.folderTree();
-
+						const pageId = newPage.pageData[0]?.id;
+						if (!pageId) {
+							return undefined;
+						}
+						const fetchedPageData = yield* GET.page.byId(pageId);
+						if (!fetchedPageData) {
+							return undefined;
+						}
+						const { data: toReturn } = fetchedPageData;
+						if (status) {
+							pages.set(toReturn.id, pageDataReturn(toReturn));
+							yield* CLEAR.folderList();
+							yield* CLEAR.folderTree();
+						}
 						return pageDataReturn(toReturn);
 					}).pipe(
 						Effect.catchTags({

package/src/{sdk → virtuals/sdk}/modules/resetTokenBucket.ts

@@ -1,5 +1,5 @@
 import { eq } from 'astro:db';
-import { Effect, genLogger } from '../../effect.js';
+import { Effect, genLogger } from '../../../effect.js';
 import { AstroDB, SDKCore_Generators, SDKCore_Users } from '../effect/index.js';
 import { SDKCoreError, StudioCMS_SDK_Error } from '../errors.js';
 import { tsUserResetTokens } from '../tables.js';

package/src/{sdk → virtuals/sdk}/modules/rest_api.ts

@@ -1,5 +1,5 @@
 import { and, eq } from 'astro:db';
-import { Effect, genLogger } from '../../effect.js';
+import { Effect, genLogger } from '../../../effect.js';
 import { AstroDB, SDKCore_Generators } from '../effect/index.js';
 import { tsAPIKeys, tsPermissions } from '../tables.js';
 import { _clearLibSQLError } from '../utils.js';