@sesamy/sesamy-js 1.120.2 → 1.121.0

package/dist/sesamy-js.d.ts

@@ -5,6 +5,7 @@ import { Contract } from '@sesamy/sdk';
 import { CreateCheckoutParams } from '@sesamy/sdk';
 import { Entitlement } from '@sesamy/sdk';
 import { Fulfillment } from '@sesamy/sdk';
+import { PaywallAccessCheckResult } from '@sesamy/sdk';
 import { PaywallAccessResult } from '@sesamy/sdk';
 import { Profile } from '@sesamy/sdk';
 import { Subscription } from '@sesamy/sdk';
@@ -145,6 +146,18 @@ export declare interface AuthPlugin {
      * are expected to rely on page reloads or their own event wiring.
      */
     refresh?(): Promise<boolean>;
+    /**
+     * The base URL under which the API proxy's `/auth/*` routes live (mirrors the
+     * plugin's own configured `baseUrl`). Implemented by BFF/cookie plugins, where
+     * the access token sits in an HttpOnly cookie that only the proxy can read.
+     *
+     * sesamy-js uses this to route flows that need the access token on a *different*
+     * Sesamy origin (e.g. Spotify linking) through a server-side proxy redirect, so
+     * the token never enters client JS. Returns `null` (or is unimplemented) for
+     * plugins that expose the token to JS directly (e.g. Auth0), where the caller
+     * builds the cross-origin redirect itself.
+     */
+    getProxyAuthBaseUrl?(): string | null;
 }
 
 declare interface BaseContentNode {
@@ -643,6 +656,7 @@ declare function registerAPI(config: ApiConfig): {
     bills: {
         list: () => Promise<{
             id: string;
+            contractId: string;
             items: {
                 sku: string;
                 title: string;
@@ -659,6 +673,7 @@ declare function registerAPI(config: ApiConfig): {
         }[]>;
         get: (id: string) => Promise<{
             id: string;
+            contractId: string;
             items: {
                 sku: string;
                 title: string;
@@ -944,7 +959,9 @@ declare function registerAPI(config: ApiConfig): {
                 purchaseOptionName?: string;
                 name: string;
                 cover?: string;
+                productType: "article" | "audiobook" | "ebook" | "bundle" | "podcast" | "pass" | "publication" | "physical_issue" | "license";
                 purchaseType?: string;
+                isMultiseat: boolean;
             }[];
             status: string;
             isActive: boolean;
@@ -952,11 +969,13 @@ declare function registerAPI(config: ApiConfig): {
             recurringTime?: number;
             willCancelAt: string | null;
             cancelRequestedAt: string | null;
+            cancelReason: string | null;
             expiresAt?: string;
             paymentData?: {
                 method?: string;
                 description?: string;
                 brand?: string;
+                walletType?: string;
             };
             appliedDiscounts: {
                 code: string;
@@ -985,7 +1004,9 @@ declare function registerAPI(config: ApiConfig): {
                 purchaseOptionName?: string;
                 name: string;
                 cover?: string;
+                productType: "article" | "audiobook" | "ebook" | "bundle" | "podcast" | "pass" | "publication" | "physical_issue" | "license";
                 purchaseType?: string;
+                isMultiseat: boolean;
             }[];
             status: string;
             isActive: boolean;
@@ -993,11 +1014,13 @@ declare function registerAPI(config: ApiConfig): {
             recurringTime?: number;
             willCancelAt: string | null;
             cancelRequestedAt: string | null;
+            cancelReason: string | null;
             expiresAt?: string;
             paymentData?: {
                 method?: string;
                 description?: string;
                 brand?: string;
+                walletType?: string;
             };
             appliedDiscounts: {
                 code: string;
@@ -1059,7 +1082,7 @@ declare function registerAPI(config: ApiConfig): {
             url?: string;
             presentationUrl?: string;
             publisherContentId?: string;
-            type: "article" | "pass" | "audiobook" | "ebook" | "bundle" | "podcast" | "publication" | "physical_issue";
+            type: "article" | "audiobook" | "ebook" | "bundle" | "podcast" | "pass" | "publication" | "physical_issue";
             origin?: {
                 type: "EXTERNAL";
                 id: string;
@@ -1108,7 +1131,13 @@ declare function registerAPI(config: ApiConfig): {
             id: string;
             vendorId: string;
             currency: string;
-            version: number;
+            version?: number;
+            name?: string;
+            entity?: string;
+            status?: string;
+            createdAt?: string;
+            modifiedAt?: string;
+            previewUrl?: string;
             settings: {
                 template: "LOGIN" | "BOXES" | "ARTICLE";
                 useDefaultLogo: boolean;
@@ -1119,12 +1148,17 @@ declare function registerAPI(config: ApiConfig): {
                     backgroundColor: string;
                     showBackground: boolean;
                 };
+                displayOptions?: {
+                    enableGift?: boolean;
+                    enableCompany?: boolean;
+                    enableLoginButton?: boolean;
+                };
             };
             showLoginButton: boolean;
             subscriptions: {
                 id: string;
-                sku: string;
-                poId: string;
+                sku?: string;
+                poId?: string;
                 title: string;
                 description: string;
                 price?: number;
@@ -1143,7 +1177,7 @@ declare function registerAPI(config: ApiConfig): {
             mainColor?: string;
             headline?: string;
             logoUrl?: string;
-            footerPaymentMethods: string[];
+            footerPaymentMethods?: string[];
             singlePurchase?: {
                 enabled: boolean;
                 title: string;
@@ -1154,6 +1188,10 @@ declare function registerAPI(config: ApiConfig): {
         checkAccess: (paywallId: string, body: {
             publisherContentId: string;
             url?: string;
+        }) => Promise<PaywallAccessCheckResult>;
+        registerAccess: (paywallId: string, body: {
+            publisherContentId: string;
+            url: string;
         }) => Promise<PaywallAccessResult>;
     };
     paymentIssues: {