@epilot/erp-integration-client 0.4.1 → 0.5.0

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={390:function(e,t,o){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=n(o(466));t.default=r.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/erp/tracking/acknowledgement":{"post":{"operationId":"acknowledgeTracking","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/trigger":{"post":{"operationId":"triggerErp","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/events":{"post":{"operationId":"processErpUpdatesEvents","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ERPUpdatesResponse":{"content":{"application/json":{}}},"TriggerWebhookResponse":{"content":{"application/json":{}}}}},"servers":[{"url":"https://erp-integration-api.sls.epilot.io"}]}')}},t={},o=function o(n){var r=t[n];if(void 0!==r)return r.exports;var s=t[n]={exports:{}};return e[n].call(s.exports,s,s.exports,o),s.exports}(390),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={330:function(e,t,o){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var r=n(o(466));t.default=r.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/erp/tracking/acknowledgement":{"post":{"operationId":"acknowledgeTracking","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/trigger":{"post":{"operationId":"triggerErp","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/events":{"post":{"operationId":"processErpUpdatesEvents","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMapping","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ERPUpdatesResponse":{"content":{"application/json":{}}},"TriggerWebhookResponse":{"content":{"application/json":{}}}}},"servers":[{"url":"https://erp-integration-api.sls.epilot.io"}]}')}},t={},o=function o(n){var r=t[n];if(void 0!==r)return r.exports;var s=t[n]={exports:{}};return e[n].call(s.exports,s,s.exports,o),s.exports}(330),n=exports;for(var r in o)n[r]=o[r];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -38,6 +38,18 @@
         },
         "responses": {}
       }
+    },
+    "/v1/erp/updates/mapping_simulation": {
+      "post": {
+        "operationId": "simulateMapping",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
     }
   },
   "components": {
@@ -52,11 +64,6 @@
           "application/json": {}
         }
       },
-      "NotFound": {
-        "content": {
-          "application/json": {}
-        }
-      },
       "InternalServerError": {
         "content": {
           "application/json": {}

package/dist/openapi.d.ts

@@ -18,14 +18,13 @@ declare namespace Components {
                  */
                 event_id: string;
                 /**
-                 * Processing status for the event
+                 * Processing status for the event (skipped indicates duplicate deduplication_id)
                  */
-                status: "success" | "error";
+                status: "success" | "error" | "skipped";
                 message?: string;
             }[];
         }
         export type InternalServerError = Schemas.ErrorResponseBase;
-        export type NotFound = Schemas.ErrorResponseBase;
         export type TriggerWebhookResponse = Schemas.TriggerWebhookResp;
         export type Unauthorized = Schemas.ErrorResponseBase;
     }
