studiocms 0.2.0 → 0.4.0

package/frontend/pages/studiocms_api/rest/v1/public/[type]/_routes/folders.ts

@@ -1,85 +0,0 @@
-import { apiResponseLogger } from 'studiocms:logger';
-import { SDKCore } from 'studiocms:sdk';
-import {
-	AllResponse,
-	createEffectAPIRoutes,
-	createJsonResponse,
-	Effect,
-	genLogger,
-	OptionsResponse,
-} from '@withstudiocms/effect';
-import type { EndpointRoute } from '../../../../../../../utils/rest-router.js';
-
-export const foldersRouter: EndpointRoute = {
-	__idType: 'string',
-	__index: createEffectAPIRoutes(
-		{
-			GET: (ctx) =>
-				genLogger('studioCMS:rest:v1:public:folders:GET')(function* () {
-					const sdk = yield* SDKCore;
-
-					const folders = yield* sdk.GET.folderList();
-
-					const searchParams = ctx.url.searchParams;
-
-					const folderNameFilter = searchParams.get('name');
-					const folderParentFilter = searchParams.get('parent');
-
-					let filteredFolders = folders;
-
-					if (folderNameFilter) {
-						filteredFolders = filteredFolders.filter((folder) =>
-							folder.name.includes(folderNameFilter)
-						);
-					}
-
-					if (folderParentFilter) {
-						filteredFolders = filteredFolders.filter(
-							(folder) => folder.parent === folderParentFilter
-						);
-					}
-
-					return createJsonResponse(filteredFolders);
-				}),
-			OPTIONS: () => Effect.try(() => OptionsResponse({ allowedMethods: ['GET'] })),
-			ALL: () => Effect.try(() => AllResponse()),
-		},
-		{
-			cors: { methods: ['GET', 'OPTIONS'] },
-			onError: (error) => {
-				console.error('API Error:', error);
-				return createJsonResponse({ error: 'Something went wrong' }, { status: 500 });
-			},
-		}
-	),
-	id: (id: string) =>
-		createEffectAPIRoutes(
-			{
-				GET: () =>
-					genLogger('studioCMS:rest:v1:public:folders:[id]:GET')(function* () {
-						const sdk = yield* SDKCore;
-
-						if (!id) {
-							return apiResponseLogger(400, 'Invalid folder ID');
-						}
-
-						const folder = yield* sdk.GET.folder(id);
-
-						if (!folder) {
-							return apiResponseLogger(404, 'Folder not found');
-						}
-
-						return createJsonResponse(folder);
-					}),
-				OPTIONS: () => Effect.try(() => OptionsResponse({ allowedMethods: ['GET'] })),
-				ALL: () => Effect.try(() => AllResponse()),
-			},
-			{
-				cors: { methods: ['GET', 'OPTIONS'] },
-				onError: (error) => {
-					console.error('API Error:', error);
-					return createJsonResponse({ error: 'Something went wrong' }, { status: 500 });
-				},
-			}
-		),
-};

package/frontend/pages/studiocms_api/rest/v1/public/[type]/_routes/pages.ts

