@ogcio/building-blocks-sdk 0.0.26 → 0.1.1

package/src/client/clients/payments/open-api-definition.json

@@ -4052,7 +4052,7 @@
         }
       }
     },
-    "/api/v1/transactions/by-external-id/{extPaymentId}": {
+    "/api/v1/transactions/transactionId/{extPaymentId}": {
       "get": {
         "tags": [
           "Transactions"
@@ -4078,121 +4078,12 @@
                     "data": {
                       "type": "object",
                       "properties": {
-                        "transactionId": {
-                          "type": "string"
-                        },
-                        "status": {
-                          "anyOf": [
-                            {
-                              "type": "string",
-                              "enum": [
-                                "initiated"
-                              ]
-                            },
-                            {
-                              "type": "string",
-                              "enum": [
-                                "pending"
-                              ]
-                            },
-                            {
-                              "type": "string",
-                              "enum": [
-                                "succeeded"
-                              ]
-                            },
-                            {
-                              "type": "string",
-                              "enum": [
-                                "cancelled"
-                              ]
-                            },
-                            {
-                              "type": "string",
-                              "enum": [
-                                "failed"
-                              ]
-                            }
-                          ]
-                        },
-                        "amount": {
-                          "minimum": 1,
-                          "maximum": 1000000,
-                          "type": "number"
-                        },
-                        "extPaymentId": {
-                          "allOf": [
-                            {
-                              "type": "string"
-                            },
-                            {
-                              "type": "string"
-                            }
-                          ]
-                        },
-                        "paymentProviderId": {
-                          "type": "string"
-                        },
-                        "updatedAt": {
-                          "type": "string"
-                        },
-                        "title": {
-                          "type": "string"
-                        },
-                        "userId": {
-                          "type": "string"
-                        },
-                        "metadata": {
-                          "type": "object",
-                          "properties": {
-                            "name": {
-                              "type": "string"
-                            },
-                            "email": {
-                              "type": "string"
-                            },
-                            "runId": {
-                              "type": "string"
-                            },
-                            "journeyId": {
-                              "type": "string"
-                            },
-                            "journeyTitle": {
-                              "type": "string"
-                            }
-                          },
-                          "required": [
-                            "name",
-                            "email"
-                          ]
-                        },
-                        "description": {
-                          "type": "string"
-                        },
-                        "providerName": {
-                          "type": "string"
-                        },
-                        "providerType": {
-                          "type": "string"
-                        },
-                        "paymentRequestId": {
+                        "id": {
                           "type": "string"
                         }
                       },
                       "required": [
-                        "transactionId",
-                        "status",
-                        "amount",
-                        "extPaymentId",
-                        "paymentProviderId",
-                        "updatedAt",
-                        "title",
-                        "userId",
-                        "metadata",
-                        "description",
-                        "providerName",
-                        "providerType",
-                        "paymentRequestId"
+                        "id"
                       ]
                     },
                     "metadata": {
@@ -4316,239 +4207,6 @@
             }
           }
         }
-      },
-      "patch": {
-        "tags": [
-          "Transactions"
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "status": {
-                    "anyOf": [
-                      {
-                        "type": "string",
-                        "enum": [
-                          "initiated"
-                        ]
-                      },
-                      {
-                        "type": "string",
-                        "enum": [
-                          "pending"
-                        ]
-                      },
-                      {
-                        "type": "string",
-                        "enum": [
-                          "succeeded"
-                        ]
-                      },
-                      {
-                        "type": "string",
-                        "enum": [
-                          "cancelled"
-                        ]
-                      },
-                      {
-                        "type": "string",
-                        "enum": [
-                          "failed"
-                        ]
-                      }
-                    ]
-                  }
-                },
-                "required": [
-                  "status"
-                ]
-              }
-            }
-          },
-          "required": true
-        },
-        "parameters": [
-          {
-            "schema": {
-              "type": "string"
-            },
-            "in": "path",
-            "name": "extPaymentId",
-            "required": true
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Default Response",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "data": {
-                      "type": "object",
-                      "properties": {
-                        "transactionId": {
-                          "type": "string"
-                        },
-                        "paymentRequestId": {
-                          "type": "string"
-                        },
-                        "metadata": {
-                          "type": "object",
-                          "properties": {
-                            "name": {
-                              "type": "string"
-                            },
-                            "email": {
-                              "type": "string"
-                            },
-                            "runId": {
-                              "type": "string"
-                            },
-                            "journeyId": {
-                              "type": "string"
-                            },
-                            "journeyTitle": {
-                              "type": "string"
-                            }
-                          },
-                          "required": [
-                            "name",
-                            "email"
-                          ]
-                        }
-                      },
-                      "required": [
-                        "transactionId",
-                        "paymentRequestId",
-                        "metadata"
-                      ]
-                    },
-                    "metadata": {
-                      "type": "object",
-                      "properties": {
-                        "links": {
-                          "description": "Object containing the links to the related endpoints",
-                          "type": "object",
-                          "properties": {
-                            "self": {
-                              "type": "object",
-                              "properties": {
-                                "href": {
-                                  "description": "URL pointing to the request itself",
-                                  "type": "string"
-                                }
-                              }
-                            },
-                            "next": {
-                              "type": "object",
-                              "properties": {
-                                "href": {
-                                  "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
-                                  "type": "string"
-                                }
-                              }
-                            },
-                            "prev": {
-                              "type": "object",
-                              "properties": {
-                                "href": {
-                                  "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
-                                  "type": "string"
-                                }
-                              }
-                            },
-                            "first": {
-                              "type": "object",
-                              "properties": {
-                                "href": {
-                                  "description": "URL pointing to the first page of results in a paginated response",
-                                  "type": "string"
-                                }
-                              }
-                            },
-                            "last": {
-                              "type": "object",
-                              "properties": {
-                                "href": {
-                                  "description": "URL pointing to the first page of results in a paginated response",
-                                  "type": "string"
-                                }
-                              }
-                            },
-                            "pages": {
-                              "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
-                              "type": "object",
-                              "additionalProperties": {
-                                "type": "object",
-                                "properties": {
-                                  "href": {
-                                    "type": "string"
-                                  }
-                                }
-                              }
-                            }
-                          },
-                          "required": [
-                            "self",
-                            "first",
-                            "last",
-                            "pages"
-                          ]
-                        },
-                        "totalCount": {
-                          "description": "Number representing the total number of available items",
-                          "type": "number"
-                        }
-                      }
-                    }
-                  },
-                  "required": [
-                    "data"
-                  ]
-                }
-              }
-            }
-          },
-          "500": {
-            "description": "Default Response",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "code": {
-                      "type": "string"
-                    },
-                    "detail": {
-                      "type": "string"
-                    },
-                    "requestId": {
-                      "type": "string"
-                    },
-                    "name": {
-                      "type": "string"
-                    },
-                    "validation": {},
-                    "validationContext": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "code",
-                    "detail",
-                    "requestId",
-                    "name"
-                  ]
-                }
-              }
-            }
-          }
-        }
       }
     },
     "/api/v1/transactions/": {

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

@@ -1632,7 +1632,7 @@ export interface paths {
         };
         trace?: never;
     };
