@withstudiocms/sdk 0.1.0-beta.1 → 0.1.0

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>;

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
+};

package/dist/modules/auth/index.d.ts

@@ -1,5 +1,5 @@
 import { Effect } from '@withstudiocms/effect';
-import { type DBCallbackFailure } from '@withstudiocms/kysely';
+import type { DBCallbackFailure } from '@withstudiocms/kysely/client';
 import type { DatabaseError } from '@withstudiocms/kysely/core/errors';
 import { DBClientLive, SDKDefaults } from '../../context.js';
 import { type AuthDeletionResponse } from '../../types.js';
@@ -68,8 +68,9 @@ import { type AuthDeletionResponse } from '../../types.js';
  * - Most DB operations will propagate DB-level failures as Effect errors that the caller
  *   can handle or map. Certain "delete" operations intentionally catch DB error tags and
  *   convert them to structured success/error result objects for convenience.
- * - Insert/update operations use returningAll() and executeTakeFirstOrThrow(), so failed
- *   inserts/updates typically surface as runtime/DB errors within the Effect system.
+ * - Insert/update operations execute within transactions, performing the write followed by
+ *   a select of the affected row(s), ensuring atomicity and MySQL compatibility. Failed
+ *   operations surface as runtime/DB errors within the Effect system.
  *
  * Usage notes
  * - All exported operations are intended to be composed and executed inside the project's
