This is the full developer documentation for StudioCMS # StudioCMS Documentation > Guides and resources for learning how to use StudioCMS. import { CardGrid, LinkButton } from '@astrojs/starlight/components'; import Card from '~/components/landing/Card.astro'; import ListCard from '~/components/landing/ListCard.astro'; import SplitCard from '~/components/landing/SplitCard.astro'; import { Center } from 'studiocms:ui/components';

```sh # Create a new Astro project pnpm create studiocms@latest # Start the development server cd my-studiocms-project pnpm dev ```

For more information about required environment variables, see the [Environment Variables][environment-variables] page. For a more in-depth guide, check out the [Getting Started][getting-started] guide. Looking for a libSQL database? Check out [Turso][turso].

- [Getting Started][getting-started] - [Environment Variables][environment-variables] - [Why StudioCMS?][why-studiocms] - [Understanding StudioCMS][how-it-works] - [Using the SDK][using-the-sdk] - [Using the REST API][using-rest-api] - [Finding and Using Plugins][package-catalog] - [Learn about the Plugin API][plugin-api]

Want to get involved with the StudioCMS community? Join our Discord!

{/* Page MD Links */} [environment-variables]: /en/start-here/getting-started/ [getting-started]: /en/start-here/getting-started/ [turso]: https://tur.so/studiocms [why-studiocms]: /en/start-here/why-studiocms/ [how-it-works]: /en/how-it-works/ [using-the-sdk]: /en/how-it-works/sdk/ [using-rest-api]: /en/how-it-works/restapi/ [package-catalog]: /en/package-catalog/ [plugin-api]: /en/plugins/ # Authentication API import { StudioCMSAuthApi } from '@withstudiocms/api-spec'; import ScalarDoc from '~/components/ScalarDoc.astro'; # Dashboard API import { StudioCMSDashboardApiSpec } from '@withstudiocms/api-spec'; import ScalarDoc from '~/components/ScalarDoc.astro'; # Integration API import { StudioCMSIntegrationsApiSpec } from '@withstudiocms/api-spec'; import ScalarDoc from '~/components/ScalarDoc.astro'; # REST API import { StudioCMSRestApiV1Spec } from '@withstudiocms/api-spec'; import ScalarDoc from '~/components/ScalarDoc.astro'; # SDK API import { StudioCMSSDKApiSpec } from '@withstudiocms/api-spec'; import ScalarDoc from '~/components/ScalarDoc.astro'; # StudioCMSOptions > Reference page for StudioCMSOptions import ReadMore from '~/components/ReadMore.astro'; StudioCMS Integration config options schema reference ```ts twoslash title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- // Default Values shown export default defineStudioCMSConfig({ dbStartPage: true, db: {}, verbose: false, logLevel: 'Info', plugins: [], componentRegistry: {}, locale: {}, features: {} }); ``` ## `dbStartPage` Project initialization page - Used during first time setup to create your database configuration. - **Type:** `boolean` - **Default:** `true` ### Usage ```ts twoslash {2} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ dbStartPage: true, // DEFAULT - This injects a start page to setup your DB data. }) ``` ## `db` `db` is an object that is used to configure the database dialect. - **Type:** `DBConfigSchema` - **Default:** `{}` ### Usage ```ts twoslash {2-4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ db: { dialect: 'libsql', // 'libsql' | 'postgresql' | 'mysql' }, }) ``` ## `storageManager` `storageManager` is used to configure the storage manager plugin for StudioCMS. - **Type:** `StudioCMSStorageManager` - **Default:** `undefined` ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- import s3Storage from '@studiocms/s3-storage'; export default defineStudioCMSConfig({ storageManager: s3Storage(), }) ``` ## `verbose` `verbose` is a boolean that is used to enable or disable verbose logging. - **Type:** `boolean` - **Default:** `false` ### Usage ```ts twoslash {2} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ verbose: false, // DEFAULT - This sets the verbose logging to false. }) ``` ## `logLevel` `logLevel` is a union for setting the LogLevel for Effect based code. - **Type:** `All` | `Fatal` | `Error` | `Warning` | `Info` | `Debug` | `Trace` | `None` - **Default:** `Info` ### Usage ```ts twoslash {2} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ logLevel: 'Info', // DEFAULT }) ``` ## `plugins` `plugins` is an array that is used to determine which plugins should be loaded. - **Type:** `StudioCMSPlugin[]` - **Default:** `[]` ### Usage ```ts twoslash {1, 3-5} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- import blog from '@studiocms/blog'; export default defineStudioCMSConfig({ plugins: [ blog(), ], }) ``` ## `componentRegistry` `componentRegistry` is an object that is used to register components. - **Type:** `Record` - **Default:** `{}` ### Usage ```ts twoslash {2-4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ componentRegistry: { 'my-component': './src/components/MyComponent.astro', }, }) ``` ## `locale` `locale` allows setting Locale specific settings [See `locale` for full options][locale] ## `features` `features` is an object that allows adjusting the StudioCMS Dashboard features [See `features` for full options][features] {/* Links */} [locale]: /en/config-reference/locale/ [features]: /en/config-reference/features/ # Features > Reference page for StudioCMSOptions features StudioCMS Integration config options schema reference ```ts twoslash title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: {}, }); ``` ## `robotsTXT` `robotsTXT` Allows the user to enable/disable and configure the use of the StudioCMS Custom `astro-robots-txt` Integration - **Type:** `RobotsConfig` | `boolean` - **Default:** `{ policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'] } ] }` ### Usage Note: `robotsTXT` can also be set to `false` to disable it. ```ts twoslash {3-11} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { robotsTXT: { policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'], } ] } } }) ``` ## `injectQuickActionsMenu` `injectQuickActionsMenu` allows enabling and disabling the quick actions menu which allows easy access to your dashboard while logged in on non-dashboard pages. - **Type:** `boolean` - **Default:** `true` ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { injectQuickActionsMenu: true } }) ``` ## `sdk` `sdk` 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. ### Usage ```ts twoslash {3-7} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; import { Duration } from 'effect'; // ---cut--- export default defineStudioCMSConfig({ features: { sdk: { cacheConfig: { lifetime: Duration.minutes(5), }, } } }) ``` ### `cacheConfig` `cacheConfig` is an object that is used to configure the cache for the SDK. - **Type:** `boolean` | `{ lifetime?: Duration | undefined; }` | `undefined` - **Default:** `{ lifetime: Duration.minutes(5) }` #### Usage ```ts twoslash {5-8} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- import { Duration } from 'effect'; export default defineStudioCMSConfig({ features: { sdk: { // DEFAULT - This uses the default cache configuration. cacheConfig: { lifetime: Duration.minutes(5), }, } } }) ``` ## `dashboardConfig` `dashboardConfig` allows customization of the Dashboard Configuration ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: {} } }) ``` ### `dashboardEnabled` `dashboardEnabled` allows the user to enable or disable the StudioCMS dashboard but still provide all the helper's and utilities to those who are customizing their setup, doing so will disable the dashboard and you will need to manage your content via your database #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: { dashboardEnabled: true, } } }) ``` ### `inject404Route` `inject404Route` allows the user to enable or disable the default 404 route for the dashboard #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: { inject404Route: true, } } }) ``` ### `faviconURL` `faviconURL` allows the user to override the default Favicon URL to a custom URL #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: { faviconURL: '/favicon.svg', } } }) ``` ### `dashboardRouteOverride` `dashboardRouteOverride` allows the user to change the base route at which the dashboard is served (e.g., `/admin` instead of `/dashboard`) #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: { dashboardRouteOverride: 'dashboard', } } }) ``` ### `versionCheck` `versionCheck` 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. #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: { versionCheck: true, } } }) ``` ### `security` `security` Allows customization of the Security Configuration #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: { security: {} } } }) ``` #### `hideGeneratorTags` `hideGeneratorTags` Allows enabling or disabling of the Generator Meta Tags in the Dashboard HTML - **Type:** `boolean` - **Default:** `false` ##### Usage ```ts twoslash {5} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { dashboardConfig: { security: { hideGeneratorTags: false } } } }) ``` ## `authConfig` `authConfig` Allows customization of the Authentication Configuration ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { authConfig: {} } }) ``` ### `enabled` Allows enabling or disabling of the Authentication Configuration - **Type:** `boolean` - **Default:** `true` #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { authConfig: { enabled: true } } }) ``` ### `providers` Allows enabling or disabling of the Authentication Providers The following provider can be configured from here: `usernameAndPassword`. #### Usage ```ts twoslash {4-9} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { authConfig: { providers: { usernameAndPassword: true, usernameAndPasswordConfig: { allowUserRegistration: true } } } } }) ``` ## `developerConfig` `developerConfig` Allows customization of the Developer Options ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { developerConfig: {} } }) ``` ### `demoMode` Enable demo mode for the site. If set to an object, the site will be in demo mode, and the user will be able to login with the provided username and password. #### Usage ```ts twoslash {4-7} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { developerConfig: { demoMode: { username: 'foo', password: 'bar' } } } }) ``` ## `preferredImageService` `preferredImageService` Allows setting the identifier of the Preferred Image Service Requires an Image Service to be installed such as `'cloudinary-js'` - **Type:** `string` | `undefined` - **Default:** `undefined` ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { preferredImageService: 'cloudinary-js' } }) ``` ## `webVitals` `webVitals` Allows enabling or disabling of Web Vitals tracking - **Type:** `boolean` - **Default:** `false` ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { webVitals: true } }) ``` ## `api` `api` allows configuring API specific features - **Type:** `ApiConfig` | `undefined` - **Default:** `undefined` ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { api: { // api specific features here } } }) ``` ### `api.apiDocs` `apiDocs` allows enabling or disabling of the API Docs route which provides an OpenAPI Spec for the StudioCMS API - **Type:** `boolean` - **Default:** `true` #### Usage ```ts twoslash {4} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ features: { api: { apiDocs: true } } }) ``` # Locale > Reference page for StudioCMSOptions locale import ReadMore from '~/components/ReadMore.astro'; `locale` allows setting Locale-specific settings ```ts twoslash title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ locale: { dateLocale: 'en-US', dateTimeFormat: {}, i18n: {} }, }); ``` ## `dateLocale` `dateLocale` is a BCP 47 locale identifier used for date formatting. - **Type:** `string` - **Default:** `'en-US'` ### Usage ```ts twoslash {3} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ locale: { dateLocale: 'en-US', // DEFAULT - This sets the date locale for date formatting. } }) ``` ## `dateTimeFormat` `dateTimeFormat` is an object that is used to configure the date time format. - **Type:** `Intl.DateTimeFormatOptions` - **Default:** `{}` ### Usage ```ts twoslash {3-7} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ locale: { dateTimeFormat: { year: "numeric", month: "short", day: "numeric" }, } }) ``` ## `i18n` `i18n` is an object that is used to configure internationalization options. - **Type:** `object` - **Default:** `{}` ### Usage ```ts twoslash {3-5} title="studiocms.config.mjs" import { defineStudioCMSConfig } from 'studiocms/config'; // ---cut--- export default defineStudioCMSConfig({ locale: { i18n: { defaultLocale: 'en', }, } }) # Ecosystem Overview import ReadMore from '~/components/ReadMore.astro' The StudioCMS ecosystem is a vibrant and growing collection of tools, plugins, and integrations that enhance the core functionality of StudioCMS or extend the Astro framework. These ecosystem packages are developed by both the StudioCMS team and the wider community, providing users with a diverse range of options to customize and optimize their StudioCMS experience. ## Featured Packages ### StudioCMS UI Library `@withstudiocms/ui` is a comprehensive UI component library designed specifically for building user interfaces within StudioCMS projects. It provides a wide range of pre-built, customizable components that adhere to StudioCMS's design principles, making it easy to create consistent and visually appealing interfaces. Learn more about the StudioCMS UI Library in the [UI Library Documentation](/en/ecosystem/packages/studiocms-ui/). ### Template Language `@withstudiocms/template-lang` is a lightweight and flexible templating engine designed for rendering dynamic content in StudioCMS projects. It supports variable interpolation, making it easy to create dynamic templates for emails, documents, and web pages. Learn more about the Template Language in the [Template Language Documentation](/en/ecosystem/packages/template-lang/). ### Kysely Database Client `@withstudiocms/kysely` is a type-safe SQL query builder for TypeScript, built on top of the Kysely library. It provides a powerful and flexible way to interact with databases while ensuring type safety and reducing runtime errors. This package is used internally by StudioCMS for database operations but can also be used directly in your projects. Learn more about the Kysely Database Client in the [Kysely Documentation](/en/ecosystem/packages/kysely/). ### CFetch `@studiocms/cfetch` is an Astro integration that provides a cacheable fetch function for Astro SSR projects. It enhances the standard fetch API by adding caching capabilities, allowing you to cache responses and improve performance for server-side rendered applications. Learn more about CFetch in the [CFetch Documentation](/en/ecosystem/packages/cfetch/). # Apollo Discord Bot > Apollo is a fully-configurable Discord Bot that helps with managing Discord Servers for OSS projects. Apollo is a fully-configurable Discord Bot that helps with managing Discord Servers for OSS projects. It is designed to help with common tasks such as managing support requests, sending PTAL announcements, and more. See this bot in action on the [StudioCMS Discord Server](https://chat.studiocms.dev). ## Tech Stack - Discord.js - Drizzle ORM - libSQL - GitHub API ## Commands ### `ptal` - **Minimum Permission**: Moderate Members Creates a PTAL announcement in the current channel and pings the notifications role (if configured). ### `settings` - **Minimum Permission**: Administrator Command which carries the sub-commands for configuring the bot. #### `set-forum` - **Minimum Permission**: Administrator Allows you to configure the Forum to be used for support requests. #### `set-ptal-role` - **Minimum Permission**: Administrator Sets the role that gets pinged when a new PTAL announcement is sent. #### `set-join-role` - **Minimum Permission**: Administrator Sets the role that a user receives when they join the server. #### `print` - **Minimum Permission**: Administrator Prints an overview of all settings. ### `solved` - **Minimum Permission**: Moderate Members Sends an embed with buttons so the OP of a support request can close it. ### `support` - **Minimum Permission**: Moderate Members Creates a new post in the support forum based on the message you supply. # Artemis Discord Bot > Artemis Bot for StudioCMS Artemis is a powerful Effect based discord bot that is designed to interact with your Discord community and your Github Organization. Built for StudioCMS, open sourced for anyone to tweak to their hearts content. See this bot in action on the [StudioCMS Discord Server](https://chat.studiocms.dev). ## Tech Stack - Effect-TS - Effect dfx - Drizzle ORM - libSQL - GroqAI API - GitHub API - Algolia ## Features - Auto-threader bot - BlueSky discord repeater - Contribute Embed - Crowdin PTAL from repo dispatch - Docs Search with Algolia - Custom Event bus (primarily for HTTP -> discord communication) - GitHub issue from message app interaction - GitHub issue from thread command - No-Embed bot (stop people's messages from having embeds) - PTAL Service - Stars Graph - HTTP webserver for assets and webhook handling - `@` ping replies with AI interactions ## Services ### Auto-Threader Automatically create threads from every message in a channel To enable auto-threading in a channel, an administrator must add `[threads]` to the channel topic. ### No-Embed Prevents embeds from appearing in messages in a channel. To enable no-embed in a channel, an administrator must add `[noembed]` to the channel topic. ### Crowdin PTAL Automatically dispatch PTAL notifications when a Crowdin pull request is created. To enable Crowdin PTAL dispatch in a channel, an administrator must set up a repository dispatch event in their GitHub repository with the action type `crowdin.create` and the appropriate payload. Also requires the PTAL service to be configured in the server. ## Commands ### `bluesky` - **Minimum Permission**: Administrator Manage BlueSky account tracking and settings for this server. #### `list` - **Minimum Permission**: Administrator Lists all BlueSky accounts currently being tracked in this server. #### `subscribe ` - **Minimum Permission**: Administrator Subscribes the current channel to updates from the specified BlueSky account. The parameters `top_level`, `replies`, and `reposts` are booleans indicating whether to track those types of posts. #### `unsubscribe ` - **Minimum Permission**: Administrator Unsubscribes the current channel from updates from the specified BlueSky account. #### `settings` - **Minimum Permission**: Administrator View or modify BlueSky tracking settings for this server. ##### `post_channel ` - **Minimum Permission**: Administrator Sets the channel where BlueSky updates will be posted. ##### `ping_role [role] [enable]` - **Minimum Permission**: Administrator Sets the role to ping for BlueSky updates and whether to enable or disable the ping. ##### `view` - **Minimum Permission**: Administrator Views the current BlueSky tracking settings for this server. ### `contribute` - **Minimum Permission**: N/A Creates a contributing guide embed for the current channel. ### `crowdin-setup` - **Minimum Permission**: Administrator Set up a Crowdin embed in the current channel for a specified repository. #### `set ` - **Minimum Permission**: Administrator Set up a new Crowdin embed listener in the current channel for the specified GitHub repository. #### `remove ` - **Minimum Permission**: Administrator Remove the Crowdin embed from the current channel for the specified GitHub repository. #### `list` - **Minimum Permission**: Administrator List all Crowdin embeds in the current channel. ### `docs [hidden=false] [language=en]` - **Minimum Permission**: N/A Search the docs for a specific query using the Algolia Docsearch API. ### `issue-from-thread [title]` - **Minimum Permission**: N/A Create a GitHub issue from the current thread in the specified repository. The `type` parameter indicates the type of issue, and an optional `title` can be provided. ### `issue-settings` - **Minimum Permission**: Administrator Manage issue command settings for this server. #### `add-repo ` - **Minimum Permission**: Administrator Add a repository to the issue command allow list. #### `remove-repo ` - **Minimum Permission**: Administrator Removes a repository from the issue command allow list. #### `list-repos` - **Minimum Permission**: Administrator List all repositories in the issue command allow list. ### `ptal ` - **Minimum Permission**: N/A Sends a PTAL (Please Take A Look) notification for a pull request with the provided GitHub URL and description. ### `ptal-settings` - **Minimum Permission**: Administrator Configure the PTAL service for this server. #### `set-ping-role ` - **Minimum Permission**: Administrator Set the role to ping for PTAL notifications. #### `view-settings` - **Minimum Permission**: Administrator View the current PTAL settings for this server. ### `stars-graph [public=false]` - **Minimum Permission**: N/A Generate a star history graph for a GitHub repository. The repository should be in the format `owner/repo` (e.g., `facebook/react`). The optional `public` parameter indicates whether the generated graph should be publicly accessible. # Buildkit > Learn about the @withstudiocms/buildkit package import { Aside } from '@astrojs/starlight/components' import { PackageManagers } from 'starlight-package-managers' import ReadMore from '~/components/ReadMore.astro' This is an esbuild based CLI kit for building Astro Integrations ## Usage ### Installation Install the package in the root of the repo: ### Usage Once you install the buildkit package you now have access to a `buildkit` CLI utility, add the following to your integration scripts: ```json title="package.json" ins={3-4} { "scripts": { "build": "buildkit build 'src/**/*.{ts,astro,css}'", "dev": "buildkit dev 'src/**/*.{ts,astro,css}'" } } ``` The command pattern is `buildkit 'path/to/file or glob/**/**.{ts}' [flags]` #### Available Flags (All are optional) - `--no-clean-dist`: Do not clean the dist output during build. - `--bundle`: Enable bundling. - `--force-cjs`: Force CJS output. - `--tsconfig=tsconfig.json`: Allows setting custom tsconfig for build time. - `--outdir=dist`: Allows settings the output directory. #### Files considered Assets The following file extensions will be copied from their src to their respective outputs and not transformed as if they are static assets. - `.astro` - `.d.ts` - `.json` - `.gif` - `.jpeg` - `.jpg` - `.png` - `.tiff` - `.webp` - `.avif` - `.svg` - `.stub` For other content types and how to use them see [The esbuild Docs](https://esbuild.github.io/content-types/) # CFetch > Learn about the @studiocms/cfetch package import { Aside, Steps } from '@astrojs/starlight/components' import { PackageManagers } from 'starlight-package-managers' import ReadMore from '~/components/ReadMore.astro' This is an [Astro integration](https://docs.astro.build/en/guides/integrations-guide/) that provides a cacheable fetch function for Astro SSR ## Usage ### Prerequisites - Using with an Astro SSR project, While you could import and use this in an Astro SSG (static) project, it would have no benefit as Astro Static pages are pre-rendered. ### Installation 1. Install the integration **automatically** using the Astro CLI: Or install it **manually**: 2. Install peer dependencies If your package manager does not automatically install peer dependencies, you will need to ensure `Effect` is installed. 3. Add the integration to your astro config ```ts title="astro.config.mts" ins={2, 6} import { defineConfig } from 'astro/config'; import cFetch from "@studiocms/cfetch"; export default defineConfig({ integrations: [ cFetch(), ], }); ``` ### Usage This integration includes various versions of cached fetch functions and [Effects](https://effect.website) to allow full control of how you work with your data. #### Effects All Effects have the following return pattern or derivatives there of ```ts Effect.Effect, FetchError, never>; ``` ##### `CachedResponse` type ```ts interface CachedResponse { data: T; ok: boolean; status: number; statusText: string; headers: Record; } ``` ##### `CFetchConfig` type ```ts interface CFetchConfig { ttl?: Duration.DurationInput; tags?: string[]; key?: string; verbose?: boolean; } ``` ##### `cFetchEffect` ###### Interface ```ts const cFetchEffect: ( url: string | URL, parser: (response: Response) => Promise, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Effect.Effect, FetchError, never> ``` ###### Example Usage ```ts import { cFetchEffect, Duration } from "c:fetch" const effect = cFetchEffect<{ foo: string; bar: number; }>( 'https://api.example.com/data', (res) => res.json(), { method: "GET" }, { ttl: Duration.hours(1), tags: ['example'], key: "api-data-fetch", verbose: false } ); /* Return type: Effect.Effect, FetchError, never> */ ``` ##### `cFetchEffectJson` ###### Interface ```ts const cFetchEffectJson: ( url: string | URL, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Effect.Effect, FetchError, never> ``` ###### Example Usage ```ts import { cFetchEffectJson } from "c:fetch" const effect = cFetchEffectJson<{ foo: string; bar: number; }>( 'https://api.example.com/data', { method: "GET" } ); /* Return type: Effect.Effect, FetchError, never> */ ``` ##### `cFetchEffectText` ###### Interface ```ts const cFetchEffectText: ( url: string | URL, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Effect.Effect, FetchError, never> ``` ###### Example Usage ```ts import { cFetchEffectText } from "c:fetch" const effect = cFetchEffectText( 'https://example.com', { method: "GET" } ); /* Return type: Effect.Effect, FetchError, never> */ ``` ##### `cFetchEffectBlob` ###### Interface ```ts const cFetchEffectBlob: ( url: string | URL, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Effect.Effect, FetchError, never> ``` ###### Example Usage ```ts import { cFetchEffectBlob } from "c:fetch" const effect = cFetchEffectBlob( 'https://example.com/image.png', { method: "GET" } ); /* Return type: Effect.Effect, FetchError, never> */ ``` #### Functions All Functions have the following return pattern or derivatives there of ```ts CachedResponse; ``` ##### `cFetch` ###### Interface ```ts const cFetch: ( url: string | URL, parser: (response: Response) => Promise, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Promise> ``` ###### Example Usage ```ts import { cFetch } from "c:fetch" const effect = await cFetch<{ foo: string; bar: number; }>( 'https://api.example.com/data', (res) => res.json(), { method: "GET" } ); /* Return type: CachedResponse<{ foo: string; bar: number; }> */ ``` ##### `cFetchJson` ###### Interface ```ts const cFetchJson: ( url: string | URL, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Promise> ``` ###### Example Usage ```ts import { cFetchJson } from "c:fetch" const effect = await cFetchJson<{ foo: string; bar: number; }>( 'https://api.example.com/data', { method: "GET" } ); /* Return type: CachedResponse<{ foo: string; bar: number; }> */ ``` ##### `cFetchText` ###### Interface ```ts const cFetchText: ( url: string | URL, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Promise> ``` ###### Example Usage ```ts import { cFetchText } from "c:fetch" const effect = await cFetchText( 'https://example.com', { method: "GET" } ); /* Return type: CachedResponse */ ``` ##### `cFetchBlob` ###### Interface ```ts const cFetchBlob: ( url: string | URL, options?: RequestInit | undefined, cacheConfig?: CFetchConfig | undefined ) => Promise> ``` ###### Example Usage ```ts import { cFetchBlob } from "c:fetch" const effect = await cFetchBlob( 'https://example.com/image.png', { method: "GET" } ); /* Return type: CachedResponse */ ``` # Expressive Code Twoslash > A Expressive Code plugin that adds Twoslash support to your Expressive Code TypeScript code blocks. import ReadMore from '~/components/ReadMore.astro' A Expressive Code plugin that adds Twoslash support to your Expressive Code TypeScript code blocks. Explore the full documentation and component catalog for the Expressive Code Twoslash package at [twoslash.studiocms.dev](https://twoslash.studiocms.dev). # Kysely Database Client > Learn about the @withstudiocms/kysely package import { Aside } from '@astrojs/starlight/components' import { PackageManagers } from 'starlight-package-managers' import ReadMore from '~/components/ReadMore.astro' [Kysely](https://kysely.dev/) is a type-safe SQL query builder for TypeScript. It provides a powerful and flexible way to interact with databases while ensuring type safety and reducing runtime errors. Kysely supports various SQL databases, including PostgreSQL, MySQL, SQLite, and more. It allows developers to construct SQL queries using a fluent API, making it easier to read and maintain database interactions in TypeScript applications. Currently StudioCMS only supports libSQL(SQLite), MySQL, and PostgreSQL databases via Kysely. In the future, support for other database dialects can be added as needed or requested. Want to have another database dialect supported? Check out the [Kysely Dialects documentation](https://kysely.dev/docs/dialects/) and open an issue on the [StudioCMS GitHub repository](https://github.com/withstudiocms/studiocms/issues). ## The Kysely Client package A type-safe database client and migration system for StudioCMS, built on top of [Kysely](https://kysely.dev/). Provides a unified interface for working with libSQL, MySQL, and PostgreSQL databases with runtime schema management and migrations. ### Features - **Type-Safe Database Operations** - Full TypeScript support with Kysely's type-safe query builder - **Multi-Database Support** - Works with libSQL (SQLite), MySQL, and PostgreSQL - **Runtime Schema Management** - Dynamic schema creation and validation - **Error Handling** - Custom error types for better debugging - **TypeScript-Based Migrations** - File-based migrations with automatic tracking - **Schema Introspection** - Inspect and validate database schemas at runtime - **Effect-ts Integration** - Functional programming patterns with Effect-ts ### Code Example #### Basic client setup ```ts twoslash title="client-setup.ts" import { getDBClientLive } from '@withstudiocms/kysely'; import type { StudioCMSDatabaseSchema } from '@withstudiocms/sdk/tables'; import { libsqlDriver } from '@withstudiocms/kysely/drivers/libsql'; import { ConfigProvider, Effect } from 'studiocms/effect'; export const getDbClient = Effect.gen(function* () { // Setup the LibSQL driver with a database URL from config const dialect = yield* libsqlDriver.pipe( Effect.withConfigProvider( ConfigProvider.fromJson({ CMS_LIBSQL_URL: 'file:./test.db', }) ) ); // Return the Kysely DB client with Effect helpers return yield* getDBClientLive(dialect); }); ``` #### Get users example ```ts twoslash title="get-users.ts" import { getDBClientLive } from '@withstudiocms/kysely'; import type { StudioCMSDatabaseSchema } from '@withstudiocms/sdk/tables'; import { libsqlDriver } from '@withstudiocms/kysely/drivers/libsql'; import { ConfigProvider, Effect } from 'studiocms/effect'; export const getDbClient = Effect.gen(function* () { // Setup the LibSQL driver with a database URL from config const dialect = yield* libsqlDriver.pipe( Effect.withConfigProvider( ConfigProvider.fromJson({ CMS_LIBSQL_URL: 'file:./test.db', }) ) ); // Return the Kysely DB client with Effect helpers return yield* getDBClientLive(dialect); }); // ---cut--- import { Schema } from 'studiocms/effect'; import { StudioCMSUsersTable } from '@withstudiocms/sdk/tables'; export const getUsers = Effect.gen(function* () { const { withDecoder } = yield* getDbClient; const getUsers = withDecoder({ decoder: Schema.Array(StudioCMSUsersTable.Select), callbackFn: (db) => db((client) => client.selectFrom('StudioCMSUsersTable') .selectAll() .execute() ), }); const users = yield* getUsers(); // ^? console.log('Users:', users); }); ``` #### Insert new user example (`withEncoder`) ```ts twoslash title="insert-user.ts" import { getDBClientLive } from '@withstudiocms/kysely'; import type { StudioCMSDatabaseSchema } from '@withstudiocms/sdk/tables'; import { libsqlDriver } from '@withstudiocms/kysely/drivers/libsql'; import { ConfigProvider, Effect } from 'studiocms/effect'; export const getDbClient = Effect.gen(function* () { // Setup the LibSQL driver with a database URL from config const dialect = yield* libsqlDriver.pipe( Effect.withConfigProvider( ConfigProvider.fromJson({ CMS_LIBSQL_URL: 'file:./test.db', }) ) ); // Return the Kysely DB client with Effect helpers return yield* getDBClientLive(dialect); }); // ---cut--- import { Schema } from 'studiocms/effect'; import { StudioCMSUsersTable } from '@withstudiocms/sdk/tables'; export const insertUser = Effect.gen(function* () { const { withEncoder } = yield* getDbClient; const insertUser = withEncoder({ encoder: StudioCMSUsersTable.Insert, callbackFn: (db, newUser) => db((client) => client.insertInto('StudioCMSUsersTable') .values(newUser) .executeTakeFirst() ), }); const data = { username: 'new_user', email: 'new_user@example.com', password: null, avatar: null, emailVerified: false, name: 'user', notifications: '', url: null, id: crypto.randomUUID(), updatedAt: new Date().toISOString(), createdAt: new Date().toISOString(), }; const newUser = yield* insertUser(data); // ^? console.log('Inserted new user:', newUser); }); ``` #### Insert new user example (`withCodec`) ```ts twoslash title="insert-user.ts" import { getDBClientLive } from '@withstudiocms/kysely'; import type { StudioCMSDatabaseSchema } from '@withstudiocms/sdk/tables'; import { libsqlDriver } from '@withstudiocms/kysely/drivers/libsql'; import { ConfigProvider, Effect } from 'studiocms/effect'; export const getDbClient = Effect.gen(function* () { // Setup the LibSQL driver with a database URL from config const dialect = yield* libsqlDriver.pipe( Effect.withConfigProvider( ConfigProvider.fromJson({ CMS_LIBSQL_URL: 'file:./test.db', }) ) ); // Return the Kysely DB client with Effect helpers return yield* getDBClientLive(dialect); }); // ---cut--- import { Schema } from 'studiocms/effect'; import { StudioCMSUsersTable } from '@withstudiocms/sdk/tables'; export const insertUser = Effect.gen(function* () { const { withCodec } = yield* getDbClient; const insertNewUser = withCodec({ encoder: StudioCMSUsersTable.Insert, decoder: StudioCMSUsersTable.Select, callbackFn: (db, newUser) => db((client) => client .insertInto('StudioCMSUsersTable') .values(newUser) .returningAll() .executeTakeFirstOrThrow() ), }); const data = { username: 'codec_user', email: 'codec_user@example.com', password: null, avatar: null, emailVerified: false, name: 'user', notifications: '', url: null, id: crypto.randomUUID(), updatedAt: new Date().toISOString(), createdAt: new Date().toISOString(), }; const insertedUser = yield* insertNewUser(data); // ^? console.log('Inserted user with codec:', insertedUser); }); ``` #### Get user by ID example ```ts twoslash title="get-user.ts" import { getDBClientLive } from '@withstudiocms/kysely'; import type { StudioCMSDatabaseSchema } from '@withstudiocms/sdk/tables'; import { libsqlDriver } from '@withstudiocms/kysely/drivers/libsql'; import { ConfigProvider, Effect } from 'studiocms/effect'; export const getDbClient = Effect.gen(function* () { // Setup the LibSQL driver with a database URL from config const dialect = yield* libsqlDriver.pipe( Effect.withConfigProvider( ConfigProvider.fromJson({ CMS_LIBSQL_URL: 'file:./test.db', }) ) ); // Return the Kysely DB client with Effect helpers return yield* getDBClientLive(dialect); }); // ---cut--- import { Schema } from 'studiocms/effect'; import { StudioCMSUsersTable } from '@withstudiocms/sdk/tables'; export const insertUser = Effect.gen(function* () { const { withCodec } = yield* getDbClient; const getUserById = withCodec({ encoder: Schema.String, decoder: Schema.UndefinedOr(StudioCMSUsersTable.Select), callbackFn: (db, id) => db((client) => client.selectFrom('StudioCMSUsersTable') .selectAll() .where('id', '=', id) .executeTakeFirst() ), }); const user = yield* getUserById('some-user-id'); // ^? console.log('User by ID:', user); }); ``` ### Further Reading For more information on how StudioCMS uses Kysely internally, check out [The SDK](/en/ecosystem/packages/sdk/) documentation to learn how to use it in your StudioCMS project! # Markdown Remark > Learn about the @studiocms/markdown-remark package import { Aside } from '@astrojs/starlight/components' import { PackageManagers } from 'starlight-package-managers' import Integration from '~/components/Integration.astro' import ReadMore from '~/components/ReadMore.astro' ## The Integration `@studiocms/markdown-remark` is a powerful Markdown parser and transformer built on top of [remark](https://github.com/remarkjs/remark). It provides seamless integration with [Astro](https://astro.build/), allowing you to easily parse and transform Markdown content within your Astro projects. This project is heavily based on and compatible with Astro's built-in `@astrojs/markdown-remark` package, extending its capabilities to better suit the needs of StudioCMS users. ### Features - **Markdown Parsing**: Parse Markdown content into an abstract syntax tree (AST) using remark. - **Astro Integration**: Easily integrate with Astro to transform Markdown content into HTML. - **Custom Plugins**: Extend the functionality with custom remark plugins. - **Configurable**: Highly configurable to suit your specific needs. ### Installation To install `@studiocms/markdown-remark`, use your preferred package manager: Or install it **manually**: ### Usage #### As an Astro Integration With the Astro integration enabled, you can either pass in custom components into your astro config, or manually for the specific render your trying to do shown in the following methods. ##### Setup the integration **`astro.config.mjs`** ```ts import markdownRemark from '@studiocms/markdown-remark'; import { defineConfig } from 'astro/config'; export default defineConfig({ markdown: { /* * Your Customizations here based on: * https://docs.astro.build/en/reference/configuration-reference/#markdown-options */ }, integrations: [markdownRemark({ // Used for injecting CSS for Headings and Callouts injectCSS: true, // User defined components that will be used when processing markdown components: { // Example of a custom defined component custom: "./src/components/Custom.astro", }, // Custom Markdown config markdown: { // Configure the available callout themes callouts: { theme: 'obsidian' // Can also be 'github' or 'vitepress' }, autoLinkHeadings: true, sanitize: {} // see https://github.com/natemoo-re/ultrahtml?tab=readme-ov-file#sanitization for full options } })], }); ``` ##### Use the integration **`src/pages/index.astro`** ```astro --- import { Markdown } from 'studiocms:markdown-remark'; import Custom from '../components/Custom.astro'; --- Example `} components={{ custom: Custom }} /> ``` OR ```astro --- import { render } from 'studiocms:markdown-remark'; import Custom from '../components/Custom.astro'; // @ts-ignore const { html } = await render('# Hello World! ', {}, { $$result, components: {custom: Custom} }) --- Example {html} ``` #### Using the Markdown component directly without the integration **`src/pages/index.astro`** ```astro --- import { Markdown } from '@studiocms/markdown-remark/components'; import H1 from '../components/H1.astro'; --- Example ``` ## The Processor ### Usage First setup your render function **`src/utils/render.ts`** ```ts import { createMarkdownProcessor } from '@studiocms/markdown-remark/core'; import type { MarkdownProcessorRenderOptions } from '@studiocms/markdown-remark/types'; const processor = await createMarkdownProcessor({ /* * Your Options here * same as https://docs.astro.build/en/reference/configuration-reference/#markdown-options */ }); export async function render( content: string, options?: MarkdownProcessorRenderOptions ) { const result = await processor.render(content, options); return { html: result.astroHTML, meta: result.metadata, }; } ``` Then use it! **`/src/pages/index.astro`** ```astro --- import { render } from '../utils/render'; const content = `# Hello world!` const { html } = await render(content) --- Example {html} ``` # StudioCMS SDK > Learn about the StudioCMS SDK import { Aside } from '@astrojs/starlight/components' import { PackageManagers } from 'starlight-package-managers' import Integration from '~/components/Integration.astro' import ReadMore from '~/components/ReadMore.astro' A comprehensive Software Development Kit for StudioCMS, providing a unified API for interacting with the CMS core functionality. Built with TypeScript and Effect-ts for type-safety and functional programming patterns, with Kysely DB ([`@withstudiocms/kysely`](/en/ecosystem/packages/kysely/)) for dynamic database storage. Want to learn more about how to use the SDK with StudioCMS? Check out [The SDK](/en/how-it-works/sdk/) documentation to learn how to use it in your StudioCMS project! ### Features - **Authentication Module** - User authentication and session management - **Configuration Management** - Type-safe configuration handling with validation - **Database Operations** - CRUD operations with Effect-ts error handling - **Plugin System** - Utilities for plugin development and integration - **Caching Layer** - Built-in caching with query memoization and invalidation - **Middleware Utilities** - Request handling and middleware composition - **Diff Tracking** - Track changes and modifications - **REST API Helpers** - Utilities for building REST endpoints - **Notification Settings** - User notification preference management - **Token Bucket** - Rate limiting and token management ### Further Reading For a code example of how to use the StudioCMS SDK manually in your project, check how it's implemented in [StudioCMS on GitHub](https://github.com/withstudiocms/studiocms/blob/main/packages/studiocms/src/virtuals/sdk/index.ts) Interested in the live SDK already available in StudioCMS? Check out [The SDK](/en/how-it-works/sdk/) documentation to learn how to use it in your StudioCMS project! Learn more about the Kysely Database Client in the [Kysely Documentation](/en/ecosystem/packages/kysely/). # StudioCMS UI Library > Learn about the @studiocms/ui package import { Aside } from '@astrojs/starlight/components' import { PackageManagers } from 'starlight-package-managers' import ReadMore from '~/components/ReadMore.astro' StudioCMS UI Library (`@studiocms/ui`) is a comprehensive collection of reusable UI components and design elements specifically crafted for building user interfaces with StudioCMS. This library provides developers with a consistent and efficient way to create visually appealing and user-friendly applications that seamlessly integrate with the StudioCMS ecosystem. The StudioCMS dashboard itself is built using the StudioCMS UI Library, showcasing its capabilities and design principles. Explore the full documentation and component catalog for the StudioCMS UI Library at [ui.studiocms.dev](https://ui.studiocms.dev). # Template Language > Learn about StudioCMS's custom template language import { Aside } from '@astrojs/starlight/components' import { PackageManagers } from 'starlight-package-managers' StudioCMS comes with its own custom template language that is similar in syntax to popular templating languages like [Handlebars](https://handlebarsjs.com/) or [Liquid](https://shopify.github.io/liquid/). This template language allows you to create dynamic and reusable templates in different parts of the StudioCMS dashboard, such as in the Mail Templates system, or in custom plugins that you may develop. `@withstudiocms/template-lang` is a simple MIT Licensed TypeScript ESM template language for HTML emails, similar to Handlebars but focused on simplicity and database data integration. ## Features - Simple `{{variable}}` syntax for variable interpolation - Support for nested properties with dot notation (`{{user.name}}`) - TypeScript with full ESM support - Strict mode for error handling - Designed specifically for email templates and DB data - Zero dependencies ## Use Cases Perfect for: - HTML email templates - Dynamic content generation from database data - Simple templating needs without complex logic - ESM-first TypeScript projects ## Installation For those interested in using the StudioCMS template language in their projects, you can install using your preferred package manager: ## Template Syntax Similar to other templating languages, StudioCMS's template language uses double curly braces `{{ }}` to denote variables that should be replaced with actual data when the template is rendered. Unlike some other templating languages, StudioCMS's template language focuses on simplicity and does not include complex logic or control structures. It is primarily designed for straightforward variable interpolation. ### Variable Interpolation ```handlebars

