@bytescale/sdk
Advanced tools
Comparing version 3.6.0 to 3.7.0
@@ -14,3 +14,3 @@ import { BytescaleApiClientConfig } from "../../public/shared"; | ||
/** | ||
* The fully-qualified URL for your backend API's auth endpoint. | ||
* The fully-qualified URL for your backend API's auth endpoint (the endpoint that returns a JWT as plain text). | ||
*/ | ||
@@ -25,4 +25,6 @@ authUrl: string; | ||
/** | ||
* Begins an authenticated Bytescale API and Bytescale CDN session. | ||
* Begins a JWT auth session with the Bytescale API and Bytescale CDN. | ||
* | ||
* Specifically, calling this method will cause the SDK to periodically acquire a JWT from your JWT endpoint. The SDK will then automatically include this JWT in all subsequent Bytescale API requests (via the 'authorization-token' request header) and also in all Bytescale CDN download requests (via a session cookie). | ||
* | ||
* You can only call this method if 'isAuthSessionActive() === false', else an error will be returned. | ||
@@ -38,3 +40,3 @@ * | ||
* | ||
* 2) You must await the promise before attempting to perform any downloads or API operations that require authentication. | ||
* 2) You must await the returned promise before attempting to perform any downloads or API operations that require authentication. | ||
* | ||
@@ -41,0 +43,0 @@ * The auth process works as follows: |
{ | ||
"name": "@bytescale/sdk", | ||
"version": "3.6.0", | ||
"version": "3.7.0", | ||
"description": "Bytescale JavaScript SDK", | ||
@@ -24,2 +24,3 @@ "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)", | ||
}, | ||
"types": "./dist/types/index.d.ts", | ||
"default": "./dist/browser/cjs/main.js" | ||
@@ -26,0 +27,0 @@ } |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
995461
21186