@@ -97,8 +98,8 @@ export declare const SDKAuthModule: Effect.Effect<{
         get: (input: string) => Effect.Effect<{
             readonly id: string;
             readonly userId: string;
-            readonly token: string;
             readonly expiresAt: Date;
+            readonly token: string;
         } | undefined, DBCallbackFailure | DatabaseError, never>;
         /**
          * Creates a new email verification token in the database.
@@ -109,8 +110,8 @@ export declare const SDKAuthModule: Effect.Effect<{
         create: (userId: string) => Effect.Effect<{
             readonly id: string;
             readonly userId: string;
-            readonly token: string;
             readonly expiresAt: Date;
+            readonly token: string;
         }, DBCallbackFailure | DatabaseError | import("../util/generators.js").GeneratorError, never>;
         /**
          * Deletes an email verification token from the database.
@@ -227,17 +228,17 @@ export declare const SDKAuthModule: Effect.Effect<{
                 readonly expiresAt: Date;
             };
             user: {
-                readonly name: string;
                 readonly id: string;
-                readonly url: string | null | undefined;
-                readonly email: string | null | undefined;
-                readonly avatar: string | null | undefined;
+                readonly url?: string | null | undefined;
+                readonly name: string;
+                readonly email?: string | null | undefined;
+                readonly avatar?: string | null | undefined;
                 readonly username: string;
-                readonly password: string | null | undefined;
+                readonly password?: string | null | undefined;
                 readonly updatedAt: Date;
                 readonly createdAt: Date;
                 readonly emailVerified: boolean;
-                readonly notifications: string | null | undefined;
+                readonly notifications?: string | null | undefined;
             };
         } | undefined, DBCallbackFailure | DatabaseError, never>;
         /**
@@ -255,53 +256,7 @@ export declare const SDKAuthModule: Effect.Effect<{
          */
         update: (input: {
             readonly id: string;
-            readonly newDate: {
-                toString: {};
-                toDateString: {};
-                toTimeString: {};
-                toLocaleString: {};
-                toLocaleDateString: {};
-                toLocaleTimeString: {};
-                valueOf: {};
-                getTime: {};
-                getFullYear: {};
-                getUTCFullYear: {};
-                getMonth: {};
-                getUTCMonth: {};
-                getDate: {};
-                getUTCDate: {};
-                getDay: {};
-                getUTCDay: {};
-                getHours: {};
-                getUTCHours: {};
-                getMinutes: {};
-                getUTCMinutes: {};
-                getSeconds: {};
-                getUTCSeconds: {};
-                getMilliseconds: {};
-                getUTCMilliseconds: {};
-                getTimezoneOffset: {};
-                setTime: {};
-                setMilliseconds: {};
-                setUTCMilliseconds: {};
-                setSeconds: {};
-                setUTCSeconds: {};
-                setMinutes: {};
-                setUTCMinutes: {};
-                setHours: {};
-                setUTCHours: {};
-                setDate: {};
-                setUTCDate: {};
-                setMonth: {};
-                setUTCMonth: {};
-                setFullYear: {};
-                setUTCFullYear: {};
-                toUTCString: {};
-                toISOString: {};
-                toJSON: {};
-                getVarDate: {};
-                [Symbol.toPrimitive]: {};
-            };
+            readonly newDate: Date;
         }) => Effect.Effect<{
             readonly id: string;
             readonly userId: string;
@@ -317,29 +272,29 @@ export declare const SDKAuthModule: Effect.Effect<{
          * @returns A promise that resolves to the created user.
          */
         create: (userData: {
-            readonly name: string;
             readonly id: string;
-            readonly url: string | null | undefined;
-            readonly email: string | null | undefined;
-            readonly avatar: string | null | undefined;
+            readonly url?: string | null | undefined;
+            readonly name: string;
+            readonly email?: string | null | undefined;
+            readonly avatar?: string | null | undefined;
             readonly username: string;
-            readonly password: string | null | undefined;
+            readonly password?: string | null | undefined;
             readonly updatedAt: string;
             readonly createdAt: string | undefined;
             readonly emailVerified: boolean;
-            readonly notifications: string | null | undefined;
+            readonly notifications?: string | null | undefined;
         }, rank: "owner" | "admin" | "editor" | "visitor" | "unknown") => Effect.Effect<{
-            readonly name: string;
             readonly id: string;
-            readonly url: string | null | undefined;
-            readonly email: string | null | undefined;
-            readonly avatar: string | null | undefined;
+            readonly url?: string | null | undefined;
+            readonly name: string;
+            readonly email?: string | null | undefined;
+            readonly avatar?: string | null | undefined;
             readonly username: string;
-            readonly password: string | null | undefined;
+            readonly password?: string | null | undefined;
             readonly updatedAt: Date;
             readonly createdAt: Date;
             readonly emailVerified: boolean;
-            readonly notifications: string | null | undefined;
+            readonly notifications?: string | null | undefined;
         }, DBCallbackFailure | DatabaseError, never>;
         /**
          * Updates user data for a specified user.
@@ -350,29 +305,30 @@ export declare const SDKAuthModule: Effect.Effect<{
         update: (input: {
             readonly userId: string;
             readonly userData: {
+                readonly id: string;
                 readonly url?: string | null | undefined;
+                readonly name: string;
                 readonly email?: string | null | undefined;
                 readonly avatar?: string | null | undefined;
-                readonly password?: string | null | undefined;
-                readonly notifications?: string | null | undefined;
-                readonly name: string;
-                readonly id: string;
                 readonly username: string;
+                readonly password?: string | null | undefined;
                 readonly updatedAt: string;
+                readonly createdAt: undefined;
                 readonly emailVerified: boolean;
+                readonly notifications?: string | null | undefined;
             };
         }) => Effect.Effect<{
-            readonly name: string;
             readonly id: string;
-            readonly url: string | null | undefined;
-            readonly email: string | null | undefined;
-            readonly avatar: string | null | undefined;
+            readonly url?: string | null | undefined;
+            readonly name: string;
+            readonly email?: string | null | undefined;
+            readonly avatar?: string | null | undefined;
             readonly username: string;
-            readonly password: string | null | undefined;
+            readonly password?: string | null | undefined;
             readonly updatedAt: Date;
             readonly createdAt: Date;
             readonly emailVerified: boolean;
-            readonly notifications: string | null | undefined;
+            readonly notifications?: string | null | undefined;
         }, DBCallbackFailure | DatabaseError, never>;
         /**
          * Searches for users by username.
@@ -383,30 +339,30 @@ export declare const SDKAuthModule: Effect.Effect<{
          */
         searchUsersForUsernameOrEmail: (username?: string | undefined, email?: string | undefined) => Effect.Effect<{
             usernameSearch: {
-                readonly name: string;
                 readonly id: string;
-                readonly url: string | null | undefined;
-                readonly email: string | null | undefined;
-                readonly avatar: string | null | undefined;
+                readonly url?: string | null | undefined;
+                readonly name: string;
+                readonly email?: string | null | undefined;
+                readonly avatar?: string | null | undefined;
                 readonly username: string;
-                readonly password: string | null | undefined;
+                readonly password?: string | null | undefined;
                 readonly updatedAt: Date;
                 readonly createdAt: Date;
                 readonly emailVerified: boolean;
-                readonly notifications: string | null | undefined;
+                readonly notifications?: string | null | undefined;
             }[];
             emailSearch: {
-                readonly name: string;
                 readonly id: string;
-                readonly url: string | null | undefined;
-                readonly email: string | null | undefined;
-                readonly avatar: string | null | undefined;
+                readonly url?: string | null | undefined;
+                readonly name: string;
+                readonly email?: string | null | undefined;
+                readonly avatar?: string | null | undefined;
                 readonly username: string;
-                readonly password: string | null | undefined;
+                readonly password?: string | null | undefined;
                 readonly updatedAt: Date;
                 readonly createdAt: Date;
                 readonly emailVerified: boolean;
-                readonly notifications: string | null | undefined;
+                readonly notifications?: string | null | undefined;
             }[];
         }, DBCallbackFailure | DatabaseError, never>;
         /**
@@ -427,17 +383,17 @@ export declare const SDKAuthModule: Effect.Effect<{
              * @returns A promise that resolves to the ghost user.
              */
             create: () => Effect.Effect<{
-                readonly name: string;
                 readonly id: string;
-                readonly url: string | null | undefined;
-                readonly email: string | null | undefined;
-                readonly avatar: string | null | undefined;
+                readonly url?: string | null | undefined;
+                readonly name: string;
+                readonly email?: string | null | undefined;
+                readonly avatar?: string | null | undefined;
                 readonly username: string;
-                readonly password: string | null | undefined;
+                readonly password?: string | null | undefined;
                 readonly updatedAt: Date;
                 readonly createdAt: Date;
                 readonly emailVerified: boolean;
-                readonly notifications: string | null | undefined;
+                readonly notifications?: string | null | undefined;
             }, DBCallbackFailure | DatabaseError, never>;
             /**
              * Retrieves the ghost user.
@@ -445,17 +401,17 @@ export declare const SDKAuthModule: Effect.Effect<{
              * @returns A promise that resolves to the ghost user.
              */
             get: () => Effect.Effect<{
-                readonly name: string;
                 readonly id: string;
-                readonly url: string | null | undefined;
-                readonly email: string | null | undefined;
-                readonly avatar: string | null | undefined;
+                readonly url?: string | null | undefined;
+                readonly name: string;
+                readonly email?: string | null | undefined;
+                readonly avatar?: string | null | undefined;
                 readonly username: string;
-                readonly password: string | null | undefined;
+                readonly password?: string | null | undefined;
                 readonly updatedAt: Date;
                 readonly createdAt: Date;
                 readonly emailVerified: boolean;
-                readonly notifications: string | null | undefined;
+                readonly notifications?: string | null | undefined;
             }, DBCallbackFailure | DatabaseError, never>;
         };
     };