@studiocms/migrator 0.0.0-beta.0 → 0.1.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 StudioCMS - withstudiocms (https://github.com/withstudiocms)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+# @studiocms/migrator
+
+Utility tool to ensure that all your content, configurations, and settings are preserved during the migration process to the latest version, allowing you to take advantage of the new features and improvements in StudioCMS without losing any of your valuable data.
+
+## Usage
+
+Run the following command in the root of your StudioCMS project that contains the `.env` file as well as the `studiocms.config.*` config file.
+
+```sh
+npx @studiocms/migrator
+```
+
+### Environment variable requirements
+
+#### AstroDB
+
+For migrating data from previous version you simply need your previous DB's env data.
+
+```sh
+# AstroDB
+ASTRO_DB_REMOTE_URL=libsql://your-old-database.turso.io
+ASTRO_DB_APP_TOKEN=<your-auth-token>
+```
+
+#### StudioCMS Database
+
+For running this migrator you will need a fresh empty DB to work against. With the latest version's of StudioCMS, we now support libSQL, MySQL, and PostgreSQL.
+
+##### LibSQL
+
+```sh
+# libSQL
+CMS_LIBSQL_URL=libsql://your-new-database.turso.io or file:./path/to/your/database.db (required)
+CMS_LIBSQL_AUTH_TOKEN=<your-auth-token> (optional)
+CMS_LIBSQL_SYNC_INTERVAL= (optional)
+CMS_LIBSQL_SYNC_URL= (optional)
+```
+
+##### MySQL
+
+```sh
+# MySQL
+CMS_MYSQL_DATABASE=<your-database-name>
+CMS_MYSQL_USER=<your-database-user>
+CMS_MYSQL_PASSWORD=<your-database-password>
+CMS_MYSQL_HOST=<your-database-host>
+CMS_MYSQL_PORT=<your-database-port>
+```
+
+##### PostgreSQL
+
+```sh
+# PostgreSQL
+CMS_PG_DATABASE=<your-database-name>
+CMS_PG_USER=<your-database-user>
+CMS_PG_PASSWORD=<your-database-password>
+CMS_PG_HOST=<your-database-host>
+CMS_PG_PORT=<your-database-port>
+```
+
+## License
+
+[MIT License](./LICENSE)

package/package.json

@@ -1,14 +1,61 @@
 {
   "name": "@studiocms/migrator",
-  "version": "0.0.0-beta.0",
-  "description": "",
-  "publishConfig": {
-    "access": "public"
+  "type": "module",
+  "version": "0.1.0-beta.1",
+  "description": "Tool for migrating from AstroDB based StudioCMS to Kysely based StudioCMS.",
+  "author": {
+    "name": "withstudiocms",
+    "url": "https://studiocms.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/withstudiocms/studiocms.git",
+    "directory": "packages/@studiocms/migrator"
+  },
+  "contributors": [
+    "Adammatthiesen",
+    "jdtjenkins",
+    "dreyfus92",
+    "code.spirit"
+  ],
+  "bin": {
+    "studiocms-migrator": "./start.mjs",
+    "@studiocms/migrator": "./start.mjs"
   },
-  "keywords": [],
-  "author": "",
   "license": "MIT",
+  "homepage": "https://studiocms.dev",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src",
+    "utils",
+    "public",
+    "start.mjs"
+  ],
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@astrojs/node": "^9.5.1",
+    "@libsql/client": "^0.15.15",
+    "@studiocms/ui": "^1.0.0-beta.4",
+    "astro": "^5.16.4",
+    "dotenv": "^17.2.3",
+    "drizzle-orm": "^0.42.0",
+    "sharp": "^0.34.3",
+    "@withstudiocms/config-utils": "0.1.0-beta.5",
+    "@withstudiocms/effect": "0.1.0-beta.7",
+    "@withstudiocms/kysely": "0.1.0-beta.1"
+  },
+  "peerDependencies": {
+    "studiocms": "0.1.0-beta.31"
+  },
   "scripts": {
-    "pre": "pnpm publish --tag beta"
+    "astro": "astro"
   }
 }

package/public/favicon.svg

@@ -0,0 +1,5 @@
+<svg width="755" height="792" viewBox="0 0 755 792" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <rect x="295" width="460" height="466" rx="32" fill="white"/>
+  <path d="M272 434V166H180C162.327 166 148 180.327 148 198V597C148 614.673 162.327 629 180 629H577.5C595.173 629 609.5 614.673 609.5 597V490H328C297.072 490 272 464.928 272 434Z" fill="white"/>
+  <path d="M124 597V329H32C14.3269 329 0 343.327 0 361V760C0 777.673 14.3269 792 32 792H429.5C447.173 792 461.5 777.673 461.5 760V653H180C149.072 653 124 627.928 124 597Z" fill="white"/>
+</svg>

