@withstudiocms/sdk 0.0.0-beta.0 → 0.1.0-beta.1

package/dist/modules/config/index.js

@@ -0,0 +1,205 @@
+import { Deepmerge, Effect, Schema } from "@withstudiocms/effect";
+import { StudioCMSDynamicConfigSettings } from "@withstudiocms/kysely/tables";
+import { CacheMissError, CacheService } from "../../cache.js";
+import { cacheKeyGetters, cacheTags } from "../../consts.js";
+import { DBClientLive } from "../../context.js";
+import {
+  MailerConfigId,
+  MailerConfigVersion,
+  NotificationSettingsId,
+  NotificationSettingsVersion,
+  SiteConfigId,
+  SiteConfigVersion,
+  TemplateConfigId,
+  TemplateConfigVersion
+} from "./consts.js";
+import defaultTemplates from "./templates/mailer.js";
+import { castData } from "./type-utils.js";
+const cacheKey = cacheKeyGetters.dynamicConfig;
+const cacheOpts = { tags: cacheTags.dynamicConfig };
+const SDKConfigModule = Effect.gen(function* () {
+  const [{ withCodec }, { merge }, cache] = yield* Effect.all([
+    DBClientLive,
+    Deepmerge,
+    CacheService
+  ]);
+  const _insert = withCodec({
+    decoder: StudioCMSDynamicConfigSettings.Select,
+    encoder: StudioCMSDynamicConfigSettings.Insert,
+    callbackFn: (db, data) => db(
+      (client) => client.insertInto("StudioCMSDynamicConfigSettings").values(data).returning(["id", "data"]).executeTakeFirstOrThrow()
+    )
+  });
+  const _select = withCodec({
+    decoder: Schema.UndefinedOr(StudioCMSDynamicConfigSettings.Select),
+    encoder: Schema.String,
+    callbackFn: (db, id) => db(
+      (client) => client.selectFrom("StudioCMSDynamicConfigSettings").selectAll().where("id", "=", id).executeTakeFirst()
+    )
+  });
+  const _update = withCodec({
+    decoder: StudioCMSDynamicConfigSettings.Select,
+    encoder: StudioCMSDynamicConfigSettings.Update,
+    callbackFn: (db, { id, data }) => db(
+      (client) => client.updateTable("StudioCMSDynamicConfigSettings").set({ data }).where("id", "=", id).returning(["id", "data"]).executeTakeFirstOrThrow()
+    )
+  });
+  const _tappedCacheUpdate = (fn) => Effect.fn(
+    (id, data) => fn({ id, data: JSON.stringify(data) }).pipe(
+      Effect.tap(() => cache.set(cacheKey(id), data, cacheOpts))
+    )
+  );
+  const setAndReturn = (id, data) => Effect.gen(function* () {
+    yield* cache.set(cacheKey(id), data, cacheOpts);
+    return yield* castData({ id, data });
+  });
+  const freshGet = Effect.fn(function* (id) {
+    const uncached = yield* _select(id);
+    if (!uncached) return void 0;
+    return yield* setAndReturn(id, uncached.data);
+  });
+  const create = _tappedCacheUpdate(_insert);
+  const update = _tappedCacheUpdate(_update);
+  const get = Effect.fn(
+    (id) => cache.get(cacheKey(id)).pipe(
+      Effect.flatMap(
+        (cached) => cached ? castData({ id, data: cached }) : Effect.fail(new CacheMissError())
+      ),
+      Effect.catchTag("CacheMissError", () => freshGet(id))
+    )
+  );
+  const siteConfig = {
+    /**
+     * Retrieves the site configuration.
+     *
+     * @returns An effect that yields the site configuration entry or undefined if not found, or a database error.
+     */
+    get: () => get(SiteConfigId),
+    /**
+     * Updates the site configuration.
+     *
+     * @param data - The new site configuration data to store.
+     * @returns An effect that yields the updated site configuration entry or a database error.
+     */
+    update: (data) => update(SiteConfigId, {
+      ...data,
+      _config_version: SiteConfigVersion
+    }),
+    /**
+     * Initializes the site configuration.
+     *
+     * @param data - The site configuration data to store.
+     * @returns An effect that yields the created site configuration entry or a database error.
+     */
+    init: (data) => create(SiteConfigId, {
+      ...data,
+      _config_version: SiteConfigVersion
+    })
+  };
+  const mailerConfig = {
+    /**
+     * Retrieves the mailer configuration.
+     *
+     * @returns An effect that yields the mailer configuration entry or undefined if not found, or a database error.
+     */
+    get: () => get(MailerConfigId),
+    /**
+     * Updates the mailer configuration.
+     *
+     * @param data - The new mailer configuration data to store.
+     * @returns An effect that yields the updated mailer configuration entry or a database error.
+     */
+    update: (data) => update(MailerConfigId, {
+      ...data,
+      _config_version: MailerConfigVersion
+    }),
+    /**
+     * Initializes the mailer configuration.
+     *
+     * @param data - The mailer configuration data to store.
+     * @returns An effect that yields the created mailer configuration entry or a database error.
+     */
+    init: (data) => create(MailerConfigId, {
+      ...data,
+      _config_version: MailerConfigVersion
+    })
+  };
+  const notificationConfig = {
+    /**
+     * Retrieves the notification settings configuration.
+     *
+     * @returns An effect that yields the notification settings configuration entry or undefined if not found, or a database error.
+     */
+    get: () => get(NotificationSettingsId),
+    /**
+     * Updates the notification settings configuration.
+     *
+     * @param data - The new notification settings configuration data to store.
+     * @returns An effect that yields the updated notification settings configuration entry or a database error.
+     */
+    update: (data) => update(NotificationSettingsId, {
+      ...data,
+      _config_version: NotificationSettingsVersion
+    }),
+    /**
+     * Initializes the notification settings configuration.
+     *
+     * @param data - The notification settings configuration data to store.
+     * @returns An effect that yields the created notification settings configuration entry or a database error.
+     */
+    init: (data) => create(NotificationSettingsId, {
+      ...data,
+      _config_version: NotificationSettingsVersion
+    })
+  };
+  const templateConfig = {
+    /**
+     * Retrieves the template configuration.
+     *
+     * @returns An effect that yields the template configuration entry or undefined if not found, or a database error.
+     */
+    get: () => get(TemplateConfigId),
+    /**
+     * Updates the template configuration by merging with existing data.
+     *
+     * @param data - The new template configuration data to merge and store.
+     * @returns An effect that yields the updated template configuration entry or a database error.
+     */
+    update: (data) => Effect.gen(function* () {
+      const currentData = yield* get(TemplateConfigId);
+      if (!currentData) {
+        const updatedData2 = yield* merge((m) => m(defaultTemplates, data));
+        return yield* create(TemplateConfigId, {
+          ...updatedData2,
+          _config_version: TemplateConfigVersion
+        });
+      }
+      const updatedData = yield* merge((m) => m(currentData.data, data));
+      return yield* update(TemplateConfigId, {
+        ...updatedData,
+        _config_version: TemplateConfigVersion
+      });
+    }),
+    /**
+     * Initializes the template configuration.
+     *
+     * @param data - The template configuration data to store.
+     * @returns An effect that yields the created template configuration entry or a database error.
+     */
+    init: (data) => create(TemplateConfigId, {
+      ...data,
+      _config_version: TemplateConfigVersion
+    })
+  };
+  return {
+    siteConfig,
+    mailerConfig,
+    notificationConfig,
+    templateConfig
+  };
+});
+var config_default = SDKConfigModule;
+export {
+  SDKConfigModule,
+  config_default as default
+};

