@symbo.ls/sdk 2.34.35 → 3.1.2

package/dist/node/utils/services.js

@@ -1,310 +1,112 @@
 const SERVICE_METHODS = {
-  hasPermission: "auth",
-  hasGlobalPermission: "auth",
-  // Collab service methods
-  connect: "collab",
-  disconnect: "collab",
-  isConnected: "collab",
-  updateData: "collab",
-  addItem: "collab",
-  addMultipleItems: "collab",
-  updateItem: "collab",
-  deleteItem: "collab",
-  undo: "collab",
-  redo: "collab",
-  checkpoint: "collab",
-  // Realtime collaboration helper methods
-  sendCursor: "collab",
-  sendPresence: "collab",
-  toggleLive: "collab",
-  // Core service methods (new - replaces most based/auth functionality)
-  // Auth methods
-  getStoredAuthState: "auth",
-  getAuthToken: "auth",
-  register: "auth",
+  // Auth service methods (legacy - keeping for backward compatibility)
+  auth: "auth",
   login: "auth",
-  logout: "auth",
-  refreshToken: "auth",
+  register: "auth",
   googleAuth: "auth",
   googleAuthCallback: "auth",
   githubAuth: "auth",
-  requestPasswordReset: "auth",
-  confirmPasswordReset: "auth",
   confirmRegistration: "auth",
-  requestPasswordChange: "auth",
-  confirmPasswordChange: "auth",
-  getMe: "auth",
-  getTokenDebugInfo: "auth",
-  getMyProjectRoleByKey: "auth",
-  getProjectRoleWithFallback: "auth",
-  getProjectRoleByKeyWithFallback: "auth",
-  // User methods
-  getUserProfile: "auth",
-  updateUserProfile: "auth",
-  getUserProjects: "auth",
-  getUser: "auth",
-  getUserByEmail: "auth",
-  // Project methods (moved to project service)
-  createProject: "project",
-  getProjects: "project",
-  getProject: "project",
-  getProjectByKey: "project",
-  getProjectDataByKey: "project",
-  getPublicProject: "project",
-  listPublicProjects: "project",
-  listProjects: "project",
-  updateProject: "project",
-  updateProjectComponents: "project",
-  updateProjectSettings: "project",
-  updateProjectName: "project",
-  updateProjectPackage: "project",
-  duplicateProject: "project",
-  removeProject: "project",
-  checkProjectKeyAvailability: "project",
-  getProjectRolePermissionsConfig: "project",
-  updateProjectRolePermissionsConfig: "project",
-  listEnvironments: "project",
-  activateMultipleEnvironments: "project",
-  upsertEnvironment: "project",
-  updateEnvironment: "project",
-  publishToEnvironment: "project",
-  deleteEnvironment: "project",
-  promoteEnvironment: "project",
-  // Project member methods (moved to project service)
-  getProjectMembers: "project",
-  inviteMember: "project",
-  acceptInvite: "project",
-  createMagicInviteLink: "project",
-  updateMemberRole: "project",
-  removeMember: "project",
-  // Project library methods (moved to project service)
-  getAvailableLibraries: "project",
-  getProjectLibraries: "project",
-  addProjectLibraries: "project",
-  removeProjectLibraries: "project",
-  // Project data methods (moved to project service)
-  applyProjectChanges: "project",
-  getProjectData: "project",
-  getProjectVersions: "project",
-  restoreProjectVersion: "project",
-  updateProjectItem: "project",
-  deleteProjectItem: "project",
-  setProjectValue: "project",
-  addProjectItems: "project",
-  getProjectItemByPath: "project",
-  setProjectAccess: "project",
-  setProjectVisibility: "project",
-  // Favorite project methods (moved to project service)
-  getFavoriteProjects: "project",
-  addFavoriteProject: "project",
-  removeFavoriteProject: "project",
-  // Recent project methods (moved to project service)
-  getRecentProjects: "project",
-  // Plan methods (moved to plan service)
-  getPlans: "plan",
-  getPlan: "plan",
-  getAdminPlans: "plan",
-  createPlan: "plan",
-  updatePlan: "plan",
-  deletePlan: "plan",
-  initializePlans: "plan",
-  getPlansWithValidation: "plan",
-  getPlanWithValidation: "plan",
-  createPlanWithValidation: "plan",
-  updatePlanWithValidation: "plan",
-  getActivePlans: "plan",
-  getPlansByPriceRange: "plan",
-  getPlanByKey: "plan",
-  getPlansWithPricing: "plan",
-  // Subscription methods (moved to subscription service)
-  createSubscription: "subscription",
-  getProjectStatus: "subscription",
-  getUsage: "subscription",
-  cancelSubscription: "subscription",
-  listInvoices: "subscription",
-  getPortalUrl: "subscription",
-  createSubscriptionWithValidation: "subscription",
-  hasActiveSubscription: "subscription",
-  getProjectSubscription: "subscription",
-  getProjectUsage: "subscription",
-  getInvoicesWithPagination: "subscription",
-  isSubscriptionActive: "subscription",
-  getSubscriptionLimits: "subscription",
-  changeSubscription: "subscription",
-  downgrade: "subscription",
-  changeSubscriptionWithValidation: "subscription",
-  downgradeWithValidation: "subscription",
-  // File methods (moved to file service)
-  uploadFile: "file",
-  updateProjectIcon: "file",
-  uploadFileWithValidation: "file",
-  uploadImage: "file",
-  uploadDocument: "file",
-  getFileUrl: "file",
-  validateFile: "file",
-  createFileFormData: "file",
-  uploadMultipleFiles: "file",
-  // Payment methods (Use subscription service instead)
-  checkout: "payment",
-  getSubscriptionStatus: "payment",
-  checkoutWithValidation: "payment",
-  getSubscriptionStatusWithValidation: "payment",
-  getSubscriptionDetails: "payment",
-  checkoutForPlan: "payment",
-  checkoutForTeam: "payment",
-  validateSubscriptionStatus: "payment",
-  formatSubscriptionAmount: "payment",
-  getSubscriptionSummary: "payment",
-  // DNS methods (moved to dns service)
-  createDnsRecord: "dns",
-  getDnsRecord: "dns",
-  removeDnsRecord: "dns",
-  getCustomHost: "dns",
-  addProjectCustomDomains: "dns",
-  validateDomain: "dns",
-  createDnsRecordWithValidation: "dns",
-  getDnsRecordWithValidation: "dns",
-  removeDnsRecordWithValidation: "dns",
-  addProjectCustomDomainsWithValidation: "dns",
-  isDomainAvailable: "dns",
-  getDomainStatus: "dns",
-  verifyDomainOwnership: "dns",
-  getProjectDomains: "dns",
-  removeProjectCustomDomain: "dns",
-  formatDomain: "dns",
-  extractDomainFromUrl: "dns",
-  // Branch Management methods (moved to branch service)
-  listBranches: "branch",
-  createBranch: "branch",
-  deleteBranch: "branch",
-  renameBranch: "branch",
-  getBranchChanges: "branch",
-  mergeBranch: "branch",
-  resetBranch: "branch",
-  publishVersion: "branch",
-  createBranchWithValidation: "branch",
-  branchExists: "branch",
-  previewMerge: "branch",
-  commitMerge: "branch",
-  createFeatureBranch: "branch",
-  createHotfixBranch: "branch",
-  getBranchStatus: "branch",
-  deleteBranchSafely: "branch",
-  getBranchesWithStatus: "branch",
-  validateBranchName: "branch",
-  sanitizeBranchName: "branch",
-  // Pull Request methods (moved to pullRequest service)
-  createPullRequest: "pullRequest",
-  listPullRequests: "pullRequest",
-  getPullRequest: "pullRequest",
-  reviewPullRequest: "pullRequest",
-  addPullRequestComment: "pullRequest",
-  mergePullRequest: "pullRequest",
-  getPullRequestDiff: "pullRequest",
-  createPullRequestWithValidation: "pullRequest",
-  approvePullRequest: "pullRequest",
-  requestPullRequestChanges: "pullRequest",
-  getOpenPullRequests: "pullRequest",
-  getClosedPullRequests: "pullRequest",
-  getMergedPullRequests: "pullRequest",
-  isPullRequestMergeable: "pullRequest",
-  getPullRequestStatusSummary: "pullRequest",
-  validatePullRequestData: "pullRequest",
-  validateReviewData: "pullRequest",
-  getPullRequestStats: "pullRequest",
-  closePullRequest: "pullRequest",
-  reopenPullRequest: "pullRequest",
-  // Admin methods (moved to admin service)
-  getAdminUsers: "admin",
-  assignProjectsToUser: "admin",
-  updateUser: "admin",
-  searchAdminUsers: "admin",
-  getAdminUsersByEmails: "admin",
-  getAdminUsersByIds: "admin",
-  assignSpecificProjectsToUser: "admin",
-  assignAllProjectsToUser: "admin",
-  validateUserData: "admin",
-  updateUserWithValidation: "admin",
-  getUserStats: "admin",
-  bulkUpdateUsers: "admin",
-  getUsersByRole: "admin",
-  getUsersByStatus: "admin",
-  activateUser: "admin",
-  deactivateUser: "admin",
-  suspendUser: "admin",
-  promoteToAdmin: "admin",
-  demoteFromAdmin: "admin",
-  // Screenshot methods
-  createScreenshotProject: "screenshot",
-  getProjectScreenshots: "screenshot",
-  reprocessProjectScreenshots: "screenshot",
-  recreateProjectScreenshots: "screenshot",
-  deleteProjectScreenshots: "screenshot",
-  getThumbnailCandidate: "screenshot",
-  updateProjectThumbnail: "screenshot",
-  getPageScreenshot: "screenshot",
-  getComponentScreenshot: "screenshot",
-  getScreenshotByKey: "screenshot",
-  getQueueStatistics: "screenshot",
-  refreshThumbnail: "screenshot",
-  // Tracking methods
-  configureTracking: "tracking",
-  trackEvent: "tracking",
-  trackError: "tracking",
-  captureException: "tracking",
-  logMessage: "tracking",
-  logDebug: "tracking",
-  logInfo: "tracking",
-  logWarning: "tracking",
-  logWarn: "tracking",
-  logErrorMessage: "tracking",
-  logError: "tracking",
-  addBreadcrumb: "tracking",
-  trackMeasurement: "tracking",
-  trackView: "tracking",
-  setUser: "tracking",
-  clearUser: "tracking",
-  setSession: "tracking",
-  clearSession: "tracking",
-  setGlobalAttributes: "tracking",
-  setGlobalAttribute: "tracking",
-  removeGlobalAttribute: "tracking",
-  flushQueue: "tracking",
-  getClient: "tracking",
-  isEnabled: "tracking",
-  isInitialized: "tracking",
-  // Waitlist methods
-  joinWaitlist: "waitlist",
-  listWaitlistEntries: "waitlist",
-  updateWaitlistEntry: "waitlist",
-  inviteWaitlistEntry: "waitlist",
-  // Metrics methods
-  getContributions: "metrics",
-  // Integration methods
-  integrationWhoami: "integration",
-  listIntegrations: "integration",
-  createIntegration: "integration",
-  updateIntegration: "integration",
-  createIntegrationApiKey: "integration",
-  listIntegrationApiKeys: "integration",
-  revokeIntegrationApiKey: "integration",
-  createIntegrationWebhook: "integration",
-  listIntegrationWebhooks: "integration",
-  updateIntegrationWebhook: "integration",
-  deleteIntegrationWebhook: "integration",
-  listIntegrationWebhookDeliveries: "integration",
-  replayIntegrationWebhookDelivery: "integration",
-  listGitHubConnectors: "integration",
-  createGitHubConnector: "integration",
-  updateGitHubConnector: "integration",
-  deleteGitHubConnector: "integration",
-  // Feature flag methods (system-level + experiments)
-  getFeatureFlags: "featureFlag",
-  getFeatureFlag: "featureFlag",
-  getAdminFeatureFlags: "featureFlag",
-  createFeatureFlag: "featureFlag",
-  updateFeatureFlag: "featureFlag",
-  archiveFeatureFlag: "featureFlag"
+  logout: "auth",
+  updateUserRole: "auth",
+  hasPermission: "auth",
+  hasGlobalPermission: "auth",
+  getProjectMembers: "auth",
+  inviteMember: "auth",
+  acceptInvite: "auth",
+  updateMemberRole: "auth",
+  removeMember: "auth",
+  updateProjectTier: "auth",
+  subscribeToAuthChanges: "auth",
+  getStoredAuthState: "core",
+  // AI service methods
+  prompt: "ai",
+  // Based service methods
+  query: "based",
+  setProject: "based",
+  setUser: "based",
+  setUserForced: "based",
+  subscribe: "based",
+  call: "based",
+  getProject: "based",
+  getProjectByKey: "based",
+  createProject: "based",
+  fetchUser: "based",
+  fetchProject: "based",
+  setBucket: "based",
+  getUser: "based",
+  getUserByEmail: "based",
+  setProjectDomains: "based",
+  checkProjectKeyAvailability: "based",
+  removeProject: "based",
+  getAvailableLibraries: "based",
+  addProjectLibraries: "based",
+  removeProjectLibraries: "based",
+  getProjectLibraries: "based",
+  checkout: "based",
+  uploadFile: "based",
+  updateProjectIcon: "based",
+  updateProject: "based",
+  updateProjectSettings: "based",
+  updateProjectComponents: "based",
+  updateProjectName: "based",
+  updateProjectPackage: "based",
+  createDnsRecord: "based",
+  getDnsRecord: "based",
+  removeDnsRecord: "based",
+  createStorageBucket: "based",
+  getStorageBucket: "based",
+  removeStorageBucket: "based",
+  requestPasswordChange: "based",
+  confirmPasswordChange: "based",
+  updateUserProfile: "based",
+  duplicateProject: "based",
+  listPlans: "based",
+  subscribeToPlan: "based",
+  getSubscriptionDetails: "based",
+  checkSubscriptionStatus: "based",
+  upgradeSubscription: "based",
+  downgradeSubscription: "based",
+  cancelSubscription: "based",
+  reactivateSubscription: "based",
+  generateInvoice: "based",
+  getUsageReport: "based",
+  inviteAccountOwner: "based",
+  acceptOwnerInvitation: "based",
+  removeAccountOwner: "based",
+  checkResourceLimit: "based",
+  checkFeatureAccess: "based",
+  getUserFeatures: "based",
+  getAvailableFeatures: "based",
+  listFeatureFlags: "based",
+  updateFeatureFlag: "based",
+  removeFeatureFlag: "based",
+  batchUpdateFeatureFlags: "based",
+  updatePlanDetails: "based",
+  updatePlanStatus: "based",
+  // Symstory service methods
+  set: "symstory",
+  getData: "symstory",
+  updateData: "symstory",
+  getBranches: "symstory",
+  editBranch: "symstory",
+  restoreVersion: "symstory",
+  getItem: "symstory",
+  addItem: "symstory",
+  addMultipleItems: "symstory",
+  updateItem: "symstory",
+  deleteItem: "symstory",
+  switchVersion: "symstory",
+  switchBranch: "symstory",
+  undo: "symstory",
+  redo: "symstory",
+  publish: "symstory",
+  getChanges: "symstory",
+  // Socket service methods
+  send: "socket",
+  subscribeChannel: "socket",
+  connect: "socket",
+  reconnect: "socket"
 };
 export {
   SERVICE_METHODS

package/dist/node/utils/symstoryClient.js

@@ -0,0 +1,230 @@
+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(),
+      {}
+    );
+  }
+}
+var symstoryClient_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;
+  }
+};
+export {
+  symstoryClient_default as default
+};

package/dist/node/utils/validation.js

@@ -152,6 +152,9 @@ 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");
+    }
     if (CODE_TYPES.includes(type)) {
       if (RESERVED_KEYWORDS.includes(data.key)) {
         throw new Error(