frameio 3.2.2 → 4.1.1

package/dist/esm/api/resources/workspaces/client/Client.mjs

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
-import { mergeHeaders } from "../../../../core/headers.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as environments from "../../../../environments.mjs";
 import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.mjs";
@@ -48,22 +48,22 @@ export class WorkspacesClient {
     }
     __show(account_id_1, workspace_id_1) {
         return __awaiter(this, arguments, void 0, function* (account_id, workspace_id, request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const { include } = request;
             const _queryParams = {
                 include: include != null ? include : undefined,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}`),
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
-                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
-                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -122,18 +122,18 @@ export class WorkspacesClient {
     }
     __delete(account_id, workspace_id, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}`),
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}`),
                 method: "DELETE",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
-                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -194,21 +194,21 @@ export class WorkspacesClient {
     }
     __update(account_id, workspace_id, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}`),
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}`),
                 method: "PATCH",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
-                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -268,17 +268,17 @@ export class WorkspacesClient {
         return __awaiter(this, arguments, void 0, function* (account_id, _request = {}, requestOptions) {
             var _a, _b;
             const list = core.HttpResponsePromise.interceptFunction((_requestUrl) => __awaiter(this, void 0, void 0, function* () {
-                var _a, _b, _c, _d, _e, _f, _g, _h;
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j;
                 const _authRequest = yield this._options.authProvider.getAuthRequest();
-                const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-                const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+                const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
                     url: _requestUrl,
                     method: "GET",
                     headers: _headers,
-                    timeoutMs: ((_e = (_c = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _c !== void 0 ? _c : (_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) !== null && _e !== void 0 ? _e : 60) * 1000,
-                    maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                    timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                    maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                     abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                    fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                    fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
                     logging: this._options.logging,
                 });
                 if (_response.ok) {
@@ -353,21 +353,21 @@ export class WorkspacesClient {
     }
     __create(account_id, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
-                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces`),
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
-                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {

package/dist/esm/api/types/Account.d.mts

@@ -10,8 +10,6 @@ export interface Account {
     id: string;
     /** The account image url */
     image?: string | undefined;
-    /** Whether mounted storage is enabled for this account */
-    mounted_storage_enabled?: boolean | undefined;
     /** Account User Roles */
     roles: Account.Roles.Item[];
     /** The number of bytes of non-archived storage in the account. Value is nil when there is no limit */

package/dist/esm/api/types/AuditLogwithIncludes.d.mts

@@ -179,6 +179,9 @@ export declare namespace AuditLogwithIncludes {
         readonly ShareCreated: "share_created";
         readonly ShareDeleted: "share_deleted";
         readonly ShareInvitesSent: "share_invites_sent";
+        readonly ShareListCreated: "share_list_created";
+        readonly ShareListDeleted: "share_list_deleted";
+        readonly ShareListUpdated: "share_list_updated";
         readonly ShareReviewersAdded: "share_reviewers_added";
         readonly ShareReviewersRemoved: "share_reviewers_removed";
         readonly ShareUpdated: "share_updated";
@@ -260,6 +263,7 @@ export declare namespace AuditLogwithIncludes {
         readonly Reviewer: "reviewer";
         readonly SbwmTemplate: "sbwm_template";
         readonly Share: "share";
+        readonly ShareList: "share_list";
         readonly Subscription: "subscription";
         readonly SubscriptionLineItem: "subscription_line_item";
         readonly Team: "team";

package/dist/esm/api/types/AuditLogwithIncludes.mjs

@@ -165,6 +165,9 @@ export var AuditLogwithIncludes;
         ShareCreated: "share_created",
         ShareDeleted: "share_deleted",
         ShareInvitesSent: "share_invites_sent",
+        ShareListCreated: "share_list_created",
+        ShareListDeleted: "share_list_deleted",
+        ShareListUpdated: "share_list_updated",
         ShareReviewersAdded: "share_reviewers_added",
         ShareReviewersRemoved: "share_reviewers_removed",
         ShareUpdated: "share_updated",
@@ -245,6 +248,7 @@ export var AuditLogwithIncludes;
         Reviewer: "reviewer",
         SbwmTemplate: "sbwm_template",
         Share: "share",
+        ShareList: "share_list",
         Subscription: "subscription",
         SubscriptionLineItem: "subscription_line_item",
         Team: "team",

package/dist/esm/api/types/Filters.d.mts

@@ -187,6 +187,9 @@ export declare namespace Filters {
         readonly ShareCreated: "share_created";
         readonly ShareDeleted: "share_deleted";
         readonly ShareInvitesSent: "share_invites_sent";
+        readonly ShareListCreated: "share_list_created";
+        readonly ShareListDeleted: "share_list_deleted";
+        readonly ShareListUpdated: "share_list_updated";
         readonly ShareReviewersAdded: "share_reviewers_added";
         readonly ShareReviewersRemoved: "share_reviewers_removed";
         readonly ShareUpdated: "share_updated";
@@ -269,6 +272,7 @@ export declare namespace Filters {
         readonly Reviewer: "reviewer";
         readonly SbwmTemplate: "sbwm_template";
         readonly Share: "share";
+        readonly ShareList: "share_list";
         readonly Subscription: "subscription";
         readonly SubscriptionLineItem: "subscription_line_item";
         readonly Team: "team";

package/dist/esm/api/types/Filters.mjs

@@ -166,6 +166,9 @@ export var Filters;
         ShareCreated: "share_created",
         ShareDeleted: "share_deleted",
         ShareInvitesSent: "share_invites_sent",
+        ShareListCreated: "share_list_created",
+        ShareListDeleted: "share_list_deleted",
+        ShareListUpdated: "share_list_updated",
         ShareReviewersAdded: "share_reviewers_added",
         ShareReviewersRemoved: "share_reviewers_removed",
         ShareUpdated: "share_updated",
@@ -247,6 +250,7 @@ export var Filters;
         Reviewer: "reviewer",
         SbwmTemplate: "sbwm_template",
         Share: "share",
+        ShareList: "share_list",
         Subscription: "subscription",
         SubscriptionLineItem: "subscription_line_item",
         Team: "team",

package/dist/esm/index.d.mts

@@ -4,3 +4,7 @@ export { FrameioClient } from "./Client.mjs";
 export { FrameioEnvironment } from "./environments.mjs";
 export { FrameioError, FrameioTimeoutError } from "./errors/index.mjs";
 export * from "./exports.mjs";
+export { ServerToServerAuth, WebAppAuth, SPAAuth, NativeAppAuth } from "./oauth";
+export type { ServerToServerAuthOptions, WebAppAuthOptions, SPAAuthOptions, NativeAppAuthOptions, AuthorizationUrlResult, BaseAuthOptions, Logger, TokenResponse, ExportedTokens, OnTokenRefreshed, } from "./oauth";
+export { FrameioAuthError, AuthenticationError, TokenExpiredError, NetworkError, RateLimitError, PKCEError, ConfigurationError, } from "./oauth";
+export { noopLogger, DEFAULT_IMS_BASE_URL, buildImsUrls } from "./oauth";

package/dist/esm/index.mjs

@@ -3,3 +3,9 @@ export { FrameioClient } from "./Client.mjs";
 export { FrameioEnvironment } from "./environments.mjs";
 export { FrameioError, FrameioTimeoutError } from "./errors/index.mjs";
 export * from "./exports.mjs";
+// Auth flows
+export { ServerToServerAuth, WebAppAuth, SPAAuth, NativeAppAuth } from "./oauth";
+// Auth errors
+export { FrameioAuthError, AuthenticationError, TokenExpiredError, NetworkError, RateLimitError, PKCEError, ConfigurationError, } from "./oauth";
+// Auth utilities
+export { noopLogger, DEFAULT_IMS_BASE_URL, buildImsUrls } from "./oauth";

package/dist/esm/oauth/BaseAuth.d.mts

@@ -0,0 +1,66 @@
+/**
+ * Base class for all authentication flows.
+ *
+ * Provides shared token management methods: `getToken`, `revoke`,
+ * `exportTokens`, `importTokens`, and the internal `_storeTokens` helper.
+ *
+ * Also consolidates shared constructor options and initialization logic.
+ */
+import type { Logger } from "./logger";
+import { TokenManager, type ExportedTokens, type OnTokenRefreshed, type TokenResponse } from "./TokenManager";
+/** Default fallback when Adobe IMS doesn't return expires_in. */
+export declare const DEFAULT_EXPIRES_IN = 86400;
+/** Options shared by all auth flow constructors. */
+export interface BaseAuthOptions {
+    clientId: string;
+    scopes?: string;
+    /** IMS base URL for staging/alternative environments. Default: production. */
+    imsBaseUrl?: string;
+    /** Custom fetch implementation (for proxy, TLS, etc.). */
+    fetch?: typeof fetch;
+    onTokenRefreshed?: OnTokenRefreshed;
+    /** HTTP request timeout in milliseconds. Default: 30000. */
+    timeout?: number;
+    /** Maximum retries for transient failures. Default: 2. */
+    maxRetries?: number;
+    /** Seconds before expiry to trigger proactive refresh. Default: 60. */
+    refreshBuffer?: number;
+    /** Logger instance for diagnostic output. */
+    logger?: Logger;
+}
+export declare abstract class BaseAuth {
+    protected readonly _clientId: string;
+    protected readonly _clientSecret: string | undefined;
+    protected readonly _tokenManager: TokenManager;
+    protected readonly _timeout: number;
+    protected readonly _logger: Logger;
+    protected readonly _maxRetries: number;
+    protected readonly _revokeUrl: string;
+    protected readonly _authorizeUrl: string;
+    protected readonly _tokenUrl: string;
+    protected readonly _fetch?: typeof fetch;
+    constructor(options: BaseAuthOptions, clientSecret?: string);
+    /**
+     * Subclasses implement this to perform the actual token refresh.
+     * For S2S this re-fetches via client_credentials; for WebApp/SPA
+     * this uses the stored refresh_token.
+     */
+    protected abstract _refresh(): Promise<TokenResponse>;
+    /** Return a valid access token, refreshing if necessary. */
+    getToken(): Promise<string>;
+    /**
+     * Revoke the current access and refresh tokens in parallel.
+     *
+     * Access token revocation may take time to propagate server-side,
+     * but refresh token revocation takes effect immediately.
+     */
+    revoke(): Promise<void>;
+    /** Export current token state for persistence. */
+    exportTokens(): ExportedTokens;
+    /** Restore token state from a previously exported object. */
+    importTokens(data: ExportedTokens): void;
+    /** Update the token manager from an Adobe IMS response. */
+    protected _storeTokens(result: TokenResponse): void;
+    /** Send a token request with the shared options. */
+    protected _tokenRequest(data: Record<string, string>): Promise<TokenResponse>;
+}

package/dist/esm/oauth/BaseAuth.mjs

@@ -0,0 +1,109 @@
+/**
+ * Base class for all authentication flows.
+ *
+ * Provides shared token management methods: `getToken`, `revoke`,
+ * `exportTokens`, `importTokens`, and the internal `_storeTokens` helper.
+ *
+ * Also consolidates shared constructor options and initialization logic.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { buildImsUrls, DEFAULT_IMS_BASE_URL, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT, revokeRequest, tokenRequest, } from "./http";
+import { ConfigurationError } from "./errors";
+import { noopLogger } from "./logger";
+import { TokenManager } from "./TokenManager";
+/** Default fallback when Adobe IMS doesn't return expires_in. */
+export const DEFAULT_EXPIRES_IN = 86400;
+export class BaseAuth {
+    constructor(options, clientSecret) {
+        var _a, _b, _c, _d;
+        if (!options.clientId) {
+            throw new ConfigurationError("clientId is required");
+        }
+        this._clientId = options.clientId;
+        this._clientSecret = clientSecret;
+        this._timeout = (_a = options.timeout) !== null && _a !== void 0 ? _a : DEFAULT_TIMEOUT;
+        this._maxRetries = (_b = options.maxRetries) !== null && _b !== void 0 ? _b : DEFAULT_MAX_RETRIES;
+        this._logger = (_c = options.logger) !== null && _c !== void 0 ? _c : noopLogger;
+        this._fetch = options.fetch;
+        const urls = buildImsUrls((_d = options.imsBaseUrl) !== null && _d !== void 0 ? _d : DEFAULT_IMS_BASE_URL);
+        this._authorizeUrl = urls.authorizeUrl;
+        this._tokenUrl = urls.tokenUrl;
+        this._revokeUrl = urls.revokeUrl;
+        this._tokenManager = new TokenManager({
+            refreshFunc: () => this._refresh(),
+            refreshBuffer: options.refreshBuffer,
+            onTokenRefreshed: options.onTokenRefreshed,
+            logger: this._logger,
+        });
+    }
+    // ------------------------------------------------------------------
+    // Public API (shared by all flows)
+    // ------------------------------------------------------------------
+    /** Return a valid access token, refreshing if necessary. */
+    getToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this._tokenManager.getToken();
+        });
+    }
+    /**
+     * Revoke the current access and refresh tokens in parallel.
+     *
+     * Access token revocation may take time to propagate server-side,
+     * but refresh token revocation takes effect immediately.
+     */
+    revoke() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const revokeOpts = {
+                timeout: this._timeout,
+                logger: this._logger,
+                revokeUrl: this._revokeUrl,
+                fetch: this._fetch,
+            };
+            const accessToken = this._tokenManager.accessToken;
+            const refreshToken = this._tokenManager.refreshTokenValue;
+            const revocations = [];
+            if (accessToken) {
+                revocations.push(revokeRequest(accessToken, this._clientId, this._clientSecret, revokeOpts));
+            }
+            if (refreshToken) {
+                revocations.push(revokeRequest(refreshToken, this._clientId, this._clientSecret, revokeOpts));
+            }
+            yield Promise.all(revocations);
+            this._tokenManager.clear();
+        });
+    }
+    /** Export current token state for persistence. */
+    exportTokens() {
+        return this._tokenManager.exportTokens();
+    }
+    /** Restore token state from a previously exported object. */
+    importTokens(data) {
+        this._tokenManager.importTokens(data);
+    }
+    // ------------------------------------------------------------------
+    // Helpers
+    // ------------------------------------------------------------------
+    /** Update the token manager from an Adobe IMS response. */
+    _storeTokens(result) {
+        var _a;
+        this._tokenManager.setTokens(result.access_token, (_a = result.expires_in) !== null && _a !== void 0 ? _a : DEFAULT_EXPIRES_IN, result.refresh_token);
+    }
+    /** Send a token request with the shared options. */
+    _tokenRequest(data) {
+        return tokenRequest(data, {
+            timeout: this._timeout,
+            maxRetries: this._maxRetries,
+            logger: this._logger,
+            tokenUrl: this._tokenUrl,
+            fetch: this._fetch,
+        });
+    }
+}

