@commercetools/connect-payments-sdk 0.28.0 → 1.0.0

package/CHANGELOG.md

@@ -1,8 +1,15 @@
 # @commercetools/connect-payments-sdk
 
+## 1.0.0
+
+### Major Changes
+
+- 9079420: Graduate to stable release
+
 ## 0.28.0
 
 ### Minor Changes
+
 - 9e2f639: chore(deps): upgrade dependencies to latest stable versions, including security patches
 
 ## 0.27.2

package/README.md

@@ -1,19 +1,146 @@
-# @commercetools/connect-payments-sdk [**Early Access**]
+# @commercetools/connect-payments-sdk
 
-This is the SDK for integrating payments with commercetools platform using TypeScript.
+The foundation library for building commercetools payment connectors. It handles all the boilerplate that every connector needs: commercetools API clients, session verification, JWT authentication, request context propagation, custom type management, and retry logic on concurrent modifications so connector authors can focus on PSP-specific business logic.
 
 ## Installation
 
-Install the package using npm:
-
 ```bash
 npm install @commercetools/connect-payments-sdk
 ```
 
-## Usage 
+## Quick start
+
+Call `setupPaymentSDK` once at application startup. It wires together all services and authentication hooks and returns them as a single object.
+
+```typescript
+import {
+  setupPaymentSDK,
+  Logger,
+  RequestContextData,
+} from '@commercetools/connect-payments-sdk';
+import { getRequestContext, updateRequestContext } from './context';
+import { config } from './config';
+
+// Adapt your application logger to the SDK Logger interface
+class AppLogger implements Logger {
+  debug = (obj: object, msg: string) => console.debug(msg, obj);
+  info  = (obj: object, msg: string) => console.info(msg, obj);
+  warn  = (obj: object, msg: string) => console.warn(msg, obj);
+  error = (obj: object, msg: string) => console.error(msg, obj);
+}
+
+export const paymentSDK = setupPaymentSDK({
+  apiUrl:       config.apiUrl,
+  authUrl:      config.authUrl,
+  clientId:     config.clientId,
+  clientSecret: config.clientSecret,
+  projectKey:   config.projectKey,
+  sessionUrl:   config.sessionUrl,
+  checkoutUrl:  config.checkoutUrl,
+  jwksUrl:      config.jwksUrl,
+  jwtIssuer:    config.jwtIssuer,
+
+  // Return the current request context (called on every incoming request)
+  getContextFn: (): RequestContextData => {
+    const { correlationId, requestId, authentication } = getRequestContext();
+    return {
+      correlationId: correlationId || '',
+      requestId:     requestId || '',
+      authentication,
+    };
+  },
+
+  // Merge updated fields back into the request context store
+  updateContextFn: (context: Partial<RequestContextData>) => {
+    updateRequestContext({
+      ...(context.correlationId  ? { correlationId:  context.correlationId  } : {}),
+      ...(context.requestId      ? { requestId:      context.requestId      } : {}),
+      ...(context.authentication ? { authentication: context.authentication } : {}),
+    });
+  },
+
+  logger: new AppLogger(),
+});
+```
+
+## Configuration
+
+| Option | Description |
+|---|---|
+| `apiUrl` | commercetools REST API URL (e.g. `https://api.europe-west1.gcp.commercetools.com`) |
+| `authUrl` | commercetools auth URL (e.g. `https://auth.europe-west1.gcp.commercetools.com`) |
+| `clientId` | commercetools API client ID with `manage_payments`, `view_sessions` and `introspect_oauth_tokens` scopes |
+| `clientSecret` | commercetools API client secret |
+| `projectKey` | commercetools project key |
+| `sessionUrl` | commercetools Session API URL (e.g. `https://session.europe-west1.gcp.commercetools.com`) |
+| `checkoutUrl` | commercetools Checkout API URL (e.g. `https://checkout.europe-west1.gcp.commercetools.com`) |
+| `jwksUrl` | JWKS endpoint used to verify incoming JWTs (e.g. `https://mc-api.europe-west1.gcp.commercetools.com/.well-known/jwks.json`) |
+| `jwtIssuer` | Expected `iss` claim in JWTs issued by commercetools (e.g. `https://mc-api.europe-west1.gcp.commercetools.com`) |
+| `getContextFn` | Function that returns the current `RequestContextData` from your request-scoped store |
+| `updateContextFn` | Function that merges partial data into your request-scoped store (used by the SDK to propagate `correlationId` etc.) |
+| `logger` | Optional. Custom logger implementing the `Logger` interface. Defaults to the built-in commercetools structured logger. |
+
+## What `setupPaymentSDK` returns
+
+```typescript
+const {
+  // commercetools API services
+  ctCartService,           // get carts, calculate payment amounts, add payments
+  ctPaymentService,        // create/update commercetools payments and transactions
+  ctOrderService,          // find orders
+  ctPaymentMethodService,  // manage stored payment methods (tokenization)
+  ctCustomTypeService,     // create/update commercetools custom types (used in post-deploy)
+  ctAuthorizationService,  // obtain OAuth2 tokens for outbound calls
+  ctRecurringPaymentJobService,
+
+  // Raw commercetools API client (escape hatch for unsupported operations)
+  ctAPI,
+
+  // Request context provider
+  contextProvider,
+
+  // Fastify hooks — register these on your routes
+  sessionHeaderAuthHookFn,      // verifies the commercetools session ID from the `x-session-id` header
+  sessionQueryParamAuthHookFn,  // verifies the commercetools session ID from a query parameter
+  jwtAuthHookFn,                // verifies a commercetools-issued JWT
+  oauth2AuthHookFn,             // verifies a connector OAuth2 token
+  authorityAuthorizationHookFn, // checks the caller has the required authority
+} = paymentSDK;
+```
+
+## Custom types
+
+The SDK ships predefined commercetools custom type drafts for storing payment method details. Register them during connector post-deploy:
 
