@withstudiocms/sdk 0.0.0-beta.0 → 0.1.0

package/dist/modules/auth/index.js

@@ -0,0 +1,436 @@
+import { Effect, Schema } from "@withstudiocms/effect";
+import { DBClientLive, SDKDefaults } from "../../context.js";
+import {
+  StudioCMSEmailVerificationTokens,
+  StudioCMSOAuthAccounts,
+  StudioCMSPermissions,
+  StudioCMSSessionTable,
+  StudioCMSUsersTable
+} from "../../tables.js";
+import {
+  AuthErrorTagsEntries
+} from "../../types.js";
+import { SDKGenerators } from "../util/generators.js";
+const SDKAuthModule = Effect.gen(function* () {
+  const [{ withCodec, withEncoder }, { generateToken }, { GhostUserDefaults }] = yield* Effect.all([
+    DBClientLive,
+    SDKGenerators,
+    SDKDefaults
+  ]);
+  const _getVerificationToken = withCodec({
+    encoder: Schema.String,
+    decoder: Schema.UndefinedOr(StudioCMSEmailVerificationTokens.Select),
+    callbackFn: (db, id) => db(
+      (client) => client.selectFrom("StudioCMSEmailVerificationTokens").selectAll().where("id", "=", id).executeTakeFirst()
+    )
+  });
+  const _deleteVerificationToken = withEncoder({
+    encoder: Schema.String,
+    callbackFn: (db, id) => db(
+      (client) => client.deleteFrom("StudioCMSEmailVerificationTokens").where("userId", "=", id).executeTakeFirst()
+    )
+  });
+  const _insertVerificationToken = withCodec({
+    encoder: StudioCMSEmailVerificationTokens.Insert,
+    decoder: StudioCMSEmailVerificationTokens.Select,
+    callbackFn: (db, data) => db(
+      (client) => client.transaction().execute(async (trx) => {
+        await trx.insertInto("StudioCMSEmailVerificationTokens").values(data).executeTakeFirstOrThrow();
+        return await trx.selectFrom("StudioCMSEmailVerificationTokens").selectAll().where("id", "=", data.id).executeTakeFirstOrThrow();
+      })
+    )
+  });
+  const _createNewOAuthAccount = withCodec({
+    encoder: StudioCMSOAuthAccounts.Insert,
+    decoder: StudioCMSOAuthAccounts.Select,
+    callbackFn: (db, data) => db(
+      (client) => client.transaction().execute(async (trx) => {
+        await trx.insertInto("StudioCMSOAuthAccounts").values(data).executeTakeFirstOrThrow();
+        return await trx.selectFrom("StudioCMSOAuthAccounts").selectAll().where(
+          (eb) => eb.and([eb("userId", "=", data.userId), eb("provider", "=", data.provider)])
+        ).executeTakeFirstOrThrow();
+      })
+    )
+  });
+  const _deleteOAuthUserAccount = withEncoder({
+    encoder: Schema.Struct({
+      userId: Schema.String,
+      provider: Schema.String
+    }),
+    callbackFn: (db, { userId, provider }) => db(
+      (client) => client.deleteFrom("StudioCMSOAuthAccounts").where((eb) => eb.and([eb("userId", "=", userId), eb("provider", "=", provider)])).executeTakeFirst()
+    )
+  });
+  const _searchOAuthAccountByProviderId = withCodec({
+    encoder: Schema.Struct({
+      providerUserId: Schema.String,
+      userId: Schema.String
+    }),
+    decoder: Schema.UndefinedOr(StudioCMSOAuthAccounts.Select),
+    callbackFn: (db, { providerUserId, userId }) => db(
+      (client) => client.selectFrom("StudioCMSOAuthAccounts").selectAll().where(
+        (eb) => eb.and([eb("providerUserId", "=", providerUserId), eb("userId", "=", userId)])
+      ).executeTakeFirst()
+    )
+  });
+  const _searchOauthProvidersForId = withCodec({
+    encoder: Schema.Struct({
+      providerId: Schema.String,
+      userId: Schema.String
+    }),
+    decoder: Schema.UndefinedOr(StudioCMSOAuthAccounts.Select),
+    callbackFn: (db, { providerId, userId }) => db(
+      (client) => client.selectFrom("StudioCMSOAuthAccounts").selectAll().where((eb) => eb.and([eb("provider", "=", providerId), eb("userId", "=", userId)])).executeTakeFirst()
+    )
+  });
+  const _getCurrentPermission = withCodec({
+    encoder: Schema.String,
+    decoder: Schema.UndefinedOr(StudioCMSPermissions.Select),
+    callbackFn: (db, id) => db(
+      (client) => client.selectFrom("StudioCMSPermissions").selectAll().where("user", "=", id).executeTakeFirst()
+    )
+  });
+  const _createNewSession = withCodec({
+    encoder: StudioCMSSessionTable.Insert,
+    decoder: StudioCMSSessionTable.Select,
+    callbackFn: (db, data) => db(
+      (client) => client.transaction().execute(async (trx) => {
+        await trx.insertInto("StudioCMSSessionTable").values(data).executeTakeFirstOrThrow();
+        return await trx.selectFrom("StudioCMSSessionTable").selectAll().where("id", "=", data.id).executeTakeFirstOrThrow();
+      })
+    )
+  });
+  const _getUserById = withCodec({
+    encoder: Schema.String,
+    decoder: Schema.UndefinedOr(StudioCMSUsersTable.Select),
+    callbackFn: (db, id) => db(
+      (client) => client.selectFrom("StudioCMSUsersTable").selectAll().where("id", "=", id).executeTakeFirst()
+    )
+  });
+  const _getSessionById = withCodec({
+    encoder: Schema.String,
+    decoder: Schema.UndefinedOr(StudioCMSSessionTable.Select),
+    callbackFn: (db, id) => db(
+      (client) => client.selectFrom("StudioCMSSessionTable").selectAll().where("id", "=", id).executeTakeFirst()
+    )
+  });
+  const _deleteSession = withEncoder({
+    encoder: Schema.String,
+    callbackFn: (db, id) => db(
+      (client) => client.deleteFrom("StudioCMSSessionTable").where("id", "=", id).executeTakeFirst()
+    )
+  });
+  const _updateSession = withCodec({
+    encoder: Schema.Struct({
+      id: Schema.String,
+      newDate: Schema.Date
+    }),
+    decoder: StudioCMSSessionTable.Select,
+    callbackFn: (db, { id, newDate }) => db(
+      (client) => client.transaction().execute(async (trx) => {
+        await trx.updateTable("StudioCMSSessionTable").set({ expiresAt: newDate }).where("id", "=", id).executeTakeFirstOrThrow();
+        return await trx.selectFrom("StudioCMSSessionTable").selectAll().where("id", "=", id).executeTakeFirstOrThrow();
+      })
+    )
+  });
+  const _createNewUser = withCodec({
+    encoder: StudioCMSUsersTable.Insert,
+    decoder: StudioCMSUsersTable.Select,
+    callbackFn: (db, data) => db(
+      (client) => client.transaction().execute(async (trx) => {
+        await trx.insertInto("StudioCMSUsersTable").values(data).executeTakeFirstOrThrow();
+        return await trx.selectFrom("StudioCMSUsersTable").selectAll().where("id", "=", data.id).executeTakeFirstOrThrow();
+      })
+    )
+  });
+  const _createUserPermission = withCodec({
+    encoder: StudioCMSPermissions.Insert,
+    decoder: StudioCMSPermissions.Select,
+    callbackFn: (db, data) => db(
+      (client) => client.transaction().execute(async (trx) => {
+        await trx.insertInto("StudioCMSPermissions").values(data).executeTakeFirstOrThrow();
+        return await trx.selectFrom("StudioCMSPermissions").selectAll().where("user", "=", data.user).executeTakeFirstOrThrow();
+      })
+    )
+  });
+  const _updateUserData = withCodec({
+    encoder: Schema.Struct({
+      userId: Schema.String,
+      userData: StudioCMSUsersTable.Update
+    }),
+    decoder: StudioCMSUsersTable.Select,
+    callbackFn: (db, { userId, userData }) => db(
+      (client) => client.transaction().execute(async (trx) => {
+        await trx.updateTable("StudioCMSUsersTable").set(userData).where("id", "=", userId).executeTakeFirstOrThrow();
+        return await trx.selectFrom("StudioCMSUsersTable").selectAll().where("id", "=", userId).executeTakeFirstOrThrow();
+      })
+    )
+  });
+  const _searchForUsername = withCodec({
+    encoder: Schema.String,
+    decoder: Schema.Array(StudioCMSUsersTable.Select),
+    callbackFn: (db, username) => db(
+      (client) => client.selectFrom("StudioCMSUsersTable").selectAll().where("username", "=", username).execute()
+    )
+  });
+  const _searchForEmail = withCodec({
+    encoder: Schema.String,
+    decoder: Schema.Array(StudioCMSUsersTable.Select),
+    callbackFn: (db, email) => db(
+      (client) => client.selectFrom("StudioCMSUsersTable").selectAll().where("email", "=", email).execute()
+    )
+  });
+  const _pippedInsertToken = (userId) => Effect.fn(
+    (token) => _insertVerificationToken({
+      id: crypto.randomUUID(),
+      userId,
+      token,
+      expiresAt: new Date(Date.now() + 1e3 * 60 * 60 * 24).toISOString()
+    })
+  );
+  const _createVerificationToken = Effect.fn(
+    (userId) => generateToken(userId).pipe(
+      Effect.tap(() => _deleteVerificationToken(userId)),
+      Effect.flatMap(_pippedInsertToken(userId))
+    )
+  );
+  const _getSessionWithUserById = Effect.fn(function* (sessionId) {
+    const session2 = yield* _getSessionById(sessionId);
+    if (!session2) return void 0;
+    const user2 = yield* _getUserById(session2.userId);
+    if (!user2) return void 0;
+    return {
+      session: session2,
+      user: user2
+    };
+  });
+  const _createNewUserWithPermission = Effect.fn(
+    (userData, rank) => _createNewUser(userData).pipe(
+      Effect.tap(
+        ({ id: user2 }) => _createUserPermission({
+          user: user2,
+          rank
+        })
+      )
+    )
+  );
+  const _searchForUsernameOrEmail = Effect.fn(function* (username, email) {
+    const usernameSearch = [];
+    const emailSearch = [];
+    if (username) {
+      const results = yield* _searchForUsername(username);
+      usernameSearch.push(...results);
+    }
+    if (email) {
+      const results = yield* _searchForEmail(email);
+      emailSearch.push(...results);
+    }
+    return { usernameSearch, emailSearch };
+  });
+  const _verifyGhostUserExists = Effect.fn(
+    () => _getUserById(GhostUserDefaults.id).pipe(Effect.map((user2) => !!user2))
+  );
+  const _createGhostUser = Effect.fn(
+    () => _getUserById(GhostUserDefaults.id).pipe(
+      Effect.flatMap(
+        (user2) => user2 ? Effect.succeed(user2) : _createNewUser({
+          ...GhostUserDefaults,
+          updatedAt: (/* @__PURE__ */ new Date()).toISOString(),
+          createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+          emailVerified: false
+        })
+      )
+    )
+  );
+  const _getGhostUser = Effect.fn(
+    () => _getUserById(GhostUserDefaults.id).pipe(
+      Effect.flatMap((user2) => user2 ? Effect.succeed(user2) : _createGhostUser())
+    )
+  );
+  const _CatchErrs = (capt) => Effect.catchTags(
+    AuthErrorTagsEntries.reduce(
+      (acc, tag) => {
+        acc[tag] = () => Effect.succeed({
+          status: "error",
+          message: `An error occurred while deleting ${capt}`
+        });
+        return acc;
+      },
+      {}
+    )
+  );
+  const verifyEmail = {
+    /**
+     * Retrieves an email verification token by its ID.
+     *
+     * @param id - The ID of the email verification token to retrieve.
+     * @returns A promise that resolves to the email verification token if found, otherwise undefined.
+     */
+    get: _getVerificationToken,
+    /**
+     * Creates a new email verification token in the database.
+     *
+     * @param userId - The ID of the user to create the token for.
+     * @returns A promise that resolves to the created email verification token.
+     */
+    create: _createVerificationToken,
+    /**
+     * Deletes an email verification token from the database.
+     *
+     * @param userId - The ID of the user associated with the token.
+     * @returns A promise that resolves to the deletion response.
+     */
+    delete: _deleteVerificationToken
+  };
+  const oAuth = {
+    /**
+     * Creates a new OAuth account in the database.
+     *
+     * @param input - The OAuth account data to create.
+     * @returns A promise that resolves to the created OAuth account.
+     */
+    create: _createNewOAuthAccount,
+    /**
+     * Deletes an OAuth user account from the database.
+     *
+     * @param input - An object containing the userId and provider of the OAuth account to delete.
+     * @returns A promise that resolves to a status and message indicating the result of the deletion.
+     */
+    delete: (input) => _deleteOAuthUserAccount(input).pipe(
+      Effect.flatMap(
+        () => Effect.succeed({
+          status: "success",
+          message: "OAuth account deleted successfully"
+        })
+      ),
+      _CatchErrs("OAuth account")
+    ),
+    /**
+     * Searches for an OAuth account by provider user ID and user ID.
+     *
+     * @param input - An object containing the providerUserId and userId to search for.
+     * @returns A promise that resolves to the found OAuth account if it exists, otherwise undefined.
+     */
+    searchByProviderId: _searchOAuthAccountByProviderId,
+    /**
+     * Searches for OAuth providers for a given user ID.
+     *
+     * @param input - An object containing the providerId and userId to search for.
+     * @returns A promise that resolves to the found OAuth account if it exists, otherwise undefined.
+     */
+    searchProvidersForId: _searchOauthProvidersForId
+  };
+  const permission = {
+    /**
+     * Retrieves the current permission for a user by their ID.
+     *
+     * @param id - The ID of the user whose permission is to be retrieved.
+     * @returns A promise that resolves to the user's permission if found, otherwise undefined.
+     */
+    currentStatus: _getCurrentPermission
+  };
+  const session = {
+    /**
+     * Creates a new session for a user.
+     *
+     * @param data - The session data to create.
+     * @returns A promise that resolves to the created session.
+     */
+    create: _createNewSession,
+    /**
+     * Retrieves a user's Session by its ID.
+     *
+     * @param id - The ID of the session to retrieve.
+     * @returns A promise that resolves to the session if found, otherwise undefined.
+     */
+    getById: _getSessionById,
+    /**
+     * Retrieves a session along with its associated user by session ID.
+     *
+     * @param sessionId - The ID of the session to retrieve.
+     * @returns A promise that resolves to an object containing the session and user if found, otherwise undefined.
+     */
+    sessionWithUser: _getSessionWithUserById,
+    /**
+     * Deletes a session by its ID.
+     *
+     * @param input - The ID of the session to delete.
+     * @returns A promise that resolves to a status and message indicating the result of the deletion.
+     */
+    delete: (input) => _deleteSession(input).pipe(
+      Effect.flatMap(
+        () => Effect.succeed({ status: "success", message: "Session deleted successfully" })
+      ),
+      _CatchErrs("Session")
+    ),
+    /**
+     * Updates a session's expiration date.
+     *
+     * @param input - An object containing the session ID and the new expiration date.
+     * @returns A promise that resolves to the updated session.
+     */
+    update: _updateSession
+  };
+  const user = {
+    /**
+     * Creates a new user with the specified permissions.
+     *
+     * @param userData - The data for the new user.
+     * @param rank - The permission rank for the new user.
+     * @returns A promise that resolves to the created user.
+     */
+    create: _createNewUserWithPermission,
+    /**
+     * Updates user data for a specified user.
+     *
+     * @param input - An object containing the userId and the userData to update.
+     * @returns A promise that resolves to the updated user.
+     */
+    update: _updateUserData,
+    /**
+     * Searches for users by username.
+     *
+     * @param username - The username to search for.
+     * @param email - The email to search for.
+     * @returns A promise that resolves to an array of users matching the username.
+     */
+    searchUsersForUsernameOrEmail: _searchForUsernameOrEmail,
+    /**
+     * Verifies the existence of the ghost user.
+     *
+     * @returns A promise that resolves to true if the ghost user exists, otherwise false.
+     */
+    ghost: {
+      /**
+       * Verifies the existence of the ghost user.
+       *
+       * @returns A promise that resolves to true if the ghost user exists, otherwise false.
+       */
+      verifyExists: _verifyGhostUserExists,
+      /**
+       * Creates the ghost user if it does not already exist.
+       *
+       * @returns A promise that resolves to the ghost user.
+       */
+      create: _createGhostUser,
+      /**
+       * Retrieves the ghost user.
+       *
+       * @returns A promise that resolves to the ghost user.
+       */
+      get: _getGhostUser
+    }
+  };
+  return {
+    verifyEmail,
+    oAuth,
+    permission,
+    session,
+    user
+  };
+});
+var auth_default = SDKAuthModule;
+export {
+  SDKAuthModule,
+  auth_default as default
+};

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