package/dist/esm/oauth/NativeAppAuth.d.mts

@@ -0,0 +1,32 @@
+/**
+ * Native App authentication (authorization_code + PKCE).
+ *
+ * Use for desktop and mobile applications with custom URI schemes
+ * or loopback redirects.
+ */
+import { SPAAuth, type SPAAuthOptions } from "./SPAAuth";
+export type NativeAppAuthOptions = SPAAuthOptions;
+/**
+ * Authenticate native (desktop / mobile) apps using PKCE.
+ *
+ * Functionally identical to {@link SPAAuth} but allows custom URI scheme
+ * redirect URIs (e.g. `adobe+<hash>://callback`, `myapp://callback`).
+ *
+ * The parent {@link SPAAuth} validates that `http://` redirect URIs only
+ * target loopback addresses, which is also the correct behavior for native
+ * apps. Custom URI schemes and `https://` are always allowed.
+ *
+ * @example
+ * ```ts
+ * const auth = new NativeAppAuth({
+ *   clientId: '...',
+ *   redirectUri: 'myapp://callback',
+ * });
+ * const { url, codeVerifier } = await auth.getAuthorizationUrl({ state: 'random' });
+ * // open system browser to url ...
+ * await auth.exchangeCode({ code: 'CODE', codeVerifier });
+ * const client = new FrameioClient({ token: () => auth.getToken() });
+ * ```
+ */
+export declare class NativeAppAuth extends SPAAuth {
+}

