@symbo.ls/sdk 2.34.35 → 3.1.2

package/src/utils/symstoryClient.js

@@ -0,0 +1,252 @@
+import config from '../config/environment.js'
+
+const DEFAULT_OPTIONS = {
+  baseUrl: config.baseUrl
+}
+
+class SymstoryClient {
+  /**
+   * Creates an instance of SymstoryClient.
+   * @param {string} appKey - The application key.
+   * @param {object} [options={}] - The options for the client.
+   */
+  constructor (appKey, options = {}) {
+    if (!appKey) {
+      throw new Error('AppKey is required')
+    }
+    this.appKey = appKey
+    this.options = { ...DEFAULT_OPTIONS, ...options }
+    this.headers = {
+      'Content-Type': 'application/json',
+      ...this.options.headers,
+      'X-AppKey': appKey
+    }
+  }
+
+  /**
+   * Makes a request to the Symstory service.
+   * @param {string} [path=''] - The request path.
+   * @param {object} [options={}] - The request options.
+   * @returns {Promise<any>} - The response data.
+   */
+  async request (path = '', options = {}) {
+    const url = `${this.options.baseUrl}/symstory/${this.appKey}${path}`
+    const response = await fetch(url, {
+      ...options,
+      headers: { ...this.headers, ...options.headers }
+    })
+
+    if (!response.ok) {
+      const error = await response.json()
+      throw new Error(error.message || error.error || 'Request failed')
+    }
+
+    return response.status === 204 ? null : response.json()
+  }
+
+  /**
+   * Fetches project data.
+   * @param {object} query - The query object to filter data.
+   * @param {string|null} [branch=null] - The branch name.
+   * @param {string|null} [version=null] - The version number.
+   * @returns {Promise<any>} - The project data.
+   */
+  get (query, branch = null, version = null) {
+    const params = new URLSearchParams({
+      ...(branch && { branch }),
+      ...(version ? { version } : { cacheId: Math.random() }),
+      ...(query && { query: JSON.stringify(query) })
+    })
+    return this.request(`?${params}`)
+  }
+
+  /**
+   * Sets a value at the specified path.
+   * @param {string} path - The path where the value should be set.
+   * @param {any} value - The value to set.
+   * @returns {Promise<any>} - The response data.
+   */
+  set (path, value) {
+    return this.request('', {
+      method: 'POST',
+      body: JSON.stringify({ changes: [['update', path, value]] })
+    })
+  }
+
+  /**
+   * Updates project data.
+   * @param {Array} changes - The changes to apply.
+   * @param {object} [options={}] - The update options.
+   * @param {string} [options.type='patch'] - The type of update.
+   * @param {string} [options.message=''] - A message describing the update.
+   * @param {string} [options.branch='main'] - The branch name.
+   * @returns {Promise<any>} - The response data.
+   */
+  async update (
+    changes,
+    { type = 'patch', message = '', branch = 'main' } = {}
+  ) {
+    return await this.request('', {
+      method: 'POST',
+      body: JSON.stringify({ changes, type, message, branch })
+    })
+  }
+
+  /**
+   * Retrieves all branches of the project.
+   * @returns {Promise<any>} - The branches data.
+   */
+  getBranches () {
+    return this.request('/branches')
+  }
+
+  /**
+   * Creates a new branch.
+   * @param {string} branch - The name of the new branch.
+   * @param {object} [options={}] - The branch creation options.
+   * @param {string} [options.message] - A message describing the branch creation.
+   * @param {string} [options.source='main'] - The source branch.
+   * @param {string} [options.version] - The version number.
+   * @returns {Promise<any>} - The response data.
+   */
+  createBranch (branch, { message, source = 'main', version } = {}) {
+    return this.request('/branch', {
+      method: 'POST',
+      body: JSON.stringify({ branch, message, source, version })
+    })
+  }
+
+  /**
+   * Edit an existing branch. (For now only supports branch renaming)
+   * @param {string} branch - The current name of the branch to edit.
+   * @param {object} [options={}] - The branch edit options.
+   * @param {string} [options.name] - New name for the branch
+   * @returns {Promise<any>} - The response data.
+   */
+  editBranch (branch, { name } = {}) {
+    return this.request('/branch', {
+      method: 'PATCH',
+      body: JSON.stringify({ branch, name })
+    })
+  }
+
+  /**
+   * Delete an existing branch.
+   * @param {string} branch - The name of the branch to delete.
+   * @returns {Promise<any>} - The response data.
+   */
+  deleteBranch (branch) {
+    return this.request('/branch', {
+      method: 'DELETE',
+      body: JSON.stringify({ branch })
+    })
+  }
+
+  /**
+   * Merges a branch into the target branch.
+   * @param {string} target - The target branch.
+   * @param {object} [options={}] - The merge options.
+   * @param {string} [options.message] - A message describing the merge.
+   * @param {string} [options.source='main'] - The source branch.
+   * @param {string} [options.type='patch'] - The type of merge.
+   * @param {string} [options.version] - The version number.
+   * @param {boolean} [options.commit='false'] - Whether to commit the merge.
+   * @param {Array} [options.changes] - The changes to apply during the merge.
+   * @returns {Promise<any>} - The response data.
+   */
+  mergeBranch (
+    target,
+    {
+      message,
+      source = 'main',
+      type = 'patch',
+      version,
+      commit = 'false',
+      changes
+    } = {}
+  ) {
+    return this.request('/merge', {
+      method: 'POST',
+      body: JSON.stringify({
+        target,
+        source,
+        message,
+        type,
+        version,
+        commit,
+        changes
+      })
+    })
+  }
+
+  /**
+   * Restores an older version of the project.
+   * @param {string} version - The version number to restore.
+   * @param {object} [options={}] - The restore options.
+   * @param {string} [options.branch='main'] - The branch name.
+   * @param {string} [options.type='patch'] - The type of restore.
+   * @param {string} [options.message] - A message describing the restore.
+   * @returns {Promise<any>} - The response data.
+   */
+  restoreVersion (version, { branch = 'main', type = 'patch', message } = {}) {
+    return this.request('/restore', {
+      method: 'POST',
+      body: JSON.stringify({ branch, version, type, message })
+    })
+  }
+
+  /**
+   * Publishes an existing version of the project.
+   * @param {string} version - The version ID/number to publish.
+   * @param {object} [options={}] - The publishing options.
+   * @param {string} [options.branch='main'] - The branch name. (Only if version number is provided)
+   * @returns {Promise<any>} - The response data.
+   */
+  publishVersion (version, { branch = 'main' } = {}) {
+    return this.request('/publish', {
+      method: 'POST',
+      body: JSON.stringify({ version })
+    })
+  }
+
+  /**
+   * Retrieves all changes after a specific version.
+   * @param {object} [options={}] - The changes options.
+   * @param {string} [options.versionId] - The version ID to publish.
+   * @param {string} [options.versionValue] - The version ID to publish. (alternative to versionId)
+   * @param {string} [options.branch] - The branch to publish (Only in combination to versionValue)
+   * @returns {Promise<any>} - The changes data.
+   */
+  getChanges ({ versionId, versionValue, branch } = {}) {
+    return this.request(
+      '/changes?' +
+        new URLSearchParams({
+          ...(versionId ? { versionId } : {}),
+          ...(versionValue ? { versionValue } : {}),
+          ...(branch ? { branch } : {})
+        }).toString(),
+      {}
+    )
+  }
+}
+
+export default {
+  /**
+   * Creates a new SymstoryClient instance.
+   * @param {string} appKey - The application key.
+   * @param {object} options - The options for the client.
+   * @returns {SymstoryClient} - The SymstoryClient instance.
+   */
+  create: (appKey, options) => new SymstoryClient(appKey, options),
+
+  /**
+   * Initializes the Symstory client.
+   * @param {string} appKey - The application key.
+   * @param {object} options - The options for the client.
+   * @returns {SymstoryClient} - The initialized SymstoryClient instance.
+   */
+  init (appKey, options) {
+    this.client = this.create(appKey, options)
+    return this
+  }
+}