package/dist/modules/config/templates/mailer.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Default email templates for various mailer scenarios.
+ */
+export declare const defaultTemplates: {
+    /**
+     * A simple HTML template for general notifications.
+     *
+     * Variables:
+     * - `data.title`: The title of the notification.
+     * - `data.message`: The message content of the notification.
+     */
+    readonly notifications: "<!doctype html>\n<html>\n  <body>\n    <div\n      style='background-color:#F2F5F7;color:#242424;font-family:\"Helvetica Neue\", \"Arial Nova\", \"Nimbus Sans\", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'\n    >\n      <table\n        align=\"center\"\n        width=\"100%\"\n        style=\"margin:0 auto;max-width:600px;background-color:#FFFFFF\"\n        role=\"presentation\"\n        cellspacing=\"0\"\n        cellpadding=\"0\"\n        border=\"0\"\n      >\n        <tbody>\n          <tr style=\"width:100%\">\n            <td>\n              <h3\n                style=\"font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px\"\n              >\n                {{data.title}}\n              </h3>\n              <div\n                style=\"color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px\"\n              >\n                {{data.message}}\n              </div>\n            </td>\n          </tr>\n        </tbody>\n      </table>\n    </div>\n  </body>\n</html>";
+    /**
+     * A simple HTML template for password reset emails.
+     *
+     * Variables:
+     * - `data.link`: The password reset link.
+     */
+    readonly passwordReset: "<!doctype html>\n<html>\n  <body>\n    <div\n      style='background-color:#F2F5F7;color:#242424;font-family:\"Helvetica Neue\", \"Arial Nova\", \"Nimbus Sans\", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'\n    >\n      <table\n        align=\"center\"\n        width=\"100%\"\n        style=\"margin:0 auto;max-width:600px;background-color:#FFFFFF\"\n        role=\"presentation\"\n        cellspacing=\"0\"\n        cellpadding=\"0\"\n        border=\"0\"\n      >\n        <tbody>\n          <tr style=\"width:100%\">\n            <td>\n              <h3\n                style=\"font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px\"\n              >\n                Reset Your Password\n              </h3>\n              <div\n                style=\"color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px\"\n              >\n                Click the button below, or copy-paste the link to reset your password!\n                <br />\n                <br />\n                If you didn't request a password reset, you can ignore this email and\n                your password will not be changed.\n              </div>\n              <div style=\"text-align:left;padding:12px 24px 32px 24px\">\n                <a\n                  href=\"{{data.link}}\"\n                  style=\"color:#FFFFFF;font-size:14px;font-weight:bold;background-color:#0068FF;display:inline-block;padding:12px 20px;text-decoration:none\"\n                  target=\"_blank\"\n                  ><span>Reset Password</span></a\n                >\n              </div>\n              <div\n                style=\"font-size:12px;font-weight:normal;padding:16px 24px 16px 24px\"\n              >\n                Link: {{data.link}}\n              </div>\n            </td>\n          </tr>\n        </tbody>\n      </table>\n    </div>\n  </body>\n</html>";
+    /**
+     * A simple HTML template for user invite emails.
+     *
+     * Variables:
+     * - `site.title`: The title of the inviting organization or application.
+     * - `data.link`: The link for the user to set their password and get started.
+     */
+    readonly userInvite: "<!doctype html>\n<html>\n  <body>\n    <div\n      style='background-color:#F2F5F7;color:#242424;font-family:\"Helvetica Neue\", \"Arial Nova\", \"Nimbus Sans\", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'\n    >\n      <table\n        align=\"center\"\n        width=\"100%\"\n        style=\"margin:0 auto;max-width:600px;background-color:#FFFFFF\"\n        role=\"presentation\"\n        cellspacing=\"0\"\n        cellpadding=\"0\"\n        border=\"0\"\n      >\n        <tbody>\n          <tr style=\"width:100%\">\n            <td>\n              <h3\n                style=\"font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px\"\n              >\n                New User Invite from {{site.title}}\n              </h3>\n              <div\n                style=\"color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px\"\n              >\n                You have been invited to join {{site.title}}! Click the button below to set your password and get started.\n              </div>\n              <div style=\"text-align:left;padding:12px 24px 32px 24px\">\n                <a\n                  href=\"{{data.link}}\"\n                  style=\"color:#FFFFFF;font-size:14px;font-weight:bold;background-color:#0068FF;display:inline-block;padding:12px 20px;text-decoration:none\"\n                  target=\"_blank\"\n                  ><span>Set Password</span\n                  ></a\n                >\n              </div>\n              <div\n                style=\"font-size:12px;font-weight:normal;padding:16px 24px 16px 24px\"\n              >\n                Link: {{data.link}}\n              </div>\n            </td>\n          </tr>\n        </tbody>\n      </table>\n    </div>\n  </body>\n</html>";
+    /**
+     * A simple HTML template for email verification.
+     *
+     * Variables:
+     * - `data.link`: The email verification link.
+     */
+    readonly verifyEmail: "<!doctype html>\n<html>\n  <body>\n    <div\n      style='background-color:#F2F5F7;color:#242424;font-family:\"Helvetica Neue\", \"Arial Nova\", \"Nimbus Sans\", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'\n    >\n      <table\n        align=\"center\"\n        width=\"100%\"\n        style=\"margin:0 auto;max-width:600px;background-color:#FFFFFF\"\n        role=\"presentation\"\n        cellspacing=\"0\"\n        cellpadding=\"0\"\n        border=\"0\"\n      >\n        <tbody>\n          <tr style=\"width:100%\">\n            <td>\n              <h3\n                style=\"font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px\"\n              >\n                Verify your Email\n              </h3>\n              <div\n                style=\"color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px\"\n              >\n                Click the button below, or copy-paste the link to verify your\n                email!\n              </div>\n              <div style=\"text-align:left;padding:12px 24px 32px 24px\">\n                <a\n                  href=\"{{data.link}}\"\n                  style=\"color:#FFFFFF;font-size:14px;font-weight:bold;background-color:#0068FF;display:inline-block;padding:12px 20px;text-decoration:none\"\n                  target=\"_blank\"\n                  ><span>Verify Email</span></a\n                >\n              </div>\n              <div\n                style=\"font-size:12px;font-weight:normal;padding:16px 24px 16px 24px\"\n              >\n                Link: {{data.link}}\n              </div>\n            </td>\n          </tr>\n        </tbody>\n      </table>\n    </div>\n  </body>\n</html>";
+};
+export default defaultTemplates;