-    "/api/v1/transactions/by-external-id/{extPaymentId}": {
+    "/api/v1/transactions/transactionId/{extPaymentId}": {
         parameters: {
             query?: never;
             header?: never;
@@ -1658,25 +1658,7 @@ export interface paths {
                     content: {
                         "application/json": {
                             data: {
-                                transactionId: string;
-                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
-                                amount: number;
-                                extPaymentId: string;
-                                paymentProviderId: string;
-                                updatedAt: string;
-                                title: string;
-                                userId: string;
-                                metadata: {
-                                    name: string;
-                                    email: string;
-                                    runId?: string;
-                                    journeyId?: string;
-                                    journeyTitle?: string;
-                                };
-                                description: string;
-                                providerName: string;
-                                providerType: string;
-                                paymentRequestId: string;
+                                id: string;
                             };
                             metadata?: {
                                 /** @description Object containing the links to the related endpoints */
@@ -1737,95 +1719,7 @@ export interface paths {
         delete?: never;
         options?: never;
         head?: never;
-        patch: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path: {
-                    extPaymentId: string;
-                };
-                cookie?: never;
-            };
-            requestBody: {
-                content: {
-                    "application/json": {
-                        status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
-                    };
-                };
-            };
-            responses: {
-                /** @description Default Response */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            data: {
-                                transactionId: string;
-                                paymentRequestId: string;
-                                metadata: {
-                                    name: string;
-                                    email: string;
-                                    runId?: string;
-                                    journeyId?: string;
-                                    journeyTitle?: 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;
-                            };
-                        };
-                    };
-                };
-                /** @description Default Response */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        "application/json": {
-                            code: string;
-                            detail: string;
-                            requestId: string;
-                            name: string;
-                            validation?: unknown;
-                            validationContext?: string;
-                        };
-                    };
-                };
-            };
-        };
+        patch?: never;
         trace?: never;
     };
     "/api/v1/transactions/": {

package/src/index.ts

@@ -6,46 +6,56 @@ 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";
-export type { BuildingBlocksSDK } from "./types/index.js";
 export { getM2MTokenFn } from "./client/auth/index.js";
 
 import type {
   BuildingBlockSDKParams,
   BuildingBlocksSDK,
+  Services,
+  TokenFunction,
 } from "./types/index.js";
 
-export const getBuildingBlockSDK = (
-  params: BuildingBlockSDKParams,
-): BuildingBlocksSDK => {
+// Create type that only includes services that are defined in params
+type DefinedServices<T extends BuildingBlockSDKParams> = {
+  [K in keyof BuildingBlocksSDK as K extends keyof T["services"]
+    ? T["services"][K] extends undefined
+      ? never
+      : K
+    : never]: BuildingBlocksSDK[K];
+};
+
+const createService = <K extends keyof Services>(
+  ServiceClass: new (
+    config: Services[K] & { getTokenFn: TokenFunction },
+  ) => BuildingBlocksSDK[K],
+  config: Services[K] | undefined,
+  getTokenFn: TokenFunction,
+): BuildingBlocksSDK[K] | undefined => {
+  if (!config) return undefined;
+  return new ServiceClass({ ...config, getTokenFn });
+};
+
+export const getBuildingBlockSDK = <T extends BuildingBlockSDKParams>(
+  params: T,
+): DefinedServices<T> => {
   const { services, getTokenFn } = params;
-  return {
-    analytics: new Analytics({
-      ...services.analytics,
-      getTokenFn,
-    }),
-    messaging: new Messaging({
-      ...services.messaging,
-      getTokenFn,
-    }),
-    payments: new Payments({
-      ...services.payments,
-      getTokenFn,
-    }),
-    profile: new Profile({
-      ...services.profile,
-      getTokenFn,
-    }),
-    scheduler: new Scheduler({
-      ...services.scheduler,
-      getTokenFn,
-    }),
-    upload: new Upload({
-      ...services.upload,
-      getTokenFn,
-    }),
-    featureFlags: new FeatureFlags({
-      ...services.featureFlags,
+
+  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),
+    featureFlags: createService(
+      FeatureFlags,
+      services.featureFlags,
       getTokenFn,
-    }),
+    ),
   };
+
+  // Remove undefined services
+  return Object.fromEntries(
+    Object.entries(sdk).filter(([_, value]) => value !== undefined),
+  ) as DefinedServices<T>;
 };