@epilot/entity-client 3.0.10 → 3.0.13

package/dist/openapi.d.ts

@@ -217,7 +217,7 @@ declare namespace Components {
             download_url: string;
             alt_text?: string;
         }
-        export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute;
+        export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* An attribute that holds a set of price components, used for dynamic pricing */ PriceComponentsAttribute;
         export interface BaseAttribute {
             name: string;
             label: string;
@@ -920,8 +920,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {}
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z"
          * }
          */
         export interface EntityItem {
@@ -980,6 +980,11 @@ declare namespace Components {
             payload?: {
                 [name: string]: any;
             };
+            diff?: {
+                added?: Entity;
+                updated?: Entity;
+                deleted?: Entity;
+            };
         }
         /**
          * example:
@@ -1057,6 +1062,14 @@ declare namespace Components {
                 list_item?: {
                     summary_attributes?: string[];
                 };
+                sharing?: {
+                    /**
+                     * Show the sharing button in entity detail view
+                     * example:
+                     * true
+                     */
+                    show_sharing_button?: boolean;
+                };
             };
             capabilities?: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
             /**
@@ -1241,6 +1254,14 @@ declare namespace Components {
                 list_item?: {
                     summary_attributes?: string[];
                 };
+                sharing?: {
+                    /**
+                     * Show the sharing button in entity detail view
+                     * example:
+                     * true
+                     */
+                    show_sharing_button?: boolean;
+                };
             };
             capabilities?: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
             /**
@@ -1411,8 +1432,8 @@ declare namespace Components {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             EntityItem[];
@@ -1527,8 +1548,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {}
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z"
          * }
          */
         RelationEntity)[];
@@ -1602,8 +1623,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {},
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z",
          *   "status": "active",
          *   "customer_number": "abc123",
          *   "email": [
@@ -2028,6 +2049,76 @@ declare namespace Components {
             protected?: boolean;
             type?: "partner_status";
         }
+        /**
+         * An attribute that holds a set of price components, used for dynamic pricing
+         */
+        export interface PriceComponentsAttribute {
+            name: string;
+            label: string;
+            placeholder?: string;
+            /**
+             * Do not render attribute in entity views
+             */
+            hidden?: boolean;
+            /**
+             * Render as a column in table views. When defined, overrides `hidden`
+             */
+            show_in_table?: boolean;
+            required?: boolean;
+            readonly?: boolean;
+            deprecated?: boolean;
+            default_value?: string | {
+                [name: string]: any;
+            } | number | number | boolean | any[];
+            group?: string;
+            layout?: string;
+            /**
+             * When set to true, will hide the label of the field.
+             */
+            hide_label?: boolean;
+            /**
+             * Code name of the icon to used to represent this attribute.
+             * The value must be a valid @epilot/base-elements Icon name
+             *
+             */
+            icon?: string;
+            /**
+             * Defines the conditional rendering expression for showing this field.
+             * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
+             * Note: Empty or invalid expression have no effect on the field visibility.
+             *
+             */
+            render_condition?: string;
+            /**
+             * A set of constraints applicable to the attribute.
+             * These constraints should and will be enforced by the attribute renderer.
+             *
+             * example:
+             * {
+             *   "disablePast": true
+             * }
+             */
+            constraints?: {
+                [key: string]: any;
+            };
+            /**
+             * This attribute should only be active when the feature flag is enabled
+             * example:
+             * FF_MY_FEATURE_FLAG
+             */
+            feature_flag?: string;
+            value_formatter?: string;
+            preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
+            /**
+             * Setting to `true` prevents the attribute from being modified / deleted
+             */
+            protected?: boolean;
+            type?: "price_components";
+        }
         /**
          * example:
          * {
@@ -2144,8 +2235,8 @@ declare namespace Components {
          *     "example",
          *     "mock"
          *   ],
-         *   "_created_at": {},
-         *   "_updated_at": {}
+         *   "_created_at": "2021-02-09T12:41:43.662Z",
+         *   "_updated_at": "2021-02-09T12:41:43.662Z"
          * }
          */
         export interface RelationEntity {
@@ -2712,8 +2803,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;
@@ -2858,8 +2949,8 @@ declare namespace Paths {
                  *     "example",
                  *     "mock"
                  *   ],
-                 *   "_created_at": {},
-                 *   "_updated_at": {}
+                 *   "_created_at": "2021-02-09T12:41:43.662Z",
+                 *   "_updated_at": "2021-02-09T12:41:43.662Z"
                  * }
                  */
                 Components.Schemas.EntityItem;
@@ -2873,8 +2964,8 @@ declare namespace Paths {
                  *     "example",
                  *     "mock"
                  *   ],
-                 *   "_created_at": {},
-                 *   "_updated_at": {}
+                 *   "_created_at": "2021-02-09T12:41:43.662Z",
+                 *   "_updated_at": "2021-02-09T12:41:43.662Z"
                  * }
                  */
                 Components.Schemas.EntityItem[];