@@ -1,103 +0,0 @@
-import { apiResponseLogger } from 'studiocms:logger';
-import { SDKCore } from 'studiocms:sdk';
-import {
-	AllResponse,
-	createEffectAPIRoutes,
-	createJsonResponse,
-	Effect,
-	genLogger,
-	OptionsResponse,
-} from '@withstudiocms/effect';
-import type { EndpointRoute } from '../../../../../../../utils/rest-router.js';
-
-export const pagesRouter: EndpointRoute = {
-	__idType: 'string',
-	__index: createEffectAPIRoutes(
-		{
-			GET: (ctx) =>
-				genLogger('studioCMS:rest:v1:public:pages:GET')(function* () {
-					const sdk = yield* SDKCore;
-
-					const pages = yield* sdk.GET.pages();
-
-					const searchParams = ctx.url.searchParams;
-
-					const titleFilter = searchParams.get('title');
-					const slugFilter = searchParams.get('slug');
-					const authorFilter = searchParams.get('author');
-					const parentFolderFilter = searchParams.get('parentFolder');
-
-					let filteredPages = pages;
-
-					if (titleFilter) {
-						filteredPages = filteredPages.filter((page) => page.title.includes(titleFilter));
-					}
-
-					if (slugFilter) {
-						filteredPages = filteredPages.filter((page) => page.slug.includes(slugFilter));
-					}
-
-					if (authorFilter) {
-						filteredPages = filteredPages.filter((page) => page.authorId === authorFilter);
-					}
-
-					if (parentFolderFilter) {
-						filteredPages = filteredPages.filter(
-							(page) => page.parentFolder === parentFolderFilter
-						);
-					}
-
-					return createJsonResponse(filteredPages);
-				}),
-			OPTIONS: () => Effect.try(() => OptionsResponse({ allowedMethods: ['GET'] })),
-			ALL: () => Effect.try(() => AllResponse()),
-		},
-		{
-			cors: { methods: ['GET', 'OPTIONS'] },
-			onError: (error) => {
-				console.error('API Error:', error);
-				return createJsonResponse(
-					{ error: 'Internal Server Error' },
-					{ status: 500, statusText: 'Internal Server Error' }
-				);
-			},
-		}
-	),
-	id: (id: string) =>
-		createEffectAPIRoutes(
-			{
-				GET: () =>
-					genLogger('studioCMS:rest:v1:public:pages:[id]:GET')(function* () {
-						const sdk = yield* SDKCore;
-
-						if (!id) {
-							return apiResponseLogger(400, 'Invalid page ID');
-						}
-
-						const page = yield* sdk.GET.page.byId(id);
-
-						if (!page) {
-							return apiResponseLogger(404, 'Page not found');
-						}
-
-						if (page.draft) {
-							return apiResponseLogger(404, 'Page not found');
-						}
-
-						return createJsonResponse(page);
-					}),
-				OPTIONS: () => Effect.try(() => OptionsResponse({ allowedMethods: ['GET'] })),
-				ALL: () => Effect.try(() => AllResponse()),
-			},
-			{
-				cors: { methods: ['GET', 'OPTIONS'] },
-				onError: (error) => {
-					console.error('API Error:', error);
-					return createJsonResponse(
-						{ error: 'Internal Server Error' },
-						{ status: 500, statusText: 'Internal Server Error' }
-					);
-				},
-			}
-		),
-};

package/frontend/pages/studiocms_api/rest/v1/public/[type]/_routes/tags.ts

@@ -1,67 +0,0 @@
-import { SDKCore } from 'studiocms:sdk';
-import {
-	AllResponse,
-	createEffectAPIRoutes,
-	createJsonResponse,
-	Effect,
-	genLogger,
-	OptionsResponse,
-} from '@withstudiocms/effect';
-import type { EndpointRoute } from '../../../../../../../utils/rest-router.js';
-
-export const tagsRouter: EndpointRoute = {
-	__idType: 'number',
-	__index: createEffectAPIRoutes(
-		{
-			GET: (ctx) =>
-				genLogger('studiocms:rest:v1:public:tags:GET')(function* () {
-					const sdk = yield* SDKCore;
-
-					const searchParams = ctx.url.searchParams;
-					const folderNameFilter = searchParams.get('name');
-
-					let tags = yield* sdk.GET.tags.getAll();
-
-					if (folderNameFilter) {
-						tags = tags.filter((tag) => tag.name.includes(folderNameFilter));
-					}
-
-					return createJsonResponse(tags);
-				}),
-			OPTIONS: () => Effect.try(() => OptionsResponse({ allowedMethods: ['GET'] })),
-			ALL: () => Effect.try(() => AllResponse()),
-		},
-		{
-			cors: { methods: ['GET', 'OPTIONS'] },
-			onError: (error) => {
-				console.error('API Error:', error);
-				return createJsonResponse({ error: 'Something went wrong' }, { status: 500 });
-			},
-		}
-	),
-	id: (id: number) =>
-		createEffectAPIRoutes(
-			{
-				GET: () =>
-					genLogger(`studiocms:rest:v1:public:tags:${id}:GET`)(function* () {
-						const sdk = yield* SDKCore;
-						const tag = yield* sdk.GET.tags.byId(id);
-
-						if (!tag) {
-							return createJsonResponse({ error: 'Tag not found' }, { status: 404 });
-						}
-
-						return createJsonResponse(tag);
-					}),
-				OPTIONS: () => Effect.try(() => OptionsResponse({ allowedMethods: ['GET'] })),
-				ALL: () => Effect.try(() => AllResponse()),
-			},
-			{
-				cors: { methods: ['GET', 'OPTIONS'] },
-				onError: (error) => {
-					console.error('API Error:', error);
-					return createJsonResponse({ error: 'Something went wrong' }, { status: 500 });
-				},
-			}
-		),
-};