@@ -0,0 +1,72 @@
+import { Effect } from '@withstudiocms/effect';
+import CacheService from '../../cache.js';
+/**
+ * Effect that provides a collection of cache-clearing helpers for the SDK.
+ *
+ * This generator yields the CacheService and returns a CLEAR object containing effects and effect-creating
+ * functions to delete individual cache entries or invalidate groups of cache tags used across the system.
+ *
+ * Returned CLEAR shape:
+ * - page.byId(id: string): Effect<void>
+ *   Deletes a single cached page entry by its ID (uses cacheKeyGetters.page and CacheService.delete).
+ *
+ * - pages: Effect<void>
+ *   Invalidates tags related to pages, page folder trees, folder trees and folder lists.
+ *
+ * - latestVersion: Effect<void>
+ *   Invalidates tags for NPM package metadata (e.g. cached latest package versions).
+ *
+ * - folderTree: Effect<void>
+ *   Invalidates folder tree and page folder tree tags.
+ *
+ * - folderList: Effect<void>
+ *   Invalidates the folder list tags.
+ *
+ * Remarks:
+ * - Each member is an Effect (or a function returning an Effect) that resolves when the cache operation completes.
+ * - The module internally depends on CacheService as well as cacheKeyGetters and cacheTags.
+ *
+ * @returns An Effect that resolves to an object exposing the described cache-clearing helpers.
+ *
+ * @example
+ * // within an Effect.gen or other Effect context:
+ * const CLEAR = yield* SDKClearModule;
+ * yield* CLEAR.page.byId("some-page-id");
+ * yield* CLEAR.pages;
+ */
+export declare const SDKClearModule: Effect.Effect<{
+    /**
+     * Clears a cached page by its ID.
+     * @param id - The ID of the page to clear from the cache.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    page: {
+        /**
+         * Clears a cached page by its ID.
+         * @param id - The ID of the page to clear from the cache.
+         * @returns An Effect that resolves when the operation is complete.
+         */
+        byId: (id: string) => Effect.Effect<void, never, never>;
+    };
+    /**
+     * Clears cached data related to various entities.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    pages: Effect.Effect<void, never, never>;
+    /**
+     * Clears cached data related to the latest NPM package versions.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    latestVersion: Effect.Effect<void, never, never>;
+    /**
+     * Clears cached folder trees and page folder trees.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    folderTree: Effect.Effect<void, never, never>;
+    /**
+     * Clears the cached folder list.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    folderList: Effect.Effect<void, never, never>;
+}, never, CacheService>;
+export default SDKClearModule;

package/dist/modules/clear/index.js

@@ -0,0 +1,52 @@
+import { Effect } from "@withstudiocms/effect";
+import CacheService from "../../cache.js";
+import { cacheKeyGetters, cacheTags } from "../../consts.js";
+const SDKClearModule = Effect.gen(function* () {
+  const { invalidateTags, delete: deleteEntry } = yield* CacheService;
+  const CLEAR = {
+    /**
+     * Clears a cached page by its ID.
+     * @param id - The ID of the page to clear from the cache.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    page: {
+      /**
+       * Clears a cached page by its ID.
+       * @param id - The ID of the page to clear from the cache.
+       * @returns An Effect that resolves when the operation is complete.
+       */
+      byId: Effect.fn((id) => deleteEntry(cacheKeyGetters.page(id)))
+    },
+    /**
+     * Clears cached data related to various entities.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    pages: invalidateTags([
+      ...cacheTags.pages,
+      ...cacheTags.pageFolderTree,
+      ...cacheTags.folderTree,
+      ...cacheTags.folderList
+    ]),
+    /**
+     * Clears cached data related to the latest NPM package versions.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    latestVersion: invalidateTags(cacheTags.npmPackage),
+    /**
+     * Clears cached folder trees and page folder trees.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    folderTree: invalidateTags([...cacheTags.folderTree, ...cacheTags.pageFolderTree]),
+    /**
+     * Clears the cached folder list.
+     * @returns An Effect that resolves when the operation is complete.
+     */
+    folderList: invalidateTags(cacheTags.folderList)
+  };
+  return CLEAR;
+});
+var clear_default = SDKClearModule;
+export {
+  SDKClearModule,
+  clear_default as default
+};