@@ -3048,8 +3139,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;
@@ -3122,8 +3213,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;
@@ -3137,8 +3228,8 @@ declare namespace Paths {
              *     "example",
              *     "mock"
              *   ],
-             *   "_created_at": {},
-             *   "_updated_at": {}
+             *   "_created_at": "2021-02-09T12:41:43.662Z",
+             *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
             Components.Schemas.EntityItem;

package/dist/openapi.json

@@ -1330,6 +1330,16 @@
                                         }
                                     }
                                 }
+                            },
+                            "sharing": {
+                                "type": "object",
+                                "properties": {
+                                    "show_sharing_button": {
+                                        "type": "boolean",
+                                        "description": "Show the sharing button in entity detail view",
+                                        "example": true
+                                    }
+                                }
                             }
                         }
                     },
@@ -1570,6 +1580,9 @@
                     },
                     {
                         "$ref": "#/components/schemas/PartnerStatusAttribute"
+                    },
+                    {
+                        "$ref": "#/components/schemas/PriceComponentsAttribute"
                     }
                 ]
             },
@@ -2267,6 +2280,25 @@
                     }
                 ]
             },
+            "PriceComponentsAttribute": {
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/BaseAttribute"
+                    },
+                    {
+                        "type": "object",
+                        "description": "An attribute that holds a set of price components, used for dynamic pricing",
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "enum": [
+                                    "price_components"
+                                ]
+                            }
+                        }
+                    }
+                ]
+            },
             "PartnerStatusAttribute": {
                 "allOf": [
                     {
@@ -3044,6 +3076,20 @@
                                 }
                             }
                         ]
+                    },
+                    "diff": {
+                        "type": "object",
+                        "properties": {
+                            "added": {
+                                "$ref": "#/components/schemas/Entity"
+                            },
+                            "updated": {
+                                "$ref": "#/components/schemas/Entity"
+                            },
+                            "deleted": {
+                                "$ref": "#/components/schemas/Entity"
+                            }
+                        }
                     }
                 },
                 "required": [
@@ -3711,5 +3757,13 @@
                 }
             }
         }
-    }
+    },
+    "servers": [
+        {
+            "url": "https://entity.sls.epilot.io"
+        },
+        {
+            "url": "https://entity.sls.epilot.io"
+        }
+    ]
 }

package/package.json

@@ -1,19 +1,36 @@
 {
   "name": "@epilot/entity-client",
-  "version": "3.0.10",
+  "version": "3.0.13",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "author": "epilot GmbH",
+  "license": "MIT",
+  "repsitory": {
+    "type": "git",
+    "url": "git+https://github.com/epilot-dev/sdk-js.git",
+    "directory": "clients/entity-client"
+  },
+  "bugs": {
+    "url": "https://github.com/epilot-dev/sdk-js/issues"
+  },
+  "homepage": "https://github.com/epilot-dev/sdk-js/tree/main/clients/entity-client#readme",
+  "keywords": [
+    "epilot",
+    "sdk",
+    "entity"
+  ],
   "scripts": {
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "openapi read --json ../lambda/ApiHandlerFunction/openapi.yml > src/openapi.json",
-    "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ../lambda/ApiHandlerFunction/openapi.yml >> src/openapi.d.ts",
-    "build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
-    "eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml",
-    "prepublishOnly": "npm run build",
-    "release-alpha": "npm version prerelease --preid alpha"
+    "openapi": "../../scripts/update-openapi.sh https://docs.api.epilot.io/entity.yaml",
+    "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
+    "build": "tsc && npm run bundle-definition",
+    "build:watch": "npm run build && tsc -w",
+    "prepublishOnly": "npm run typegen && npm run build",
+    "release-alpha": "npm version prerelease --preid alpha",
+    "lint": "../../node_modules/eslint/bin/eslint.js src"
   },
   "files": [
     "*.js",
@@ -28,9 +45,6 @@
     "!src/**",
     "!*.config.js"
   ],
-  "keywords": [],
-  "author": "epilot GmbH",
-  "license": "UNLICENSED",
   "peerDependencies": {
     "axios": "^0.25.0"
   },
@@ -57,5 +71,6 @@
     "typescript": "^4.1.3",
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
-  }
-}
+  },
+  "gitHead": "7b83c1f1eae808b0184858ee471818cf4dca3295"
+}