package/src/components/ErrorCard.astro

@@ -0,0 +1,20 @@
+---
+import { Card } from 'studiocms:ui/components/card';
+import { Icon } from 'studiocms:ui/components/icon';
+
+interface Props {
+	title: string;
+	description: string;
+}
+
+const { title, description } = Astro.props;
+---
+<Card fullHeight fullWidth class="db-error-card">
+    <div slot="header">
+        <span class="error-header">
+            <Icon name="heroicons:exclamation-circle" height={24} width={24} />
+            <h2>{title}</h2>
+        </span>
+    </div>
+    <span>{description}</span>
+</Card>

package/src/components/MigrationMeta.astro

@@ -0,0 +1,74 @@
+---
+import { Badge } from 'studiocms:ui/components/badge';
+import { astroDBToKyselyMap, type MigrationMetaTables } from '../lib/tableMap.js';
+
+interface Props {
+	migrationMetaData: MigrationMetaTables;
+}
+
+const { migrationMetaData } = Astro.props;
+---
+
+<table>
+    <thead>
+        <tr>
+            <th>Table</th>
+            <th>AstroDB Records</th>
+            <th>StudioCMS Records</th>
+            <th>Status</th>
+        </tr>
+    </thead>
+    <tbody>
+        {
+            Object.entries(migrationMetaData.astro).map(
+                ([tableName, astroCount]) => {
+                    const kyselyCount =
+                        migrationMetaData.kysely[
+                            astroDBToKyselyMap[
+                                tableName as keyof typeof astroDBToKyselyMap
+                            ]
+                        ] || 0;
+                    const isMigrated =
+                        astroCount === kyselyCount && astroCount > 0;
+
+                    const isDualEmpty = astroCount === 0 && kyselyCount === 0;
+
+                    return (
+                        <tr class:list={[isDualEmpty ? "not-applicable" : ""]}>
+                            <td>{tableName}</td>
+                            <td>{astroCount}</td>
+                            <td>{kyselyCount}</td>
+                            <td>
+                                {isDualEmpty ? (
+                                    <Badge
+                                        color="mono"
+                                        label="Not Applicable"
+                                        rounding="semi"
+                                        size="sm"
+                                        class="status"
+                                    />
+                                ) : isMigrated ? (
+                                    <Badge
+                                        color="success"
+                                        label="Migrated"
+                                        rounding="semi"
+                                        size="sm"
+                                        class="status"
+                                    />
+                                ) : (
+                                    <Badge
+                                        label="Pending"
+                                        color="warning"
+                                        rounding="semi"
+                                        size="sm"
+                                        class="status"
+                                    />
+                                )}
+                            </td>
+                        </tr>
+                    );
+                },
+            )
+        }
+    </tbody>
+</table>

package/src/components/MigrationStatus.astro

@@ -0,0 +1,71 @@
+---
+import { Badge } from 'studiocms:ui/components/badge';
+import type { MigrationInfo } from '@withstudiocms/kysely/kysely';
+
+interface Props {
+	migrationStatus: readonly MigrationInfo[];
+}
+
+const { migrationStatus } = Astro.props;
+
+/**
+ * Cleans up the migration name by removing timestamp prefixes and formatting.
+ *
+ * @param name - The original migration name.
+ * @returns The cleaned and formatted migration name.
+ */
+const cleanName = (name: string) => {
+	const nameMatcher = name.match(/^\d{8}T\d{6}_(.+)$/);
+	const cleanName = nameMatcher ? nameMatcher[1] : name;
+
+	// Uppercase the first letter of each word and replace underscores with spaces
+	const formattedName = cleanName
+		.split('_')
+		.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+		.join(' ');
+	return formattedName;
+};
+---
+
+<table class="migration">
+    <thead>
+        <tr>
+            <th>Migration Name</th>
+            <th>Status</th>
+            <th>Executed At</th>
+        </tr>
+    </thead>
+    <tbody>
+        {
+            migrationStatus.map((migration) => (
+                <tr>
+                    <td>{cleanName(migration.name)}</td>
+                    <td>
+                        {migration.executedAt ? (
+                            <Badge
+                                label="Applied"
+                                color="success"
+                                rounding="semi"
+                                size="sm"
+                                class="status"
+                            />
+                        ) : (
+                            <Badge
+                                label="Pending"
+                                color="warning"
+                                rounding="semi"
+                                size="sm"
+                                class="status"
+                            />
+                        )}
+                    </td>
+                    <td>
+                        {migration.executedAt
+                            ? new Date(migration.executedAt).toLocaleString()
+                            : "N/A"}
+                    </td>
+                </tr>
+            ))
+        }
+    </tbody>
+</table>

