@withstudiocms/sdk 0.0.0-beta.0 → 0.1.0

package/dist/migrations/20251025T040912_init.js

@@ -0,0 +1,260 @@
+import {
+  rollbackMigration,
+  syncDatabaseSchema
+} from "@withstudiocms/kysely/utils/migrator";
+const previousSchema = [];
+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 }
+    ]
+  },
+  // DEPRECATED TABLES - to be removed in future migrations
+  {
+    name: "StudioCMSSiteConfig",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "title", type: "text", notNull: true },
+      { name: "description", type: "text", notNull: true },
+      { name: "defaultOgImage", type: "text" },
+      { name: "siteIcon", type: "text" },
+      { name: "loginPageBackground", type: "text", notNull: true, default: "studiocms-curves" },
+      { name: "loginPageCustomImage", type: "text" },
+      { name: "enableDiffs", type: "integer", notNull: true, default: 0 },
+      { name: "diffPerPage", type: "integer", notNull: true, default: 10 },
+      { name: "gridItems", type: "text", notNull: true, default: JSON.stringify([]) },
+      { name: "enableMailer", type: "integer", notNull: true, default: 0 },
+      { name: "hideDefaultIndex", type: "integer", notNull: true, default: 0 }
+    ]
+  },
+  {
+    name: "StudioCMSMailerConfig",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "host", type: "text", notNull: true },
+      { name: "port", type: "integer", notNull: true },
+      { name: "secure", type: "integer", notNull: true, default: 0 },
+      { name: "proxy", type: "text" },
+      { name: "auth_user", type: "text" },
+      { name: "auth_password", type: "text" },
+      { name: "tls_rejectUnauthorized", type: "integer" },
+      { name: "tls_servername", type: "text" },
+      { name: "default_sender", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSNotificationSettings",
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "emailVerification", type: "integer", notNull: true, default: 0 },
+      { name: "requireAdminVerification", type: "integer", notNull: true, default: 0 },
+      { name: "requireEditorVerification", type: "integer", notNull: true, default: 0 },
+      { name: "oAuthBypassVerification", type: "integer", notNull: true, default: 0 }
+    ]
+  }
+];
+async function up(db) {
+  await syncDatabaseSchema(db, schemaDefinition, previousSchema);
+}
+async function down(db) {
+  await rollbackMigration(db, schemaDefinition, previousSchema);
+}
+export {
+  down,
+  schemaDefinition,
+  up
+};

package/dist/migrations/20251130T150847_drop_deprecated.d.ts

@@ -0,0 +1,13 @@
+/**
+ * - Title: Drop Deprecated Tables
+ * - Created: 2025-11-30
+ * - Author: Adam Matthiesen
+ * - GitHub PR: #1033
+ * - Description: Drop previously deprecated tables from the database schema. (re-deprecate here to be fully removed in the next migration safely)
+ */
+/** biome-ignore-all lint/suspicious/noExplicitAny: Requirement from Kysely */
+import type { Kysely } from '@withstudiocms/kysely/kysely';
+import { type TableDefinition } from '@withstudiocms/kysely/utils/migrator';
+export declare const schemaDefinition: TableDefinition[];
+export declare function up(db: Kysely<any>): Promise<void>;
+export declare function down(db: Kysely<any>): Promise<void>;

package/dist/migrations/20251130T150847_drop_deprecated.js

@@ -0,0 +1,262 @@
+import {
+  rollbackMigration,
+  syncDatabaseSchema
+} from "@withstudiocms/kysely/utils/migrator";
+import { schemaDefinition as previousSchema } from "./20251025T040912_init.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: "StudioCMSSiteConfig",
+    deprecated: true,
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "title", type: "text", notNull: true },
+      { name: "description", type: "text", notNull: true },
+      { name: "defaultOgImage", type: "text" },
+      { name: "siteIcon", type: "text" },
+      { name: "loginPageBackground", type: "text", notNull: true, default: "studiocms-curves" },
+      { name: "loginPageCustomImage", type: "text" },
+      { name: "enableDiffs", type: "integer", notNull: true, default: 0 },
+      { name: "diffPerPage", type: "integer", notNull: true, default: 10 },
+      { name: "gridItems", type: "text", notNull: true, default: JSON.stringify([]) },
+      { name: "enableMailer", type: "integer", notNull: true, default: 0 },
+      { name: "hideDefaultIndex", type: "integer", notNull: true, default: 0 }
+    ]
+  },
+  {
+    name: "StudioCMSMailerConfig",
+    deprecated: true,
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "host", type: "text", notNull: true },
+      { name: "port", type: "integer", notNull: true },
+      { name: "secure", type: "integer", notNull: true, default: 0 },
+      { name: "proxy", type: "text" },
+      { name: "auth_user", type: "text" },
+      { name: "auth_password", type: "text" },
+      { name: "tls_rejectUnauthorized", type: "integer" },
+      { name: "tls_servername", type: "text" },
+      { name: "default_sender", type: "text", notNull: true }
+    ]
+  },
+  {
+    name: "StudioCMSNotificationSettings",
+    deprecated: true,
+    columns: [
+      { name: "id", type: "text", primaryKey: true },
+      { name: "emailVerification", type: "integer", notNull: true, default: 0 },
+      { name: "requireAdminVerification", type: "integer", notNull: true, default: 0 },
+      { name: "requireEditorVerification", type: "integer", notNull: true, default: 0 },
+      { name: "oAuthBypassVerification", type: "integer", notNull: true, default: 0 }
+    ]
+  }
+];
+async function up(db) {
+  await syncDatabaseSchema(db, schemaDefinition, previousSchema);
+}
+async function down(db) {
+  await rollbackMigration(db, schemaDefinition, previousSchema);
+}
+export {
+  down,
+  schemaDefinition,
+  up
+};

package/dist/migrations/20251221T002125_url-mapping.d.ts

@@ -0,0 +1,13 @@
+/**
+ * - Title: URL Mapping Table Migration
+ * - Created: 2025-12-21
+ * - Author: Adam Matthiesen
+ * - GitHub PR: #1085
+ * - Description: This migration creates the URL mapping table to manage URL mappings for the StudioCMS Storage Manager.
+ */
+/** biome-ignore-all lint/suspicious/noExplicitAny: Requirement from Kysely */
+import type { Kysely } from '@withstudiocms/kysely/kysely';
+import { type TableDefinition } from '@withstudiocms/kysely/utils/migrator';
+export declare const schemaDefinition: TableDefinition[];
+export declare function up(db: Kysely<any>): Promise<void>;
+export declare function down(db: Kysely<any>): Promise<void>;