+
+
+
+
+ 
+
## StudioCMS Dashboard i18n Status
@@ -45,7 +45,7 @@ For an up-to-date list of our main tools check out our [`.prototools`](.prototoo
For more information about Proto checkout [Proto's Website](https://moonrepo.dev/proto)
-## This is a [`Moonrepo`](https://moonrepo.dev)
+## This is a [`Moon repository`](https://moonrepo.dev)
Follow install instructions listed on Moonrepo's docs, and you'll be all set to go! Its even a super easy single line command you put in your terminal!
@@ -65,16 +65,15 @@ Steps to get a running playground should be the following:
- clone repo
- run `pnpm i --frozen-lockfile`
-- change `dbStartPage` in the [node playground's](./playgrounds/node/studiocms.config.mjs) config to `true`
+- change `dbStartPage` in the [node playground's](./playground/studiocms.config.mts) config to `true`
- read the first time setup instructions listed in the [main package readme](./packages/studiocms/README.md#first-start-and-setup) then replace the astro db commands with the following:
Commands to run:
- - `pnpm playground:login` - Login your CLI to Astro Studio
- - `pnpm playground:push` - Creates the base tables on the remote database.
+ - `pnpm playground:push` - Push to your libSQL database assigned via environment variables
- `pnpm playground:dev` - Starts the Dev server connected to the linked database
-Once that process completes successfuly you are ready to navigate to http://localhost:4321/start and follow the instructions to get started.
+Once that process completes successfully you are ready to navigate to http://localhost:4321/start and follow the instructions to get started.
It will redirect and ask you to shutdown and change the above mentioned config option `dbStartPage` to `false` at which point that will enable full functionality of the CMS. you can now restart the dev server with `astro dev --remote` to continue viewing your new site!
diff --git a/www/assets/banner-readme.png b/assets/banner-readme.png
similarity index 100%
rename from www/assets/banner-readme.png
rename to assets/banner-readme.png
diff --git a/www/assets/discord-emoji-dark.png b/assets/discord-emoji-dark.png
similarity index 100%
rename from www/assets/discord-emoji-dark.png
rename to assets/discord-emoji-dark.png
diff --git a/www/assets/discord-emoji-light.png b/assets/discord-emoji-light.png
similarity index 100%
rename from www/assets/discord-emoji-light.png
rename to assets/discord-emoji-light.png
diff --git a/playgrounds/node/public/studiocms-auth/logo-adaptive.svg b/assets/logo-adaptive.svg
similarity index 100%
rename from playgrounds/node/public/studiocms-auth/logo-adaptive.svg
rename to assets/logo-adaptive.svg
diff --git a/www/assets/logo-dark.svg b/assets/logo-dark.svg
similarity index 100%
rename from www/assets/logo-dark.svg
rename to assets/logo-dark.svg
diff --git a/www/assets/logo-discord.png b/assets/logo-discord.png
similarity index 100%
rename from www/assets/logo-discord.png
rename to assets/logo-discord.png
diff --git a/www/assets/logo-discord.svg b/assets/logo-discord.svg
similarity index 100%
rename from www/assets/logo-discord.svg
rename to assets/logo-discord.svg
diff --git a/www/assets/logo-light.svg b/assets/logo-light.svg
similarity index 100%
rename from www/assets/logo-light.svg
rename to assets/logo-light.svg
diff --git a/www/assets/logo-outlined-adaptive.svg b/assets/logo-outlined-adaptive.svg
similarity index 100%
rename from www/assets/logo-outlined-adaptive.svg
rename to assets/logo-outlined-adaptive.svg
diff --git a/www/assets/logo-outlined-dark.svg b/assets/logo-outlined-dark.svg
similarity index 100%
rename from www/assets/logo-outlined-dark.svg
rename to assets/logo-outlined-dark.svg
diff --git a/www/assets/logo-outlined-light.svg b/assets/logo-outlined-light.svg
similarity index 100%
rename from www/assets/logo-outlined-light.svg
rename to assets/logo-outlined-light.svg
diff --git a/www/assets/old/banner-readme.png b/assets/old/banner-readme.png
similarity index 100%
rename from www/assets/old/banner-readme.png
rename to assets/old/banner-readme.png
diff --git a/www/assets/old/discord-emoji-dark.png b/assets/old/discord-emoji-dark.png
similarity index 100%
rename from www/assets/old/discord-emoji-dark.png
rename to assets/old/discord-emoji-dark.png
diff --git a/www/assets/old/discord-emoji-light.png b/assets/old/discord-emoji-light.png
similarity index 100%
rename from www/assets/old/discord-emoji-light.png
rename to assets/old/discord-emoji-light.png
diff --git a/www/assets/old/logo-dark.svg b/assets/old/logo-dark.svg
similarity index 100%
rename from www/assets/old/logo-dark.svg
rename to assets/old/logo-dark.svg
diff --git a/www/assets/old/logo-discord.png b/assets/old/logo-discord.png
similarity index 100%
rename from www/assets/old/logo-discord.png
rename to assets/old/logo-discord.png
diff --git a/www/assets/old/logo-discord.svg b/assets/old/logo-discord.svg
similarity index 100%
rename from www/assets/old/logo-discord.svg
rename to assets/old/logo-discord.svg
diff --git a/www/assets/old/logo-light.svg b/assets/old/logo-light.svg
similarity index 100%
rename from www/assets/old/logo-light.svg
rename to assets/old/logo-light.svg
diff --git a/www/assets/old/studioCMS-dark.png b/assets/old/studioCMS-dark.png
similarity index 100%
rename from www/assets/old/studioCMS-dark.png
rename to assets/old/studioCMS-dark.png
diff --git a/www/assets/old/studioCMS.png b/assets/old/studioCMS.png
similarity index 100%
rename from www/assets/old/studioCMS.png
rename to assets/old/studioCMS.png
diff --git a/www/assets/old/studiocms-new-logos.zip b/assets/old/studiocms-new-logos.zip
similarity index 100%
rename from www/assets/old/studiocms-new-logos.zip
rename to assets/old/studiocms-new-logos.zip
diff --git a/www/assets/studioCMS.png b/assets/studioCMS.png
similarity index 100%
rename from www/assets/studioCMS.png
rename to assets/studioCMS.png
diff --git a/www/assets/studiocms-dark.png b/assets/studiocms-dark.png
similarity index 100%
rename from www/assets/studiocms-dark.png
rename to assets/studiocms-dark.png
diff --git a/www/assets/studiocms-new-logos.zip b/assets/studiocms-new-logos.zip
similarity index 100%
rename from www/assets/studiocms-new-logos.zip
rename to assets/studiocms-new-logos.zip
diff --git a/biome.json b/biome.json
index 46f00326e8..9b57a86f4f 100644
--- a/biome.json
+++ b/biome.json
@@ -8,7 +8,7 @@
},
"files": {
"ignoreUnknown": true,
- "ignore": ["**/.astro/**", "**/package.json", "**/dist/**"]
+ "ignore": ["**/.astro/**", "**/package.json", "**/dist/**", "**/min.js"]
},
"formatter": {
"lineWidth": 100,
@@ -34,6 +34,9 @@
"recommended": true,
"suspicious": {
"noExplicitAny": "warn"
+ },
+ "style": {
+ "noParameterAssign": "off"
}
}
},
diff --git a/build-scripts/cmd/build.js b/build-scripts/cmd/build.js
new file mode 100644
index 0000000000..5c8932215b
--- /dev/null
+++ b/build-scripts/cmd/build.js
@@ -0,0 +1,187 @@
+import { execSync } from 'node:child_process';
+import fs from 'node:fs/promises';
+import esbuild from 'esbuild';
+import { copy } from 'esbuild-plugin-copy';
+import glob from 'fast-glob';
+import { dim, gray, green, red, yellow } from 'kleur/colors';
+
+/** @type {import('esbuild').BuildOptions} */
+const defaultConfig = {
+ minify: false,
+ format: 'esm',
+ platform: 'node',
+ target: 'node18',
+ sourcemap: false,
+ sourcesContent: false,
+};
+
+const dt = new Intl.DateTimeFormat('en-us', {
+ hour: '2-digit',
+ minute: '2-digit',
+});
+
+const dtsGen = (buildTsConfig) => ({
+ name: 'TypeScriptDeclarationsPlugin',
+ setup(build) {
+ build.onEnd((result) => {
+ if (result.errors.length > 0) return;
+ const date = dt.format(new Date());
+ console.log(`${dim(`[${date}]`)} Generating TypeScript declarations...`);
+ try {
+ const res = execSync(
+ `tsc --emitDeclarationOnly ${buildTsConfig ? '-p tsconfig.build.json' : ''} --outDir ./dist`
+ );
+ console.log(res.toString());
+ console.log(dim(`[${date}] `) + green('√ Generated TypeScript declarations'));
+ } catch (error) {
+ console.error(dim(`[${date}] `) + red(`${error}\n\n${error.stdout.toString()}`));
+ }
+ });
+ },
+});
+
+const CopyConfig = {
+ assets: [
+ {
+ from: ['./src/**/*.!(ts|js|css)'],
+ to: '.',
+ },
+ ],
+};
+
+export default async function build(...args) {
+ const config = Object.assign({}, defaultConfig);
+ const isDev = args.slice(-1)[0] === 'IS_DEV';
+ const patterns = args
+ .filter((f) => !!f) // remove empty args
+ .map((f) => f.replace(/^'/, '').replace(/'$/, '')); // Needed for Windows: glob strings contain surrounding string chars??? remove these
+ const entryPoints = [].concat(
+ ...(await Promise.all(
+ patterns.map((pattern) => glob(pattern, { filesOnly: true, absolute: true }))
+ ))
+ );
+ const date = dt.format(new Date());
+
+ const noClean = args.includes('--no-clean-dist');
+ const bundle = args.includes('--bundle');
+ const forceCJS = args.includes('--force-cjs');
+ const buildTsConfig = args.includes('--build-tsconfig');
+
+ const { type = 'module', dependencies = {} } = await readPackageJSON('./package.json');
+
+ config.define = {};
+ for (const [key, value] of await getDefinedEntries()) {
+ config.define[`process.env.${key}`] = JSON.stringify(value);
+ }
+ const format = type === 'module' && !forceCJS ? 'esm' : 'cjs';
+
+ const outdir = 'dist';
+
+ if (!noClean) {
+ console.log(
+ `${dim(`[${date}]`)} Cleaning dist directory... ${dim(`(${entryPoints.length} files found)`)}`
+ );
+ await clean(outdir, [`!${outdir}/**/*.d.ts`]);
+ }
+
+ if (!isDev) {
+ console.log(
+ `${dim(`[${date}]`)} Building...${bundle ? '(Bundling)' : ''} ${dim(`(${entryPoints.length} files found)`)}`
+ );
+ await esbuild.build({
+ ...config,
+ bundle,
+ external: bundle ? Object.keys(dependencies) : undefined,
+ entryPoints,
+ outdir,
+ outExtension: forceCJS ? { '.js': '.cjs' } : {},
+ format,
+ plugins: [copy(CopyConfig), dtsGen(buildTsConfig)],
+ });
+ console.log(dim(`[${date}] `) + green('√ Build Complete'));
+ return;
+ }
+
+ const rebuildPlugin = {
+ name: 'dev:rebuild',
+ setup(build) {
+ build.onEnd(async (result) => {
+ const date = dt.format(new Date());
+ if (result?.errors.length) {
+ console.error(dim(`[${date}] `) + red(error || result.errors.join('\n')));
+ } else {
+ if (result.warnings.length) {
+ console.info(
+ dim(`[${date}] `) + yellow(`! updated with warnings:\n${result.warnings.join('\n')}`)
+ );
+ }
+ console.info(dim(`[${date}] `) + green('√ updated'));
+ }
+ });
+ },
+ };
+
+ const builder = await esbuild.context({
+ ...config,
+ entryPoints,
+ outdir,
+ format,
+ sourcemap: 'linked',
+ plugins: [copy(CopyConfig), rebuildPlugin],
+ });
+
+ console.log(
+ `${dim(`[${date}] `) + gray('Watching for changes...')} ${dim(`(${entryPoints.length} files found)`)}`
+ );
+ await builder.watch();
+
+ process.on('beforeExit', () => {
+ builder.stop?.();
+ });
+}
+
+async function clean(outdir, skip = []) {
+ const files = await glob([`${outdir}/**`, ...skip], { filesOnly: true });
+ await Promise.all(files.map((file) => fs.rm(file, { force: true })));
+}
+
+/**
+ * Contextual `define` values to statically replace in the built JS output.
+ * Available to all packages, but mostly useful for CLIs like `create-astro`.
+ */
+async function getDefinedEntries() {
+ const define = {
+ /** The current version (at the time of building) for the current package, such as `astro` or `@astrojs/sitemap` */
+ PACKAGE_VERSION: await getInternalPackageVersion('./package.json'),
+ /** The current version (at the time of building) for `typescript` */
+ TYPESCRIPT_VERSION: await getWorkspacePackageVersion('typescript'),
+ };
+ for (const [key, value] of Object.entries(define)) {
+ if (value === undefined) {
+ delete define[key];
+ }
+ }
+ return Object.entries(define);
+}
+
+async function readPackageJSON(path) {
+ return await fs.readFile(path, { encoding: 'utf8' }).then((res) => JSON.parse(res));
+}
+
+async function getInternalPackageVersion(path) {
+ return readPackageJSON(path).then((res) => res.version);
+}
+
+async function getWorkspacePackageVersion(packageName) {
+ const { dependencies, devDependencies } = await readPackageJSON(
+ new URL('../../package.json', import.meta.url)
+ );
+ const deps = { ...dependencies, ...devDependencies };
+ const version = deps[packageName];
+ if (!version) {
+ throw new Error(
+ `Unable to resolve "${packageName}". Is it a dependency of the workspace root?`
+ );
+ }
+ return version.replace(/^\D+/, '');
+}
diff --git a/build-scripts/index.js b/build-scripts/index.js
new file mode 100755
index 0000000000..17a4d6e676
--- /dev/null
+++ b/build-scripts/index.js
@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+export default async function run() {
+ const [cmd, ...args] = process.argv.slice(2);
+ switch (cmd) {
+ case 'dev':
+ case 'build': {
+ const { default: build } = await import('./cmd/build.js');
+ await build(...args, cmd === 'dev' ? 'IS_DEV' : undefined);
+ break;
+ }
+ }
+}
+
+run();
diff --git a/build-scripts/jsconfig.json b/build-scripts/jsconfig.json
new file mode 100644
index 0000000000..5cf3835e81
--- /dev/null
+++ b/build-scripts/jsconfig.json
@@ -0,0 +1,12 @@
+{
+ "compilerOptions": {
+ "declaration": true,
+ "strict": true,
+ "module": "esnext",
+ "moduleResolution": "node",
+ "esModuleInterop": true,
+ "skipLibCheck": true,
+ "forceConsistentCasingInFileNames": true,
+ "target": "esnext"
+ }
+}
diff --git a/build-scripts/package.json b/build-scripts/package.json
new file mode 100644
index 0000000000..862fda8573
--- /dev/null
+++ b/build-scripts/package.json
@@ -0,0 +1,19 @@
+{
+ "name": "build-scripts",
+ "version": "0.0.14",
+ "private": true,
+ "type": "module",
+ "main": "./index.js",
+ "bin": {
+ "build-scripts": "./index.js"
+ },
+ "dependencies": {
+ "esbuild": "^0.24.2",
+ "esbuild-plugin-copy": "^2.1.1",
+ "fast-glob": "^3.3.2",
+ "kleur": "^4.1.5",
+ "p-limit": "^6.1.0",
+ "tinyexec": "^0.3.1",
+ "tsconfck": "^3.1.4"
+ }
+}
\ No newline at end of file
diff --git a/www/docs/.gitignore b/docs/.gitignore
similarity index 100%
rename from www/docs/.gitignore
rename to docs/.gitignore
diff --git a/playgrounds/node/.vscode/extensions.json b/docs/.vscode/extensions.json
similarity index 100%
rename from playgrounds/node/.vscode/extensions.json
rename to docs/.vscode/extensions.json
diff --git a/playgrounds/node/.vscode/launch.json b/docs/.vscode/launch.json
similarity index 100%
rename from playgrounds/node/.vscode/launch.json
rename to docs/.vscode/launch.json
diff --git a/www/docs/README.md b/docs/README.md
similarity index 100%
rename from www/docs/README.md
rename to docs/README.md
diff --git a/www/docs/astro.config.mts b/docs/astro.config.mts
similarity index 88%
rename from www/docs/astro.config.mts
rename to docs/astro.config.mts
index 789aefe843..76b0f26726 100644
--- a/www/docs/astro.config.mts
+++ b/docs/astro.config.mts
@@ -2,9 +2,9 @@ import starlight from '@astrojs/starlight';
import starlightUtils from '@lorenzo_lewis/starlight-utils';
import { defineConfig } from 'astro/config';
import starlightImageZoom from 'starlight-image-zoom';
-import getCoolifyURL from './hostUtils';
-import rehypePluginKit from './src/plugins/rehypePluginKit';
-import { typeDocPlugins, typeDocSideBarEntry } from './typedoc.config';
+import getCoolifyURL from './hostUtils.ts';
+import rehypePluginKit from './src/plugins/rehypePluginKit.ts';
+import { typeDocPlugins, typeDocSideBarEntry } from './typedoc.config.ts';
// Define the Site URL
const site = getCoolifyURL(true) || 'https://docs.studiocms.dev/';
@@ -30,9 +30,6 @@ export const locales = {
export default defineConfig({
site,
- experimental: {
- directRenderScript: true,
- },
image: {
remotePatterns: [{ protocol: 'https' }],
},
@@ -73,7 +70,7 @@ export default defineConfig({
'./src/styles/starlight.css',
],
editLink: {
- baseUrl: 'https://github.com/withstudiocms/studiocms/tree/main/www/docs',
+ baseUrl: 'https://github.com/withstudiocms/studiocms/tree/main/docs',
},
head: [
// {
@@ -143,21 +140,6 @@ export default defineConfig({
autogenerate: { directory: 'customizing/studiocms-renderers' },
collapsed: true,
},
- {
- label: '@studiocms/ui',
- badge: { text: 'New', variant: 'success' },
- items: [
- { label: 'Getting Started', link: 'customizing/studiocms-ui/' },
- {
- label: 'Components',
- autogenerate: {
- directory: 'customizing/studiocms-ui/components',
- collapsed: true,
- },
- },
- ],
- collapsed: true,
- },
],
},
],
diff --git a/www/docs/ec.config.mjs b/docs/ec.config.mjs
similarity index 87%
rename from www/docs/ec.config.mjs
rename to docs/ec.config.mjs
index 74fc964ab4..bb02c7ba39 100644
--- a/www/docs/ec.config.mjs
+++ b/docs/ec.config.mjs
@@ -24,7 +24,9 @@ export default defineEcConfig({
}),
],
styleOverrides: {
- // @ts-expect-error - This is not a Standard EC config option, but it's a valid one from a plugin
+ frames: {
+ editorActiveTabIndicatorBottomColor: 'var(--sl-color-accent)',
+ },
twoSlash: {
cursorColor: '#f8f8f2',
},
diff --git a/www/docs/hostUtils.ts b/docs/hostUtils.ts
similarity index 100%
rename from www/docs/hostUtils.ts
rename to docs/hostUtils.ts
diff --git a/www/docs/lunaria.config.ts b/docs/lunaria.config.ts
similarity index 100%
rename from www/docs/lunaria.config.ts
rename to docs/lunaria.config.ts
diff --git a/www/docs/lunaria/components.ts b/docs/lunaria/components.ts
similarity index 100%
rename from www/docs/lunaria/components.ts
rename to docs/lunaria/components.ts
diff --git a/www/docs/lunaria/styles.ts b/docs/lunaria/styles.ts
similarity index 100%
rename from www/docs/lunaria/styles.ts
rename to docs/lunaria/styles.ts
diff --git a/www/docs/package.json b/docs/package.json
similarity index 98%
rename from www/docs/package.json
rename to docs/package.json
index 8d46c63a38..b841285648 100644
--- a/www/docs/package.json
+++ b/docs/package.json
@@ -16,7 +16,7 @@
"@studiocms/renderers": "workspace:*",
"@studiocms/blog": "workspace:*",
"@studiocms/devapps": "workspace:*",
- "@studiocms/ui": "workspace:*",
+ "@studiocms/ui": "catalog:",
"astro": "catalog:",
"@astrojs/check": "catalog:",
diff --git a/www/docs/public/logo-light.svg b/docs/public/logo-light.svg
similarity index 100%
rename from www/docs/public/logo-light.svg
rename to docs/public/logo-light.svg
diff --git a/www/docs/public/og.jpg b/docs/public/og.jpg
similarity index 100%
rename from www/docs/public/og.jpg
rename to docs/public/og.jpg
diff --git a/www/docs/scripts/lunaria-report-bot.ts b/docs/scripts/lunaria-report-bot.ts
similarity index 100%
rename from www/docs/scripts/lunaria-report-bot.ts
rename to docs/scripts/lunaria-report-bot.ts
diff --git a/www/docs/scripts/lunaria.mts b/docs/scripts/lunaria.mts
similarity index 100%
rename from www/docs/scripts/lunaria.mts
rename to docs/scripts/lunaria.mts
diff --git a/www/docs/src/assets/avatar.png b/docs/src/assets/avatar.png
similarity index 100%
rename from www/docs/src/assets/avatar.png
rename to docs/src/assets/avatar.png
diff --git a/www/docs/src/assets/gallery/CreateNewPageDark-1.png b/docs/src/assets/gallery/CreateNewPageDark-1.png
similarity index 100%
rename from www/docs/src/assets/gallery/CreateNewPageDark-1.png
rename to docs/src/assets/gallery/CreateNewPageDark-1.png
diff --git a/www/docs/src/assets/gallery/CreateNewPageDark.png b/docs/src/assets/gallery/CreateNewPageDark.png
similarity index 100%
rename from www/docs/src/assets/gallery/CreateNewPageDark.png
rename to docs/src/assets/gallery/CreateNewPageDark.png
diff --git a/www/docs/src/assets/gallery/CreateNewPageLight-1.png b/docs/src/assets/gallery/CreateNewPageLight-1.png
similarity index 100%
rename from www/docs/src/assets/gallery/CreateNewPageLight-1.png
rename to docs/src/assets/gallery/CreateNewPageLight-1.png
diff --git a/www/docs/src/assets/gallery/CreateNewPageLight-2.png b/docs/src/assets/gallery/CreateNewPageLight-2.png
similarity index 100%
rename from www/docs/src/assets/gallery/CreateNewPageLight-2.png
rename to docs/src/assets/gallery/CreateNewPageLight-2.png
diff --git a/www/docs/src/assets/gallery/DashboardDark.png b/docs/src/assets/gallery/DashboardDark.png
similarity index 100%
rename from www/docs/src/assets/gallery/DashboardDark.png
rename to docs/src/assets/gallery/DashboardDark.png
diff --git a/www/docs/src/assets/gallery/DashboardLight.png b/docs/src/assets/gallery/DashboardLight.png
similarity index 100%
rename from www/docs/src/assets/gallery/DashboardLight.png
rename to docs/src/assets/gallery/DashboardLight.png
diff --git a/www/docs/src/assets/gallery/EditPageDark-1.png b/docs/src/assets/gallery/EditPageDark-1.png
similarity index 100%
rename from www/docs/src/assets/gallery/EditPageDark-1.png
rename to docs/src/assets/gallery/EditPageDark-1.png
diff --git a/www/docs/src/assets/gallery/EditPageDark-2.png b/docs/src/assets/gallery/EditPageDark-2.png
similarity index 100%
rename from www/docs/src/assets/gallery/EditPageDark-2.png
rename to docs/src/assets/gallery/EditPageDark-2.png
diff --git a/www/docs/src/assets/gallery/EditPageLight-1.png b/docs/src/assets/gallery/EditPageLight-1.png
similarity index 100%
rename from www/docs/src/assets/gallery/EditPageLight-1.png
rename to docs/src/assets/gallery/EditPageLight-1.png
diff --git a/www/docs/src/assets/gallery/EditPageLight-2.png b/docs/src/assets/gallery/EditPageLight-2.png
similarity index 100%
rename from www/docs/src/assets/gallery/EditPageLight-2.png
rename to docs/src/assets/gallery/EditPageLight-2.png
diff --git a/www/docs/src/assets/gallery/ExistingPageLight.png b/docs/src/assets/gallery/ExistingPageLight.png
similarity index 100%
rename from www/docs/src/assets/gallery/ExistingPageLight.png
rename to docs/src/assets/gallery/ExistingPageLight.png
diff --git a/www/docs/src/assets/gallery/ExistingPagesDark.png b/docs/src/assets/gallery/ExistingPagesDark.png
similarity index 100%
rename from www/docs/src/assets/gallery/ExistingPagesDark.png
rename to docs/src/assets/gallery/ExistingPagesDark.png
diff --git a/www/docs/src/assets/gallery/LoginPageDark.png b/docs/src/assets/gallery/LoginPageDark.png
similarity index 100%
rename from www/docs/src/assets/gallery/LoginPageDark.png
rename to docs/src/assets/gallery/LoginPageDark.png
diff --git a/www/docs/src/assets/gallery/LoginPageLight.png b/docs/src/assets/gallery/LoginPageLight.png
similarity index 100%
rename from www/docs/src/assets/gallery/LoginPageLight.png
rename to docs/src/assets/gallery/LoginPageLight.png
diff --git a/www/docs/src/assets/gallery/SiteAdminsDark.png b/docs/src/assets/gallery/SiteAdminsDark.png
similarity index 100%
rename from www/docs/src/assets/gallery/SiteAdminsDark.png
rename to docs/src/assets/gallery/SiteAdminsDark.png
diff --git a/www/docs/src/assets/gallery/SiteConfigDark.png b/docs/src/assets/gallery/SiteConfigDark.png
similarity index 100%
rename from www/docs/src/assets/gallery/SiteConfigDark.png
rename to docs/src/assets/gallery/SiteConfigDark.png
diff --git a/www/docs/src/assets/gallery/UserProfileDark.png b/docs/src/assets/gallery/UserProfileDark.png
similarity index 100%
rename from www/docs/src/assets/gallery/UserProfileDark.png
rename to docs/src/assets/gallery/UserProfileDark.png
diff --git a/www/docs/src/assets/gallery/UserProfileLight.png b/docs/src/assets/gallery/UserProfileLight.png
similarity index 100%
rename from www/docs/src/assets/gallery/UserProfileLight.png
rename to docs/src/assets/gallery/UserProfileLight.png
diff --git a/www/docs/src/assets/index.ts b/docs/src/assets/index.ts
similarity index 100%
rename from www/docs/src/assets/index.ts
rename to docs/src/assets/index.ts
diff --git a/www/docs/src/assets/web-vitals/cv-analytics-dark.png b/docs/src/assets/web-vitals/cv-analytics-dark.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/cv-analytics-dark.png
rename to docs/src/assets/web-vitals/cv-analytics-dark.png
diff --git a/www/docs/src/assets/web-vitals/cv-analytics-light.png b/docs/src/assets/web-vitals/cv-analytics-light.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/cv-analytics-light.png
rename to docs/src/assets/web-vitals/cv-analytics-light.png
diff --git a/www/docs/src/assets/web-vitals/cv-byroute-dark.png b/docs/src/assets/web-vitals/cv-byroute-dark.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/cv-byroute-dark.png
rename to docs/src/assets/web-vitals/cv-byroute-dark.png
diff --git a/www/docs/src/assets/web-vitals/cv-byroute-light.png b/docs/src/assets/web-vitals/cv-byroute-light.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/cv-byroute-light.png
rename to docs/src/assets/web-vitals/cv-byroute-light.png
diff --git a/www/docs/src/assets/web-vitals/cv-progressbars-dark.png b/docs/src/assets/web-vitals/cv-progressbars-dark.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/cv-progressbars-dark.png
rename to docs/src/assets/web-vitals/cv-progressbars-dark.png
diff --git a/www/docs/src/assets/web-vitals/cv-progressbars-light.png b/docs/src/assets/web-vitals/cv-progressbars-light.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/cv-progressbars-light.png
rename to docs/src/assets/web-vitals/cv-progressbars-light.png
diff --git a/www/docs/src/assets/web-vitals/pagespeed-dark.png b/docs/src/assets/web-vitals/pagespeed-dark.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/pagespeed-dark.png
rename to docs/src/assets/web-vitals/pagespeed-dark.png
diff --git a/www/docs/src/assets/web-vitals/pagespeed-light.png b/docs/src/assets/web-vitals/pagespeed-light.png
similarity index 100%
rename from www/docs/src/assets/web-vitals/pagespeed-light.png
rename to docs/src/assets/web-vitals/pagespeed-light.png
diff --git a/www/docs/src/components/ContributorList.astro b/docs/src/components/ContributorList.astro
similarity index 100%
rename from www/docs/src/components/ContributorList.astro
rename to docs/src/components/ContributorList.astro
diff --git a/www/docs/src/components/DropdownScript.astro b/docs/src/components/DropdownScript.astro
similarity index 100%
rename from www/docs/src/components/DropdownScript.astro
rename to docs/src/components/DropdownScript.astro
diff --git a/www/docs/src/components/FacePile.astro b/docs/src/components/FacePile.astro
similarity index 100%
rename from www/docs/src/components/FacePile.astro
rename to docs/src/components/FacePile.astro
diff --git a/www/docs/src/components/Gallery.astro b/docs/src/components/Gallery.astro
similarity index 100%
rename from www/docs/src/components/Gallery.astro
rename to docs/src/components/Gallery.astro
diff --git a/www/docs/src/components/Integration.astro b/docs/src/components/Integration.astro
similarity index 100%
rename from www/docs/src/components/Integration.astro
rename to docs/src/components/Integration.astro
diff --git a/www/docs/src/components/ModalScript.astro b/docs/src/components/ModalScript.astro
similarity index 100%
rename from www/docs/src/components/ModalScript.astro
rename to docs/src/components/ModalScript.astro
diff --git a/www/docs/src/components/PackageCatalog.astro b/docs/src/components/PackageCatalog.astro
similarity index 93%
rename from www/docs/src/components/PackageCatalog.astro
rename to docs/src/components/PackageCatalog.astro
index 6fa1f75430..28b325e68b 100644
--- a/www/docs/src/components/PackageCatalog.astro
+++ b/docs/src/components/PackageCatalog.astro
@@ -42,7 +42,7 @@ const packages = (await getCollection('package-catalog'))
{description}
-} )) diff --git a/www/docs/src/components/PreviewCard.astro b/docs/src/components/PreviewCard.astro similarity index 100% rename from www/docs/src/components/PreviewCard.astro rename to docs/src/components/PreviewCard.astro diff --git a/www/docs/src/components/ReadMore.astro b/docs/src/components/ReadMore.astro similarity index 100% rename from www/docs/src/components/ReadMore.astro rename to docs/src/components/ReadMore.astro diff --git a/www/docs/src/components/Sponsors.astro b/docs/src/components/Sponsors.astro similarity index 100% rename from www/docs/src/components/Sponsors.astro rename to docs/src/components/Sponsors.astro diff --git a/www/docs/src/components/ThemeHelperScript.astro b/docs/src/components/ThemeHelperScript.astro similarity index 100% rename from www/docs/src/components/ThemeHelperScript.astro rename to docs/src/components/ThemeHelperScript.astro diff --git a/www/docs/src/components/ToasterScript.astro b/docs/src/components/ToasterScript.astro similarity index 100% rename from www/docs/src/components/ToasterScript.astro rename to docs/src/components/ToasterScript.astro diff --git a/www/docs/src/components/TursoCLI.astro b/docs/src/components/TursoCLI.astro similarity index 100% rename from www/docs/src/components/TursoCLI.astro rename to docs/src/components/TursoCLI.astro diff --git a/www/docs/src/components/Version.astro b/docs/src/components/Version.astro similarity index 100% rename from www/docs/src/components/Version.astro rename to docs/src/components/Version.astro diff --git a/www/docs/src/components/Youtube.astro b/docs/src/components/Youtube.astro similarity index 100% rename from www/docs/src/components/Youtube.astro rename to docs/src/components/Youtube.astro diff --git a/www/docs/src/components/landing/Card.astro b/docs/src/components/landing/Card.astro similarity index 100% rename from www/docs/src/components/landing/Card.astro rename to docs/src/components/landing/Card.astro diff --git a/www/docs/src/components/landing/ListCard.astro b/docs/src/components/landing/ListCard.astro similarity index 100% rename from www/docs/src/components/landing/ListCard.astro rename to docs/src/components/landing/ListCard.astro diff --git a/www/docs/src/components/landing/SplitCard.astro b/docs/src/components/landing/SplitCard.astro similarity index 100% rename from www/docs/src/components/landing/SplitCard.astro rename to docs/src/components/landing/SplitCard.astro diff --git a/docs/src/content.config.ts b/docs/src/content.config.ts new file mode 100644 index 0000000000..ea8715a5ef --- /dev/null +++ b/docs/src/content.config.ts @@ -0,0 +1,65 @@ +import { defineCollection, reference, z } from 'astro:content'; +import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders'; +import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; +import { glob } from 'astro/loaders'; + +const packageCatalogSchema = z.object({ + name: z.string(), + description: z.string(), + docsLink: z.string(), + githubURL: z.string(), + catalog: z + .union([z.literal('studiocms'), z.literal('community')]) + .optional() + .default('studiocms'), + isPlugin: z.boolean().optional().default(false), + publiclyUsable: z.boolean().optional().default(false), + released: z.boolean().optional().default(true), +}); + +const baseSchema = z.object({ + type: z.literal('base').optional().default('base'), + i18nReady: z.boolean().optional().default(false), +}); + +const integrationSchema = baseSchema.extend({ + type: z.literal('integration'), + catalogEntry: reference('package-catalog'), +}); + +const redirectSchema = baseSchema.extend({ + type: z.literal('redirect'), + redirect: z.string(), +}); + +export const collections = { + docs: defineCollection({ + loader: docsLoader(), + schema: docsSchema({ extend: z.union([baseSchema, integrationSchema, redirectSchema]) }), + }), + i18n: defineCollection({ + loader: i18nLoader(), + schema: i18nSchema({ + extend: z.object({ + 'site-title.labels.docs': z.string().optional(), + 'site-title.labels.main-site': z.string().optional(), + 'site-title.labels.live-demo': z.string().optional(), + 'sponsors.sponsoredby': z.string().optional(), + 'package-catalog.readmore.start': z.string().optional(), + 'package-catalog.readmore.end': z.string().optional(), + 'integration-labels.changelog': z.string().optional(), + 'contributors.core-packages': z.string().optional(), + 'contributors.ui-library': z.string().optional(), + 'contributors.devapps': z.string().optional(), + 'contributors.plugins': z.string().optional(), + 'contributors.documentation': z.string().optional(), + 'contributors.website': z.string().optional(), + 'contributors.bots': z.string().optional(), + }), + }), + }), + 'package-catalog': defineCollection({ + loader: glob({ pattern: '*.json', base: 'src/content/package-catalog' }), + schema: packageCatalogSchema, + }), +}; diff --git a/www/docs/src/content/docs/config-reference/dashboard.mdx b/docs/src/content/docs/config-reference/dashboard/index.mdx similarity index 68% rename from www/docs/src/content/docs/config-reference/dashboard.mdx rename to docs/src/content/docs/config-reference/dashboard/index.mdx index 13040ab261..944827c2d2 100644 --- a/www/docs/src/content/docs/config-reference/dashboard.mdx +++ b/docs/src/content/docs/config-reference/dashboard/index.mdx @@ -79,59 +79,6 @@ export default defineStudioCMSConfig({ }) ``` -### `UnoCSSConfigOverride` - -- **Type:** `unocssConfigSchema{} | undefined{}` - -Allows customization of the UnoCSS Configuration. - -#### `injectReset` - -- **Type:** `boolean | undefined` -- **Default:** `false` - -Allows the user to enable or disable the UnoCSS Default Reset import. - -#### `injectEntry` - -- **Type:** `boolean | undefined` -- **Default:** `false` - -Allows the user to enable or disable the UnoCSS Default Entry import. - -#### `presetsConfig` - -- **Type:** `unocssPresetsSchema{} | undefined{}` - -Allows the user to modify the included UnoCSS Presets. - -##### `presetDaisyUI` - -- **Type:** `unocssDaisyUISchema{} | undefined{}` - -Allows the user to enable or disable the UnoCSS DaisyUI Preset. - -###### `themes` - -- **Type:** `Array
0.1.0-beta.7 and below.
sidebar:
order: 5
---
diff --git a/www/docs/src/content/docs/start-here/getting-started.mdx b/docs/src/content/docs/start-here/getting-started.mdx
similarity index 100%
rename from www/docs/src/content/docs/start-here/getting-started.mdx
rename to docs/src/content/docs/start-here/getting-started.mdx
diff --git a/www/docs/src/content/docs/start-here/why-studioCMS.mdx b/docs/src/content/docs/start-here/why-studioCMS.mdx
similarity index 100%
rename from www/docs/src/content/docs/start-here/why-studioCMS.mdx
rename to docs/src/content/docs/start-here/why-studioCMS.mdx
diff --git a/www/docs/src/content/docs/studioCMS-dark.png b/docs/src/content/docs/studioCMS-dark.png
similarity index 100%
rename from www/docs/src/content/docs/studioCMS-dark.png
rename to docs/src/content/docs/studioCMS-dark.png
diff --git a/www/docs/src/content/docs/studioCMS.png b/docs/src/content/docs/studioCMS.png
similarity index 100%
rename from www/docs/src/content/docs/studioCMS.png
rename to docs/src/content/docs/studioCMS.png
diff --git a/www/docs/src/content/i18n/en.json b/docs/src/content/i18n/en.json
similarity index 100%
rename from www/docs/src/content/i18n/en.json
rename to docs/src/content/i18n/en.json
diff --git a/www/docs/src/content/package-catalog/astrojs-web-vitals.json b/docs/src/content/package-catalog/astrojs-web-vitals.json
similarity index 100%
rename from www/docs/src/content/package-catalog/astrojs-web-vitals.json
rename to docs/src/content/package-catalog/astrojs-web-vitals.json
diff --git a/www/docs/src/content/package-catalog/studiocms-blog.json b/docs/src/content/package-catalog/studiocms-blog.json
similarity index 100%
rename from www/docs/src/content/package-catalog/studiocms-blog.json
rename to docs/src/content/package-catalog/studiocms-blog.json
diff --git a/www/docs/src/content/package-catalog/studiocms-devapps.json b/docs/src/content/package-catalog/studiocms-devapps.json
similarity index 100%
rename from www/docs/src/content/package-catalog/studiocms-devapps.json
rename to docs/src/content/package-catalog/studiocms-devapps.json
diff --git a/www/docs/src/content/package-catalog/studiocms-ui.json b/docs/src/content/package-catalog/studiocms-ui.json
similarity index 84%
rename from www/docs/src/content/package-catalog/studiocms-ui.json
rename to docs/src/content/package-catalog/studiocms-ui.json
index 0914fe8ad3..4eedb3481f 100644
--- a/www/docs/src/content/package-catalog/studiocms-ui.json
+++ b/docs/src/content/package-catalog/studiocms-ui.json
@@ -2,9 +2,9 @@
"$schema": "../../../.astro/collections/package-catalog.schema.json",
"name": "@studiocms/ui",
"description": "The UI library for StudioCMS. Includes the layouts & components we use to build StudioCMS.",
- "docsLink": "/customizing/studiocms-ui/",
+ "docsLink": "https://ui.studiocms.dev",
"githubURL": "https://github.com/withstudiocms/studiocms/tree/main/packages/studiocms_ui/",
"catalog": "studiocms",
- "released": false,
+ "released": true,
"publiclyUsable": true
}
diff --git a/www/docs/src/content/package-catalog/studiocms.json b/docs/src/content/package-catalog/studiocms.json
similarity index 100%
rename from www/docs/src/content/package-catalog/studiocms.json
rename to docs/src/content/package-catalog/studiocms.json
diff --git a/www/docs/src/env.d.ts b/docs/src/env.d.ts
similarity index 100%
rename from www/docs/src/env.d.ts
rename to docs/src/env.d.ts
diff --git a/www/docs/src/plugins/rehype.types.ts b/docs/src/plugins/rehype.types.ts
similarity index 100%
rename from www/docs/src/plugins/rehype.types.ts
rename to docs/src/plugins/rehype.types.ts
diff --git a/www/docs/src/plugins/rehypeAutolink.ts b/docs/src/plugins/rehypeAutolink.ts
similarity index 96%
rename from www/docs/src/plugins/rehypeAutolink.ts
rename to docs/src/plugins/rehypeAutolink.ts
index 237af75c0d..97f6dc2aeb 100644
--- a/www/docs/src/plugins/rehypeAutolink.ts
+++ b/docs/src/plugins/rehypeAutolink.ts
@@ -3,7 +3,7 @@ import { h } from 'hastscript';
import { escape as esc } from 'html-escaper';
import rehypeAutoLink from 'rehype-autolink-headings';
import type { Options as rehypeAutolinkHeadingsOptions } from 'rehype-autolink-headings';
-import type { RehypePlugin } from './rehype.types';
+import type { RehypePlugin } from './rehype.types.ts';
const AnchorLinkIcon = h(
'span',
diff --git a/www/docs/src/plugins/rehypeExternalLinks.ts b/docs/src/plugins/rehypeExternalLinks.ts
similarity index 87%
rename from www/docs/src/plugins/rehypeExternalLinks.ts
rename to docs/src/plugins/rehypeExternalLinks.ts
index f1203c27c0..9f519f1192 100644
--- a/www/docs/src/plugins/rehypeExternalLinks.ts
+++ b/docs/src/plugins/rehypeExternalLinks.ts
@@ -1,5 +1,5 @@
import rehypeExternal from 'rehype-external-links';
-import type { RehypePlugin } from './rehype.types';
+import type { RehypePlugin } from './rehype.types.ts';
// biome-ignore lint/suspicious/noExplicitAny: any is used to match the generic type
export const rehypeExternalLinks: [RehypePlugin, any] = [
diff --git a/www/docs/src/plugins/rehypePluginKit.ts b/docs/src/plugins/rehypePluginKit.ts
similarity index 51%
rename from www/docs/src/plugins/rehypePluginKit.ts
rename to docs/src/plugins/rehypePluginKit.ts
index 4a74d0a0b4..9725166895 100644
--- a/www/docs/src/plugins/rehypePluginKit.ts
+++ b/docs/src/plugins/rehypePluginKit.ts
@@ -1,7 +1,7 @@
import rehypeSlug from 'rehype-slug';
-import type { RehypePlugins } from './rehype.types';
-import rehypeAutolinkHeadings from './rehypeAutolink';
-import rehypeExternalLinks from './rehypeExternalLinks';
+import type { RehypePlugins } from './rehype.types.ts';
+import rehypeAutolinkHeadings from './rehypeAutolink.ts';
+import rehypeExternalLinks from './rehypeExternalLinks.ts';
export const rehypePluginKit: RehypePlugins = [
rehypeSlug,
diff --git a/www/docs/src/share-link.ts b/docs/src/share-link.ts
similarity index 100%
rename from www/docs/src/share-link.ts
rename to docs/src/share-link.ts
diff --git a/www/docs/src/starlightOverrides/Head.astro b/docs/src/starlightOverrides/Head.astro
similarity index 100%
rename from www/docs/src/starlightOverrides/Head.astro
rename to docs/src/starlightOverrides/Head.astro
diff --git a/www/docs/src/starlightOverrides/PageTitle.astro b/docs/src/starlightOverrides/PageTitle.astro
similarity index 100%
rename from www/docs/src/starlightOverrides/PageTitle.astro
rename to docs/src/starlightOverrides/PageTitle.astro
diff --git a/www/docs/src/starlightOverrides/Sidebar.astro b/docs/src/starlightOverrides/Sidebar.astro
similarity index 100%
rename from www/docs/src/starlightOverrides/Sidebar.astro
rename to docs/src/starlightOverrides/Sidebar.astro
diff --git a/www/docs/src/starlightOverrides/SiteTitle.astro b/docs/src/starlightOverrides/SiteTitle.astro
similarity index 100%
rename from www/docs/src/starlightOverrides/SiteTitle.astro
rename to docs/src/starlightOverrides/SiteTitle.astro
diff --git a/www/docs/src/styles/sponsorcolors.css b/docs/src/styles/sponsorcolors.css
similarity index 100%
rename from www/docs/src/styles/sponsorcolors.css
rename to docs/src/styles/sponsorcolors.css
diff --git a/www/docs/src/styles/starlight.css b/docs/src/styles/starlight.css
similarity index 94%
rename from www/docs/src/styles/starlight.css
rename to docs/src/styles/starlight.css
index 2e424e718c..919e3a3cb4 100644
--- a/www/docs/src/styles/starlight.css
+++ b/docs/src/styles/starlight.css
@@ -77,9 +77,11 @@
border-radius: 8px;
}
-code,
+div.expressive-code,
starlight-file-tree {
- border-radius: 4px;
+ border-radius: 8px;
+ overflow: hidden;
+ border: 1px solid var(--ec-brdCol);
}
aside.starlight-aside {
@@ -195,3 +197,10 @@ button[aria-label="Menu"][aria-controls="starlight__sidebar"] {
a {
text-decoration: none;
}
+
+.expressive-code figcaption,
+.expressive-code figcaption::before,
+.expressive-code pre,
+.expressive-code span.title {
+ border: none !important;
+}
diff --git a/www/docs/src/typedocHelpers.ts b/docs/src/typedocHelpers.ts
similarity index 96%
rename from www/docs/src/typedocHelpers.ts
rename to docs/src/typedocHelpers.ts
index db522629bb..b5700471ea 100644
--- a/www/docs/src/typedocHelpers.ts
+++ b/docs/src/typedocHelpers.ts
@@ -2,7 +2,7 @@ import type { StarlightTypeDocOptions } from 'starlight-typedoc';
// Utility function to create TypeDoc related paths
export function getFilePathToPackage(name: string, path: string) {
- return `../../packages/${name}/${path}`;
+ return `../packages/${name}/${path}`;
}
// Utility function to create TypeDoc options for the StudioCMS packages so that each package documentation is the same when generated
diff --git a/www/docs/src/util-server.ts b/docs/src/util-server.ts
similarity index 100%
rename from www/docs/src/util-server.ts
rename to docs/src/util-server.ts
diff --git a/www/docs/src/util/SponsorLink.astro b/docs/src/util/SponsorLink.astro
similarity index 100%
rename from www/docs/src/util/SponsorLink.astro
rename to docs/src/util/SponsorLink.astro
diff --git a/www/docs/src/util/contributors.config.ts b/docs/src/util/contributors.config.ts
similarity index 94%
rename from www/docs/src/util/contributors.config.ts
rename to docs/src/util/contributors.config.ts
index a4d7b04502..0bb3d6702c 100644
--- a/www/docs/src/util/contributors.config.ts
+++ b/docs/src/util/contributors.config.ts
@@ -23,9 +23,10 @@ export const contributorConfig = (Astro: AstroGlobal): ContributorConfig[] => [
paths: [
// OLD Paths
'packages/studioCMS/',
+ 'playgrounds/node/',
// NEW Paths
'README.md',
- 'playgrounds/node/',
+ 'playground/',
'packages/studiocms/',
'packages/studiocms_assets/',
'packages/studiocms_auth/',
@@ -48,6 +49,10 @@ export const contributorConfig = (Astro: AstroGlobal): ContributorConfig[] => [
type: 'byPath',
paths: ['packages/studiocms_ui/', 'playgrounds/ui/'],
},
+ {
+ repo: 'withstudiocms/ui',
+ type: 'all',
+ },
],
},
{
@@ -81,7 +86,7 @@ export const contributorConfig = (Astro: AstroGlobal): ContributorConfig[] => [
{
repo: 'withstudiocms/studiocms',
type: 'byPath',
- paths: ['www/docs/'],
+ paths: ['www/docs/', 'docs/'],
},
],
},
diff --git a/www/docs/src/util/getContributors.ts b/docs/src/util/getContributors.ts
similarity index 98%
rename from www/docs/src/util/getContributors.ts
rename to docs/src/util/getContributors.ts
index 79c8597ef8..37eeaa3965 100644
--- a/www/docs/src/util/getContributors.ts
+++ b/docs/src/util/getContributors.ts
@@ -1,6 +1,6 @@
import type { AstroGlobal } from 'astro';
-import { cachedFetch } from '../util-server';
-import { StudioCMSServiceAccounts, contributorConfig } from './contributors.config';
+import { cachedFetch } from '../util-server.ts';
+import { StudioCMSServiceAccounts, contributorConfig } from './contributors.config.ts';
export interface Contributor {
login: string;
diff --git a/www/docs/starlight-types.ts b/docs/starlight-types.ts
similarity index 100%
rename from www/docs/starlight-types.ts
rename to docs/starlight-types.ts
diff --git a/www/docs/starlight-virtual.d.ts b/docs/starlight-virtual.d.ts
similarity index 100%
rename from www/docs/starlight-virtual.d.ts
rename to docs/starlight-virtual.d.ts
diff --git a/www/docs/tsconfig.json b/docs/tsconfig.json
similarity index 65%
rename from www/docs/tsconfig.json
rename to docs/tsconfig.json
index 754f6f39c8..462e11b6de 100644
--- a/www/docs/tsconfig.json
+++ b/docs/tsconfig.json
@@ -1,13 +1,12 @@
{
"extends": "astro/tsconfigs/strict",
+ "include": [".astro/types.d.ts", "**/*"],
"exclude": ["dist"],
"compilerOptions": {
"allowJs": true,
- "moduleResolution": "bundler",
"baseUrl": ".",
"paths": {
"~/*": ["src/*"]
- },
- "outDir": "../../.moon/cache/types/www/docs"
+ }
}
}
diff --git a/www/docs/typedoc.config.ts b/docs/typedoc.config.ts
similarity index 94%
rename from www/docs/typedoc.config.ts
rename to docs/typedoc.config.ts
index 6f4637a496..773bdd1900 100644
--- a/www/docs/typedoc.config.ts
+++ b/docs/typedoc.config.ts
@@ -1,7 +1,7 @@
import type { StarlightPlugin } from '@astrojs/starlight/types';
import { createStarlightTypeDocPlugin } from 'starlight-typedoc';
-import { getFilePathToPackage, makeTypedocOpts } from './src/typedocHelpers';
-import type { SidebarGroup } from './starlight-types';
+import { getFilePathToPackage, makeTypedocOpts } from './src/typedocHelpers.ts';
+import type { SidebarGroup } from './starlight-types.ts';
// Create Starlight TypeDoc Plugins for different parts of the Astro StudioCMS Project
@@ -39,11 +39,7 @@ const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[
name: 'studiocms',
output: 'studiocms',
dir: 'studiocms',
- entryPoints: [
- getFilePathToPackage('studiocms', 'src/index.ts'),
- getFilePathToPackage('studiocms', 'src/integration.ts'),
- getFilePathToPackage('studiocms', 'src/updateCheck.ts'),
- ],
+ entryPoints: [getFilePathToPackage('studiocms', 'src/index.ts')],
})
),
tdAuth(
@@ -95,9 +91,9 @@ const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[
getFilePathToPackage('studiocms_core', 'src/schemas/config/index.ts'),
getFilePathToPackage('studiocms_core', 'src/schemas/config/integrations.ts'),
getFilePathToPackage('studiocms_core', 'src/schemas/config/markdoc.ts'),
- getFilePathToPackage('studiocms_core', 'src/schemas/config/marked.ts'),
getFilePathToPackage('studiocms_core', 'src/schemas/config/rendererConfig.ts'),
- getFilePathToPackage('studiocms_core', 'src/schemas/config/unocss.ts'),
+ getFilePathToPackage('studiocms_core', 'src/schemas/plugins/shared.ts'),
+ getFilePathToPackage('studiocms_core', 'src/schemas/plugins/index.ts'),
getFilePathToPackage('studiocms_core', 'src/lib/index.ts'),
getFilePathToPackage('studiocms_core', 'src/lib/configManager.ts'),
getFilePathToPackage('studiocms_core', 'src/lib/convertDashboardLinksType.ts'),
@@ -116,6 +112,7 @@ const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[
getFilePathToPackage('studiocms_core', 'src/db/tables.ts'),
getFilePathToPackage('studiocms_core', 'src/db/tsTables.ts'),
getFilePathToPackage('studiocms_core', 'src/components/index.ts'),
+ getFilePathToPackage('studiocms_core', 'src/i18n/index.ts'),
],
})
),
@@ -145,6 +142,7 @@ const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[
entryPoints: [
getFilePathToPackage('studiocms_frontend', 'src/index.ts'),
getFilePathToPackage('studiocms_frontend', 'src/integration.ts'),
+ getFilePathToPackage('studiocms_frontend', 'src/schema.ts'),
getFilePathToPackage('studiocms_frontend', 'src/components/index.ts'),
],
})
@@ -160,7 +158,7 @@ const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[
getFilePathToPackage('studiocms_imagehandler', 'src/integration.ts'),
getFilePathToPackage('studiocms_imagehandler', 'src/components/index.ts'),
getFilePathToPackage('studiocms_imagehandler', 'src/components/props.ts'),
- getFilePathToPackage('studiocms_imagehandler', 'src/plugins/cloudinary.ts'),
+ getFilePathToPackage('studiocms_imagehandler', 'src/components/plugins/cloudinary.ts'),
],
})
),
@@ -183,7 +181,6 @@ const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[
getFilePathToPackage('studiocms_renderers', 'src/lib/markdoc/index.ts'),
getFilePathToPackage('studiocms_renderers', 'src/lib/markdoc/markdocHTML.ts'),
getFilePathToPackage('studiocms_renderers', 'src/lib/markdoc/markdocReactStatic.ts'),
- getFilePathToPackage('studiocms_renderers', 'src/lib/marked/index.ts'),
getFilePathToPackage('studiocms_renderers', 'src/lib/mdx/index.ts'),
],
})
@@ -209,15 +206,16 @@ const TypeDocPlugins = (isProd: boolean, testingMode: boolean): StarlightPlugin[
entryPoints: [
getFilePathToPackage('studiocms_devapps', 'src/index.ts'),
getFilePathToPackage('studiocms_devapps', 'src/integration.ts'),
+ getFilePathToPackage('studiocms_devapps', 'src/apps/libsqlViewer.ts'),
+ getFilePathToPackage('studiocms_devapps', 'src/apps/wp-importer.ts'),
+ getFilePathToPackage('studiocms_devapps', 'src/apps/utils/index.ts'),
+ getFilePathToPackage('studiocms_devapps', 'src/schema/index.ts'),
+ getFilePathToPackage('studiocms_devapps', 'src/schema/appsConfig.ts'),
+ getFilePathToPackage('studiocms_devapps', 'src/schema/wp-api/index.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/pathGenerator.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/utils.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/converters.ts'),
getFilePathToPackage('studiocms_devapps', 'src/utils/wp-api/index.ts'),
- getFilePathToPackage('studiocms_devapps', 'src/schema/index.ts'),
- getFilePathToPackage('studiocms_devapps', 'src/schema/appsConfig.ts'),
- getFilePathToPackage('studiocms_devapps', 'src/schema/wp-api/index.ts'),
- getFilePathToPackage('studiocms_devapps', 'src/apps/libsqlViewer.ts'),
- getFilePathToPackage('studiocms_devapps', 'src/apps/wp-importer.ts'),
],
})
),
diff --git a/package.json b/package.json
index 4168a3453e..24b4d7310a 100644
--- a/package.json
+++ b/package.json
@@ -6,26 +6,27 @@
"node": "20.14.0"
},
"scripts": {
- "moon": "moon",
- "changeset": "changeset",
+ "build": "pnpm build:studiocms && pnpm --filter node-playground build",
+ "build:docs": "pnpm --filter docs build",
+ "docs:dev": "pnpm build:studiocms && pnpm --filter docs dev",
"playground:dev": "pnpm --filter node-playground dev",
- "playground:login": "pnpm --filter node-playground db:login",
- "playground:link": "pnpm --filter node-playground db:link",
"playground:push": "pnpm --filter node-playground db:push",
- "ui:dev": "pnpm --filter ui-playground dev",
- "ui:build": "pnpm --filter ui-playground build",
- "ui:preview": "pnpm --filter ui-playground preview",
- "build": "pnpm --filter node-playground build",
+
+ "build:studiocms": "pnpm --filter studiocms --filter @studiocms/* build",
+ "dev:studiocms": "pnpm --stream --filter studiocms --filter @studiocms/* -r -parallel dev",
+ "dev": "pnpm --stream --filter studiocms --filter @studiocms/* --filter node-playground -r -parallel dev",
+
+ "build:cli": "pnpm --filter studiocms build",
+ "cli:test": "pnpm studiocms",
+
+ "changeset": "changeset",
"lint": "biome check .",
"lint:fix": "biome check --write .",
- "build:web": "pnpm --filter web build",
- "build:docs": "pnpm --filter docs build",
- "update:web": "pnpm --filter web up --latest",
- "update:docs": "pnpm --filter docs up --latest",
- "web:dev": "pnpm --filter web dev",
- "docs:dev": "pnpm --filter docs dev",
- "lunaria:build": "pnpm --filter docs lunaria:build",
- "translations:changeset": "tsm --require=./scripts/filter-warnings.cjs ./scripts/translation-changeset.ts",
+
+ "ci:prepublish": "pnpm build:studiocms",
+ "ci:lunaria:build": "pnpm --filter docs lunaria:build",
+ "ci:lunaria:report": "pnpm tsm --require=./scripts/filter-warnings.cjs ./www/docs/scripts/lunaria-report-bot.ts",
+ "ci:translations:changeset": "tsm --require=./scripts/filter-warnings.cjs ./scripts/translation-changeset.ts",
"ci:lint": "biome ci --formatter-enabled=true --organize-imports-enabled=true --reporter=github",
"ci:install": "pnpm install --frozen-lockfile",
"ci:version": "pnpm changeset version",
@@ -35,11 +36,12 @@
"devDependencies": {
"@actions/core": "^1.11.1",
"@biomejs/biome": "1.9.4",
- "@moonrepo/cli": "1.28.3",
"@changesets/cli": "2.27.9",
"@changesets/config": "3.0.3",
"@changesets/changelog-github": "0.5.0",
"@changesets/write": "0.3.2",
+ "build-scripts": "workspace:*",
+ "studiocms": "workspace:*",
"execa": "9.5.1",
"pkg-pr-new": "0.0.32",
"typescript": "catalog:",
diff --git a/packages/studiocms/.gitignore b/packages/studiocms/.gitignore
index 4e02004cb0..8f18003eca 100644
--- a/packages/studiocms/.gitignore
+++ b/packages/studiocms/.gitignore
@@ -18,4 +18,6 @@ pnpm-debug.log*
# macOS-specific files
.DS_Store
-.npmrc
\ No newline at end of file
+.npmrc
+
+dist/
\ No newline at end of file
diff --git a/packages/studiocms/LICENSE b/packages/studiocms/LICENSE
index a30d1fbe47..94787104c4 100644
--- a/packages/studiocms/LICENSE
+++ b/packages/studiocms/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2024 Astrolicious - StudioCMS - Adam Matthiesen, Jacob Jenkins, Paul Valladares
+Copyright (c) 2024 StudioCMS - Adam Matthiesen, Jacob Jenkins, Paul Valladares
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/packages/studiocms/README.md b/packages/studiocms/README.md
index 0cf5b48f60..16e85c4358 100644
--- a/packages/studiocms/README.md
+++ b/packages/studiocms/README.md
@@ -2,9 +2,12 @@
As part of our efforts, we're excited to introduce StudioCMS - a dedicated content management system (CMS) built on top of Astro's latest feature, [Astro DB](https://docs.astro.build/en/guides/astro-db/). This project was developed by [Adam](https://github.com/Adammatthiesen), [Dreyfus](https://github.com/dreyfus92), and [Jumper](https://github.com/jdtjenkins), three passionate members of the Astro community.
+> [!IMPORTANT]
+> This project is still in early development and it is not yet ready for production use. If you encounter any issues or have ideas for new features, please let us know by [opening an issue](https://github.com/withstudiocms/studiocms/issues/new/choose) on our GitHub repository.
+
## Sponsor
-
+
## Why another CMS?
@@ -25,17 +28,17 @@ StudioCMS is built from the ground up to seamlessly integrate with Astro's robus
## Key Features
-**Astro Foundation:** StudioCMS leverages Astro's robust and efficient framework, providing a solid base for building and scaling applications.
+**Built on Astro:** StudioCMS leverages Astro's robust and efficient framework, providing a solid base for building and scaling applications.
-**Enhanced Markdown:** We've incorporated 'Marked' with support for extensions, enriching the markdown experience with greater flexibility and functionality.
+**Support for Markdown:** Incorporates Astro's Markdown processing, enriching the markdown experience with greater flexibility and functionality.
-**Shiki Syntax Highlighting:** StudioCMS offers Shiki-powered syntax highlighting, ensuring your code is both visually appealing and easy to read. This is especially useful in non-Cloudflare environments due to bundle size considerations.
+**Markdoc Integration:** Provides an alternative to Astro's Markdown with Markdoc, offering users a choice for their markdown processing needs.
-**Markdoc Integration:** In addition to 'Marked', StudioCMS provides an alternative with Markdoc, offering users a choice for their markdown processing needs.
+**Secure libSQL Database:** All data is securely housed within your libSQL database, ensuring accessibility to your data to only authorized users to your libSQL provider or Self-hosted server.
-**Built-in Authentication:** StudioCMS features built-in authentication with support for multiple platforms, including Local and Github, enhancing security and user management (currently in development).
+**Built-in Authentication:** Features built-in authentication with support for multiple platforms including Local and Github, enhancing security and user management.
-**Unpic Image Service:** StudioCMS includes a free and efficient image service, Unpic, which makes managing external URLs straightforward, with support for major CDNs.
+**Web Vitals:**Integration with '@astrojs/web-vitals' for monitoring and providing insights into web performance metrics, ensuring optimal user experiences.
## A Community-Driven Effort
diff --git a/packages/studiocms/dev.d.ts b/packages/studiocms/dev.d.ts
new file mode 100644
index 0000000000..ea19848c7c
--- /dev/null
+++ b/packages/studiocms/dev.d.ts
@@ -0,0 +1,2 @@
+/// Hello Example
\ No newline at end of file
diff --git a/packages/studiocms/src/index.ts b/packages/studiocms/src/index.ts
index c5a1f7079d..dfa0be54f0 100644
--- a/packages/studiocms/src/index.ts
+++ b/packages/studiocms/src/index.ts
@@ -1,27 +1,368 @@
-import { defineStudioCMSConfig, defineStudioCMSPlugin } from '@studiocms/core/lib';
-import type { CustomRenderer, Renderer, StudioCMSOptions } from '@studiocms/core/schemas';
-import type { StudioCMSPluginOptions } from '@studiocms/core/types';
-import integration from './integration';
+import inlineMod from '@inox-tools/aik-mod';
+import astroDTSBuilder from '@matthiesenxyz/astrodtsbuilder';
+import auth from '@studiocms/auth';
+import core from '@studiocms/core';
+import { StudioCMSError } from '@studiocms/core/errors';
+import type {
+ SafePluginListType,
+ StudioCMSConfig,
+ StudioCMSOptions,
+} from '@studiocms/core/schemas';
+import dashboard from '@studiocms/dashboard';
+import frontend from '@studiocms/frontend';
+import imageHandler from '@studiocms/imagehandler';
+import renderers from '@studiocms/renderers';
+import robotsTXT from '@studiocms/robotstxt';
+import ui from '@studiocms/ui';
+import {
+ addVirtualImports,
+ createResolver,
+ defineIntegration,
+ withPlugins,
+} from 'astro-integration-kit';
+import { z } from 'astro/zod';
+import boxen from 'boxen';
+import packageJson from 'package-json';
+import { compare as semCompare } from 'semver';
+import type { Messages } from './types.js';
+import { addIntegrationArray } from './utils/addIntegrationArray.js';
+import { checkAstroConfig } from './utils/astroConfigCheck.js';
+import { changelogHelper } from './utils/changelog.js';
+import { watchStudioCMSConfig } from './utils/configManager.js';
+import { configResolver } from './utils/configResolver.js';
+import { integrationLogger } from './utils/integrationLogger.js';
+import { nodeNamespaceBuiltinsAstro } from './utils/integrations.js';
+import readJson from './utils/readJson.js';
+
+const { name: pkgName, version: pkgVersion } = readJson<{ name: string; version: string }>(
+ new URL('../package.json', import.meta.url)
+);
/**
* **StudioCMS Integration**
*
* A CMS built for Astro by the Astro Community for the Astro Community.
*
- * > **Note: Astro SSR adapters that are configured for Image Optimization will automatically take full control of the Image Optimization Service. Making the `imageService` option in this integration not have any effect.**
- *
- * @see [GitHub Repo: 'astrolicious/studiocms'](https://github.com/astrolicious/studiocms) for more information on how to contribute to StudioCMS.
- * @see [StudioCMS Docs](https://docs.studiocms.xyz) for more information on how to use StudioCMS.
+ * @see The [GitHub Repo: `withstudiocms/studiocms`](https://github.com/withstudiocms/studiocms) for more information on how to contribute to StudioCMS.
+ * @see The [StudioCMS Docs](https://docs.studiocms.dev) for more information on how to use StudioCMS.
*
*/
-export const studioCMS = integration;
+export default defineIntegration({
+ name: pkgName,
+ optionsSchema: z.custom
+
+
+
\ No newline at end of file
diff --git a/packages/studiocms_auth/assets/layouts/ThemeManager.astro b/packages/studiocms_auth/assets/layouts/ThemeManager.astro
new file mode 100644
index 0000000000..c69f615071
--- /dev/null
+++ b/packages/studiocms_auth/assets/layouts/ThemeManager.astro
@@ -0,0 +1,53 @@
+
+
+
\ No newline at end of file
diff --git a/packages/studiocms_auth/assets/layouts/ThreeCanvasLoader.astro b/packages/studiocms_auth/assets/layouts/ThreeCanvasLoader.astro
new file mode 100644
index 0000000000..4ef318170b
--- /dev/null
+++ b/packages/studiocms_auth/assets/layouts/ThreeCanvasLoader.astro
@@ -0,0 +1,18 @@
+---
+import studioCMS_SDK_Cache from 'studiocms:sdk/cache';
+
+// Get the site config
+const {
+ data: { loginPageBackground, loginPageCustomImage },
+} = await studioCMS_SDK_Cache.GET.siteConfig();
+---
+
+
+
\ No newline at end of file
diff --git a/packages/studiocms_auth/src/layouts/authlayout.css b/packages/studiocms_auth/assets/layouts/authlayout.css
similarity index 100%
rename from packages/studiocms_auth/src/layouts/authlayout.css
rename to packages/studiocms_auth/assets/layouts/authlayout.css
diff --git a/packages/studiocms_auth/src/loginBackgrounds/studiocms-blobs-dark.png b/packages/studiocms_auth/assets/loginBackgrounds/studiocms-blobs-dark.png
similarity index 100%
rename from packages/studiocms_auth/src/loginBackgrounds/studiocms-blobs-dark.png
rename to packages/studiocms_auth/assets/loginBackgrounds/studiocms-blobs-dark.png
diff --git a/packages/studiocms_auth/src/loginBackgrounds/studiocms-blobs-light.png b/packages/studiocms_auth/assets/loginBackgrounds/studiocms-blobs-light.png
similarity index 100%
rename from packages/studiocms_auth/src/loginBackgrounds/studiocms-blobs-light.png
rename to packages/studiocms_auth/assets/loginBackgrounds/studiocms-blobs-light.png
diff --git a/packages/studiocms_auth/src/loginBackgrounds/studiocms-blocks-dark.png b/packages/studiocms_auth/assets/loginBackgrounds/studiocms-blocks-dark.png
similarity index 100%
rename from packages/studiocms_auth/src/loginBackgrounds/studiocms-blocks-dark.png
rename to packages/studiocms_auth/assets/loginBackgrounds/studiocms-blocks-dark.png
diff --git a/packages/studiocms_auth/src/loginBackgrounds/studiocms-blocks-light.png b/packages/studiocms_auth/assets/loginBackgrounds/studiocms-blocks-light.png
similarity index 100%
rename from packages/studiocms_auth/src/loginBackgrounds/studiocms-blocks-light.png
rename to packages/studiocms_auth/assets/loginBackgrounds/studiocms-blocks-light.png
diff --git a/packages/studiocms_auth/src/loginBackgrounds/studiocms-curves-dark.png b/packages/studiocms_auth/assets/loginBackgrounds/studiocms-curves-dark.png
similarity index 100%
rename from packages/studiocms_auth/src/loginBackgrounds/studiocms-curves-dark.png
rename to packages/studiocms_auth/assets/loginBackgrounds/studiocms-curves-dark.png
diff --git a/packages/studiocms_auth/src/loginBackgrounds/studiocms-curves-light.png b/packages/studiocms_auth/assets/loginBackgrounds/studiocms-curves-light.png
similarity index 100%
rename from packages/studiocms_auth/src/loginBackgrounds/studiocms-curves-light.png
rename to packages/studiocms_auth/assets/loginBackgrounds/studiocms-curves-light.png
diff --git a/packages/studiocms_auth/src/resources/studiocms-logo.glb b/packages/studiocms_auth/assets/public/studiocms-logo.glb
similarity index 100%
rename from packages/studiocms_auth/src/resources/studiocms-logo.glb
rename to packages/studiocms_auth/assets/public/studiocms-logo.glb
diff --git a/packages/studiocms_auth/src/routes/api/auth0/callback.ts b/packages/studiocms_auth/assets/routes/api/auth0/callback.ts
similarity index 74%
rename from packages/studiocms_auth/src/routes/api/auth0/callback.ts
rename to packages/studiocms_auth/assets/routes/api/auth0/callback.ts
index dd8e3d935c..6deaf1d278 100644
--- a/packages/studiocms_auth/src/routes/api/auth0/callback.ts
+++ b/packages/studiocms_auth/assets/routes/api/auth0/callback.ts
@@ -1,18 +1,13 @@
+// @ts-nocheck
import { logger } from '@it-astro:logger:studiocms-auth';
-import { and, db, eq } from 'astro:db';
import { createUserSession } from 'studiocms:auth/lib/session';
import { LinkNewOAuthCookieName, createOAuthUser, getUserData } from 'studiocms:auth/lib/user';
-import { StudioCMSRoutes } from 'studiocms:helpers/routemap';
-import { tsOAuthAccounts, tsUsers } from '@studiocms/core/db/tsTables';
+import { StudioCMSRoutes } from 'studiocms:lib';
+import studioCMS_SDK from 'studiocms:sdk';
import { OAuth2RequestError, type OAuth2Tokens } from 'arctic';
import type { APIContext, APIRoute } from 'astro';
import { type Auth0User, ProviderCookieName, ProviderID, auth0, getClientDomain } from './shared';
-const {
- authLinks: { loginURL },
- mainLinks: { dashboardIndex },
-} = StudioCMSRoutes;
-
export const GET: APIRoute = async (context: APIContext): Promise{t('header')}
@@ -55,26 +44,24 @@ if (usernameAndPassword && SHOW_OAUTH) {{t('allow-registration-noaccount')} {t('allow-registration-register')}
+{t('allow-registration-noaccount')} {t('allow-registration-register')}
)} -
+
+
+ { usernameAndPassword && (
+
+ )}
+
+ { allowUserRegistration && (
+ {t('header')}
+{paragraph}
+{t('allow-login-haveaccount')} {t('allow-login-login')}
+ )} + +
-
-
-
-
-
-
-
-
-
- { usernameAndPassword && (
-
- )}
-
- { allowUserRegistration && (
- {t('header')}
-{paragraph}
-{t('allow-login-haveaccount')} {t('allow-login-login')}
- )} - -
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/studiocms_betaresources/src/index.ts b/packages/studiocms_betaresources/src/index.ts
index 844273d02b..e69de29bb2 100644
--- a/packages/studiocms_betaresources/src/index.ts
+++ b/packages/studiocms_betaresources/src/index.ts
@@ -1 +0,0 @@
-export { default as BetaFeedback } from './BetaFeedback.astro';
diff --git a/packages/studiocms_betaresources/tsconfig.json b/packages/studiocms_betaresources/tsconfig.json
index 54435a1f14..d175d082a9 100644
--- a/packages/studiocms_betaresources/tsconfig.json
+++ b/packages/studiocms_betaresources/tsconfig.json
@@ -2,37 +2,10 @@
"extends": "astro/tsconfigs/strictest",
"files": [],
"compilerOptions": {
- "outDir": "../../.moon/cache/types/packages/studiocms_betaresources",
"composite": true,
"noEmit": false,
"allowImportingTsExtensions": false,
- "emitDeclarationOnly": false,
- "paths": {
- "node-playground/*": ["../../playgrounds/node/src/*"],
- "@studiocms/assets": ["../studiocms_assets/src/index.ts"],
- "@studiocms/assets/*": ["../studiocms_assets/src/*"],
- "@studiocms/core": ["../studiocms_core/src/index.ts"],
- "@studiocms/core/*": ["../studiocms_core/src/*"]
- }
+ "emitDeclarationOnly": false
},
- "references": [
- {
- "path": "../../playgrounds/node"
- },
- {
- "path": "../studiocms_assets"
- },
- {
- "path": "../studiocms_core"
- }
- ],
- "include": [
- "./package.json",
- "../../playgrounds/node/**/*",
- "../../playgrounds/node/.astro/**/*",
- "../studiocms_assets/**/*",
- "../studiocms_core/**/*",
- "./**/*",
- "./src/**/*.json"
- ]
+ "include": ["./package.json", "./**/*", "./src/**/*.json"]
}
diff --git a/packages/studiocms_blog/LICENSE b/packages/studiocms_blog/LICENSE
index a30d1fbe47..94787104c4 100644
--- a/packages/studiocms_blog/LICENSE
+++ b/packages/studiocms_blog/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2024 Astrolicious - StudioCMS - Adam Matthiesen, Jacob Jenkins, Paul Valladares
+Copyright (c) 2024 StudioCMS - Adam Matthiesen, Jacob Jenkins, Paul Valladares
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/packages/studiocms_blog/index.ts b/packages/studiocms_blog/index.ts
index 8d474fab20..e31e0ced0a 100644
--- a/packages/studiocms_blog/index.ts
+++ b/packages/studiocms_blog/index.ts
@@ -1,5 +1,5 @@
-import { defineStudioCMSPlugin } from '@studiocms/core/lib';
import defineTheme from 'astro-theme-provider';
+import { definePlugin } from 'studiocms';
import { name } from './package.json';
import { studioCMSBlogSchema as schema } from './schema';
@@ -19,50 +19,19 @@ export type ATP_ThemeOptions = Parameters
-
+
-
{
links.map(({ text, href }) => (
- {text}
+ {text}
))
}
@@ -89,26 +95,26 @@ for (const link of externalLinks) {
-
+
-
{
links.slice(0, topLevelLinkCount).map(({ text, href }) => (
- {text}
+ {text}
))
}
diff --git a/packages/studiocms_core/src/components/avatar.webp b/packages/studiocms_core/assets/components/avatar.webp
similarity index 100%
rename from packages/studiocms_core/src/components/avatar.webp
rename to packages/studiocms_core/assets/components/avatar.webp
diff --git a/packages/studiocms_core/src/components/index.ts b/packages/studiocms_core/assets/components/index.ts
similarity index 80%
rename from packages/studiocms_core/src/components/index.ts
rename to packages/studiocms_core/assets/components/index.ts
index 62fe2a238f..1cc0ef8f3d 100644
--- a/packages/studiocms_core/src/components/index.ts
+++ b/packages/studiocms_core/assets/components/index.ts
@@ -2,3 +2,4 @@ export { default as Avatar } from './Avatar.astro';
export { default as FormattedDate } from './FormattedDate.astro';
export { default as GenericHeader } from './GenericHeader.astro';
export { default as Navigation } from './Navigation.astro';
+export { default as Generator } from './Generator.astro';
diff --git a/packages/studiocms_core/src/components/navigation.css b/packages/studiocms_core/assets/components/navigation.css
similarity index 89%
rename from packages/studiocms_core/src/components/navigation.css
rename to packages/studiocms_core/assets/components/navigation.css
index 72e95f3918..9e3aece8d6 100644
--- a/packages/studiocms_core/src/components/navigation.css
+++ b/packages/studiocms_core/assets/components/navigation.css
@@ -21,12 +21,12 @@
font-weight: bold;
}
-.navigation .mininav {
+.navigation .mini-nav {
display: hidden;
visibility: hidden;
}
-.navigation .mininav button {
+.navigation .mini-nav button {
background-color: hsl(0, 0%, 95%);
color: back;
font-size: larger;
@@ -38,14 +38,14 @@
visibility: hidden;
}
-.navigation .mininav a {
+.navigation .mini-nav a {
display: block;
padding: 10px 15px;
text-decoration: none;
color: black;
}
-.navigation .mininav-content {
+.navigation .mini-nav-content {
display: none;
position: absolute;
background-color: hsl(0, 0%, 90%);
@@ -53,20 +53,20 @@
box-shadow: 2px 2px 5px hsla(0, 0%, 0%, 0.8);
}
-.navigation .mininav:hover .mininav-content {
+.navigation .mini-nav:hover .mini-nav-content {
display: block;
}
-.navigation .mininav:hover button {
+.navigation .mini-nav:hover button {
background-color: hsl(0, 0%, 80%);
}
@media (max-width: 720px) {
- .navigation .mininav {
+ .navigation .mini-nav {
display: inline-block;
visibility: visible;
}
- .navigation .mininav button {
+ .navigation .mini-nav button {
display: inline-block;
visibility: visible;
}
@@ -99,11 +99,11 @@
position: relative;
justify-self: center;
}
- .navigation .mininav {
+ .navigation .mini-nav {
display: flex;
position: relative;
}
- .navigation .mininav button {
+ .navigation .mini-nav button {
display: flex;
position: relative;
}
diff --git a/packages/studiocms_core/src/i18n/LanguageSelector.astro b/packages/studiocms_core/assets/i18n/LanguageSelector.astro
similarity index 100%
rename from packages/studiocms_core/src/i18n/LanguageSelector.astro
rename to packages/studiocms_core/assets/i18n/LanguageSelector.astro
diff --git a/packages/studiocms_core/src/i18n/index.ts b/packages/studiocms_core/assets/i18n/index.ts
similarity index 80%
rename from packages/studiocms_core/src/i18n/index.ts
rename to packages/studiocms_core/assets/i18n/index.ts
index 51f73a3d11..19090a7ba2 100644
--- a/packages/studiocms_core/src/i18n/index.ts
+++ b/packages/studiocms_core/assets/i18n/index.ts
@@ -2,6 +2,14 @@ import type { AstroGlobal } from 'astro';
export { default as LanguageSelector } from './LanguageSelector.astro';
+// Note: Translations are not currently used in StudioCMS, so we
+// will only allow 'en-us' to be used for now on the Dashboard.
+
+// If you still want to help translate our library while we
+// prepare to implement i18n, feel free to add the new translations on
+// https://i18n.studiocms.dev/ or PR them into the `translations` folder:
+// `packages/studiocms_core/src/i18n/translations/` on https://github.com/withstudiocms/studiocms
+
// --- i18n Config --- //
// Translations
@@ -9,53 +17,64 @@ const uiTranslations = {
'en-us': await import('./translations/en-us.json'),
} as const;
+// Default language - Must match one of the keys in the `ui` object above
+const defaultLang: UiLanguageKeys = 'en-us';
+
+// Show the default language in the URL (e.g. /en/page) or hide it (e.g. /page)
+// This is false in Astro-feedback so there is no need for a language prefix and page redirect on the main route.
+const showDefaultLang: boolean = false;
+
+// --- i18n Utils --- //
+
/**
* Represents the type of UI translations.
* This type is derived from the structure of the `uiTranslations` object.
*/
-type UiTranslations = typeof uiTranslations;
+export type UiTranslations = typeof uiTranslations;
/**
* Represents the keys of the UiTranslations type.
* This type is used to define the possible keys for UI language translations.
*/
-type UiLanguageKeys = keyof UiTranslations;
+export type UiLanguageKeys = keyof UiTranslations;
/**
* Represents the keys of the UI component translations for the 'en-us' locale.
* This type is derived from the 'translations' property of the 'UiTranslations' interface
* for the 'en-us' locale (Source of truth), ensuring that only valid translation keys are used.
*/
-type UiComponentKeys = keyof UiTranslations['en-us']['translations'];
+export type UiComponentKeys = keyof UiTranslations['en-us']['translations'];
-// Default language - Must match one of the keys in the `ui` object above
-const defaultLang: UiLanguageKeys = 'en-us';
+// God please forgive me for what I am about to do
+type UiTranslationComponent<
+ L extends UiLanguageKeys,
+ T extends UiComponentKeys,
+> = (typeof uiTranslations)[L]['translations'][T];
-// Show the default language in the URL (e.g. /en/page) or hide it (e.g. /page)
-// This is false in Astro-feedback so there is no need for a language prefix and page redirect on the main route.
-const showDefaultLang: boolean = false;
-
-// --- i18n Utils --- //
+type UiTranslationKey<
+ L extends UiLanguageKeys,
+ T extends UiComponentKeys,
+> = keyof UiTranslationComponent;
/**
* Retrieves a translation function for a given language and component.
*
* @param lang - The language key to use for translations.
- * @param comp - The component key to use for translations.
+ * @param component - The component key to use for translations.
* @returns A function that takes a translation key and returns the corresponding translated string.
*/
-export function useTranslations(
- lang: UiLanguageKeys,
- comp: UiComponentKeys
-): (key: string) => string {
- return function t(key: string): string {
- // @ts-expect-error - Component key is dynamic depending on the component
- const translation = uiTranslations[lang].translations[comp][key];
+export function useTranslations(
+ lang: L,
+ component: T
+) {
+ return function t(
+ key: UiTranslationKey
+ ): UiTranslationComponent[UiTranslationKey] {
+ const translation = uiTranslations[lang].translations[component][key];
// If the translation is not found, return the default language translation
if (translation === undefined || translation === '') {
- // @ts-expect-error - Component key is dynamic depending on the component
- return uiTranslations[defaultLang].translations[comp][key];
+ return uiTranslations[defaultLang].translations[component][key];
}
return translation;
diff --git a/packages/studiocms_core/src/i18n/translations/de.json b/packages/studiocms_core/assets/i18n/translations/de.json
similarity index 100%
rename from packages/studiocms_core/src/i18n/translations/de.json
rename to packages/studiocms_core/assets/i18n/translations/de.json
diff --git a/packages/studiocms_core/src/i18n/translations/en-us.json b/packages/studiocms_core/assets/i18n/translations/en-us.json
similarity index 66%
rename from packages/studiocms_core/src/i18n/translations/en-us.json
rename to packages/studiocms_core/assets/i18n/translations/en-us.json
index 9c67c59bd8..c6347ad965 100644
--- a/packages/studiocms_core/src/i18n/translations/en-us.json
+++ b/packages/studiocms_core/assets/i18n/translations/en-us.json
@@ -38,6 +38,26 @@
},
"@studiocms/auth:oauth-stack": {
"or-login-with": "or log in using"
+ },
+ "@studiocms/dashboard:index": {
+ "title": "Dashboard",
+ "welcome-title": "Welcome",
+ "title-button:discord": "Join the Community",
+ "title-button:feedback": "Give Feedback",
+ "sub-header": "StudioCMS is a free and open-source content management system built from the ground up by the Astro community."
+ },
+ "@studiocms/dashboard:sidebar": {
+ "category-1-header": "Dashboard",
+ "dashboard-link-label": "Dashboard",
+ "content-management-label": "Content Management",
+ "category-2-header": "Admin",
+ "site-configuration-label": "Site Configuration",
+ "user-management-label": "User Management",
+ "category-3-header": "Plugins",
+ "category-3-empty-placeholder": "No plugins with settings pages found.",
+ "user-dropdown:settings": "User Settings",
+ "user-dropdown:view-site": "View Site",
+ "user-dropdown:logout": "Log Out"
}
}
}
diff --git a/packages/studiocms_core/assets/public/favicon-dark.png b/packages/studiocms_core/assets/public/favicon-dark.png
new file mode 100644
index 0000000000..1f3d01dd50
Binary files /dev/null and b/packages/studiocms_core/assets/public/favicon-dark.png differ
diff --git a/packages/studiocms_core/assets/public/favicon-light.png b/packages/studiocms_core/assets/public/favicon-light.png
new file mode 100644
index 0000000000..5dcc90d6d9
Binary files /dev/null and b/packages/studiocms_core/assets/public/favicon-light.png differ
diff --git a/packages/studiocms_core/assets/public/favicon.svg b/packages/studiocms_core/assets/public/favicon.svg
new file mode 100644
index 0000000000..00df2d7a93
--- /dev/null
+++ b/packages/studiocms_core/assets/public/favicon.svg
@@ -0,0 +1,15 @@
+
\ No newline at end of file
diff --git a/packages/studiocms_core/env.d.ts b/packages/studiocms_core/env.d.ts
deleted file mode 100644
index 7c8c624f53..0000000000
--- a/packages/studiocms_core/env.d.ts
+++ /dev/null
@@ -1,41 +0,0 @@
-interface ImportMetaEnv {
- readonly PROD: boolean;
- readonly BASE_URL: string;
-}
-
-interface ImportMeta {
- readonly env: ImportMetaEnv;
-}
-
-declare namespace App {
- interface Locals {
- isLoggedIn: boolean;
- dbUser?: {
- id: string;
- url: string | null;
- name: string;
- email: string | null;
- avatar: string | null;
- githubId: number | null;
- githubURL: string | null;
- discordId: string | null;
- googleId: string | null;
- auth0Id: string | null;
- username: string;
- password: string | null;
- updatedAt: Date | null;
- createdAt: Date | null;
- } | null;
- user?: {
- id: string;
- username?: string;
- githubId?: number;
- } | null;
- session?: {
- id: string;
- userId: string;
- fresh: boolean;
- expiresAt: Date;
- } | null;
- }
-}
diff --git a/packages/studiocms_core/moon.yml b/packages/studiocms_core/moon.yml
deleted file mode 100644
index ca5ddcb2b8..0000000000
--- a/packages/studiocms_core/moon.yml
+++ /dev/null
@@ -1,7 +0,0 @@
-language: 'typescript'
-tags: ['astro', 'typescript']
-
-project:
- name: '@studiocms/core'
- description: 'A CMS that bridges Astro with Astro DB & Studio'
- maintainers: ['Adammatthiesen','jdtjenkins','dreyfus92']
\ No newline at end of file
diff --git a/packages/studiocms_core/package.json b/packages/studiocms_core/package.json
index a3b194ad89..9f562f1c56 100644
--- a/packages/studiocms_core/package.json
+++ b/packages/studiocms_core/package.json
@@ -25,47 +25,120 @@
"publishConfig": {
"access": "public"
},
+ "scripts": {
+ "build": "build-scripts build 'src/**/*.ts' --build-tsconfig",
+ "dev": "build-scripts dev 'src/**/*.ts' --build-tsconfig"
+ },
"sideEffects": false,
"files": [
- "src"
+ "src", "assets"
],
"exports": {
- ".": "./src/index.ts",
- "./components": "./src/components/index.ts",
- "./lib": "./src/lib/index.ts",
- "./schemas": "./src/schemas/index.ts",
- "./schemas/renderer": "./src/schemas/config/rendererConfig.ts",
- "./types": "./src/types/index.ts",
- "./utils": "./src/utils/index.ts",
- "./strings": "./src/strings.ts",
- "./consts": "./src/consts.ts",
- "./helpers": "./src/helpers/index.ts",
- "./db/config": "./src/db/config.ts",
- "./db/tables": "./src/db/tables.ts",
- "./db/tsTables": "./src/db/tsTables.ts"
+ ".": {
+ "types": "./dist/index.d.ts",
+ "default": "./dist/index.js"
+ },
+ "./components": "./assets/components/index.ts",
+ "./errors": {
+ "types": "./dist/errors.d.ts",
+ "default": "./dist/errors.js"
+ },
+ "./lib": {
+ "types": "./dist/lib/index.d.ts",
+ "default": "./dist/lib/index.js"
+ },
+ "./schemas": {
+ "types": "./dist/schemas/index.d.ts",
+ "default": "./dist/schemas/index.js"
+ },
+ "./schemas/renderer": {
+ "types": "./dist/schemas/config/rendererConfig.d.ts",
+ "default": "./dist/schemas/config/rendererConfig.js"
+ },
+ "./utils": {
+ "types": "./dist/utils/index.d.ts",
+ "default": "./dist/utils/index.js"
+ },
+ "./consts": {
+ "types": "./dist/consts.d.ts",
+ "default": "./dist/consts.js"
+ },
+ "./db/config": {
+ "types": "./dist/db/config.d.ts",
+ "default": "./dist/db/config.js"
+ },
+ "./db/tables": "./src/db/tables.js",
+ "./sdk-utils": {
+ "types": "./dist/sdk-utils/index.d.ts",
+ "default": "./dist/sdk-utils/index.js"
+ },
+ "./sdk-utils/tables": {
+ "types": "./dist/sdk-utils/tables.d.ts",
+ "default": "./dist/sdk-utils/tables.js"
+ },
+ "./sdk-utils/types": {
+ "types": "./dist/sdk-utils/types/index.d.ts",
+ "default": "./dist/sdk-utils/types/index.js"
+ },
+ "./sdk-utils/utils": {
+ "types": "./dist/sdk-utils/utils.d.ts",
+ "default": "./dist/sdk-utils/utils.js"
+ },
+ "./sdk-utils/auth": {
+ "types": "./dist/sdk-utils/auth.d.ts",
+ "default": "./dist/sdk-utils/auth.js"
+ },
+ "./sdk-utils/delete": {
+ "types": "./dist/sdk-utils/delete.d.ts",
+ "default": "./dist/sdk-utils/delete.js"
+ },
+ "./sdk-utils/get": {
+ "types": "./dist/sdk-utils/get.d.ts",
+ "default": "./dist/sdk-utils/get.js"
+ },
+ "./sdk-utils/post": {
+ "types": "./dist/sdk-utils/post.d.ts",
+ "default": "./dist/sdk-utils/post.js"
+ },
+ "./sdk-utils/update": {
+ "types": "./dist/sdk-utils/update.d.ts",
+ "default": "./dist/sdk-utils/update.js"
+ },
+ "./sdk-utils/init": {
+ "types": "./dist/sdk-utils/init.d.ts",
+ "default": "./dist/sdk-utils/init.js"
+ }
},
"type": "module",
"dependencies": {
+ "@studiocms/ui": "catalog:",
"@studiocms/robotstxt": "workspace:*",
"astro-integration-kit": "catalog:",
"@markdoc/markdoc": "catalog:studiocms-renderer",
- "marked": "catalog:studiocms-renderer",
- "shiki": "catalog:studiocms-renderer",
"mrmime": "catalog:studiocms-core",
"unified": "catalog:studiocms-core",
"remark-rehype": "catalog:studiocms-core",
"mdast-util-to-hast": "catalog:studiocms-core",
+ "rollup-plugin-copy": "catalog:studiocms-shared",
"@matthiesenxyz/astrodtsbuilder": "catalog:studiocms-shared",
- "@matthiesenxyz/integration-utils": "catalog:studiocms-shared",
-
- "@matthiesenxyz/astrolace": "catalog:studiocms-shared"
+ "drizzle-orm": "catalog:studiocms-core",
+ "lodash": "catalog:studiocms-shared",
+ "mdast": "catalog:studiocms-shared",
+ "mdast-util-from-markdown": "catalog:studiocms-shared",
+ "mdast-util-to-markdown": "catalog:studiocms-shared",
+ "mdast-util-to-string": "catalog:studiocms-shared",
+ "unist-util-visit": "catalog:studiocms-shared",
+ "jsonwebtoken": "^9.0.2"
},
"peerDependencies": {
"@astrojs/db": "catalog:min",
- "astro": "catalog:min"
+ "astro": "catalog:min",
+ "vite": "catalog:min"
},
"devDependencies": {
- "vite": "catalog:",
- "typescript": "catalog:"
+ "typescript": "catalog:",
+ "@types/lodash": "catalog:studiocms-shared",
+ "@types/mdast": "catalog:studiocms-shared",
+ "@types/jsonwebtoken": "^9.0.8"
}
}
diff --git a/packages/studiocms_core/src/components/Avatar.astro b/packages/studiocms_core/src/components/Avatar.astro
deleted file mode 100644
index 3f5e022758..0000000000
--- a/packages/studiocms_core/src/components/Avatar.astro
+++ /dev/null
@@ -1,46 +0,0 @@
----
-import { StudioCMSRoutes } from 'studiocms:helpers/routemap';
-// import Config from 'virtual:studiocms/config';
-import profileImg from './avatar.webp';
-
-// const {
-// dashboardConfig: {
-// AuthConfig: { enabled },
-// },
-// } = Config;
-const {
- // mainLinks: { dashboardIndex },
- authLinks: { loginURL },
-} = StudioCMSRoutes;
-// const { isLoggedIn, dbUser: userProfile } = Astro.locals;
-
-// TODO: Update this to use the new auth system
----
-{/* enabled !== false && (isLoggedIn ? (
-
- 
-
- ) : (
- */
-
- 
-
- /* ))
-}
-{ enabled === false && (
-
-
-
-)*/}
\ No newline at end of file
diff --git a/packages/studiocms_core/src/components/FormattedDate.astro b/packages/studiocms_core/src/components/FormattedDate.astro
deleted file mode 100644
index 2bf5bceb83..0000000000
--- a/packages/studiocms_core/src/components/FormattedDate.astro
+++ /dev/null
@@ -1,21 +0,0 @@
----
-import Config from 'virtual:studiocms/config';
-
-const { dateLocale: locales } = Config;
-
-interface Props {
- date: Date;
-}
-
-const { date } = Astro.props;
----
-
-
diff --git a/packages/studiocms_core/src/components/GenericHeader.astro b/packages/studiocms_core/src/components/GenericHeader.astro
deleted file mode 100644
index 870bd4eb1b..0000000000
--- a/packages/studiocms_core/src/components/GenericHeader.astro
+++ /dev/null
@@ -1,35 +0,0 @@
----
-import Config from 'virtual:studiocms/config';
-import { headDefaults } from '../helpers/headDefaults';
-import { createHead } from '../lib';
-
-const {
- defaultFrontEndConfig: { htmlDefaultHead, favicon: configFav },
-} = Config;
-
-interface Props {
- title: string;
- description: string;
- favicon: string;
- lang?: string;
- ogImage?: string;
- canonicalURL?: URL;
-}
-
-const canonical = Astro.site ? new URL(Astro.url.pathname, Astro.site) : undefined;
-
-const {
- title,
- description,
- favicon = configFav,
- canonicalURL = canonical,
- lang = 'en',
- ogImage,
-} = Astro.props;
-
-const genericHead = headDefaults(title, description, lang, Astro, favicon, ogImage, canonicalURL);
-
-const head = createHead(genericHead, htmlDefaultHead);
----
-
-{head.map(({ tag: Tag, attrs, content }) => 
- * {
- const slugToUse = slug;
- const packageToGet = pkg || 'studiocms';
-
- const pageData = await db.select().from(tsPageData).where(eq(tsPageData.slug, slugToUse)).get();
-
- if (!pageData) {
- return {} as ContentHelperTempResponse;
- }
-
- if (pageData.package && pageData.package !== packageToGet) {
- throw new AstroError(
- `Page not found: ${slug} in package ${packageToGet}`,
- `studioCMS contentHelper Failed to get page data for page ${slug} in package ${packageToGet}`
- );
- }
-
- const langToGet = 'default';
-
- const pageContent = await db
- .select()
- .from(tsPageContent)
- .where(eq(tsPageContent.contentId, pageData.id))
- .get();
-
- if (!pageContent) {
- throw new AstroError(
- `Page Content not found: ${slug} with language ${langToGet}`,
- `studioCMS contentHelper Failed to get page content for page ${slug} with language ${langToGet}`
- );
- }
- return { ...pageData, content: pageContent.content || 'Failed to fetch Content' };
-}
-
-export async function getPageById(id: string): Promise {
- const pageData = await db.select().from(tsPageData).where(eq(tsPageData.id, id)).get();
-
- if (!pageData) {
- return {} as ContentHelperTempResponse;
- }
-
- const langToGet = 'default';
-
- const pageContent = await db
- .select()
- .from(tsPageContent)
- .where(eq(tsPageContent.contentId, pageData.id))
- .get();
-
- if (!pageContent) {
- throw new AstroError(
- `Page Content not found: ${id} with language ${langToGet}`,
- `studioCMS contentHelper Failed to get page content for page ${id} with language ${langToGet}`
- );
- }
- return { ...pageData, content: pageContent.content || 'Failed to fetch Content' };
-}
-
-/**
- * Get page list helper function to get a list of all pages from Astro Studio's database.
- *
- * @returns A Array of all pages in the database in ascending order of their published date.
- */
-export async function getPageList(): Promise {
- const pageData = await db.select().from(tsPageData).orderBy(asc(tsPageData.publishedAt));
-
- if (!pageData) {
- return [] as pageDataReponse[];
- }
-
- return pageData;
-}
-
-/**
- * Site Configuration helper function to get the site configuration data from Astro Studio's Database.
- *
- * @returns The site configuration data. (Title, Description)
- */
-export async function getSiteConfig(): Promise {
- const config: PageDataAndContent['SiteConfig'] | undefined = await db
- .select()
- .from(tsSiteConfig)
- .where(eq(tsSiteConfig.id, CMSSiteConfigId))
- .get();
-
- if (!config || config === undefined) {
- return {
- id: CMSSiteConfigId,
- title: 'StudioCMS',
- description: 'A CMS for Astro.',
- } as SiteConfigResponse;
- }
-
- return {
- id: config.id,
- title: config.title,
- description: config.description,
- };
-}
-
-/**
- * Get user by ID helper function to get a user by their ID from Astro Studio's Database.
- *
- * @param userId The ID of the user to get. You can get this from `Astro.locals.dbUser.id` when StudioCMS Auth middleware is used.
- * @returns The user data.
- */
-export async function getUserById(userId: string): Promise {
- const user = await db.select().from(tsUsers).where(eq(tsUsers.id, userId)).get();
-
- if (!user) {
- return {} as UserResponse;
- }
-
- return user;
-}
-
-/**
- * Get user list helper function to get a list of all users from Astro Studio's Database.
- *
- * @returns A Array of all users in the database.
- */
-export async function getUserList(): Promise {
- const users: UserResponse[] = await db.select().from(tsUsers).orderBy(desc(tsUsers.name));
-
- if (!users) {
- return [] as UserResponse[];
- }
-
- return users;
-}
-
-/**
- * Get permissions list helper function to get a list of all permissions from Astro Studio's Database.
- *
- * @returns An Array of all permissions in the database.
- */
-export async function getPermissionsList(): Promise {
- const permissions = await db.select().from(tsPermissions);
-
- if (!permissions) {
- return [] as PageDataAndContent['Permissions'][];
- }
-
- return permissions;
-}
diff --git a/packages/studiocms_core/src/helpers/index.ts b/packages/studiocms_core/src/helpers/index.ts
deleted file mode 100644
index 7bfbedee49..0000000000
--- a/packages/studiocms_core/src/helpers/index.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-// This file is here to make it easier for accessing the helpers virtual modules when
-// creating the definitions for them for development and should not be imported directly in the codebase.
-export { default as urlGenFactory } from './urlGen';
-export * from './contentHelper';
-export * from './headDefaults';
-export * from './pathGenerators';
-export * from './routemap';
diff --git a/packages/studiocms_core/src/helpers/routemap.ts b/packages/studiocms_core/src/helpers/routemap.ts
deleted file mode 100644
index f7f361b628..0000000000
--- a/packages/studiocms_core/src/helpers/routemap.ts
+++ /dev/null
@@ -1,159 +0,0 @@
-import Config from 'virtual:studiocms/config';
-import { dashboardPageLinks } from 'virtual:studiocms/pluginSystem';
-import type { SideBarLink } from '@studiocms/core/types';
-import urlGenFactory from '../helpers/urlGen';
-
-const {
- dashboardConfig: { dashboardRouteOverride },
-} = Config;
-
-export async function getSluggedRoute(url: string, slug: string): Promise {
- return await urlGenFactory(true, url + slug, dashboardRouteOverride);
-}
-
-export async function getEditRoute(slug: string): Promise {
- return await getSluggedRoute('edit/pages/', slug);
-}
-
-export async function getDeleteRoute(slug: string): Promise {
- return await getSluggedRoute('delete/pages/', slug);
-}
-
-export async function makeNonDashboardRoute(route?: string | undefined): Promise {
- return await urlGenFactory(false, route);
-}
-
-export async function makeDashboardRoute(route?: string | undefined): Promise {
- return await urlGenFactory(true, route, dashboardRouteOverride);
-}
-
-export async function makeAPIDashboardRoute(route: string): Promise {
- return await urlGenFactory(true, `api/${route}`, dashboardRouteOverride);
-}
-
-export async function makeStudioCMSAPIRoute(route: string): Promise {
- return await urlGenFactory(false, `studiocms_api/${route}`);
-}
-
-export const StudioCMSRoutes = {
- mainLinks: {
- baseSiteURL: await makeNonDashboardRoute(),
- dashboardIndex: await makeDashboardRoute(),
- userProfile: await makeDashboardRoute('profile/'),
- pageNew: await makeDashboardRoute('new/page/'),
- pageEdit: await makeDashboardRoute('page-list/'),
- siteConfiguration: await makeDashboardRoute('configuration/'),
- configurationAdmins: await makeDashboardRoute('configuration/admins/'),
- },
- authLinks: {
- loginURL: await makeDashboardRoute('login'),
- logoutURL: await makeDashboardRoute('logout'),
- signupURL: await makeDashboardRoute('signup'),
- loginAPI: await makeStudioCMSAPIRoute('auth/login'), // /studiocms_api/auth/login
- logoutAPI: await makeStudioCMSAPIRoute('auth/logout'), // /studiocms_api/auth/logout
- registerAPI: await makeStudioCMSAPIRoute('auth/register'), // /studiocms_api/auth/register
- githubIndex: await makeStudioCMSAPIRoute('auth/github'), // /studiocms_api/auth/github
- githubCallback: await makeStudioCMSAPIRoute('auth/github/callback'), // /studiocms_api/auth/github/callback
- discordIndex: await makeStudioCMSAPIRoute('auth/discord'), // /studiocms_api/auth/discord
- discordCallback: await makeStudioCMSAPIRoute('auth/discord/callback'), // /studiocms_api/auth/discord/callback
- googleIndex: await makeStudioCMSAPIRoute('auth/google'), // /studiocms_api/auth/google
- googleCallback: await makeStudioCMSAPIRoute('auth/google/callback'), // /studiocms_api/auth/google/callback
- auth0Index: await makeStudioCMSAPIRoute('auth/auth0'), // /studiocms_api/auth/auth0
- auth0Callback: await makeStudioCMSAPIRoute('auth/auth0/callback'), // /studiocms_api/auth/auth0/callback
- },
- endpointLinks: {
- partials: {
- livePreviewBox: await makeAPIDashboardRoute('liverender'), // /studiocms_api/render/preview
- },
- config: {
- siteConfig: await makeAPIDashboardRoute('config/site'), // /studiocms_api/config/site
- adminConfig: await makeAPIDashboardRoute('config/admin'), // /studiocms_api/config/admin
- },
- pages: {
- createPages: await makeAPIDashboardRoute('pages/create'), // /studiocms_api/pages/create
- editPages: await makeAPIDashboardRoute('pages/edit'), // /studiocms_api/pages/edit
- deletePages: await makeAPIDashboardRoute('pages/delete'), // /studiocms_api/pages/delete
- },
- },
-};
-
-// Add default dashboard page links
-const defaultDashboardPageLinks: SideBarLink[] = [
- {
- id: 'home',
- href: StudioCMSRoutes.mainLinks.baseSiteURL,
- text: 'View Site',
- minPermissionLevel: 'unknown',
- icon: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDE2IDE2Ij48cGF0aCBmaWxsPSJjdXJyZW50Q29sb3IiIGQ9Ik04IDBhOCA4IDAgMSAwIDAgMTZBOCA4IDAgMCAwIDggME0yLjA0IDQuMzI2Yy4zMjUgMS4zMjkgMi41MzIgMi41NCAzLjcxNyAzLjE5Yy40OC4yNjMuNzkzLjQzNC43NDMuNDg0cS0uMTIxLjEyLS4yNDIuMjM0Yy0uNDE2LjM5Ni0uNzg3Ljc0OS0uNzU4IDEuMjY2Yy4wMzUuNjM0LjYxOC44MjQgMS4yMTQgMS4wMTdjLjU3Ny4xODggMS4xNjguMzggMS4yODYuOTgzYy4wODIuNDE3LS4wNzUuOTg4LS4yMiAxLjUyYy0uMjE1Ljc4Mi0uNDA2IDEuNDguMjIgMS40OGMxLjUtLjUgMy43OTgtMy4xODYgNC01Yy4xMzgtMS4yNDMtMi0yLTMuNS0yLjVjLS40NzgtLjE2LS43NTUuMDgxLS45OS4yODRjLS4xNzIuMTUtLjMyMi4yNzktLjUxLjIxNmMtLjQ0NS0uMTQ4LTIuNS0yLTEuNS0yLjVjLjc4LS4zOS45NTItLjE3MSAxLjIyNy4xODJjLjA3OC4wOTkuMTYzLjIwOC4yNzMuMzE4Yy42MDkuMzA0LjY2Mi0uMTMyLjcyMy0uNjMzYy4wMzktLjMyMi4wODEtLjY3MS4yNzctLjg2N2MuNDM0LS40MzQgMS4yNjUtLjc5MSAyLjAyOC0xLjEyYy43MTItLjMwNiAxLjM2NS0uNTg3IDEuNTc5LS44OEE3IDcgMCAxIDEgMi4wNCA0LjMyN1oiLz48L3N2Zz4=',
- type: 'link',
- },
- {
- id: 'dashboard',
- href: StudioCMSRoutes.mainLinks.dashboardIndex,
- text: 'Dashboard',
- minPermissionLevel: 'visitor',
- icon: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDE2IDE2Ij48cGF0aCBmaWxsPSJjdXJyZW50Q29sb3IiIGQ9Ik02IDF2M0gxVjF6TTEgMGExIDEgMCAwIDAtMSAxdjNhMSAxIDAgMCAwIDEgMWg1YTEgMSAwIDAgMCAxLTFWMWExIDEgMCAwIDAtMS0xem0xNCAxMnYzaC01di0zem0tNS0xYTEgMSAwIDAgMC0xIDF2M2ExIDEgMCAwIDAgMSAxaDVhMSAxIDAgMCAwIDEtMXYtM2ExIDEgMCAwIDAtMS0xek02IDh2N0gxVjh6TTEgN2ExIDEgMCAwIDAtMSAxdjdhMSAxIDAgMCAwIDEgMWg1YTEgMSAwIDAgMCAxLTFWOGExIDEgMCAwIDAtMS0xem0xNC02djdoLTVWMXptLTUtMWExIDEgMCAwIDAtMSAxdjdhMSAxIDAgMCAwIDEgMWg1YTEgMSAwIDAgMCAxLTFWMWExIDEgMCAwIDAtMS0xeiIvPjwvc3ZnPg==',
- type: 'link',
- },
- {
- id: 'profile',
- href: StudioCMSRoutes.mainLinks.userProfile,
- text: 'User Profile',
- minPermissionLevel: 'visitor',
- icon: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDE2IDE2Ij48ZyBmaWxsPSJjdXJyZW50Q29sb3IiPjxwYXRoIGQ9Ik0xMSA2YTMgMyAwIDEgMS02IDBhMyAzIDAgMCAxIDYgMCIvPjxwYXRoIGQ9Ik0yIDBhMiAyIDAgMCAwLTIgMnYxMmEyIDIgMCAwIDAgMiAyaDEyYTIgMiAwIDAgMCAyLTJWMmEyIDIgMCAwIDAtMi0yem0xMiAxYTEgMSAwIDAgMSAxIDF2MTJhMSAxIDAgMCAxLTEgMXYtMWMwLTEtMS00LTYtNHMtNiAzLTYgNHYxYTEgMSAwIDAgMS0xLTFWMmExIDEgMCAwIDEgMS0xeiIvPjwvZz48L3N2Zz4=',
- type: 'link',
- },
- {
- id: 'new-page',
- href: StudioCMSRoutes.mainLinks.pageNew,
- text: 'Create New Page',
- minPermissionLevel: 'editor',
- icon: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDE2IDE2Ij48ZyBmaWxsPSJjdXJyZW50Q29sb3IiPjxwYXRoIGQ9Ik0xNS41MDIgMS45NGEuNS41IDAgMCAxIDAgLjcwNkwxNC40NTkgMy42OWwtMi0yTDEzLjUwMi42NDZhLjUuNSAwIDAgMSAuNzA3IDBsMS4yOTMgMS4yOTN6bS0xLjc1IDIuNDU2bC0yLTJMNC45MzkgOS4yMWEuNS41IDAgMCAwLS4xMjEuMTk2bC0uODA1IDIuNDE0YS4yNS4yNSAwIDAgMCAuMzE2LjMxNmwyLjQxNC0uODA1YS41LjUgMCAwIDAgLjE5Ni0uMTJsNi44MTMtNi44MTR6Ii8+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMSAxMy41QTEuNSAxLjUgMCAwIDAgMi41IDE1aDExYTEuNSAxLjUgMCAwIDAgMS41LTEuNXYtNmEuNS41IDAgMCAwLTEgMHY2YS41LjUgMCAwIDEtLjUuNWgtMTFhLjUuNSAwIDAgMS0uNS0uNXYtMTFhLjUuNSAwIDAgMSAuNS0uNUg5YS41LjUgMCAwIDAgMC0xSDIuNUExLjUgMS41IDAgMCAwIDEgMi41eiIvPjwvZz48L3N2Zz4=',
- type: 'link',
- },
- {
- id: 'edit-pages',
- href: StudioCMSRoutes.mainLinks.pageEdit,
- text: 'Edit Pages',
- minPermissionLevel: 'editor',
- icon: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDE2IDE2Ij48cGF0aCBmaWxsPSJjdXJyZW50Q29sb3IiIGQ9Ik0xMi4xNDYuMTQ2YS41LjUgMCAwIDEgLjcwOCAwbDMgM2EuNS41IDAgMCAxIDAgLjcwOGwtMTAgMTBhLjUuNSAwIDAgMS0uMTY4LjExbC01IDJhLjUuNSAwIDAgMS0uNjUtLjY1bDItNWEuNS41IDAgMCAxIC4xMS0uMTY4ek0xMS4yMDcgMi41TDEzLjUgNC43OTNMMTQuNzkzIDMuNUwxMi41IDEuMjA3em0xLjU4NiAzTDEwLjUgMy4yMDdMNCA5LjcwN1YxMGguNWEuNS41IDAgMCAxIC41LjV2LjVoLjVhLjUuNSAwIDAgMSAuNS41di41aC4yOTN6bS05Ljc2MSA1LjE3NWwtLjEwNi4xMDZsLTEuNTI4IDMuODIxbDMuODIxLTEuNTI4bC4xMDYtLjEwNkEuNS41IDAgMCAxIDUgMTIuNVYxMmgtLjVhLjUuNSAwIDAgMS0uNS0uNVYxMWgtLjVhLjUuNSAwIDAgMS0uNDY4LS4zMjUiLz48L3N2Zz4=',
- type: 'link',
- },
- {
- id: 'site-config',
- href: StudioCMSRoutes.mainLinks.siteConfiguration,
- text: 'Site Configuration',
- minPermissionLevel: 'admin',
- icon: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDE2IDE2Ij48cGF0aCBmaWxsPSJjdXJyZW50Q29sb3IiIGQ9Ik03LjA2OC43MjdjLjI0My0uOTcgMS42Mi0uOTcgMS44NjQgMGwuMDcxLjI4NmEuOTYuOTYgMCAwIDAgMS42MjIuNDM0bC4yMDUtLjIxMWMuNjk1LS43MTkgMS44ODgtLjAzIDEuNjEzLjkzMWwtLjA4LjI4NGEuOTYuOTYgMCAwIDAgMS4xODcgMS4xODdsLjI4My0uMDgxYy45Ni0uMjc1IDEuNjUuOTE4LjkzMSAxLjYxM2wtLjIxMS4yMDVhLjk2Ljk2IDAgMCAwIC40MzQgMS42MjJsLjI4Ni4wNzFjLjk3LjI0My45NyAxLjYyIDAgMS44NjRsLS4yODYuMDcxYS45Ni45NiAwIDAgMC0uNDM0IDEuNjIybC4yMTEuMjA1Yy43MTkuNjk1LjAzIDEuODg4LS45MzEgMS42MTNsLS4yODQtLjA4YS45Ni45NiAwIDAgMC0xLjE4NyAxLjE4N2wuMDgxLjI4M2MuMjc1Ljk2LS45MTggMS42NS0xLjYxMy45MzFsLS4yMDUtLjIxMWEuOTYuOTYgMCAwIDAtMS42MjIuNDM0bC0uMDcxLjI4NmMtLjI0My45Ny0xLjYyLjk3LTEuODY0IDBsLS4wNzEtLjI4NmEuOTYuOTYgMCAwIDAtMS42MjItLjQzNGwtLjIwNS4yMTFjLS42OTUuNzE5LTEuODg4LjAzLTEuNjEzLS45MzFsLjA4LS4yODRhLjk2Ljk2IDAgMCAwLTEuMTg2LTEuMTg3bC0uMjg0LjA4MWMtLjk2LjI3NS0xLjY1LS45MTgtLjkzMS0xLjYxM2wuMjExLS4yMDVhLjk2Ljk2IDAgMCAwLS40MzQtMS42MjJsLS4yODYtLjA3MWMtLjk3LS4yNDMtLjk3LTEuNjIgMC0xLjg2NGwuMjg2LS4wNzFhLjk2Ljk2IDAgMCAwIC40MzQtMS42MjJsLS4yMTEtLjIwNWMtLjcxOS0uNjk1LS4wMy0xLjg4OC45MzEtMS42MTNsLjI4NC4wOGEuOTYuOTYgMCAwIDAgMS4xODctMS4xODZsLS4wODEtLjI4NGMtLjI3NS0uOTYuOTE4LTEuNjUgMS42MTMtLjkzMWwuMjA1LjIxMWEuOTYuOTYgMCAwIDAgMS42MjItLjQzNHpNMTIuOTczIDguNUg4LjI1bC0yLjgzNCAzLjc3OUE0Ljk5OCA0Ljk5OCAwIDAgMCAxMi45NzMgOC41bTAtMWE0Ljk5OCA0Ljk5OCAwIDAgMC03LjU1Ny0zLjc3OWwyLjgzNCAzLjc4ek01LjA0OCAzLjk2N2wtLjA4Ny4wNjV6bS0uNDMxLjM1NUE0Ljk4IDQuOTggMCAwIDAgMy4wMDIgOGMwIDEuNDU1LjYyMiAyLjc2NSAxLjYxNSAzLjY3OEw3LjM3NSA4em0uMzQ0IDcuNjQ2bC4wODcuMDY1eiIvPjwvc3ZnPg==',
- type: 'link',
- },
-];
-
-// Add custom dashboard page links
-const customDashboardPageLinks: SideBarLink[] = [];
-
-const customDashboardRoutes = Array.from(dashboardPageLinks.values());
-
-for (const links of customDashboardRoutes) {
- customDashboardPageLinks.push(...links);
-}
-
-const customDashboardDropdown = {
- id: 'integrations',
- href: '',
- text: 'Integration Configs',
- minPermissionLevel: 'editor',
- icon: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDE2IDE2Ij48cGF0aCBmaWxsPSJjdXJyZW50Q29sb3IiIGQ9Ik0zLjExMiAzLjY0NUExLjUgMS41IDAgMCAxIDQuNjA1IDJIN2EuNS41IDAgMCAxIC41LjV2LjM4MmMwIC42OTYtLjQ5NyAxLjE4Mi0uODcyIDEuNDY5YS41LjUgMCAwIDAtLjExNS4xMThsLS4wMTIuMDI1TDYuNSA0LjV2LjAwM2wuMDAzLjAxcS4wMDUuMDE1LjAzNi4wNTNhLjkuOSAwIDAgMCAuMjcuMTk0QzcuMDkgNC45IDcuNTEgNSA4IDVjLjQ5MiAwIC45MTItLjEgMS4xOS0uMjRhLjkuOSAwIDAgMCAuMjcxLS4xOTRhLjIuMiAwIDAgMCAuMDM5LS4wNjN2LS4wMDlsLS4wMTItLjAyNWEuNS41IDAgMCAwLS4xMTUtLjExOGMtLjM3NS0uMjg3LS44NzItLjc3My0uODcyLTEuNDY5VjIuNUEuNS41IDAgMCAxIDkgMmgyLjM5NWExLjUgMS41IDAgMCAxIDEuNDkzIDEuNjQ1TDEyLjY0NSA2LjVoLjIzN2MuMTk1IDAgLjQyLS4xNDcuNjc1LS40OGMuMjEtLjI3NC41MjgtLjUyLjk0My0uNTJjLjU2OCAwIC45NDcuNDQ3IDEuMTU0Ljg2MkMxNS44NzcgNi44MDcgMTYgNy4zODcgMTYgOHMtLjEyMyAxLjE5My0uMzQ2IDEuNjM4Yy0uMjA3LjQxNS0uNTg2Ljg2Mi0xLjE1NC44NjJjLS40MTUgMC0uNzMzLS4yNDYtLjk0My0uNTJjLS4yNTUtLjMzMy0uNDgtLjQ4LS42NzUtLjQ4aC0uMjM3bC4yNDMgMi44NTVBMS41IDEuNSAwIDAgMSAxMS4zOTUgMTRIOWEuNS41IDAgMCAxLS41LS41di0uMzgyYzAtLjY5Ni40OTctMS4xODIuODcyLTEuNDY5YS41LjUgMCAwIDAgLjExNS0uMTE4bC4wMTItLjAyNWwuMDAxLS4wMDZ2LS4wMDNhLjIuMiAwIDAgMC0uMDM5LS4wNjRhLjkuOSAwIDAgMC0uMjctLjE5M0M4LjkxIDExLjEgOC40OSAxMSA4IDExcy0uOTEyLjEtMS4xOS4yNGEuOS45IDAgMCAwLS4yNzEuMTk0YS4yLjIgMCAwIDAtLjAzOS4wNjN2LjAwM2wuMDAxLjAwNmwuMDEyLjAyNWMuMDE2LjAyNy4wNS4wNjguMTE1LjExOGMuMzc1LjI4Ny44NzIuNzczLjg3MiAxLjQ2OXYuMzgyYS41LjUgMCAwIDEtLjUuNUg0LjYwNWExLjUgMS41IDAgMCAxLTEuNDkzLTEuNjQ1TDMuMzU2IDkuNWgtLjIzOGMtLjE5NSAwLS40Mi4xNDctLjY3NS40OGMtLjIxLjI3NC0uNTI4LjUyLS45NDMuNTJjLS41NjggMC0uOTQ3LS40NDctMS4xNTQtLjg2MkMuMTIzIDkuMTkzIDAgOC42MTMgMCA4cy4xMjMtMS4xOTMuMzQ2LTEuNjM4Qy41NTMgNS45NDcuOTMyIDUuNSAxLjUgNS41Yy40MTUgMCAuNzMzLjI0Ni45NDMuNTJjLjI1NS4zMzMuNDguNDguNjc1LjQ4aC4yMzh6TTQuNjA1IDNhLjUuNSAwIDAgMC0uNDk4LjU1bC4wMDEuMDA3bC4yOSAzLjRBLjUuNSAwIDAgMSAzLjkgNy41aC0uNzgyYy0uNjk2IDAtMS4xODItLjQ5Ny0xLjQ2OS0uODcyYS41LjUgMCAwIDAtLjExOC0uMTE1bC0uMDI1LS4wMTJMMS41IDYuNWgtLjAwM2EuMi4yIDAgMCAwLS4wNjQuMDM5YS45LjkgMCAwIDAtLjE5My4yN0MxLjEgNy4wOSAxIDcuNTEgMSA4cy4xLjkxMi4yNCAxLjE5Yy4wNy4xNC4xNC4yMjUuMTk0LjI3MWEuMi4yIDAgMCAwIC4wNjMuMDM5SDEuNWwuMDA2LS4wMDFsLjAyNS0uMDEyYS41LjUgMCAwIDAgLjExOC0uMTE1Yy4yODctLjM3NS43NzMtLjg3MiAxLjQ2OS0uODcySDMuOWEuNS41IDAgMCAxIC40OTguNTQybC0uMjkgMy40MDhhLjUuNSAwIDAgMCAuNDk3LjU1aDEuODc4Yy0uMDQ4LS4xNjYtLjE5NS0uMzUyLS40NjMtLjU1N2MtLjI3NC0uMjEtLjUyLS41MjgtLjUyLS45NDNjMC0uNTY4LjQ0Ny0uOTQ3Ljg2Mi0xLjE1NEM2LjgwNyAxMC4xMjMgNy4zODcgMTAgOCAxMHMxLjE5My4xMjMgMS42MzguMzQ2Yy40MTUuMjA3Ljg2Mi41ODYuODYyIDEuMTU0YzAgLjQxNS0uMjQ2LjczMy0uNTIuOTQzYy0uMjY4LjIwNS0uNDE1LjM5LS40NjMuNTU3aDEuODc4YS41LjUgMCAwIDAgLjQ5OC0uNTVsLS4wMDEtLjAwN2wtLjI5LTMuNEEuNS41IDAgMCAxIDEyLjEgOC41aC43ODJjLjY5NiAwIDEuMTgyLjQ5NyAxLjQ2OS44NzJjLjA1LjA2NS4wOTEuMDk5LjExOC4xMTVsLjAyNS4wMTJsLjAwNi4wMDFoLjAwM2EuMi4yIDAgMCAwIC4wNjQtLjAzOWEuOS45IDAgMCAwIC4xOTMtLjI3Yy4xNC0uMjguMjQtLjcuMjQtMS4xOTFzLS4xLS45MTItLjI0LTEuMTlhLjkuOSAwIDAgMC0uMTk0LS4yNzFhLjIuMiAwIDAgMC0uMDYzLS4wMzlIMTQuNWwtLjAwNi4wMDFsLS4wMjUuMDEyYS41LjUgMCAwIDAtLjExOC4xMTVjLS4yODcuMzc1LS43NzMuODcyLTEuNDY5Ljg3MkgxMi4xYS41LjUgMCAwIDEtLjQ5OC0uNTQzbC4yOS0zLjQwN2EuNS41IDAgMCAwLS40OTctLjU1SDkuNTE3Yy4wNDguMTY2LjE5NS4zNTIuNDYzLjU1N2MuMjc0LjIxLjUyLjUyOC41Mi45NDNjMCAuNTY4LS40NDcuOTQ3LS44NjIgMS4xNTRDOS4xOTMgNS44NzcgOC42MTMgNiA4IDZzLTEuMTkzLS4xMjMtMS42MzgtLjM0NkM1Ljk0NyA1LjQ0NyA1LjUgNS4wNjggNS41IDQuNWMwLS40MTUuMjQ2LS43MzMuNTItLjk0M2MuMjY4LS4yMDUuNDE1LS4zOS40NjMtLjU1N3oiLz48L3N2Zz4=',
- type: 'dropdown',
- dropdownItems: customDashboardPageLinks,
-} satisfies SideBarLink;
-
-// Side bar links map
-const finalSideBarLinkMap: SideBarLink[] = [...defaultDashboardPageLinks];
-
-// Merge custom dashboard page links
-if (customDashboardDropdown.dropdownItems.length > 0) {
- finalSideBarLinkMap.push(customDashboardDropdown);
-}
-
-export const sideBarLinkMap: SideBarLink[] = finalSideBarLinkMap;
diff --git a/packages/studiocms_core/src/hooks/config-done.ts b/packages/studiocms_core/src/hooks/config-done.ts
new file mode 100644
index 0000000000..df5ca0a61a
--- /dev/null
+++ b/packages/studiocms_core/src/hooks/config-done.ts
@@ -0,0 +1,17 @@
+import { defineUtility } from 'astro-integration-kit';
+import componentsDtsFileOutput from '../stubs/components.js';
+import coreDtsFileOutput from '../stubs/core.js';
+import i18nDTSOutput from '../stubs/i18n-dts.js';
+import libDtsFileOutput from '../stubs/lib.js';
+import sdkDtsFile from '../stubs/sdk.js';
+
+export const configDone = defineUtility('astro:config:done')(({ injectTypes }) => {
+ // Inject the DTS File
+ injectTypes(componentsDtsFileOutput);
+ injectTypes(coreDtsFileOutput);
+ injectTypes(i18nDTSOutput);
+ injectTypes(sdkDtsFile);
+ injectTypes(libDtsFileOutput);
+});
+
+export default configDone;
diff --git a/packages/studiocms_core/src/hooks/config-setup.ts b/packages/studiocms_core/src/hooks/config-setup.ts
new file mode 100644
index 0000000000..fc7e48e981
--- /dev/null
+++ b/packages/studiocms_core/src/hooks/config-setup.ts
@@ -0,0 +1,155 @@
+import { addVirtualImports, createResolver, defineUtility } from 'astro-integration-kit';
+import copy from 'rollup-plugin-copy';
+import { makeAPIRoute, makePublicRoute } from '../lib/index.js';
+import type { StudioCMSConfig } from '../schemas/index.js';
+import { integrationLogger } from '../utils/integrationLogger.js';
+import readJson from '../utils/readJson.js';
+
+const { name } = readJson<{ name: string; version: string }>(
+ new URL('../../package.json', import.meta.url)
+);
+
+export const configSetup = defineUtility('astro:config:setup')(
+ (params, options: StudioCMSConfig) => {
+ // Destructure the params
+ const {
+ logger,
+ injectRoute,
+ updateConfig,
+ config: {
+ root: { pathname: userSrcDir },
+ },
+ } = params;
+
+ // Create logInfo object
+ const logInfo = { logger, logLevel: 'info' as const, verbose: options.verbose };
+
+ // Log the setup
+ integrationLogger(logInfo, 'Setting up StudioCMS Core...');
+
+ // Create resolvers
+ const { resolve } = createResolver(import.meta.url);
+ const { resolve: userSrcDirResolve } = createResolver(userSrcDir);
+
+ updateConfig({
+ vite: {
+ plugins: [
+ copy({
+ copyOnce: true,
+ hook: 'buildStart',
+ targets: [
+ {
+ src: resolve('../../assets/public/*'),
+ dest: makePublicRoute('core'),
+ },
+ ],
+ }),
+ ],
+ },
+ });
+
+ // Setup Virtual Imports
+ integrationLogger(logInfo, 'Adding Virtual Imports...');
+
+ addVirtualImports(params, {
+ name,
+ imports: {
+ // Core Virtual Components
+ 'studiocms:components': `
+ export { default as Avatar } from '${resolve('../../assets/components/Avatar.astro')}';
+ export { default as FormattedDate } from '${
+ options.overrides.FormattedDateOverride
+ ? userSrcDirResolve(options.overrides.FormattedDateOverride)
+ : resolve('../../assets/components/FormattedDate.astro')
+ }';
+ export { default as GenericHeader } from '${resolve('../../assets/components/GenericHeader.astro')}';
+ export { default as Navigation } from '${resolve('../../assets/components/Navigation.astro')}';
+ export { default as Generator } from '${resolve('../../assets/components/Generator.astro')}';
+ `,
+
+ // StudioCMS lib
+ 'studiocms:lib': `
+ export * from '${resolve('../lib/head.js')}';
+ export * from '${resolve('../lib/headDefaults.js')}';
+ export * from '${resolve('../lib/jsonUtils.js')}';
+ export * from '${resolve('../lib/pathGenerators.js')}';
+ export * from '${resolve('../lib/removeLeadingTrailingSlashes.js')}';
+ export * from '${resolve('../lib/routeMap.js')}';
+ export * from '${resolve('../lib/urlGen.js')}';
+ `,
+
+ // StudioCMS Core i18n
+ 'studiocms:i18n': `
+ export * from '${resolve('../../assets/i18n/index.ts')}';
+ `,
+
+ // StudioCMS SDK
+ 'studiocms:sdk': `
+ import studioCMS_SDK from '${resolve('../sdk-utils/index.js')}';
+ export default studioCMS_SDK;
+ `,
+ 'studiocms:sdk/get': `
+ import studioCMS_SDK_GET from '${resolve('../sdk-utils/get.js')}';
+ export default studioCMS_SDK_GET;
+ `,
+ 'studiocms:sdk/post': `
+ import studioCMS_SDK_POST from '${resolve('../sdk-utils/post.js')}';
+ export default studioCMS_SDK_POST;
+ `,
+ 'studiocms:sdk/update': `
+ import studioCMS_SDK_UPDATE from '${resolve('../sdk-utils/update.js')}';
+ export default studioCMS_SDK_UPDATE;
+ `,
+ 'studiocms:sdk/delete': `
+ import studioCMS_SDK_DELETE from '${resolve('../sdk-utils/delete.js')}';
+ export default studioCMS_SDK_DELETE;
+ `,
+ 'studiocms:sdk/auth': `
+ import studioCMS_SDK_AUTH from '${resolve('../sdk-utils/auth.js')}';
+ export default studioCMS_SDK_AUTH;
+ `,
+ 'studiocms:sdk/types': `
+ export * from '${resolve('../sdk-utils/types.js')}';
+ `,
+ 'studiocms:sdk/cache': `
+ export * from '${resolve('../sdk-utils/cache.js')}';
+ import studioCMS_SDK_Cache from '${resolve('../sdk-utils/cache.js')}';
+ export default studioCMS_SDK_Cache;
+ `,
+ },
+ });
+
+ // Inject SDK API Routes
+ integrationLogger(logInfo, 'Injecting SDK Routes...');
+
+ const sdkRouteResolver = makeAPIRoute('sdk');
+
+ injectRoute({
+ pattern: sdkRouteResolver('list-pages'),
+ entrypoint: resolve('../routes/list-pages.js'),
+ prerender: false,
+ });
+
+ injectRoute({
+ pattern: sdkRouteResolver('update-latest-version-cache'),
+ entrypoint: resolve('../routes/update-latest-version-cache.js'),
+ prerender: false,
+ });
+
+ injectRoute({
+ pattern: sdkRouteResolver('fallback-list-pages.json'),
+ entrypoint: resolve('../routes/fallback-list-pages.json.js'),
+ prerender: true,
+ });
+
+ injectRoute({
+ pattern: sdkRouteResolver('full-changelog.json'),
+ entrypoint: resolve('../routes/full-changelog.json.js'),
+ prerender: true,
+ });
+
+ integrationLogger(logInfo, 'Core Setup Complete...');
+ }
+);
+
+export default configSetup;
diff --git a/packages/studiocms_core/src/index.ts b/packages/studiocms_core/src/index.ts
index 0cbb8cd394..56553b1ec7 100644
--- a/packages/studiocms_core/src/index.ts
+++ b/packages/studiocms_core/src/index.ts
@@ -1,9 +1,28 @@
-// Import core-integration
-import integration from './integration';
+import type { AstroIntegration } from 'astro';
+// import { name as pkgName } from '../package.json' assert { type: 'json' };
+import configDone from './hooks/config-done.js';
+import configSetup from './hooks/config-setup.js';
+import type { StudioCMSConfig } from './schemas/index.js';
+import readJson from './utils/readJson.js';
+
+const { name: pkgName } = readJson<{ name: string }>(new URL('../package.json', import.meta.url));
/**
- * Core StudioCMS Integration
+ * **StudioCMS Core Integration**
+ *
+ * @param options StudioCMS Configuration
+ * @returns AstroIntegration
+ *
+ * @see [StudioCMS Docs](https://docs.studiocms.dev) for more information on how to use StudioCMS.
*/
-const coreIntegration = integration;
+export function studioCMSCore(options: StudioCMSConfig): AstroIntegration {
+ return {
+ name: pkgName,
+ hooks: {
+ 'astro:config:setup': (params) => configSetup(params, options),
+ 'astro:config:done': (params) => configDone(params),
+ },
+ };
+}
-export default coreIntegration;
+export default studioCMSCore;
diff --git a/packages/studiocms_core/src/integration.ts b/packages/studiocms_core/src/integration.ts
deleted file mode 100644
index 923f72dec1..0000000000
--- a/packages/studiocms_core/src/integration.ts
+++ /dev/null
@@ -1,58 +0,0 @@
-import { integrationLogger } from '@matthiesenxyz/integration-utils/astroUtils';
-import type { InjectedType } from 'astro';
-import { createResolver, defineIntegration } from 'astro-integration-kit';
-import { version } from '../package.json';
-import { name } from '../package.json';
-import { StudioCMSOptionsSchema as optionsSchema } from './schemas';
-import { CoreStrings } from './strings';
-import { i18nDTSOutput } from './stubs/i18n-dts';
-import { coreVirtualModuleGeneration } from './utils/coreVirtualModules';
-
-export default defineIntegration({
- name,
- optionsSchema,
- setup({ name, options }) {
- // Declaration for Core DTS File
- let coreDtsFile: InjectedType;
-
- return {
- hooks: {
- 'astro:config:setup': async (params) => {
- // Destructure Params
- const {
- config: {
- root: { pathname: astroConfigPath },
- },
- logger,
- } = params;
-
- // Destruction Options
- const { verbose } = options;
-
- // Create resolver to resolve to the Astro Config
- const { resolve: astroConfigResolved } = createResolver(astroConfigPath);
-
- // Setup Virtual Imports
- integrationLogger({ logger, logLevel: 'info', verbose }, CoreStrings.AddVirtualImports);
- const { dtsFileOutput } = coreVirtualModuleGeneration(params, name, {
- StudioCMSConfig: options,
- currentVersion: version,
- overrides: {
- FormattedDateOverride:
- options.overrides.FormattedDateOverride &&
- astroConfigResolved(options.overrides.FormattedDateOverride),
- },
- });
-
- // Set the DTS File
- coreDtsFile = dtsFileOutput;
- },
- 'astro:config:done': async ({ injectTypes }) => {
- // Inject the DTS File
- injectTypes(coreDtsFile);
- injectTypes(i18nDTSOutput);
- },
- },
- };
- },
-});
diff --git a/packages/studiocms_core/src/lib/configManager.ts b/packages/studiocms_core/src/lib/configManager.ts
deleted file mode 100644
index d11b693f8f..0000000000
--- a/packages/studiocms_core/src/lib/configManager.ts
+++ /dev/null
@@ -1,71 +0,0 @@
-import type { StudioCMSOptions } from '../schemas';
-import { studioErrors } from '../strings';
-
-// This File was created based on Expressive Code's Astro Integration by Hippotastic on github
-// see: https://expressive-code.com/ & https://github.com/expressive-code/expressive-code
-
-/**
- * Returns a URL to the optional StudioCMS config file in the Astro project root.
- */
-export function getStudioConfigFileUrl(projectRootUrl: URL | string) {
- return new URL('./studiocms.config.mjs', projectRootUrl);
-}
-
-/**
- * Attempts to import an StudioCMS config file in the Astro project root and returns its default export.
- *
- * If no config file is found, an empty object is returned.
- */
-export async function loadStudioCMSConfigFile(
- projectRootUrl: URL | string
-): Promise {
- const pathsToTry = [
- // This path works in most scenarios, but not when the integration is processed by Vite
- // due to a Vite bug affecting import URLs using the "file:" protocol
- new URL(`./studiocms.config.mjs?t=${Date.now()}`, projectRootUrl).href,
- ];
- // Detect if the integration is processed by Vite
- if (import.meta.env?.BASE_URL?.length) {
- // Add a fallback path starting with "/", which Vite treats as relative to the project root
- pathsToTry.push(`/studiocms.config.mjs?t=${Date.now()}`);
- }
- /**
- * Checks the error received on attempting to import StudioCMS config file.
- * Bun's choice to throw ResolveMessage for import resolver messages means
- * type comparison (error instanceof Error) isn't portable.
- * @param error Error object, which could be string, Error, or ResolveMessage.
- * @returns object containing message and, if present, error code.
- */
- function coerceError(error: unknown): { message: string; code?: string | undefined } {
- if (typeof error === 'object' && error !== null && 'message' in error) {
- return error as { message: string; code?: string | undefined };
- }
- return { message: error as string };
- }
- for (const path of pathsToTry) {
- try {
- const module = (await import(/* @vite-ignore */ path)) as { default: StudioCMSOptions };
- if (!module.default) {
- throw new Error(studioErrors.invalidOrMissingExport);
- }
- return module.default;
- } catch (error) {
- const { message, code } = coerceError(error);
- // If the config file was not found, continue with the next path (if any)
- if (code === 'ERR_MODULE_NOT_FOUND' || code === 'ERR_LOAD_URL') {
- // Ignore the error only if the config file itself was not found,
- // not if the config file failed to import another module
- if (message.replace(/(imported )?from .*$/, '').includes('studiocms.config.mjs')) continue;
- }
- // If the config file exists, but there was a problem loading it, rethrow the error
- throw new Error(
- `${studioErrors.loadingError} ${code ? `the error ${code}` : 'the following error'}: ${message}`.replace(
- /\s+/g,
- ' '
- ),
- error instanceof Error ? { cause: error } : undefined
- );
- }
- }
- return {} as StudioCMSOptions;
-}
diff --git a/packages/studiocms_core/src/lib/convertDashboardLinksType.ts b/packages/studiocms_core/src/lib/convertDashboardLinksType.ts
deleted file mode 100644
index e5dadf8420..0000000000
--- a/packages/studiocms_core/src/lib/convertDashboardLinksType.ts
+++ /dev/null
@@ -1,82 +0,0 @@
-import { PLUGIN_INTEGRATION_ICON } from '../consts';
-import type { DashboardPageLink, SideBarLink } from '../types';
-
-/**
- * Convert the dashboard links type to the sidebar links type for the StudioCMS Dashboard from a StudioCMS Plugin
- *
- * @param dashboardPageLinks
- * @param pkgname
- * @param pluginLabel
- * @returns The converted sidebar links
- */
-export function convertDashboardLinksType(
- dashboardPageLinks: DashboardPageLink[],
- pkgname: string,
- pluginLabel: string
-): SideBarLink[] {
- const toReturn: SideBarLink[] = [];
-
- const dashboardPageLinksArray: SideBarLink[] = [];
-
- for (const linkItem of dashboardPageLinks) {
- const { type } = linkItem;
-
- // If the type is a regular link
- if (type === 'link') {
- const { icon, label, link, minRole } = linkItem;
-
- dashboardPageLinksArray.push({
- id: `${pkgname}-${label}`,
- href: link,
- text: label,
- minPermissionLevel: minRole,
- icon: icon,
- type: 'link',
- });
- }
-
- // If the type is a dropdown
- if (type === 'dropdown') {
- const { icon, label, link, minRole, type, dropdownChildren } = linkItem;
-
- const DropdownChildren: SideBarLink[] = [];
-
- if (dropdownChildren) {
- for (const childItem of dropdownChildren) {
- const { icon, label, link, minRole, type } = childItem;
-
- DropdownChildren.push({
- id: `${pkgname}-${label}`,
- href: link,
- text: label,
- minPermissionLevel: minRole,
- icon: icon,
- type: type,
- });
- }
- }
-
- dashboardPageLinksArray.push({
- id: `${pkgname}-${label}`,
- href: link,
- text: label,
- minPermissionLevel: minRole,
- icon: icon,
- type: type,
- dropdownItems: DropdownChildren,
- });
- }
- }
-
- toReturn.push({
- id: `${pkgname}-dashboard`,
- href: '',
- text: pluginLabel,
- minPermissionLevel: 'visitor',
- icon: PLUGIN_INTEGRATION_ICON,
- type: 'dropdown',
- dropdownItems: dashboardPageLinksArray,
- });
-
- return toReturn;
-}
diff --git a/packages/studiocms_core/src/lib/head.ts b/packages/studiocms_core/src/lib/head.ts
index ae2f599597..68a3669883 100644
--- a/packages/studiocms_core/src/lib/head.ts
+++ b/packages/studiocms_core/src/lib/head.ts
@@ -2,7 +2,7 @@ import {
type HeadConfig,
HeadConfigSchema,
type HeadUserConfig,
-} from '../schemas/config/defaultFrontend';
+} from '../schemas/config/defaultFrontend.js';
export { HeadConfigSchema };
export type { HeadConfig, HeadUserConfig };
diff --git a/packages/studiocms_core/src/helpers/headDefaults.ts b/packages/studiocms_core/src/lib/headDefaults.ts
similarity index 95%
rename from packages/studiocms_core/src/helpers/headDefaults.ts
rename to packages/studiocms_core/src/lib/headDefaults.ts
index 765e0453b4..331e7a5098 100644
--- a/packages/studiocms_core/src/helpers/headDefaults.ts
+++ b/packages/studiocms_core/src/lib/headDefaults.ts
@@ -1,10 +1,10 @@
import { extname } from 'node:path';
-import version from 'virtual:studiocms/version';
+import version from 'studiocms:version';
import type { AstroGlobalPartial } from 'astro';
-import { AstroError } from 'astro/errors';
import type { z } from 'astro/zod';
import { lookup } from 'mrmime';
-import type { HeadConfigSchema } from '../schemas/config/defaultFrontend';
+import { StudioCMSCoreError } from '../errors.js';
+import type { HeadConfigSchema } from '../schemas/config/defaultFrontend.js';
type faviconTypeMap = '.ico' | '.gif' | '.jpeg' | '.jpg' | '.png' | '.svg';
const faviconTypes: faviconTypeMap[] = ['.ico', '.gif', '.jpeg', '.jpg', '.png', '.svg'];
@@ -23,7 +23,7 @@ const makeFavicon = (favicon: string) => {
const faviconType = lookup(ext);
return { href: faviconHref, type: faviconType };
}
- throw new AstroError(
+ throw new StudioCMSCoreError(
`Unsupported favicon extension: ${ext}`,
`The favicon must be one of the following types: ${faviconTypes.join(', ')}`
);
diff --git a/packages/studiocms_core/src/lib/index.ts b/packages/studiocms_core/src/lib/index.ts
index 3a49ef8f8f..19f9b91090 100644
--- a/packages/studiocms_core/src/lib/index.ts
+++ b/packages/studiocms_core/src/lib/index.ts
@@ -1,6 +1,7 @@
-export * from './pluginSystem';
-export * from './configManager';
-export * from './defineStudioCMSConfig';
-export * from './jsonUtils';
-export * from './head';
-export * from './removeLeadingTrailingSlashes';
+export * from './head.js';
+export * from './jsonUtils.js';
+export * from './pathGenerators.js';
+export * from './removeLeadingTrailingSlashes.js';
+export * from './urlGen.js';
+export * from './makeAPIRoute.js';
+export * from './makePublicRoute.js';
diff --git a/packages/studiocms_core/src/lib/makeAPIRoute.ts b/packages/studiocms_core/src/lib/makeAPIRoute.ts
new file mode 100644
index 0000000000..fb1d385450
--- /dev/null
+++ b/packages/studiocms_core/src/lib/makeAPIRoute.ts
@@ -0,0 +1,5 @@
+export function makeAPIRoute(path: string) {
+ return function api(route: string) {
+ return `/studiocms_api/${path}/${route}`;
+ };
+}
diff --git a/packages/studiocms_core/src/lib/makePublicRoute.ts b/packages/studiocms_core/src/lib/makePublicRoute.ts
new file mode 100644
index 0000000000..04fc6226c3
--- /dev/null
+++ b/packages/studiocms_core/src/lib/makePublicRoute.ts
@@ -0,0 +1,3 @@
+export function makePublicRoute(route: string) {
+ return `public/studiocms-resources/${route}/`;
+}
diff --git a/packages/studiocms_core/src/helpers/pathGenerators.ts b/packages/studiocms_core/src/lib/pathGenerators.ts
similarity index 55%
rename from packages/studiocms_core/src/helpers/pathGenerators.ts
rename to packages/studiocms_core/src/lib/pathGenerators.ts
index 072dce8a9e..1849170ae6 100644
--- a/packages/studiocms_core/src/helpers/pathGenerators.ts
+++ b/packages/studiocms_core/src/lib/pathGenerators.ts
@@ -1,60 +1,58 @@
-const base = stripTrailingSlash(import.meta.env.BASE_URL);
-
/** Get the a root-relative URL path with the site’s `base` prefixed. */
export function pathWithBase(path: string) {
- let newpath = path;
- newpath = stripLeadingSlash(newpath);
- return newpath ? `${base}/${newpath}` : `${base}/`;
+ let newPath = path;
+ newPath = stripLeadingSlash(newPath);
+ return newPath ? `/${newPath}` : '/';
}
/** Get the a root-relative file URL path with the site’s `base` prefixed. */
export function fileWithBase(path: string) {
- let newpath = path;
- newpath = stripLeadingSlash(newpath);
- return newpath ? `${base}/${newpath}` : base;
+ let newPath = path;
+ newPath = stripLeadingSlash(newPath);
+ return newPath ? `/${newPath}` : '/';
}
/** Ensure the passed path starts with a leading slash. */
export function ensureLeadingSlash(href: string): string {
- let newhref = href;
- if (newhref[0] !== '/') newhref = `/${newhref}`;
- return newhref;
+ let newHref = href;
+ if (newHref[0] !== '/') newHref = `/${newHref}`;
+ return newHref;
}
/** Ensure the passed path ends with a trailing slash. */
export function ensureTrailingSlash(href: string): string {
- let newhref = href;
- if (newhref[newhref.length - 1] !== '/') newhref += '/';
- return newhref;
+ let newHref = href;
+ if (newHref[newHref.length - 1] !== '/') newHref += '/';
+ return newHref;
}
/** Ensure the passed path starts and ends with slashes. */
export function ensureLeadingAndTrailingSlashes(href: string): string {
- let newhref = href;
- newhref = ensureLeadingSlash(newhref);
- newhref = ensureTrailingSlash(newhref);
- return newhref;
+ let newHref = href;
+ newHref = ensureLeadingSlash(newHref);
+ newHref = ensureTrailingSlash(newHref);
+ return newHref;
}
/** Ensure the passed path does not start with a leading slash. */
export function stripLeadingSlash(href: string) {
- let newhref = href;
- if (newhref[0] === '/') newhref = newhref.slice(1);
- return newhref;
+ let newHref = href;
+ if (newHref[0] === '/') newHref = newHref.slice(1);
+ return newHref;
}
/** Ensure the passed path does not end with a trailing slash. */
export function stripTrailingSlash(href: string) {
- let newhref = href;
- if (newhref[newhref.length - 1] === '/') newhref = newhref.slice(0, -1);
- return newhref;
+ let newHref = href;
+ if (newHref[newHref.length - 1] === '/') newHref = newHref.slice(0, -1);
+ return newHref;
}
/** Ensure the passed path does not start and end with slashes. */
export function stripLeadingAndTrailingSlashes(href: string): string {
- let newhref = href;
- newhref = stripLeadingSlash(newhref);
- newhref = stripTrailingSlash(newhref);
- return newhref;
+ let newHref = href;
+ newHref = stripLeadingSlash(newHref);
+ newHref = stripTrailingSlash(newHref);
+ return newHref;
}
/** Remove the extension from a path. */
@@ -65,10 +63,10 @@ export function stripHtmlExtension(path: string) {
/** Add '.html' extension to a path. */
export function ensureHtmlExtension(path: string) {
- let newpath = path;
- newpath = stripLeadingAndTrailingSlashes(path);
- if (!newpath.endsWith('.html')) {
- newpath = path ? `${path}.html` : '/index.html';
+ let newPath = path;
+ newPath = stripLeadingAndTrailingSlashes(path);
+ if (!newPath.endsWith('.html')) {
+ newPath = path ? `${path}.html` : '/index.html';
}
- return ensureLeadingSlash(newpath);
+ return ensureLeadingSlash(newPath);
}
diff --git a/packages/studiocms_core/src/lib/pluginSystem.ts b/packages/studiocms_core/src/lib/pluginSystem.ts
deleted file mode 100644
index 1af1692046..0000000000
--- a/packages/studiocms_core/src/lib/pluginSystem.ts
+++ /dev/null
@@ -1,77 +0,0 @@
-import type { SideBarLink, StudioCMSPluginOptions } from '../types';
-import { convertDashboardLinksType } from './convertDashboardLinksType';
-
-/**
- * # Define StudioCMS Plugin
- *
- * Register a StudioCMS Plugin with the StudioCMS Core.
- *
- * @param options.pkgname {string} - The Package Name of the Plugin
- * @param options.opts.pluginLabel {string} - The Label for the Plugin
- * @param options.opts.navigationLinks Array<{ text: string, slug: string }> - The Navigation Links for the Plugin
- * @param options.opts.customRendererPluginPath { string } - The Custom Renderer Plugin Path - This is used to replace the built-in Markdown Renderer. Recommended for Advanced Users.
- */
-export function defineStudioCMSPlugin(options: StudioCMSPluginOptions) {
- // Extract the options
- const { pkgname, opts } = options;
- const { pluginLabel, navigationLinks, customRendererPluginPath, dashboardPageLinks } = opts;
-
- // Add the plugin to the StudioCMS Plugin List
- studioCMSPluginList.set(pkgname, { name: pkgname, label: pluginLabel });
-
- // Add the navigation links to the External Navigation Map
- if (navigationLinks) {
- for (const link of navigationLinks) {
- externalNavigation.set(`${pkgname}:${link.slug}`, { text: link.text, slug: link.slug });
- }
- }
-
- // Add the custom Dashboard pages to the Dashboard Page Links
- if (dashboardPageLinks) {
- // Convert the Dashboard Page Links to the SideBarLink type
- const DashboardPluginLinkList = convertDashboardLinksType(
- dashboardPageLinks,
- pkgname,
- pluginLabel
- );
-
- // Add the Dashboard Page Links to the Dashboard Page Links Map
- dashboardPageLinksMap.set(pkgname, DashboardPluginLinkList);
- }
-
- // Add the custom renderer plugin path to the Custom Renderer Plugin Set
- if (customRendererPluginPath) {
- customRendererPlugin.add(customRendererPluginPath);
- }
-}
-
-/**
- * # StudioCMSPluginList
- *
- * A Map of StudioCMS Plugins used to register with the StudioCMS Core.
- */
-export const studioCMSPluginList = new Map();
-
-/**
- * # External Navigation
- *
- * A Map of External Navigation Links used to register with the StudioCMS Core for usage on the Front-end Navigation bar.
- */
-export const externalNavigation = new Map();
-
-/**
- * # Dashboard Page Links Map
- *
- * A map of dashboard page links used to register with the StudioCMS Core for usage on the dashboard sidebar for displaying custom plugin pages.
- */
-export const dashboardPageLinksMap = new Map();
-
-/**
- * # Custom Renderer Plugin
- *
- * A Set of Custom Renderer Plugins used to register with the StudioCMS Core to replace the built in Markdown renderer.
- *
- * Note: This may require additional setup and configuration to work properly.
- * ## Deprecated This feature has been moved to the StudioCMS Renderer Configuration.
- */
-export const customRendererPlugin = new Set();
diff --git a/packages/studiocms_core/src/lib/routeMap.ts b/packages/studiocms_core/src/lib/routeMap.ts
new file mode 100644
index 0000000000..c61208de3a
--- /dev/null
+++ b/packages/studiocms_core/src/lib/routeMap.ts
@@ -0,0 +1,167 @@
+import { dashboardConfig } from 'studiocms:config';
+// import { dashboardPageLinks } from 'virtual:studiocms/pluginSystem';
+import type { SideBarLink } from '../schemas/index.js';
+import { makeAPIRoute } from './makeAPIRoute.js';
+import urlGenFactory from './urlGen.js';
+
+const { dashboardRouteOverride } = dashboardConfig;
+
+export function getSluggedRoute(url: string, slug: string): string {
+ return urlGenFactory(true, url + slug, dashboardRouteOverride);
+}
+
+export function getEditRoute(slug: string): string {
+ return getSluggedRoute('edit/pages/', slug);
+}
+
+export function getDeleteRoute(slug: string): string {
+ return getSluggedRoute('delete/pages/', slug);
+}
+
+export function makeNonDashboardRoute(route?: string | undefined): string {
+ return urlGenFactory(false, route);
+}
+
+export function makeDashboardRoute(route?: string | undefined): string {
+ return urlGenFactory(true, route, dashboardRouteOverride);
+}
+
+const authAPIRoute = makeAPIRoute('auth');
+const dashboardAPIRoute = makeAPIRoute('dashboard');
+const sdkRoute = makeAPIRoute('sdk');
+
+export const StudioCMSRoutes = {
+ mainLinks: {
+ baseSiteURL: makeNonDashboardRoute(),
+ dashboardIndex: makeDashboardRoute(),
+ userProfile: makeDashboardRoute('profile'),
+ contentManagement: makeDashboardRoute('content-management'),
+ contentManagementCreate: makeDashboardRoute('content-management/create'),
+ contentManagementEdit: makeDashboardRoute('content-management/edit'),
+ contentManagementFolderCreate: makeDashboardRoute('content-management/create-folder'),
+ contentManagementFolderEdit: makeDashboardRoute('content-management/edit-folder'),
+ createPage: makeDashboardRoute('create-page'),
+ siteConfiguration: makeDashboardRoute('configuration'),
+ userManagement: makeDashboardRoute('user-management'),
+ userManagementEdit: makeDashboardRoute('user-management/edit'),
+ },
+ authLinks: {
+ loginURL: makeDashboardRoute('login'),
+ logoutURL: makeDashboardRoute('logout'),
+ signupURL: makeDashboardRoute('signup'),
+ loginAPI: authAPIRoute('login'),
+ logoutAPI: authAPIRoute('logout'),
+ registerAPI: authAPIRoute('register'),
+ githubIndex: authAPIRoute('github'),
+ githubCallback: authAPIRoute('github/callback'),
+ discordIndex: authAPIRoute('discord'),
+ discordCallback: authAPIRoute('discord/callback'),
+ googleIndex: authAPIRoute('google'),
+ googleCallback: authAPIRoute('google/callback'),
+ auth0Index: authAPIRoute('auth0'),
+ auth0Callback: authAPIRoute('auth0/callback'),
+ },
+ endpointLinks: {
+ searchList: dashboardAPIRoute('search-list'),
+ partials: {
+ livePreviewBox: dashboardAPIRoute('live-render'),
+ userListItems: dashboardAPIRoute('user-list-items'),
+ },
+ config: dashboardAPIRoute('config'),
+ users: dashboardAPIRoute('users'),
+ profile: dashboardAPIRoute('profile'),
+ createResetLink: dashboardAPIRoute('create-reset-link'),
+ resetPassword: dashboardAPIRoute('reset-password'),
+ content: {
+ page: dashboardAPIRoute('content/page'),
+ folder: dashboardAPIRoute('content/folder'),
+ },
+ },
+ sdk: {
+ pages: sdkRoute('list-pages'),
+ fallback_pages: sdkRoute('fallback-list-pages.json'),
+ updateLatestVersionCache: sdkRoute('update-latest-version-cache'),
+ },
+};
+
+// Add default dashboard page links
+const defaultDashboardPageLinks: SideBarLink[] = [
+ {
+ id: 'home',
+ href: StudioCMSRoutes.mainLinks.baseSiteURL,
+ text: 'View Site',
+ minPermissionLevel: 'unknown',
+ icon: 'globe-alt',
+ },
+ {
+ id: 'dashboard',
+ href: StudioCMSRoutes.mainLinks.dashboardIndex,
+ text: 'Dashboard',
+ minPermissionLevel: 'visitor',
+ icon: 'home',
+ },
+ {
+ id: 'profile',
+ href: StudioCMSRoutes.mainLinks.userProfile,
+ text: 'User Profile',
+ minPermissionLevel: 'visitor',
+ icon: 'user',
+ },
+ {
+ id: 'content-management',
+ href: StudioCMSRoutes.mainLinks.contentManagement,
+ text: 'Content Management',
+ minPermissionLevel: 'editor',
+ icon: 'plus',
+ },
+ {
+ id: 'edit-pages',
+ href: StudioCMSRoutes.mainLinks.createPage,
+ text: 'Create Page',
+ minPermissionLevel: 'editor',
+ icon: 'pencil-square',
+ },
+ {
+ id: 'site-config',
+ href: StudioCMSRoutes.mainLinks.siteConfiguration,
+ text: 'Site Configuration',
+ minPermissionLevel: 'admin',
+ icon: 'cog-6-tooth',
+ },
+ {
+ id: 'user-management',
+ href: StudioCMSRoutes.mainLinks.userManagement,
+ text: 'User Management',
+ minPermissionLevel: 'admin',
+ icon: 'cog-6-tooth',
+ },
+];
+
+// Side bar links map
+const finalSideBarLinkMap: SideBarLink[] = [...defaultDashboardPageLinks];
+
+export const sideBarLinkMap: SideBarLink[] = finalSideBarLinkMap;
+
+// // Add custom dashboard page links
+// const customDashboardPageLinks: SideBarLink[] = [];
+
+// const customDashboardRoutes = Array.from(dashboardPageLinks.values());
+
+// for (const links of customDashboardRoutes) {
+// customDashboardPageLinks.push(...links);
+// }
+
+// const customDashboardDropdown = {
+// id: 'integrations',
+// href: '',
+// text: 'Integration Configs',
+// minPermissionLevel: 'editor',
+// icon: 'question-mark-circle',
+// type: 'dropdown',
+// dropdownItems: customDashboardPageLinks,
+// } satisfies SideBarLink;
+
+// Merge custom dashboard page links
+// if (customDashboardDropdown.dropdownItems.length > 0) {
+// finalSideBarLinkMap.push(customDashboardDropdown);
+// }
diff --git a/packages/studiocms_core/src/helpers/urlGen.ts b/packages/studiocms_core/src/lib/urlGen.ts
similarity index 78%
rename from packages/studiocms_core/src/helpers/urlGen.ts
rename to packages/studiocms_core/src/lib/urlGen.ts
index a2e258aa5b..3212cfb3d7 100644
--- a/packages/studiocms_core/src/helpers/urlGen.ts
+++ b/packages/studiocms_core/src/lib/urlGen.ts
@@ -1,5 +1,5 @@
-import { removeLeadingTrailingSlashes } from '../lib/removeLeadingTrailingSlashes';
-import { pathWithBase } from './pathGenerators';
+import { pathWithBase } from './pathGenerators.js';
+import { removeLeadingTrailingSlashes } from './removeLeadingTrailingSlashes.js';
/**
* # urlGenFactory Helper Function
@@ -11,11 +11,11 @@ import { pathWithBase } from './pathGenerators';
* @param DashboardRouteOverride
* @returns
*/
-export default async function urlGenFactory(
+export default function urlGenFactory(
isDashboardRoute: boolean,
path: string | undefined,
DashboardRouteOverride?: string
-): Promise {
+): string {
let url: string;
let dashboardRoute = 'dashboard';
diff --git a/packages/studiocms_core/src/routes/fallback-list-pages.json.ts b/packages/studiocms_core/src/routes/fallback-list-pages.json.ts
new file mode 100644
index 0000000000..8ad4af65bb
--- /dev/null
+++ b/packages/studiocms_core/src/routes/fallback-list-pages.json.ts
@@ -0,0 +1,17 @@
+import studioCMS_SDK from 'studiocms:sdk';
+import type { APIRoute } from 'astro';
+
+export const GET: APIRoute = async (): Promise => {
+ const pages = await studioCMS_SDK.GET.database.pages();
+
+ const lastUpdated = new Date().toISOString();
+
+ return new Response(JSON.stringify({ lastUpdated, pages }, null, 2), {
+ headers: {
+ 'Content-Type': 'application/json',
+ 'ACCESS-CONTROL-ALLOW-ORIGIN': '*',
+ 'Cache-Control': 'public, max-age=604800, immutable',
+ Date: lastUpdated,
+ },
+ });
+};
diff --git a/packages/studiocms_core/src/routes/full-changelog.json.ts b/packages/studiocms_core/src/routes/full-changelog.json.ts
new file mode 100644
index 0000000000..648bec39a1
--- /dev/null
+++ b/packages/studiocms_core/src/routes/full-changelog.json.ts
@@ -0,0 +1,214 @@
+import contentRenderer from 'studiocms:renderer/current';
+import type { APIRoute } from 'astro';
+import { HTMLString } from 'astro/runtime/server/index.js';
+import type { List, Root } from 'mdast';
+import { fromMarkdown } from 'mdast-util-from-markdown';
+import { toMarkdown } from 'mdast-util-to-markdown';
+import { toString as ToString } from 'mdast-util-to-string';
+import { visit } from 'unist-util-visit';
+
+export type Changelog = {
+ packageName: string;
+ versions: Version[];
+};
+
+export type Version = {
+ version: string;
+ changes: { [key in SemverCategory]: List };
+ includes: Set;
+};
+
+export const semverCategories = ['major', 'minor', 'patch'] as const;
+export type SemverCategory = (typeof semverCategories)[number];
+
+function parsePackageReference(str: string) {
+ const matches = str.match(/^([@/a-z0-9-]+)@([0-9.]+)$/);
+ if (!matches) return;
+ const [, packageName, version] = matches;
+ return { packageName, version };
+}
+
+export const GET: APIRoute = async () => {
+ const Changelog = await fetch(
+ 'https://raw.githubusercontent.com/withstudiocms/studiocms/refs/heads/main/packages/studiocms/CHANGELOG.md'
+ );
+
+ const ChangelogText = await Changelog.text();
+
+ if (ChangelogText) {
+ let markdown = ChangelogText;
+
+ // Convert GitHub usernames in "Thanks ..." sentences to links
+ markdown = markdown.replace(
+ /(?<=Thank[^.!]*? )@([a-z0-9-]+)(?=[\s,.!])/gi,
+ '[@$1](https://github.com/$1)'
+ );
+
+ const astStart = fromMarkdown(markdown);
+
+ const changelog: Changelog = {
+ packageName: '',
+ versions: [],
+ };
+
+ type ParserState = 'packageName' | 'version' | 'semverCategory' | 'changes';
+ let state: ParserState = 'packageName';
+ let version: Version | undefined;
+ let semverCategory: SemverCategory | undefined;
+
+ function handleNode(node: ReturnType['children'][number]) {
+ if (node.type === 'heading') {
+ if (node.depth === 1) {
+ if (state !== 'packageName') throw new Error('Unexpected h1');
+ changelog.packageName = ToString(node);
+ state = 'version';
+ return;
+ }
+ if (node.depth === 2) {
+ if (state === 'packageName') throw new Error('Unexpected h2');
+ version = {
+ version: ToString(node),
+ changes: {
+ major: { type: 'list', children: [] },
+ minor: { type: 'list', children: [] },
+ patch: { type: 'list', children: [] },
+ },
+ includes: new Set(),
+ };
+ changelog.versions.push(version);
+ state = 'semverCategory';
+ return;
+ }
+ if (node.depth === 3) {
+ if (state === 'packageName' || state === 'version') throw new Error('Unexpected h3');
+ semverCategory = (ToString(node).split(' ')[0] || '').toLowerCase() as SemverCategory;
+ if (!semverCategories.includes(semverCategory))
+ throw new Error(`Unexpected semver category: ${semverCategory}`);
+ state = 'changes';
+ return;
+ }
+ }
+ if (node.type === 'list') {
+ if (state !== 'changes' || !version || !semverCategory) throw new Error('Unexpected list');
+ // Go through list items
+ for (let listItemIdx = 0; listItemIdx < node.children.length; listItemIdx++) {
+ const listItem = node.children[listItemIdx];
+ if (!listItem) continue;
+
+ // Check if the current list item ends with a nested sublist that consists
+ // of items matching the pattern `@`
+ const lastChild = listItem.children[listItem.children.length - 1];
+ if (lastChild?.type === 'list') {
+ const packageRefs: string[] = [];
+ // biome-ignore lint/complexity/noForEach:
+ lastChild.children.forEach((subListItem) => {
+ const text = ToString(subListItem);
+ if (parsePackageReference(text)) packageRefs.push(text);
+ });
+ if (packageRefs.length === lastChild.children.length) {
+ // If so, add the packages to `includes`
+ for (const packageRef of packageRefs) {
+ version.includes.add(packageRef);
+ }
+ // Remove the sub-list from the list item
+ listItem.children.pop();
+ }
+ }
+
+ const firstPara =
+ listItem.children[0]?.type === 'paragraph' ? listItem.children[0] : undefined;
+ if (firstPara) {
+ // Remove IDs like `bfed62a: ...` or `... [85dbab8]` from the first paragraph
+ visit(firstPara, 'text', (textNode) => {
+ textNode.value = textNode.value.replace(/(^[0-9a-f]{7,}: | \[[0-9a-f]{7,}\]$)/, '');
+ });
+ // Skip list items that only contain the text `Updated dependencies`
+ const firstParaText = ToString(firstPara);
+ if (firstParaText === 'Updated dependencies') continue;
+ // If the list item is a package reference, add it to `includes` instead
+ const packageRef = parsePackageReference(firstParaText);
+ if (packageRef) {
+ version.includes.add(firstParaText);
+ continue;
+ }
+ // Add the list item to the changes
+ version.changes[semverCategory].children.push(listItem);
+ }
+ }
+ return;
+ }
+ throw new Error(`Unexpected node: ${JSON.stringify(node)}`);
+ }
+
+ // biome-ignore lint/complexity/noForEach:
+ astStart.children.forEach((node) => {
+ handleNode(node);
+ });
+
+ const ToProcess = changelog;
+
+ 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);
+ }
+
+ output.push(toMarkdown(astEnd, { bullet: '-' }));
+
+ const markdownString = output.join('\n');
+
+ const renderedContent = await contentRenderer(markdownString);
+
+ return new Response(
+ JSON.stringify({ success: true, changelog: new HTMLString(renderedContent) }),
+ {
+ status: 200,
+ headers: {
+ 'Content-Type': 'application/json',
+ Date: new Date().toUTCString(),
+ },
+ }
+ );
+ }
+
+ return new Response(JSON.stringify({ success: false, error: 'Error fetching changelog' }), {
+ status: 500,
+ headers: {
+ 'Content-Type': 'application/json',
+ Date: new Date().toUTCString(),
+ },
+ });
+};
diff --git a/packages/studiocms_core/src/routes/list-pages.ts b/packages/studiocms_core/src/routes/list-pages.ts
new file mode 100644
index 0000000000..b007ecaf78
--- /dev/null
+++ b/packages/studiocms_core/src/routes/list-pages.ts
@@ -0,0 +1,36 @@
+import studioCMS_SDK_Cache from 'studiocms:sdk/cache';
+import type { APIRoute } from 'astro';
+
+export const GET: APIRoute = async (): Promise => {
+ const pages = await studioCMS_SDK_Cache.GET.pages();
+
+ // last updated date
+ const lastUpdated = new Date().toISOString();
+
+ return new Response(JSON.stringify({ lastUpdated, pages }, null, 2), {
+ headers: {
+ 'Content-Type': 'application/json',
+ 'ACCESS-CONTROL-ALLOW-ORIGIN': '*',
+ Date: lastUpdated,
+ },
+ });
+};
+
+export const OPTIONS: APIRoute = async () => {
+ return new Response(null, {
+ status: 204,
+ statusText: 'No Content',
+ headers: {
+ Allow: 'OPTIONS, GET',
+ 'Cache-Control': 'public, max-age=604800, immutable',
+ Date: new Date().toUTCString(),
+ },
+ });
+};
+
+export const ALL: APIRoute = async () => {
+ return new Response(null, {
+ status: 405,
+ statusText: 'Method Not Allowed',
+ });
+};
diff --git a/packages/studiocms_core/src/routes/update-latest-version-cache.ts b/packages/studiocms_core/src/routes/update-latest-version-cache.ts
new file mode 100644
index 0000000000..8e797d15a3
--- /dev/null
+++ b/packages/studiocms_core/src/routes/update-latest-version-cache.ts
@@ -0,0 +1,46 @@
+// @ts-ignore
+import { logger } from '@it-astro:logger:studiocms-dashboard';
+import studioCMS_SDK_Cache from 'studiocms:sdk/cache';
+import type { APIRoute } from 'astro';
+
+export const GET: APIRoute = async (): Promise => {
+ const latestVersion = await studioCMS_SDK_Cache.UPDATE.latestVersion().catch((err) => {
+ logger.error(`Error updating latest version cache: ${err}`);
+ return new Response(JSON.stringify({ success: false, error: err }), {
+ status: 500,
+ headers: {
+ 'Content-Type': 'application/json',
+ Date: new Date().toUTCString(),
+ },
+ });
+ });
+
+ logger.info(`Latest version cache updated: ${latestVersion}`);
+
+ return new Response(JSON.stringify({ success: true, latestVersion }), {
+ status: 200,
+ headers: {
+ 'Content-Type': 'application/json',
+ Date: new Date().toUTCString(),
+ },
+ });
+};
+
+export const OPTIONS: APIRoute = async () => {
+ return new Response(null, {
+ status: 204,
+ statusText: 'No Content',
+ headers: {
+ Allow: 'OPTIONS, GET',
+ 'Cache-Control': 'public, max-age=604800, immutable',
+ Date: new Date().toUTCString(),
+ },
+ });
+};
+
+export const ALL: APIRoute = async () => {
+ return new Response(null, {
+ status: 405,
+ statusText: 'Method Not Allowed',
+ });
+};
diff --git a/packages/studiocms_core/src/schemas/config/auth.ts b/packages/studiocms_core/src/schemas/config/auth.ts
index 40c76738c7..ae6ede594a 100644
--- a/packages/studiocms_core/src/schemas/config/auth.ts
+++ b/packages/studiocms_core/src/schemas/config/auth.ts
@@ -7,7 +7,7 @@ const localUsernameAndPasswordConfig = z
*
* @default false
*/
- allowUserRegistration: z.boolean().optional().default(false),
+ allowUserRegistration: z.boolean().optional().default(true),
})
.optional()
.default({});
@@ -22,9 +22,9 @@ export const authProviderSchema = z
*
* Requires a GitHub OAuth App to be created and configured using ENV Variables
*
- * @default true
+ * @default false
*/
- github: z.boolean().optional().default(true),
+ github: z.boolean().optional().default(false),
/**
* Discord Auth Provider - Powered by Arctic
*
diff --git a/packages/studiocms_core/src/schemas/config/dashboard.ts b/packages/studiocms_core/src/schemas/config/dashboard.ts
index 910be79c1d..4835fd7d9c 100644
--- a/packages/studiocms_core/src/schemas/config/dashboard.ts
+++ b/packages/studiocms_core/src/schemas/config/dashboard.ts
@@ -1,7 +1,6 @@
import { z } from 'astro/zod';
-import { authConfigSchema } from './auth';
-import { developerConfigSchema } from './developer';
-import { unocssConfigSchema } from './unocss';
+import { authConfigSchema } from './auth.js';
+import { developerConfigSchema } from './developer.js';
export const dashboardConfigSchema = z
.object({
@@ -11,6 +10,20 @@ export const dashboardConfigSchema = z
* @default true
*/
dashboardEnabled: z.boolean().optional().default(true),
+ // /**
+ // * This allows the user when in `output: "server"` mode with Astro to enable or disable the prerendering of the dashboard
+ // *
+ // * **Note: This is only applicable when using Astro in server mode in static(hybrid) mode, this will be `true`**
+ // *
+ // * @default true
+ // */
+ // prerender: z.boolean().optional().default(true),
+ /**
+ * OPTIONAL - This allows the user to enable or disable the default 404 route for the dashboard
+ *
+ * @default true
+ */
+ inject404Route: z.boolean().optional().default(true),
/**
* OPTIONAL - This allows the user to override the default Favicon URL to a custom URL
*/
@@ -29,18 +42,19 @@ export const dashboardConfigSchema = z
* Auth Configuration - Allows customization of the Authentication Configuration
*/
AuthConfig: authConfigSchema,
- /**
- * UnoCSS Configuration - Allows customization of the UnoCSS Configuration
- *
- * **Note: Use with caution, this is an advanced feature**
- *
- * StudioCMS uses UnoCSS+DaisyUI to provide a TailwindCSS-like experience with minimal CSS+prebuilt theme options!. This configuration allows you to override the default configuration.
- */
- UnoCSSConfigOverride: unocssConfigSchema,
/**
* Developer Options/Configuration
*/
developerConfig: developerConfigSchema,
+ /**
+ * OPTIONAL - This allows the user to enable or disable the version check for the dashboard
+ *
+ * This will check for the latest version of StudioCMS and notify the user
+ * if there is a new version available.
+ *
+ * @default true
+ */
+ versionCheck: z.boolean().optional().default(true),
})
.optional()
.default({});
diff --git a/packages/studiocms_core/src/schemas/config/defaultFrontend.ts b/packages/studiocms_core/src/schemas/config/defaultFrontend.ts
index dc981ee289..48aa59ed66 100644
--- a/packages/studiocms_core/src/schemas/config/defaultFrontend.ts
+++ b/packages/studiocms_core/src/schemas/config/defaultFrontend.ts
@@ -31,7 +31,7 @@ function isFaviconExt(ext: string): ext is keyof typeof faviconTypeMap {
export type HeadUserConfig = z.input>;
export type HeadConfig = z.output>;
-export const DefaultFrontEndConfigSchema = z
+export const FrontEndConfigSchema = z
.object({
/**
* Inject Default Routes - Injects the default routes for the StudioCMS Frontend
@@ -41,6 +41,8 @@ export const DefaultFrontEndConfigSchema = z
/**
* Inject 404 Route - Injects a 404 route for handling unknown routes
* @default true
+ *
+ * @deprecated Moved to dashboardConfig
*/
inject404Route: z.boolean().optional().default(true),
/**
@@ -75,3 +77,8 @@ export const DefaultFrontEndConfigSchema = z
})
.optional()
.default({});
+
+export const DefaultFrontEndConfigSchema = z
+ .union([FrontEndConfigSchema, z.boolean()])
+ .optional()
+ .default({});
diff --git a/packages/studiocms_core/src/schemas/config/developer.ts b/packages/studiocms_core/src/schemas/config/developer.ts
index 8e67408126..37169101b6 100644
--- a/packages/studiocms_core/src/schemas/config/developer.ts
+++ b/packages/studiocms_core/src/schemas/config/developer.ts
@@ -2,14 +2,6 @@ import { z } from 'astro/zod';
export const developerConfigSchema = z
.object({
- /**
- * Zero-JavaScript View Transitions
- *
- * Chrome 126 (released last week) and Microsoft Edge 126 (releasing this week) both support “cross-document view transitions” unlocking zero-JavaScript view transitions in Astro.
- *
- * @see https://astro.build/blog/future-of-astro-zero-js-view-transitions/
- */
- viewTransitionAPI: z.boolean().optional().default(false),
/**
* Enable Testing and Demo Mode
*
diff --git a/packages/studiocms_core/src/schemas/config/index.ts b/packages/studiocms_core/src/schemas/config/index.ts
index d689ec5e5e..9785461e0e 100644
--- a/packages/studiocms_core/src/schemas/config/index.ts
+++ b/packages/studiocms_core/src/schemas/config/index.ts
@@ -1,21 +1,24 @@
import { z } from 'astro/zod';
-import { overridesSchema } from './componentoverrides';
-import { dashboardConfigSchema } from './dashboard';
-import { DefaultFrontEndConfigSchema } from './defaultFrontend';
-import { imageServiceSchema } from './imageService';
-import { includedIntegrationsSchema } from './integrations';
+import type { StudioCMSPlugin } from '../plugins/index.js';
+import { overridesSchema } from './componentoverrides.js';
+import { dashboardConfigSchema } from './dashboard.js';
+import { DefaultFrontEndConfigSchema, FrontEndConfigSchema } from './defaultFrontend.js';
+import { imageServiceSchema } from './imageService.js';
+import { includedIntegrationsSchema } from './integrations.js';
import {
type CustomRenderer,
type Renderer,
type StudioCMSRendererConfig,
StudioCMSRendererConfigSchema,
-} from './rendererConfig';
+} from './rendererConfig.js';
+import { SDKSchema } from './sdk.js';
//
// Exported Schemas for use in other internal packages
//
export {
StudioCMSRendererConfigSchema,
+ FrontEndConfigSchema,
type StudioCMSRendererConfig,
type CustomRenderer,
type Renderer,
@@ -45,12 +48,14 @@ export const StudioCMSOptionsSchema = z
imageService: imageServiceSchema,
/**
* Default Frontend Configuration
+ *
+ * Allows customization of the default frontend configuration
+ *
+ * @default true
*/
defaultFrontEndConfig: DefaultFrontEndConfigSchema,
/**
* Allows customization of the Dashboard Configuration
- *
- * Coming soon....
*/
dashboardConfig: dashboardConfigSchema,
/**
@@ -61,6 +66,14 @@ export const StudioCMSOptionsSchema = z
* Date Locale used for formatting dates
*/
dateLocale: z.string().optional().default('en-us'),
+ /**
+ * DateTime Format Options
+ */
+ dateTimeFormat: z.custom().optional().default({
+ year: 'numeric',
+ month: 'short',
+ day: 'numeric',
+ }),
/**
* Component Overrides - Allows for customizing the components used in StudioCMS
*/
@@ -70,6 +83,21 @@ export const StudioCMSOptionsSchema = z
* @default false
*/
verbose: z.boolean().optional().default(false),
+ /**
+ * Add Plugins to the StudioCMS
+ */
+ plugins: z.custom().optional(),
+ /**
+ * SDKSchema is a Zod schema that validates the SDK configuration.
+ * It can either be a boolean or an object containing cache configuration.
+ *
+ * If it is a boolean, it defaults to `true` and transforms into an object
+ * with default cache configuration.
+ *
+ * If it is an object, it must contain the `cacheConfig` property which is
+ * validated by the `SDKCacheSchema`.
+ */
+ sdk: SDKSchema,
})
.optional()
.default({});
diff --git a/packages/studiocms_core/src/schemas/config/integrations.ts b/packages/studiocms_core/src/schemas/config/integrations.ts
index cf289b5b41..92d57a7a2f 100644
--- a/packages/studiocms_core/src/schemas/config/integrations.ts
+++ b/packages/studiocms_core/src/schemas/config/integrations.ts
@@ -1,4 +1,4 @@
-import type { RobotsConfig } from '@studiocms/robotstxt';
+import type { RobotsConfig } from '@studiocms/robotstxt/types';
import { z } from 'astro/zod';
//
@@ -9,19 +9,9 @@ export const includedIntegrationsSchema = z
/**
* Allows the user to enable/disable the use of the StudioCMS Custom `astro-robots-txt` Integration
*
- * @default true
+ * @default robotsTXT: { policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'] } ] }
*/
- useAstroRobots: z.boolean().optional().default(true),
- astroRobotsConfig: z.custom().default({}),
- /**
- * Allows the user to enable/disable the use of the Inox-tools Sitemap Plugin
- * For more information on the Inox-tools Sitemap Plugin, visit:
- * @see https://inox-tools.vercel.app/sitemap-ext
- *
- * # TEMPORARILY DISABLED
- * If you would like to still use the Inox-tools Sitemap Plugin, you can manually add it to your project's Integrations.
- */
- useInoxSitemap: z.boolean().optional().default(true),
+ robotsTXT: z.union([z.custom(), z.boolean()]).optional().default(true),
})
.optional()
.default({});
diff --git a/packages/studiocms_core/src/schemas/config/markdoc.ts b/packages/studiocms_core/src/schemas/config/markdoc.ts
index 71a6d4842c..d4ac9160ea 100644
--- a/packages/studiocms_core/src/schemas/config/markdoc.ts
+++ b/packages/studiocms_core/src/schemas/config/markdoc.ts
@@ -1,13 +1,64 @@
-import type { ConfigType, ParserArgs, RenderableTreeNode } from '@markdoc/markdoc';
import { z } from 'astro/zod';
-type markdocParserArgs = ParserArgs;
-type markdocTransformConfig = ConfigType;
+const PrimitiveSchema = z.union([z.null(), z.boolean(), z.number(), z.string()]);
+const ScalarSchema = z.union([
+ PrimitiveSchema,
+ z.array(PrimitiveSchema),
+ z.record(PrimitiveSchema),
+]);
-export type markdocRenderer = {
- name: string;
- renderer: (content: RenderableTreeNode) => Promise;
-};
+export const TagSchema = z.object({
+ $$mdtype: z.literal('Tag'), // The constant readonly property
+ name: z.string().default('div'), // Default to 'div'
+ attributes: z.record(z.any()).default({}), // Allow any key-value pairs
+ children: z.array(z.any()).default([]), // Array of RenderableTreeNode, default is empty array
+});
+
+const RenderableTreeNodeSchema = z.union([TagSchema, ScalarSchema]);
+const RenderableTreeNodesSchema = z.union([
+ z.array(RenderableTreeNodeSchema),
+ RenderableTreeNodeSchema,
+]);
+
+type CustomMarkDocRendererNodes = z.infer;
+
+export type markdocRenderer = (nodes: CustomMarkDocRendererNodes) => Promise;
+
+const MarkdocRendererSchema = z.object({
+ name: z.string(),
+ renderer: z.custom(),
+});
+
+export interface MarkdocRenderer extends z.infer {}
+
+const ParserArgsSchema = z.object({
+ file: z.string().optional(),
+ slots: z.boolean().optional(),
+ location: z.boolean().optional(),
+});
+
+const ConfigTypeSchema = z
+ .object({
+ nodes: z
+ .record(
+ z
+ .object({})
+ .partial() // Apply partial on the object inside the record
+ )
+ .optional(),
+ tags: z.record(z.object({})).optional(),
+ variables: z.record(z.any()).optional(),
+ functions: z.record(z.any()).optional(),
+ partials: z.record(z.any()).optional(),
+ validation: z
+ .object({
+ parents: z.array(z.any()).optional(),
+ validateFunctions: z.boolean().optional(),
+ environment: z.string().optional(),
+ })
+ .optional(),
+ })
+ .partial();
//
// MARKDOC CONFIG SCHEMA
@@ -20,19 +71,19 @@ export const markdocConfigSchema = z
* Can be one of the following: `html`, `react-static`, or a custom renderer
*/
renderType: z
- .union([z.literal('html'), z.literal('react-static'), z.custom()])
+ .union([z.literal('html'), z.literal('react-static'), z.custom()])
.optional()
.default('html'),
/**
* The MarkDoc Arg Parse to use for rendering pages and posts
*/
- argParse: z.custom().optional(),
+ argParse: ParserArgsSchema.optional(),
/**
* The MarkDoc Transform Config to use for rendering pages and posts
*
* @see https://markdoc.dev/docs/config
*/
- transformConfig: z.custom().optional(),
+ transformConfig: ConfigTypeSchema.optional(),
})
.optional()
.default({});
diff --git a/packages/studiocms_core/src/schemas/config/marked.ts b/packages/studiocms_core/src/schemas/config/marked.ts
deleted file mode 100644
index 953f1eba9a..0000000000
--- a/packages/studiocms_core/src/schemas/config/marked.ts
+++ /dev/null
@@ -1,134 +0,0 @@
-import { z } from 'astro/zod';
-import type { MarkedExtension } from 'marked';
-import type { BundledTheme, LanguageInput, ThemeInput } from 'shiki';
-
-//
-// MARKED EXTENSIONS SCHEMA
-//
-export const markedExtensionsSchema = z
- .object({
- /**
- * Allows the user to enable/disable the use of the `marked-alert` extension
- * @default true
- * @see https://www.npmjs.com/package/marked-alert
- */
- markedAlert: z.boolean().optional().default(true),
- /**
- * Allows the user to enable/disable the use of the `marked-footnote` extension
- * @default true
- * @see https://www.npmjs.com/package/marked-footnote
- */
- markedFootnote: z.boolean().optional().default(true),
- /**
- * Allows the user to enable/disable the use of the `marked-smartypants` extension
- * @default true
- * @see https://www.npmjs.com/package/marked-smartypants
- */
- markedSmartypants: z.boolean().optional().default(true),
- /**
- * Allows the user to enable/disable the use of the `marked-emoji` extension
- * @default true
- * @see https://www.npmjs.com/package/marked-emoji
- */
- markedEmoji: z.boolean().optional().default(true),
- })
- .optional()
- .default({});
-
-//
-// SHIKI CONFIG SCHEMA
-//
-export const shikiConfigSchema = z
- .object({
- /**
- * Allows the user to choose a Shiki Theme.
- *
- * Note: The Only available themes are the ones listed below, and the user can import them from the `shiki` package. using loadTheme option.
- *
- * ### Current Bundled Themes:
- * - `houston`
- * - `github-dark`
- * - `github-light`
- * - `night-owl`
- *
- * Import the theme from the `shiki` package
- * @default theme: "houston"
- */
- theme: z.custom().optional().default('houston'),
- /**
- * Allows the user to load additional Shiki Themes
- *
- * Note: This option is only used if the user wants to load additional Shiki Themes
- *
- * @example
- * ```ts
- * loadThemes: [ import('shiki/themes/github-dark-default.mjs'), import('shiki/themes/night-owl.mjs') ]
- * ```
- */
- loadThemes: z.array(z.custom()).optional(),
- /**
- * Allows the user to load additional Shiki Languages
- *
- * Note: This option is only used if the user wants to load additional Shiki Languages
- *
- * @example
- * ```ts
- * loadLangs: [ import('shiki/languages/rust.mjs'), import('shiki/languages/scala.mjs') ]
- * ```
- */
- loadLangs: z.array(z.custom()).optional(),
- })
- .optional()
- .default({});
-
-//
-// MARKED HIGHLIGHTER CONFIG SCHEMA
-//
-export const markedHighlighterConfigSchema = z
- .object({
- /**
- * Allows the user to choose between the `shiki` and Other eventually supported Highlighters
- *
- * Note: The Shiki Highlighter is from the `astro` package.
- *
- * @default 'disabled'
- */
- highlighter: z.enum(['shiki', 'disabled']).optional().default('disabled'),
- /**
- * Allows the user to configure the Shiki Highlighter
- */
- shikiConfig: shikiConfigSchema,
- })
- .optional()
- .default({});
-
-//
-// MARKED CONFIG SCHEMA
-//
-export const markedConfigSchema = z
- .object({
- /**
- * Allows Enabling and Disabling of the included Marked Extensions
- */
- includedExtensions: markedExtensionsSchema,
- /**
- * Allows the user to customize the current Marked Highlighter
- */
- highlighterConfig: markedHighlighterConfigSchema,
- /**
- * Allows the user to load additional Marked Extensions
- *
- * Note: This option is only used if the user wants to load additional Marked Extensions
- *
- * @see https://marked.js.org/using_advanced#extensions for more info about Marked Extensions
- * @example
- * ```ts
- * import markedAlert from "marked-alert";
- *
- * loadmarkedExtensions: [ markedAlert() ]
- * ```
- */
- loadmarkedExtensions: z.array(z.custom()).optional(),
- })
- .optional()
- .default({});
diff --git a/packages/studiocms_core/src/schemas/config/mdx.ts b/packages/studiocms_core/src/schemas/config/mdx.ts
index 032d51d06f..af1d0bf34b 100644
--- a/packages/studiocms_core/src/schemas/config/mdx.ts
+++ b/packages/studiocms_core/src/schemas/config/mdx.ts
@@ -1,9 +1,81 @@
import { z } from 'astro/zod';
import type { PluggableList } from 'unified';
-// Get the type of the remark-rehype options
-type ToHastOptions = import('mdast-util-to-hast').Options;
-type RemarkRehypeOptions = Omit;
+// Assuming CommentSchema, ElementSchema, and TextSchema are already defined
+const CommentSchema = z.object({
+ // Define the schema for comments
+ type: z.literal('comment'),
+ value: z.string(),
+});
+
+const ElementSchema = z.object({
+ // Define the schema for elements
+ type: z.literal('element'),
+ tagName: z.string(),
+ properties: z.record(z.any()),
+ children: z.array(z.any()),
+});
+
+const TextSchema = z.object({
+ // Define the schema for text
+ type: z.literal('text'),
+ value: z.string(),
+});
+
+// Annotate the variable with the type
+const ElementContentSchema: z.ZodUnion<
+ [typeof CommentSchema, typeof ElementSchema, typeof TextSchema]
+> = z.union([CommentSchema, ElementSchema, TextSchema]);
+
+// Schema for FootnoteBackContentTemplate.
+export const FootnoteBackContentTemplateSchema = z
+ .function()
+ .args(z.number(), z.number()) // The arguments: referenceIndex and rereferenceIndex.
+ .returns(
+ z.union([
+ z.array(ElementContentSchema), // Array of ElementContent
+ ElementContentSchema, // Single ElementContent
+ z.string(), // Or a string
+ ])
+ );
+
+const FootnoteBackLabelTemplateSchema = z
+ .function()
+ .args(z.number(), z.number()) // The arguments: referenceIndex and rereferenceIndex, both numbers.
+ .returns(z.string()); // The return type is a string.
+
+const HastPropertiesSchema = z.record(
+ z.union([
+ z.boolean(),
+ z.number(),
+ z.string(),
+ z.null(),
+ z.undefined(),
+ z.array(z.union([z.string(), z.number()])),
+ ])
+);
+
+const HandlersSchema = z.any(); // Replace with actual schema for Handlers
+
+const MdastNodesSchema = z.object({ type: z.string() }); // Replace with actual schema for MdastNodes
+
+const HandlerSchema = z.any(); // Replace with actual schema for Handler
+
+export const OptionsSchema = z.object({
+ allowDangerousHtml: z.boolean().nullable().optional(),
+ clobberPrefix: z.string().nullable().optional(),
+ file: z.any().nullable().optional(),
+ footnoteBackContent: z
+ .union([FootnoteBackContentTemplateSchema, z.string(), z.null()])
+ .optional(),
+ footnoteBackLabel: z.union([FootnoteBackLabelTemplateSchema, z.string(), z.null()]).optional(),
+ footnoteLabel: z.string().nullable().optional(),
+ footnoteLabelProperties: HastPropertiesSchema.nullable().optional(),
+ footnoteLabelTagName: z.string().nullable().optional(),
+ handlers: HandlersSchema.nullable().optional(),
+ passThrough: z.array(MdastNodesSchema.shape.type).nullable().optional(),
+ unknownHandler: HandlerSchema.nullable().optional(),
+});
/**
* MDX Configuration Schema
@@ -19,7 +91,7 @@ export const mdxConfigSchema = z
/** List of recma plugins (optional); this is a new ecosystem, currently in beta, to transform esast trees (JavaScript) */
recmaPlugins: z.custom().optional().default([]),
/** Options to pass through to remark-rehype (optional); the option allowDangerousHtml will always be set to true and the MDX nodes (see nodeTypes) are passed through; In particular, you might want to pass configuration for footnotes if your content is not in English. */
- remarkRehypeOptions: z.custom().optional().default({}),
+ remarkRehypeOptions: OptionsSchema.optional().default({}),
})
.optional()
.default({});
diff --git a/packages/studiocms_core/src/schemas/config/rendererConfig.ts b/packages/studiocms_core/src/schemas/config/rendererConfig.ts
index 6c9dd08c6f..acaaecf994 100644
--- a/packages/studiocms_core/src/schemas/config/rendererConfig.ts
+++ b/packages/studiocms_core/src/schemas/config/rendererConfig.ts
@@ -1,10 +1,9 @@
import { z } from 'astro/zod';
-import { markdocConfigSchema, type markdocRenderer } from './markdoc';
-import { markedConfigSchema } from './marked';
-import { mdxConfigSchema } from './mdx';
+import { type MarkdocRenderer, markdocConfigSchema, type markdocRenderer } from './markdoc.js';
+import { mdxConfigSchema } from './mdx.js';
export type Renderer = (content: string) => Promise;
-export type { markdocRenderer };
+export type { markdocRenderer, MarkdocRenderer };
/**
* Custom Renderer Type
@@ -20,10 +19,10 @@ export type { markdocRenderer };
* },
* };
*/
-export type CustomRenderer = {
+export interface CustomRenderer {
name: string;
renderer: Renderer;
-};
+}
/**
* StudioCMS Renderer Configuration Schema
@@ -35,9 +34,6 @@ export const StudioCMSRendererConfigSchema = z
/**
* The Markdown Content Renderer to use for rendering pages and posts
*
- * Marked is A markdown parser and compiler. Built for speed.
- * @see https://marked.js.org/ for more info about marked.
- *
* Astro is the built-in Astro remark-markdown plugin.
* @see https://www.npmjs.com/package/@astrojs/markdown-remark
*
@@ -47,21 +43,13 @@ export const StudioCMSRendererConfigSchema = z
*/
renderer: z
.union([
- z.literal('marked'),
z.literal('astro'),
z.literal('markdoc'),
z.literal('mdx'),
z.custom(),
])
.optional()
- .default('marked'),
- /**
- * Allows customization of the Marked Configuration
- *
- * Marked is a markdown parser and compiler. Built for speed. It is used to convert markdown strings into HTML for rendering content on StudioCMS pages.
- * @see https://marked.js.org/ for more info about marked.
- */
- markedConfig: markedConfigSchema,
+ .default('astro'),
/**
* Allows customization of the Markdoc Configuration
*
diff --git a/packages/studiocms_core/src/schemas/config/sdk.ts b/packages/studiocms_core/src/schemas/config/sdk.ts
new file mode 100644
index 0000000000..58367451cd
--- /dev/null
+++ b/packages/studiocms_core/src/schemas/config/sdk.ts
@@ -0,0 +1,176 @@
+import { z } from 'astro/zod';
+import { defaultCacheLifeTime } from '../../consts.js';
+
+const TimeUnitSchema = z.union([z.literal('m'), z.literal('h')]);
+
+type TimeUnit = z.infer;
+
+const TimeStringSchema = z
+ .string()
+ .regex(/^\d+(m|h)$/, {
+ message: "Invalid time string format. Must be a number followed by 'm' or 'h'.",
+ })
+ .transform((value) => {
+ // Define time multipliers
+ const timeUnits: Record = {
+ m: 60 * 1000, // Minutes to milliseconds
+ h: 60 * 60 * 1000, // Hours to milliseconds
+ };
+
+ // Extract the numeric value and unit from the input string
+ const match = value.match(/^(\d+)([mh])$/);
+
+ if (!match) {
+ throw new Error("Invalid time format. Use values like '5m', '1h', etc.");
+ }
+
+ const val = Number.parseInt(match[1] as string, 10);
+ const unit = match[2] as TimeUnit;
+
+ return val * timeUnits[unit];
+ });
+
+export type TimeString = typeof TimeStringSchema._input;
+
+/**
+ * Schema for cache configuration.
+ */
+const CacheConfigSchema = z.object({
+ /**
+ * Cache Lifetime
+ *
+ * `{number}{unit}` - e.g. '5m' for 5 minutes or '1h' for 1 hour
+ * @default '5m'
+ */
+ lifetime: TimeStringSchema.optional().default(defaultCacheLifeTime),
+});
+
+/**
+ * Schema for processed cache configuration.
+ *
+ * Extends the base CacheConfigSchema with additional properties.
+ *
+ * Properties:
+ * - `enabled` (boolean): Indicates if the cache is enabled.
+ * - @default true
+ */
+const ProcessedCacheConfigSchema = z.object({
+ /**
+ * Cache Enabled
+ *
+ * @default true
+ */
+ enabled: z.boolean().default(true),
+ /**
+ * Cache Lifetime
+ *
+ * `{number}{unit}` - e.g. '5m' for 5 minutes or '1h' for 1 hour
+ * @default '5m'
+ */
+ lifetime: TimeStringSchema.default(defaultCacheLifeTime),
+});
+
+/**
+ * Represents the configuration for the cache.
+ *
+ * This type is inferred from the `CacheConfigSchema` using Zod's `infer` method.
+ * It ensures that the cache configuration adheres to the schema defined in `CacheConfigSchema`.
+ */
+export type CacheConfig = z.infer;
+
+/**
+ * Represents the processed cache configuration inferred from the ProcessedCacheConfigSchema.
+ *
+ * This type is used to define the structure of the cache configuration after it has been
+ * processed and validated by the schema.
+ */
+export type ProcessedCacheConfig = z.infer;
+
+/**
+ * Schema for SDK cache configuration.
+ *
+ * This schema allows for either a boolean value or a more detailed cache configuration object.
+ *
+ * - If a boolean value is provided:
+ * - `true`: Enables caching with a default lifetime.
+ * - `false`: Disables caching.
+ * - If a cache configuration object is provided, it must conform to `CacheConfigSchema`.
+ *
+ * The schema is optional and defaults to `true` (enabled with default lifetime).
+ *
+ * The transformation ensures that the resulting configuration is of type `ProcessedCacheConfig`:
+ * - If a boolean value is provided, it is transformed into an object with `enabled` and `lifetime` properties.
+ * - If a cache configuration object is provided, it is transformed to ensure `enabled` is always `true`.
+ */
+const SDKCacheSchema = z
+ .union([z.boolean(), CacheConfigSchema])
+ .optional()
+ .default(true)
+ .transform((cacheConfig) => {
+ if (typeof cacheConfig === 'boolean') {
+ return {
+ enabled: cacheConfig,
+ lifetime: TimeStringSchema.parse(defaultCacheLifeTime),
+ };
+ }
+ return { enabled: true, lifetime: cacheConfig.lifetime };
+ });
+
+/**
+ * Schema for processing SDK configuration.
+ */
+const ProcessedSDKSchema = z.object({
+ /**
+ * Cache Configuration
+ *
+ * @default cacheConfig: { lifetime: '5m' }
+ */
+ cacheConfig: ProcessedCacheConfigSchema,
+});
+
+/**
+ * Type definition for the processed SDK configuration.
+ *
+ * This type is inferred from the `ProcessedSDKSchema` using Zod's `infer` method.
+ * It represents the structure of the SDK configuration after it has been processed.
+ */
+export type ProcessedSDKConfig = z.infer;
+
+/**
+ * SDKSchema is a Zod schema that validates the SDK configuration.
+ * It can either be a boolean or an object containing cache configuration.
+ *
+ * If it is a boolean, it defaults to `true` and transforms into an object
+ * with default cache configuration.
+ *
+ * If it is an object, it must contain the `cacheConfig` property which is
+ * validated by the `SDKCacheSchema`.
+ */
+export const SDKSchema = z
+ .union([
+ z.boolean(),
+ z.object({
+ /**
+ * Cache Configuration
+ *
+ * @default cacheConfig: { lifetime: '5m' }
+ */
+ cacheConfig: SDKCacheSchema,
+ }),
+ ])
+ .optional()
+ .default(true)
+ .transform((sdkConfig) => {
+ if (typeof sdkConfig === 'boolean') {
+ return {
+ cacheConfig: {
+ enabled: sdkConfig,
+ lifetime: TimeStringSchema.parse(defaultCacheLifeTime),
+ },
+ };
+ }
+ return sdkConfig;
+ });
+
+export type StudioCMS_SDKOptions = typeof SDKSchema._input;
+export type StudioCMS_SDKConfig = typeof SDKSchema._output;
diff --git a/packages/studiocms_core/src/schemas/config/unocss.ts b/packages/studiocms_core/src/schemas/config/unocss.ts
deleted file mode 100644
index 6e809c8b73..0000000000
--- a/packages/studiocms_core/src/schemas/config/unocss.ts
+++ /dev/null
@@ -1,73 +0,0 @@
-import { z } from 'astro/zod';
-
-export const unocssDaisyUISchema = z
- .object({
- /**
- * OPTIONAL - This allows the user to use any of the available DaisyUI themes
- *
- * @default ['light', 'dark']
- */
- themes: z.array(z.string()).optional().default(['light', 'dark']),
- /**
- * OPTIONAL - This allows the user to set the default light theme
- *
- * @default 'light'
- */
- lightTheme: z.string().optional().default('light'),
- /**
- * OPTIONAL - This allows the user to set the default dark theme
- *
- * @default 'dark'
- */
- darkTheme: z.string().optional().default('dark'),
- })
- .optional()
- .default({});
-
-export const unocssPresetsSchema = z
- .object({
- /**
- * OPTIONAL - This allows the user to enable or disable the UnoCSS DaisyUI Preset
- */
- presetDaisyUI: unocssDaisyUISchema,
- })
- .optional()
- .default({});
-
-export const unocssConfigSchema = z
- .object({
- /**
- * OPTIONAL - This allows the user to enable or disable the UnoCSS Default Reset import
- *
- * If you would like to use our UnoCSS configuration with our front-end you can enable this option to import the default reset styles or use the example from the code snippet below to import the reset styles into your Base Layout/header.
- *
- * ```tsx
- * ---
- * import '@unocss/reset/tailwind.css';
- * ---
- * ```
- * @default false
- * The default is false to prevent the dashboard from injecting the reset styles into your project.
- */
- injectReset: z.boolean().optional().default(false),
- /**
- * OPTIONAL - This allows the user to enable or disable the UnoCSS Default Entry import
- *
- * If you would like to use our UnoCSS configuration with our front-end you can enable this option to import the default entry styles or use the example from the code snippet below to import the entry styles into your Base Layout/header.
- *
- * ```tsx
- * ---
- * import 'uno.css';
- * ---
- * ```
- * @default false
- * The default is false to prevent the dashboard from injecting the entry styles into your project.
- */
- injectEntry: z.boolean().optional().default(false),
- /**
- * Allows the user to modify the included UnoCSS Presets
- */
- presetsConfig: unocssPresetsSchema,
- })
- .optional()
- .default({});
diff --git a/packages/studiocms_core/src/schemas/index.ts b/packages/studiocms_core/src/schemas/index.ts
index f03c2281a9..75372dae1a 100644
--- a/packages/studiocms_core/src/schemas/index.ts
+++ b/packages/studiocms_core/src/schemas/index.ts
@@ -1 +1,3 @@
-export * from './config';
+export * from './config/index.js';
+export * from './plugins/index.js';
+export * from './sideBarLink.js';
diff --git a/packages/studiocms_core/src/schemas/plugins/index.ts b/packages/studiocms_core/src/schemas/plugins/index.ts
new file mode 100644
index 0000000000..4f453c59c7
--- /dev/null
+++ b/packages/studiocms_core/src/schemas/plugins/index.ts
@@ -0,0 +1,211 @@
+import { z } from 'astro/zod';
+import type { ColumnDataType } from 'drizzle-orm';
+import type { SQLiteColumn, SQLiteTableWithColumns } from 'drizzle-orm/sqlite-core';
+import { SettingsFieldSchema, TransformFunction, ValidationFunction } from './shared.js';
+
+export interface AstroIntegration {
+ /** The name of the integration. */
+ name: string;
+ /** The different hooks available to extend. */
+ hooks: {
+ [K in keyof Astro.IntegrationHooks]?: Astro.IntegrationHooks[K];
+ } & Partial>;
+}
+
+type AsDrizzleTable = SQLiteTableWithColumns<{
+ name: string;
+ schema: undefined;
+ columns: {
+ [x: string]: SQLiteColumn<
+ {
+ name: string;
+ tableName: string;
+ dataType: ColumnDataType;
+ columnType: string;
+ data: unknown;
+ driverParam: unknown;
+ notNull: false;
+ hasDefault: false;
+ enumValues: string[] | undefined;
+ baseColumn: never;
+ },
+ object
+ >;
+ };
+ dialect: 'sqlite';
+}>;
+
+const DrizzleTableSchema = z.custom<{ name: string; table: AsDrizzleTable }>();
+
+const AstroIntegrationSchema = z.union([
+ z.custom(),
+ z.array(z.custom()),
+]);
+
+export const StudioCMSPluginSchema = z.object({
+ /**
+ * Identifier of the plugin from the package.json
+ */
+ identifier: z.string(),
+ /**
+ * Label of the plugin to be displayed in the StudioCMS Dashboard
+ */
+ name: z.string(),
+ /**
+ * Minimum version of StudioCMS required for the plugin to work
+ */
+ studiocmsMinimumVersion: z.string(),
+ /**
+ * Astro Integration(s) for the plugin
+ */
+ integration: AstroIntegrationSchema,
+ /**
+ * If this exists, the plugin will have its own setting page
+ */
+ settingsPage: z
+ .object({
+ /**
+ * Fields according to specification
+ */
+ fields: z.array(SettingsFieldSchema),
+ /**
+ * Validation function that runs on save
+ */
+ validate: ValidationFunction,
+ })
+ .optional(),
+ /**
+ * Navigation Links for use with the `@studiocms/frontend` package to display links in the frontend
+ */
+ frontendNavigationLinks: z
+ .array(
+ z.object({
+ /**
+ * Display label for the link
+ */
+ label: z.string(),
+ /**
+ * URL to link to
+ */
+ href: z.string(),
+ })
+ )
+ .optional(),
+ /**
+ * Page Type definition. If this is present, the plugin wants to be able to modify the page creation process
+ */
+ pageTypes: z
+ .array(
+ z.object({
+ /**
+ * Label that is shown in the select input
+ */
+ label: z.string(),
+ /**
+ * Identifier that is saved in the database
+ * @example
+ * // Single page type per plugin
+ * 'studiocms'
+ * '@studiocms/blog'
+ * // Multiple page types per plugin (Use unique identifiers for each type to avoid conflicts)
+ * '@mystudiocms/plugin:pageType1'
+ * '@mystudiocms/plugin:pageType2'
+ * '@mystudiocms/plugin:pageType3'
+ * '@mystudiocms/plugin:pageType4'
+ */
+ identifier: z.string(),
+ /**
+ * Description that is shown below the "Page Content" header if this type is selected
+ */
+ description: z.string().optional(),
+ /**
+ * Fields that are shown in the page creation form
+ */
+ fields: z
+ .object({
+ /**
+ * Fields according to specification
+ */
+ fields: z.array(SettingsFieldSchema),
+ /**
+ * Database Conversion function that runs on save after validation
+ */
+ transform: TransformFunction,
+ /**
+ * AstroDB Table to store the data in
+ *
+ * @example
+ * ```ts
+ * import { myTable } from '../dbTables';
+ *
+ * {
+ * table: { name: 'myTable', table: myTable },
+ * }
+ */
+ table: DrizzleTableSchema,
+ })
+ .optional(),
+ /**
+ * A function that takes in all basic info & the page content and gets to modify it. `any` type for visualization purposes.
+ */
+ contentTransform: z
+ .object({
+ /**
+ * Content Transform function. Takes in all the values and returns the modified values to be stored in the database.
+ */
+ transform: TransformFunction,
+ /**
+ * AstroDB Table to store the data in
+ *
+ * @example
+ * ```ts
+ * import { myTable } from '../dbTables';
+ *
+ * {
+ * table: { name: 'myTable', table: myTable },
+ * }
+ */
+ table: DrizzleTableSchema,
+ })
+ .optional(),
+ /**
+ * The path to the actual component that is displayed for the page content
+ *
+ * @example
+ * ```ts
+ * import { createResolver } from 'astro-integration-kit';
+ * const { resolve } = createResolver(import.meta.url)
+ *
+ * {
+ * pageContentComponent: resolve('./components/MyContentEditor.astro'),
+ * }
+ * ```
+ *
+ */
+ pageContentComponent: z.string().optional(),
+ })
+ )
+ .optional(),
+});
+
+export const SafePluginListItemSchema = StudioCMSPluginSchema.omit({
+ integration: true,
+ studiocmsMinimumVersion: true,
+});
+
+export const SafePluginListSchema = z.array(SafePluginListItemSchema);
+
+export type StudioCMSPluginOptions = z.infer;
+export type SafePluginListItemType = z.infer;
+export type SafePluginListType = z.infer;
+export interface StudioCMSPlugin extends StudioCMSPluginOptions {}
+
+/**
+ * Defines a plugin for StudioCMS.
+ *
+ * @param options - The configuration options for the plugin.
+ * @returns The plugin configuration.
+ */
+export function definePlugin(options: StudioCMSPluginOptions): StudioCMSPlugin {
+ return options;
+}
diff --git a/packages/studiocms_core/src/schemas/plugins/shared.ts b/packages/studiocms_core/src/schemas/plugins/shared.ts
new file mode 100644
index 0000000000..3f3dba33b2
--- /dev/null
+++ b/packages/studiocms_core/src/schemas/plugins/shared.ts
@@ -0,0 +1,66 @@
+import { z } from 'astro/zod';
+
+// Common options for all fields
+export const DefaultSettingsFieldOptionsSchema = z.object({
+ name: z.string(),
+ label: z.string(),
+ required: z.boolean().optional(),
+ readOnly: z.boolean().optional(),
+});
+
+// Individual field types
+export const CheckboxSettingsFieldSchema = z.object({
+ input: z.literal('checkbox'),
+ description: z.string(),
+});
+
+export const NumberSettingsFieldSchema = z.object({
+ input: z.literal('number'),
+ description: z.string(),
+});
+
+export const RadioGroupSettingsFieldSchema = z.object({
+ input: z.literal('radio'),
+ options: z.array(
+ z.object({
+ label: z.string(),
+ value: z.string(),
+ })
+ ),
+});
+
+export const SelectSettingsFieldSchema = z.object({
+ input: z.literal('select'),
+ options: z.array(
+ z.object({
+ label: z.string(),
+ value: z.string(),
+ })
+ ),
+ hasMany: z.boolean().optional(),
+});
+
+export const TextSettingsFieldSchema = z.object({
+ input: z.literal('text'),
+});
+
+export const SettingsFieldPreSchema = z.union([
+ CheckboxSettingsFieldSchema,
+ NumberSettingsFieldSchema,
+ RadioGroupSettingsFieldSchema,
+ SelectSettingsFieldSchema,
+ TextSettingsFieldSchema,
+]);
+
+export const RowSettingsFieldSchema = z.object({
+ input: z.literal('row'),
+ fields: z.lazy(() => SettingsFieldPreSchema.array()), // Recursive definition
+});
+
+export const SettingsFieldSchema = z
+ .union([SettingsFieldPreSchema, RowSettingsFieldSchema])
+ .and(DefaultSettingsFieldOptionsSchema);
+
+export const ValidationFunction = z.function().args(z.any()).returns(z.string().or(z.boolean()));
+
+export const TransformFunction = z.function().args(z.any()).returns(z.any());
diff --git a/packages/studiocms_core/src/schemas/sideBarLink.ts b/packages/studiocms_core/src/schemas/sideBarLink.ts
new file mode 100644
index 0000000000..0ebe285064
--- /dev/null
+++ b/packages/studiocms_core/src/schemas/sideBarLink.ts
@@ -0,0 +1,12 @@
+import type { HeroIconName } from '@studiocms/ui/components/Icon/iconType.js';
+import { z } from 'astro/zod';
+
+export const SideBarLinkSchema = z.object({
+ id: z.string(),
+ href: z.string(),
+ text: z.string(),
+ minPermissionLevel: z.string(),
+ icon: z.custom(),
+});
+
+export type SideBarLink = z.infer;
diff --git a/packages/studiocms_core/src/sdk-utils/StudioCMSSDK.ts b/packages/studiocms_core/src/sdk-utils/StudioCMSSDK.ts
new file mode 100644
index 0000000000..95e77c285a
--- /dev/null
+++ b/packages/studiocms_core/src/sdk-utils/StudioCMSSDK.ts
@@ -0,0 +1,2556 @@
+import { CMS_ENCRYPTION_KEY } from 'astro:env/server';
+import jwt from 'jsonwebtoken';
+import { CMSSiteConfigId, GhostUserDefaults } from '../consts.js';
+import { StudioCMS_SDK_Error } from './errors.js';
+import {
+ tsDiffTracking,
+ tsOAuthAccounts,
+ tsPageContent,
+ tsPageData,
+ tsPageDataCategories,
+ tsPageDataTags,
+ tsPageFolderStructure,
+ tsPermissions,
+ tsSessionTable,
+ tsSiteConfig,
+ tsUserResetTokens,
+ tsUsers,
+} from './tables.js';
+import type {
+ AstroDBVirtualModule,
+ CombinedInsertContent,
+ CombinedPageData,
+ CombinedRank,
+ CombinedUserData,
+ DeletionResponse,
+ FolderListItem,
+ FolderNode,
+ MultiPageInsert,
+ PageContentReturnId,
+ PageDataCategoriesInsertResponse,
+ PageDataTagsInsertResponse,
+ SingleRank,
+ addDatabaseEntryInsertPage,
+ tsDiffTrackingInsert,
+ tsDiffTrackingSelect,
+ tsOAuthAccountsSelect,
+ tsPageContentInsert,
+ tsPageContentSelect,
+ tsPageDataCategoriesInsert,
+ tsPageDataCategoriesSelect,
+ tsPageDataInsert,
+ tsPageDataSelect,
+ tsPageDataTagsInsert,
+ tsPageDataTagsSelect,
+ tsPageFolderInsert,
+ tsPageFolderSelect,
+ tsPermissionsInsert,
+ tsPermissionsSelect,
+ tsSessionTableInsert,
+ tsSessionTableSelect,
+ tsSiteConfigInsert,
+ tsSiteConfigSelect,
+ tsUsersInsert,
+ tsUsersSelect,
+ tsUsersUpdate,
+} from './types/index.js';
+
+/**
+ * The StudioCMSSDK class provides a comprehensive set of methods for interacting with the StudioCMS database.
+ * It includes functionalities for parsing input data, collecting and combining page and user data, managing
+ * authentication and authorization, and performing CRUD operations on various database tables.
+ *
+ * @class StudioCMSSDK
+ * @param AstroDB - The AstroDB virtual module to interact with the database.
+ *
+ * @example
+ * ```ts
+ * import * as AstroDB from 'astro:db';
+ * import { uninitializedStudioCMSSDK } from '@studiocms/core/sdk-utils';
+ *
+ * const sdkCore = new uninitializedStudioCMSSDK(AstroDB);
+ * ```
+ */
+export class StudioCMSSDK {
+ private db: AstroDBVirtualModule['db'];
+ private and: AstroDBVirtualModule['and'];
+ private eq: AstroDBVirtualModule['eq'];
+
+ constructor(AstroDB: AstroDBVirtualModule) {
+ this.db = AstroDB.db;
+ this.and = AstroDB.and;
+ this.eq = AstroDB.eq;
+ }
+
+ /**
+ * Parses an unknown input and casts it to an array of numbers.
+ *
+ * @param ids - The input to be parsed, expected to be an array of numbers.
+ * @returns An array of numbers.
+ */
+ public parseIdNumberArray(ids: unknown): number[] {
+ return ids as number[];
+ }
+
+ /**
+ * Parses the given input as an array of strings.
+ *
+ * @param ids - The input to be parsed, expected to be an array of unknown type.
+ * @returns An array of strings parsed from the input.
+ */
+ public parseIdStringArray(ids: unknown): string[] {
+ return ids as string[];
+ }
+
+ /**
+ * Builds a folder structure from the provided folder data.
+ *
+ * @param folders - An array of folder data to build the folder structure from.
+ * @returns An array of folder nodes representing the folder structure.
+ */
+ public generateFolderTree(folders: tsPageFolderSelect[]): FolderNode[] {
+ // Create a lookup table
+ const folderMap: Record = {};
+
+ for (const folder of folders) {
+ folderMap[folder.id] = {
+ id: folder.id,
+ name: folder.name,
+ pageData: null,
+ page: false,
+ children: [],
+ };
+ }
+
+ // Build the tree
+ const rootFolders: FolderNode[] = [];
+
+ for (const folder of folders) {
+ const childFolder = folderMap[folder.id];
+ if (!childFolder) continue; // Skip if childFolder is undefined
+
+ if (folder.parent === null) {
+ // Root-level folder
+ rootFolders.push(childFolder);
+ } else {
+ const parentFolder = folderMap[folder.parent];
+ if (parentFolder) {
+ // Add to parent's children
+ parentFolder.children.push(childFolder);
+ }
+ }
+ }
+
+ return rootFolders;
+ }
+
+ /**
+ * Gets the folder structure from the database.
+ *
+ * @returns A promise that resolves to an array of folder nodes representing the folder structure.
+ */
+ public async buildFolderTree(): Promise {
+ const currentFolders = await this.db.select().from(tsPageFolderStructure);
+ return this.generateFolderTree(currentFolders);
+ }
+
+ /**
+ * Gets the available folders from the database.
+ *
+ * @returns A promise that resolves to an array of folder list items.
+ */
+ public async getAvailableFolders(): Promise {
+ const folders: FolderListItem[] = [];
+ const currentFolders = await this.db.select().from(tsPageFolderStructure);
+ for (const current of currentFolders) {
+ folders.push(current);
+ }
+ return folders;
+ }
+
+ /**
+ * Finds a node in the tree that matches the given URL path.
+ * @param tree - The root of the folder tree.
+ * @param path - The URL path to locate.
+ * @returns The matching node or null if not found.
+ */
+ public findNodeByPath(tree: FolderNode[], path: string[]): FolderNode | null {
+ if (path.length === 0) return null;
+
+ const [current, ...rest] = path;
+
+ for (const node of tree) {
+ if (node.name === current) {
+ if (rest.length === 0) return node;
+ return this.findNodeByPath(node.children, rest);
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * Finds all nodes along the path to a specific node by its ID.
+ * @param tree - The root of the folder tree.
+ * @param id - The ID of the target node.
+ * @returns An array of nodes along the path or an empty array if the node is not found.
+ */
+ public findNodesAlongPathToId(tree: FolderNode[], id: string): FolderNode[] {
+ const path: FolderNode[] = [];
+
+ function helper(nodes: FolderNode[], targetId: string): boolean {
+ for (const node of nodes) {
+ path.push(node); // Add the current node to the path
+
+ if (node.id === targetId) {
+ return true; // Target found, stop recursion
+ }
+
+ if (helper(node.children, targetId)) {
+ return true; // Target found in descendants, propagate success
+ }
+
+ path.pop(); // Backtrack if target is not found in this branch
+ }
+
+ return false; // Target not found in this branch
+ }
+
+ helper(tree, id);
+ return path;
+ }
+
+ /**
+ * Finds the full path to a node based on its URL.
+ * @param tree - The root of the folder tree.
+ * @param path - The URL path to locate.
+ * @returns The full path as an array of node names.
+ */
+ public getFullPath(tree: FolderNode[], path: string[]): string[] {
+ const result: string[] = [];
+
+ function helper(nodes: FolderNode[], pathParts: string[]): boolean {
+ if (pathParts.length === 0) return false;
+
+ const [current, ...rest] = pathParts;
+
+ for (const node of nodes) {
+ if (node.name === current) {
+ result.push(node.name);
+ if (rest.length === 0 || helper(node.children, rest)) {
+ return true;
+ }
+ result.pop(); // Backtrack if not found
+ }
+ }
+
+ return false;
+ }
+
+ helper(tree, path);
+ return result;
+ }
+
+ /**
+ * Finds all nodes along the path to a given URL.
+ * @param tree - The root of the folder tree.
+ * @param path - The URL path to locate.
+ * @returns The nodes along the path.
+ */
+ public findNodesAlongPath(tree: FolderNode[], path: string[]): FolderNode[] {
+ const result: FolderNode[] = [];
+
+ function helper(nodes: FolderNode[], pathParts: string[]): boolean {
+ if (pathParts.length === 0) return false;
+
+ const [current, ...rest] = pathParts;
+
+ for (const node of nodes) {
+ if (node.name === current) {
+ result.push(node);
+ if (rest.length === 0 || helper(node.children, rest)) {
+ return true;
+ }
+ result.pop(); // Backtrack if not found
+ }
+ }
+
+ return false;
+ }
+
+ helper(tree, path);
+ return result;
+ }
+
+ /**
+ * Finds a node by its ID in the tree.
+ * @param id - The ID of the node to find.
+ * @returns The node or null if not found.
+ */
+ private findNodeById(tree: FolderNode[], id: string): FolderNode | null {
+ for (const node of tree) {
+ if (node.id === id) {
+ return node;
+ }
+ const found = this.findNodeById(node.children, id);
+ if (found) {
+ return found;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Adds a new page to the folder tree.
+ * @param tree - The root of the folder tree.
+ * @param folderId - The ID of the parent folder.
+ * @param newPage - The new page to add.
+ * @returns The updated folder tree
+ */
+ public addPageToFolderTree(
+ tree: FolderNode[],
+ folderId: string,
+ newPage: FolderNode
+ ): FolderNode[] {
+ const parentFolder = this.findNodeById(tree, folderId);
+
+ if (!parentFolder) {
+ tree.push(newPage);
+ return tree;
+ }
+
+ parentFolder.children.push(newPage);
+ return tree;
+ }
+
+ public async clearUserReferences(userId: string) {
+ try {
+ await this.db.batch([
+ this.db.delete(tsUserResetTokens).where(this.eq(tsUserResetTokens.userId, userId)),
+ this.db.delete(tsPermissions).where(this.eq(tsPermissions.user, userId)),
+ this.db.delete(tsOAuthAccounts).where(this.eq(tsOAuthAccounts.userId, userId)),
+ this.db.delete(tsSessionTable).where(this.eq(tsSessionTable.userId, userId)),
+ this.db
+ .update(tsDiffTracking)
+ .set({ userId: GhostUserDefaults.id })
+ .where(this.eq(tsDiffTracking.userId, userId)),
+ this.db
+ .update(tsPageData)
+ .set({ authorId: GhostUserDefaults.id })
+ .where(this.eq(tsPageData.authorId, userId)),
+ ]);
+ return true;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error clearing user references: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error clearing user references: An unknown error occurred.');
+ }
+ }
+
+ /**
+ * Collects categories based on the provided category IDs.
+ *
+ * @param categoryIds - An array of category IDs to collect.
+ * @returns A promise that resolves to an array of collected categories.
+ * @throws {StudioCMS_SDK_Error} If there is an error while collecting categories.
+ */
+ public async collectCategories(categoryIds: number[]): Promise {
+ try {
+ const categories: CombinedPageData['categories'] = [];
+
+ const [categoryHead, ...categoryTail] = categoryIds.map((id) =>
+ this.db.select().from(tsPageDataCategories).where(this.eq(tsPageDataCategories.id, id))
+ );
+
+ if (categoryHead) {
+ const categoryResults = await this.db.batch([categoryHead, ...categoryTail]);
+ categories.push(...categoryResults.flat().filter((result) => result !== undefined));
+ }
+
+ return categories;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting categories: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting categories: An unknown error occurred.');
+ }
+ }
+
+ /**
+ * Collects tags based on the provided tag IDs.
+ *
+ * @param tagIds - An array of tag IDs to collect.
+ * @returns A promise that resolves to an array of tags.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while fetching the tags.
+ */
+ public async collectTags(tagIds: number[]): Promise {
+ try {
+ const tags: CombinedPageData['tags'] = [];
+
+ const [tagHead, ...tagTail] = tagIds.map((id) =>
+ this.db.select().from(tsPageDataCategories).where(this.eq(tsPageDataCategories.id, id))
+ );
+
+ if (tagHead) {
+ const tagResults = await this.db.batch([tagHead, ...tagTail]);
+ tags.push(...tagResults.flat().filter((result) => result !== undefined));
+ }
+
+ return tags;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting tags: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting tags: An unknown error occurred.');
+ }
+ }
+
+ /**
+ * Collects and combines various data related to a page.
+ *
+ * @param page - The page data to collect additional information for.
+ * @returns A promise that resolves to the combined page data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while collecting page data.
+ */
+ public async collectPageData(
+ page: tsPageDataSelect,
+ tree: FolderNode[]
+ ): Promise {
+ try {
+ const categoryIds = this.parseIdNumberArray(page.categories || []);
+ const categories = await this.collectCategories(categoryIds);
+
+ const tagIds = this.parseIdNumberArray(page.tags || []);
+ const tags = await this.collectTags(tagIds);
+
+ const contributorIds = this.parseIdStringArray(page.contributorIds || []);
+
+ const multiLanguageContentData = await this.db
+ .select()
+ .from(tsPageContent)
+ .where(this.eq(tsPageContent.contentId, page.id));
+
+ const defaultLanguageContentData = multiLanguageContentData.find(
+ (content) => content.contentLang === page.contentLang
+ );
+
+ const safeSlug = page.slug === 'index' ? '/' : `/${page.slug}`;
+
+ let urlRoute = safeSlug;
+
+ if (page.parentFolder) {
+ const urlParts = this.findNodesAlongPathToId(tree, page.parentFolder);
+ urlRoute = urlParts.map((part) => part.name).join('/') + safeSlug;
+ }
+
+ return {
+ ...page,
+ urlRoute,
+ categories,
+ tags,
+ contributorIds,
+ multiLangContent: multiLanguageContentData,
+ defaultContent: defaultLanguageContentData,
+ };
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error collecting page data: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error collecting page data: An unknown error occurred.');
+ }
+ }
+
+ /**
+ * Collects user data by fetching OAuth data and permission data from the database.
+ *
+ * @param user - The user object containing user information.
+ * @returns A promise that resolves to a CombinedUserData object containing the user data, OAuth data, and permissions data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while collecting user data.
+ */
+ public async collectUserData(user: tsUsersSelect): Promise {
+ try {
+ const [oAuthData, permissionData] = await this.db.batch([
+ this.db.select().from(tsOAuthAccounts).where(this.eq(tsOAuthAccounts.userId, user.id)),
+ this.db.select().from(tsPermissions).where(this.eq(tsPermissions.user, user.id)),
+ ]);
+
+ return {
+ ...user,
+ oAuthData,
+ permissionsData: permissionData[0],
+ };
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error collecting user data: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error collecting user data: An unknown error occurred.');
+ }
+ }
+
+ /**
+ * Verifies the rank of users based on the provided permissions and rank.
+ *
+ * @param users - An array of user objects to be verified.
+ * @param permissions - An array of permission objects that include user ranks.
+ * @param rank - The rank to be verified against the permissions.
+ * @returns An array of objects containing the id and name of users with the specified rank.
+ * @throws {StudioCMS_SDK_Error} If an error occurs during the verification process.
+ */
+ public verifyRank(
+ users: tsUsersSelect[],
+ permissions: tsPermissionsSelect[],
+ rank: string
+ ): SingleRank[] {
+ try {
+ const filteredUsers = permissions.filter((user) => user.rank === rank);
+ const permitted: { id: string; name: string }[] = [];
+
+ for (const user of filteredUsers) {
+ const foundUser = users.find((u) => u.id === user.user);
+
+ if (foundUser) {
+ permitted.push({ id: foundUser.id, name: foundUser.name });
+ }
+ }
+
+ return permitted;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error verifying rank: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error verifying rank: An unknown error occurred.');
+ }
+ }
+
+ /**
+ * Combines a given rank with an array of user ranks.
+ *
+ * @param rank - The rank to be combined with each user.
+ * @param users - An array of user ranks to be combined with the given rank.
+ * @returns An array of combined ranks, where each element includes the given rank and the properties of a user rank.
+ */
+ public combineRanks(rank: string, users: SingleRank[]): CombinedRank[] {
+ return users.map((user) => ({ rank, ...user }));
+ }
+
+ /**
+ * Generates a random ID number with the specified length.
+ *
+ * @param length - The length of the random ID number to generate.
+ * @returns A random ID number with the specified length.
+ */
+ public generateRandomIDNumber(length: number): number {
+ return Math.floor(Math.random() * 10 ** length);
+ }
+
+ public generateToken = (userId: string): string => {
+ return jwt.sign({ userId }, CMS_ENCRYPTION_KEY, { expiresIn: '3h' });
+ };
+
+ public testToken(token: string) {
+ return jwt.verify(token, CMS_ENCRYPTION_KEY);
+ }
+
+ public resetTokenBucket = {
+ new: async (userId: string) => {
+ const token = this.generateToken(userId);
+
+ return await this.db
+ .insert(tsUserResetTokens)
+ .values({ id: crypto.randomUUID(), userId, token })
+ .returning()
+ .get();
+ },
+ delete: async (userId: string): Promise => {
+ await this.db.delete(tsUserResetTokens).where(this.eq(tsUserResetTokens.userId, userId));
+ },
+ check: async (token: string) => {
+ const _token = this.testToken(token) as { userId: string };
+
+ const resetToken = await this.db
+ .select()
+ .from(tsUserResetTokens)
+ .where(this.eq(tsUserResetTokens.userId, _token.userId))
+ .get();
+
+ if (!resetToken) {
+ return false;
+ }
+
+ return resetToken.token === token;
+ },
+ };
+
+ /**
+ * Initializes the StudioCMS SDK with various utility functions.
+ */
+ public INIT = {
+ /**
+ * Initializes the StudioCMS SiteConfig table with the provided configuration.
+ *
+ * @param config - The configuration to insert into the SiteConfig table.
+ * @returns A promise that resolves to the inserted site configuration.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while creating the site configuration.
+ */
+ siteConfig: async (config: tsSiteConfigInsert): Promise => {
+ try {
+ return await this.db
+ .insert(tsSiteConfig)
+ .values({ ...config, id: CMSSiteConfigId })
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error creating site configuration: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error creating site configuration: An unknown error occurred.'
+ );
+ }
+ },
+
+ /**
+ * Initializes the StudioCMS Ghost User.
+ *
+ * The ghost user is a default user that is used to perform actions on behalf of the system as well as to replace deleted users.
+ *
+ * @returns A promise that resolves to the ghost user record.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while creating the ghost user.
+ */
+ ghostUser: async (): Promise => {
+ try {
+ // Check if the ghost user already exists in the database.
+ const ghostUser = await this.AUTH.user.ghost.verifyExists();
+
+ // If the ghost user does not exist, create it and return the inserted record
+ if (!ghostUser) {
+ return await this.AUTH.user.ghost.create();
+ }
+
+ const ghostUserRecord = await this.AUTH.user.ghost.get();
+
+ if (!ghostUserRecord) {
+ throw new StudioCMS_SDK_Error(
+ 'Error getting ghost user from database: The ghost user may not exist yet.'
+ );
+ }
+
+ return ghostUserRecord;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error creating ghost user: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error creating ghost user: An unknown error occurred.');
+ }
+ },
+ };
+
+ /**
+ * The AUTH object provides various authentication and authorization utilities for the StudioCMS SDK.
+ */
+ public AUTH = {
+ /**
+ * Provides various methods to create, delete, and search for OAuth accounts in the StudioCMS database.
+ */
+ oAuth: {
+ /**
+ * Creates a new OAuth account in the database.
+ *
+ * @param data - The data to insert into the OAuth account table.
+ * @returns A promise that resolves to the inserted OAuth account.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while creating the OAuth account.
+ */
+ create: async (data: tsOAuthAccountsSelect): Promise => {
+ try {
+ return await this.db.insert(tsOAuthAccounts).values(data).returning().get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error creating OAuth account: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error creating OAuth account: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Deletes an OAuth account from the database.
+ *
+ * @param userId - The ID of the user associated with the OAuth account.
+ * @param provider - The provider of the OAuth account.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the OAuth account.
+ */
+ delete: async (userId: string, provider: string): Promise => {
+ try {
+ return await this.db
+ .delete(tsOAuthAccounts)
+ .where(
+ this.and(
+ this.eq(tsOAuthAccounts.userId, userId),
+ this.eq(tsOAuthAccounts.provider, provider)
+ )
+ )
+ .then(() => {
+ return {
+ status: 'success',
+ message: 'OAuth account deleted',
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting OAuth account: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error deleting OAuth account: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Searches for OAuth accounts based on the provider ID and user ID.
+ *
+ * @param providerId - The provider ID to search for.
+ * @param userId - The user ID to search for.
+ * @returns A promise that resolves to the OAuth account data if found, otherwise undefined.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while searching for the OAuth account.
+ */
+ searchProvidersForId: async (
+ providerId: string,
+ userId: string
+ ): Promise => {
+ try {
+ return await this.db
+ .select()
+ .from(tsOAuthAccounts)
+ .where(
+ this.and(
+ this.eq(tsOAuthAccounts.providerUserId, providerId),
+ this.eq(tsOAuthAccounts.userId, userId)
+ )
+ )
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error searching for OAuth account: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error searching for OAuth account: An unknown error occurred.'
+ );
+ }
+ },
+ },
+
+ /**
+ * Provides various methods to get and update permissions for users in the StudioCMS database.
+ */
+ permission: {
+ /**
+ * Checks the current status of a user's permissions.
+ */
+ currentStatus: async (userId: string): Promise => {
+ try {
+ return await this.db
+ .select()
+ .from(tsPermissions)
+ .where(this.eq(tsPermissions.user, userId))
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting user permissions: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error getting user permissions: An unknown error occurred.'
+ );
+ }
+ },
+ },
+
+ /**
+ * Provides various methods to create, delete, and update sessions in the StudioCMS database.
+ */
+ session: {
+ /**
+ * Creates a new session in the database.
+ *
+ * @param data - The data to insert into the session table.
+ * @returns A promise that resolves to the inserted session.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while creating the session.
+ */
+ create: async (data: tsSessionTableInsert): Promise => {
+ try {
+ return await this.db
+ .insert(tsSessionTable)
+ .values(data)
+ .returning({
+ id: tsSessionTable.id,
+ userId: tsSessionTable.userId,
+ expiresAt: tsSessionTable.expiresAt,
+ })
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error creating session: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error creating session: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Gets a session with the associated user.
+ *
+ * @param sessionId - The ID of the session to search for.
+ * @returns A promise that resolves to the session with the associated user.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the session with the user.
+ */
+ sessionWithUser: async (
+ sessionId: string
+ ): Promise<
+ {
+ user: tsUsersSelect;
+ session: tsSessionTableSelect;
+ }[]
+ > => {
+ try {
+ return await this.db
+ .select({ user: tsUsers, session: tsSessionTable })
+ .from(tsSessionTable)
+ .innerJoin(tsUsers, this.eq(tsSessionTable.userId, tsUsers.id))
+ .where(this.eq(tsSessionTable.id, sessionId));
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting session with user: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error getting session with user: An unknown error occurred.'
+ );
+ }
+ },
+
+ /**
+ * Deletes a session from the database.
+ *
+ * @param sessionId - The ID of the session to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the session.
+ */
+ delete: async (sessionId: string): Promise => {
+ try {
+ await this.db.delete(tsSessionTable).where(this.eq(tsSessionTable.id, sessionId));
+ return {
+ status: 'success',
+ message: 'Session deleted',
+ };
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error deleting session: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error deleting session: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Updates the expiration date of a session.
+ *
+ * @param sessionId - The ID of the session to update.
+ * @param newDate - The new expiration date for the session.
+ * @returns A promise that resolves to the updated session.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the session.
+ */
+ update: async (sessionId: string, newDate: Date): Promise => {
+ try {
+ return await this.db
+ .update(tsSessionTable)
+ .set({ expiresAt: newDate })
+ .where(this.eq(tsSessionTable.id, sessionId))
+ .returning();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error updating session: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error updating session: An unknown error occurred.');
+ }
+ },
+ },
+
+ /**
+ * Provides various methods to create, update, and search for users in the StudioCMS database.
+ */
+ user: {
+ /**
+ * Creates a new user in the database.
+ *
+ * @param newUserData - The data to insert into the users table.
+ * @returns A promise that resolves to the inserted user.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while creating the user.
+ */
+ create: async (newUserData: tsUsersInsert): Promise => {
+ try {
+ const newUser = await this.db.insert(tsUsers).values(newUserData).returning().get();
+ await this.db.insert(tsPermissions).values({ user: newUser.id, rank: 'visitor' });
+ return newUser;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error creating user: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error creating user: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Updates a user in the database.
+ *
+ * @param userId - The ID of the user to update.
+ * @param userData - The data to update the user with.
+ * @returns A promise that resolves to the updated user.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the user.
+ */
+ update: async (userId: string, userData: tsUsersUpdate): Promise => {
+ try {
+ return await this.db
+ .update(tsUsers)
+ .set(userData)
+ .where(this.eq(tsUsers.id, userId))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error updating user: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error updating user: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Searches for users based on the provided username or email.
+ *
+ * @param username - The username to search for.
+ * @param email - The email to search for.
+ * @returns A promise that resolves to an object containing the search results for the username and email.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while searching for the username or email.
+ */
+ searchUsersForUsernameOrEmail: async (
+ username: string,
+ email: string
+ ): Promise<{
+ usernameSearch: tsUsersSelect[];
+ emailSearch: tsUsersSelect[];
+ }> => {
+ try {
+ const [usernameSearch, emailSearch] = await this.db.batch([
+ this.db.select().from(tsUsers).where(this.eq(tsUsers.username, username)),
+ this.db.select().from(tsUsers).where(this.eq(tsUsers.email, email)),
+ ]);
+
+ return { usernameSearch, emailSearch };
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error searching for username or email: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error searching for username or email: An unknown error occurred.'
+ );
+ }
+ },
+
+ /**
+ * Ghost user utilities.
+ */
+ ghost: {
+ /**
+ * Verifies if the ghost user exists in the database.
+ *
+ * @returns A promise that resolves to a boolean indicating if the ghost user exists.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while verifying the ghost user.
+ */
+ verifyExists: async () => {
+ try {
+ const ghostUser = await this.db
+ .select()
+ .from(tsUsers)
+ .where(this.eq(tsUsers.id, GhostUserDefaults.id))
+ .get();
+ if (!ghostUser) {
+ return false;
+ }
+ return true;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error verifying ghost user exists: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error verifying ghost user exists: An unknown error occurred.'
+ );
+ }
+ },
+
+ /**
+ * Creates the ghost user in the database.
+ *
+ * @returns A promise that resolves to the inserted ghost user.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while creating the ghost user.
+ */
+ create: async () => {
+ try {
+ return await this.db.insert(tsUsers).values(GhostUserDefaults).returning().get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error creating ghost user: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error creating ghost user: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Gets the ghost user from the database.
+ *
+ * @returns A promise that resolves to the ghost user.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the ghost user.
+ */
+ get: async () => {
+ try {
+ return await this.db
+ .select()
+ .from(tsUsers)
+ .where(this.eq(tsUsers.id, GhostUserDefaults.id))
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting ghost user: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error getting ghost user: An unknown error occurred.');
+ }
+ },
+ },
+ },
+ };
+
+ /**
+ * Provides various methods to get data from the StudioCMS database.
+ */
+ public GET = {
+ /**
+ * Retrieves data from the database
+ */
+ database: {
+ /**
+ * Retrieves all users from the database.
+ *
+ * @returns A promise that resolves to an array of combined user data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the users.
+ */
+ users: async (): Promise => {
+ try {
+ const combinedUserData: CombinedUserData[] = [];
+
+ const users = await this.db.select().from(tsUsers);
+
+ for (const user of users) {
+ const UserData = await this.collectUserData(user);
+
+ combinedUserData.push(UserData);
+ }
+
+ return combinedUserData;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting users: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting users: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves all pages from the database.
+ *
+ * @returns A promise that resolves to an array of combined page data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the pages.
+ */
+ pages: async (includeDrafts = false, tree?: FolderNode[]): Promise => {
+ try {
+ const pages: CombinedPageData[] = [];
+
+ let pagesRaw = await this.db.select().from(tsPageData);
+
+ if (!includeDrafts) {
+ pagesRaw = pagesRaw.filter(({ draft }) => !draft);
+ }
+
+ const folders = tree || (await this.buildFolderTree());
+
+ for (const page of pagesRaw) {
+ const PageData = await this.collectPageData(page, folders);
+
+ pages.push(PageData);
+ }
+
+ return pages;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting pages: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting pages: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves the site configuration from the database.
+ *
+ * @returns A promise that resolves to the site configuration.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the site configuration.
+ */
+ config: async (): Promise => {
+ try {
+ return await this.db
+ .select()
+ .from(tsSiteConfig)
+ .where(this.eq(tsSiteConfig.id, CMSSiteConfigId))
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting site configuration: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error getting site configuration: An unknown error occurred.'
+ );
+ }
+ },
+
+ folders: async (): Promise => {
+ try {
+ return await this.db.select().from(tsPageFolderStructure);
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting folders: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting folders: An unknown error occurred.');
+ }
+ },
+ },
+
+ /**
+ * Retrieves data from the database by ID.
+ */
+ databaseEntry: {
+ /**
+ * Retrieves a user from the database
+ */
+ users: {
+ /**
+ * Retrieves a user by ID.
+ *
+ * @param id - The ID of the user to retrieve.
+ * @returns A promise that resolves to the user data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the user.
+ */
+ byId: async (id: string): Promise => {
+ try {
+ const user = await this.db.select().from(tsUsers).where(this.eq(tsUsers.id, id)).get();
+
+ if (!user) return undefined;
+
+ return await this.collectUserData(user);
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting user by ID: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error getting user by ID: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves a user by username.
+ *
+ * @param username - The username of the user to retrieve.
+ * @returns A promise that resolves to the user data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the user.
+ */
+ byUsername: async (username: string): Promise => {
+ try {
+ const user = await this.db
+ .select()
+ .from(tsUsers)
+ .where(this.eq(tsUsers.username, username))
+ .get();
+
+ if (!user) return undefined;
+
+ return await this.collectUserData(user);
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting user by username: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error getting user by username: An unknown error occurred.'
+ );
+ }
+ },
+
+ /**
+ * Retrieves a user by email.
+ *
+ * @param email - The email of the user to retrieve.
+ * @returns A promise that resolves to the user data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the user.
+ */
+ byEmail: async (email: string): Promise => {
+ try {
+ const user = await this.db
+ .select()
+ .from(tsUsers)
+ .where(this.eq(tsUsers.email, email))
+ .get();
+
+ if (!user) return undefined;
+
+ return await this.collectUserData(user);
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting user by email: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error getting user by email: An unknown error occurred.'
+ );
+ }
+ },
+ },
+
+ /**
+ * Retrieves a page from the database
+ */
+ pages: {
+ /**
+ * Retrieves a page by ID.
+ *
+ * @param id - The ID of the page to retrieve.
+ * @returns A promise that resolves to the page data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the page.
+ */
+ byId: async (id: string, tree?: FolderNode[]): Promise => {
+ try {
+ const page = await this.db
+ .select()
+ .from(tsPageData)
+ .where(this.eq(tsPageData.id, id))
+ .get();
+
+ if (!page) return undefined;
+ const folders = tree || (await this.buildFolderTree());
+
+ return await this.collectPageData(page, folders);
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting page by ID: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error getting page by ID: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves a page by slug.
+ *
+ * @param slug - The slug of the page to retrieve.
+ * @param pkg - The package of the page to retrieve.
+ * @returns A promise that resolves to the page data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the page.
+ */
+ bySlug: async (
+ slug: string,
+ pkg?: string,
+ tree?: FolderNode[]
+ ): Promise => {
+ try {
+ const pkgToGet = pkg || 'studiocms';
+
+ const page = await this.db
+ .select()
+ .from(tsPageData)
+ .where(
+ this.and(this.eq(tsPageData.slug, slug), this.eq(tsPageData.package, pkgToGet))
+ )
+ .get();
+
+ if (!page) return undefined;
+ const folders = tree || (await this.buildFolderTree());
+
+ return await this.collectPageData(page, folders);
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error getting page by slug: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error getting page by slug: An unknown error occurred.');
+ }
+ },
+ },
+
+ folder: async (id: string): Promise => {
+ try {
+ return await this.db
+ .select()
+ .from(tsPageFolderStructure)
+ .where(this.eq(tsPageFolderStructure.id, id))
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting folders: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting folders: An unknown error occurred.');
+ }
+ },
+ },
+
+ /**
+ * Retrieves data from the database tables without any additional processing.
+ */
+ databaseTable: {
+ /**
+ * Retrieves all data from the users table.
+ *
+ * @returns A promise that resolves to an array of user data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the users.
+ */
+ users: async () => await this.db.select().from(tsUsers),
+
+ /**
+ * Retrieves all data from the OAuth accounts table.
+ *
+ * @returns A promise that resolves to an array of OAuth account data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the OAuth accounts.
+ */
+ oAuthAccounts: async () => await this.db.select().from(tsOAuthAccounts),
+
+ /**
+ * Retrieves all data from the session table.
+ *
+ * @returns A promise that resolves to an array of session data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the sessions.
+ */
+ sessionTable: async () => await this.db.select().from(tsSessionTable),
+
+ /**
+ * Retrieves all data from the permissions table.
+ *
+ * @returns A promise that resolves to an array of permission data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the permissions.
+ */
+ permissions: async () => await this.db.select().from(tsPermissions),
+
+ /**
+ * Retrieves all data from the page data table.
+ *
+ * @returns A promise that resolves to an array of page data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the pages.
+ */
+ pageData: async () => await this.db.select().from(tsPageData),
+
+ /**
+ * Retrieves all data from the page data tags table.
+ *
+ * @returns A promise that resolves to an array of page data tags.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the page data tags.
+ */
+ pageDataTags: async () => await this.db.select().from(tsPageDataTags),
+
+ /**
+ * Retrieves all data from the page data categories table.
+ *
+ * @returns A promise that resolves to an array of page data categories.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the page data categories.
+ */
+ pageDataCategories: async () => await this.db.select().from(tsPageDataCategories),
+
+ /**
+ * Retrieves all data from the page content table.
+ *
+ * @returns A promise that resolves to an array of page content.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the page content.
+ */
+ pageContent: async () => await this.db.select().from(tsPageContent),
+
+ /**
+ * Retrieves all data from the site config table.
+ *
+ * @returns A promise that resolves to an array of site configuration data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the site configuration.
+ */
+ siteConfig: async () =>
+ await this.db
+ .select()
+ .from(tsSiteConfig)
+ .where(this.eq(tsSiteConfig.id, CMSSiteConfigId))
+ .get(),
+
+ /**
+ * Retrieves all data from the diff tracking table.
+ *
+ * @returns A promise that resolves to an array of diff tracking data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the diff tracking data.
+ */
+ diffTracking: async () => await this.db.select().from(tsDiffTracking),
+
+ /**
+ * Retrieves all data from the page folder structure table.
+ *
+ * @returns A promise that resolves to an array of page folder structure data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the page folder structure data.
+ */
+ pageFolderStructure: async () => await this.db.select().from(tsPageFolderStructure),
+ },
+
+ /**
+ * Retrieve Permission Lists
+ */
+ permissionsLists: {
+ /**
+ * Retrieves all permissions for users in the database.
+ *
+ * @returns A promise that resolves to an array of combined rank data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the permissions.
+ */
+ all: async (): Promise => {
+ try {
+ const [currentPermittedUsers, existingUsers] = await this.db.batch([
+ this.db.select().from(tsPermissions),
+ this.db.select().from(tsUsers),
+ ]);
+
+ const owners = this.verifyRank(existingUsers, currentPermittedUsers, 'owner');
+
+ const admins = this.verifyRank(existingUsers, currentPermittedUsers, 'admin');
+
+ const editors = this.verifyRank(existingUsers, currentPermittedUsers, 'editor');
+
+ const visitors = this.verifyRank(existingUsers, currentPermittedUsers, 'visitor');
+
+ return [
+ ...this.combineRanks('owner', owners),
+ ...this.combineRanks('admin', admins),
+ ...this.combineRanks('editor', editors),
+ ...this.combineRanks('visitor', visitors),
+ ];
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting users: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting users: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves all owners in the database.
+ *
+ * @returns A promise that resolves to an array of combined rank data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the owners.
+ */
+ owners: async (): Promise => {
+ try {
+ const [currentPermittedUsers, existingUsers] = await this.db.batch([
+ this.db.select().from(tsPermissions),
+ this.db.select().from(tsUsers),
+ ]);
+
+ return this.verifyRank(existingUsers, currentPermittedUsers, 'owner');
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting users: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting users: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves all admins in the database.
+ *
+ * @returns A promise that resolves to an array of combined rank data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the admins.
+ */
+ admins: async (): Promise => {
+ try {
+ const [currentPermittedUsers, existingUsers] = await this.db.batch([
+ this.db.select().from(tsPermissions),
+ this.db.select().from(tsUsers),
+ ]);
+
+ return this.verifyRank(existingUsers, currentPermittedUsers, 'admin');
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting users: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting users: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves all editors in the database.
+ *
+ * @returns A promise that resolves to an array of combined rank data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the editors.
+ */
+ editors: async (): Promise => {
+ try {
+ const [currentPermittedUsers, existingUsers] = await this.db.batch([
+ this.db.select().from(tsPermissions),
+ this.db.select().from(tsUsers),
+ ]);
+
+ return this.verifyRank(existingUsers, currentPermittedUsers, 'editor');
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting users: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting users: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Retrieves all visitors in the database.
+ *
+ * @returns A promise that resolves to an array of combined rank data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while getting the visitors.
+ */
+ visitors: async (): Promise => {
+ try {
+ const [currentPermittedUsers, existingUsers] = await this.db.batch([
+ this.db.select().from(tsPermissions),
+ this.db.select().from(tsUsers),
+ ]);
+
+ return this.verifyRank(existingUsers, currentPermittedUsers, 'visitor');
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting users: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting users: An unknown error occurred.');
+ }
+ },
+ },
+
+ /**
+ * Retrieves data from the database by package.
+ */
+ packagePages: async (packageName: string, tree?: FolderNode[]): Promise => {
+ try {
+ const pages: CombinedPageData[] = [];
+
+ const pagesRaw = await this.db
+ .select()
+ .from(tsPageData)
+ .where(this.eq(tsPageData.package, packageName));
+ const folders = tree || (await this.buildFolderTree());
+
+ for (const page of pagesRaw) {
+ const PageData = await this.collectPageData(page, folders);
+
+ pages.push(PageData);
+ }
+
+ return pages;
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error getting pages: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error getting pages: An unknown error occurred.');
+ }
+ },
+ };
+
+ /**
+ * Provides various methods to post data to the StudioCMS database.
+ */
+ public POST = {
+ /**
+ * Inserts data into the database by Entry
+ */
+ databaseEntry: {
+ /**
+ * Insert a new page into the database.
+ *
+ * @param pageData - The data to insert into the page data table.
+ * @param pageContent - The data to insert into the page content table.
+ * @returns A promise that resolves to the inserted page data and page content.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the page.
+ */
+ pages: async (
+ pageData: tsPageDataInsert,
+ pageContent: CombinedInsertContent
+ ): Promise => {
+ try {
+ const newContentID = pageData.id || crypto.randomUUID().toString();
+
+ const {
+ id = newContentID,
+ title,
+ slug,
+ description,
+ authorId = null,
+ package: packageName = 'studiocms',
+ contentLang = 'default',
+ heroImage = '',
+ showOnNav = false,
+ showAuthor = false,
+ showContributors = false,
+ categories = [],
+ tags = [],
+ contributorIds = [],
+ draft = false,
+ parentFolder = null,
+ } = pageData;
+
+ const stringified = {
+ categories: JSON.stringify(categories || []),
+ tags: JSON.stringify(tags || []),
+ contributorIds: JSON.stringify(contributorIds || []),
+ };
+
+ const contentData = {
+ id: crypto.randomUUID().toString(),
+ contentId: newContentID,
+ contentLang: contentLang,
+ content: pageContent.content || '',
+ };
+
+ const NOW = new Date();
+
+ const [newPageData, newPageContent] = await this.db.batch([
+ this.db
+ .insert(tsPageData)
+ .values({
+ id,
+ title,
+ slug,
+ description,
+ authorId,
+ contentLang,
+ heroImage,
+ showAuthor,
+ showContributors,
+ showOnNav,
+ draft,
+ parentFolder,
+ package: packageName,
+ publishedAt: NOW,
+ updatedAt: NOW,
+ ...stringified,
+ })
+ .returning({ id: tsPageData.id }),
+ this.db.insert(tsPageContent).values(contentData).returning({ id: tsPageContent.id }),
+ ]);
+
+ return {
+ pageData: newPageData,
+ pageContent: newPageContent,
+ };
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error inserting page: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error inserting page: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts a new user into the database.
+ *
+ * @param userData - The data to insert into the users table.
+ * @returns A promise that resolves to the inserted user.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the user.
+ */
+ pageContent: async (pageContent: tsPageContentInsert): Promise => {
+ try {
+ return await this.db
+ .insert(tsPageContent)
+ .values({
+ id: pageContent.id || crypto.randomUUID().toString(),
+ contentId: pageContent.contentId,
+ contentLang: pageContent.contentLang || 'default',
+ content: pageContent.content || '',
+ })
+ .returning({ id: tsPageContent.id });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error inserting page content: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error inserting page content: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts a new tag into the database.
+ *
+ * @param tag - The data to insert into the page data tags table.
+ * @returns A promise that resolves to the inserted tag.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the tag.
+ */
+ tags: async (tag: tsPageDataTagsInsert): Promise => {
+ try {
+ return await this.db
+ .insert(tsPageDataTags)
+ .values({
+ name: tag.name,
+ description: tag.description,
+ slug: tag.slug,
+ meta: JSON.stringify(tag.meta),
+ id: tag.id || this.generateRandomIDNumber(9),
+ })
+ .returning({ id: tsPageDataTags.id });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error inserting tag: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error inserting tag: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts a new category into the database.
+ *
+ * @param category - The data to insert into the page data categories table.
+ * @returns A promise that resolves to the inserted category.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the category.
+ */
+ categories: async (category: tsPageDataCategoriesInsert) => {
+ try {
+ return await this.db
+ .insert(tsPageDataCategories)
+ .values({
+ name: category.name,
+ description: category.description,
+ slug: category.slug,
+ meta: JSON.stringify(category.meta),
+ id: category.id || this.generateRandomIDNumber(9),
+ })
+ .returning({ id: tsPageDataCategories.id });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error inserting category: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error inserting category: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts a new permission into the database.
+ *
+ * @param userId - The ID of the user to assign the rank to.
+ * @param rank - The rank to assign to the user.
+ * @returns A promise that resolves to the inserted permission.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the permission.
+ */
+ permissions: async (userId: string, rank: string): Promise => {
+ try {
+ const userAlreadyExists = await this.db
+ .select()
+ .from(tsPermissions)
+ .where(this.eq(tsPermissions.user, userId))
+ .get();
+
+ if (userAlreadyExists) {
+ throw new StudioCMS_SDK_Error(
+ 'User already is already assigned a rank, please update the existing rank instead.'
+ );
+ }
+
+ return await this.db
+ .insert(tsPermissions)
+ .values({
+ user: userId,
+ rank,
+ })
+ .returning({ user: tsPermissions.user, rank: tsPermissions.rank });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error inserting permissions: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error inserting permissions: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts a new site configuration into the database.
+ *
+ * @param siteConfig - The data to insert into the site config table.
+ * @returns A promise that resolves to the inserted site configuration.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the site configuration.
+ */
+ diffTracking: async (diff: tsDiffTrackingInsert): Promise => {
+ try {
+ return await this.db
+ .insert(tsDiffTracking)
+ .values({
+ id: diff.id || crypto.randomUUID().toString(),
+ userId: diff.userId,
+ pageId: diff.pageId,
+ diff: diff.diff || '',
+ timestamp: diff.timestamp || new Date(),
+ pageContentStart: diff.pageContentStart,
+ pageMetaData: JSON.stringify(diff.pageMetaData || {}),
+ })
+ .returning();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error inserting diff tracking: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ 'Error inserting diff tracking: An unknown error occurred.'
+ );
+ }
+ },
+
+ /**
+ * Inserts a new folder into the database.
+ *
+ * @param folder - The data to insert into the page folder structure table.
+ * @returns A promise that resolves to the inserted folder.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the folder.
+ */
+ folder: async (folder: tsPageFolderInsert): Promise => {
+ try {
+ return await this.db
+ .insert(tsPageFolderStructure)
+ .values({
+ id: folder.id || crypto.randomUUID().toString(),
+ name: folder.name,
+ parent: folder.parent || null,
+ })
+ .returning();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error inserting folder: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error inserting folder: An unknown error occurred.');
+ }
+ },
+ },
+
+ /**
+ * Inserts data into the database by Array of Entries
+ */
+ databaseEntries: {
+ /**
+ * Inserts multiple tags into the database.
+ *
+ * @param data - The data to insert into the page data tags table.
+ * @returns A promise that resolves to the inserted tags.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the tags.
+ */
+ tags: async (data: tsPageDataTagsInsert[]): Promise => {
+ try {
+ return await this.db
+ .insert(tsPageDataTags)
+ .values(
+ data.map((tag) => {
+ return {
+ id: tag.id || this.generateRandomIDNumber(9),
+ name: tag.name,
+ slug: tag.slug,
+ description: tag.description,
+ meta: JSON.stringify(tag.meta),
+ };
+ })
+ )
+ .returning({ id: tsPageDataTags.id });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error inserting tags: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error inserting tags: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts multiple categories into the database.
+ *
+ * @param data - The data to insert into the page data categories table.
+ * @returns A promise that resolves to the inserted categories.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the categories.
+ */
+ categories: async (
+ data: tsPageDataCategoriesInsert[]
+ ): Promise => {
+ try {
+ return await this.db
+ .insert(tsPageDataCategories)
+ .values(
+ data.map((category) => {
+ return {
+ id: category.id || this.generateRandomIDNumber(9),
+ name: category.name,
+ slug: category.slug,
+ description: category.description,
+ meta: JSON.stringify(category.meta),
+ };
+ })
+ )
+ .returning({ id: tsPageDataCategories.id });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error inserting categories: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error inserting categories: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts multiple permissions into the database.
+ *
+ * @param data - The data to insert into the permissions table.
+ * @returns A promise that resolves to the inserted permissions.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the permissions.
+ */
+ permissions: async (data: tsPermissionsInsert[]): Promise => {
+ try {
+ const currentPermittedUsers = await this.db.select().from(tsPermissions);
+
+ for (const permission of data) {
+ const userAlreadyExists = currentPermittedUsers.find(
+ (user) => user.user === permission.user
+ );
+
+ if (userAlreadyExists) {
+ throw new Error(
+ `User with ID ${permission.user} already has a rank assigned. Please update the existing rank instead.`
+ );
+ }
+ }
+
+ return await this.db
+ .insert(tsPermissions)
+ .values(
+ data.map((permission) => {
+ return {
+ user: permission.user,
+ rank: permission.rank,
+ };
+ })
+ )
+ .returning({ user: tsPermissions.user, rank: tsPermissions.rank });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error inserting permissions: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error inserting permissions: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Inserts multiple pages into the database.
+ *
+ * @param pages - The data to insert into the page data and page content tables.
+ * @returns A promise that resolves to the inserted pages.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while inserting the pages.
+ */
+ pages: async (pages: MultiPageInsert): Promise => {
+ try {
+ const queries = [];
+
+ for (const { pageData, pageContent } of pages) {
+ const newContentID = pageData.id || crypto.randomUUID().toString();
+
+ const {
+ title,
+ slug,
+ description,
+ authorId = null,
+ package: packageName = 'studiocms',
+ contentLang = 'default',
+ heroImage = '',
+ showOnNav = false,
+ showAuthor = false,
+ showContributors = false,
+ categories = [],
+ tags = [],
+ contributorIds = [],
+ draft = false,
+ parentFolder = null,
+ id = newContentID,
+ } = pageData;
+
+ const stringified = {
+ categories: JSON.stringify(categories || []),
+ tags: JSON.stringify(tags || []),
+ contributorIds: JSON.stringify(contributorIds || []),
+ };
+
+ const contentData = {
+ id: crypto.randomUUID().toString(),
+ contentId: newContentID,
+ contentLang: pageContent.contentLang || 'default',
+ content: pageContent.content || '',
+ };
+
+ const NOW = new Date();
+
+ queries.push(
+ this.db
+ .insert(tsPageData)
+ .values({
+ id,
+ title,
+ slug,
+ description,
+ authorId,
+ contentLang,
+ heroImage,
+ showAuthor,
+ showContributors,
+ showOnNav,
+ draft,
+ parentFolder,
+ package: packageName,
+ publishedAt: NOW,
+ updatedAt: NOW,
+ ...stringified,
+ })
+ .returning(),
+ this.db.insert(tsPageContent).values(contentData).returning()
+ );
+ }
+
+ const [head, ...tail] = queries;
+
+ if (head) {
+ await this.db.batch([head, ...tail]);
+ }
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error inserting pages: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error inserting pages: An unknown error occurred.');
+ }
+ },
+ },
+ };
+
+ /**
+ * Provides various methods to update data in the StudioCMS database.
+ */
+ public UPDATE = {
+ /**
+ * Updates a page in the database.
+ *
+ * @param data - The data to update in the page data table.
+ * @returns A promise that resolves to the updated page data.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the page.
+ */
+ page: async (data: tsPageDataSelect): Promise => {
+ try {
+ return await this.db
+ .update(tsPageData)
+ .set(data)
+ .where(this.eq(tsPageData.id, data.id))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error updating page: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error updating page: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Updates a page content in the database.
+ *
+ * @param data - The data to update in the page content table.
+ * @returns A promise that resolves to the updated page content.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the page content.
+ */
+ pageContent: async (data: tsPageContentSelect): Promise => {
+ try {
+ return await this.db
+ .update(tsPageContent)
+ .set(data)
+ .where(this.eq(tsPageContent.id, data.id))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error updating page content: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error updating page content: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Updates a tag in the database.
+ *
+ * @param data - The data to update in the page data tags table.
+ * @returns A promise that resolves to the updated tag.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the tag.
+ */
+ tags: async (data: tsPageDataTagsSelect): Promise => {
+ try {
+ return await this.db
+ .update(tsPageDataTags)
+ .set(data)
+ .where(this.eq(tsPageDataTags.id, data.id))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error updating tags: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error updating tags: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Updates a category in the database.
+ *
+ * @param data - The data to update in the page data categories table.
+ * @returns A promise that resolves to the updated category.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the category.
+ */
+ categories: async (data: tsPageDataCategoriesSelect): Promise => {
+ try {
+ return await this.db
+ .update(tsPageDataCategories)
+ .set(data)
+ .where(this.eq(tsPageDataCategories.id, data.id))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error updating categories: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error updating categories: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Updates a permission in the database.
+ *
+ * @param data - The data to update in the permissions table.
+ * @returns A promise that resolves to the updated permission.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the permission.
+ */
+ permissions: async (data: tsPermissionsSelect): Promise => {
+ try {
+ return await this.db
+ .update(tsPermissions)
+ .set(data)
+ .where(this.eq(tsPermissions.user, data.user))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error updating permissions: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error updating permissions: An unknown error occurred.');
+ }
+ },
+
+ /**
+ * Updates a site configuration in the database.
+ *
+ * @param data - The data to update in the site config table.
+ * @returns A promise that resolves to the updated site configuration.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while updating the site configuration.
+ */
+ siteConfig: async (data: tsSiteConfigSelect): Promise => {
+ try {
+ return await this.db
+ .update(tsSiteConfig)
+ .set(data)
+ .where(this.eq(tsSiteConfig.id, data.id))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error updating site config: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error('Error updating site config: An unknown error occurred.');
+ }
+ },
+
+ folder: async (data: tsPageFolderSelect): Promise => {
+ try {
+ return await this.db
+ .update(tsPageFolderStructure)
+ .set(data)
+ .where(this.eq(tsPageFolderStructure.id, data.id))
+ .returning()
+ .get();
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(`Error updating folder: ${error.message}`, error.stack);
+ }
+ throw new StudioCMS_SDK_Error('Error updating folder: An unknown error occurred.');
+ }
+ },
+ };
+
+ /**
+ * Provides various methods to delete data from the StudioCMS database.
+ */
+ public DELETE = {
+ /**
+ * Deletes a page from the database.
+ *
+ * @param id - The ID of the page to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the page.
+ */
+ page: async (id: string): Promise => {
+ try {
+ return await this.db
+ .batch([
+ this.db.delete(tsDiffTracking).where(this.eq(tsDiffTracking.pageId, id)),
+ this.db.delete(tsPageContent).where(this.eq(tsPageContent.contentId, id)),
+ this.db.delete(tsPageData).where(this.eq(tsPageData.id, id)),
+ ])
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Page with ID ${id} has been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting page with ID ${id}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting page with ID ${id}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a page content from the database.
+ *
+ * @param id - The ID of the page content to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the page content.
+ */
+ pageContent: async (id: string): Promise => {
+ try {
+ return await this.db
+ .delete(tsPageContent)
+ .where(this.eq(tsPageContent.contentId, id))
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Page content with ID ${id} has been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting page content with ID ${id}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting page content with ID ${id}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a page content lang from the database.
+ *
+ * @param id - The ID of the page content to delete.
+ * @param lang - The lang of the page content to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the page content lang.
+ */
+ pageContentLang: async (id: string, lang: string): Promise => {
+ try {
+ return await this.db
+ .delete(tsPageContent)
+ .where(
+ this.and(this.eq(tsPageContent.contentId, id), this.eq(tsPageContent.contentLang, lang))
+ )
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Page content with ID ${id} and lang ${lang} has been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting page content with ID ${id} and lang ${lang}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting page content with ID ${id} and lang ${lang}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a tag from the database.
+ *
+ * @param id - The ID of the tag to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the tag.
+ */
+ tags: async (id: number): Promise => {
+ try {
+ return await this.db
+ .delete(tsPageDataTags)
+ .where(this.eq(tsPageDataTags.id, id))
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Tag with ID ${id} has been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting tag with ID ${id}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting tag with ID ${id}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a category from the database.
+ *
+ * @param id - The ID of the category to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the category.
+ */
+ categories: async (id: number): Promise => {
+ try {
+ return await this.db
+ .delete(tsPageDataCategories)
+ .where(this.eq(tsPageDataCategories.id, id))
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Category with ID ${id} has been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting category with ID ${id}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting category with ID ${id}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a permission from the database.
+ *
+ * @param userId - The ID of the user to delete the permission for.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the permission.
+ */
+ permissions: async (userId: string): Promise => {
+ try {
+ return await this.db
+ .delete(tsPermissions)
+ .where(this.eq(tsPermissions.user, userId))
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Permissions for user with ID ${userId} have been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting permissions for user with ID ${userId}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting permissions for user with ID ${userId}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a site configuration from the database.
+ *
+ * @param id - The ID of the site configuration to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the site configuration.
+ */
+ diffTracking: async (id: string): Promise => {
+ try {
+ return await this.db
+ .delete(tsDiffTracking)
+ .where(this.eq(tsDiffTracking.id, id))
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Diff tracking with ID ${id} has been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting diff tracking with ID ${id}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting diff tracking with ID ${id}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a folder from the database.
+ *
+ * @param id - The ID of the folder to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the folder.
+ */
+ folder: async (id: string): Promise => {
+ try {
+ return await this.db
+ .delete(tsPageFolderStructure)
+ .where(this.eq(tsPageFolderStructure.id, id))
+ .then(() => {
+ return {
+ status: 'success',
+ message: `Folder with ID ${id} has been deleted successfully`,
+ };
+ });
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting folder with ID ${id}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting folder with ID ${id}: An unknown error occurred.`
+ );
+ }
+ },
+
+ /**
+ * Deletes a user from the database.
+ *
+ * @param id - The ID of the user to delete.
+ * @returns A promise that resolves to a deletion response.
+ * @throws {StudioCMS_SDK_Error} If an error occurs while deleting the user.
+ */
+ user: async (id: string): Promise => {
+ try {
+ const verifyNoReference = await this.clearUserReferences(id);
+
+ if (verifyNoReference) {
+ return await this.db
+ .delete(tsUsers)
+ .where(this.eq(tsUsers.id, id))
+ .then(() => {
+ return {
+ status: 'success',
+ message: `User with ID ${id} has been deleted successfully`,
+ };
+ });
+ }
+ throw new StudioCMS_SDK_Error(
+ `There was an issue deleting User with ID ${id}. Please manually remove all references before deleting the user. Or try again.`
+ );
+ } catch (error) {
+ if (error instanceof Error) {
+ throw new StudioCMS_SDK_Error(
+ `Error deleting user with ID ${id}: ${error.message}`,
+ error.stack
+ );
+ }
+ throw new StudioCMS_SDK_Error(
+ `Error deleting user with ID ${id}: An unknown error occurred.`
+ );
+ }
+ },
+ };
+}
+
+export default StudioCMSSDK;
diff --git a/packages/studiocms_core/src/sdk-utils/StudioCMSVirtualCache.ts b/packages/studiocms_core/src/sdk-utils/StudioCMSVirtualCache.ts
new file mode 100644
index 0000000000..86176db4b1
--- /dev/null
+++ b/packages/studiocms_core/src/sdk-utils/StudioCMSVirtualCache.ts
@@ -0,0 +1,952 @@
+import { CMSSiteConfigId, versionCacheLifetime } from '../consts.js';
+import { StudioCMSCacheError } from './errors.js';
+import type {
+ BaseCacheObject,
+ CombinedPageData,
+ FolderListCacheObject,
+ FolderListItem,
+ FolderNode,
+ FolderTreeCacheObject,
+ PageDataCacheObject,
+ ProcessedCacheConfig,
+ STUDIOCMS_SDK,
+ SiteConfig,
+ SiteConfigCacheObject,
+ VersionCacheObject,
+ tsPageContentSelect,
+ tsPageDataSelect,
+ tsPageFolderSelect,
+} from './types/index.js';
+
+/**
+ * The `StudioCMSVirtualCache` class provides caching utilities for the StudioCMS SDK.
+ * It supports caching for site configurations, versions, and page data.
+ *
+ * @class
+ * @classdesc This class handles caching operations for the StudioCMS SDK, including
+ * fetching, updating, and clearing cache entries for site configurations, versions,
+ * and page data.
+ *
+ * @param {ProcessedCacheConfig} cacheConfig - The configuration for the cache.
+ * @param {STUDIOCMS_SDK} studioCMS_SDK - The StudioCMS SDK instance.
+ */
+export class StudioCMSVirtualCache {
+ private readonly SiteConfigMapID: string = '__StudioCMS_Site_Config';
+ private readonly VersionMapID: string = '__StudioCMS_Latest_Version';
+ private readonly FolderTreeMapID: string = '__StudioCMS_Folder_Tree';
+ private readonly PageFolderTreeMapID: string = '__StudioCMS_Page_Folder_Tree';
+ private readonly FolderListMapID: string = '__StudioCMS_Folder_List';
+ private readonly StudioCMSPkgId: string = 'studiocms';
+ private readonly CMSSiteConfigId = CMSSiteConfigId;
+ private readonly versionCacheLifetime = versionCacheLifetime;
+
+ private readonly cacheConfig: ProcessedCacheConfig;
+ private readonly sdk: STUDIOCMS_SDK;
+
+ private pages = new Map();
+ private siteConfig = new Map();
+ private version = new Map();
+ private folderTree = new Map();
+ private pageFolderTree = new Map();
+ private FolderList = new Map();
+
+ constructor(cacheConfig: ProcessedCacheConfig, sdkCore: STUDIOCMS_SDK) {
+ this.cacheConfig = cacheConfig;
+ this.sdk = sdkCore;
+ }
+
+ // Misc Utils
+
+ /**
+ * Checks if the cache entry has expired based on the provided lifetime.
+ *
+ * @param entry - The cache entry to check, which should implement the BaseCacheObject interface.
+ * @param lifetime - The lifetime duration in milliseconds. Defaults to the cacheConfig's lifetime if not provided.
+ * @returns A boolean indicating whether the cache entry has expired.
+ */
+ private isCacheExpired(entry: BaseCacheObject, lifetime = this.cacheConfig.lifetime): boolean {
+ return new Date().getTime() - entry.lastCacheUpdate.getTime() > lifetime;
+ }
+
+ /**
+ * Checks if the cache is enabled based on the cache configuration.
+ *
+ * @returns {boolean} True if the cache is enabled, false otherwise.
+ */
+ private isEnabled(): boolean {
+ return this.cacheConfig.enabled;
+ }
+
+ /**
+ * Fetches the latest version of the StudioCMS package from the NPM registry.
+ *
+ * @returns {Promise} A promise that resolves to the latest version string of the StudioCMS package.
+ * @throws {StudioCMSCacheError} If there is an error fetching the latest version from NPM.
+ */
+ private async getLatestVersionFromNPM(pkg: string, ver = 'latest'): Promise {
+ try {
+ const npmResponse = await fetch(`https://registry.npmjs.org/${pkg}/${ver}`);
+ const npmData = await npmResponse.json();
+ return npmData.version as string;
+ } catch (error) {
+ throw new StudioCMSCacheError('Error fetching latest version from NPM');
+ }
+ }
+
+ /**
+ * Generates a VersionCacheObject with the provided version and the current date as the last cache update.
+ *
+ * @param version - The version string to be included in the VersionCacheObject.
+ * @returns An object containing the provided version and the current date as the last cache update.
+ */
+ private versionReturn(version: string): VersionCacheObject {
+ return {
+ version,
+ lastCacheUpdate: new Date(),
+ };
+ }
+
+ /**
+ * Generates a cache object for the given site configuration.
+ *
+ * @param siteConfig - The site configuration to be cached.
+ * @returns An object containing the site configuration data and the timestamp of the cache update.
+ */
+ private siteConfigReturn(siteConfig: SiteConfig): SiteConfigCacheObject {
+ return {
+ data: siteConfig,
+ lastCacheUpdate: new Date(),
+ };
+ }
+
+ /**
+ * Returns a PageDataCacheObject containing the provided CombinedPageData and the current date as the last cache update.
+ *
+ * @param data - The combined page data to be cached.
+ * @returns An object containing the provided data and the current date as the last cache update.
+ */
+ private pageDataReturn(data: CombinedPageData): PageDataCacheObject {
+ return {
+ data,
+ lastCacheUpdate: new Date(),
+ };
+ }
+
+ /**
+ * Returns a FolderTreeCacheObject containing the provided folder tree data and the current date as the last cache update.
+ *
+ * @param data - The folder tree data to be cached.
+ * @returns An object containing the provided data and the current date as the last cache update.
+ */
+ private folderTreeReturn(data: FolderNode[]): FolderTreeCacheObject {
+ return {
+ data,
+ lastCacheUpdate: new Date(),
+ };
+ }
+
+ private folderListReturn(data: FolderListItem[]): FolderListCacheObject {
+ return {
+ data,
+ lastCacheUpdate: new Date(),
+ };
+ }
+
+ // Folder Tree Utils
+
+ public async getFolderList(): Promise {
+ try {
+ if (!this.isEnabled()) {
+ const folderList = await this.sdk.getAvailableFolders();
+
+ if (!folderList) {
+ throw new StudioCMSCacheError('Folder list not found in database');
+ }
+
+ return this.folderListReturn(folderList);
+ }
+
+ const list = this.FolderList.get(this.FolderListMapID);
+
+ if (!list || this.isCacheExpired(list)) {
+ const folderList = await this.sdk.getAvailableFolders();
+
+ if (!folderList) {
+ throw new StudioCMSCacheError('Folder list not found in database');
+ }
+
+ this.FolderList.set(this.FolderListMapID, this.folderListReturn(folderList));
+
+ return this.folderListReturn(folderList);
+ }
+
+ return list;
+ } catch (error) {
+ throw new StudioCMSCacheError('Error fetching folder list');
+ }
+ }
+
+ public async updateFolderList(): Promise {
+ try {
+ const folderList = await this.sdk.getAvailableFolders();
+
+ if (!this.isEnabled()) {
+ return this.folderListReturn(folderList);
+ }
+
+ this.FolderList.set(this.FolderListMapID, this.folderListReturn(folderList));
+
+ return this.folderListReturn(folderList);
+ } catch (error) {
+ throw new StudioCMSCacheError('Error updating folder list');
+ }
+ }
+
+ public clearFolderList(): void {
+ // Check if caching is disabled
+ if (!this.isEnabled()) {
+ return;
+ }
+
+ // Clear the folder list cache
+ this.FolderList.clear();
+
+ // Return void
+ return;
+ }
+
+ /**
+ * Retrieves the folder tree from the cache or the database.
+ *
+ * @returns {Promise} A promise that resolves to the folder tree.
+ * @throws {StudioCMSCacheError} If the folder tree is not found in the database or if there is an error fetching the folder tree.
+ */
+ public async getFolderTree(): Promise {
+ try {
+ if (!this.isEnabled()) {
+ const folderTree = await this.sdk.buildFolderTree();
+
+ if (!folderTree) {
+ throw new StudioCMSCacheError('Folder tree not found in database');
+ }
+
+ return this.folderTreeReturn(folderTree);
+ }
+
+ const tree = this.folderTree.get(this.FolderTreeMapID);
+
+ if (!tree || this.isCacheExpired(tree)) {
+ const folderTree = await this.sdk.buildFolderTree();
+
+ if (!folderTree) {
+ throw new StudioCMSCacheError('Folder tree not found in database');
+ }
+
+ this.folderTree.set(this.FolderTreeMapID, this.folderTreeReturn(folderTree));
+
+ return this.folderTreeReturn(folderTree);
+ }
+
+ return tree;
+ } catch (error) {
+ throw new StudioCMSCacheError('Error fetching folder tree');
+ }
+ }
+
+ /**
+ * Retrieves the folder tree from the cache or the database.
+ *
+ * @returns {Promise} A promise that resolves to the folder tree.
+ * @throws {StudioCMSCacheError} If the folder tree is not found in the database or if there is an error fetching the folder tree.
+ */
+ public async getPageFolderTree(includeDrafts = false): Promise
{title}
- *{description}
- *