package/dist/modules/config/consts.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Constants for configuration entries.
+ */
+export declare const SiteConfigId: string;
+/**
+ * Version of the site configuration.
+ */
+export declare const SiteConfigVersion = "1.0.0";
+/**
+ * Constants for mailer configuration entries.
+ */
+export declare const MailerConfigId: string;
+/**
+ * Version of the mailer configuration.
+ */
+export declare const MailerConfigVersion = "1.0.0";
+/**
+ * Constants for notification settings configuration entries.
+ */
+export declare const NotificationSettingsId: string;
+/**
+ * Version of the notification settings configuration.
+ */
+export declare const NotificationSettingsVersion = "1.0.0";
+/**
+ * Constants for template configuration entries.
+ */
+export declare const TemplateConfigId: string;
+/**
+ * Version of the template configuration.
+ */
+export declare const TemplateConfigVersion = "1.0.0";

package/dist/modules/config/consts.js

@@ -0,0 +1,18 @@
+const SiteConfigId = "SCMS_SITE_CONFIG_1";
+const SiteConfigVersion = "1.0.0";
+const MailerConfigId = "SCMS_MAILER_CONFIG_1";
+const MailerConfigVersion = "1.0.0";
+const NotificationSettingsId = "SCMS_NOTIFICATION_SETTINGS_1";
+const NotificationSettingsVersion = "1.0.0";
+const TemplateConfigId = "SCMS_EMAIL_TEMPLATES_1";
+const TemplateConfigVersion = "1.0.0";
+export {
+  MailerConfigId,
+  MailerConfigVersion,
+  NotificationSettingsId,
+  NotificationSettingsVersion,
+  SiteConfigId,
+  SiteConfigVersion,
+  TemplateConfigId,
+  TemplateConfigVersion
+};