package/dist/esm/oauth/NativeAppAuth.mjs

@@ -0,0 +1,31 @@
+/**
+ * Native App authentication (authorization_code + PKCE).
+ *
+ * Use for desktop and mobile applications with custom URI schemes
+ * or loopback redirects.
+ */
+import { SPAAuth } from "./SPAAuth";
+/**
+ * Authenticate native (desktop / mobile) apps using PKCE.
+ *
+ * Functionally identical to {@link SPAAuth} but allows custom URI scheme
+ * redirect URIs (e.g. `adobe+<hash>://callback`, `myapp://callback`).
+ *
+ * The parent {@link SPAAuth} validates that `http://` redirect URIs only
+ * target loopback addresses, which is also the correct behavior for native
+ * apps. Custom URI schemes and `https://` are always allowed.
+ *
+ * @example
+ * ```ts
+ * const auth = new NativeAppAuth({
+ *   clientId: '...',
+ *   redirectUri: 'myapp://callback',
+ * });
+ * const { url, codeVerifier } = await auth.getAuthorizationUrl({ state: 'random' });
+ * // open system browser to url ...
+ * await auth.exchangeCode({ code: 'CODE', codeVerifier });
+ * const client = new FrameioClient({ token: () => auth.getToken() });
+ * ```
+ */
+export class NativeAppAuth extends SPAAuth {
+}