package/dist/modules/config/templates/mailer.js

@@ -0,0 +1,218 @@
+const defaultTemplates = {
+  /**
+   * A simple HTML template for general notifications.
+   *
+   * Variables:
+   * - `data.title`: The title of the notification.
+   * - `data.message`: The message content of the notification.
+   */
+  notifications: `<!doctype html>
+<html>
+  <body>
+    <div
+      style='background-color:#F2F5F7;color:#242424;font-family:"Helvetica Neue", "Arial Nova", "Nimbus Sans", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'
+    >
+      <table
+        align="center"
+        width="100%"
+        style="margin:0 auto;max-width:600px;background-color:#FFFFFF"
+        role="presentation"
+        cellspacing="0"
+        cellpadding="0"
+        border="0"
+      >
+        <tbody>
+          <tr style="width:100%">
+            <td>
+              <h3
+                style="font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px"
+              >
+                {{data.title}}
+              </h3>
+              <div
+                style="color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px"
+              >
+                {{data.message}}
+              </div>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </body>
+</html>`,
+  /**
+   * A simple HTML template for password reset emails.
+   *
+   * Variables:
+   * - `data.link`: The password reset link.
+   */
+  passwordReset: `<!doctype html>
+<html>
+  <body>
+    <div
+      style='background-color:#F2F5F7;color:#242424;font-family:"Helvetica Neue", "Arial Nova", "Nimbus Sans", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'
+    >
+      <table
+        align="center"
+        width="100%"
+        style="margin:0 auto;max-width:600px;background-color:#FFFFFF"
+        role="presentation"
+        cellspacing="0"
+        cellpadding="0"
+        border="0"
+      >
+        <tbody>
+          <tr style="width:100%">
+            <td>
+              <h3
+                style="font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px"
+              >
+                Reset Your Password
+              </h3>
+              <div
+                style="color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px"
+              >
+                Click the button below, or copy-paste the link to reset your password!
+                <br />
+                <br />
+                If you didn't request a password reset, you can ignore this email and
+                your password will not be changed.
+              </div>
+              <div style="text-align:left;padding:12px 24px 32px 24px">
+                <a
+                  href="{{data.link}}"
+                  style="color:#FFFFFF;font-size:14px;font-weight:bold;background-color:#0068FF;display:inline-block;padding:12px 20px;text-decoration:none"
+                  target="_blank"
+                  ><span>Reset Password</span></a
+                >
+              </div>
+              <div
+                style="font-size:12px;font-weight:normal;padding:16px 24px 16px 24px"
+              >
+                Link: {{data.link}}
+              </div>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </body>
+</html>`,
+  /**
+   * A simple HTML template for user invite emails.
+   *
+   * Variables:
+   * - `site.title`: The title of the inviting organization or application.
+   * - `data.link`: The link for the user to set their password and get started.
+   */
+  userInvite: `<!doctype html>
+<html>
+  <body>
+    <div
+      style='background-color:#F2F5F7;color:#242424;font-family:"Helvetica Neue", "Arial Nova", "Nimbus Sans", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'
+    >
+      <table
+        align="center"
+        width="100%"
+        style="margin:0 auto;max-width:600px;background-color:#FFFFFF"
+        role="presentation"
+        cellspacing="0"
+        cellpadding="0"
+        border="0"
+      >
+        <tbody>
+          <tr style="width:100%">
+            <td>
+              <h3
+                style="font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px"
+              >
+                New User Invite from {{site.title}}
+              </h3>
+              <div
+                style="color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px"
+              >
+                You have been invited to join {{site.title}}! Click the button below to set your password and get started.
+              </div>
+              <div style="text-align:left;padding:12px 24px 32px 24px">
+                <a
+                  href="{{data.link}}"
+                  style="color:#FFFFFF;font-size:14px;font-weight:bold;background-color:#0068FF;display:inline-block;padding:12px 20px;text-decoration:none"
+                  target="_blank"
+                  ><span>Set Password</span
+                  ></a
+                >
+              </div>
+              <div
+                style="font-size:12px;font-weight:normal;padding:16px 24px 16px 24px"
+              >
+                Link: {{data.link}}
+              </div>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </body>
+</html>`,
+  /**
+   * A simple HTML template for email verification.
+   *
+   * Variables:
+   * - `data.link`: The email verification link.
+   */
+  verifyEmail: `<!doctype html>
+<html>
+  <body>
+    <div
+      style='background-color:#F2F5F7;color:#242424;font-family:"Helvetica Neue", "Arial Nova", "Nimbus Sans", Arial, sans-serif;font-size:16px;font-weight:400;letter-spacing:0.15008px;line-height:1.5;margin:0;padding:32px 0;min-height:100%;width:100%'
+    >
+      <table
+        align="center"
+        width="100%"
+        style="margin:0 auto;max-width:600px;background-color:#FFFFFF"
+        role="presentation"
+        cellspacing="0"
+        cellpadding="0"
+        border="0"
+      >
+        <tbody>
+          <tr style="width:100%">
+            <td>
+              <h3
+                style="font-weight:bold;text-align:left;margin:0;font-size:20px;padding:32px 24px 0px 24px"
+              >
+                Verify your Email
+              </h3>
+              <div
+                style="color:#474849;font-size:14px;font-weight:normal;text-align:left;padding:8px 24px 16px 24px"
+              >
+                Click the button below, or copy-paste the link to verify your
+                email!
+              </div>
+              <div style="text-align:left;padding:12px 24px 32px 24px">
+                <a
+                  href="{{data.link}}"
+                  style="color:#FFFFFF;font-size:14px;font-weight:bold;background-color:#0068FF;display:inline-block;padding:12px 20px;text-decoration:none"
+                  target="_blank"
+                  ><span>Verify Email</span></a
+                >
+              </div>
+              <div
+                style="font-size:12px;font-weight:normal;padding:16px 24px 16px 24px"
+              >
+                Link: {{data.link}}
+              </div>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+  </body>
+</html>`
+};
+var mailer_default = defaultTemplates;
+export {
+  mailer_default as default,
+  defaultTemplates
+};