package/frontend/pages/studiocms_api/sdk/[...path].ts

@@ -1,97 +0,0 @@
-import logger from 'studiocms:logger';
-import { SDKCore } from 'studiocms:sdk';
-import {
-	AllResponse,
-	createEffectAPIRoutes,
-	createJsonResponse,
-	Effect,
-	type HTTPMethod,
-	OptionsResponse,
-} from '@withstudiocms/effect';
-import { createSimplePathRouter } from '#frontend/utils/rest-router.js';
-import { ProcessChangelog } from './utils/changelog.js';
-
-const optionsFn = (allowedMethods: string[]) => () =>
-	Effect.try(() => OptionsResponse({ allowedMethods }));
-
-const allFn = () => Effect.try(() => AllResponse());
-
-const cors = (method: string) => ({ methods: [method, 'OPTIONS'] }) as { methods: HTTPMethod[] };
-
-const isError = (error: unknown): error is Error => {
-	return (
-		error instanceof Error || (typeof error === 'object' && error !== null && 'message' in error)
-	);
-};
-
-const onError = (error: unknown) => {
-	const message = isError(error) ? error.message : String(error);
-	logger.error(`API Error: ${message}`);
-	return createJsonResponse(
-		{ error: 'Something went wrong' },
-		{
-			status: 500,
-		}
-	);
-};
-
-const router = {
-	'full-changelog.json': createEffectAPIRoutes(
-		{
-			POST: (ctx) =>
-				ProcessChangelog.pipe(
-					Effect.flatMap(({ generateChangelog, getRawChangelog, renderChangelog }) =>
-						getRawChangelog().pipe(
-							Effect.flatMap(generateChangelog),
-							Effect.flatMap((changelogData) => renderChangelog(changelogData, ctx))
-						)
-					),
-					Effect.map((renderedChangelog) => ({ success: true, changelog: renderedChangelog })),
-					Effect.map(createJsonResponse),
-					ProcessChangelog.Provide
-				),
-			OPTIONS: optionsFn(['POST']),
-			ALL: allFn,
-		},
-		{
-			cors: cors('POST'),
-			onError,
-		}
-	),
-	'list-pages': createEffectAPIRoutes(
-		{
-			GET: () =>
-				SDKCore.pipe(
-					Effect.flatMap((sdk) => sdk.GET.pages()),
-					Effect.map((pages) => {
-						const lastUpdated = new Date().toISOString();
-						return { lastUpdated, pages };
-					}),
-					Effect.map((data) => createJsonResponse(data))
-				),
-			OPTIONS: optionsFn(['GET']),
-			ALL: allFn,
-		},
-		{
-			cors: cors('GET'),
-			onError,
-		}
-	),
-	'update-latest-version-cache': createEffectAPIRoutes(
-		{
-			GET: () =>
-				SDKCore.pipe(
-					Effect.flatMap((sdk) => sdk.UPDATE.latestVersion()),
-					Effect.map((latestVersion) => createJsonResponse({ success: true, latestVersion }))
-				),
-			OPTIONS: optionsFn(['GET']),
-			ALL: allFn,
-		},
-		{
-			cors: cors('GET'),
-			onError,
-		}
-	),
-};
-
-export const ALL = createSimplePathRouter('studiocms:sdk', router);

