@epilot/entity-client 3.0.11 → 3.0.12

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 {
@@ -1432,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[];
@@ -1548,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)[];
@@ -1623,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": [
@@ -2049,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:
          * {
@@ -2165,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 {
@@ -2733,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;
@@ -2879,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;
@@ -2894,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[];
@@ -3069,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;
@@ -3143,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;
@@ -3158,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

@@ -1580,6 +1580,9 @@
                     },
                     {
                         "$ref": "#/components/schemas/PartnerStatusAttribute"
+                    },
+                    {
+                        "$ref": "#/components/schemas/PriceComponentsAttribute"
                     }
                 ]
             },
@@ -2277,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": [
                     {
@@ -3735,5 +3757,10 @@
                 }
             }
         }
-    }
+    },
+    "servers": [
+        {
+            "url": "https://entity.sls.epilot.io"
+        }
+    ]
 }

package/package.json

@@ -1,19 +1,36 @@
 {
   "name": "@epilot/entity-client",
-  "version": "3.0.11",
+  "version": "3.0.12",
   "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",
+    "openapi": "openapi read --json https://docs.api.epilot.io/entity.yaml > src/openapi.json",
+    "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
+    "build": "npm run typegen && tsc && npm run bundle-definition",
+    "build:watch": "npm run build && tsc -w",
     "prepublishOnly": "npm run build",
-    "release-alpha": "npm version prerelease --preid alpha"
+    "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"
   },

package/.gitignore

@@ -1,3 +0,0 @@
-*.js
-!webpack.config.js
-src/openapi.json

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;AAG/B,IAAM,SAAS,GAAG;IACvB,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;IACzC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,MAAM;QACxC,IAAM,kBAAkB,GAAG,2CAAc,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QACtD,MAAM,CAAC,OAAO,yBACT,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,GACtB,kBAAkB,CACtB,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAdW,QAAA,SAAS,aAcpB"}

package/dist/definition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"definition.js","sourceRoot":"","sources":["../src/definition.ts"],"names":[],"mappings":";;;;;AAEA,gEAAwC;AAExC,kBAAe,sBAAsB,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,13 +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,
-};
-
-export default config;