package/dist/esm/oauth/SPAAuth.d.mts

@@ -0,0 +1,38 @@
+/**
+ * Single Page App authentication (authorization_code + PKCE).
+ *
+ * Use for browser-based apps that cannot store a client secret.
+ */
+import { BaseAuth, type BaseAuthOptions } from "./BaseAuth";
+import type { TokenResponse } from "./TokenManager";
+/** Returned by `getAuthorizationUrl` — contains the URL and PKCE verifier. */
+export interface AuthorizationUrlResult {
+    url: string;
+    codeVerifier: string;
+}
+export type SPAAuthOptions = BaseAuthOptions & {
+    redirectUri: string;
+};
+export declare class SPAAuth extends BaseAuth {
+    protected readonly _redirectUri: string;
+    protected readonly _scopes: string;
+    constructor(options: SPAAuthOptions);
+    /**
+     * Build the Adobe IMS authorization URL with PKCE challenge.
+     *
+     * @returns Object with `url` and `codeVerifier` (store the verifier for exchange).
+     */
+    getAuthorizationUrl(options: {
+        state: string;
+    }): Promise<AuthorizationUrlResult>;
+    /**
+     * Exchange an authorization code + PKCE verifier for tokens.
+     */
+    exchangeCode(options: {
+        code: string;
+        codeVerifier: string;
+    }): Promise<TokenResponse>;
+    /** Manually trigger a token refresh. */
+    refresh(): Promise<TokenResponse>;
+    protected _refresh(): Promise<TokenResponse>;
+}