package/frontend/pages/studiocms_api/sdk/utils/changelog.ts

@@ -1,119 +0,0 @@
-import { Effect, genLogger, HTTPClient, Platform, readAPIContextJson } from '@withstudiocms/effect';
-import { loadChangelog, semverCategories } from '@withstudiocms/internal_helpers/utils';
-import type { APIContext } from 'astro';
-import { Data } from 'effect';
-import type { List, Root } from 'mdast';
-import { toMarkdown } from 'mdast-util-to-markdown';
-
-export class ChangelogError extends Data.TaggedError('ChangelogError')<{ message: string }> {}
-
-export class ProcessChangelog extends Effect.Service<ProcessChangelog>()('ProcessChangelog', {
-	effect: genLogger('routes/sdk/utils/changelog/ProcessChangelog/effect')(function* () {
-		const httpClient = yield* HTTPClient;
-
-		const getRawChangelog = () =>
-			genLogger('routes/sdk/utils/changelog/ProcessChangelog/effect.getRawChangelog')(function* () {
-				const data = yield* httpClient.get(
-					'https://raw.githubusercontent.com/withstudiocms/studiocms/refs/heads/main/packages/studiocms/CHANGELOG.md'
-				);
-
-				if (data.status !== 200) {
-					return yield* new ChangelogError({
-						message: `Failed to fetch CHANGELOG.md: ${data.status} ${data.toString()}`,
-					});
-				}
-
-				return yield* data.text;
-			});
-
-		const generateChangelog = (raw: string) =>
-			genLogger('routes/sdk/utils/changelog/ProcessChangelog/effect.generateChangelog')(
-				function* () {
-					const ToProcess = yield* Effect.try(() => loadChangelog({ raw }));
-
-					const output: string[] = [];
-
-					const astEnd: Root = {
-						type: 'root',
-						children: [],
-					};
-
-					for (const version of ToProcess.versions) {
-						const versionChanges: List = { type: 'list', children: [] };
-
-						for (const semverCategory of semverCategories) {
-							for (const listItem of version.changes[semverCategory].children) {
-								versionChanges.children.push(listItem);
-							}
-						}
-
-						if (version.includes.size) {
-							versionChanges.children.push({
-								type: 'listItem',
-								children: [
-									{
-										type: 'paragraph',
-										children: [
-											{ type: 'text', value: `Includes: ${[...version.includes].join(', ')} ` },
-										],
-									},
-								],
-							});
-						}
-
-						if (!versionChanges.children.length) continue;
-
-						astEnd.children.push({
-							type: 'heading',
-							depth: 2,
-							children: [{ type: 'text', value: version.version }],
-						});
-
-						astEnd.children.push(versionChanges);
-					}
-
-					const outputData = yield* Effect.try(() => toMarkdown(astEnd, { bullet: '-' }));
-
-					output.push(outputData);
-
-					const markdownString = output.join('\n');
-
-					return markdownString;
-				}
-			);
-
-		const renderChangelog = (content: string, context: APIContext) =>
-			genLogger('routes/sdk/utils/changelog/ProcessChangelog/effect.renderChangelog')(function* () {
-				const currentRequestJson = yield* readAPIContextJson<{
-					currentURLOrigin: string;
-				}>(context);
-
-				const currentURLOrigin = currentRequestJson.currentURLOrigin;
-
-				const partialUrl = new URL(
-					context.locals.StudioCMS?.routeMap.endpointLinks.partials.render,
-					currentURLOrigin
-				);
-
-				return yield* Platform.HttpClientRequest.post(partialUrl).pipe(
-					Platform.HttpClientRequest.setHeaders({
-						'Content-Type': 'application/json',
-					}),
-					Platform.HttpClientRequest.bodyJson({
-						content,
-					}),
-					Effect.flatMap(httpClient.execute),
-					Effect.flatMap((response) => response.text)
-				);
-			});
-
-		return {
-			getRawChangelog,
-			generateChangelog,
-			renderChangelog,
-		};
-	}),
-	dependencies: [HTTPClient.Default],
-}) {
-	static Provide = Effect.provide(this.Default);
-}