@@ -162,6 +161,13 @@ declare namespace Paths {
                  * The serialized object data payload (JSON, XML, etc.) as a string
                  */
                 payload: string;
+                /**
+                 * Optional unique identifier for idempotency - prevents duplicate processing of the same event within 24 hours in context of the same app and component. Must contain only alphanumeric characters, hyphens, and underscores.
+                 *
+                 * example:
+                 * evt-2025-05-01-12345-create-bp
+                 */
+                deduplication_id?: string; // ^[a-zA-Z0-9_-]+$
             }[];
         }
         namespace Responses {
@@ -172,6 +178,91 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace SimulateMapping {
+        export interface RequestBody {
+            /**
+             * The integration mapping configuration
+             */
+            mapping_configuration: {
+                mapping: {
+                    /**
+                     * Object type mappings
+                     */
+                    objects: {
+                        [name: string]: {
+                            /**
+                             * Mapping of entity types to their unique identifier field mappings
+                             */
+                            unique_ids: {
+                                [name: string]: {
+                                    [name: string]: string;
+                                };
+                            };
+                            /**
+                             * Field mapping definitions
+                             */
+                            fields: {
+                                /**
+                                 * Target entity slug
+                                 */
+                                entity: string;
+                                /**
+                                 * Target attribute name
+                                 */
+                                attribute: string;
+                                /**
+                                 * Source field name (mutually exclusive with jsonataExpression)
+                                 */
+                                field?: string;
+                                /**
+                                 * JSONata expression for transformation (mutually exclusive with field)
+                                 */
+                                jsonataExpression?: string;
+                            }[];
+                        };
+                    };
+                };
+            };
+            /**
+             * Type of the object being mapped (must match a key in mapping_configuration.mapping.objects)
+             */
+            object_type: string;
+            /**
+             * Format of the payload data
+             */
+            format: "json" | "xml";
+            /**
+             * The serialized object data payload (JSON, XML, etc.) as a string
+             */
+            payload: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                entity_updates: {
+                    /**
+                     * The entity type slug
+                     */
+                    entity_slug: string;
+                    /**
+                     * Unique identifier mappings for this entity
+                     */
+                    uniqueIdentifiers: {
+                        [name: string]: any;
+                    };
+                    /**
+                     * Mapped attribute values
+                     */
+                    attributes: {
+                        [name: string]: any;
+                    };
+                }[];
+            }
+            export type $400 = Components.Responses.BadRequest;
+            export type $401 = Components.Responses.Unauthorized;
+            export type $422 = Components.Schemas.ErrorResponseBase;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace TriggerErp {
         export type RequestBody = Components.Schemas.TriggerErpActionRequest;
         namespace Responses {
@@ -218,6 +309,16 @@ export interface OperationMethods {
     data?: Paths.ProcessErpUpdatesEvents.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ProcessErpUpdatesEvents.Responses.$200>
+  /**
+   * simulateMapping - Simulate ERP mapping transformation
+   * 
+   * Test mapping configuration by transforming a payload using the provided mapping rules without persisting data
+   */
+  'simulateMapping'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.SimulateMapping.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SimulateMapping.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -257,6 +358,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ProcessErpUpdatesEvents.Responses.$200>
   }
+  ['/v1/erp/updates/mapping_simulation']: {
+    /**
+     * simulateMapping - Simulate ERP mapping transformation
+     * 
+     * Test mapping configuration by transforming a payload using the provided mapping rules without persisting data
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.SimulateMapping.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SimulateMapping.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -2,12 +2,17 @@
   "openapi": "3.0.3",
   "info": {
     "title": "ERP Integration API",
-    "version": "1.0.0"
+    "version": "0.3.0",
+    "description": "API for integrating with ERP systems, handling tracking acknowledgments, triggering ERP processes, and processing ERP updates."
   },
   "tags": [
     {
       "name": "erp",
       "description": "ERP integration endpoints"
+    },
+    {
+      "name": "trigger",
+      "description": "Endpoints to trigger ERP related actions"
     }
   ],
   "security": [
@@ -192,6 +197,14 @@
                         "payload": {
                           "type": "string",
                           "description": "The serialized object data payload (JSON, XML, etc.) as a string"
+                        },
+                        "deduplication_id": {
+                          "type": "string",
+                          "pattern": "^[a-zA-Z0-9_-]+$",
+                          "minLength": 1,
+                          "maxLength": 255,
+                          "description": "Optional unique identifier for idempotency - prevents duplicate processing of the same event within 24 hours in context of the same app and component. Must contain only alphanumeric characters, hyphens, and underscores.\n",
+                          "example": "evt-2025-05-01-12345-create-bp"
                         }
                       }
                     }
@@ -201,20 +214,25 @@
               "example": {
                 "app_id": "123e4567-e89b-12d3-a456-426614174000",
                 "component_id": "123e4567-e89b-12d3-a456-426614174000",
+                "meta": {
+                  "correlation_id": "req-789e4567-e89b-12d3-a456-426614174000"
+                },
                 "events": [
                   {
                     "event_type": "CREATE",
                     "object_type": "business_partner",
                     "timestamp": "2025-05-01T08:30:00Z",
                     "format": "json",
-                    "payload": "{\"id\":\"BP10001\",\"name\":\"Acme Corporation\",\"type\":\"organization\",\"tax_id\":\"DE123456789\",\"status\":\"active\"}"
+                    "payload": "{\"id\":\"BP10001\",\"name\":\"Acme Corporation\",\"type\":\"organization\",\"tax_id\":\"DE123456789\",\"status\":\"active\"}",
+                    "deduplication_id": "bp-create-20250501-083000-001"
                   },
                   {
                     "event_type": "UPDATE",
                     "object_type": "contract_account",
                     "timestamp": "2025-05-01T08:35:00Z",
                     "format": "json",
-                    "payload": "{\"id\":\"CA20001\",\"business_partner_id\":\"BP10001\",\"status\":\"active\",\"payment_method\":\"direct_debit\"}"
+                    "payload": "{\"id\":\"CA20001\",\"business_partner_id\":\"BP10001\",\"status\":\"active\",\"payment_method\":\"direct_debit\"}",
+                    "deduplication_id": "ca-update-20250501-083500-001"
                   }
                 ]
               }
@@ -239,6 +257,214 @@
           }
         }
       }
+    },
+    "/v1/erp/updates/mapping_simulation": {
+      "post": {
+        "operationId": "simulateMapping",
+        "summary": "Simulate ERP mapping transformation",
+        "description": "Test mapping configuration by transforming a payload using the provided mapping rules without persisting data",
+        "tags": [
+          "erp"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "mapping_configuration",
+                  "object_type",
+                  "format",
+                  "payload"
+                ],
+                "properties": {
+                  "mapping_configuration": {
+                    "type": "object",
+                    "description": "The integration mapping configuration",
+                    "required": [
+                      "mapping"
+                    ],
+                    "properties": {
+                      "mapping": {
+                        "type": "object",
+                        "required": [
+                          "objects"
+                        ],
+                        "properties": {
+                          "objects": {
+                            "type": "object",
+                            "description": "Object type mappings",
+                            "additionalProperties": {
+                              "type": "object",
+                              "required": [
+                                "unique_ids",
+                                "fields"
+                              ],
+                              "properties": {
+                                "unique_ids": {
+                                  "type": "object",
+                                  "description": "Mapping of entity types to their unique identifier field mappings",
+                                  "additionalProperties": {
+                                    "type": "object",
+                                    "description": "Map of remote keys to local entity keys",
+                                    "additionalProperties": {
+                                      "type": "string"
+                                    }
+                                  }
+                                },
+                                "fields": {
+                                  "type": "array",
+                                  "description": "Field mapping definitions",
+                                  "items": {
+                                    "type": "object",
+                                    "required": [
+                                      "entity",
+                                      "attribute"
+                                    ],
+                                    "properties": {
+                                      "entity": {
+                                        "type": "string",
+                                        "description": "Target entity slug"
+                                      },
+                                      "attribute": {
+                                        "type": "string",
+                                        "description": "Target attribute name"
+                                      },
+                                      "field": {
+                                        "type": "string",
+                                        "description": "Source field name (mutually exclusive with jsonataExpression)"
+                                      },
+                                      "jsonataExpression": {
+                                        "type": "string",
+                                        "description": "JSONata expression for transformation (mutually exclusive with field)"
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  },
+                  "object_type": {
+                    "type": "string",
+                    "description": "Type of the object being mapped (must match a key in mapping_configuration.mapping.objects)"
+                  },
+                  "format": {
+                    "type": "string",
+                    "enum": [
+                      "json",
+                      "xml"
+                    ],
+                    "default": "json",
+                    "description": "Format of the payload data"
+                  },
+                  "payload": {
+                    "type": "string",
+                    "description": "The serialized object data payload (JSON, XML, etc.) as a string"
+                  }
+                }
+              },
+              "example": {
+                "mapping_configuration": {
+                  "mapping": {
+                    "objects": {
+                      "business_partner": {
+                        "unique_ids": {
+                          "contact": {
+                            "partner_id": "_id"
+                          }
+                        },
+                        "fields": [
+                          {
+                            "entity": "contact",
+                            "attribute": "first_name",
+                            "field": "firstName"
+                          },
+                          {
+                            "entity": "contact",
+                            "attribute": "last_name",
+                            "field": "lastName"
+                          }
+                        ]
+                      }
+                    }
+                  }
+                },
+                "object_type": "business_partner",
+                "format": "json",
+                "payload": "{\"partner_id\":\"BP10001\",\"firstName\":\"John\",\"lastName\":\"Doe\"}"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successfully simulated mapping",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "entity_updates"
+                  ],
+                  "properties": {
+                    "entity_updates": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "entity_slug",
+                          "uniqueIdentifiers",
+                          "attributes"
+                        ],
+                        "properties": {
+                          "entity_slug": {
+                            "type": "string",
+                            "description": "The entity type slug"
+                          },
+                          "uniqueIdentifiers": {
+                            "type": "object",
+                            "description": "Unique identifier mappings for this entity",
+                            "additionalProperties": true
+                          },
+                          "attributes": {
+                            "type": "object",
+                            "description": "Mapped attribute values",
+                            "additionalProperties": true
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequest"
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "422": {
+            "description": "Unprocessable entity - mapping configuration or payload validation failed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBase"
+                }
+              }
+            }
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
     }
   },
   "components": {
@@ -248,12 +474,6 @@
         "scheme": "bearer",
         "description": "Authorization header with epilot OAuth2 bearer token",
         "bearerFormat": "JWT"
-      },
-      "EpilotPublicAuth": {
-        "type": "http",
-        "scheme": "bearer",
-        "description": "Authorization header with epilot public access token",
-        "bearerFormat": "JWT"
       }
     },
     "schemas": {
@@ -383,16 +603,6 @@
           }
         }
       },
-      "NotFound": {
-        "description": "The specified resource was not found",
-        "content": {
-          "application/json": {
-            "schema": {
-              "$ref": "#/components/schemas/ErrorResponseBase"
-            }
-          }
-        }
-      },
       "InternalServerError": {
         "description": "Internal Server Error",
         "content": {
@@ -427,9 +637,10 @@
                         "type": "string",
                         "enum": [
                           "success",
-                          "error"
+                          "error",
+                          "skipped"
                         ],
-                        "description": "Processing status for the event"
+                        "description": "Processing status for the event (skipped indicates duplicate deduplication_id)"
                       },
                       "message": {
                         "type": "string"
@@ -455,9 +666,6 @@
     }
   },
   "servers": [
-    {
-      "url": "https://erp-integration-api.sls.epilot.io"
-    },
     {
       "url": "https://erp-integration-api.sls.epilot.io"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/erp-integration-client",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Client library for ePilot ERP Integration API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,6 +22,18 @@
     "erp",
     "integration"
   ],
+  "scripts": {
+    "test": "jest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/erp-integration.yaml",
+    "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
+    "build": "tsc && npm run build:patch && npm run bundle-definition",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
+    "build:watch": "npm run build && tsc -w",
+    "prepublishOnly": "npm run typegen && npm run build",
+    "lint": "pnpm exec eslint src"
+  },
   "files": [
     "*.js",
     "*.d.ts",
@@ -51,25 +63,14 @@
     "@types/jest": "^26.0.20",
     "axios": "^1.11.0",
     "copy-webpack-plugin": "^7.0.0",
-    "jest": "^26.6.3",
+    "jest": "^29.6.2",
     "json-loader": "^0.5.7",
     "openapicmd": "^2.7.0",
-    "ts-jest": "^26.5.0",
+    "ts-jest": "^29.4.1",
     "ts-loader": "^8.0.14",
     "ts-node": "^10.9.1",
     "typescript": "^4.1.3",
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
-  },
-  "scripts": {
-    "test": "jest",
-    "typescript": "tsc",
-    "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/erp-integration.yaml",
-    "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
-    "build": "tsc && npm run build:patch && npm run bundle-definition",
-    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
-    "build:watch": "npm run build && tsc -w",
-    "lint": "pnpm exec eslint src"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 epilot GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.