@epilot/entity-client 4.24.0 → 4.25.0

package/{src → package/dist}/openapi.d.ts

@@ -2677,6 +2677,10 @@ declare namespace Components {
              * _schema:contact AND status:active
              */
             q: string;
+            /**
+             * Filter queries supported with ElasticSearch
+             */
+            filter?: any[];
             /**
              * example:
              * _created_at:desc
@@ -3077,6 +3081,73 @@ declare namespace Components {
             hits?: number;
             relations?: GetRelationsResp;
         }
+        /**
+         * Entity with relation data resolved into the attribute values
+         * example:
+         * {
+         *   "_relations": [
+         *     {
+         *       "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+         *     }
+         *   ],
+         *   "status": "active",
+         *   "customer_number": "abc123",
+         *   "email": [
+         *     {
+         *       "label": "work",
+         *       "email": "user@example.com"
+         *     }
+         *   ],
+         *   "phone": [
+         *     {
+         *       "label": "work",
+         *       "phone": "+49123456789"
+         *     }
+         *   ],
+         *   "first_name": "First Name",
+         *   "middle_name": "Middle Name",
+         *   "last_name": "Last Name",
+         *   "date_of_birth": "2019-08-24",
+         *   "title": "Mr.",
+         *   "account": [
+         *     {
+         *       "status": "active",
+         *       "name": "Company name",
+         *       "company_email": [
+         *         {
+         *           "label": "Company email",
+         *           "email": "company@example.com"
+         *         }
+         *       ],
+         *       "company_phone": [
+         *         {
+         *           "label": "Support phone",
+         *           "phone": "+49123456789"
+         *         }
+         *       ],
+         *       "company_website": "https://example.com",
+         *       "tax_id": "DE123456789",
+         *       "tax_exemption": "2019-08-24",
+         *       "contacts": {
+         *         "$relation": [
+         *           {
+         *             "_tags": [
+         *               "CEO"
+         *             ],
+         *             "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+         *           }
+         *         ]
+         *       }
+         *     }
+         *   ]
+         * }
+         */
+        export interface HydratedEntity {
+            [name: string]: any;
+            _relations: {
+                entity_id: EntityId /* uuid */;
+            }[];
+        }
         /**
          * No UI representation
          */

package/{src → package/dist}/openapi.json

@@ -4693,6 +4693,87 @@
         },
         "additionalProperties": true
       },
+      "HydratedEntity": {
+        "type": "object",
+        "description": "Entity with relation data resolved into the attribute values",
+        "properties": {
+          "_relations": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "entity_id": {
+                  "$ref": "#/components/schemas/EntityId"
+                }
+              },
+              "required": [
+                "entity_id"
+              ]
+            }
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "_relations"
+        ],
+        "example": {
+          "_relations": [
+            {
+              "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+            }
+          ],
+          "status": "active",
+          "customer_number": "abc123",
+          "email": [
+            {
+              "label": "work",
+              "email": "user@example.com"
+            }
+          ],
+          "phone": [
+            {
+              "label": "work",
+              "phone": "+49123456789"
+            }
+          ],
+          "first_name": "First Name",
+          "middle_name": "Middle Name",
+          "last_name": "Last Name",
+          "date_of_birth": "2019-08-24",
+          "title": "Mr.",
+          "account": [
+            {
+              "status": "active",
+              "name": "Company name",
+              "company_email": [
+                {
+                  "label": "Company email",
+                  "email": "company@example.com"
+                }
+              ],
+              "company_phone": [
+                {
+                  "label": "Support phone",
+                  "phone": "+49123456789"
+                }
+              ],
+              "company_website": "https://example.com",
+              "tax_id": "DE123456789",
+              "tax_exemption": "2019-08-24",
+              "contacts": {
+                "$relation": [
+                  {
+                    "_tags": [
+                      "CEO"
+                    ],
+                    "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      },
       "EntityItem": {
         "allOf": [
           {
@@ -4874,6 +4955,10 @@
             "type": "string",
             "example": "_schema:contact AND status:active"
           },
+          "filter": {
+            "description": "Filter queries supported with ElasticSearch",
+            "type": "array"
+          },
           "sort": {
             "type": "string",
             "example": "_created_at:desc"
@@ -6384,9 +6469,6 @@
     }
   },
   "servers": [
-    {
-      "url": "https://entity.sls.epilot.io"
-    },
     {
       "url": "https://entity.sls.epilot.io"
     }

package/package/dist/schema-model.d.ts

@@ -0,0 +1,11 @@
+import { Components } from './openapi';
+export declare enum RelationAffinityMode {
+    /**
+     * For strong affinity mode on a relation attribute, deleting or creating the parent or the relation linkage will trigger a CASCADE delete or create to the relation entity itself.
+     * For weak affinity mode on a relation attribute, deleting or creating the parent or the relation linkage will NOT trigger a CASCADE delete or create to the relation entity itself.
+     */
+    WEAK = "weak",
+    STRONG = "strong"
+}
+export type Attribute = Components.Schemas.Attribute;
+export type AttributeType = Attribute['type'];

package/package/dist/schema-model.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationAffinityMode = void 0;
+var RelationAffinityMode;
+(function (RelationAffinityMode) {
+    /**
+     * For strong affinity mode on a relation attribute, deleting or creating the parent or the relation linkage will trigger a CASCADE delete or create to the relation entity itself.
+     * For weak affinity mode on a relation attribute, deleting or creating the parent or the relation linkage will NOT trigger a CASCADE delete or create to the relation entity itself.
+     */
+    RelationAffinityMode["WEAK"] = "weak";
+    RelationAffinityMode["STRONG"] = "strong";
+})(RelationAffinityMode = exports.RelationAffinityMode || (exports.RelationAffinityMode = {}));
+//# sourceMappingURL=schema-model.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "4.24.0",
+  "version": "4.25.0",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8GAAqE;AACrE,8EAAsD;AAEtD,4DAAsC;AAGtC,IAAI,MAAc,CAAC;AACZ,IAAM,SAAS,GAAG;IACvB,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,GAAG,IAAA,oBAAY,GAAE,CAAC;KACzB;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AANW,QAAA,SAAS,aAMpB;AAEK,IAAM,YAAY,GAAG;;IAC1B,IAAM,GAAG,GAAG,IAAI,8BAAkB,CAAC,EAAE,UAAU,sBAAA,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,IAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,EAAU,CAAC;IAEzC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,yBAC5B,CAAC,MAAA,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,mCAAI,EAAE,CAAC,GACzC,CAAC,2CAAc,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAChC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAVW,QAAA,YAAY,gBAUvB"}

package/dist/definition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"definition.js","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":";;;;;AAEA,gFAAgD;AAEhD,kBAAgB,8BAAkC,CAAC"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,iDAA+B"}

package/dist/schema-model.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema-model.js","sourceRoot":"","sources":["../src/schema-model.ts"],"names":[],"mappings":";;;AAEA,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B;;;OAGG;IACH,qCAAa,CAAA;IACb,yCAAiB,CAAA;AACnB,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B"}

package/jest.config.ts

@@ -1,16 +0,0 @@
-import type { Config } from '@jest/types';
-
-const config: Config.InitialOptions = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  testMatch: ['**/?(*.)+(spec|test).ts?(x)'],
-  testPathIgnorePatterns: ['node_modules'],
-  coveragePathIgnorePatterns: ['__tests__', 'node_modules'],
-  verbose: true,
-  silent: true,
-  moduleNameMapper: {
-    '^axios$': require.resolve('axios'),
-  },
-};
-
-export default config;