-First, import the SDK:
+```typescript
+import {
+  GenerateCardDetailsCustomFieldsDraft,
+  GenerateSepaDetailsCustomFieldsDraft,
+  GenerateInterfaceInteractionCustomFieldsDraft,
+} from '@commercetools/connect-payments-sdk';
+
+// In post-deploy:
+await paymentSDK.ctCustomTypeService.createOrUpdatePredefinedPaymentMethodTypes();
+await paymentSDK.ctCustomTypeService.createOrUpdatePredefinedInterfaceInteractionType();
+
+// When processing a notification for a card payment:
+const customFields = GenerateCardDetailsCustomFieldsDraft({
+  brand: 'Visa',
+  lastFour: '4242',
+  expiryMonth: 12,
+  expiryYear: 2027,
+});
+```
+
+For connector-specific custom types, use `createOrUpdate` directly:
 
 ```typescript
-import { setupPaymentSDK } from '@commercetools/connect-payments-sdk';
+await paymentSDK.ctCustomTypeService.createOrUpdate(myConnectorTypeDraft);
 ```
+
+## Key behaviours
+
+- **Consolidated payment updates** — `ctPaymentService.updatePayment` handles PSP reference, interface interactions, transaction state transitions, payment method info and custom fields in a single commercetools API call, so you never need to chain multiple update requests for a single PSP notification.
+- **Retry on concurrent modification** — `ctCartService.addPayment` and `ctPaymentService.updatePayment` automatically retry with a fresh version on HTTP 409.
+- **Planned payment amount** — `ctCartService.getPlannedPaymentAmount` deducts already-approved payments from the cart total, so you always get the remaining amount to charge. Pass `expand: ['paymentInfo.payments[*]']` to `getCart` to avoid N+1 payment fetches.
+- **Request context propagation** — correlation IDs, authentication data and session information flow through every SDK call via `getContextFn`/`updateContextFn`, which you back with a Fastify `AsyncLocalStorage` or equivalent.

package/dist/commercetools/api/cart-api.d.ts