package/frontend/scripts/auth/formListener.ts

@@ -1,81 +0,0 @@
-/**
- * This tool is used by Auth Login pages
- */
-
-import { toast as uiToast } from 'studiocms:ui/components/toaster/client';
-import type { ToastProps } from '@studiocms/ui/types';
-
-/**
- * Handles form submission events for login and registration forms.
- *
- * @param event - The submit event triggered by the form submission.
- * @param form - The HTML form element being submitted.
- * @param type - The type of form being submitted, either 'login' or 'register'.
- *
- * @remarks
- * - Prevents the default form submission behavior.
- * - For registration forms, checks if the password and confirm password fields match.
- * - Displays a toast notification if the passwords do not match.
- * - Submits the form data using the fetch API.
- * - Displays a success toast notification and reloads the page if the submission is successful.
- * - Displays an error toast notification if the submission fails.
- */
-export async function formListener(
-	event: SubmitEvent,
-	form: HTMLFormElement,
-	type: 'login' | 'register',
-	toast: (props: ToastProps) => void = uiToast,
-	/* v8 ignore start */
-	reload: () => void = () => {
-		if (typeof window !== 'undefined') {
-			window.location.reload();
-		}
-	}
-	/* v8 ignore stop */
-) {
-	event.preventDefault();
-
-	/* v8 ignore start */
-	if (type === 'register') {
-		const password = form.querySelector('input[name="password"]') as HTMLInputElement;
-		const confirmPassword = form.querySelector(
-			'input[name="confirm-password"]'
-		) as HTMLInputElement;
-
-		if (password.value !== confirmPassword.value) {
-			toast({
-				title: 'Passwords do not match!',
-				type: 'danger',
-				description: 'Please make sure your passwords match.',
-				closeButton: true,
-				persistent: true,
-			});
-			return;
-		}
-	}
-	/* v8 ignore stop */
-
-	const response = await fetch(form.action, {
-		method: form.method,
-		body: new FormData(form),
-	});
-	if (response.ok) {
-		toast({
-			title: `${type === 'login' ? 'Login' : 'Registration'} successful!`,
-			type: 'success',
-			description: 'Redirecting...',
-		});
-		reload();
-	} else {
-		const {
-			error: { title, description },
-		} = await response.json();
-		toast({
-			title,
-			type: 'danger',
-			description,
-			closeButton: true,
-			persistent: true,
-		});
-	}
-}

package/frontend/scripts/formdata-utils.ts