package/dist/esm/oauth/SPAAuth.mjs

@@ -0,0 +1,92 @@
+/**
+ * Single Page App authentication (authorization_code + PKCE).
+ *
+ * Use for browser-based apps that cannot store a client secret.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { BaseAuth } from "./BaseAuth";
+import { ConfigurationError } from "./errors";
+import { DEFAULT_SCOPES } from "./http";
+import { generateCodeChallenge, generateCodeVerifier } from "./pkce";
+import { validateRedirectUriScheme } from "./validation";
+export class SPAAuth extends BaseAuth {
+    constructor(options) {
+        var _a;
+        if (!options.redirectUri) {
+            throw new ConfigurationError("redirectUri is required");
+        }
+        validateRedirectUriScheme(options.redirectUri);
+        super(options);
+        this._redirectUri = options.redirectUri;
+        this._scopes = (_a = options.scopes) !== null && _a !== void 0 ? _a : DEFAULT_SCOPES;
+    }
+    /**
+     * Build the Adobe IMS authorization URL with PKCE challenge.
+     *
+     * @returns Object with `url` and `codeVerifier` (store the verifier for exchange).
+     */
+    getAuthorizationUrl(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const codeVerifier = generateCodeVerifier();
+            const codeChallenge = yield generateCodeChallenge(codeVerifier);
+            const params = new URLSearchParams({
+                client_id: this._clientId,
+                redirect_uri: this._redirectUri,
+                scope: this._scopes,
+                response_type: "code",
+                state: options.state,
+                code_challenge: codeChallenge,
+                code_challenge_method: "S256",
+            });
+            return {
+                url: `${this._authorizeUrl}?${params.toString()}`,
+                codeVerifier,
+            };
+        });
+    }
+    /**
+     * Exchange an authorization code + PKCE verifier for tokens.
+     */
+    exchangeCode(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._tokenRequest({
+                grant_type: "authorization_code",
+                client_id: this._clientId,
+                code: options.code,
+                redirect_uri: this._redirectUri,
+                code_verifier: options.codeVerifier,
+            });
+            this._storeTokens(result);
+            return result;
+        });
+    }
+    /** Manually trigger a token refresh. */
+    refresh() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._refresh();
+            this._storeTokens(result);
+            return result;
+        });
+    }
+    _refresh() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const refreshTok = this._tokenManager.refreshTokenValue;
+            if (!refreshTok) {
+                throw new ConfigurationError("No refresh token available. Call exchangeCode() first.");
+            }
+            return this._tokenRequest({
+                grant_type: "refresh_token",
+                client_id: this._clientId,
+                refresh_token: refreshTok,
+            });
+        });
+    }
+}