fix: update package references from @studiocms/storage-s3 to @studiocms/s3-storage and revise related documentation

Author: Adammatthiesen

package.json

@@ -29,7 +29,7 @@
     "@studiocms/md": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/md@9f45a21",
     "@studiocms/mdx": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/mdx@9f45a21",
     "@studiocms/wysiwyg": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/wysiwyg@9f45a21",
-    "@studiocms/storage-s3": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/s3-storage@9f45a21",
+    "@studiocms/s3-storage": "https://pkg.pr.new/withstudiocms/studiocms/@studiocms/s3-storage@9f45a21",
     "studiocms": "https://pkg.pr.new/withstudiocms/studiocms@9f45a21",
     "@withstudiocms/component-registry": "https://pkg.pr.new/withstudiocms/studiocms/@withstudiocms/component-registry@9f45a21",
     "@withstudiocms/kysely": "https://pkg.pr.new/withstudiocms/studiocms/@withstudiocms/kysely@9f45a21",

pnpm-lock.yaml

@@ -80,7 +80,7 @@ export default defineStudioCMSConfig({
 ```ts twoslash {3} title="studiocms.config.mjs"
 import { defineStudioCMSConfig } from 'studiocms/config';
 // ---cut---
-import s3Storage from '@studiocms/storage-s3';
+import s3Storage from '@studiocms/s3-storage';
 export default defineStudioCMSConfig({
   storageManager: s3Storage(),
 })

src/content/docs/en/config-reference/index.mdx

@@ -103,23 +103,9 @@ export const getUsers = Effect.gen(function* () {
 	});
 
 	const users = yield* getUsers();
+//        ^?
+
 	console.log('Users:', users);
-	/*
-	    type of 'users' is:
-		const users: readonly {
-			readonly url: string | null | undefined;
-			readonly id: string;
-			readonly name: string;
-			readonly email: string | null | undefined;
-			readonly avatar: string | null | undefined;
-			readonly username: string;
-			readonly password: string | null | undefined;
-			readonly updatedAt: Date;
-			readonly createdAt: Date;
-			readonly emailVerified: boolean;
-			readonly notifications: string | null | undefined;
-		}[]
-	*/
 });
 ```
 
@@ -157,7 +143,7 @@ export const insertUser = Effect.gen(function* () {
 			db((client) => client.insertInto('StudioCMSUsersTable').values(newUser).executeTakeFirst()),
 	});
 
-	const newUser = yield* insertUser({
+	const data = {
 		username: 'new_user',
 		email: '[email protected]',
 		password: null,
@@ -169,12 +155,11 @@ export const insertUser = Effect.gen(function* () {
 		id: crypto.randomUUID(),
 		updatedAt: new Date().toISOString(),
 		createdAt: new Date().toISOString(),
-	});
-	console.log('Inserted new user:', newUser); // withEncoder returns a 'InsertResult'
-	/*
-		type of 'newUser' is:
-		const newUser: InsertResult
-	*/
+	};
+
+	const newUser = yield* insertUser(data);
+//        ^?
+	console.log('Inserted new user:', newUser);
 });
 ```
 
@@ -219,7 +204,7 @@ export const insertUser = Effect.gen(function* () {
 			),
 	});
 
-	const insertedUser = yield* insertNewUser({
+	const data = {
 		username: 'codec_user',
 		email: '[email protected]',
 		password: null,
@@ -231,24 +216,11 @@ export const insertUser = Effect.gen(function* () {
 		id: crypto.randomUUID(),
 		updatedAt: new Date().toISOString(),
 		createdAt: new Date().toISOString(),
-	});
-	console.log('Inserted user with codec:', insertedUser); // withCodec returns decoded results
-	/*
-	    type of 'insertedUser' is:
-		const user: {
-			readonly url: string | null | undefined;
-			readonly id: string;
-			readonly name: string;
-			readonly email: string | null | undefined;
-			readonly avatar: string | null | undefined;
-			readonly username: string;
-			readonly password: string | null | undefined;
-			readonly updatedAt: Date;
-			readonly createdAt: Date;
-			readonly emailVerified: boolean;
-			readonly notifications: string | null | undefined;
-		}
-	*/
+	};
+
+	const insertedUser = yield* insertNewUser(data);
+//        ^?
+	console.log('Inserted user with codec:', insertedUser);
 });
 ```
 
@@ -290,23 +262,8 @@ export const insertUser = Effect.gen(function* () {
 	});
 
 	const user = yield* getUserById('some-user-id');
+//        ^?
 	console.log('User by ID:', user);
-	/*
-	    type of 'user' is:
-		const user: {
-			readonly url: string | null | undefined;
-			readonly id: string;
-			readonly name: string;
-			readonly email: string | null | undefined;
-			readonly avatar: string | null | undefined;
-			readonly username: string;
-			readonly password: string | null | undefined;
-			readonly updatedAt: Date;
-			readonly createdAt: Date;
-			readonly emailVerified: boolean;
-			readonly notifications: string | null | undefined;
-		} | undefined
-	*/
 });
 ```
 

src/content/docs/en/ecosystem/packages/kysely.mdx

@@ -18,7 +18,7 @@ import { PackageManagers } from 'starlight-package-managers'
 import Integration from '~/components/Integration.astro'
 import ReadMore from '~/components/ReadMore.astro'
 
-The following package is built-in to StudioCMS and provides the core database functionality used by StudioCMS. It is intended to be used internally by StudioCMS, but users can also use it directly in their projects for more advanced use cases.
+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.
 
 <Aside type="caution" title="Warning">
   This package is primarily intended for internal use by StudioCMS. While you can use it directly in your projects, be aware that it may change without notice as StudioCMS evolves.
@@ -28,12 +28,6 @@ The following package is built-in to StudioCMS and provides the core database fu
   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!
 </ReadMore>
 
-## The SDK package
-
-<Integration title="@withstudiocms/sdk" githubURL="https://github.com/withstudiocms/studiocms/tree/main/packages/@withstudiocms/sdk/" released={true} />
-
-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.
-
 ### Features
 
 - **Authentication Module** - User authentication and session management

src/content/docs/en/ecosystem/packages/sdk.mdx

@@ -1,10 +1,10 @@
 ---
 i18nReady: true
-title: "Upgrade: 0.1.0-beta.32"
-description: Upgrade StudioCMS to Beta.32
+title: "Upgrade: v0.1.0"
+description: Upgrade StudioCMS to v0.1.0
 topic: guides
 sidebar:
-  label: 0.1.0-beta.32
+  label: v0.1.0
   badge:
     text: NEW
     variant: success
@@ -15,7 +15,7 @@ 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.32` introduces several breaking changes, new features, and bug fixes. This guide will help you navigate the upgrade process smoothly.
+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.
@@ -51,6 +51,7 @@ StudioCMS `0.1.0-beta.32` introduces several breaking changes, new features, and
 - 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**
 

