@ogcio/building-blocks-sdk 0.1.5 → 0.1.7

package/src/client/clients/payments/schema.ts

@@ -125,23 +125,6 @@ export interface paths {
                                 id: string;
                                 name: string;
                                 type: "banktransfer" | "openbanking" | "stripe" | "realex" | "worldpay";
-                                data: {
-                                    iban: string;
-                                    accountHolderName: string;
-                                } | {
-                                    iban: string;
-                                    accountHolderName: string;
-                                } | {
-                                    livePublishableKey: string;
-                                    liveSecretKey: string;
-                                    webhookSigningKey?: string;
-                                } | {
-                                    merchantCode: string;
-                                    installationId: string;
-                                } | {
-                                    merchantId: string;
-                                    sharedSecret: string;
-                                };
                                 status: "connected" | "disconnected";
                             }[];
                             metadata?: {
@@ -349,6 +332,7 @@ export interface paths {
                                 id: string;
                                 name: string;
                                 type: "banktransfer" | "openbanking" | "stripe" | "realex" | "worldpay";
+                                status: "connected" | "disconnected";
                                 data: {
                                     iban: string;
                                     accountHolderName: string;
@@ -366,7 +350,6 @@ export interface paths {
                                     merchantId: string;
                                     sharedSecret: string;
                                 };
-                                status: "connected" | "disconnected";
                             };
                             metadata?: {
                                 /** @description Object containing the links to the related endpoints */
@@ -877,6 +860,86 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/requests/external-info": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: {
+                    offset?: number;
+                    limit?: number;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                paymentRequestId: string;
+                                title: string;
+                                description?: string;
+                                amount?: number;
+                                allowAmountOverride: boolean;
+                                createdAt: string;
+                            }[];
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    last: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /** @description Number representing the total number of available items */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/requests/{requestId}": {
         parameters: {
             query?: never;

package/src/client/clients/profile/index.ts

@@ -10,8 +10,8 @@ export class Profile extends BaseClient<paths> {
 
   async getAddresses() {
     return this.client.GET("/api/v1/addresses/").then(
-      (response) => formatResponse(response),
-      (reason) => formatError(reason),
+      (response) => formatResponse(response, this.serviceName, this.logger),
+      (reason) => formatError(reason, this.serviceName, this.logger),
     );
   }
 
@@ -21,8 +21,8 @@ export class Profile extends BaseClient<paths> {
         params: { path: { addressId } },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -34,8 +34,8 @@ export class Profile extends BaseClient<paths> {
         body: data,
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -54,8 +54,8 @@ export class Profile extends BaseClient<paths> {
         body: data,
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -69,8 +69,8 @@ export class Profile extends BaseClient<paths> {
         body: data,
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -80,15 +80,15 @@ export class Profile extends BaseClient<paths> {
         params: { path: { addressId } },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
   async getEntitlements() {
     return this.client.GET("/api/v1/entitlements/").then(
-      (response) => formatResponse(response),
-      (reason) => formatError(reason),
+      (response) => formatResponse(response, this.serviceName, this.logger),
+      (reason) => formatError(reason, this.serviceName, this.logger),
     );
   }
 
@@ -98,8 +98,8 @@ export class Profile extends BaseClient<paths> {
         params: { path: { userId } },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -111,8 +111,8 @@ export class Profile extends BaseClient<paths> {
         body: data,
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -126,8 +126,8 @@ export class Profile extends BaseClient<paths> {
         body: data,
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -146,8 +146,8 @@ export class Profile extends BaseClient<paths> {
         body: data,
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -161,8 +161,8 @@ export class Profile extends BaseClient<paths> {
         },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -174,8 +174,8 @@ export class Profile extends BaseClient<paths> {
         body: { ids },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 }

package/src/client/clients/scheduler/index.ts

@@ -20,8 +20,8 @@ export class Scheduler extends BaseClient<paths> {
         body: tasks,
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 }

package/src/client/clients/upload/index.ts

@@ -25,8 +25,8 @@ export class Upload extends BaseClient<paths> {
         },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -63,8 +63,8 @@ export class Upload extends BaseClient<paths> {
         params: { query: { userId, organizationId } },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -74,8 +74,8 @@ export class Upload extends BaseClient<paths> {
         params: { path: { id, organizationId } },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -85,8 +85,8 @@ export class Upload extends BaseClient<paths> {
         body: { fileId: id },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -100,8 +100,8 @@ export class Upload extends BaseClient<paths> {
         },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -111,8 +111,8 @@ export class Upload extends BaseClient<paths> {
         body: { fileId, userId },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 
@@ -122,8 +122,8 @@ export class Upload extends BaseClient<paths> {
         body: { fileId, userId },
       })
       .then(
-        (response) => formatResponse(response),
-        (reason) => formatError(reason),
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
 

package/src/client/utils/client-utils.ts

@@ -6,6 +6,7 @@ import type {
   ResponseContent,
   ResponseObjectMap,
 } from "openapi-typescript-helpers";
+import type { Logger } from "../../types/index.js";
 
 export interface PaginationParams {
   offset?: string | number;
@@ -52,12 +53,18 @@ export function preparePaginationParams(paginationParams?: PaginationParams): {
 // biome-ignore lint/suspicious/noExplicitAny: <explanation>
 export function formatResponse<G extends Record<string | number, any>, O>(
   response: FetchResponse<G, O, "application/json">,
+  serviceName: string,
+  logger?: Logger,
 ): DataResponseValue<G, O> {
   let outputData = undefined;
   let outputMetadata = undefined;
+
   if (!response) {
+    logger?.debug(`${serviceName} - Undefined response`);
     return {} as DataResponseValue<G, O>;
   }
+
+  logger?.debug({ rawResponse: response }, `${serviceName} - Raw response`);
   if (response.data) {
     const dataEntries = Object.entries(response.data);
     // by docs the body should contain a "data"
@@ -71,13 +78,24 @@ export function formatResponse<G extends Record<string | number, any>, O>(
     outputData = containsData ? containsData[1] : response.data;
   }
 
-  return {
+  const formattedResponse = {
     data: outputData,
     metadata: outputMetadata,
     error: response.error,
   } as unknown as DataResponseValue<G, O>;
+
+  logger?.debug({ formattedResponse }, `${serviceName} - Formatted response`);
+
+  return formattedResponse;
 }
 
-export function formatError<G, O>(reason: unknown): DataResponseValue<G, O> {
+export function formatError<G, O>(
+  reason: unknown,
+  serviceName: string,
+  logger?: Logger,
+): DataResponseValue<G, O> {
+  if (logger) {
+    logger.debug({ reason }, `${serviceName} - Got error`);
+  }
   return { error: reason } as unknown as DataResponseValue<G, O>;
 }

package/src/index.ts

@@ -1,23 +1,26 @@
 import { Analytics } from "@ogcio/analytics-sdk";
 import { FeatureFlags } from "./client/clients/featureFlags/index.js";
 
+import { Journey } from "./client/clients/journey/index.js";
 import { Messaging } from "./client/clients/messaging/index.js";
 import { Payments } from "./client/clients/payments/index.js";
 import { Profile } from "./client/clients/profile/index.js";
 import { Scheduler } from "./client/clients/scheduler/index.js";
 import { Upload } from "./client/clients/upload/index.js";
-import { Journey } from "./client/clients/journey/index.js";
 export { getM2MTokenFn } from "./client/auth/index.js";
 
 import type {
   BuildingBlockSDKParams,
   BuildingBlocksSDK,
+  Logger,
   Services,
   TokenFunction,
 } from "./types/index.js";
 
+export type { TokenFunction, BuildingBlocksSDK } from "./types/index.js";
+
 // Create type that only includes services that are defined in params
-type DefinedServices<T extends BuildingBlockSDKParams> = {
+export type DefinedServices<T extends BuildingBlockSDKParams> = {
   [K in keyof BuildingBlocksSDK as K extends keyof T["services"]
     ? T["services"][K] extends undefined
       ? never
@@ -27,33 +30,35 @@ type DefinedServices<T extends BuildingBlockSDKParams> = {
 
 const createService = <K extends keyof Services>(
   ServiceClass: new (
-    config: Services[K] & { getTokenFn: TokenFunction },
+    config: Services[K] & { getTokenFn: TokenFunction; logger?: Logger },
   ) => BuildingBlocksSDK[K],
   config: Services[K] | undefined,
   getTokenFn: TokenFunction,
+  logger?: Logger,
 ): BuildingBlocksSDK[K] | undefined => {
   if (!config) return undefined;
-  return new ServiceClass({ ...config, getTokenFn });
+  return new ServiceClass({ ...config, getTokenFn, logger });
 };
 
 export const getBuildingBlockSDK = <T extends BuildingBlockSDKParams>(
   params: T,
 ): DefinedServices<T> => {
-  const { services, getTokenFn } = params;
+  const { services, getTokenFn, logger } = params;
 
   const sdk = {
-    analytics: createService(Analytics, services.analytics, getTokenFn),
-    messaging: createService(Messaging, services.messaging, getTokenFn),
-    payments: createService(Payments, services.payments, getTokenFn),
-    profile: createService(Profile, services.profile, getTokenFn),
-    scheduler: createService(Scheduler, services.scheduler, getTokenFn),
-    upload: createService(Upload, services.upload, getTokenFn),
+    analytics: createService(Analytics, services.analytics, getTokenFn, logger),
+    messaging: createService(Messaging, services.messaging, getTokenFn, logger),
+    payments: createService(Payments, services.payments, getTokenFn, logger),
+    profile: createService(Profile, services.profile, getTokenFn, logger),
+    scheduler: createService(Scheduler, services.scheduler, getTokenFn, logger),
+    upload: createService(Upload, services.upload, getTokenFn, logger),
     featureFlags: createService(
       FeatureFlags,
       services.featureFlags,
       getTokenFn,
+      logger,
     ),
-    journey: createService(Journey, services.journey, getTokenFn),
+    journey: createService(Journey, services.journey, getTokenFn, logger),
   };
 
   // Remove undefined services

package/src/types/index.ts

@@ -1,12 +1,12 @@
 import type { Analytics, AnalyticsOptions } from "@ogcio/analytics-sdk";
 
 import type { FeatureFlags } from "../client/clients/featureFlags/index.js";
+import type { Journey } from "../client/clients/journey/index.js";
 import type { Messaging } from "../client/clients/messaging/index.js";
 import type { Payments } from "../client/clients/payments/index.js";
 import type { Profile } from "../client/clients/profile/index.js";
 import type { Scheduler } from "../client/clients/scheduler/index.js";
 import type { Upload } from "../client/clients/upload/index.js";
-import type { Journey } from "../client/clients/journey/index.js";
 
 const ANALYTICS = "analytics" as const;
 const MESSAGING = "messaging" as const;
@@ -87,9 +87,26 @@ type M2MTokenFnConfig = {
   };
 };
 
+interface LogFn {
+  <T extends object>(obj: T, msg?: string, ...args: unknown[]): void;
+  (obj: unknown, msg?: string, ...args: unknown[]): void;
+  (msg: string, ...args: unknown[]): void;
+}
+
+export type Logger = {
+  fatal: LogFn;
+  error: LogFn;
+  warn: LogFn;
+  info: LogFn;
+  debug: LogFn;
+  trace: LogFn;
+  silent: LogFn;
+};
+
 interface BuildingBlockSDKParams {
   services: Services;
   getTokenFn: TokenFunction;
+  logger?: Logger;
 }
 
 interface BuildingBlocksSDK {