Hello {{user.firstName}} {{user.lastName}}!

Your order #{{order.id}} total is ${{order.total}}

``` ### Nested Properties ```handlebars

Shipping to: {{user.address.street}}, {{user.address.city}}

``` ## Usage Examples ### Basic Usage ```ts twoslash title="basic-usage.ts" import TemplateEngine from '@withstudiocms/template-lang'; const engine = new TemplateEngine(); const template = "Hello {{name}}! Welcome to {{company.name}}."; const data = { name: "John Doe", company: { name: "Acme Corp" } }; const result = engine.render(template, data); console.log(result); // "Hello John Doe! Welcome to Acme Corp." ``` ### Email Template ```ts twoslash title="email-template.ts" import TemplateEngine from '@withstudiocms/template-lang'; const engine = new TemplateEngine(); const emailTemplate = ` {{subject}}

Hello {{user.name}}!

Your order #{{order.id}} has been confirmed.

Total: {{order.total}}

`; const data = { subject: "Order Confirmation", user: { name: "John Doe" }, order: { id: "12345", total: "99.99" } }; const html = engine.render(emailTemplate, data); ``` ### Strict Mode ```ts twoslash title="strict-mode.ts" import TemplateEngine from '@withstudiocms/template-lang'; const strictEngine = new TemplateEngine({ strict: true }); // This will throw an error if 'missingVar' is not in data try { const result = strictEngine.render("Hello {{missingVar}}!", {}); } catch (error) { console.log("Variable not found:", (error as Error).message); } ``` ### Default Values ```ts twoslash title="default-values.ts" import TemplateEngine from '@withstudiocms/template-lang'; const engine = new TemplateEngine({ defaultValue: "[NOT SET]" }); const result = engine.render("Hello {{name}}!", {}); // Result: "Hello [NOT SET]!" ``` ### Template Compilation ```ts twoslash title="template-compilation.ts" import TemplateEngine from '@withstudiocms/template-lang'; const engine = new TemplateEngine(); // Compile once, use multiple times const compiled = engine.compile("Hello {{name}}!"); const result1 = compiled({ name: "Alice" }); const result2 = compiled({ name: "Bob" }); ``` ## API Reference ### TemplateEngine #### Constructor ```typescript new TemplateEngine(options?: TemplateOptions) ``` #### Methods **`render(template: string, data: TemplateData): string`** Renders a template with the provided data. **`compile(template: string): (data: TemplateData) => string`** Compiles a template into a reusable function. **`hasVariables(template: string): boolean`** Checks if a template contains any variables. **`getVariables(template: string): string[]`** Returns an array of all variable names in the template. **`setOptions(options: Partial): void`** Updates the engine options. ### Options ```ts interface TemplateOptions { strict?: boolean; // Throw error on missing variables (default: false) defaultValue?: string; // Default value for missing variables (default: '') } ``` # Guides & Tutorials > Guides and Tutorials for StudioCMS ## Contributing Guides - [Getting Started](/en/guides/contributing/getting-started/) - Learn the basics of contributing to StudioCMS - [Code Contributions](/en/guides/contributing/code-contributions/) - Learn how to contribute code to StudioCMS - [Translations](/en/guides/contributing/translations/) - Learn how to contribute translations to StudioCMS ## Upgrade Guides - [Release Notes](/en/guides/upgrade/release-notes/) - Automated Release notes generated from StudioCMS Changelogs - See the Sidebar for more options for this category, such as the specific version guides. ## Custom Frontend Guides - [Rendering Content](/en/guides/custom-frontend/rendering/) - Options for rendering Content on a Custom Frontend ## Databases - [Self-hosted libSQL Server](/en/guides/database/sqld-server/) - Host your own sqld libSQL server with Docker # Code Contributions > Learn how to contribute code to StudioCMS import { Steps } from '@astrojs/starlight/components'; In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. If you'd like to contribute code to this project, please follow the steps below: ## Solve an issue Scan through our [existing issues](https://github.com/withstudiocms/studiocms/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, you are welcome to open a PR with a fix. ## Make Changes 1. Fork the repository. - Using GitHub Desktop: - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! - Using the command line: - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. 2. Install or update **Node.js** and **pnpm**, to the versions specified in [`.prototools`](https://github.com/withstudiocms/studiocms/blob/main/.prototools). 3. Create a working branch and start with your changes! 4. Write tests for your changes, if applicable. 5. Update the documentation, if necessary. ## Commit your update Commit the changes once you are happy with them. ## Pull Request When you're finished with the changes, create a pull request, also known as a PR. - Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. - Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. - Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information. - We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. - As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). - If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues. ## Your PR is merged! Congratulations! The StudioCMS team thanks you. Your contribution will be part of the next release. Now that you are part of the StudioCMS community, you can help us review other PRs, answer questions, and help other contributors. If you haven't already, join our [Discord](https://chat.studiocms.dev) to connect with other contributors and the StudioCMS team. Oh and you will see your face in the [list of contributors][contributors]! 🎉 {/* Links */} [contributors]: /en/guides/contributing/getting-started/#our-contributors # Getting Started > Learn the basics of contributing to StudioCMS import ContributorList from '~/components/ContributorList.astro'; Thank you for investing your time in contributing to our project! Read our [Code of Conduct](https://github.com/withstudiocms/studiocms?tab=coc-ov-file#code-of-conduct-) to keep our community approachable and respectable. We welcome contributions from the community! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making this project better. To navigate our codebase with confidence, see [How it works][how-it-works] section. ## Our Contributors Our project exists thanks to all the people who contribute. [Join us on GitHub](https://github.com/withstudiocms/studiocms) and your profile picture will automatically appear in this list: ## Bug Reports and Feature Requests If you encounter a bug or want to suggest a new feature, please open an issue on our [GitHub repository](https://github.com/withstudiocms/studiocms). When creating a new issue, please provide as much detail as possible, including steps to reproduce the issue (for bugs) and a clear description of the proposed feature. {/* Links */} [how-it-works]: /en/how-it-works/ # Translations > Learn how to contribute translations to StudioCMS import ReadMore from '~/components/ReadMore.astro'; import { FileTree } from '@astrojs/starlight/components'; StudioCMS is a global project, and we want to make it accessible to everyone. If you are fluent in multiple languages, you can help us translate StudioCMS into your language. ## Hop on Discord Before you dive into translating, swing by our [Discord chat](https://chat.studiocms.dev). Being on Discord means you can get answers in real time and coordinate with other translators so nobody's unknowingly working on the same page. Plus, all our i18n discussions and style tips live there, making it the go-to spot for picking up on best practices and getting involved in decisions. :::tip[Can't access Discord?] We still want you to participate! Please open a new issue on GitHub for [Docs](https://github.com/withstudiocms/docs/issues/new/choose) or the [packages](https://github.com/withstudiocms/studiocms/issues/new/choose) to ask any questions you may have. ::: ## Package Translations Current translation status:

