mbd-studio-sdk 2.0.6 → 2.1.0

package/StudioConfig.js

@@ -0,0 +1,127 @@
+/**
+ * @typedef {Object} ServicesUrl
+ * @property {string} searchService - URL of the search service
+ * @property {string} storiesService - URL of the stories service
+ * @property {string} featuresService - URL of the features service
+ * @property {string} scoringService - URL of the scoring service
+ * @property {string} rankingService - URL of the ranking service
+ */
+
+/**
+ * @typedef {Object} StudioConfigOptions
+ * @property {string} apiKey - API key for authentication (required)
+ * @property {string} [commonUrl] - Base URL used for all services when provided
+ * @property {ServicesUrl} [servicesUrl] - Per-service URLs when commonUrl is not provided
+ * @property {function(string): void} [log] - Optional log function, defaults to console.log
+ * @property {function(*): void} [show] - Optional show function, defaults to console.log
+ */
+
+/**
+ * Configuration for MBD Studio SDK.
+ * Use commonUrl for a single URL for all services, or servicesUrl for one URL per service.
+ */
+export class StudioConfig {
+  /**
+   * @param {StudioConfigOptions} options - Configuration options
+   * @throws {Error} When parameters are invalid or missing required fields
+   */
+  constructor(options) {
+    if (!options || typeof options !== 'object') {
+      throw new Error('StudioConfig: options object is required');
+    }
+    const { apiKey, commonUrl, servicesUrl, log, show } = options;
+
+    if (typeof apiKey !== 'string' || !apiKey.trim()) {
+      throw new Error('StudioConfig: apiKey is required and must be a non-empty string');
+    }
+
+    const hasCommonUrl =
+      typeof commonUrl === 'string' && commonUrl.trim().length > 0;
+
+    if (hasCommonUrl) {
+      const url = commonUrl.trim().replace(/\/$/, '');
+      this._searchService = url;
+      this._storiesService = url;
+      this._featuresService = url;
+      this._scoringService = url;
+      this._rankingService = url;
+    } else {
+      if (!servicesUrl || typeof servicesUrl !== 'object') {
+        throw new Error(
+          'StudioConfig: when commonUrl is not provided, servicesUrl must be an object with searchService, storiesService, featuresService, scoringService, rankingService'
+        );
+      }
+      const {
+        searchService,
+        storiesService,
+        featuresService,
+        scoringService,
+        rankingService,
+      } = servicesUrl;
+      const services = {
+        searchService,
+        storiesService,
+        featuresService,
+        scoringService,
+        rankingService,
+      };
+      const missing = Object.entries(services)
+        .filter(([, v]) => typeof v !== 'string' || !v.trim())
+        .map(([k]) => k);
+      if (missing.length > 0) {
+        throw new Error(
+          `StudioConfig: when using servicesUrl, all service URLs are required. Missing or invalid: ${missing.join(', ')}`
+        );
+      }
+      this._searchService = searchService.trim().replace(/\/$/, '');
+      this._storiesService = storiesService.trim().replace(/\/$/, '');
+      this._featuresService = featuresService.trim().replace(/\/$/, '');
+      this._scoringService = scoringService.trim().replace(/\/$/, '');
+      this._rankingService = rankingService.trim().replace(/\/$/, '');
+    }
+
+    this._apiKey = apiKey.trim();
+    this._log = typeof log === 'function' ? log : console.log.bind(console);
+    this._show = typeof show === 'function' ? show : console.log.bind(console);
+  }
+
+  /** @returns {function(string): void} */
+  get log() {
+    return this._log;
+  }
+
+  /** @returns {function(*): void} */
+  get show() {
+    return this._show;
+  }
+
+  /** @returns {string} */
+  get searchService() {
+    return this._searchService;
+  }
+
+  /** @returns {string} */
+  get storiesService() {
+    return this._storiesService;
+  }
+
+  /** @returns {string} */
+  get featuresService() {
+    return this._featuresService;
+  }
+
+  /** @returns {string} */
+  get scoringService() {
+    return this._scoringService;
+  }
+
+  /** @returns {string} */
+  get rankingService() {
+    return this._rankingService;
+  }
+
+  /** @returns {string} */
+  get apiKey() {
+    return this._apiKey;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mbd-studio-sdk",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "description": "SDK for MBD Studio backend services",
   "type": "module",
   "main": "index.js",
@@ -9,6 +9,7 @@
   },
   "files": [
     "index.js",
+    "StudioConfig.js",
     "V1"
   ]
 }