@commercetools/connect-payments-sdk 0.0.1

package/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: |
+            - recursive: true
+              args: [--frozen-lockfile, --strict-peer-dependencies]
+
+      - name: Build
+        run: pnpm run build
+
+      - name: Static code analysis
+        run: pnpm run lint
+
+      - name: Tests
+        run: pnpm run test

package/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  publish-gpr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: |
+            - recursive: true
+              args: [--frozen-lockfile, --strict-peer-dependencies]
+
+      - name: Static code analysis
+        run: pnpm run lint
+
+      - name: Tests
+        run: pnpm run test
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          # This expects you to have a script called release which does a build for your packages and calls changeset publish
+          publish: pnpm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      
+      - name: Create release
+        if: steps.changesets.outputs.published == 'true'
+        # You can do something when a publish happens.
+        run: VERSION=$(jq '.version' package.json -r);gh release create "$VERSION" --title "$VERSION [@commercetools/connect-payments-sdk]" --notes 'Check CHANGELOG.md file.'

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+pnpm run format && pnpm run lint

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @commercetools/connect-payments-sdk
+
+## 0.0.1
+
+### Patch Changes
+
+- c489d1a: Initial commit

package/README.md

@@ -0,0 +1,19 @@
+# @commercetools/connect-payments-sdk
+
+This is the SDK for integrating payments with commercetools platform using TypeScript.
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install @commercetools/connect-payments-sdk
+```
+
+## Usage 
+
+First, import the SDK:
+
+```typescript
+import { setupPaymentSDK } from '@commercetools/connect-payments-sdk';
+```

package/dist/api/context/request-context.provider.d.ts

@@ -0,0 +1,14 @@
+import { ContextProvider, RequestContextData } from './types/request-context.type';
+/**
+ * ContextProvider is a class that provides a way to access and update the context data.
+ */
+export declare class RequestContextProvider implements ContextProvider<RequestContextData> {
+    private getContextFn;
+    private updateContextFn;
+    constructor(opts: {
+        getContextFn: () => RequestContextData;
+        updateContextFn: (ctx: Partial<RequestContextData>) => void;
+    });
+    getContextData(): RequestContextData;
+    updateContextData(ctx: Partial<RequestContextData>): void;
+}

package/dist/api/context/request-context.provider.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestContextProvider = void 0;
+/**
+ * ContextProvider is a class that provides a way to access and update the context data.
+ */
+class RequestContextProvider {
+    getContextFn;
+    updateContextFn;
+    constructor(opts) {
+        this.getContextFn = opts.getContextFn;
+        this.updateContextFn = opts.updateContextFn;
+    }
+    getContextData() {
+        return this.getContextFn();
+    }
+    updateContextData(ctx) {
+        this.updateContextFn(ctx);
+    }
+}
+exports.RequestContextProvider = RequestContextProvider;

package/dist/api/context/types/request-context.type.d.ts

@@ -0,0 +1,16 @@
+import { PaymentSessionData } from '../../../security';
+/**
+ * Context provider interface
+ */
+export interface ContextProvider<T> {
+    getContextData(): T;
+    updateContextData(ctx: Partial<T>): void;
+}
+/**
+ * Request context data
+ */
+export type RequestContextData = {
+    correlationId: string;
+    requestId: string;
+    sessionData?: PaymentSessionData;
+};

package/dist/api/context/types/request-context.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/handlers/config.handler.d.ts

@@ -0,0 +1,4 @@
+import { HandlerResponse } from './types/handler.type';
+export declare const configHandler: (options: {
+    configuration: () => Promise<object> | object;
+}) => () => Promise<HandlerResponse>;

package/dist/api/handlers/config.handler.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configHandler = void 0;
+const configHandler = (options) => async () => {
+    return {
+        status: 200,
+        body: await options.configuration(),
+    };
+};
+exports.configHandler = configHandler;

package/dist/api/handlers/status.handler.d.ts

@@ -0,0 +1,25 @@
+import { Oauth2Service } from '../../security/types/oauth2.type';
+import { HandlerResponse } from './types/handler.type';
+export type HealthCheckResult = {
+    name: string;
+    status: 'UP' | 'DOWN';
+    details?: object;
+};
+export type HealthCheck = () => Promise<HealthCheckResult> | HealthCheckResult;
+export declare const statusHandler: (options: {
+    timeout: number;
+    checks: HealthCheck[];
+    metadataFn?: () => Promise<object> | object;
+}) => () => Promise<HandlerResponse>;
+/**
+ * Check if CoCo permissions are available
+ * @param opts
+ * @returns
+ */
+export declare const healthCheckCoCoPermissions: (opts: {
+    oauth2Service: Oauth2Service;
+    clientId: string;
+    clientSecret: string;
+    projectKey: string;
+    requiredPermissions: string[];
+}) => () => Promise<HealthCheckResult>;

package/dist/api/handlers/status.handler.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.healthCheckCoCoPermissions = exports.statusHandler = void 0;
+const statusHandler = (options) => async () => {
+    const status = {
+        timestamp: new Date().toISOString(),
+        version: process.env.npm_package_version ?? '0.0.0',
+    };
+    if (options.metadataFn) {
+        status.metadata = await options.metadataFn();
+    }
+    let timeoutId = null;
+    const timeoutPromise = new Promise((_, reject) => (timeoutId = setTimeout(() => reject(new Error('Timeout')), options.timeout)));
+    try {
+        const results = await Promise.race([Promise.all(options.checks.map((check) => check())), timeoutPromise]);
+        if (results.findIndex((result) => result.status === 'DOWN') !== -1) {
+            status.status = 'Partially Available';
+        }
+        else {
+            status.status = 'OK';
+        }
+        status.checks = results;
+        return {
+            status: 200,
+            body: status,
+        };
+    }
+    catch (error) {
+        status.status = 'Unavailable';
+        status.checks = [];
+        return {
+            status: 503,
+            body: status,
+        };
+    }
+    finally {
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+    }
+};
+exports.statusHandler = statusHandler;
+/**
+ * Check if CoCo permissions are available
+ * @param opts
+ * @returns
+ */
+const healthCheckCoCoPermissions = (opts) => async () => {
+    const token = await opts.oauth2Service.getAccessToken({
+        clientId: opts.clientId,
+        clientSecret: opts.clientSecret,
+    });
+    const foundAll = opts.requiredPermissions.every((currentScope) => token.scope.split(' ').some((scopeInToken) => scopeInToken === `${currentScope}:${opts.projectKey}`));
+    if (foundAll) {
+        return {
+            name: 'CoCo Permissions',
+            status: 'UP',
+            details: {
+                scope: token.scope,
+            },
+        };
+    }
+    return {
+        name: 'CoCo Permissions',
+        status: 'DOWN',
+        details: {
+            expectedScopes: opts.requiredPermissions,
+            actualScopes: token.scope,
+            reason: 'scopes not available',
+        },
+    };
+};
+exports.healthCheckCoCoPermissions = healthCheckCoCoPermissions;

package/dist/api/handlers/types/handler.type.d.ts

@@ -0,0 +1,5 @@
+export type HandlerResponse = {
+    status: number;
+    body?: object;
+    headers?: object;
+};

package/dist/api/handlers/types/handler.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/hooks/session-auth.hook.d.ts

@@ -0,0 +1,15 @@
+import { IncomingHttpHeaders } from 'node:http';
+import { SessionAuthenticator } from '../../security/types/session.type';
+import { ContextProvider, RequestContextData } from '../context/types/request-context.type';
+export type SessionAuthHookOptions = {
+    sessionAuthenticator: SessionAuthenticator;
+    contextProvider: ContextProvider<RequestContextData>;
+};
+/**
+ * Fastify hook to authenticate and getting session information
+ * @param opts
+ * @returns
+ */
+export declare const sessionAuthHook: (opts: SessionAuthHookOptions) => (req: {
+    headers: IncomingHttpHeaders;
+}) => Promise<void>;

package/dist/api/hooks/session-auth.hook.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sessionAuthHook = void 0;
+const errorx_1 = require("../../errorx/errorx");
+/**
+ * Fastify hook to authenticate and getting session information
+ * @param opts
+ * @returns
+ */
+const sessionAuthHook = (opts) => async (req) => {
+    const sessionId = req.headers['x-session-id'];
+    if (sessionId) {
+        const sessionData = await opts.sessionAuthenticator.introspectSession({
+            sessionId,
+        });
+        opts.contextProvider.updateContextData({
+            sessionData,
+        });
+        //updateSessionContext(sessionData);
+    }
+    else {
+        //TODO: throw a forbidden error
+        throw new errorx_1.ErrorAuthErrorResponse({
+            privateMessage: 'Session is not valid',
+            fields: {
+                id: sessionId,
+            },
+        });
+    }
+};
+exports.sessionAuthHook = sessionAuthHook;

package/dist/api/index.d.ts

@@ -0,0 +1,5 @@
+export * from './context/request-context.provider';
+export * from './context/types/request-context.type';
+export * from './handlers/config.handler';
+export * from './handlers/status.handler';
+export * from './hooks/session-auth.hook';

package/dist/api/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./context/request-context.provider"), exports);
+__exportStar(require("./context/types/request-context.type"), exports);
+__exportStar(require("./handlers/config.handler"), exports);
+__exportStar(require("./handlers/status.handler"), exports);
+__exportStar(require("./hooks/session-auth.hook"), exports);

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

@@ -0,0 +1,7 @@
+import { ClientResponse } from '@commercetools/platform-sdk';
+import { APIOpts, CommercetoolsClient } from '../types/api.type';
+export declare abstract class CommercetoolsBaseAPI {
+    protected client: CommercetoolsClient;
+    constructor(opts: APIOpts);
+    protected executeCall<T>(cr: Promise<ClientResponse<T>>): Promise<T>;
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommercetoolsBaseAPI = void 0;
+const ct_api_error_1 = require("../errors/ct-api.error");
+class CommercetoolsBaseAPI {
+    client;
+    constructor(opts) {
+        this.client = opts.client;
+    }
+    async executeCall(cr) {
+        try {
+            return (await cr).body;
+        }
+        catch (e) {
+            if (e instanceof Object && 'statusCode' in e) {
+                throw new ct_api_error_1.CommercetoolsAPIError(e);
+            }
+            throw e;
+        }
+    }
+}
+exports.CommercetoolsBaseAPI = CommercetoolsBaseAPI;

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

@@ -0,0 +1,8 @@
+import { Cart } from '@commercetools/platform-sdk';
+import { APIOpts, AddPayment, CartAPI } from '../types/api.type';
+import { CommercetoolsBaseAPI } from './base-api';
+export declare class CommercetoolsCartAPI extends CommercetoolsBaseAPI implements CartAPI {
+    constructor(opts: APIOpts);
+    getCartById(id: string): Promise<Cart>;
+    addPayment(opts: AddPayment): Promise<Cart>;
+}

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommercetoolsCartAPI = void 0;
+const base_api_1 = require("./base-api");
+class CommercetoolsCartAPI extends base_api_1.CommercetoolsBaseAPI {
+    constructor(opts) {
+        super(opts);
+        Object.setPrototypeOf(this, CommercetoolsCartAPI.prototype);
+    }
+    async getCartById(id) {
+        return this.executeCall(this.client.carts().withId({ ID: id }).get().execute());
+    }
+    async addPayment(opts) {
+        return this.executeCall(this.client
+            .carts()
+            .withId({ ID: opts.resource.id })
+            .post({
+            body: {
+                version: opts.resource.version,
+                actions: [
+                    {
+                        action: 'addPayment',
+                        payment: {
+                            id: opts.paymentId,
+                            typeId: 'payment',
+                        },
+                    },
+                ],
+            },
+        })
+            .execute());
+    }
+}
+exports.CommercetoolsCartAPI = CommercetoolsCartAPI;

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

@@ -0,0 +1,10 @@
+import { Payment, PaymentDraft, PaymentPagedQueryResponse } from '@commercetools/platform-sdk';
+import { APIOpts, PaymentAPI, UpdatePayment } from '../types/api.type';
+import { CommercetoolsBaseAPI } from './base-api';
+export declare class CommercetoolsPaymentAPI extends CommercetoolsBaseAPI implements PaymentAPI {
+    constructor(opts: APIOpts);
+    getPaymentById(id: string): Promise<Payment>;
+    find(queryPredicate: string): Promise<PaymentPagedQueryResponse>;
+    createPayment(paymentDraft: PaymentDraft): Promise<Payment>;
+    updatePayment(opts: UpdatePayment): Promise<Payment>;
+}

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommercetoolsPaymentAPI = void 0;
+const base_api_1 = require("./base-api");
+class CommercetoolsPaymentAPI extends base_api_1.CommercetoolsBaseAPI {
+    constructor(opts) {
+        super(opts);
+        Object.setPrototypeOf(this, CommercetoolsPaymentAPI.prototype);
+    }
+    async getPaymentById(id) {
+        return this.executeCall(this.client.payments().withId({ ID: id }).get().execute());
+    }
+    async find(queryPredicate) {
+        return this.executeCall(this.client
+            .payments()
+            .get({ queryArgs: { where: queryPredicate } })
+            .execute());
+    }
+    async createPayment(paymentDraft) {
+        return this.executeCall(this.client
+            .payments()
+            .post({
+            body: paymentDraft,
+        })
+            .execute());
+    }
+    async updatePayment(opts) {
+        return this.executeCall(this.client
+            .payments()
+            .withId({ ID: opts.resource.id })
+            .post({
+            body: {
+                version: opts.resource.version,
+                actions: opts.actions,
+            },
+        })
+            .execute());
+    }
+}
+exports.CommercetoolsPaymentAPI = CommercetoolsPaymentAPI;

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

@@ -0,0 +1,15 @@
+import { ContextProvider, RequestContextData } from '../../api';
+import { CartAPI, CommercetoolsAPI, CommercetoolsClient, PaymentAPI } from '../types/api.type';
+export declare class DefaultCommercetoolsAPI implements CommercetoolsAPI {
+    client: CommercetoolsClient;
+    cart: CartAPI;
+    payment: PaymentAPI;
+    constructor(opts: {
+        clientId: string;
+        clientSecret: string;
+        authUrl: string;
+        apiUrl: string;
+        projectKey: string;
+        contextProvider: ContextProvider<RequestContextData>;
+    });
+}

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

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultCommercetoolsAPI = void 0;
+const platform_sdk_1 = require("@commercetools/platform-sdk");
+const sdk_client_v2_1 = require("@commercetools/sdk-client-v2");
+const cart_api_1 = require("./cart-api");
+const payment_api_1 = require("./payment-api");
+class DefaultCommercetoolsAPI {
+    client;
+    cart;
+    payment;
+    constructor(opts) {
+        this.client = createClient(opts);
+        this.cart = new cart_api_1.CommercetoolsCartAPI({ client: this.client });
+        this.payment = new payment_api_1.CommercetoolsPaymentAPI({ client: this.client });
+    }
+}
+exports.DefaultCommercetoolsAPI = DefaultCommercetoolsAPI;
+const createClient = (opts) => {
+    const authMiddlewareOptions = {
+        host: opts.authUrl,
+        projectKey: opts.projectKey,
+        credentials: {
+            clientId: opts.clientId,
+            clientSecret: opts.clientSecret,
+        },
+    };
+    const httpMiddlewareOptions = {
+        host: opts.apiUrl,
+    };
+    const correlationIdMiddlewareOptions = {
+        generate: () => {
+            const correlationID = opts.contextProvider.getContextData().correlationId;
+            return correlationID;
+        },
+    };
+    const ctpClient = new sdk_client_v2_1.ClientBuilder()
+        .withClientCredentialsFlow(authMiddlewareOptions)
+        .withCorrelationIdMiddleware(correlationIdMiddlewareOptions)
+        .withHttpMiddleware(httpMiddlewareOptions)
+        .build();
+    return (0, platform_sdk_1.createApiBuilderFromCtpClient)(ctpClient).withProjectKey({
+        projectKey: opts.projectKey,
+    });
+};

package/dist/commercetools/errors/ct-api.error.d.ts

@@ -0,0 +1,13 @@
+import { Errorx } from '../../errorx/errorx';
+export type CocoErrorType = {
+    body?: {
+        code?: string;
+        message?: string;
+        errors?: object[];
+    };
+    statusCode: number;
+    message?: string;
+};
+export declare class CommercetoolsAPIError extends Errorx {
+    constructor(err: CocoErrorType);
+}

package/dist/commercetools/errors/ct-api.error.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommercetoolsAPIError = void 0;
+const errorx_1 = require("../../errorx/errorx");
+class CommercetoolsAPIError extends errorx_1.Errorx {
+    constructor(err) {
+        super({
+            code: err.body?.code ?? 'CommercetoolsAPIError',
+            message: err?.body?.message ?? err?.message ?? '',
+            httpErrorStatus: err.statusCode,
+            cause: err,
+            fields: err.body?.errors,
+        });
+        this.name = 'CommercetoolsAPIError';
+    }
+}
+exports.CommercetoolsAPIError = CommercetoolsAPIError;

package/dist/commercetools/index.d.ts

@@ -0,0 +1,2 @@
+export { CartService as CommercetoolsCartService } from './types/cart.type';
+export { PaymentService as CommercetoolsPaymentService, TransactionData, UpdatePayment } from './types/payment.type';

package/dist/commercetools/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commercetools/services/ct-cart.service.d.ts

@@ -0,0 +1,14 @@
+import { CartService, CartServiceOptions, GetCart, GetPaymentAmount } from '../types/cart.type';
+import { Cart } from '@commercetools/platform-sdk';
+import { PaymentAmount } from '../types/payment.type';
+import { AddPayment } from '../types/api.type';
+/**
+ * Default implementation of the CartService interface.
+ */
+export declare class DefaultCartService implements CartService {
+    private ctAPI;
+    constructor(opts: CartServiceOptions);
+    getCart(opts: GetCart): Promise<Cart>;
+    getPaymentAmount(opts: GetPaymentAmount): PaymentAmount;
+    addPayment(opts: AddPayment): Promise<Cart>;
+}