@withstudiocms/sdk 0.0.0-beta.0 → 0.1.0

package/dist/migrations/20251221T002125_url-mapping.js

@@ -0,0 +1,228 @@
+import {
+  rollbackMigration,
+  syncDatabaseSchema
+} from "@withstudiocms/kysely/utils/migrator";
+import { schemaDefinition as previousSchema } from "./20251130T150847_drop_deprecated.js";
+const schemaDefinition = [
+  {
+    name: "StudioCMSUsersTable",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "url", type: "text" },
+      { name: "name", type: "text", notNull: true },
+      { name: "email", type: "text" },
+      { name: "avatar", type: "text" },
+      { name: "username", type: "text", notNull: true },
+      { name: "password", type: "text" },
+      { name: "updatedAt", type: "text", notNull: true },
+      { name: "createdAt", type: "text", notNull: true, defaultSQL: "CURRENT_TIMESTAMP" },
+      { name: "emailVerified", type: "integer", notNull: true, default: 0 },
+      { name: "notifications", type: "text" }
+    ]
+  },
+  {
+    name: "StudioCMSOAuthAccounts",
+    columns: [
+      { name: "providerUserId", type: "text", notNull: true },
+      { name: "provider", type: "text", notNull: true },
+      {
+        name: "userId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSUsersTable", column: "id" }
+      }
+    ]
+  },
+  {
+    name: "StudioCMSSessionTable",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      {
+        name: "userId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSUsersTable", column: "id" }
+      },
+      { name: "expiresAt", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSPermissions",
+    columns: [
+      {
+        name: "user",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSUsersTable", column: "id" }
+      },
+      { name: "rank", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSAPIKeys",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      {
+        name: "userId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSUsersTable", column: "id" }
+      },
+      { name: "key", type: "text", notNull: true },
+      { name: "creationDate", type: "text", notNull: true },
+      { name: "description", type: "text" }
+    ]
+  },
+  {
+    name: "StudioCMSUserResetTokens",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      {
+        name: "userId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSUsersTable", column: "id" }
+      },
+      { name: "token", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSPageFolderStructure",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "name", type: "text", notNull: true },
+      { name: "parent", type: "text" }
+    ]
+  },
+  {
+    name: "StudioCMSPageData",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "package", type: "text", notNull: true },
+      { name: "title", type: "text", notNull: true },
+      { name: "description", type: "text", notNull: true },
+      { name: "showOnNav", type: "integer", notNull: true, default: 0 },
+      { name: "publishedAt", type: "text" },
+      { name: "updatedAt", type: "text", notNull: true },
+      { name: "slug", type: "text", notNull: true },
+      { name: "contentLang", type: "text", notNull: true },
+      { name: "heroImage", type: "text" },
+      { name: "categories", type: "text", notNull: true, default: JSON.stringify([]) },
+      { name: "tags", type: "text", notNull: true, default: JSON.stringify([]) },
+      { name: "authorId", type: "text", notNull: true },
+      { name: "contributorIds", type: "text", notNull: true, default: JSON.stringify([]) },
+      { name: "showAuthor", type: "integer", notNull: true, default: 0 },
+      { name: "showContributors", type: "integer", notNull: true, default: 0 },
+      { name: "parentFolder", type: "text" },
+      { name: "draft", type: "integer", notNull: true, default: 0 },
+      { name: "augments", type: "text", notNull: true, default: JSON.stringify([]) }
+    ]
+  },
+  {
+    name: "StudioCMSDiffTracking",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      {
+        name: "pageId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSPageData", column: "id" }
+      },
+      {
+        name: "userId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSUsersTable", column: "id" }
+      },
+      { name: "timestamp", type: "text", notNull: true },
+      { name: "pageMetaData", type: "text", notNull: true },
+      { name: "pageContentStart", type: "text", notNull: true },
+      { name: "diff", type: "text" }
+    ]
+  },
+  {
+    name: "StudioCMSPageDataTags",
+    columns: [
+      { name: "id", type: "integer", primaryKey: true },
+      { name: "description", type: "text", notNull: true },
+      { name: "name", type: "text", notNull: true },
+      { name: "slug", type: "text", notNull: true },
+      { name: "meta", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSPageDataCategories",
+    columns: [
+      { name: "id", type: "integer", primaryKey: true },
+      { name: "parent", type: "integer" },
+      { name: "description", type: "text", notNull: true },
+      { name: "name", type: "text", notNull: true },
+      { name: "slug", type: "text", notNull: true },
+      { name: "meta", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSPageContent",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      {
+        name: "contentId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSPageData", column: "id" }
+      },
+      { name: "contentLang", type: "text", notNull: true },
+      { name: "content", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSEmailVerificationTokens",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      {
+        name: "userId",
+        type: "text",
+        notNull: true,
+        references: { table: "StudioCMSUsersTable", column: "id" }
+      },
+      { name: "token", type: "text", notNull: true },
+      { name: "expiresAt", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSPluginData",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "data", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSDynamicConfigSettings",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "data", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSStorageManagerUrlMappings",
+    columns: [
+      { name: "identifier", type: "text", primaryKey: true },
+      { name: "url", type: "text", notNull: true },
+      { name: "isPermanent", type: "integer", notNull: true, default: 0 },
+      { name: "expiresAt", type: "integer" },
+      { name: "createdAt", type: "integer", notNull: true },
+      { name: "updatedAt", type: "integer", notNull: true }
+    ]
+  }
+];
+async function up(db) {
+  await syncDatabaseSchema(db, schemaDefinition, previousSchema);
+}
+async function down(db) {
+  await rollbackMigration(db, schemaDefinition, previousSchema);
+}
+export {
+  down,
+  schemaDefinition,
+  up
+};

package/dist/migrator.d.ts

@@ -0,0 +1,25 @@
+/** biome-ignore-all lint/suspicious/noExplicitAny: Kysely Requirement */
+import type { Effect } from '@withstudiocms/effect';
+import type { MigratorError } from '@withstudiocms/kysely/core/errors';
+import type { Dialect, MigrationInfo, MigrationResultSet } from '@withstudiocms/kysely/kysely';
+/**
+ * Creates a live migrator instance bound to the package's migration folder.
+ *
+ * This convenience factory forwards the provided dialect to `makeMigratorLive`
+ * and binds the module's default `migrationFolder`, producing a migrator that
+ * runs migrations from the package's built-in migration directory.
+ *
+ * @template Schema - The database schema type; defaults to `StudioCMSDatabaseSchema`.
+ * @param dialect - The SQL dialect implementation to use (e.g. Postgres, MySQL, SQLite).
+ * @returns A migrator instance configured for the given dialect and the package migration folder.
+ *
+ * @example
+ * const migrator = getMigratorLive<MySchema>(yourDriver);
+ * await migrator.migrateToLatest();
+ */
+export declare const getMigratorLive: <Schema>(dialect: Dialect) => Effect.Effect<{
+    readonly toLatest: Effect.Effect<MigrationResultSet, MigratorError, never>;
+    readonly down: Effect.Effect<MigrationResultSet, MigratorError, never>;
+    readonly up: Effect.Effect<MigrationResultSet, MigratorError, never>;
+    readonly status: Effect.Effect<readonly MigrationInfo[], MigratorError, never>;
+}, MigratorError, never>;

package/dist/migrator.js

@@ -0,0 +1,21 @@
+import { makeMigratorLive } from "@withstudiocms/kysely/core/migrator";
+const importMigration = async (name) => {
+  if (import.meta.env?.VITEST) {
+    const migrations = import.meta.glob("../dist/migrations/*.js");
+    const migrationPath = `../dist/migrations/${name}.js`;
+    if (!migrations[migrationPath]) {
+      throw new Error(`Migration not found: ${name}`);
+    }
+    return await migrations[migrationPath]();
+  }
+  return await import(`./migrations/${name}.js`).then(({ up, down }) => ({ up, down }));
+};
+const migrationIndex = {
+  "20251025T040912_init": await importMigration("20251025T040912_init"),
+  "20251130T150847_drop_deprecated": await importMigration("20251130T150847_drop_deprecated"),
+  "20251221T002125_url-mapping": await importMigration("20251221T002125_url-mapping")
+};
+const getMigratorLive = (dialect) => makeMigratorLive(dialect, migrationIndex);
+export {
+  getMigratorLive
+};