@@ -4,6 +4,6 @@ import { CommercetoolsBaseAPI } from './base-api';
 export declare class CommercetoolsCartAPI extends CommercetoolsBaseAPI implements CartAPI {
     constructor(opts: APIOpts);
     find(queryPredicate: string): Promise<CartPagedQueryResponse>;
-    getCartById(id: string): Promise<Cart>;
+    getCartById(id: string, expand?: string[]): Promise<Cart>;
     addPayment(opts: AddPayment): Promise<Cart>;
 }

package/dist/commercetools/api/cart-api.js

@@ -13,8 +13,12 @@ class CommercetoolsCartAPI extends base_api_1.CommercetoolsBaseAPI {
             .get({ queryArgs: { where: queryPredicate } })
             .execute());
     }
-    async getCartById(id) {
-        return this.executeCall(this.client.carts().withId({ ID: id }).get().execute());
+    async getCartById(id, expand) {
+        return this.executeCall(this.client
+            .carts()
+            .withId({ ID: id })
+            .get({ queryArgs: expand ? { expand } : undefined })
+            .execute());
     }
     async addPayment(opts) {
         return this.executeCall(this.client

package/dist/commercetools/services/ct-cart.service.js

@@ -30,7 +30,7 @@ class DefaultCartService {
         return result.results[0];
     }
     async getCart(opts) {
-        return await this.ctAPI.cart.getCartById(opts.id);
+        return await this.ctAPI.cart.getCartById(opts.id, opts.expand);
     }
     async getPlannedPaymentAmount(opts) {
         const giftCardPlannedAmount = (0, __1.getGiftCardPlannedAmountFromContext)(this.contextProvider.getContextData());

package/dist/commercetools/services/ct-custom-type.service.d.ts

@@ -15,15 +15,15 @@ export declare class DefaultCustomTypeService implements CustomTypeService {
     createOrUpdatePredefinedPaymentMethodTypes(): Promise<Type[]>;
     createOrUpdatePredefinedInterfaceInteractionType(): Promise<Type>;
     /**
-     * Based on the given TypeDraft this will either create or update the custom type in CT based on the provided "key".
+     * Based on the given TypeDraft this will either create or update the custom type in commercetools based on the provided "key".
      *
-     * - if a custom-type by key does not exist in CT then it will create it using the given draft
-     * - if a custom-type by key does exist in CT it will gather a set of update actions to try and sync up the definitions
+     * - if a custom-type by key does not exist in commercetools then it will create it using the given draft
+     * - if a custom-type by key does exist in commercetools it will gather a set of update actions to try and sync up the definitions
      *
      * The update currently supports:
-     * - adding missing field definitions. If the given draft contains field definitions that the custom-type in CT does not have, it will for each missing field definition perform an "addFieldDefinition" update action. Purely by checking the "name" of the field definitions.
+     * - adding missing field definitions. If the given draft contains field definitions that the custom-type in commercetools does not have, it will for each missing field definition perform an "addFieldDefinition" update action. Purely by checking the "name" of the field definitions.
      *
-     * Differences between the TypeDraft and existing custom-type in CT such as are not supported yet but could be added in the future.
+     * Differences between the TypeDraft and existing custom-type in commercetools such as are not supported yet but could be added in the future.
      * - remove field definition if they no longer exist in the TypeDraft
      * - update/sync the possible enum values for a field definition
      * - update/sync the actual field definition properties. Such as "localized label", "type" or "required" value

package/dist/commercetools/services/ct-custom-type.service.js

@@ -33,15 +33,15 @@ class DefaultCustomTypeService {
         return await this.createOrUpdate(custom_types_1.PaymentInterfaceInteractionTypeDraft);
     }
     /**
-     * Based on the given TypeDraft this will either create or update the custom type in CT based on the provided "key".
+     * Based on the given TypeDraft this will either create or update the custom type in commercetools based on the provided "key".
      *
-     * - if a custom-type by key does not exist in CT then it will create it using the given draft
-     * - if a custom-type by key does exist in CT it will gather a set of update actions to try and sync up the definitions
+     * - if a custom-type by key does not exist in commercetools then it will create it using the given draft
+     * - if a custom-type by key does exist in commercetools it will gather a set of update actions to try and sync up the definitions
      *
      * The update currently supports:
-     * - adding missing field definitions. If the given draft contains field definitions that the custom-type in CT does not have, it will for each missing field definition perform an "addFieldDefinition" update action. Purely by checking the "name" of the field definitions.
+     * - adding missing field definitions. If the given draft contains field definitions that the custom-type in commercetools does not have, it will for each missing field definition perform an "addFieldDefinition" update action. Purely by checking the "name" of the field definitions.
      *
-     * Differences between the TypeDraft and existing custom-type in CT such as are not supported yet but could be added in the future.
+     * Differences between the TypeDraft and existing custom-type in commercetools such as are not supported yet but could be added in the future.
      * - remove field definition if they no longer exist in the TypeDraft
      * - update/sync the possible enum values for a field definition
      * - update/sync the actual field definition properties. Such as "localized label", "type" or "required" value
@@ -49,7 +49,7 @@ class DefaultCustomTypeService {
     async createOrUpdate(customTypeDraft) {
         const exists = await this.existsByKey({ key: customTypeDraft.key });
         if (!exists) {
-            this.logger.info({ key: customTypeDraft.key }, 'Custom type by key does not exist in CT, creating it');
+            this.logger.info({ key: customTypeDraft.key }, 'Custom type by key does not exist in commercetools, creating it');
             return await this.create(customTypeDraft);
         }
         const customTypeFromCT = await this.getByKey({ key: customTypeDraft.key });
@@ -83,7 +83,7 @@ class DefaultCustomTypeService {
                 key: customTypeDraft.key,
                 missingFieldsCount: addFieldDefinitionUpdateActions.length,
                 fieldNames: missingFieldDefinitions.map((fd) => fd.name),
-            }, 'Custom type in CT is missing field definition from the draft, adding them');
+            }, 'Custom type in commercetools is missing field definition from the draft, adding them');
         }
         return addFieldDefinitionUpdateActions;
     }

package/dist/commercetools/types/api.type.d.ts

@@ -45,7 +45,7 @@ export interface AuthorizationAPI {
     getToken(): Promise<OauthToken>;
 }
 export interface CartAPI {
-    getCartById(id: string): Promise<Cart>;
+    getCartById(id: string, expand?: string[]): Promise<Cart>;
     find(queryPredicate: string): Promise<CartPagedQueryResponse>;
     addPayment(opts: AddPayment): Promise<Cart>;
 }

package/dist/commercetools/types/cart.type.d.ts

@@ -6,6 +6,8 @@ import { ContextProvider, RequestContextData } from '../../api';
 export type GetCart = {
     id: string;
     version?: number;
+    /** commercetools expand paths to include in the response, e.g. `['paymentInfo.payments[*]']` */
+    expand?: string[];
 };
 export type GetPaymentAmount = {
     cart: Cart;
@@ -39,7 +41,12 @@ export type GetCartByPaymentIdRequest = {
  * Cart service interface exposes methods to interact with the commercetools platform API.
  */
 export interface CartService {
+    /** Finds the cart that contains the given payment ID. Throws if no cart is found. */
     getCartByPaymentId(opts: GetCartByPaymentIdRequest): Promise<Cart>;
+    /**
+     * Returns a cart by ID. Pass `expand` to hydrate referenced resources in a single API call
+     * instead of fetching them individually afterwards (e.g. `['paymentInfo.payments[*]']`).
+     */
     getCart(opts: GetCart): Promise<Cart>;
     /**
      * Get payment amount for a cart. This method is used to calculate the payment amount for a cart.
@@ -54,6 +61,7 @@ export interface CartService {
      * @param opts
      */
     getPlannedPaymentAmount(opts: GetPaymentAmount): Promise<PaymentAmount>;
+    /** Adds a payment reference to the cart. Retries automatically on concurrent modification. */
     addPayment(opts: AddPayment): Promise<Cart>;
     /**
      * Checks if the given cart contains items configured for recurring orders.

package/dist/commercetools/types/custom-type.type.d.ts

@@ -10,11 +10,27 @@ export type UpdateCustomType = {
     updateActions: TypeUpdate;
 };
 export interface CustomTypeService {
+    /** Returns a commercetools custom type by key. Throws if not found. */
     getByKey(opts: GetByKeyCustomType): Promise<Type>;
+    /** Returns true if a commercetools custom type with the given key exists. */
     existsByKey(opts: GetByKeyCustomType): Promise<boolean>;
+    /** Creates a new commercetools custom type from the provided draft. */
     create(draft: TypeDraft): Promise<Type>;
+    /** Applies update actions to an existing commercetools custom type. */
     update(opts: UpdateCustomType): Promise<Type>;
+    /**
+     * Creates the custom type if it does not exist, or adds any field definitions present in
+     * the draft but missing in the existing type. Field removals and type changes are not applied.
+     */
     createOrUpdate(customTypeDraft: TypeDraft): Promise<Type>;
+    /**
+     * Ensures the predefined payment method custom types (card, SEPA) exist in commercetools.
+     * Called during connector post-deploy when `ADYEN_STORE_PAYMENT_METHOD_DETAILS_ENABLED` is true.
+     */
     createOrUpdatePredefinedPaymentMethodTypes(): Promise<Type[]>;
+    /**
+     * Ensures the predefined interface interaction custom type exists in commercetools.
+     * Used to record raw PSP request/response pairs on the commercetools payment.
+     */
     createOrUpdatePredefinedInterfaceInteractionType(): Promise<Type>;
 }

package/dist/commercetools/types/payment.type.d.ts

@@ -47,9 +47,18 @@ export type FindTransaction = {
  * Payment service interface exposes methods to interact with the commercetools platform API.
  */
 export interface PaymentService {
+    /** Returns a payment by ID. Throws if not found. */
     getPayment(opts: GetPayment): Promise<Payment>;
+    /** Finds all payments whose `interfaceId` matches the given PSP reference. */
     findPaymentsByInterfaceId(opts: FindPaymentsByInterfaceId): Promise<Payment[]>;
+    /** Returns true if the payment has at least one transaction of the given type in any of the given states. */
     hasTransactionInState(opts: FindTransaction): boolean;
+    /** Creates a new commercetools payment from the provided draft. */
     createPayment(draft: PaymentDraft): Promise<Payment>;
+    /**
+     * Applies changes to an existing commercetools payment. Handles PSP reference, interface interactions,
+     * transaction state transitions, payment method info and custom fields in a single update call.
+     * Retries automatically on concurrent modification.
+     */
     updatePayment(opts: UpdatePayment): Promise<Payment>;
 }

package/dist/commercetools/types/session.type.d.ts

@@ -23,14 +23,27 @@ export type Session = {
     };
 };
 export interface SessionService {
+    /** Verifies a session ID against the commercetools Session API and returns the session object. Throws if invalid or expired. */
     verifySession(sessionId: string): Promise<Session>;
+    /** Returns the cart ID associated with the session. */
     getCartFromSession(session: Session): string;
+    /** Returns the list of payment method keys the merchant has allowed for this session. */
     getAllowedPaymentMethodsFromSession(session: Session): string[];
+    /** Returns the processor URL stored in the session metadata. */
     getProcessorUrlFromSession(session: Session): string;
+    /** Returns the payment interface identifier stored in the session, if present. */
     getPaymentInterfaceFromSession(session: Session): string | undefined;
+    /** Returns the checkout transaction item ID stored in the session, if present. */
     getCheckoutTransactionItemIdFromSession(session: Session): string | undefined;
+    /** Returns the merchant return URL stored in the session, if present. */
     getMerchantReturnUrlFromSession(session: Session): string | undefined;
+    /** Returns the future order number stored in the session, if present. */
     getFutureOrderNumberFromSession(session: Session): string | undefined;
+    /**
+     * Returns the gift card planned amount stored in the session, if present.
+     * Used by `getPlannedPaymentAmount` to deduct the gift card portion from the total.
+     */
     getGiftCardPlannedAmountFromSession(session: Session): Money | undefined;
+    /** Returns the correlation ID stored in the session, if present. */
     getCorrelationIdFromSession(session: Session): string | undefined;
 }

package/dist/custom-types/payment-interface-interactions.d.ts

@@ -8,4 +8,10 @@ export type InterfaceInteractionFields = {
     response?: string;
     type: string;
 };
+/**
+ * Builds a `CustomFieldsDraft` that records a raw PSP request/response pair as a
+ * `payment-interface-interaction` on a commercetools payment.
+ * Requires the `commercetools-checkout-payment-interface-interaction` custom type to exist
+ * (created by `createOrUpdatePredefinedInterfaceInteractionType`).
+ */
 export declare const GenerateInterfaceInteractionCustomFieldsDraft: (fields: InterfaceInteractionFields) => CustomFieldsDraft;

package/dist/custom-types/payment-interface-interactions.js

@@ -66,6 +66,12 @@ exports.PaymentInterfaceInteractionTypeDraft = {
         },
     ],
 };
+/**
+ * Builds a `CustomFieldsDraft` that records a raw PSP request/response pair as a
+ * `payment-interface-interaction` on a commercetools payment.
+ * Requires the `commercetools-checkout-payment-interface-interaction` custom type to exist
+ * (created by `createOrUpdatePredefinedInterfaceInteractionType`).
+ */
 const GenerateInterfaceInteractionCustomFieldsDraft = (fields) => {
     return {
         type: {

package/dist/custom-types/payment-methods/card.d.ts

@@ -9,4 +9,10 @@ export type CardDetailsFields = {
     expiryYear?: number;
     storePaymentMethod?: boolean;
 };
+/**
+ * Builds a `CustomFieldsDraft` that sets the card details custom fields on a
+ * `payment-method-info` or `payment-method` resource.
+ * Requires the `commercetools-checkout-card-details` custom type to exist (created by
+ * `createOrUpdatePredefinedPaymentMethodTypes`).
+ */
 export declare const GenerateCardDetailsCustomFieldsDraft: (fields: CardDetailsFields) => CustomFieldsDraft;

package/dist/custom-types/payment-methods/card.js

@@ -63,6 +63,12 @@ exports.CardDetailsTypeDraft = {
         shared_1.StorePaymentMethodFieldDefinition,
     ],
 };
+/**
+ * Builds a `CustomFieldsDraft` that sets the card details custom fields on a
+ * `payment-method-info` or `payment-method` resource.
+ * Requires the `commercetools-checkout-card-details` custom type to exist (created by
+ * `createOrUpdatePredefinedPaymentMethodTypes`).
+ */
 const GenerateCardDetailsCustomFieldsDraft = (fields) => {
     return {
         type: {

package/dist/custom-types/payment-methods/sepa.d.ts

@@ -5,4 +5,10 @@ export type SepaDetailsFields = {
     lastFour?: string;
     storePaymentMethod?: boolean;
 };
+/**
+ * Builds a `CustomFieldsDraft` that sets the SEPA details custom fields on a
+ * `payment-method-info` or `payment-method` resource.
+ * Requires the `commercetools-checkout-sepa-details` custom type to exist (created by
+ * `createOrUpdatePredefinedPaymentMethodTypes`).
+ */
 export declare const GenerateSepaDetailsCustomFieldsDraft: (fields: SepaDetailsFields) => CustomFieldsDraft;

package/dist/custom-types/payment-methods/sepa.js

@@ -23,6 +23,12 @@ exports.SepaDetailsTypeDraft = {
         shared_1.StorePaymentMethodFieldDefinition,
     ],
 };
+/**
+ * Builds a `CustomFieldsDraft` that sets the SEPA details custom fields on a
+ * `payment-method-info` or `payment-method` resource.
+ * Requires the `commercetools-checkout-sepa-details` custom type to exist (created by
+ * `createOrUpdatePredefinedPaymentMethodTypes`).
+ */
 const GenerateSepaDetailsCustomFieldsDraft = (fields) => {
     return {
         type: {

package/dist/index.d.ts

@@ -14,6 +14,23 @@ export * from './errorx';
 export * from './logger';
 export * from './security';
 export * from './custom-types';
+/**
+ * Initialises and wires together all SDK services and authentication hooks.
+ * Call this once at application startup and use the returned object throughout the connector.
+ *
+ * @param opts.authUrl - commercetools auth URL (e.g. `https://auth.europe-west1.gcp.commercetools.com`)
+ * @param opts.apiUrl - commercetools API URL
+ * @param opts.sessionUrl - commercetools Session API URL
+ * @param opts.checkoutUrl - commercetools Checkout API URL
+ * @param opts.jwksUrl - JWKS endpoint used to verify incoming JWTs
+ * @param opts.clientId - commercetools API client ID
+ * @param opts.clientSecret - commercetools API client secret
+ * @param opts.projectKey - commercetools project key
+ * @param opts.jwtIssuer - Expected `iss` claim in incoming JWTs
+ * @param opts.getContextFn - Returns the current request context (called on every request)
+ * @param opts.updateContextFn - Merges partial data into the current request context
+ * @param opts.logger - Optional custom logger; defaults to the built-in commercetools logger
+ */
 export declare const setupPaymentSDK: (opts: {
     authUrl: string;
     apiUrl: string;

package/dist/index.js

@@ -35,6 +35,23 @@ __exportStar(require("./errorx"), exports);
 __exportStar(require("./logger"), exports);
 __exportStar(require("./security"), exports);
 __exportStar(require("./custom-types"), exports);
+/**
+ * Initialises and wires together all SDK services and authentication hooks.
+ * Call this once at application startup and use the returned object throughout the connector.
+ *
+ * @param opts.authUrl - commercetools auth URL (e.g. `https://auth.europe-west1.gcp.commercetools.com`)
+ * @param opts.apiUrl - commercetools API URL
+ * @param opts.sessionUrl - commercetools Session API URL
+ * @param opts.checkoutUrl - commercetools Checkout API URL
+ * @param opts.jwksUrl - JWKS endpoint used to verify incoming JWTs
+ * @param opts.clientId - commercetools API client ID
+ * @param opts.clientSecret - commercetools API client secret
+ * @param opts.projectKey - commercetools project key
+ * @param opts.jwtIssuer - Expected `iss` claim in incoming JWTs
+ * @param opts.getContextFn - Returns the current request context (called on every request)
+ * @param opts.updateContextFn - Merges partial data into the current request context
+ * @param opts.logger - Optional custom logger; defaults to the built-in commercetools logger
+ */
 const setupPaymentSDK = (opts) => {
     const contextProvider = new api_1.RequestContextProvider({
         getContextFn: opts.getContextFn,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/connect-payments-sdk",
-  "version": "0.28.0",
+  "version": "1.0.0",
   "description": "Payment SDK for commercetools payment connectors",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,9 +15,9 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "@commercetools-backend/loggers": "27.4.0",
-    "@commercetools/platform-sdk": "8.25.0",
-    "@commercetools/ts-client": "4.9.1",
+    "@commercetools-backend/loggers": "27.6.3",
+    "@commercetools/platform-sdk": "8.27.0",
+    "@commercetools/ts-client": "4.10.0",
     "jsonwebtoken": "9.0.3",
     "jwks-rsa": "3.2.0",
     "lodash": "4.18.1",

package/pnpm-workspace.yaml

@@ -0,0 +1,20 @@
+overrides:
+  handlebars: "4.7.9"
+  jws: "3.2.3"
+  flatted: "3.4.2"
+  "picomatch@^2": "2.3.2"
+  "picomatch@^4": "4.0.4"
+  "minimatch@^3": "3.1.5"
+  "minimatch@^9": "9.0.9"
+  "@babel/helpers": "7.26.10"
+  "js-yaml@^3": "3.14.2"
+  "js-yaml@^4": "4.1.1"
+  "ajv@^6": "6.14.0"
+  "brace-expansion@^1": "1.1.14"
+  "@typescript-eslint/utils": "8.61.0"
+
+allowBuilds:
+  '@swc/core': true
+  core-js-pure: true
+  msw: true
+  unrs-resolver: true