@symbo.ls/sdk 2.34.35 → 3.1.2

package/dist/esm/utils/symstoryClient.js

@@ -0,0 +1,370 @@
+// src/config/environment.js
+import { isDevelopment } from "@domql/utils";
+var CONFIG = {
+  // Common defaults for all environments
+  common: {
+    // NOTE: Google client id for google auth, need to configure URLs for each environment in Google console
+    googleClientId: "686286207466-bvd2fqs31rlm64fgich7rtpnc8ns2tqg.apps.googleusercontent.com",
+    // Feature toggles that apply across all environments by default
+    features: {
+      newUserOnboarding: true,
+      betaFeatures: false
+    }
+  },
+  // Environment-specific configurations
+  local: {
+    // local
+    baseUrl: "http://localhost:8080",
+    // For symstory api
+    socketUrl: "http://localhost:8080",
+    // For socket api
+    routerUrl: "http://localhost:8080",
+    // For router api
+    apiUrl: "http://localhost:8080",
+    // For server api
+    basedEnv: "development",
+    // For based api
+    basedProject: "platform-v2-sm",
+    // For based api
+    basedOrg: "symbols",
+    // For based api
+    githubClientId: "Ov23liHxyWFBxS8f1gnF",
+    // For github api
+    // Environment-specific feature toggles (override common)
+    features: {
+      betaFeatures: true
+      // Enable beta features in local dev
+    }
+  },
+  development: {
+    baseUrl: "https://dev.api.symbols.app",
+    socketUrl: "https://dev.api.symbols.app",
+    routerUrl: "https://dev.api.symbols.app",
+    apiUrl: "https://dev.api.symbols.app",
+    basedEnv: "development",
+    basedProject: "platform-v2-sm",
+    basedOrg: "symbols",
+    githubClientId: "Ov23liHxyWFBxS8f1gnF"
+  },
+  testing: {
+    baseUrl: "https://test.api.symbols.app",
+    socketUrl: "https://test.api.symbols.app",
+    routerUrl: "https://test.api.symbols.app",
+    apiUrl: "https://test.api.symbols.app",
+    basedEnv: "testing",
+    basedProject: "platform-v2-sm",
+    basedOrg: "symbols",
+    githubClientId: "Ov23liHxyWFBxS8f1gnF"
+  },
+  staging: {
+    baseUrl: "https://staging.api.symbols.app",
+    socketUrl: "https://staging.api.symbols.app",
+    routerUrl: "https://staging.api.symbols.app",
+    apiUrl: "https://staging.api.symbols.app",
+    basedEnv: "staging",
+    basedProject: "platform-v2-sm",
+    basedOrg: "symbols",
+    githubClientId: "Ov23ligwZDQVD0VfuWNa"
+  },
+  production: {
+    baseUrl: "https://api.symbols.app",
+    socketUrl: "https://api.symbols.app",
+    routerUrl: "https://api.symbols.app",
+    apiUrl: "https://api.symbols.app",
+    basedEnv: "production",
+    basedProject: "platform-v2-sm",
+    basedOrg: "symbols",
+    githubClientId: "Ov23liFAlOEIXtX3dBtR"
+  }
+};
+var getEnvironment = () => {
+  const env = process.env.SYMBOLS_APP_ENV || process.env.NODE_ENV;
+  if (!CONFIG[env]) {
+    throw new Error(`Unknown environment "${env}"`);
+  }
+  return env;
+};
+var getConfig = () => {
+  try {
+    const env = getEnvironment();
+    const envConfig = { ...CONFIG.common, ...CONFIG[env] };
+    const finalConfig = {
+      ...envConfig,
+      baseUrl: process.env.SYMBOLS_APP_BASE_URL || envConfig.baseUrl,
+      socketUrl: process.env.SYMBOLS_APP_SOCKET_URL || envConfig.socketUrl,
+      routerUrl: process.env.SYMBOLS_APP_ROUTER_URL || envConfig.routerUrl,
+      apiUrl: process.env.SYMBOLS_APP_API_URL || envConfig.apiUrl,
+      basedEnv: process.env.SYMBOLS_APP_BASED_ENV || envConfig.basedEnv,
+      basedProject: process.env.SYMBOLS_APP_BASED_PROJECT || envConfig.basedProject,
+      basedOrg: process.env.SYMBOLS_APP_BASED_ORG || envConfig.basedOrg,
+      githubClientId: process.env.SYMBOLS_APP_GITHUB_CLIENT_ID || envConfig.githubClientId,
+      isDevelopment: isDevelopment(env),
+      isTesting: env === "testing",
+      isStaging: env === "staging",
+      isProduction: env === "production"
+      // Store all environment variables for potential future use
+    };
+    const requiredFields = [
+      "baseUrl",
+      "socketUrl",
+      "apiUrl",
+      "basedEnv",
+      "basedProject",
+      "basedOrg",
+      "githubClientId",
+      "googleClientId"
+    ];
+    const missingFields = requiredFields.filter((field) => !finalConfig[field]);
+    if (missingFields.length > 0) {
+      console.error(
+        `Missing required configuration: ${missingFields.join(", ")}`
+      );
+    }
+    if (finalConfig.isDevelopment) {
+      console.log(
+        "environment in SDK:",
+        env || process.env.NODE_ENV || process.env.NODE_ENV
+      );
+      console.log(finalConfig);
+    }
+    return finalConfig;
+  } catch (error) {
+    console.error("Failed to load environment configuration:", error);
+    return {
+      ...CONFIG.development
+    };
+  }
+};
+var environment_default = getConfig();
+
+// src/utils/symstoryClient.js
+var DEFAULT_OPTIONS = {
+  baseUrl: environment_default.baseUrl
+};
+var SymstoryClient = class {
+  /**
+   * 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
+};
+// @preserve-env

package/dist/esm/utils/validation.js

@@ -219,12 +219,12 @@ var skipWhiteSpace = /(?:\s|\/\/.*|\/\*[^]*?\*\/)*/g;
 var ref = Object.prototype;
 var hasOwnProperty = ref.hasOwnProperty;
 var toString = ref.toString;
-var hasOwn = Object.hasOwn || (function(obj, propName) {
+var hasOwn = Object.hasOwn || function(obj, propName) {
   return hasOwnProperty.call(obj, propName);
-});
-var isArray = Array.isArray || (function(obj) {
+};
+var isArray = Array.isArray || function(obj) {
   return toString.call(obj) === "[object Array]";
-});
+};
 var regexpCache = /* @__PURE__ */ Object.create(null);
 function wordsRegexp(words) {
   return regexpCache[words] || (regexpCache[words] = new RegExp("^(?:" + words.replace(/ /g, "|") + ")$"));
@@ -6059,6 +6059,9 @@ var validateParams = {
     if (!data2.key) {
       throw new Error("Data must contain a key property");
     }
+    if (!data2.value) {
+      throw new Error("Data must contain a value property");
+    }
     if (CODE_TYPES.includes(type)) {
       if (RESERVED_KEYWORDS.includes(data2.key)) {
         throw new Error(

package/dist/node/config/environment.js

@@ -7,16 +7,18 @@ const CONFIG = {
     // Feature toggles that apply across all environments by default
     features: {
       newUserOnboarding: true,
-      betaFeatures: false,
-      // Tracking is enabled by default unless overridden per environment
-      trackingEnabled: true
+      betaFeatures: false
     }
   },
   // Environment-specific configurations
   local: {
     // local
+    baseUrl: "http://localhost:8080",
+    // For symstory api
     socketUrl: "http://localhost:8080",
     // For socket api
+    routerUrl: "http://localhost:8080",
+    // For router api
     apiUrl: "http://localhost:8080",
     // For server api
     basedEnv: "development",
@@ -25,115 +27,53 @@ const CONFIG = {
     // For based api
     basedOrg: "symbols",
     // For based api
-    githubClientId: "Ov23liAFrsR0StbAO6PO",
+    githubClientId: "Ov23liHxyWFBxS8f1gnF",
     // For github api
-    grafanaUrl: "",
-    // For grafana tracing
-    grafanaAppName: "Symbols Localhost",
     // Environment-specific feature toggles (override common)
     features: {
-      // Disable tracking by default on localhost/dev machines
-      trackingEnabled: false,
+      betaFeatures: true
       // Enable beta features in local dev
-      betaFeatures: true,
-      // Preserve common defaults explicitly for local
-      newUserOnboarding: true
-    },
-    typesenseCollectionName: "docs",
-    typesenseApiKey: "vZya3L2zpq8L6iI5WWMUZJZABvT63VDb",
-    typesenseHost: "localhost",
-    typesensePort: "8108",
-    typesenseProtocol: "http"
+    }
   },
   development: {
+    baseUrl: "https://dev.api.symbols.app",
     socketUrl: "https://dev.api.symbols.app",
+    routerUrl: "https://dev.api.symbols.app",
     apiUrl: "https://dev.api.symbols.app",
-    githubClientId: "Ov23liHxyWFBxS8f1gnF",
-    grafanaUrl: "https://faro-collector-prod-us-east-0.grafana.net/collect/7a3ba473cee2025c68513667024316b8",
-    // For grafana tracing
-    grafanaAppName: "Symbols Dev",
-    typesenseCollectionName: "docs",
-    typesenseApiKey: "awmcVpbWqZi9IUgmvslp1C5LKDU8tMjA",
-    typesenseHost: "tl2qpnwxev4cjm36p-1.a1.typesense.net",
-    typesensePort: "443",
-    typesenseProtocol: "https"
+    basedEnv: "development",
+    basedProject: "platform-v2-sm",
+    basedOrg: "symbols",
+    githubClientId: "Ov23liHxyWFBxS8f1gnF"
   },
   testing: {
+    baseUrl: "https://test.api.symbols.app",
     socketUrl: "https://test.api.symbols.app",
+    routerUrl: "https://test.api.symbols.app",
     apiUrl: "https://test.api.symbols.app",
     basedEnv: "testing",
     basedProject: "platform-v2-sm",
     basedOrg: "symbols",
-    githubClientId: "Ov23liHxyWFBxS8f1gnF",
-    grafanaUrl: "",
-    // For grafana tracing
-    grafanaAppName: "Symbols Test",
-    typesenseCollectionName: "docs",
-    typesenseApiKey: "awmcVpbWqZi9IUgmvslp1C5LKDU8tMjA",
-    typesenseHost: "tl2qpnwxev4cjm36p-1.a1.typesense.net",
-    typesensePort: "443",
-    typesenseProtocol: "https"
-  },
-  upcoming: {
-    socketUrl: "https://upcoming.api.symbols.app",
-    apiUrl: "https://upcoming.api.symbols.app",
-    githubClientId: "Ov23liWF7NvdZ056RV5J",
-    grafanaUrl: "",
-    // For grafana tracing
-    grafanaAppName: "Symbols Upcoming",
-    typesenseCollectionName: "docs",
-    typesenseApiKey: "awmcVpbWqZi9IUgmvslp1C5LKDU8tMjA",
-    typesenseHost: "tl2qpnwxev4cjm36p-1.a1.typesense.net",
-    typesensePort: "443",
-    typesenseProtocol: "https"
+    githubClientId: "Ov23liHxyWFBxS8f1gnF"
   },
   staging: {
+    baseUrl: "https://staging.api.symbols.app",
     socketUrl: "https://staging.api.symbols.app",
+    routerUrl: "https://staging.api.symbols.app",
     apiUrl: "https://staging.api.symbols.app",
     basedEnv: "staging",
     basedProject: "platform-v2-sm",
     basedOrg: "symbols",
-    githubClientId: "Ov23ligwZDQVD0VfuWNa",
-    grafanaUrl: "",
-    // For grafana tracing
-    grafanaAppName: "Symbols Staging",
-    typesenseCollectionName: "docs",
-    typesenseApiKey: "awmcVpbWqZi9IUgmvslp1C5LKDU8tMjA",
-    typesenseHost: "tl2qpnwxev4cjm36p-1.a1.typesense.net",
-    typesensePort: "443",
-    typesenseProtocol: "https"
-  },
-  preview: {
-    socketUrl: "https://api.symbols.app",
-    apiUrl: "https://api.symbols.app",
-    basedEnv: "production",
-    basedProject: "platform-v2-sm",
-    basedOrg: "symbols",
-    githubClientId: "Ov23liFAlOEIXtX3dBtR",
-    grafanaUrl: "https://faro-collector-prod-us-east-0.grafana.net/collect/5c1089f3c3eea4ec5658e05c3f53baae",
-    // For grafana tracing
-    grafanaAppName: "Symbols Preview",
-    typesenseCollectionName: "docs",
-    typesenseApiKey: "awmcVpbWqZi9IUgmvslp1C5LKDU8tMjA",
-    typesenseHost: "tl2qpnwxev4cjm36p-1.a1.typesense.net",
-    typesensePort: "443",
-    typesenseProtocol: "https"
+    githubClientId: "Ov23ligwZDQVD0VfuWNa"
   },
   production: {
+    baseUrl: "https://api.symbols.app",
     socketUrl: "https://api.symbols.app",
+    routerUrl: "https://api.symbols.app",
     apiUrl: "https://api.symbols.app",
     basedEnv: "production",
     basedProject: "platform-v2-sm",
     basedOrg: "symbols",
-    githubClientId: "Ov23liFAlOEIXtX3dBtR",
-    grafanaUrl: "https://faro-collector-prod-us-east-0.grafana.net/collect/5c1089f3c3eea4ec5658e05c3f53baae",
-    // For grafana tracing
-    grafanaAppName: "Symbols",
-    typesenseCollectionName: "docs",
-    typesenseApiKey: "awmcVpbWqZi9IUgmvslp1C5LKDU8tMjA",
-    typesenseHost: "tl2qpnwxev4cjm36p-1.a1.typesense.net",
-    typesensePort: "443",
-    typesenseProtocol: "https"
+    githubClientId: "Ov23liFAlOEIXtX3dBtR"
   }
 };
 const getEnvironment = () => {
@@ -150,33 +90,27 @@ const getConfig = () => {
     const envConfig = { ...CONFIG.common, ...CONFIG[env] };
     const finalConfig = {
       ...envConfig,
-      // Deep-merge feature flags so env-specific overrides don't drop common defaults
-      features: {
-        ...CONFIG.common.features || {},
-        ...CONFIG[env] && CONFIG[env].features || {}
-      },
+      baseUrl: process.env.SYMBOLS_APP_BASE_URL || envConfig.baseUrl,
       socketUrl: process.env.SYMBOLS_APP_SOCKET_URL || envConfig.socketUrl,
+      routerUrl: process.env.SYMBOLS_APP_ROUTER_URL || envConfig.routerUrl,
       apiUrl: process.env.SYMBOLS_APP_API_URL || envConfig.apiUrl,
       basedEnv: process.env.SYMBOLS_APP_BASED_ENV || envConfig.basedEnv,
       basedProject: process.env.SYMBOLS_APP_BASED_PROJECT || envConfig.basedProject,
       basedOrg: process.env.SYMBOLS_APP_BASED_ORG || envConfig.basedOrg,
       githubClientId: process.env.SYMBOLS_APP_GITHUB_CLIENT_ID || envConfig.githubClientId,
-      grafanaUrl: process.env.SYMBOLS_APP_GRAFANA_URL || envConfig.grafanaUrl,
-      typesenseCollectionName: process.env.TYPESENSE_COLLECTION_NAME || envConfig.typesenseCollectionName,
-      typesenseApiKey: process.env.TYPESENSE_API_KEY || envConfig.typesenseApiKey,
-      typesenseHost: process.env.TYPESENSE_HOST || envConfig.typesenseHost,
-      typesensePort: process.env.TYPESENSE_PORT || envConfig.typesensePort,
-      typesenseProtocol: process.env.TYPESENSE_PROTOCOL || envConfig.typesenseProtocol,
       isDevelopment: isDevelopment(env),
       isTesting: env === "testing",
       isStaging: env === "staging",
-      isPreview: env === "preview",
       isProduction: env === "production"
       // Store all environment variables for potential future use
     };
     const requiredFields = [
+      "baseUrl",
       "socketUrl",
       "apiUrl",
+      "basedEnv",
+      "basedProject",
+      "basedOrg",
       "githubClientId",
       "googleClientId"
     ];
@@ -187,13 +121,11 @@ const getConfig = () => {
       );
     }
     if (finalConfig.isDevelopment) {
-      console.warn(
+      console.log(
         "environment in SDK:",
         env || process.env.NODE_ENV || process.env.NODE_ENV
       );
       console.log(finalConfig);
-    } else if (global.window) {
-      global.window.finalConfig = finalConfig;
     }
     return finalConfig;
   } catch (error) {