package/src/utils/validation.js

@@ -185,6 +185,9 @@ export const validateParams = {
     if (!data.key) {
       throw new Error('Data must contain a key property')
     }
+    if (!data.value) {
+      throw new Error('Data must contain a value property')
+    }
 
     // Check key against reserved keywords for code-related types
     if (CODE_TYPES.includes(type)) {

package/dist/cjs/services/AdminService.js

@@ -1,351 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var AdminService_exports = {};
-__export(AdminService_exports, {
-  AdminService: () => AdminService
-});
-module.exports = __toCommonJS(AdminService_exports);
-var import_BaseService = require("./BaseService.js");
-class AdminService extends import_BaseService.BaseService {
-  // ==================== ADMIN METHODS ====================
-  /**
-   * Get admin users list with comprehensive filtering and search capabilities
-   * Requires admin or super_admin global role
-   */
-  async getAdminUsers(params = {}) {
-    this._requireReady("getAdminUsers");
-    const {
-      emails,
-      ids,
-      query,
-      status,
-      page = 1,
-      limit = 50,
-      sort = { field: "createdAt", order: "desc" }
-    } = params;
-    const queryParams = new URLSearchParams();
-    if (emails) {
-      queryParams.append("emails", emails);
-    }
-    if (ids) {
-      queryParams.append("ids", ids);
-    }
-    if (query) {
-      queryParams.append("query", query);
-    }
-    if (status) {
-      queryParams.append("status", status);
-    }
-    if (page) {
-      queryParams.append("page", page.toString());
-    }
-    if (limit) {
-      queryParams.append("limit", limit.toString());
-    }
-    if (sort && sort.field) {
-      queryParams.append("sort[field]", sort.field);
-      queryParams.append("sort[order]", sort.order || "desc");
-    }
-    const queryString = queryParams.toString();
-    const url = `/users/admin/users${queryString ? `?${queryString}` : ""}`;
-    try {
-      const response = await this._request(url, {
-        method: "GET",
-        methodName: "getAdminUsers"
-      });
-      if (response.success) {
-        return response.data;
-      }
-      throw new Error(response.message);
-    } catch (error) {
-      throw new Error(`Failed to get admin users: ${error.message}`, { cause: error });
-    }
-  }
-  /**
-   * Assign projects to a specific user
-   * Requires admin or super_admin global role
-   */
-  async assignProjectsToUser(userId, options = {}) {
-    this._requireReady("assignProjectsToUser");
-    if (!userId) {
-      throw new Error("User ID is required");
-    }
-    const { projectIds, role = "guest" } = options;
-    const requestBody = {
-      userId,
-      role
-    };
-    if (projectIds && Array.isArray(projectIds)) {
-      requestBody.projectIds = projectIds;
-    }
-    try {
-      const response = await this._request("/assign-projects", {
-        method: "POST",
-        body: JSON.stringify(requestBody),
-        methodName: "assignProjectsToUser"
-      });
-      if (response.success) {
-        return response.data;
-      }
-      throw new Error(response.message);
-    } catch (error) {
-      throw new Error(`Failed to assign projects to user: ${error.message}`, { cause: error });
-    }
-  }
-  /**
-   * Update user information (admin only)
-   */
-  async updateUser(userId, userData) {
-    var _a;
-    this._requireReady("updateUser");
-    if (!userId) {
-      throw new Error("User ID is required");
-    }
-    if (!userData || typeof userData !== "object" || Object.keys(userData).length === 0) {
-      throw new Error("userData must be a non-empty object");
-    }
-    try {
-      const response = await this._request(`/users/${userId}`, {
-        method: "PATCH",
-        body: JSON.stringify(userData),
-        methodName: "updateUser"
-      });
-      if (response.success) {
-        return response.data;
-      }
-      throw new Error(response.message);
-    } catch (error) {
-      if ((_a = error.message) == null ? void 0 : _a.includes("Duplicate")) {
-        throw new Error("Username already exists");
-      }
-      throw new Error(`Failed to update user: ${error.message}`, { cause: error });
-    }
-  }
-  // ==================== ADMIN HELPER METHODS ====================
-  /**
-   * Helper method for admin users search
-   */
-  async searchAdminUsers(searchQuery, options = {}) {
-    return await this.getAdminUsers({
-      query: searchQuery,
-      ...options
-    });
-  }
-  /**
-   * Helper method to get admin users by email list
-   */
-  async getAdminUsersByEmails(emails, options = {}) {
-    const emailList = Array.isArray(emails) ? emails.join(",") : emails;
-    return await this.getAdminUsers({
-      emails: emailList,
-      ...options
-    });
-  }
-  /**
-   * Helper method to get admin users by ID list
-   */
-  async getAdminUsersByIds(ids, options = {}) {
-    const idList = Array.isArray(ids) ? ids.join(",") : ids;
-    return await this.getAdminUsers({
-      ids: idList,
-      ...options
-    });
-  }
-  /**
-   * Helper method to assign specific projects to a user with a specific role
-   */
-  async assignSpecificProjectsToUser(userId, projectIds, role = "guest") {
-    if (!Array.isArray(projectIds) || projectIds.length === 0) {
-      throw new Error("Project IDs must be a non-empty array");
-    }
-    return await this.assignProjectsToUser(userId, {
-      projectIds,
-      role
-    });
-  }
-  /**
-   * Helper method to assign all projects to a user with a specific role
-   */
-  async assignAllProjectsToUser(userId, role = "guest") {
-    return await this.assignProjectsToUser(userId, {
-      role
-    });
-  }
-  /**
-   * Helper method to validate user data for updates
-   */
-  validateUserData(userData) {
-    const errors = [];
-    if (!userData || typeof userData !== "object") {
-      errors.push("User data must be an object");
-      return { isValid: false, errors };
-    }
-    if (userData.email && typeof userData.email !== "string") {
-      errors.push("Email must be a string");
-    } else if (userData.email && !this._isValidEmail(userData.email)) {
-      errors.push("Email must be a valid email address");
-    }
-    if (userData.username && typeof userData.username !== "string") {
-      errors.push("Username must be a string");
-    } else if (userData.username && userData.username.length < 3) {
-      errors.push("Username must be at least 3 characters long");
-    }
-    if (userData.role && !["admin", "user", "guest"].includes(userData.role)) {
-      errors.push("Role must be one of: admin, user, guest");
-    }
-    if (userData.status && !["active", "inactive", "suspended"].includes(userData.status)) {
-      errors.push("Status must be one of: active, inactive, suspended");
-    }
-    return {
-      isValid: errors.length === 0,
-      errors
-    };
-  }
-  /**
-   * Helper method to update user with validation
-   */
-  async updateUserWithValidation(userId, userData) {
-    const validation = this.validateUserData(userData);
-    if (!validation.isValid) {
-      throw new Error(`Validation failed: ${validation.errors.join(", ")}`);
-    }
-    return await this.updateUser(userId, userData);
-  }
-  /**
-   * Helper method to get user statistics
-   */
-  async getUserStats() {
-    try {
-      const users = await this.getAdminUsers({ limit: 1e3 });
-      const stats = {
-        total: users.length,
-        active: 0,
-        inactive: 0,
-        suspended: 0,
-        admins: 0,
-        users: 0,
-        guests: 0
-      };
-      users.forEach((user) => {
-        if (user.status === "active") {
-          stats.active++;
-        }
-        if (user.status === "inactive") {
-          stats.inactive++;
-        }
-        if (user.status === "suspended") {
-          stats.suspended++;
-        }
-        if (user.role === "admin") {
-          stats.admins++;
-        }
-        if (user.role === "user") {
-          stats.users++;
-        }
-        if (user.role === "guest") {
-          stats.guests++;
-        }
-      });
-      return stats;
-    } catch (error) {
-      throw new Error(`Failed to get user stats: ${error.message}`, { cause: error });
-    }
-  }
-  /**
-   * Helper method to bulk update users
-   */
-  async bulkUpdateUsers(userUpdates) {
-    if (!Array.isArray(userUpdates) || userUpdates.length === 0) {
-      throw new Error("User updates must be a non-empty array");
-    }
-    const updatePromises = userUpdates.map(async (update) => {
-      try {
-        const result = await this.updateUser(update.userId, update.userData);
-        return {
-          userId: update.userId,
-          success: true,
-          data: result
-        };
-      } catch (error) {
-        return {
-          userId: update.userId,
-          success: false,
-          error: error.message
-        };
-      }
-    });
-    const results = await Promise.all(updatePromises);
-    return {
-      total: results.length,
-      successful: results.filter((r) => r.success).length,
-      failed: results.filter((r) => !r.success).length,
-      results
-    };
-  }
-  /**
-   * Helper method to get users by role
-   */
-  async getUsersByRole(role, options = {}) {
-    const users = await this.getAdminUsers(options);
-    return users.filter((user) => user.role === role);
-  }
-  /**
-   * Helper method to get users by status
-   */
-  async getUsersByStatus(status, options = {}) {
-    const users = await this.getAdminUsers(options);
-    return users.filter((user) => user.status === status);
-  }
-  /**
-   * Helper method to activate a user
-   */
-  async activateUser(userId) {
-    return await this.updateUser(userId, { status: "active" });
-  }
-  /**
-   * Helper method to deactivate a user
-   */
-  async deactivateUser(userId) {
-    return await this.updateUser(userId, { status: "inactive" });
-  }
-  /**
-   * Helper method to suspend a user
-   */
-  async suspendUser(userId) {
-    return await this.updateUser(userId, { status: "suspended" });
-  }
-  /**
-   * Helper method to promote user to admin
-   */
-  async promoteToAdmin(userId) {
-    return await this.updateUser(userId, { role: "admin" });
-  }
-  /**
-   * Helper method to demote user from admin
-   */
-  async demoteFromAdmin(userId) {
-    return await this.updateUser(userId, { role: "user" });
-  }
-  /**
-   * Private helper to validate email format
-   */
-  _isValidEmail(email) {
-    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/u;
-    return emailRegex.test(email);
-  }
-}