@@ -1,116 +0,0 @@
-import { z } from 'astro/zod';
-
-/**
- * Ensures the input value is returned as an array of strings.
- *
- * - If the input is `undefined`, `null`, or an empty string, returns an empty array.
- * - If the input is already an array of strings, returns it as-is.
- * - If the input is a JSON string representing an array, parses and returns the array.
- * - For any other input, returns an empty array.
- *
- * @param val - The value to convert to a string array. Can be a string, an array of strings, or undefined.
- * @returns An array of strings derived from the input value.
- */
-function ensureStringArray(val: string | string[] | undefined): string[] {
-	if (!val) return [];
-	if (typeof val === 'string' && val.trim() === '') return [];
-	if (Array.isArray(val)) return val;
-	try {
-		const parsed = JSON.parse(val);
-		if (Array.isArray(parsed)) return parsed;
-		return [];
-	} catch {
-		return [];
-	}
-}
-
-/**
- * Zod schema for validating and transforming data when creating a new StudioCMS page.
- *
- * Fields:
- * - `title`: Required string. The title of the page. Must not be empty.
- * - `slug`: Required string. Must be lowercase, only contain letters, numbers, and hyphens (no leading/trailing hyphens).
- * - `description`: Optional string. A description of the page.
- * - `package`: Required string. The package associated with the page.
- * - `showOnNav`: Optional boolean (default: false). Whether to show the page in navigation.
- * - `heroImage`: Optional string. URL or path to the hero image.
- * - `parentFolder`: Optional string or null (default: null). The parent folder for the page.
- * - `draft`: Optional boolean (default: false). Whether the page is a draft.
- * - `showAuthor`: Optional boolean (default: false). Whether to display the author.
- * - `showContributors`: Optional boolean (default: false). Whether to display contributors.
- * - `categories`: Optional string or array of strings (default: []). Transformed to an array of strings.
- * - `tags`: Optional string or array of strings (default: []). Transformed to an array of strings.
- *
- * Uses custom transformations to ensure `categories` and `tags` are always arrays of strings.
- */
-export const studioCMSCreatePageDataSchema = z.object({
-	title: z.string().min(1, { message: 'Title is required' }),
-	slug: z.string().refine((val) => /^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(val), {
-		message:
-			'Slug must be lowercase and can only contain letters, numbers, and hyphens (no leading/trailing hyphens)',
-	}),
-	description: z.string().optional(),
-	package: z.string(),
-	showOnNav: z.string().optional().transform(transformStringToBoolean),
-	heroImage: z.string().optional(),
-	parentFolder: z
-		.union([z.string(), z.null()])
-		.transform((value) => (value === 'null' || value === null ? null : value))
-		.optional()
-		.default(null),
-	draft: z.string().optional().transform(transformStringToBoolean),
-	showAuthor: z.string().optional().transform(transformStringToBoolean),
-	showContributors: z.string().optional().transform(transformStringToBoolean),
-	categories: z
-		.string()
-		.or(z.array(z.string()))
-		.optional()
-		.transform(ensureStringArray)
-		.default([]),
-	tags: z.string().or(z.array(z.string())).optional().transform(ensureStringArray).default([]),
-});
-
-/**
- * Schema for editing page data and content in StudioCMS.
- *
- * Extends the `studioCMSCreatePageDataSchema` with additional fields required for editing:
- * - `id`: The unique identifier for the page.
- * - `content`: The main content of the page as a string.
- * - `contentId`: The unique identifier for the content.
- * - `pluginFields`: An optional record of plugin-specific fields, where each value is a `FormDataEntryValue` or null.
- */
-export const studioCMSEditPageDataAndContentSchema = studioCMSCreatePageDataSchema.extend({
-	id: z.string(),
-	content: z.string(),
-	contentId: z.string(),
-	pluginFields: z.record(z.custom<FormDataEntryValue>().nullable()).optional().default({}),
-	augments: z.array(z.string()).optional(),
-});
-
-/**
- * Converts a FormData object into a plain record object, optionally remapping keys.
- *
- * @param formData - The FormData instance to convert.
- * @param keyRemapping - An optional mapping of original keys to new keys.
- * @returns A record object where each key is either the original or remapped key, and each value is the corresponding FormData entry value.
- */
-export function formDataToRecord(formData: FormData, keyRemapping?: Record<string, string>) {
-	const record: Record<string, FormDataEntryValue> = {};
-	for (const [key, value] of formData.entries()) {
-		const mappedKey = keyRemapping?.[key] || key;
-		record[mappedKey] = value;
-	}
-	return record;
-}
-
-/**
- * Transform a string true/false value to boolean.
- *
- * - If the input value is undefined, return false.
- *
- * @param value - The value to transform, can be undefined, 'true' or 'false'.
- * @returns Transformed value in boolean.
- */
-export function transformStringToBoolean(value: string | undefined): boolean {
-	return !!value && value.toLowerCase() === 'true';
-}