npm - @epilot/entity-client - Versions diffs - 2.6.2 → 2.6.3-alpha.0 - Mend

@epilot/entity-client 2.6.2 → 2.6.3-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/openapi.d.ts CHANGED Viewed

@@ -197,6 +197,10 @@ declare namespace Components {
             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;
             type?: "relation_address";
             has_primary?: boolean;
         }
@@ -267,6 +271,10 @@ declare namespace Components {
             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;
         }
         /**
          * example:
@@ -366,6 +374,10 @@ declare namespace Components {
             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;
             type?: "boolean";
         }
         /**
@@ -428,6 +440,10 @@ declare namespace Components {
             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;
             type: "consent";
             topic: string;
             identifiers?: string[];
@@ -492,6 +508,10 @@ declare namespace Components {
             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;
             type?: "country";
         }
         /**
@@ -554,6 +574,10 @@ declare namespace Components {
             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;
             type: "currency";
             /**
              * An array of currency configurations with a country code (ISO-4217)
@@ -569,6 +593,7 @@ declare namespace Components {
          * Custom input
          */
         export interface CustomAttribute {
+            [name: string]: any;
             name: string;
             label: string;
             placeholder?: string;
@@ -625,7 +650,22 @@ declare namespace Components {
             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;
             type?: "custom";
+            /**
+             * When present, lets the handlebars compiler of the value_formatter and preview_value_formatter access the:
+             *  - entire entity
+             *  - attribute definition
+             *  - locale
+             *  - optional value (matching the attribute name on the entity object)
+             *
+             * The handlebars helpers can then use this rich context to compute the output value for the attribute.
+             *
+             */
+            computed?: boolean;
         }
         /**
          * Date or Datetime picker
@@ -687,6 +727,10 @@ declare namespace Components {
             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;
             type?: "date" | "datetime";
         }
         export interface Entity {
@@ -921,6 +965,7 @@ declare namespace Components {
              * contact
              */
             EntitySlug;
+            version?: number;
             blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
             /**
              * This schema should only be active when the feature flag is enabled
@@ -971,7 +1016,11 @@ declare namespace Components {
              *     "expanded": true
              *   },
              *   "Contact Details": {
-             *     "expanded": false
+             *     "expanded": false,
+             *     "info_tooltip_title": {
+             *       "key": "partner.partner_information_group_tooltip",
+             *       "default": "These informations are provided by the partner company and cannot be edited."
+             *     }
              *   }
              * }
              */
@@ -982,6 +1031,10 @@ declare namespace Components {
                      * Render order of the group
                      */
                     order?: number;
+                    info_tooltip_title?: {
+                        key?: string;
+                        default?: string;
+                    };
                 };
             };
             /**
@@ -1068,6 +1121,7 @@ declare namespace Components {
              * contact
              */
             EntitySlug;
+            version?: number;
             blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
             /**
              * This schema should only be active when the feature flag is enabled
@@ -1118,7 +1172,11 @@ declare namespace Components {
              *     "expanded": true
              *   },
              *   "Contact Details": {
-             *     "expanded": false
+             *     "expanded": false,
+             *     "info_tooltip_title": {
+             *       "key": "partner.partner_information_group_tooltip",
+             *       "default": "These informations are provided by the partner company and cannot be edited."
+             *     }
              *   }
              * }
              */
