@bytescale/sdk 3.0.0-alpha.1 → 3.0.0-alpha.2

package/dist/browser/cjs/main.js

@@ -42,7 +42,7 @@ __lib_require__.d(__lib_exports__, {
   "AuthManager": function() { return /* reexport */ AuthManager; },
   "BaseAPI": function() { return /* reexport */ BaseAPI; },
   "BinaryResult": function() { return /* reexport */ BinaryResult; },
-  "BytescaleApiClientConfigResolver": function() { return /* reexport */ BytescaleApiClientConfigResolver; },
+  "BytescaleApiClientConfigUtils": function() { return /* reexport */ BytescaleApiClientConfigUtils; },
   "BytescaleApiError": function() { return /* reexport */ BytescaleApiError; },
   "CancelledError": function() { return /* reexport */ CancelledError; },
   "CommonTypesNoOp": function() { return /* reexport */ CommonTypesNoOp; },
@@ -118,21 +118,21 @@ function runtime_createClass(Constructor, protoProps, staticProps) { if (protoPr
 function runtime_toPropertyKey(arg) { var key = runtime_toPrimitive(arg, "string"); return runtime_typeof(key) === "symbol" ? key : String(key); }
 function runtime_toPrimitive(input, hint) { if (runtime_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (runtime_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 
-var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
-  function BytescaleApiClientConfigResolver() {
-    runtime_classCallCheck(this, BytescaleApiClientConfigResolver);
+var BytescaleApiClientConfigUtils = /*#__PURE__*/function () {
+  function BytescaleApiClientConfigUtils() {
+    runtime_classCallCheck(this, BytescaleApiClientConfigUtils);
   }
-  runtime_createClass(BytescaleApiClientConfigResolver, null, [{
+  runtime_createClass(BytescaleApiClientConfigUtils, null, [{
     key: "getApiUrl",
     value: function getApiUrl(config) {
       var _a;
-      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultApiUrl;
+      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultApiUrl;
     }
   }, {
     key: "getCdnUrl",
     value: function getCdnUrl(config) {
       var _a;
-      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
     }
   }, {
     key: "getFetchApi",
@@ -140,11 +140,48 @@ var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
       var _a;
       return (_a = config.fetchApi) !== null && _a !== void 0 ? _a : fetch;
     }
+  }, {
+    key: "getAccountId",
+    value: function getAccountId(config) {
+      var _a, _b;
+      var accountId;
+      if (BytescaleApiClientConfigUtils.specialApiKeys.includes(config.apiKey)) {
+        accountId = BytescaleApiClientConfigUtils.specialApiKeyAccountId;
+      } else {
+        accountId = (_b = (_a = config.apiKey.split("_")[1]) === null || _a === void 0 ? void 0 : _a.substr(0, BytescaleApiClientConfigUtils.accountIdLength)) !== null && _b !== void 0 ? _b : "";
+        if (accountId.length !== BytescaleApiClientConfigUtils.accountIdLength) {
+          throw new Error("Invalid Bytescale API key.");
+        }
+      }
+      return accountId;
+    }
+  }, {
+    key: "validate",
+    value: function validate(config) {
+      var _a;
+      // Defensive programming, for users not using TypeScript. Mainly because this is used by UploadWidget users.
+      if ((config !== null && config !== void 0 ? config : undefined) === undefined) {
+        throw new Error("Config parameter required.");
+      }
+      if (((_a = config.apiKey) !== null && _a !== void 0 ? _a : undefined) === undefined) {
+        throw new Error("Please provide an API key via the 'apiKey' config parameter.");
+      }
+      if (config.apiKey.trim() !== config.apiKey) {
+        // We do not support API keys with whitespace (by trimming ourselves) because otherwise we'd need to support this
+        // everywhere in perpetuity (since removing the trimming would be a breaking change).
+        throw new Error("API key needs trimming (whitespace detected).");
+      }
+      // This performs futher validation on the API key...
+      BytescaleApiClientConfigUtils.getAccountId(config);
+    }
   }]);
-  return BytescaleApiClientConfigResolver;
+  return BytescaleApiClientConfigUtils;
 }();
-BytescaleApiClientConfigResolver.defaultApiUrl = "https://api.bytescale.com";
-BytescaleApiClientConfigResolver.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.defaultApiUrl = "https://api.bytescale.com";
+BytescaleApiClientConfigUtils.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.specialApiKeys = ["free", "demo"];
+BytescaleApiClientConfigUtils.specialApiKeyAccountId = "W142hJk";
+BytescaleApiClientConfigUtils.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 /**
  * This is the base class for all generated API classes.
  */
@@ -152,6 +189,7 @@ var BaseAPI = /*#__PURE__*/function () {
   function BaseAPI(config) {
     runtime_classCallCheck(this, BaseAPI);
     this.config = config;
+    BytescaleApiClientConfigUtils.validate(config);
   }
   runtime_createClass(BaseAPI, [{
     key: "request",
@@ -166,7 +204,7 @@ var BaseAPI = /*#__PURE__*/function () {
         }
         // Key: any possible value for 'baseUrlOverride'
         // Value: user-overridden value for that base URL from the config.
-        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigResolver.defaultCdnUrl, BytescaleApiClientConfigResolver.getCdnUrl(_this2.config));
+        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigUtils.defaultCdnUrl, BytescaleApiClientConfigUtils.getCdnUrl(_this2.config));
         return _await(_this2.createFetchParams(context, initOverrides, baseUrlOverride === undefined ? undefined : (_b = nonDefaultBasePaths[baseUrlOverride]) !== null && _b !== void 0 ? _b : baseUrlOverride), function (_ref) {
           var url = _ref.url,
             init = _ref.init;
@@ -188,7 +226,7 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return _continue(_catch(function () {
-          return _await(BytescaleApiClientConfigResolver.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return _await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -242,7 +280,7 @@ var BaseAPI = /*#__PURE__*/function () {
     value: function createFetchParams(context, initOverrides, baseUrlOverride) {
       try {
         var _this6 = this;
-        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigResolver.getApiUrl(_this6.config)) + context.path;
+        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigUtils.getApiUrl(_this6.config)) + context.path;
         if (context.query !== undefined && Object.keys(context.query).length !== 0) {
           // only add the querystring to the URL if there are query parameters.
           // this is done to avoid urls ending with a "?" character which buggy webservers
@@ -286,9 +324,6 @@ var BaseAPI = /*#__PURE__*/function () {
   }]);
   return BaseAPI;
 }();
-BaseAPI.specialApiKeys = ["free", "demo"];
-BaseAPI.specialApiKeyAccountId = "W142hJk";
-BaseAPI.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 var CancelledError = /*#__PURE__*/function (_Error) {
   _inherits(CancelledError, _Error);
   var _super = _createSuper(CancelledError);
@@ -1340,7 +1375,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   function UrlBuilder(config) {
     UrlBuilder_classCallCheck(this, UrlBuilder);
     var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
   }
   /**
    * Builds a URL to either a raw file or a transformed file.
@@ -2446,7 +2481,6 @@ var AuthManager = /*#__PURE__*/function (_BaseAPI) {
   function AuthManager(config) {
     var _this;
     AuthManagerBrowser_classCallCheck(this, AuthManager);
-    var _a, _b;
     _this = _super.call(this, config);
     _this.authSessionMutex = new Mutex();
     _this.contentType = "content-type";
@@ -2455,16 +2489,9 @@ var AuthManager = /*#__PURE__*/function (_BaseAPI) {
     _this.minJwtTtlSeconds = 10;
     _this.retryAuthAfterErrorSeconds = 5;
     _this.refreshBeforeExpirySeconds = 20;
-    var accountId;
-    if (BaseAPI.specialApiKeys.includes(config.apiKey)) {
-      accountId = BaseAPI.specialApiKeyAccountId;
-    } else {
-      accountId = (_b = (_a = config.apiKey.split("_")[1]) === null || _a === void 0 ? void 0 : _a.substr(0, BaseAPI.accountIdLength)) !== null && _b !== void 0 ? _b : "";
-      if (accountId.length !== BaseAPI.accountIdLength) {
-        throw new Error("Invalid Bytescale API key.");
-      }
-    }
-    _this.accessTokenUrl = "".concat(BytescaleApiClientConfigResolver.getCdnUrl(config), "/api/v1/access_tokens/").concat(accountId);
+    var cdnUrl = BytescaleApiClientConfigUtils.getCdnUrl(config);
+    var accountId = BytescaleApiClientConfigUtils.getAccountId(config);
+    _this.accessTokenUrl = "".concat(cdnUrl, "/api/v1/access_tokens/").concat(accountId);
     return _this;
   }
   AuthManagerBrowser_createClass(AuthManager, [{

package/dist/node/cjs/main.js

@@ -64,7 +64,7 @@ __lib_require__.d(__lib_exports__, {
   "AuthManager": function() { return /* reexport */ AuthManager; },
   "BaseAPI": function() { return /* reexport */ BaseAPI; },
   "BinaryResult": function() { return /* reexport */ BinaryResult; },
-  "BytescaleApiClientConfigResolver": function() { return /* reexport */ BytescaleApiClientConfigResolver; },
+  "BytescaleApiClientConfigUtils": function() { return /* reexport */ BytescaleApiClientConfigUtils; },
   "BytescaleApiError": function() { return /* reexport */ BytescaleApiError; },
   "CancelledError": function() { return /* reexport */ CancelledError; },
   "CommonTypesNoOp": function() { return /* reexport */ CommonTypesNoOp; },
@@ -140,21 +140,21 @@ function runtime_createClass(Constructor, protoProps, staticProps) { if (protoPr
 function runtime_toPropertyKey(arg) { var key = runtime_toPrimitive(arg, "string"); return runtime_typeof(key) === "symbol" ? key : String(key); }
 function runtime_toPrimitive(input, hint) { if (runtime_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (runtime_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 
-var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
-  function BytescaleApiClientConfigResolver() {
-    runtime_classCallCheck(this, BytescaleApiClientConfigResolver);
+var BytescaleApiClientConfigUtils = /*#__PURE__*/function () {
+  function BytescaleApiClientConfigUtils() {
+    runtime_classCallCheck(this, BytescaleApiClientConfigUtils);
   }
-  runtime_createClass(BytescaleApiClientConfigResolver, null, [{
+  runtime_createClass(BytescaleApiClientConfigUtils, null, [{
     key: "getApiUrl",
     value: function getApiUrl(config) {
       var _a;
-      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultApiUrl;
+      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultApiUrl;
     }
   }, {
     key: "getCdnUrl",
     value: function getCdnUrl(config) {
       var _a;
-      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
     }
   }, {
     key: "getFetchApi",
@@ -162,11 +162,48 @@ var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
       var _a;
       return (_a = config.fetchApi) !== null && _a !== void 0 ? _a : fetch;
     }
+  }, {
+    key: "getAccountId",
+    value: function getAccountId(config) {
+      var _a, _b;
+      var accountId;
+      if (BytescaleApiClientConfigUtils.specialApiKeys.includes(config.apiKey)) {
+        accountId = BytescaleApiClientConfigUtils.specialApiKeyAccountId;
+      } else {
+        accountId = (_b = (_a = config.apiKey.split("_")[1]) === null || _a === void 0 ? void 0 : _a.substr(0, BytescaleApiClientConfigUtils.accountIdLength)) !== null && _b !== void 0 ? _b : "";
+        if (accountId.length !== BytescaleApiClientConfigUtils.accountIdLength) {
+          throw new Error("Invalid Bytescale API key.");
+        }
+      }
+      return accountId;
+    }
+  }, {
+    key: "validate",
+    value: function validate(config) {
+      var _a;
+      // Defensive programming, for users not using TypeScript. Mainly because this is used by UploadWidget users.
+      if ((config !== null && config !== void 0 ? config : undefined) === undefined) {
+        throw new Error("Config parameter required.");
+      }
+      if (((_a = config.apiKey) !== null && _a !== void 0 ? _a : undefined) === undefined) {
+        throw new Error("Please provide an API key via the 'apiKey' config parameter.");
+      }
+      if (config.apiKey.trim() !== config.apiKey) {
+        // We do not support API keys with whitespace (by trimming ourselves) because otherwise we'd need to support this
+        // everywhere in perpetuity (since removing the trimming would be a breaking change).
+        throw new Error("API key needs trimming (whitespace detected).");
+      }
+      // This performs futher validation on the API key...
+      BytescaleApiClientConfigUtils.getAccountId(config);
+    }
   }]);
-  return BytescaleApiClientConfigResolver;
+  return BytescaleApiClientConfigUtils;
 }();
-BytescaleApiClientConfigResolver.defaultApiUrl = "https://api.bytescale.com";
-BytescaleApiClientConfigResolver.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.defaultApiUrl = "https://api.bytescale.com";
+BytescaleApiClientConfigUtils.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.specialApiKeys = ["free", "demo"];
+BytescaleApiClientConfigUtils.specialApiKeyAccountId = "W142hJk";
+BytescaleApiClientConfigUtils.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 /**
  * This is the base class for all generated API classes.
  */
@@ -174,6 +211,7 @@ var BaseAPI = /*#__PURE__*/function () {
   function BaseAPI(config) {
     runtime_classCallCheck(this, BaseAPI);
     this.config = config;
+    BytescaleApiClientConfigUtils.validate(config);
   }
   runtime_createClass(BaseAPI, [{
     key: "request",
@@ -188,7 +226,7 @@ var BaseAPI = /*#__PURE__*/function () {
         }
         // Key: any possible value for 'baseUrlOverride'
         // Value: user-overridden value for that base URL from the config.
-        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigResolver.defaultCdnUrl, BytescaleApiClientConfigResolver.getCdnUrl(_this2.config));
+        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigUtils.defaultCdnUrl, BytescaleApiClientConfigUtils.getCdnUrl(_this2.config));
         return _await(_this2.createFetchParams(context, initOverrides, baseUrlOverride === undefined ? undefined : (_b = nonDefaultBasePaths[baseUrlOverride]) !== null && _b !== void 0 ? _b : baseUrlOverride), function (_ref) {
           var url = _ref.url,
             init = _ref.init;
@@ -210,7 +248,7 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return _continue(_catch(function () {
-          return _await(BytescaleApiClientConfigResolver.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return _await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -264,7 +302,7 @@ var BaseAPI = /*#__PURE__*/function () {
     value: function createFetchParams(context, initOverrides, baseUrlOverride) {
       try {
         var _this6 = this;
-        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigResolver.getApiUrl(_this6.config)) + context.path;
+        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigUtils.getApiUrl(_this6.config)) + context.path;
         if (context.query !== undefined && Object.keys(context.query).length !== 0) {
           // only add the querystring to the URL if there are query parameters.
           // this is done to avoid urls ending with a "?" character which buggy webservers
@@ -308,9 +346,6 @@ var BaseAPI = /*#__PURE__*/function () {
   }]);
   return BaseAPI;
 }();
-BaseAPI.specialApiKeys = ["free", "demo"];
-BaseAPI.specialApiKeyAccountId = "W142hJk";
-BaseAPI.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 var CancelledError = /*#__PURE__*/function (_Error) {
   _inherits(CancelledError, _Error);
   var _super = _createSuper(CancelledError);
@@ -1362,7 +1397,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   function UrlBuilder(config) {
     UrlBuilder_classCallCheck(this, UrlBuilder);
     var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
   }
   /**
    * Builds a URL to either a raw file or a transformed file.

package/dist/node/esm/main.mjs

@@ -51,7 +51,7 @@ __lib_require__.d(__lib_exports__, {
   "AuthManager": function() { return /* reexport */ AuthManager; },
   "BaseAPI": function() { return /* reexport */ BaseAPI; },
   "BinaryResult": function() { return /* reexport */ BinaryResult; },
-  "BytescaleApiClientConfigResolver": function() { return /* reexport */ BytescaleApiClientConfigResolver; },
+  "BytescaleApiClientConfigUtils": function() { return /* reexport */ BytescaleApiClientConfigUtils; },
   "BytescaleApiError": function() { return /* reexport */ BytescaleApiError; },
   "CancelledError": function() { return /* reexport */ CancelledError; },
   "CommonTypesNoOp": function() { return /* reexport */ CommonTypesNoOp; },
@@ -127,21 +127,21 @@ function runtime_createClass(Constructor, protoProps, staticProps) { if (protoPr
 function runtime_toPropertyKey(arg) { var key = runtime_toPrimitive(arg, "string"); return runtime_typeof(key) === "symbol" ? key : String(key); }
 function runtime_toPrimitive(input, hint) { if (runtime_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (runtime_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 
-var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
-  function BytescaleApiClientConfigResolver() {
-    runtime_classCallCheck(this, BytescaleApiClientConfigResolver);
+var BytescaleApiClientConfigUtils = /*#__PURE__*/function () {
+  function BytescaleApiClientConfigUtils() {
+    runtime_classCallCheck(this, BytescaleApiClientConfigUtils);
   }
-  runtime_createClass(BytescaleApiClientConfigResolver, null, [{
+  runtime_createClass(BytescaleApiClientConfigUtils, null, [{
     key: "getApiUrl",
     value: function getApiUrl(config) {
       var _a;
-      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultApiUrl;
+      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultApiUrl;
     }
   }, {
     key: "getCdnUrl",
     value: function getCdnUrl(config) {
       var _a;
-      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
     }
   }, {
     key: "getFetchApi",
@@ -149,11 +149,48 @@ var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
       var _a;
       return (_a = config.fetchApi) !== null && _a !== void 0 ? _a : fetch;
     }
+  }, {
+    key: "getAccountId",
+    value: function getAccountId(config) {
+      var _a, _b;
+      var accountId;
+      if (BytescaleApiClientConfigUtils.specialApiKeys.includes(config.apiKey)) {
+        accountId = BytescaleApiClientConfigUtils.specialApiKeyAccountId;
+      } else {
+        accountId = (_b = (_a = config.apiKey.split("_")[1]) === null || _a === void 0 ? void 0 : _a.substr(0, BytescaleApiClientConfigUtils.accountIdLength)) !== null && _b !== void 0 ? _b : "";
+        if (accountId.length !== BytescaleApiClientConfigUtils.accountIdLength) {
+          throw new Error("Invalid Bytescale API key.");
+        }
+      }
+      return accountId;
+    }
+  }, {
+    key: "validate",
+    value: function validate(config) {
+      var _a;
+      // Defensive programming, for users not using TypeScript. Mainly because this is used by UploadWidget users.
+      if ((config !== null && config !== void 0 ? config : undefined) === undefined) {
+        throw new Error("Config parameter required.");
+      }
+      if (((_a = config.apiKey) !== null && _a !== void 0 ? _a : undefined) === undefined) {
+        throw new Error("Please provide an API key via the 'apiKey' config parameter.");
+      }
+      if (config.apiKey.trim() !== config.apiKey) {
+        // We do not support API keys with whitespace (by trimming ourselves) because otherwise we'd need to support this
+        // everywhere in perpetuity (since removing the trimming would be a breaking change).
+        throw new Error("API key needs trimming (whitespace detected).");
+      }
+      // This performs futher validation on the API key...
+      BytescaleApiClientConfigUtils.getAccountId(config);
+    }
   }]);
-  return BytescaleApiClientConfigResolver;
+  return BytescaleApiClientConfigUtils;
 }();
-BytescaleApiClientConfigResolver.defaultApiUrl = "https://api.bytescale.com";
-BytescaleApiClientConfigResolver.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.defaultApiUrl = "https://api.bytescale.com";
+BytescaleApiClientConfigUtils.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.specialApiKeys = ["free", "demo"];
+BytescaleApiClientConfigUtils.specialApiKeyAccountId = "W142hJk";
+BytescaleApiClientConfigUtils.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 /**
  * This is the base class for all generated API classes.
  */
@@ -161,6 +198,7 @@ var BaseAPI = /*#__PURE__*/function () {
   function BaseAPI(config) {
     runtime_classCallCheck(this, BaseAPI);
     this.config = config;
+    BytescaleApiClientConfigUtils.validate(config);
   }
   runtime_createClass(BaseAPI, [{
     key: "request",
@@ -175,7 +213,7 @@ var BaseAPI = /*#__PURE__*/function () {
         }
         // Key: any possible value for 'baseUrlOverride'
         // Value: user-overridden value for that base URL from the config.
-        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigResolver.defaultCdnUrl, BytescaleApiClientConfigResolver.getCdnUrl(_this2.config));
+        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigUtils.defaultCdnUrl, BytescaleApiClientConfigUtils.getCdnUrl(_this2.config));
         return _await(_this2.createFetchParams(context, initOverrides, baseUrlOverride === undefined ? undefined : (_b = nonDefaultBasePaths[baseUrlOverride]) !== null && _b !== void 0 ? _b : baseUrlOverride), function (_ref) {
           var url = _ref.url,
             init = _ref.init;
@@ -197,7 +235,7 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return _continue(_catch(function () {
-          return _await(BytescaleApiClientConfigResolver.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return _await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -251,7 +289,7 @@ var BaseAPI = /*#__PURE__*/function () {
     value: function createFetchParams(context, initOverrides, baseUrlOverride) {
       try {
         var _this6 = this;
-        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigResolver.getApiUrl(_this6.config)) + context.path;
+        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigUtils.getApiUrl(_this6.config)) + context.path;
         if (context.query !== undefined && Object.keys(context.query).length !== 0) {
           // only add the querystring to the URL if there are query parameters.
           // this is done to avoid urls ending with a "?" character which buggy webservers
@@ -295,9 +333,6 @@ var BaseAPI = /*#__PURE__*/function () {
   }]);
   return BaseAPI;
 }();
-BaseAPI.specialApiKeys = ["free", "demo"];
-BaseAPI.specialApiKeyAccountId = "W142hJk";
-BaseAPI.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 var CancelledError = /*#__PURE__*/function (_Error) {
   _inherits(CancelledError, _Error);
   var _super = _createSuper(CancelledError);
@@ -1349,7 +1384,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   function UrlBuilder(config) {
     UrlBuilder_classCallCheck(this, UrlBuilder);
     var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
   }
   /**
    * Builds a URL to either a raw file or a transformed file.
@@ -2624,7 +2659,7 @@ var AuthManager = /*#__PURE__*/function () {
 var __lib_exports__AuthManager = __lib_exports__.AuthManager;
 var __lib_exports__BaseAPI = __lib_exports__.BaseAPI;
 var __lib_exports__BinaryResult = __lib_exports__.BinaryResult;
-var __lib_exports__BytescaleApiClientConfigResolver = __lib_exports__.BytescaleApiClientConfigResolver;
+var __lib_exports__BytescaleApiClientConfigUtils = __lib_exports__.BytescaleApiClientConfigUtils;
 var __lib_exports__BytescaleApiError = __lib_exports__.BytescaleApiError;
 var __lib_exports__CancelledError = __lib_exports__.CancelledError;
 var __lib_exports__CommonTypesNoOp = __lib_exports__.CommonTypesNoOp;
@@ -2638,4 +2673,4 @@ var __lib_exports__UrlBuilder = __lib_exports__.UrlBuilder;
 var __lib_exports__UrlBuilderTypesNoOp = __lib_exports__.UrlBuilderTypesNoOp;
 var __lib_exports__VoidApiResponse = __lib_exports__.VoidApiResponse;
 var __lib_exports__querystring = __lib_exports__.querystring;
-export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigResolver as BytescaleApiClientConfigResolver, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__querystring as querystring };
+export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__querystring as querystring };

package/dist/types/public/shared/generated/runtime.d.ts

@@ -12,13 +12,13 @@ import { ErrorResponse } from "./models";
  */
 export interface BytescaleApiClientConfig {
     /**
-     * Required for Node.js: you must provide an instance of requires("node-fetch")
+     * Only required for Node.js. Must be an instance of requires("node-fetch").
      *
      * Not required for the browser.
      */
     fetchApi?: FetchAPI;
     /**
-     * Required for all environments. Must begin with "public_" or "secret_".
+     * Must begin with "public_" or "secret_".
      *
      * Please note: if you require JWT-based auth, you must provide an API key to this field, and then call 'AuthManager.beginAuthSession' to start a JWT-based auth session. The JWT's permissions will be merged with the API key's permissions, with precedence given to the JWT.
      */
@@ -38,21 +38,23 @@ export interface BytescaleApiClientConfig {
      */
     headers?: () => Promise<HTTPHeaders>;
 }
-export declare class BytescaleApiClientConfigResolver {
+export declare class BytescaleApiClientConfigUtils {
     static defaultApiUrl: string;
     static defaultCdnUrl: string;
+    private static readonly specialApiKeys;
+    private static readonly specialApiKeyAccountId;
+    private static readonly accountIdLength;
     static getApiUrl(config: BytescaleApiClientConfig): string;
     static getCdnUrl(config: BytescaleApiClientConfig): string;
     static getFetchApi(config: BytescaleApiClientConfig): FetchAPI;
+    static getAccountId(config: BytescaleApiClientConfig): string;
+    static validate(config: BytescaleApiClientConfig): void;
 }
 /**
  * This is the base class for all generated API classes.
  */
 export declare class BaseAPI {
     protected readonly config: BytescaleApiClientConfig;
-    protected static readonly specialApiKeys: string[];
-    protected static readonly specialApiKeyAccountId = "W142hJk";
-    protected static readonly accountIdLength = 7;
     constructor(config: BytescaleApiClientConfig);
     protected request(context: RequestOpts, initOverrides: RequestInit | InitOverrideFunction | undefined, baseUrlOverride: string | undefined): Promise<Response>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.2",
   "description": "Bytescale JavaScript SDK",
   "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
   "license": "MIT",