package/dist/modules/config/type-utils.d.ts

@@ -0,0 +1,13 @@
+import { Effect } from '@withstudiocms/effect';
+import type { DynamicConfigEntry } from '../../types.js';
+/**
+ * Casts the given id and data into a DynamicConfigEntry.
+ *
+ * @template T - The type of the data in the configuration entry.
+ * @param param0 - An object containing the id and data.
+ * @returns An effect that yields a DynamicConfigEntry with the given id and data.
+ */
+export declare const castData: <T>({ id, data, }: {
+    id: string;
+    data: T;
+}) => Effect.Effect<DynamicConfigEntry<T>>;

package/dist/modules/config/type-utils.js

@@ -0,0 +1,11 @@
+import { Effect } from "@withstudiocms/effect";
+const castData = ({
+  id,
+  data
+}) => Effect.succeed({
+  id,
+  data
+});
+export {
+  castData
+};

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

@@ -0,0 +1,140 @@
+import { Effect } from '@withstudiocms/effect';
+import { DBClientLive, SDKDefaults } from '../../context.js';
+/**
+ * SDKDeleteModule
+ *
+ * Effect generator that builds and returns the Delete API for the StudioCMS SDK.
+ *
+ * This module wires together low-level database delete operations, input validation
+ * (via encoders), cache clearing and higher-level helpers to provide a cohesive
+ * deletion surface for pages, page content, tags, categories, permissions, diff
+ * tracking, folders and users.
+ *
+ * Remarks
+ * - All low-level DB deletes are wrapped with a validation encoder (withEncoder)
+ *   and execute the underlying query using executeTakeFirstOrThrow; absent rows
+ *   will surface as errors which are handled by the module's error pipeline.
+ * - High-level helpers compose these low-level operations into meaningful flows:
+ *   - Page deletion clears diff tracking, page content and page data, then clears relevant caches.
+ *   - Folder deletion triggers subsequent updates to folder list and folder tree views.
+ *   - User deletion clears user references and prevents deletion of the platform
+ *     "ghost" (internal) user.
+ * - The module uses a shared error handler (_handleErrors) to normalize errors into
+ *   DeletionResponse values where possible.
+ *
+ * Error handling
+ * - DB-level errors (not found / constraint failures) thrown by executeTakeFirstOrThrow
+ *   are propagated into the module's error-handling pipeline and converted into
+ *   DeletionResponse values by _handleErrors.
+ * - Ghost user protection surfaces a GhostUserError that is caught and turned into
+ *   an appropriate DeletionResponse explaining that the internal user cannot be deleted.
+ * - Folder update failures are specially caught and returned with an explanatory message.
+ *
+ * Side effects
+ * - Cache/derived-data clearing routines are invoked where appropriate (e.g. page cache
+ *   clearing after deleting page content).
+ * - Folder deletion triggers background updates to folder list and folder tree.
+ *
+ * Returns
+ * - An Effect that, when executed, yields an object containing the DELETE API
+ *   described above. Each method itself is an Effect producing a DeletionResponse
+ *   describing success or a mapped error.
+ *
+ * Example
+ * - const deleteModule = yield* SDKDeleteModule;
+ * - yield* deleteModule.page('page-id-123') // returns a DeletionResponse effect
+ */
+export declare const SDKDeleteModule: Effect.Effect<{
+    /**
+     * Deletes a page by its ID.
+     *
+     * @param id - The ID of the page to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    page: (id: string) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes page content by its ID.
+     *
+     * @param id - The ID of the page content to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    pageContent: (id: string) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes page content for a specific language by its ID and language.
+     *
+     * @param id - The ID of the page content to delete.
+     * @param lang - The language of the page content to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    pageContentLang: (id: string, lang: string) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes a tag by its ID.
+     *
+     * @param id - The ID of the tag to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    tags: (id: number) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes a category by its ID.
+     *
+     * @param id - The ID of the category to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    categories: (id: number) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes permissions for a specific user by their ID.
+     *
+     * @param userId - The ID of the user whose permissions to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    permissions: (userId: string) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes diff tracking entry by diff ID.
+     *
+     * @param id - The ID of the diff tracking entry to be deleted.
+     * @returns An effect that represents the deletion operation.
+     */
+    diffTracking: (id: string) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes a folder by its ID.
+     *
+     * @param folderId - The ID of the folder to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    folder: (folderId: string) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+    /**
+     * Deletes a user by their ID.
+     *
+     * @param userId - The ID of the user to delete.
+     * @returns An effect that resolves to a success or error message.
+     */
+    user: (userId: string) => Effect.Effect<{
+        status: "success" | "error";
+        message: string;
+    }, never, never>;
+}, never, DBClientLive | SDKDefaults | import("../../cache.js").CacheService | import("@withstudiocms/effect").Deepmerge>;
+export default SDKDeleteModule;