package/src/components/PageHeader.astro

@@ -0,0 +1,24 @@
+---
+import { Card } from 'studiocms:ui/components/card';
+---
+<Card variant='filled' fullWidth>
+    <div slot="header">
+        <div class="header-content">
+            <div class="header-logo">
+                <svg width="50" height="50" viewBox="0 0 755 792" fill="none" xmlns="http://www.w3.org/2000/svg">
+                    <rect x="295" width="460" height="466" rx="32" fill="white"/>
+                    <path d="M272 434V166H180C162.327 166 148 180.327 148 198V597C148 614.673 162.327 629 180 629H577.5C595.173 629 609.5 614.673 609.5 597V490H328C297.072 490 272 464.928 272 434Z" fill="white"/>
+                    <path d="M124 597V329H32C14.3269 329 0 343.327 0 361V760C0 777.673 14.3269 792 32 792H429.5C447.173 792 461.5 777.673 461.5 760V653H180C149.072 653 124 627.928 124 597Z" fill="white"/>
+                </svg>
+            </div>
+            <div class="header-text">
+                <h1>StudioCMS Migrator Utility</h1>
+                <p class="prose">Migrate your data from previous AstroDB versions of StudioCMS to the new Kysely powered version</p>
+            </div>
+        </div>
+    </div>
+
+    <div class="prose">
+        <span>This tool ensures that all your content, configurations, and settings are preserved during the migration process, allowing you to take advantage of the new features and improvements in StudioCMS without losing any of your valuable data.</span>
+    </div>
+</Card>

package/src/components/StatusTables.astro

@@ -0,0 +1,45 @@
+---
+import { Badge } from 'studiocms:ui/components/badge';
+import type { ComponentProps } from 'astro/types';
+
+interface Props {
+	dbStatusTables: {
+		label: string;
+		conditions: {
+			label: string;
+			value: string;
+			color: ComponentProps<typeof Badge>['color'];
+		}[];
+	}[];
+}
+
+const { dbStatusTables } = Astro.props;
+---
+
+{
+    dbStatusTables.map(({ label, conditions }) => (
+        <div class="split-screen-item">
+            <span class="status-label">{label}</span>
+            <table>
+                <tbody>
+                    {conditions.map(
+                        ({ label: conditionLabel, value, color }) => (
+                            <tr>
+                                <td>{conditionLabel}</td>
+                                <td>
+                                    <Badge
+                                        label={value}
+                                        color={color}
+                                        rounding="semi"
+                                        size="sm"
+                                        class="status"
+                                    />
+                                </td>
+                            </tr>
+                        ),
+                    )}
+                </tbody>
+            </table>
+        </div>
+    ))
+}

package/src/db/astro-db-drizzle-client.ts

@@ -0,0 +1,14 @@
+/** biome-ignore-all lint/style/noNonNullAssertion: This is okay */
+import { createClient } from '@libsql/client';
+import { drizzle } from 'drizzle-orm/libsql';
+import * as schema from './drizzle-schema.js';
+
+const client = createClient({
+	url: process.env.ASTRO_DB_REMOTE_URL!,
+	authToken: process.env.ASTRO_DB_APP_TOKEN!,
+});
+
+export const db = drizzle({ client, schema });
+
+export * from '../lib/astro-db-drizzle-compat/virtual.js';
+export * from './drizzle-schema.js';

package/src/db/astro-db-schema.ts