…upgrade/version-guides/0-1-0-beta-32.mdx …/guides/upgrade/version-guides/0-1-0.mdxsrc/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-32.mdx renamed to src/content/docs/en/guides/upgrade/version-guides/0-1-0.mdx src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-32.mdx renamed to src/content/docs/en/guides/upgrade/version-guides/0-1-0.mdx

@@ -82,7 +82,7 @@ export function studioCMSPageInjector(options: Options) {
   return definePlugin({
     identifier: 'my-plugin',
     name: 'My Plugin',
-    studiocmsMinimumVersion: '0.1.0-beta.31',
+    studiocmsMinimumVersion: '0.1.0',
     hooks: {
       'studiocms:astro-config': ({ addIntegrations }) => {
         addIntegrations(myIntegration(options));  // Optional, but recommended

src/content/docs/en/plugins/extended.mdx

@@ -91,7 +91,7 @@ const myIntegration = (options: Options): AstroIntegration => ({
 export const myPlugin = (options: Options) => definePlugin({
     identifier: 'my-plugin',
     name: 'My Plugin',
-    studiocmsMinimumVersion: '0.1.0-beta.31',
+    studiocmsMinimumVersion: '0.1.0',
     hooks: {
       'studiocms:astro-config': ({ addIntegrations }) => {
         addIntegrations(myIntegration(options)) // Optional, but recommended
@@ -100,7 +100,7 @@ export const myPlugin = (options: Options) => definePlugin({
 });
 ```
 
-In this example, we define a StudioCMS plugin called `My Plugin` that requires StudioCMS version `0.1.0-beta.31` or higher. The plugin also provides an Astro Integration that logs a message to the console when the `astro:config:setup` hook is called.
+In this example, we define a StudioCMS plugin called `My Plugin` that requires StudioCMS version `v0.1.0` or higher. The plugin also provides an Astro Integration that logs a message to the console when the `astro:config:setup` hook is called.
 
 <ReadMore>For more information on building plugins checkout the [Making Plugins Useful][extended-plugins] Guide</ReadMore>
 

src/content/docs/en/plugins/index.mdx

@@ -29,7 +29,7 @@ const { resolve } = createResolver(import.meta.url);
 export const myPlugin = () => definePlugin({
     identifier: 'my-plugin',
     name: 'My Plugin',
-    studiocmsMinimumVersion: '0.1.0-beta.31',
+    studiocmsMinimumVersion: '0.1.0',
     hooks: {
       'studiocms:rendering': ({ setRendering }) => {
         setRendering({

src/content/docs/en/plugins/renderers.mdx

@@ -21,7 +21,7 @@ import { sponsors, SponsorLink } from '~/share-link'
 <LinkCard title="Upgrading StudioCMS to Latest" href="/en/guides/upgrade/latest/" description="Looking to Upgrade to the latest version? Look here!" />
 
 <Aside type="caution" title="Attention">
-This guide was recently revised for major changes in StudioCMS `0.1.0-beta.31`. If you've previously read this guide, please the review the changes carefully to ensure you are up to date with the latest setup instructions.
+This guide was recently revised for changes in StudioCMS `v0.1.0`. If you've previously read this guide, please the review the changes carefully to ensure you are up to date with the latest setup instructions.
 
 Or if you are upgrading from a previous version of StudioCMS, please see the [Upgrading StudioCMS to Latest](/en/guides/upgrade/latest/) guide for more information.
 </Aside>
@@ -374,7 +374,7 @@ The following paths are examples of the callback URL for each provider:
 | [Google](/en/package-catalog/studiocms-plugins/studiocms-google/)   | `/studiocms_api/auth/google/callback` |
 | [Auth0](/en/package-catalog/studiocms-plugins/studiocms-auth0/)     | `/studiocms_api/auth/auth0/callback` |
 
-### Configure Storage API Manager (optional) <Badge text='Added in beta.32' variant='success' />
+### Configure Storage API Manager (optional) <Badge text='Added in v0.1.0' variant='success' />
 
 StudioCMS supports using different Storage API Managers to handle file and image storage. By default, StudioCMS uses a built-in no-op storage manager that does not store any files or images.