@@ -1129,6 +1187,10 @@ declare namespace Components {
                      * Render order of the group
                      */
                     order?: number;
+                    info_tooltip_title?: {
+                        key?: string;
+                        default?: string;
+                    };
                 };
             };
             /**
@@ -1339,6 +1401,10 @@ declare namespace Components {
             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;
             type: "image" | "file";
             multiple?: boolean;
             /**
@@ -1567,6 +1633,10 @@ declare namespace Components {
             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;
             type?: "internal";
         }
         /**
@@ -1629,6 +1699,10 @@ declare namespace Components {
             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;
             type?: "link";
         }
         /**
@@ -1691,6 +1765,10 @@ declare namespace Components {
             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;
             type?: "number";
             format?: string;
         }
@@ -1754,6 +1832,10 @@ declare namespace Components {
             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;
             type?: "ordered_list";
         }
         /**
@@ -1816,6 +1898,10 @@ declare namespace Components {
             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;
             type?: "partner_status";
         }
         /**
@@ -1893,6 +1979,10 @@ declare namespace Components {
             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;
             type?: "relation";
             relation_type?: "belongs_to" | "has_many";
             delete_mode?: "cascade";
@@ -2016,6 +2106,10 @@ declare namespace Components {
             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;
             repeatable?: boolean;
             has_primary?: boolean;
             relation_affinity_mode?: "weak" | "strong";
@@ -2109,6 +2203,10 @@ declare namespace Components {
             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;
             type?: "select" | "radio";
             options?: (string | {
                 value: string;
@@ -2188,6 +2286,10 @@ declare namespace Components {
             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;
             type?: "tags";
             options?: string[];
             suggestions?: string[];
@@ -2252,6 +2354,10 @@ declare namespace Components {
             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;
             type?: "string";
             multiline?: boolean;
         }
@@ -2315,6 +2421,10 @@ declare namespace Components {
             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;
             type?: "relation_user";
             multiple?: boolean;
         }
@@ -2677,6 +2787,24 @@ declare namespace Paths {
             export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
         }
     }
+    namespace GetSchemaVersions {
+        namespace Parameters {
+            export type Slug = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug;
+        }
+        export interface PathParameters {
+            slug: Parameters.Slug;
+        }
+        namespace Responses {
+            export interface $200 {
+                results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
+            }
+        }
+    }
     namespace ListSchemas {
         namespace Responses {
             export interface $200 {
@@ -2851,6 +2979,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ListSchemas.Responses.$200>
+  /**
+   * getSchemaVersions - getSchemaVersions
+   *
+   * Get all versions of this schema
+   */
+  'getSchemaVersions'(
+    parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
   /**
    * getSchema - getSchema
    */
@@ -2861,6 +2999,8 @@ export interface OperationMethods {
   ): OperationResponse<Paths.GetSchema.Responses.$200>
   /**
    * putSchema - putSchema
+   *
+   * Create new version of the schema
    */
   'putSchema'(
     parameters?: Parameters<Paths.PutSchema.PathParameters> | null,
@@ -2880,6 +3020,8 @@ export interface OperationMethods {
    *
    * Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.
    *
+   * Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search.
+   *
    * ## Relations
    *
    * When `hydrate=true`, relation attributes are replaced in-place with nested entity values.
@@ -3194,6 +3336,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ListSchemas.Responses.$200>
   }
+  ['/v1/entity/schemas/{slug}/versions']: {
+    /**
+     * getSchemaVersions - getSchemaVersions
+     *
+     * Get all versions of this schema
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
+  }
   ['/v1/entity/schemas/{slug}']: {
     /**
      * getSchema - getSchema
@@ -3205,6 +3359,8 @@ export interface PathsDictionary {
     ): OperationResponse<Paths.GetSchema.Responses.$200>
     /**
      * putSchema - putSchema
+     *
+     * Create new version of the schema
      */
     'put'(
       parameters?: Parameters<Paths.PutSchema.PathParameters> | null,
@@ -3226,6 +3382,8 @@ export interface PathsDictionary {
      *
      * Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.
      *
+     * Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search.
+     *
      * ## Relations
      *
      * When `hydrate=true`, relation attributes are replaced in-place with nested entity values.

package/dist/openapi.json CHANGED Viewed

@@ -57,6 +57,46 @@
                 }
             }
         },
+        "/v1/entity/schemas/{slug}/versions": {
+            "get": {
+                "operationId": "getSchemaVersions",
+                "summary": "getSchemaVersions",
+                "description": "Get all versions of this schema",
+                "tags": [
+                    "Schemas"
+                ],
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "slug",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/components/schemas/EntitySlug"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "results": {
+                                            "type": "array",
+                                            "items": {
+                                                "$ref": "#/components/schemas/EntitySchemaItem"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/v1/entity/schemas/{slug}": {
             "get": {
                 "operationId": "getSchema",
@@ -90,6 +130,7 @@
             "put": {
                 "operationId": "putSchema",
                 "summary": "putSchema",
+                "description": "Create new version of the schema",
                 "tags": [
                     "Schemas"
                 ],
@@ -152,7 +193,7 @@
             "post": {
                 "operationId": "searchEntities",
                 "summary": "searchEntities",
-                "description": "Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.\n\n## Relations\n\nWhen `hydrate=true`, relation attributes are replaced in-place with nested entity values.\n\nExample:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": {\n    \"$relation\": [\n      { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n    ]\n  }\n}\n```\n\nBecomes:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": [\n    {\n      \"$relation\": { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      \"_id\": \"456\",\n      \"name\": \"child 1\",\n      \"_tags\": [\"child\"]\n    },\n    {\n      \"$relation\": { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n      \"_id\": \"789\",\n      \"name\": \"child 2\",\n      \"_tags\": [\"child\"]\n    }\n  ]\n}\n```\n",
+                "description": "Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.\n\nPassing comma-separated `x-epilot-org-id` is supported for cross-org entity search.\n\n## Relations\n\nWhen `hydrate=true`, relation attributes are replaced in-place with nested entity values.\n\nExample:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": {\n    \"$relation\": [\n      { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n    ]\n  }\n}\n```\n\nBecomes:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": [\n    {\n      \"$relation\": { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      \"_id\": \"456\",\n      \"name\": \"child 1\",\n      \"_tags\": [\"child\"]\n    },\n    {\n      \"$relation\": { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n      \"_id\": \"789\",\n      \"name\": \"child 2\",\n      \"_tags\": [\"child\"]\n    }\n  ]\n}\n```\n",
                 "tags": [
                     "Entities"
                 ],
@@ -1141,6 +1182,10 @@
                     "slug": {
                         "$ref": "#/components/schemas/EntitySlug"
                     },
+                    "version": {
+                        "type": "integer",
+                        "minimum": 1
+                    },
                     "blueprint": {
                         "$ref": "#/components/schemas/BlueprintEntityId"
                     },
@@ -1221,6 +1266,17 @@
                                     "description": "Render order of the group",
                                     "type": "integer",
                                     "default": 0
+                                },
+                                "info_tooltip_title": {
+                                    "type": "object",
+                                    "properties": {
+                                        "key": {
+                                            "type": "string"
+                                        },
+                                        "default": {
+                                            "type": "string"
+                                        }
+                                    }
                                 }
                             }
                         },
@@ -1229,7 +1285,11 @@
                                 "expanded": true
                             },
                             "Contact Details": {
-                                "expanded": false
+                                "expanded": false,
+                                "info_tooltip_title": {
+                                    "key": "partner.partner_information_group_tooltip",
+                                    "default": "These informations are provided by the partner company and cannot be edited."
+                                }
                             }
                         }
                     },
@@ -1482,6 +1542,11 @@
                     },
                     "preview_value_formatter": {
                         "type": "string"
+                    },
+                    "entity_builder_disable_edit": {
+                        "description": "Setting to `true` disables editing the attribute on the entity builder UI",
+                        "type": "boolean",
+                        "default": false
                     }
                 },
                 "required": [
@@ -2060,8 +2125,13 @@
                                 "enum": [
                                     "custom"
                                 ]
+                            },
+                            "computed": {
+                                "description": "When present, lets the handlebars compiler of the value_formatter and preview_value_formatter access the:\n - entire entity\n - attribute definition\n - locale\n - optional value (matching the attribute name on the entity object)\n\nThe handlebars helpers can then use this rich context to compute the output value for the attribute.\n",
+                                "type": "boolean"
                             }
-                        }
+                        },
+                        "additionalProperties": true
                     }
                 ]
             },

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "2.6.2",
+  "version": "2.6.3-alpha.0",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,8 @@
     "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"
+    "prepublishOnly": "npm run build",
+    "release-alpha": "npm version prerelease --preid alpha"
   },
   "files": [
     "*.js",