@@ -0,0 +1,193 @@
+import { column, defineTable, NOW } from '../lib/astro-db-drizzle-compat/virtual.js';
+
+// Astro DB Configuration Tables for StudioCMS
+
+// ====================================================
+// Tables that do not require relationship definitions
+// ====================================================
+
+/** StudioCMS - Users Table for Astro DB */
+export const StudioCMSUsers = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		url: column.text({ optional: true }),
+		name: column.text(),
+		email: column.text({ unique: true, optional: true }),
+		avatar: column.text({
+			optional: true,
+			default: 'https://seccdn.libravatar.org/static/img/mm/80.png',
+		}),
+		username: column.text(),
+		password: column.text({ optional: true }),
+		updatedAt: column.date({ default: NOW, optional: true }),
+		createdAt: column.date({ default: NOW, optional: true }),
+		emailVerified: column.boolean({ default: false }),
+		notifications: column.text({ optional: true }),
+	},
+});
+
+/** StudioCMS - Pages Data Table for Astro DB */
+export const StudioCMSPageData = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		package: column.text({ default: 'studiocms' }),
+		title: column.text(),
+		description: column.text(),
+		showOnNav: column.boolean({ default: false }),
+		publishedAt: column.date({ default: NOW }),
+		updatedAt: column.date({ optional: true }),
+		slug: column.text(),
+		contentLang: column.text({ default: 'default' }),
+		heroImage: column.text({
+			default:
+				'https://images.unsplash.com/photo-1707343843982-f8275f3994c5?q=80&w=1032&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDF8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D',
+		}),
+		categories: column.json({ default: [], optional: true }),
+		tags: column.json({ default: [], optional: true }),
+		authorId: column.text({ optional: true }),
+		contributorIds: column.json({ default: [], optional: true }),
+		showAuthor: column.boolean({ default: false, optional: true }),
+		showContributors: column.boolean({ default: false, optional: true }),
+		parentFolder: column.text({ optional: true }),
+		draft: column.boolean({ optional: true }),
+	},
+});
+
+/** StudioCMS - Page Folder Structure */
+export const StudioCMSPageFolderStructure = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		name: column.text(),
+		parent: column.text({ optional: true }),
+	},
+});
+
+/** StudioCMS - Page Data Tags Table for Astro DB */
+export const StudioCMSPageDataTags = defineTable({
+	columns: {
+		id: column.number({ primaryKey: true }),
+		description: column.text(),
+		name: column.text(),
+		slug: column.text(),
+		meta: column.json(),
+	},
+});
+
+/** StudioCMS - Page Data Categories Table for Astro DB */
+export const StudioCMSPageDataCategories = defineTable({
+	columns: {
+		id: column.number({ primaryKey: true }),
+		parent: column.number({ optional: true }),
+		description: column.text(),
+		name: column.text(),
+		slug: column.text(),
+		meta: column.json(),
+	},
+});
+
+export const StudioCMSPluginData = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		data: column.json(),
+	},
+});
+
+/**
+ * StudioCMS - Dynamic Config Settings Table
+ *
+ * This table stores dynamic configuration settings for the StudioCMS application.
+ *
+ * @remarks
+ * This table is designed to store dynamic configuration settings that can be updated at runtime.
+ *
+ * Replaces:
+ * - `StudioCMSSiteConfig`
+ * - `StudioCMSMailerConfig`
+ * - `StudioCMSNotificationSettings`
+ */
+export const StudioCMSDynamicConfigSettings = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		data: column.json(),
+	},
+});
+
+// ====================================================
+// Tables that require relationship definitions
+// ====================================================
+
+export const StudioCMSAPIKeys = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		userId: column.text({ references: () => StudioCMSUsers.columns.id }),
+		key: column.text(),
+		creationDate: column.date({ default: NOW }),
+		description: column.text({ optional: true }),
+	},
+});
+
+export const StudioCMSUserResetTokens = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		userId: column.text({ references: () => StudioCMSUsers.columns.id }),
+		token: column.text(),
+	},
+});
+
+/** StudioCMS - OAuth Accounts Table for Astro DB */
+export const StudioCMSOAuthAccounts = defineTable({
+	columns: {
+		provider: column.text(), // github, google, discord, auth0
+		providerUserId: column.text({ primaryKey: true }),
+		userId: column.text({ references: () => StudioCMSUsers.columns.id }),
+	},
+});
+
+/** StudioCMS - Session Table for Astro DB */
+export const StudioCMSSessionTable = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		userId: column.text({ references: () => StudioCMSUsers.columns.id, optional: false }),
+		expiresAt: column.date(),
+	},
+});
+
+/** StudioCMS - Permissions Table for Astro DB */
+export const StudioCMSPermissions = defineTable({
+	columns: {
+		user: column.text({ references: () => StudioCMSUsers.columns.id }),
+		rank: column.text({ enum: ['owner', 'admin', 'editor', 'visitor', 'unknown'] }),
+	},
+});
+
+/** StudioCMS - Diff Tracking Table for Astro DB */
+export const StudioCMSDiffTracking = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		userId: column.text({ references: () => StudioCMSUsers.columns.id }),
+		pageId: column.text({ references: () => StudioCMSPageData.columns.id }),
+		timestamp: column.date({ default: NOW, optional: true }),
+		pageMetaData: column.json({ optional: true }),
+		pageContentStart: column.text({ multiline: true }),
+		diff: column.text({ multiline: true, optional: true }),
+	},
+});
+
+/** StudioCMS - Pages Content Table for Astro DB */
+export const StudioCMSPageContent = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		contentId: column.text({ references: () => StudioCMSPageData.columns.id }),
+		contentLang: column.text({ default: 'default' }),
+		content: column.text({ multiline: true, optional: true }),
+	},
+});
+
+export const StudioCMSEmailVerificationTokens = defineTable({
+	columns: {
+		id: column.text({ primaryKey: true }),
+		userId: column.text({ references: () => StudioCMSUsers.columns.id }),
+		token: column.text(),
+		expiresAt: column.date(),
+	},
+});