Visit [our i18n dashboard](https://crowdin.com/project/studiocms) to help translate the StudioCMS packages into your language. If your language is not listed, you can add it within the dashboard. **At this time we only support translation contributions via Crowdin.** And new translations should use the languages **International Locale** if available. Any Contribution to translation files via GitHub will be overwritten at the next Crowdin sync. Once the translations have been added and approved, they will be automatically added to the [StudioCMS i18n configuration](https://github.com/withstudiocms/studiocms/tree/main/packages/studiocms/src/virtuals/i18n) and will be available in the next release. All StudioCMS packages use [Crowdin](https://crowdin.com/) for managing translations on top of GitHub. If you are new to Crowdin, you can find the [For Translators guide](https://support.crowdin.com/for-translators/) on their website. ## Documentation Translations StudioCMS is actively working on translating their docs into multiple languages. Currently, we are aiming to translate the StudioCMS documentation into the following languages: - Spanish - French - German - Korean Big shout-out to our awesome community translators who volunteer their time to make our site available in the languages you see above. We'd love to support every language out there, but we need to focus on where we already have people ready to translate and keep things updated. Spinning up a new language means rallying a team and juggling multiple codebases, so we only roll out ones we've pre-approved and that have a crew lined up to tackle the full-site translation. ### Getting Started Swing by our [translation tracker](https://i18n.docs.studiocms.dev) to see the live status of every page—what's up-to-date, what needs tweaks, and which PRs are still waiting on reviews. It pulls in our local Git history to compare timestamps across all translations and auto-updates each page's status. Or jump straight into GitHub: filter your language's open PRs by the i18n label, skim for typos, or mistranslations, and give 'em a review. It's a great way to get your feet wet with how StudioCMS handles i18n! ### Structure of the documentation The docs repository contains three different kinds of translatable content: docs pages, and UI strings. The following file tree shows where to find these in the repository. - ... - src/ - ... - content/ - docs/ MDX page content, one directory per language - de/ - en/ - es/ - ... - i18n/ UI string translations, one file per language - de.json - en.json - es.json - ... - starlight-sidebar/ UI string translations for Sidebar, one file per language - de.json - en.json - es.json - ... - astro.config.ts - package.json - ... ### Translation Process Ready to dive in? Here's how to find what you need in the repo: 1. **Page-specific content** (page title, body copy, etc.) ➤ Go to `src/content/docs/{language}/{page-slug}.mdx` 2. **Shared text** (search modal, right sidebar, “next article” links, tutorials, etc.) ➤ Go to `src/content/i18n/{language}.json` 3. **Primary Sidebar Translations** ➤ Go to `src/starlight-sidebar/{language}.json` Once you've located your target file, peek at the [Translation Tracker](https://i18n.docs.studiocms.dev/) and existing PRs, maybe someone might already be on it. If it's free, shout out in the `docs-i18n` channel in Discord so nobody duplicates work! :::note Not sure if something should or not be translated? How does a certain component work? See our [Reference section](/en/config-reference/). ::: :::caution Not all of our pages are ready for translation, we roll out new pages for translation based on their stability, so do not translate any page that doesn't include a "Translate this page" button in the "Contribute" section of the right sidebar. ::: # Rendering Content > Options for rendering Content on a Custom Frontend import { Aside } from '@astrojs/starlight/components' import ReadMore from '~/components/ReadMore.astro' The StudioCMS rendering system is dynamic based on the current pageType. Example Catch-all route where the current page is grabbed from the SDK and the page data is passed to the renderer, in this case we are using the default `studiocms/markdown` pageType configured in the page settings, and wrapping that in a Layout like we do with the `@studiocms/blog` plugin. a pageBuilder plugin for example, may come without a standard layout, but instead intend on you designing the whole thing within the builder like you would on other CMS systems. ```astro title="src/pages/[...slug].astro" --- import { StudioCMSRenderer } from 'studiocms:renderer'; import { SDKCoreJs, runSDK } from 'studiocms:sdk'; import Layout from '../layouts/Layout.astro'; let { slug } = Astro.params; if (!slug) { slug = 'index'; } const { data: page } = await runSDK(SDKCoreJs.GET.page.bySlug(slug)) if (!page) { return new Response(null, { status: 404 }); } const { title, description, heroImage } = page; ---

``` ## Further Reading Want to build a custom renderer plugin for StudioCMS? Check out our guide on [Creating Custom Renderer Plugins](/en/plugins/renderers/) to learn how to extend StudioCMS with your own rendering logic. # Self-hosted libSQL server > Host your own sqld libSQL server with Docker import ReadMore from '~/components/ReadMore.astro' import { PackageManagers } from 'starlight-package-managers' import { FileTree, TabItem, Tabs, Steps, Aside } from '@astrojs/starlight/components'; The `sqld` ("SQL daemon") project is a server mode for libSQL created by Turso. This guide will go over setting up and configuring `sqld` to work from a docker container for your StudioCMS project. Learn more about `sqld` using their [Documentation][sql-docs] ## Prerequisites - [Docker and Docker Compose][docker-docs] (either running on a server or locally) - [OpenSSL][openssl-docs] installed - StudioCMS CLI (available from the root of your StudioCMS project) The final file structure will look something like this if testing locally: - docker-compose.yml - data/ - keys/ - my-studiocms-project/ - astro.config.mjs - studiocms.config.mjs - package.json - src/ ## Generate Private and Public keys From inside the `keys` directory run the following command to create a new PKCS#8-encoded Ed25519 key-pair: ```bash openssl genpkey -algorithm Ed25519 -out ./libsql.pem ``` Then extract the public key with: ```bash openssl pkey -in ./libsql.pem -pubout -out ./libsql.pub ``` This will generate a new PKCS#8 key-pair that will be used for the `sqld` server. ## Generate your JWT token Navigate to your studiocms project directory and run the following command: The output is the JWT auth token encrypted with your private key in both standard format as well as base64URLEncoded, which will be used for libSQL authentication. Keep in mind that the token will be valid for 1 year! ### Update your StudioCMS `.env` with the following: ```sh CMS_LIBSQL_URL=http://localhost:8080 # This should point to your docker server/local system CMS_LIBSQL_AUTH_TOKEN= # paste your Standard JWT auth token here ``` ## Setting up the Docker container Create a new `docker-compose.yml` file outside of the StudioCMS project directory, for the libSQL instance. At this point you have two options to configure libSQL authentication: - Using the public key file itself - Using the JWT token as an environment variable (the same CMS_LIBSQL_AUTH_TOKEN value you used in your .env file) ```yml services: libsql: image: ghcr.io/tursodatabase/libsql-server:latest platform: linux/amd64 ports: - "8080:8080" - "5001:5001" environment: - SQLD_NODE=primary - SQLD_AUTH_JWT_KEY_FILE=/home/.ssh/libsql.pub volumes: - ./data/libsql:/var/lib/sqld - ./keys/libsql.pub:/home/.ssh/libsql.pub ``` ```yml services: libsql: image: ghcr.io/tursodatabase/libsql-server:latest platform: linux/amd64 ports: - "8080:8080" - "5001:5001" environment: - SQLD_NODE=primary - SQLD_AUTH_JWT_KEY=paste your Base64URL Encoded JWT token here volumes: - ./data/libsql:/var/lib/sqld ``` ## Starting Everything up 1. Start the Docker container: From the base directory (or the server if you went that route) run the following command to start the libSQL Server container ```sh docker compose up -d ``` 2. Sync your StudioCMS database schema: Move into your StudioCMS project directory and run the following command: 3. Follow the first time setup for your new database. - See [Getting Started][getting-started] :::note If this is not your first time setting up a StudioCMS project you may need to enable the `dbStartPage` option in your `studiocms.config.mjs` ::: ## Final Thoughts If you are looking for an option for Self-hosting your own libSQL database with StudioCMS `sqld` is a viable option and is not very complicated to get up and running if you do it the right way, following this guide provides you with a secure libSQL server to use alongside your StudioCMS project. {/* Links */} [sql-docs]: https://github.com/tursodatabase/libsql/blob/main/docs/USER_GUIDE.md [docker-docs]: https://docs.docker.com/get-started/get-docker/ [openssl-docs]: https://docs.openssl.org/3.2/man7/ossl-guide-introduction/#getting-and-installing-openssl [getting-started]: /en/start-here/getting-started/#first-time-setup-or-during-updates-if-the-tables-schema-is-updated # Release Notes > Release notes for the studiocms package. The following is automated release notes for the `studiocms` package. For more information, see the [Changelog file](https://github.com/withstudiocms/studiocms/blob/main/packages/studiocms/CHANGELOG.md) ## 0.4.4 - [#1480](https://github.com/withstudiocms/studiocms/pull/1480) [`aebe8bc`](https://github.com/withstudiocms/studiocms/commit/aebe8bcb3618bb07c6753e3f5c982c1fe6adea64) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fix user filtering logic in RestApiSecureHandler - Updated dependencies \[[`3f7e6cf`](https://github.com/withstudiocms/studiocms/commit/3f7e6cf419781e714f6802117b8ead0e3ddd7f47)]: - Includes: effectify@0.2.0, @withstudiocms/api-spec@0.3.2, @withstudiocms/effect@0.4.1 ## 0.4.3 - [#1470](https://github.com/withstudiocms/studiocms/pull/1470) [`66b634c`](https://github.com/withstudiocms/studiocms/commit/66b634c0b0ecbf501c948cc6b7aa1f584ea2561d) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes createResetLink endpoints rank check - [#1472](https://github.com/withstudiocms/studiocms/pull/1472) [`87f0239`](https://github.com/withstudiocms/studiocms/commit/87f02392152c83ec5796c0dc2b6d82a69d6d4641) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Improves permission checks for user ranks during user creation in the REST API endpoint - [#1466](https://github.com/withstudiocms/studiocms/pull/1466) [`d65992d`](https://github.com/withstudiocms/studiocms/commit/d65992d780dfefb63a9bec747357cef57075b3f4) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes peerDependencies and associated metadata - [#1471](https://github.com/withstudiocms/studiocms/pull/1471) [`66b30b7`](https://github.com/withstudiocms/studiocms/commit/66b30b73e32af52ba4d72fbc994a073ae3397749) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Prevents unauthorized modification of user notification preferences ## 0.4.2 - [#1463](https://github.com/withstudiocms/studiocms/pull/1463) [`d17d916`](https://github.com/withstudiocms/studiocms/commit/d17d9162c10d0d8acd628da00374983769f56828) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes import paths, build scripts, and tweaks Astro config for StudioCMS installations - Updated dependencies \[[`d17d916`](https://github.com/withstudiocms/studiocms/commit/d17d9162c10d0d8acd628da00374983769f56828)]: - Includes: @withstudiocms/api-spec@0.3.1, effectify@0.1.1 ## 0.4.1 - [#1461](https://github.com/withstudiocms/studiocms/pull/1461) [`af78a9c`](https://github.com/withstudiocms/studiocms/commit/af78a9cf31623f96b93e3731edeff7aba6ec401a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes imports in Analytics plugin ## 0.4.0 - [#1401](https://github.com/withstudiocms/studiocms/pull/1401) [`de6bb17`](https://github.com/withstudiocms/studiocms/commit/de6bb17d75f74d91776658cf1a608eebe94be495) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Migrates RestAPI to utilize new API-Spec package for better type safety - [#1421](https://github.com/withstudiocms/studiocms/pull/1421) [`d7a0217`](https://github.com/withstudiocms/studiocms/commit/d7a0217e5ece55eddfa34399075614bef2041052) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Removes deprecated and unused SDK listpages endpoint, and updates the changelog json endpoint to not use .json in the pathname - [#1433](https://github.com/withstudiocms/studiocms/pull/1433) [`64ff643`](https://github.com/withstudiocms/studiocms/commit/64ff64357f5e34960a2a044d427350bcba389304) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Migrates StorageFileBrowser script to utilize new API spec client for typesafe API interactions - [#1440](https://github.com/withstudiocms/studiocms/pull/1440) [`9eec9c3`](https://github.com/withstudiocms/studiocms/commit/9eec9c3b45523b635cfe16d55aa55afabacbebe3) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Introduces new admin level api token revocation endpoint - [#1438](https://github.com/withstudiocms/studiocms/pull/1438) [`f4a209f`](https://github.com/withstudiocms/studiocms/commit/f4a209fc090c90195e2419fff47b48a46eab7441) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Refactors and cleans up API spec handlers to remove un-needed variables and tighten security - [#1448](https://github.com/withstudiocms/studiocms/pull/1448) [`35a1984`](https://github.com/withstudiocms/studiocms/commit/35a19845b30b6eed5b1273a40d99d9b405eeab9f) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Deprecates the `studiocmsMinimumVersion` setting from the plugins API, it is recommended to rely on `peerDependencies` instead. - [#1322](https://github.com/withstudiocms/studiocms/pull/1322) [`0ae47b0`](https://github.com/withstudiocms/studiocms/commit/0ae47b06a4ff03ed9cdf01b136e1a50f4c8c4add) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Migrate from Zod Schemas to Effect Schemas - [#1342](https://github.com/withstudiocms/studiocms/pull/1342) [`7773e9c`](https://github.com/withstudiocms/studiocms/commit/7773e9c094802d678edb89540b82744db7a4dcbd) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Moves to new data-middleware system for being able to handle dynamic authentication checks. - [#1375](https://github.com/withstudiocms/studiocms/pull/1375) [`c9f32d0`](https://github.com/withstudiocms/studiocms/commit/c9f32d07ab88fdd11806ace656748494b5a782ec) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Extends rendering functionality to allow site-wide post-processors, or single page post-processors (augments) - [#1430](https://github.com/withstudiocms/studiocms/pull/1430) [`a78f6d5`](https://github.com/withstudiocms/studiocms/commit/a78f6d513b0fc2bd7aa83837624460452a38539e) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Migrates dashboard components to use new api spec clients - [#1434](https://github.com/withstudiocms/studiocms/pull/1434) [`ef7197e`](https://github.com/withstudiocms/studiocms/commit/ef7197ed9ca8dff757e9e791b0452279aa3791ad) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Adds SDK utility endpoints for markdown rendering and user-list HTML, replacing legacy page partial routes. Consumers now go through the SDK utilities for these renders, and the markdown render route is POST-based. - [#1373](https://github.com/withstudiocms/studiocms/pull/1373) [`5d6ec77`](https://github.com/withstudiocms/studiocms/commit/5d6ec77bd7105118239fbd015f182e381dbfcb2c) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Reworks API handling and migrates to Effect HttpApi Spec - [#1429](https://github.com/withstudiocms/studiocms/pull/1429) [`1cc8957`](https://github.com/withstudiocms/studiocms/commit/1cc8957db3f1e3af2c5f4763103a0d7d46aa1c6d) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Migrates various frontend pages to utilize new dashboard API client - [#1374](https://github.com/withstudiocms/studiocms/pull/1374) [`33d3c2b`](https://github.com/withstudiocms/studiocms/commit/33d3c2bf91cf39abc15b5df136c9eeb01b1ba317) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Migrates frontend utils to use new API spec for SDK and Auth endpoints - [#1307](https://github.com/withstudiocms/studiocms/pull/1307) [`a855f94`](https://github.com/withstudiocms/studiocms/commit/a855f94e40b24c938dc09cdbacb72fee5a8a012a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - New Effect Schema based validation for plugin schemas - [#1322](https://github.com/withstudiocms/studiocms/pull/1322) [`0ae47b0`](https://github.com/withstudiocms/studiocms/commit/0ae47b06a4ff03ed9cdf01b136e1a50f4c8c4add) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Update Plugin hooks to align with new schemas - [#1311](https://github.com/withstudiocms/studiocms/pull/1311) [`2d2ff4e`](https://github.com/withstudiocms/studiocms/commit/2d2ff4e180e23215dcd4f95aa850a1844e0569a8) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Implements new Effect-based config schemas - [#1351](https://github.com/withstudiocms/studiocms/pull/1351) [`94b6d4f`](https://github.com/withstudiocms/studiocms/commit/94b6d4f53d40d95ae7238fb91839174d61f43c8b) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes folder deletion schema calls that caused folder deletion to return a server error - [#1381](https://github.com/withstudiocms/studiocms/pull/1381) [`07b3508`](https://github.com/withstudiocms/studiocms/commit/07b35088c55a817a218b1568dd9d3f418b01a26d) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Deduplicates API spec definitions and expands LocalsSessionData middleware context data - [#1287](https://github.com/withstudiocms/studiocms/pull/1287) [`2ea1074`](https://github.com/withstudiocms/studiocms/commit/2ea107448571e1d42bf0d21dd832b1e71e464a51) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update studiocms dependencies - [#1336](https://github.com/withstudiocms/studiocms/pull/1336) [`e85f46b`](https://github.com/withstudiocms/studiocms/commit/e85f46b6453b7a8abfdda7d1046399a1dbc99df6) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update dependency @inox-tools/runtime-logger to ^0.8.1 - [#1385](https://github.com/withstudiocms/studiocms/pull/1385) [`9ef4b85`](https://github.com/withstudiocms/studiocms/commit/9ef4b854ed5915d7653059154798adce4abca859) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update dependency @iconify-json/simple-icons to ^1.2.71 - [#1402](https://github.com/withstudiocms/studiocms/pull/1402) [`2123645`](https://github.com/withstudiocms/studiocms/commit/2123645553911c3b1f97958e67f9c5f14c47d5f5) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update dependency nanostores to ^1.1.1 - [#1442](https://github.com/withstudiocms/studiocms/pull/1442) [`ea2298e`](https://github.com/withstudiocms/studiocms/commit/ea2298e10a94a5334e75f9af806d9a03195206c8) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update dependency @iconify-json/simple-icons to ^1.2.72 - [#1453](https://github.com/withstudiocms/studiocms/pull/1453) [`fb59e23`](https://github.com/withstudiocms/studiocms/commit/fb59e23b3d906b69b8c53430ae594a5d895180d5) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update studiocms dependencies - [#1352](https://github.com/withstudiocms/studiocms/pull/1352) [`27fd734`](https://github.com/withstudiocms/studiocms/commit/27fd73476ccd06f4e8ec6b8a64d86319f21b083a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes outdated done page instructions - [#1446](https://github.com/withstudiocms/studiocms/pull/1446) [`7d2ebfb`](https://github.com/withstudiocms/studiocms/commit/7d2ebfb35a77982b31a7edc95bce01223f77cf15) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Code cleanup and OCD, purges dead and unused code - [#1441](https://github.com/withstudiocms/studiocms/pull/1441) [`39e367d`](https://github.com/withstudiocms/studiocms/commit/39e367d1433ef577b018586b347216df92e21d20) Thanks [@renovate](https://github.com/apps/renovate)! - fixes CSS lint error with duplicate CSS variable - [#1422](https://github.com/withstudiocms/studiocms/pull/1422) [`de78276`](https://github.com/withstudiocms/studiocms/commit/de78276f1f940be413a1510aa57cc4caa2aac6fd) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Ensures proper permissions for API route, and updates client script to align with new API spec - [#1353](https://github.com/withstudiocms/studiocms/pull/1353) [`54d5a3e`](https://github.com/withstudiocms/studiocms/commit/54d5a3eaec5b6bf3d75c190cf31f80ca27ebd96e) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes `studiocms init` optional option parsing - [#1281](https://github.com/withstudiocms/studiocms/pull/1281) [`b5d5719`](https://github.com/withstudiocms/studiocms/commit/b5d5719b612545622813f1a944313e61a08e50f8) Thanks [@renovate](https://github.com/apps/renovate)! - lint - [#1420](https://github.com/withstudiocms/studiocms/pull/1420) [`139b3a6`](https://github.com/withstudiocms/studiocms/commit/139b3a6820c848c9052e319f53a855172e023091) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Adds new config option for built-in API spec docs available in studiocms config as a boolean option `features.api.apiDocs` - Updated dependencies \[[`a67bcc0`](https://github.com/withstudiocms/studiocms/commit/a67bcc0967c49d366552b76ce1f061472020ade6), [`d7a0217`](https://github.com/withstudiocms/studiocms/commit/d7a0217e5ece55eddfa34399075614bef2041052), [`48a5334`](https://github.com/withstudiocms/studiocms/commit/48a5334051252f4f1192faa9023d56a41f9fe95c), [`07b3508`](https://github.com/withstudiocms/studiocms/commit/07b35088c55a817a218b1568dd9d3f418b01a26d), [`6280e24`](https://github.com/withstudiocms/studiocms/commit/6280e246369fa9732978a335ea6ddc3178f75e71), [`9a1180c`](https://github.com/withstudiocms/studiocms/commit/9a1180c6fe1e09599aa63a323ffcc4ba081a6e16), [`fbb5e47`](https://github.com/withstudiocms/studiocms/commit/fbb5e4749674ff4fd0593f37ae29614061d1f362), [`b7b76cb`](https://github.com/withstudiocms/studiocms/commit/b7b76cbb8e3b4ea4fe7f0d86e4f57acac47a94fe), [`3cff26c`](https://github.com/withstudiocms/studiocms/commit/3cff26c53e7b8ec1781ec7c390666a0276f50c46), [`5c0c17b`](https://github.com/withstudiocms/studiocms/commit/5c0c17b17a65046bcb93654d8bd7b0bfdad4c773), [`ff4e543`](https://github.com/withstudiocms/studiocms/commit/ff4e543a516350cd4139827b925061d8355d4932), [`ba50598`](https://github.com/withstudiocms/studiocms/commit/ba50598168030af18ccea5fedb263379507d5112), [`26d0584`](https://github.com/withstudiocms/studiocms/commit/26d05848b444cb53a26c6e89baa83203bf0398cc), [`466d3c5`](https://github.com/withstudiocms/studiocms/commit/466d3c599fdf54b95788e377cd0c817a53bb6fd3), [`d0ef542`](https://github.com/withstudiocms/studiocms/commit/d0ef542490b45bc65e276c30ae422b3386ed9f88), [`9eec9c3`](https://github.com/withstudiocms/studiocms/commit/9eec9c3b45523b635cfe16d55aa55afabacbebe3), [`f4a209f`](https://github.com/withstudiocms/studiocms/commit/f4a209fc090c90195e2419fff47b48a46eab7441), [`d0ef542`](https://github.com/withstudiocms/studiocms/commit/d0ef542490b45bc65e276c30ae422b3386ed9f88), [`6c9497d`](https://github.com/withstudiocms/studiocms/commit/6c9497d29f2dd84edc3400c1f9dda98e2aaf1ec8), [`0ae47b0`](https://github.com/withstudiocms/studiocms/commit/0ae47b06a4ff03ed9cdf01b136e1a50f4c8c4add), [`0cafedf`](https://github.com/withstudiocms/studiocms/commit/0cafedf4dee4edae1a2e859e6066365c4bea9ed5), [`de6bb17`](https://github.com/withstudiocms/studiocms/commit/de6bb17d75f74d91776658cf1a608eebe94be495), [`1e13417`](https://github.com/withstudiocms/studiocms/commit/1e1341773ea163ae25529b14877078e965899a30), [`9ea0cc9`](https://github.com/withstudiocms/studiocms/commit/9ea0cc90e69e98eb89c793f178928a3cff3f34a5), [`3cc5cff`](https://github.com/withstudiocms/studiocms/commit/3cc5cfffff082d6eaa1b928c1370e661b8cbde07), [`ef7197e`](https://github.com/withstudiocms/studiocms/commit/ef7197ed9ca8dff757e9e791b0452279aa3791ad), [`5d6ec77`](https://github.com/withstudiocms/studiocms/commit/5d6ec77bd7105118239fbd015f182e381dbfcb2c), [`33d3c2b`](https://github.com/withstudiocms/studiocms/commit/33d3c2bf91cf39abc15b5df136c9eeb01b1ba317), [`170adc4`](https://github.com/withstudiocms/studiocms/commit/170adc47216cefdce6b56e01973e3fa7812a1527), [`5d6ec77`](https://github.com/withstudiocms/studiocms/commit/5d6ec77bd7105118239fbd015f182e381dbfcb2c), [`0ae47b0`](https://github.com/withstudiocms/studiocms/commit/0ae47b06a4ff03ed9cdf01b136e1a50f4c8c4add), [`ae9ce1f`](https://github.com/withstudiocms/studiocms/commit/ae9ce1f73545a9db6b54b2bffc145a59ca598aaf), [`9eec9c3`](https://github.com/withstudiocms/studiocms/commit/9eec9c3b45523b635cfe16d55aa55afabacbebe3), [`8743206`](https://github.com/withstudiocms/studiocms/commit/87432066bf8c6788f1af0840b9a793e03d119815), [`5e56327`](https://github.com/withstudiocms/studiocms/commit/5e56327bf0084ab42eec8a59211a9f90a4611b81), [`b5d5719`](https://github.com/withstudiocms/studiocms/commit/b5d5719b612545622813f1a944313e61a08e50f8)]: - @withstudiocms/effect@0.4.0 - effectify@0.1.0 - @withstudiocms/api-spec@0.3.0 - @withstudiocms/sdk@0.3.0 - @withstudiocms/cli-kit@0.2.1 - @withstudiocms/internal\_helpers@0.2.0 - @withstudiocms/kysely@0.2.1 - @withstudiocms/config-utils@0.2.0 - @withstudiocms/auth-kit@0.1.4 - @withstudiocms/component-registry@0.1.4 ## 0.3.0 - [#1254](https://github.com/withstudiocms/studiocms/pull/1254) [`180b959`](https://github.com/withstudiocms/studiocms/commit/180b95972f9d51731eb570685e251532cbae2f62) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Replaces chalk with node:util's styleText - [#1271](https://github.com/withstudiocms/studiocms/pull/1271) [`9a450cb`](https://github.com/withstudiocms/studiocms/commit/9a450cb9167e2f2ea4c197bc812131d2fdeda6c9) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Removes deprecated and unused virtual modules. The following modules have been removed. - `studiocms:astro-config/adapter` - `studiocms:auth/utils/getLabelForPermissionLevel` - `virtual:studiocms/sdk/env` - [#1237](https://github.com/withstudiocms/studiocms/pull/1237) [`fb6c96a`](https://github.com/withstudiocms/studiocms/commit/fb6c96ac6ae25887a0f673618770a67b2deffae6) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update studiocms dependencies - [#1259](https://github.com/withstudiocms/studiocms/pull/1259) [`0525390`](https://github.com/withstudiocms/studiocms/commit/05253906d33a9b7bd12a27cdf2b8c9e9f693177f) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update studiocms dependencies - [#1267](https://github.com/withstudiocms/studiocms/pull/1267) [`d56b066`](https://github.com/withstudiocms/studiocms/commit/d56b066554848d819cc3dd59cfacfbda51565ad5) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update dependency @nanostores/persistent to ^1.3.0 - [#1255](https://github.com/withstudiocms/studiocms/pull/1255) [`e12e074`](https://github.com/withstudiocms/studiocms/commit/e12e074e6432398181be1f58f5c89df96a516cbb) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fix new type issues due to updated clack version - [#1270](https://github.com/withstudiocms/studiocms/pull/1270) [`c9727f7`](https://github.com/withstudiocms/studiocms/commit/c9727f7a218113d68254de825b84ddb926721b56) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes issue with pg and mysql2 being required to be installed when they should be optional - [#1272](https://github.com/withstudiocms/studiocms/pull/1272) [`38e74bb`](https://github.com/withstudiocms/studiocms/commit/38e74bbeec97e054e8545d6665452c5246a1fdd3) Thanks [@RATIU5](https://github.com/RATIU5)! - Fix client regex in frontend to allow for slashes within a slug, but not on the outside. This unblocks creating pages under sub-paths just using the slug (e.g., `docs/getting-started`) and only affects client-side validation. - [#1265](https://github.com/withstudiocms/studiocms/pull/1265) [`6d9b601`](https://github.com/withstudiocms/studiocms/commit/6d9b601b0a29ca2221d47efa65bc1356870e0339) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Removes legacy email domain verification code - [#1231](https://github.com/withstudiocms/studiocms/pull/1231) [`e7b39ef`](https://github.com/withstudiocms/studiocms/commit/e7b39ef6c3e1e2a54201e200b32fb1c02cd5fc3e) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fixes default 404 route rendering - Updated dependencies \[[`6b826b8`](https://github.com/withstudiocms/studiocms/commit/6b826b80104fe23e35763edf275f1800e5629c32), [`8b46bf5`](https://github.com/withstudiocms/studiocms/commit/8b46bf5861f3ab884bb8cbac1b73a1e97fcabe96), [`f129eec`](https://github.com/withstudiocms/studiocms/commit/f129eec8d0a6f18c446c319dec9925cc31a890b4), [`e12e074`](https://github.com/withstudiocms/studiocms/commit/e12e074e6432398181be1f58f5c89df96a516cbb)]: - @withstudiocms/internal\_helpers@0.1.1 - @withstudiocms/effect@0.3.0 - @withstudiocms/auth-kit@0.1.3 - @withstudiocms/component-registry@0.1.3 - @withstudiocms/sdk@0.2.0 ## 0.2.0 - [#1197](https://github.com/withstudiocms/studiocms/pull/1197) [`4b542ec`](https://github.com/withstudiocms/studiocms/commit/4b542eca8934996f7ed9eaf1c9f040305ea5e471) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Tweaks optional dependencies, and chunkSizeWarningLimit for Astro config to prevent warnings from WYSIWYG plugin - [#1219](https://github.com/withstudiocms/studiocms/pull/1219) [`9122ddd`](https://github.com/withstudiocms/studiocms/commit/9122ddd16f9c7ab61c5df227ae7a81edd8620bb0) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Move to updated and migrated cli-kit package - [#1222](https://github.com/withstudiocms/studiocms/pull/1222) [`0f6b4c7`](https://github.com/withstudiocms/studiocms/commit/0f6b4c74886f09ebf35ee73d5d8579d26f8e534a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Tweaks package linking to pnpm catalog - [#1211](https://github.com/withstudiocms/studiocms/pull/1211) [`b269e44`](https://github.com/withstudiocms/studiocms/commit/b269e44d68c8fd0da8eb3147c75b7d1cc899580d) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Adds regex and proper error handling to prevent illegal characters (non-url-safe) from being used for S3 objects. - [#1220](https://github.com/withstudiocms/studiocms/pull/1220) [`3324f2b`](https://github.com/withstudiocms/studiocms/commit/3324f2be74a6c7d21005d1cc0b4a8695f376c53b) Thanks [@kunjabijukchhe](https://github.com/kunjabijukchhe)! - Fixes an issue where saving a page that does not have `draft` set to true, would previously update the `publishedAt` date value. - [#1214](https://github.com/withstudiocms/studiocms/pull/1214) [`efc10be`](https://github.com/withstudiocms/studiocms/commit/efc10bee20db090fdd75463622c30dda390c50ad) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Fix: Reworks permission checks for dashboard routes to be at the middleware level to prevent unauthorized access - Updated dependencies \[[`0f6b4c7`](https://github.com/withstudiocms/studiocms/commit/0f6b4c74886f09ebf35ee73d5d8579d26f8e534a), [`93e62f6`](https://github.com/withstudiocms/studiocms/commit/93e62f65f779192403361826bc2a7fb997762521), [`2dd709f`](https://github.com/withstudiocms/studiocms/commit/2dd709f7f83efbb64c4ccb83f49db2d589ca9404), [`0f6b4c7`](https://github.com/withstudiocms/studiocms/commit/0f6b4c74886f09ebf35ee73d5d8579d26f8e534a), [`4b542ec`](https://github.com/withstudiocms/studiocms/commit/4b542eca8934996f7ed9eaf1c9f040305ea5e471), [`4b542ec`](https://github.com/withstudiocms/studiocms/commit/4b542eca8934996f7ed9eaf1c9f040305ea5e471), [`e628b43`](https://github.com/withstudiocms/studiocms/commit/e628b431f3128da1ad378138bdda2ca14794e76e), [`8a0ea71`](https://github.com/withstudiocms/studiocms/commit/8a0ea7176350b9526203d5722e1ff45d7fe6dfeb), [`59e5517`](https://github.com/withstudiocms/studiocms/commit/59e5517963cfd5f62fd3631b5ee69ae1e423ef50), [`c68668b`](https://github.com/withstudiocms/studiocms/commit/c68668b0a83341dd6cbdc378e1673017afef1d73)]: - Includes: @withstudiocms/cli-kit@0.2.0, @withstudiocms/effect@0.2.0, @withstudiocms/kysely@0.2.0, @withstudiocms/sdk@0.2.0, @withstudiocms/auth-kit@0.1.2, @withstudiocms/component-registry@0.1.2 ## 0.1.1 - [#1181](https://github.com/withstudiocms/studiocms/pull/1181) [`a169a89`](https://github.com/withstudiocms/studiocms/commit/a169a893338947b425e87057cc77401f33abcbfd) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update dependency @iconify-json/simple-icons to ^1.2.66 - [#1186](https://github.com/withstudiocms/studiocms/pull/1186) [`415a512`](https://github.com/withstudiocms/studiocms/commit/415a51241ffddf5045ad8f8d695a5f40a86b5af7) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - fix workspace package dependency specifiers - [#1187](https://github.com/withstudiocms/studiocms/pull/1187) [`1b2a0c5`](https://github.com/withstudiocms/studiocms/commit/1b2a0c57299544caeba18205ca85a8ca0381d7cb) Thanks [@aliozinan](https://github.com/aliozinan)! - Fix create folder bug in s3-storage PUT request handler - Updated dependencies \[[`415a512`](https://github.com/withstudiocms/studiocms/commit/415a51241ffddf5045ad8f8d695a5f40a86b5af7)]: - Includes: @withstudiocms/component-registry@0.1.1, @withstudiocms/auth-kit@0.1.1, @withstudiocms/sdk@0.1.1 ## 0.1.0 - [#1151](https://github.com/withstudiocms/studiocms/pull/1151) [`25e6fc0`](https://github.com/withstudiocms/studiocms/commit/25e6fc0cca879e77c49c35da5e9a28e582957988) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Migrates table imports to new `@withstudiocms/sdk/tables` export, and update other relevant imports - [#1153](https://github.com/withstudiocms/studiocms/pull/1153) [`0435b82`](https://github.com/withstudiocms/studiocms/commit/0435b82fbc40af767f065a990639b44cfefecf4d) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Update imports for Migrator to `@withstudiocms/sdk/migrator` - [#1132](https://github.com/withstudiocms/studiocms/pull/1132) [`e1c3052`](https://github.com/withstudiocms/studiocms/commit/e1c30524e7fd6ed8f7b85874f049d36ffb50afc8) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Refactor REST-API structure - [#1134](https://github.com/withstudiocms/studiocms/pull/1134) [`3a27939`](https://github.com/withstudiocms/studiocms/commit/3a279390d2688d464fc5476fac0faf2bada2c1fd) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Reworks table types to better align with actual table schema - [#1142](https://github.com/withstudiocms/studiocms/pull/1142) [`4b676ca`](https://github.com/withstudiocms/studiocms/commit/4b676ca9fe4a603d036c0d9e680fd5bed997cab2) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Consolidates auth api routes - [#1112](https://github.com/withstudiocms/studiocms/pull/1112) [`28f0e56`](https://github.com/withstudiocms/studiocms/commit/28f0e5614ae07c3f73b9c9fd102cd9bb8b912ca9) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Implements new FolderTree rendering system and updated content management inner sidebar - [#1128](https://github.com/withstudiocms/studiocms/pull/1128) [`96c98c2`](https://github.com/withstudiocms/studiocms/commit/96c98c2e420bf8526611e674f1f58dd3fa2f33a3) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Tweak categories and tag ID generation to try to solve ID issue with database entry, and enable categories and tag entry on pageData - [#1124](https://github.com/withstudiocms/studiocms/pull/1124) [`7c8a684`](https://github.com/withstudiocms/studiocms/commit/7c8a68431f9087d4c3b65b06c76093b462dcddb1) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update dependency @iconify-json/simple-icons to ^1.2.64 - [#1108](https://github.com/withstudiocms/studiocms/pull/1108) [`36eead9`](https://github.com/withstudiocms/studiocms/commit/36eead9e3b002491f1d3ddd562479b0ea381e2c0) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - dedupes storage manager resolver utility - [#1141](https://github.com/withstudiocms/studiocms/pull/1141) [`9c350ea`](https://github.com/withstudiocms/studiocms/commit/9c350ea47118aa83738ded08b01a2ee3c98875a9) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Consolidates the db-studio and storage api handlers into a new unified integrations route. - [#1136](https://github.com/withstudiocms/studiocms/pull/1136) [`3ab68b4`](https://github.com/withstudiocms/studiocms/commit/3ab68b4de1ba2730d5acf16804c5b452fb7fcc43) Thanks [@louisescher](https://github.com/louisescher)! - Fixes various CSS issues across all dashboard and auth pages. - [#1157](https://github.com/withstudiocms/studiocms/pull/1157) [`f8a2d34`](https://github.com/withstudiocms/studiocms/commit/f8a2d342cc3c35bf4478bb523bf28d78dd2d0404) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Add effect-language-service diagnostics scripts to all workspace packages - [#1107](https://github.com/withstudiocms/studiocms/pull/1107) [`3cf47d9`](https://github.com/withstudiocms/studiocms/commit/3cf47d90c38c1b70a1378dabe6e72bf4a0ae467c) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Creates user-available resolver utils to call dynamic storage api - [#1106](https://github.com/withstudiocms/studiocms/pull/1106) [`4ece96b`](https://github.com/withstudiocms/studiocms/commit/4ece96bb9b9a3180a2d840dc64ee647371ff693e) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Integrates Storage Manager API for Custom Image component to resolve image urls from storage - [#1103](https://github.com/withstudiocms/studiocms/pull/1103) [`249b674`](https://github.com/withstudiocms/studiocms/commit/249b67423122c589fd15ea83518837d11c444b11) Thanks [@apollo-git-bot](https://github.com/apps/apollo-git-bot)! - Translation Updated (PR: #1103) - [#1150](https://github.com/withstudiocms/studiocms/pull/1150) [`7439f48`](https://github.com/withstudiocms/studiocms/commit/7439f485691f7c95397e2da46f509fa36e55cd48) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Cleans up and consolidates all page partial routes - [#1166](https://github.com/withstudiocms/studiocms/pull/1166) [`feb85ad`](https://github.com/withstudiocms/studiocms/commit/feb85ada2084e4e83e3dfbb47b89f747a41979a0) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Replace instance of .returning/returningAll with transactions to properly support SQL dialects that do not support returning such as MySQL - [#1119](https://github.com/withstudiocms/studiocms/pull/1119) [`45b9470`](https://github.com/withstudiocms/studiocms/commit/45b9470867c552e87e5ea1f68e20f5e4386233ff) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Implements taxonomy management into the REST\_API - [#1116](https://github.com/withstudiocms/studiocms/pull/1116) [`845f147`](https://github.com/withstudiocms/studiocms/commit/845f14732a2d2a76159027b9ed29695f62ebf22c) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Reworks search into its own component and script so that it is easier to maintain, also streamlines search result design to align with new tree styles - [#1144](https://github.com/withstudiocms/studiocms/pull/1144) [`dfa40ff`](https://github.com/withstudiocms/studiocms/commit/dfa40ff0c145ef70c7f8d2bb6bd7aaf467e934d0) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Cleans up pnpm catalog dependencies - [#1138](https://github.com/withstudiocms/studiocms/pull/1138) [`db2778a`](https://github.com/withstudiocms/studiocms/commit/db2778ae77944a1e8bb362e49215cfefff5223d0) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - More RestAPI cleanup, and cleans up SDK api endpoints - [#1129](https://github.com/withstudiocms/studiocms/pull/1129) [`d59c4b0`](https://github.com/withstudiocms/studiocms/commit/d59c4b00d44b65bae84315d34fa3b721f9621136) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Replaced `@libsql/kysely-libsql` with `kysely-turso` #### BREAKING UPDATE All previous installs relying on `@libsql/kysely-libsql` should remove the old dependency and install the new `kysely-turso` dependency. - [#1100](https://github.com/withstudiocms/studiocms/pull/1100) [`d5c77ea`](https://github.com/withstudiocms/studiocms/commit/d5c77eaf352e0ce3d45b0ce761ce6370e5a7a4ff) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Implements file browser on site config and content management pages - [#1101](https://github.com/withstudiocms/studiocms/pull/1101) [`8f53993`](https://github.com/withstudiocms/studiocms/commit/8f539933716b9d3335a13c180e3c607e44a63f8a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Introduces new transformer option in component registry and creates new StorageAPI transformer to allow Storage API automatic url swapping - [#1160](https://github.com/withstudiocms/studiocms/pull/1160) [`30de271`](https://github.com/withstudiocms/studiocms/commit/30de271f347a3a997669c8118006143148efb33a) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Refactors code to handle Effect LSP diagnostic warnings and errors - [#1111](https://github.com/withstudiocms/studiocms/pull/1111) [`e26ff92`](https://github.com/withstudiocms/studiocms/commit/e26ff92c731776156dfdb6830b5ebbccaf05acbf) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Implements new component registry UI for content editing and System management pages. - [#1117](https://github.com/withstudiocms/studiocms/pull/1117) [`87a5ed0`](https://github.com/withstudiocms/studiocms/commit/87a5ed0fdf3a23b0c743f38a42a814b7d68f496d) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Implements categories and tags management for the StudioCMS Dashboard - [#1172](https://github.com/withstudiocms/studiocms/pull/1172) [`3af3578`](https://github.com/withstudiocms/studiocms/commit/3af357827ad2ef1f2a7c41b8b4d459ecc743fc69) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Update readme to remove beta warning - [#1163](https://github.com/withstudiocms/studiocms/pull/1163) [`cd865cf`](https://github.com/withstudiocms/studiocms/commit/cd865cf995c3b926900b347ee0782d9ccecc1d4f) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Removes deprecated hideDefaultIndex site config variable from SDK and updates all instances of usage in StudioCMS #### Breaking Change Note for anyone previously relying on this feature, it has now been completely removed. Users will need to adjust any code relying on this functionality. - [#1099](https://github.com/withstudiocms/studiocms/pull/1099) [`359e655`](https://github.com/withstudiocms/studiocms/commit/359e65541206e5d10c3fef67666bc883f81e2f85) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Introduces StorageManager API to SDK and allow resolving image urls for site config and pagedata - [#1137](https://github.com/withstudiocms/studiocms/pull/1137) [`860337f`](https://github.com/withstudiocms/studiocms/commit/860337f73d2c6bb56135f16146c524721600057e) Thanks [@louisescher](https://github.com/louisescher)! - Fixes edit page tabs overflowing - [#1098](https://github.com/withstudiocms/studiocms/pull/1098) [`80285ec`](https://github.com/withstudiocms/studiocms/commit/80285ecf94078c1f99912fa88bd230a42e106bbd) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Add file browser access to system management page with identifier output utility - [#1135](https://github.com/withstudiocms/studiocms/pull/1135) [`1e85356`](https://github.com/withstudiocms/studiocms/commit/1e8535629363c518549ff3606710ae000245aa8a) Thanks [@louisescher](https://github.com/louisescher)! - Adjusts CSS to allow for a full-size editor window and fixes some spacing on the editor page. - [#1102](https://github.com/withstudiocms/studiocms/pull/1102) [`c36800e`](https://github.com/withstudiocms/studiocms/commit/c36800e5e13173e6d3a030d060774d223892d6e2) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Implements Storage manager url generator for content edit page - [#1126](https://github.com/withstudiocms/studiocms/pull/1126) [`4a4db87`](https://github.com/withstudiocms/studiocms/commit/4a4db87f755bf9e5f6d46c8daa04a48591395dff) Thanks [@Adammatthiesen](https://github.com/Adammatthiesen)! - Reworks CLI to fix async/sync code handling for `studiocms users` command - Updated dependencies \[[`25e6fc0`](https://github.com/withstudiocms/studiocms/commit/25e6fc0cca879e77c49c35da5e9a28e582957988), [`87a5ed0`](https://github.com/withstudiocms/studiocms/commit/87a5ed0fdf3a23b0c743f38a42a814b7d68f496d), [`3a27939`](https://github.com/withstudiocms/studiocms/commit/3a279390d2688d464fc5476fac0faf2bada2c1fd), [`96c98c2`](https://github.com/withstudiocms/studiocms/commit/96c98c2e420bf8526611e674f1f58dd3fa2f33a3), [`87d36ba`](https://github.com/withstudiocms/studiocms/commit/87d36ba83d24d83c7b2b17daa47231a63c225fa2), [`fc33e3f`](https://github.com/withstudiocms/studiocms/commit/fc33e3fb2c3568331be89b43a3a892317834f43a), [`9bde767`](https://github.com/withstudiocms/studiocms/commit/9bde7670e3813828615354ec5f99b5188487eb48), [`f8a2d34`](https://github.com/withstudiocms/studiocms/commit/f8a2d342cc3c35bf4478bb523bf28d78dd2d0404), [`e359a69`](https://github.com/withstudiocms/studiocms/commit/e359a69d2cad6db0b665908bdee67f02d418877a), [`b4d7879`](https://github.com/withstudiocms/studiocms/commit/b4d7879ae9ea93f199bcf187c8cd940efb405ad9), [`feb85ad`](https://github.com/withstudiocms/studiocms/commit/feb85ada2084e4e83e3dfbb47b89f747a41979a0), [`4ffae83`](https://github.com/withstudiocms/studiocms/commit/4ffae83377c75efe7c26c45d3cb360394fba5001), [`d59c4b0`](https://github.com/withstudiocms/studiocms/commit/d59c4b00d44b65bae84315d34fa3b721f9621136), [`cb8ffda`](https://github.com/withstudiocms/studiocms/commit/cb8ffda2d6fb31e3a754996b3e938a5c1b643af1), [`e1c3052`](https://github.com/withstudiocms/studiocms/commit/e1c30524e7fd6ed8f7b85874f049d36ffb50afc8), [`9007ca5`](https://github.com/withstudiocms/studiocms/commit/9007ca5d8d6c471ee25f07bd2f0a101ba195440c), [`8f53993`](https://github.com/withstudiocms/studiocms/commit/8f539933716b9d3335a13c180e3c607e44a63f8a), [`30de271`](https://github.com/withstudiocms/studiocms/commit/30de271f347a3a997669c8118006143148efb33a), [`9bde767`](https://github.com/withstudiocms/studiocms/commit/9bde7670e3813828615354ec5f99b5188487eb48), [`cd865cf`](https://github.com/withstudiocms/studiocms/commit/cd865cf995c3b926900b347ee0782d9ccecc1d4f), [`359e655`](https://github.com/withstudiocms/studiocms/commit/359e65541206e5d10c3fef67666bc883f81e2f85), [`0435b82`](https://github.com/withstudiocms/studiocms/commit/0435b82fbc40af767f065a990639b44cfefecf4d)]: - @withstudiocms/kysely@0.1.0 - @withstudiocms/sdk@0.1.0 - @withstudiocms/auth-kit@0.1.0 - @withstudiocms/effect@0.1.0 - @withstudiocms/component-registry@0.1.0 - @withstudiocms/config-utils@0.1.0 - @withstudiocms/internal\_helpers@0.1.0 - @withstudiocms/template-lang@0.1.0 ## 0.1.0-beta.32 - For previous version changelogs, see [CHANGELOG.beta.md](https://github.com/withstudiocms/studiocms/blob/main/packages/studiocms/CHANGELOG.beta.md) # Upgrade: v0.1.0 > Upgrade StudioCMS to v0.1.0 import ReadMore from '~/components/ReadMore.astro' import { PackageManagers } from 'starlight-package-managers' import { FileTree, TabItem, Tabs, Steps, Aside } from '@astrojs/starlight/components'; StudioCMS `0.1.0` introduces several breaking changes, new features, and bug fixes. This guide will help you navigate the upgrade process smoothly. ## Breaking changes - Replaced `@libsql/kysely-libsql` with `kysely-turso` for Turso database client. If you were using `@libsql/kysely-libsql` in your project, please update your dependencies to use `kysely-turso` instead. - **Steps to migrate:** 1. Remove `@libsql/kysely-libsql` from your `package.json` dependencies. 2. Install `kysely-turso` by running: - Removes deprecated hideDefaultIndex site config variable from SDK and updates all instances of usage in StudioCMS. - Note for anyone previously relying on this feature, it has now been completely removed. Users will need to adjust any code relying on this functionality. - Migrates table imports to new `@withstudiocms/sdk/tables` export, and updated relevant imports. - Migrates migration system to StudioCMS SDK and updated imports for Migrator to `@withstudiocms/sdk/migrator`. ## New Features - Added new Storage API for StudioCMS files and Assets. - This new API provides a standardized way to manage files and assets within StudioCMS, allowing for better integration with various storage backends. - Check out the [Storage API Documentation](/en/storage-api/) for more details on how to use the new Storage API in your projects. - Implements new FolderTree rendering system and updated content management inner sidebar - Implements taxonomy management in the StudioCMS dashboard - Adds Taxonomy support for REST API and SDK - Adds Taxonomy management UI in the StudioCMS Dashboard - Implements new component registry UI for content editing and System management pages. - Fixes issue with debug info having Unavailable outputs during PROD ## Bug Fixes & Improvements - Reworks table types to better align with actual table schemas and improve type safety across the SDK. - Improves error handling and logging for database operations to aid in debugging and maintenance. - Fixes various CSS issues across all dashboard and auth pages. - Ensures DB Studio custom element is defined if dev-toolbar is not present - Reworks CLI to fix async/sync code handling for `studiocms users` command - Replaced all instances of `.returning()`/`returningAll()` with transactions to properly support SQL dialects that do not support returning such as MySQL **Further Reading** For a full list of changes in this release, please refer to the [Changelog](/en/guides/upgrade/release-notes/#010-beta32). # Upgrade: 0.1.0-beta.16 > Upgrade StudioCMS to Beta.16 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' ## Breaking Changes - Updated minimum Astro version to `Astro v5.7.1` - Updated Password security - Users should be instructed to update passwords after updating, legacy password hashing support will be removed in the future. ## New Features/Functionality - CLI Updates/Changes - New Command: `studiocms add ` for quickly adding new plugins to your StudioCMS project. - New Command: `studiocms crypto [command]` for new security utilities. - New Command: `studiocms crypto gen-jwt ` for generating JWT tokens from the CLI. - Fix: Editing users from the CLI is now possible thanks to new partial db drizzle schema for Users and Permissions. For more information about the new CLI commands checkout [The CLI][cli-docs] documentation {/* Links */} [cli-docs]: /en/how-it-works/cli/ # Upgrade: 0.1.0-beta.17 > Upgrade StudioCMS to Beta.17 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' No major changes in this version, but we have made some optimizations and bug fixes to improve the overall performance and stability of StudioCMS. ## Patch Overview - **New Features** - Introduced a new feedback system in the dashboard. - **Bug Fixes** - Resolved issues with Astro Fonts. - Improved keyfile path detection for the [`crypto gen-jwt`](/en/how-it-works/cli/#crypto-gen-jwt) CLI command. - **Improvements** - Replaced [lodash](https://www.npmjs.com/package/lodash) with [deepmerge-ts](https://www.npmjs.com/package/deepmerge-ts) for better performance. - Optimized promise handling in middleware and updated permission level processing. # Upgrade: 0.1.0-beta.18 > Upgrade StudioCMS to Beta.18 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Breaking Changes - New Hook based plugin system - See the updated [Plugins Docs][plugin-doc] for more info. ## Bug fixes - Refactor `gen-jwt` command - See the updated [CLI docs][cli-doc] for more info. {/* Links */} [plugin-doc]: /en/plugins/ [cli-doc]: /en/how-it-works/cli/#crypto-gen-jwt # Upgrade: 0.1.0-beta.19 > Upgrade StudioCMS to Beta.19 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Breaking Changes - StudioCMS now **only support NodeJS 20 and higher** - New Config structure, please verify your `studiocms.config.*` file when updating. Config files can also end in `.js`, `.mjs`, `.ts`, `.mts` now! Allowing flexibility, and full type-safety. For more information related to these changes checkout the new [Config Reference][config-doc] - Image Service has been migrated to the plugin system. If you were previously using the `cloudinary-js` image service you will need to migrate to utilizing the new [`@studiocms/cloudinary-image-service` plugin][cloudinary-plugin], and configure your [preferredImageService][image-service] - Integrated [Effect][effect-website], and migrated most of the codebase to an Effect based structure. (old functions have been deprecated to allow migration to new Effects) - Added support for `@studiocms/web-vitals` to replace `@astrojs/web-vitals` in the future. Note, Astro has deprecated `@astrojs/web-vitals` and asked us to maintain the package, please update to the new package to prevent future issues as we plan to remove support for the old package in a future update. For more information about web-vitals checkout our [Web-Vitals plugin guide][web-vitals-guide] ## Bug fixes - Removed usage of remote google fonts for the dashboard, resolving potential network blocking issues. {/* Links */} [config-doc]: /en/config-reference/ [image-service]: /en/config-reference/features/#preferredimageservice [cloudinary-plugin]: /en/package-catalog/studiocms-plugins/studiocms-cloudinary-js/ [web-vitals-guide]: /en/package-catalog/ {/* External Links */} [effect-website]: https://effect.website # Upgrade: 0.1.0-beta.20 > Upgrade StudioCMS to Beta.20 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Bug fixes - Fixed First time setup routes that used a unavailable middleware feature during first time setup, causing the first time setup to fail. {/* Links */} [config-doc]: /en/config-reference/ [image-service]: /en/config-reference/features/#preferredimageservice [cloudinary-plugin]: /en/package-catalog/studiocms-plugins/studiocms-cloudinary-js/ {/* External Links */} [effect-website]: https://effect.website # Upgrade: 0.1.0-beta.21 > Upgrade StudioCMS to Beta.21 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Bug fixes - Implement fixes for First-time-setup, auth API routes and css for font, and markdown pageType config. {/* Links */} [config-doc]: /en/config-reference/ [image-service]: /en/config-reference/features/#preferredimageservice [cloudinary-plugin]: /en/package-catalog/studiocms-plugins/studiocms-cloudinary-js/ {/* External Links */} [effect-website]: https://effect.website # Upgrade: 0.1.0-beta.22 > Upgrade StudioCMS to Beta.22 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Breaking Changes - Remove deprecated `@astrojs/web-vitals` support in favor of new `@studiocms/web-vitals` package. See the [Web Vitals Guide][web-vitals-guide] for more information. - `studiocms:component-proxy` has been replaced by `studiocms:component-registry`. - Added `studiocms:component-registry/runtime` virtual module which exports types, and the following helpers, `getRegistryComponents` and `getRendererComponents` used for getting Components with props, and the renderer components respectively. - `importComponentKeys` has been carried over but deprecated in favor for the new `getRendererComponents` function. - All internal base included pageTypes have been removed, allowing even more flexibility when it comes to how studiocms works for the user. This change also means that you will be required to install at least one rendering plugin for studiocms. - The `@studiocms/html` and `@studiocms/md` plugins have been introduced to handle HTML and MD support respectively. See the [HTML Plugin][studiocms-html] and [MD Plugin][studiocms-md] documentation for more details. - If you were using the `studiocms/markdown` or `studiocms/html` pageTypes, you will need to install the respective plugin and update your configuration accordingly. - Remove Deprecated SDK functions and refactor SDK to make it easier to modify/read. - Remove previously deprecated functions and old password hashing system. ## New Features - Markdown and HTML page types have been modularized into separate plugins. - Added a new configuration utilities package for improved configuration management. - Refactored component registry and SDK for improved maintainability and easier modification. - OAuth endpoints streamlined for better authentication handling. - New `componentRegistry` system for handling user-defined components, allowing for more flexibility in how components are registered and used within StudioCMS. ## Bug fixes - Add support for the SDK folder getter to get by name or ID instead of just ID, and add jsdoc comments to missing functions for the SDK. - Fix: Correct exports for components, layouts, and add export for styles {/* Links */} [config-doc]: /en/config-reference/ [web-vitals-guide]: /en/package-catalog/ [studiocms-html]: /en/package-catalog/studiocms-plugins/studiocms-html/ [studiocms-md]: /en/package-catalog/studiocms-plugins/studiocms-md/ # Upgrade: 0.1.0-beta.23 > Upgrade StudioCMS to Beta.23 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Breaking Changes - Refactor oAuth: oAuth providers have been modularized into separate plugins. This means that you will need to install the respective plugin for each oAuth provider you want to use. The existing oAuth providers have been moved to their respective plugins: - [`@studiocms/auth0` for Auth0][auth0-plugin] - [`@studiocms/discord` for Discord][discord-plugin] - [`@studiocms/github` for GitHub][github-plugin] - [`@studiocms/google` for Google][google-plugin] ## Bug fixes - Fix sdk: Correct issue where the `CMSSiteConfigId` is undefined during initialization. - Fix UserQuickTools Widget: Tweak user quick tools widget and endpoint to prevent an actual 400 error on the user browser {/* Links */} [auth0-plugin]: /en/package-catalog/studiocms-plugins/studiocms-auth0/ [discord-plugin]: /en/package-catalog/studiocms-plugins/studiocms-discord/ [github-plugin]: /en/package-catalog/studiocms-plugins/studiocms-github/ [google-plugin]: /en/package-catalog/studiocms-plugins/studiocms-google/ # Upgrade: 0.1.0-beta.24 > Upgrade StudioCMS to Beta.24 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Breaking Changes - Added new `StudioCMSPluginData` table to AstroDB for usage by StudioCMS plugins, as well as new SDK plugin utilities for dynamic table typing. ## Bug fixes - Added export for `component-registry/types`. - Optimized `user-quick-tools` widget. - Introduced new middleware SDK module to ensure cache objects are initialized and not empty. - Converted internal `robotstxt` to proper Zod schema and cleaned up related code. - Updated editor page to also inject an id variable for the current page. # Upgrade: 0.1.0-beta.25 > Upgrade StudioCMS to Beta.25 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Features - Refactor dashboard content management components to eliminate inline scripts and improve code reusability. - Refactor usage of effect to utilize new enhanced utilities from new `@withstudiocms/effect` package. - Updates to utilize new `@withstudiocms/component-registry` package. - Migrate API routes to new createEffectAPIRoutes utility from `@withstudiocms/effect`. - Optimize login page preview on Config page and first-time setup. - Optimize `threejs` login page, ensuring fast page load. ## Bug fixes - Unifies date-time config on last updated check for version check modal. - Cleanup code, fix first time setup oauth, and cleanup old utils. - Consolidate table definitions into config and remove legacy tables file. # Upgrade: 0.1.0-beta.26 > Upgrade StudioCMS to Beta.26 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Breaking Changes - Updated Astro DB Table schema (Users will be required to run `astro db push --remote` to update their table schema) - Implements new DB table for dynamic config storage in unified table. - Updated AstroDB table config to utilize enums for permissions. - Remove deprecated locals from middleware in favor of a joined StudioCMS locals object. - Removed top-level Astro.Locals keys: - `SCMSGenerator`, `SCMSUiGenerator`, `latestVersion`, `siteConfig`, `defaultLang`, `routeMap` - `userSessionData`, `emailVerificationEnabled`, `userPermissionLevel` - `wysiwygCsrfToken` (renamed) - New location: - Access these under `Astro.locals.StudioCMS`. - Renames: - `wysiwygCsrfToken` → `editorCSRFToken` (under StudioCMS) - Migration examples: - Before: ```ts const { siteConfig, defaultLang } = Astro.locals; ``` - After: ```ts const { siteConfig, defaultLang } = Astro.locals.StudioCMS; ``` - Before: ```ts const token = Astro.locals.wysiwygCsrfToken; ``` - After: ```ts const token = Astro.locals.StudioCMS.editorCSRFToken; ``` ## Features - Update to `@studiocms/ui` 1.0 beta. ## Bug fixes - Adjust SDK page lookup to return undefined when a page is not found, eliminating noisy Astro errors in development. - Fix form data conversion on first time setup. # Upgrade: 0.1.0-beta.27 > Upgrade StudioCMS to Beta.27 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## New Features - Refactor CLI to utilize new Effect-ful clack module from `@withstudiocms/effect` - Migrate CLI to new `@withstudiocms/auth-kit` package - Setup initial testing for StudioCMS. ## Bug fixes - Enable the "Draft" toggle on the Edit Page for all pages (including the index page) so the draft field is submitted with the form. Previously the disabled control omitted this field from the payload, preventing changes to draft status. - Ensure slug is not an empty string, or an invalid slug. - Rename internal file to avoid confusion with tests during development. - Correct parameter in CLI add command. # Upgrade: 0.1.0-beta.28 > Upgrade StudioCMS to Beta.28 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Breaking Changes - Deprecates and hides the "Hide Index Page" setting from dashboard. Users who previously relied on this setting should migrate to another method. - Implements new rendering system, allowing plugins to augment the rendering pipeline with prefix, suffix, or simple component augmentation. This is a breaking change for plugin authors who have implemented custom renderers. See the [Plugin Renderer Documentation][plugin-renderer-docs] for more details on how to migrate existing renderers to the new system. - Deprecates the legacy StudioCMSSiteConfig, StudioCMSMailerConfig, and StudioCMSNotificationSettings tables to be fully removed in a future release. - Users will need to run `astro db push --remote` to ensure their DB schemas are up-to-date. ## New Features - Introduces a new email template editor and preview feature in the StudioCMS dashboard, allowing users to customize email templates directly from the UI. - Enables Multi-language support for StudioCMS dashboard. - Implements a better API route type PluginAPIRoute from the `studiocms/plugins` export for plugin `onCreate`, `onEdit`, and `onDelete` API handlers. - Reorganizes create and edit content pages, as well as SMTP config page. ## Bug fixes & Improvements - Updates to `@studiocms/ui@1.0.0-beta.3` and cleanup now unneeded styles. - Replaces custom CSS search icon with Input component icon prop and removes unused CSS. - Fixes the form validation parsing of boolean select fields values by transforming the string values to boolean for content management pages. - Updates feedback button to point to GitHub (temporary measure until astro-feedback integration). - Fixes zod error parsing for first-time setup api route responses. - Updates quick user tools, Logout page, and buttons to utilize POST requests. - Optimizes middleware cache for improved performance. - Refactors internal file structure of Astro frontend pages and api endpoints to simplify long-term maintenance. - Improve page creation and edit data processing for better consistency and reliability. - Move avatar loading to client-side to eliminate render blocking. {/* Links */} [plugin-renderer-docs]: /en/plugins/renderers/ # Upgrade: 0.1.0-beta.29 > Upgrade StudioCMS to Beta.29 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Bug Fixes & Improvements - Updated `@studiocms/ui` to `1.0.0-beta.4` to address Astro Picocolors bug - Updated various other dependencies to their latest versions # Upgrade: 0.1.0-beta.30 > Upgrade StudioCMS to Beta.30 import ReadMore from '~/components/ReadMore.astro' import QuickUpdate from '~/components/QuickUpdate.astro' import { Aside } from '@astrojs/starlight/components' ## Bug Fixes & Improvements - Updated First-time setup scripts to fix picocolor bug - Updated various other dependencies to their latest versions # Upgrade: 0.1.0-beta.31 > Upgrade StudioCMS to Beta.31 import ReadMore from '~/components/ReadMore.astro' import { PackageManagers } from 'starlight-package-managers' import { FileTree, TabItem, Tabs, Steps, Aside } from '@astrojs/starlight/components'; StudioCMS `0.1.0-beta.31` introduces significant changes, including a new Kysely based database layer, a revamped plugin system, and various new features and improvements. This guide will help you upgrade your existing StudioCMS project to the latest version. ## Breaking changes - Refactored Plugin System. Please see the [Plugin docs](/en/plugins/) for more details. - Implemented new Kysely based database layer. - Removed support for config options directly passed to the StudioCMS astro integration, now all config options must be defined in `studiocms.config.mjs` file. Please see the [Config Reference](/en/start-here/configuration/) for more details. ## New Features - Implemented new [`studiocms migrate`](/en/how-it-works/cli/#migrate) command to handle database migrations. - Allow disabling Generator meta tags via [`features.dashboard.security.hideGeneratorTags`](/en/config-reference/features/#hidegeneratortags) config option. - StudioCMS now supports different database dialects via [Kysely](https://kysely.dev/). - Introduced new middleware to display system errors on pages with errors instead of crashing the entire site. - New plugin features: - Dynamic components and scripts injection to the dashboard via new plugin hooks. - New db helpers for easier database access within plugins. - Introduced new Dashboard page for managing the System management. - Includes a System info (debug) panel - Provides quick access to your database tables while in production. - Added the new developer toolbar app built-in to StudioCMS for viewing and managing your database while in development mode. - Integrated optional web-vitals/analytics tracking into the dashboard for better performance insights. - This can be enabled via the [`features.webVitals`](/en/config-reference/features/#webvitals) config option. - For those who previously used the `@studiocms/web-vitals` or `@astrojs/web-vitals` integrations, this is now built-in and can be configured via the StudioCMS config. - Added new CLI command [`studiocms debug`](/en/how-it-works/cli/#debug) to quickly access helpful debug information about your StudioCMS project. ## Bug Fixes & Improvements - Updated ghost user image url. - Refactored page data `urlRoute` generation to resolve correctly. - Refactored and simplified dashboard layout components. - Improved StudioCMS config types and JSDoc comments. - Refactored CLI commands to use new database layer. - Introduced new debug utilities for easier access to helpful debug information. ## Migration Steps To upgrade your StudioCMS project to version `0.1.0-beta.31`, please follow these steps: 1. **Update your StudioCMS dependencies** to the latest version: 2. **If you have custom plugins**, ensure they are updated to be compatible with the new plugin system. Refer to the [Plugin docs](/en/plugins/) for guidance. 3. **Review your `studiocms.config.mjs` file** to ensure all configuration options are correctly set according to the new schema. Refer to the [Config Reference](/en/start-here/configuration/) for details. - **Previously used `@studiocms/web-vitals` or `@astrojs/web-vitals` integrations?** Remove them from your project dependencies and configure the built-in web vitals tracking via the `features.webVitals` option in your `studiocms.config.mjs` file: ```ts {3} title="studiocms.config.mjs" export default defineStudioCMSConfig({ features: { webVitals: true, }, }); ``` 4. **Setup a new database connection for the new Kysely based database layer.** Update your `.env` file with the necessary database connection details. Keep your previous database intact for migration. Refer to the [Database Setup Guide](/en/start-here/getting-started/#prepare-your-database) for more information on configuring your database. Refer to the [Environment Variables Docs](/en/start-here/environment-variables/) for more information on configuring your environment variables. 5. **Configure your database dialect in `studiocms.config.mjs` under the `db` option. For example, to use libSQL:** ```ts {3} title="studiocms.config.mjs" export default defineStudioCMSConfig({ db: { dialect: 'libsql', // or 'postgresql', 'mysql' }, }); ``` 6. **Install the necessary database client packages** for your chosen database dialect: 7. **Download the migration tool into the root of your StudioCMS project:** This tool will read your `studiocms.config.mjs` file to be able to connect to the correct database dialect. 8. **Running Schema Migrations:** Since the database layer has changed, you will need to run migrations to update your database schema to be compatible with the new version. There is two ways to do this: Built into the StudioCMS CLI is a new `migrate` command that will run the necessary migrations for you. To use it, run the following command in your project directory: You will be prompted to select an option to, migrate your database schema to the latest version, rollback to a previous version, or view the current migration status. Select "Migrate to Latest" to update your database schema. Alternatively, you can use the migration tool you installed in previous step. To do this, continue to the next step, and use the Web UI to run the migrations. 9. **Run the Migration Tool Web UI:** Start the migration tool by running the following command in your project directory: This will start a local web server. Open your browser and navigate to `http://localhost:4321` to access the migration tool interface. This interface will give you options to migrate your database schema, as well as migrating your data from your old database to the new one. 1. Once the migration is complete, **start your StudioCMS project** as usual: Your project should now be running with the updated database schema and configuration. ## Final Notes - Ensure you have backups of your database before performing migrations. - Test your application thoroughly after the migration to catch any issues early. - Refer to the [StudioCMS documentation](/en/start-here/getting-started/) for more information on new features and changes. - If you encounter any issues during the migration process, please reach out on our [Discord community](https://chat.studiocms.dev), or open an issue on our [GitHub repository](https://github.com/withstudiocms/studiocms/issues). # Upgrade: v0.2.0 > Upgrade StudioCMS to v0.2.0 import QuickUpdate from '~/components/QuickUpdate.astro' ## Breaking changes None. This is a non-breaking release. ## Bug Fixes & Improvements - Migrated to the updated cli-kit package for improved CLI functionality. - Added regex and proper error handling to prevent illegal characters (non-url-safe) from being used for S3 objects. - Fixed an issue where saving a page that does not have `draft` set to `true`, would previously update the `publishedAt` date value. - Reworked permission checks for dashboard routes to be at the middleware level to prevent unauthorized access. - Updated various dependencies to their latest versions to ensure security and stability. # Upgrade: v0.3.0 > Upgrade StudioCMS to v0.3.0 import QuickUpdate from '~/components/QuickUpdate.astro' ## Breaking changes - Removes the following deprecated and unused virtual modules. - `studiocms:astro-config/adapter` - `studiocms:auth/utils/getLabelForPermissionLevel` - `virtual:studiocms/sdk/env` ## Bug Fixes & Improvements - Replaces `chalk` with `node:util`'s `styleText` for StudioCMS CLI. - Updates StudioCMS dependencies. - Fixes issue with `pg` and `mysql2` being required to be installed when they should be optional - Fixes client regex in frontend to allow for slashes within a slug, but not on the outside. This unblocks creating pages under sub-paths just using the slug (e.g., `docs/getting-started`) and only affects client-side validation. - Removes legacy email domain verification code - Fixes default 404 route rendering # Upgrade: v0.4.0 > Upgrade StudioCMS to v0.4.0 import QuickUpdate from '~/components/QuickUpdate.astro'; import { Aside } from '@astrojs/starlight/components'; import ReadMore from '~/components/ReadMore.astro'; ## Breaking changes - Migrates all API routes to use the new `@withstudiocms/api-spec` package, which includes a new type-safe way to define API routes and their parameters, request body, and response shape built using Effect's HttpApi implementation. This is a breaking change for any custom API routes defined in plugins or the project itself, and requires updating to the new API route definition format. - `/studiocms_api/sdk/listpages` has been removed. - `/studiocms_api/sdk/full-changelog.json` has been renamed to `/studiocms_api/sdk/full-changelog`. - Replaces page partial routes with new sdk routes for markdown rendering, and user-list HTML generation. - `/studiocms_api/sdk/render` has been added for rendering basic markdown content to HTML. - `/studiocms_api/sdk/user-list-items` has been added for generating HTML for lists of users, such as those used in the dashboard user list. - Deprecates the `studiocmsMinimumVersion` property on plugins, which was previously used to specify the minimum version of StudioCMS required for a plugin to work. This is no longer necessary with the new API route definition format, and has been removed to simplify plugin definitions. Interested in learning more about the new API spec? Check out the new Scalar generated [API Spec Documentation](/en/api-docs/auth/) for details on how you can interact with the new API definitions. This is also included by default within all StudioCMS installations at the `/studiocms_api/docs` route, and can be disabled as needed. ## Bug Fixes & Improvements - Migrates all frontend and dashboard API calls to use the new `@withstudiocms/api-spec` package, which includes improved error handling and type safety for API calls. This migration also includes updates to the SDK to support the new API route definition format. - Migrates internal Zod based Schemas to use Effect Schemas for improved validation, error handling, and integration within our ecosystem. This migration includes updates to all internal schemas used for validating API route parameters, request bodies, and other data structures, and may require updates to any custom schemas defined in plugins or the project itself. - Extends Plugin rendering API to support site-wide post-processors, or single page post-processor augments. This allows plugins to modify the rendered output of any page, either by applying a post-processing function to all pages or by targeting specific pages for modification. This is a new feature that may require updates to any custom rendering logic defined in plugins or the project itself to take advantage of the new post-processing capabilities. (e.g., adding support for TailwindCSS is now possible.) - Moves internal dashboard authentication checks into a per-page custom data-middleware system, allowing for more flexible and customizable authentication logic for dashboard pages. This migration includes updates to the dashboard routing system to support the new middleware system, and may require updates to any custom dashboard routes defined in plugins or the project itself to take advantage of the new authentication middleware capabilities. - Fixes folder deletion schema calls that caused server errors when attempting to delete folders. - Updates first time setup step 3 instructions. Previously they showed outdated instructions related to `@astrojs/db`, which has since been removed. The new instructions provide updated guidance on setting up the database connection for StudioCMS. - Fixes `studiocms init` optional option parsing. - Adds new config option for built-in API spec docs route, served at `/studiocms_api/docs` by default. This route provides interactive API documentation for all built-in and custom API routes defined in the project, and can be customized or disabled as needed. - To disable the built-in API docs route, set `features.api.apiDocs` to `false` in the StudioCMS config. - Updated various dependencies to their latest versions to ensure security and stability. # Upgrade: v0.4.1 > Upgrade StudioCMS to v0.4.1 import QuickUpdate from '~/components/QuickUpdate.astro'; import { Aside } from '@astrojs/starlight/components'; ## Bug Fixes & Improvements - Fixes a small bug where the optional built-in Analytics plugin had imports that did not properly resolve, causing errors when StudioCMS was run with or without the Analytics plugin enabled. This fix ensures that the Analytics plugin does not cause errors regardless of whether it is enabled or not, and improves the overall stability of StudioCMS when using the Analytics plugin. # Upgrade: v0.4.2 > Upgrade StudioCMS to v0.4.2 import QuickUpdate from '~/components/QuickUpdate.astro'; import { Aside } from '@astrojs/starlight/components'; ## Bug Fixes & Improvements - Fixes a bug where `effect` and it's dependencies were not being properly bundled, causing CJS/ESM compatibility issues. This adds Effect to the Vite optimizeDeps configuration to ensure it is ESM version is properly bundled for StudioCMS. # Upgrade: v0.4.3 > Upgrade StudioCMS to v0.4.3 import QuickUpdate from '~/components/QuickUpdate.astro'; import { Aside } from '@astrojs/starlight/components'; ## Bug Fixes & Improvements - Fixes and tweaks peerDependencies for StudioCMS to ensure `effect`, `@effect/platform` and `@effect/platform-node` are all properly included as required peer dependencies for StudioCMS. - Improves rank check handling for REST API createUser endpoint - Fixes Dashboard API's createResetLink endpoint to properly validate ranks - Fixes Dashboard API's user notification endpoint to prevent unauthorized users from altering other users' notifications # The Integration > Learn how StudioCMS helps you manage and deliver your content by exploring a comprehensive breakdown of it's fundamental components. import ReadMore from '~/components/ReadMore.astro' # Introduction StudioCMS is a powerful CMS built for Astro that allows you to manage and serve your content. It's designed to be easy-to-use and flexible enough to handle any type of content. Extending StudioCMS is easy too! You can create your own plugins to add new features to StudioCMS. The StudioCMS integration is the basis for the entire StudioCMS ecosystem. It provides a headless CMS solution for Astro projects. The following is a breakdown of the StudioCMS integration and its components. ## Virtual Modules The StudioCMS integration provides several [virtual modules](https://vite.dev/guide/api-plugin#virtual-modules-convention) that give you full control over your dynamic content. These modules are primarily used internally by StudioCMS, but can be accessed by developers to access StudioCMS data. The following are the virtual modules provided by the StudioCMS integration: ### Authentication Virtual Modules - **`studiocms:auth/lib`**: Authentication utilities for StudioCMS. - **`studiocms:auth/utils/authEnvCheck`**: Utilities for checking the authentication environment for StudioCMS. - **`studiocms:auth/utils/validImages`**: Valid images used on the StudioCMS login page. - **`studiocms:auth/scripts/three`**: Three.js scripts for the StudioCMS login page. ### Core Virtual Modules - **`studiocms:config`**: Provides the resolved configuration for the StudioCMS integration ecosystem. - **`studiocms:version`**: Provides the current version of the StudioCMS integration ecosystem. - **`studiocms:plugins`**: Provides the plugin system interfaces during runtime for StudioCMS. - **`studiocms:plugin-helpers`**: Provides the plugin helper functions for StudioCMS. - **`studiocms:components`**: Provides exported components for StudioCMS. - **`studiocms:components/Editors`**: Provides the Editor components for Page Editing. - **`studiocms:components/dashboard-grid-components`**: Internal components used by the StudioCMS Dashboard. - **`studiocms:components/dashboard-grid-items`**: Internal components used by the StudioCMS Dashboard. - **`studiocms:component-registry`**: Provides the component registry for User-defined components in StudioCMS. - **`studiocms:component-registry/runtime`**: Provides the runtime utils for the component registry for User-defined components in StudioCMS. - **`studiocms:lib`**: Provides the StudioCMS library helpers for StudioCMS. ### SDK Virtual Modules - **`studiocms:sdk`**: Provides the StudioCMS SDK for StudioCMS. - **`studiocms:sdk/types`**: Provides the StudioCMS SDK types for StudioCMS. ### i18n Virtual Modules - **`studiocms:i18n`**: Provides the StudioCMS i18n for StudioCMS. ### Renderer Virtual Modules - **`studiocms:renderer`**: Provides the StudioCMS renderer for StudioCMS. ### ImageHandler Virtual Modules - **`studiocms:imageHandler/components`**: Provides the StudioCMS imageHandler components for StudioCMS. ## Routes The StudioCMS integration provides several routes that allow you to manage your content and configuration. These routes are used by the StudioCMS Dashboard and API to interact with the StudioCMS integration. The following is a breakdown of the routes provided by the StudioCMS integration. ### Dashboard Routes The routes that users can access to manage their StudioCMS project. #### Main Routes - **`/dashboard/`**: The StudioCMS Dashboard, where you can manage your StudioCMS project. - **`/dashboard/profile/`**: The StudioCMS Dashboard profile page, where you can manage your profile. - **`/dashboard/content-management/`**: The StudioCMS Dashboard content management page, where you can manage your content. - **`/dashboard/configuration/`**: The StudioCMS Dashboard configuration page, where you can manage your configuration. - **`/dashboard/user-management/`**: The StudioCMS Dashboard user management page, where you can manage your users. - **`/dashboard/plugins/`**: The StudioCMS Dashboard plugins page, where you can manage your plugins. #### Auth Routes For a detailed list of available API routes and their usage, please refer to the [StudioCMS Authentication API documentation](/en/api-docs/auth/). ### API Routes The Routes that the StudioCMS Dashboard uses to interact with the StudioCMS integration. For a detailed list of available API routes and their usage, please refer to the [StudioCMS Dashboard API documentation](/en/api-docs/dashboard/). # The CLI > Learn about the StudioCMS CLIs and how to use them. import { Steps } from '@astrojs/starlight/components'; import { PackageManagers } from 'starlight-package-managers' import ReadMore from '~/components/ReadMore.astro'; The StudioCMS CLIs are utilities that allow you to quickly scaffold new StudioCMS projects and expose useful utilities for StudioCMS. There are multiple different CLIs that are part of the StudioCMS ecosystem: - **[`studiocms`](#studiocms)**: The StudioCMS utility CLI. - **[`create-studiocms`](#create-studiocms)**: The StudioCMS project scaffolding CLI. - **[`@studiocms/upgrade`](#studiocmsupgrade)**: Upgrade StudioCMS Projects and their Plugins. The following is a breakdown of the StudioCMS CLI and its components. ## `studiocms` ### Full CLI Options and commands ```log Usage: studiocms [options] [command] Options: -V, --version Output the current version of the CLI Toolkit. -h, --help display help for command COMMANDS - add Add StudioCMS plugin(s) to your project - crypto Crypto Utilities for StudioCMS Security - get-turso Install the Turso CLI - init Initialize the StudioCMS project after new installation. - users Utilities for Tweaking Users in StudioCMS - migrate Manage database migrations for StudioCMS. ``` ### Example Usage From within your StudioCMS Project root ### Command Breakdown #### `add` ```log usage: studiocms add Adds StudioCMS plugin(s) to your project. Arguments: plugins Plugin(s) to install Options: -h, --help display help for command ``` #### `crypto` ```log usage: studiocms crypto [command] Crypto Utilities for Security Options: -h, --help display help for command Commands: gen-jwt Generate JWT token from a keyfile ``` #### `crypto gen-jwt` ```log usage: studiocms crypto gen-jwt [options] Generate a JWT token from a keyfile Arguments: key-file a relative path (e.g., `../keys/libsql.pem`) from the current directory to your private key file (.pem) Options: -e, --exp Expiry date in seconds (>=0) from issued at (iat) time -h, --help display help for command ``` #### `debug` ```log usage: studiocms debug [options] Displays debug information about your StudioCMS installation. Options: -h, --help display help for command --debug Enable debug mode ``` #### `get-turso` Downloads and installs the latest version of Turso using the script from Turso's [documentation][turso-docs] :::note Windows requires the use of WSL as per Turso ::: ```log Usage: getTurso [options] Turso CLI Installer Options: -h, --help display help for command ``` #### `init` ```log Usage: studiocms init [options] Initialize the StudioCMS project after new installation. Options: -d, --dry-run Dry run mode --skip-banners Skip all banners --debug Enable debug mode -h, --help Display help for command ``` The init command provides an interactive setup experience that helps you: 1. Set up your environment file (.env) with options to: - Use an example `.env` template - Use the interactive `.env` builder which can: - Set up a database connection (libSQL, MySQL, PostgreSQL) - Configure OAuth providers (GitHub, Discord, Google, Auth0) - Set encryption keys and other required variables - Skip environment file creation For a full list of environment variables, see the [Environment Variables documentation][environment-variables]. #### `users` ```log usage: studiocms users [options] Utilities for Tweaking Users in StudioCMS Options: -h, --help display help for command ``` #### `migrate` ```log usage: studiocms migrate [options] Manage database migrations for StudioCMS. Options: -h, --help display help for command --debug Enable debug mode -r, --rollback Rollback the last migration -l, --latest Migrate to the latest version --status Show the current migration status ``` ## `create-studiocms` ### Full CLI Options and commands ```log Usage: create-studiocms [options] [command] Options: -V, --version Output the current version of the CLI Toolkit. -h, --help display help for command --color force color output --no-color disable color output Commands: get-turso Get the latest version of Turso. help Show help for command interactive* Start the interactive CLI. * Indicates the default command that is run when calling this CLI. ``` ### Example Usage `create-studiocms` automatically runs in _interactive_ mode, but you can also specify your project name and template with command line arguments. [Check out the full list][templates] of templates, available on GitHub. When using `--template`, the CLI searches the templates repository for all folders. For example, the `studiocms/basics` template points to the `basics` project within the `studiocms` folder at the root of the repository. ### Command Breakdown #### Interactive (Default command) ```log Usage: create-studiocms interactive [options] Start the interactive CLI. Powered by [clack](https://clack.cc). This command will open an interactive CLI prompt to guide you through the process of creating a new StudioCMS(or StudioCMS Ecosystem package) project using one of the available templates. Options: -t, --template

Hello {{user.firstName}} {{user.lastName}}!

Hello {{user.name}}!

{page.title}

My Plugin

Recently Updated Pages