@epilot/entity-client 4.0.5 → 4.1.1
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.
- package/LICENSE +21 -0
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +87 -1
- package/dist/openapi.json +16 -4
- package/package.json +4 -3
- package/package-lock.json +0 -18839
package/dist/openapi.d.ts
CHANGED
|
@@ -993,9 +993,15 @@ declare namespace Components {
|
|
|
993
993
|
}
|
|
994
994
|
export interface EntityDefaultCreate {
|
|
995
995
|
view_type?: "default";
|
|
996
|
+
searchParams?: {
|
|
997
|
+
[name: string]: string;
|
|
998
|
+
};
|
|
996
999
|
}
|
|
997
1000
|
export interface EntityDefaultEdit {
|
|
998
1001
|
view_type?: "default";
|
|
1002
|
+
searchParams?: {
|
|
1003
|
+
[name: string]: string;
|
|
1004
|
+
};
|
|
999
1005
|
}
|
|
1000
1006
|
export interface EntityDefaultOverview {
|
|
1001
1007
|
view_type?: "default";
|
|
@@ -1570,7 +1576,7 @@ declare namespace Components {
|
|
|
1570
1576
|
from?: number;
|
|
1571
1577
|
size?: number;
|
|
1572
1578
|
/**
|
|
1573
|
-
* When true, enables entity hydration to resolve nested $relation references in-place.
|
|
1579
|
+
* When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
|
|
1574
1580
|
*/
|
|
1575
1581
|
hydrate?: boolean;
|
|
1576
1582
|
/**
|
|
@@ -4038,6 +4044,12 @@ export interface OperationMethods {
|
|
|
4038
4044
|
* { "entity_id": "456", "_tags": ["primary"] },
|
|
4039
4045
|
* { "entity_id": "789", "_tags": ["secondary"] },
|
|
4040
4046
|
* ]
|
|
4047
|
+
* },
|
|
4048
|
+
* "addresses": {
|
|
4049
|
+
* "$relation_ref": [
|
|
4050
|
+
* { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4051
|
+
* { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4052
|
+
* ]
|
|
4041
4053
|
* }
|
|
4042
4054
|
* }
|
|
4043
4055
|
* ```
|
|
@@ -4061,6 +4073,20 @@ export interface OperationMethods {
|
|
|
4061
4073
|
* "name": "child 2",
|
|
4062
4074
|
* "_tags": ["child"]
|
|
4063
4075
|
* }
|
|
4076
|
+
* ],
|
|
4077
|
+
* "addresses": [
|
|
4078
|
+
* {
|
|
4079
|
+
* "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4080
|
+
* "_id": "123",
|
|
4081
|
+
* "address": "address 1",
|
|
4082
|
+
* "_tags": ["child"]
|
|
4083
|
+
* },
|
|
4084
|
+
* {
|
|
4085
|
+
* "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4086
|
+
* "_id": "234",
|
|
4087
|
+
* "address": "address 2",
|
|
4088
|
+
* "_tags": ["child"]
|
|
4089
|
+
* }
|
|
4064
4090
|
* ]
|
|
4065
4091
|
* }
|
|
4066
4092
|
* ```
|
|
@@ -4145,6 +4171,12 @@ export interface OperationMethods {
|
|
|
4145
4171
|
* { "entity_id": "456", "_tags": ["primary"] },
|
|
4146
4172
|
* { "entity_id": "789", "_tags": ["secondary"] },
|
|
4147
4173
|
* ]
|
|
4174
|
+
* },
|
|
4175
|
+
* "addresses": {
|
|
4176
|
+
* "$relation_ref": [
|
|
4177
|
+
* { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4178
|
+
* { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4179
|
+
* ]
|
|
4148
4180
|
* }
|
|
4149
4181
|
* }
|
|
4150
4182
|
* ```
|
|
@@ -4168,6 +4200,20 @@ export interface OperationMethods {
|
|
|
4168
4200
|
* "name": "child 2",
|
|
4169
4201
|
* "_tags": ["child"]
|
|
4170
4202
|
* }
|
|
4203
|
+
* ],
|
|
4204
|
+
* "addresses": [
|
|
4205
|
+
* {
|
|
4206
|
+
* "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4207
|
+
* "_id": "123",
|
|
4208
|
+
* "address": "address 1",
|
|
4209
|
+
* "_tags": ["child"]
|
|
4210
|
+
* },
|
|
4211
|
+
* {
|
|
4212
|
+
* "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4213
|
+
* "_id": "234",
|
|
4214
|
+
* "address": "address 2",
|
|
4215
|
+
* "_tags": ["child"]
|
|
4216
|
+
* }
|
|
4171
4217
|
* ]
|
|
4172
4218
|
* }
|
|
4173
4219
|
* ```
|
|
@@ -4428,6 +4474,12 @@ export interface PathsDictionary {
|
|
|
4428
4474
|
* { "entity_id": "456", "_tags": ["primary"] },
|
|
4429
4475
|
* { "entity_id": "789", "_tags": ["secondary"] },
|
|
4430
4476
|
* ]
|
|
4477
|
+
* },
|
|
4478
|
+
* "addresses": {
|
|
4479
|
+
* "$relation_ref": [
|
|
4480
|
+
* { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4481
|
+
* { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4482
|
+
* ]
|
|
4431
4483
|
* }
|
|
4432
4484
|
* }
|
|
4433
4485
|
* ```
|
|
@@ -4451,6 +4503,20 @@ export interface PathsDictionary {
|
|
|
4451
4503
|
* "name": "child 2",
|
|
4452
4504
|
* "_tags": ["child"]
|
|
4453
4505
|
* }
|
|
4506
|
+
* ],
|
|
4507
|
+
* "addresses": [
|
|
4508
|
+
* {
|
|
4509
|
+
* "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4510
|
+
* "_id": "123",
|
|
4511
|
+
* "address": "address 1",
|
|
4512
|
+
* "_tags": ["child"]
|
|
4513
|
+
* },
|
|
4514
|
+
* {
|
|
4515
|
+
* "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4516
|
+
* "_id": "234",
|
|
4517
|
+
* "address": "address 2",
|
|
4518
|
+
* "_tags": ["child"]
|
|
4519
|
+
* }
|
|
4454
4520
|
* ]
|
|
4455
4521
|
* }
|
|
4456
4522
|
* ```
|
|
@@ -4541,6 +4607,12 @@ export interface PathsDictionary {
|
|
|
4541
4607
|
* { "entity_id": "456", "_tags": ["primary"] },
|
|
4542
4608
|
* { "entity_id": "789", "_tags": ["secondary"] },
|
|
4543
4609
|
* ]
|
|
4610
|
+
* },
|
|
4611
|
+
* "addresses": {
|
|
4612
|
+
* "$relation_ref": [
|
|
4613
|
+
* { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4614
|
+
* { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4615
|
+
* ]
|
|
4544
4616
|
* }
|
|
4545
4617
|
* }
|
|
4546
4618
|
* ```
|
|
@@ -4564,6 +4636,20 @@ export interface PathsDictionary {
|
|
|
4564
4636
|
* "name": "child 2",
|
|
4565
4637
|
* "_tags": ["child"]
|
|
4566
4638
|
* }
|
|
4639
|
+
* ],
|
|
4640
|
+
* "addresses": [
|
|
4641
|
+
* {
|
|
4642
|
+
* "$relation_ref": { "entity_id": "123", "_tags": ["primary"], "path": "address.0" },
|
|
4643
|
+
* "_id": "123",
|
|
4644
|
+
* "address": "address 1",
|
|
4645
|
+
* "_tags": ["child"]
|
|
4646
|
+
* },
|
|
4647
|
+
* {
|
|
4648
|
+
* "$relation_ref": { "entity_id": "234", "_tags": ["secondary"], "path": "address.0" },
|
|
4649
|
+
* "_id": "234",
|
|
4650
|
+
* "address": "address 2",
|
|
4651
|
+
* "_tags": ["child"]
|
|
4652
|
+
* }
|
|
4567
4653
|
* ]
|
|
4568
4654
|
* }
|
|
4569
4655
|
* ```
|
package/dist/openapi.json
CHANGED
|
@@ -274,7 +274,7 @@
|
|
|
274
274
|
"post": {
|
|
275
275
|
"operationId": "searchEntities",
|
|
276
276
|
"summary": "searchEntities",
|
|
277
|
-
"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",
|
|
277
|
+
"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 \"addresses\": {\n \"$relation_ref\": [\n { \"entity_id\": \"123\", \"_tags\": [\"primary\"], \"path\": \"address.0\" },\n { \"entity_id\": \"234\", \"_tags\": [\"secondary\"], \"path\": \"address.0\" },\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 \"addresses\": [\n {\n \"$relation_ref\": { \"entity_id\": \"123\", \"_tags\": [\"primary\"], \"path\": \"address.0\" },\n \"_id\": \"123\",\n \"address\": \"address 1\",\n \"_tags\": [\"child\"]\n },\n {\n \"$relation_ref\": { \"entity_id\": \"234\", \"_tags\": [\"secondary\"], \"path\": \"address.0\" },\n \"_id\": \"234\",\n \"address\": \"address 2\",\n \"_tags\": [\"child\"]\n }\n ]\n}\n```\n",
|
|
278
278
|
"tags": [
|
|
279
279
|
"Entities"
|
|
280
280
|
],
|
|
@@ -489,7 +489,7 @@
|
|
|
489
489
|
"get": {
|
|
490
490
|
"operationId": "getEntity",
|
|
491
491
|
"summary": "getEntity",
|
|
492
|
-
"description": "Gets Entity and relations by id.\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",
|
|
492
|
+
"description": "Gets Entity and relations by id.\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 \"addresses\": {\n \"$relation_ref\": [\n { \"entity_id\": \"123\", \"_tags\": [\"primary\"], \"path\": \"address.0\" },\n { \"entity_id\": \"234\", \"_tags\": [\"secondary\"], \"path\": \"address.0\" },\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 \"addresses\": [\n {\n \"$relation_ref\": { \"entity_id\": \"123\", \"_tags\": [\"primary\"], \"path\": \"address.0\" },\n \"_id\": \"123\",\n \"address\": \"address 1\",\n \"_tags\": [\"child\"]\n },\n {\n \"$relation_ref\": { \"entity_id\": \"234\", \"_tags\": [\"secondary\"], \"path\": \"address.0\" },\n \"_id\": \"234\",\n \"address\": \"address 2\",\n \"_tags\": [\"child\"]\n }\n ]\n}\n```\n",
|
|
493
493
|
"tags": [
|
|
494
494
|
"Entities"
|
|
495
495
|
],
|
|
@@ -515,7 +515,7 @@
|
|
|
515
515
|
{
|
|
516
516
|
"in": "query",
|
|
517
517
|
"name": "hydrate",
|
|
518
|
-
"description": "When true, enables entity hydration to resolve nested $relation references in-place.",
|
|
518
|
+
"description": "When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.",
|
|
519
519
|
"schema": {
|
|
520
520
|
"default": false,
|
|
521
521
|
"type": "boolean"
|
|
@@ -2921,6 +2921,12 @@
|
|
|
2921
2921
|
"enum": [
|
|
2922
2922
|
"default"
|
|
2923
2923
|
]
|
|
2924
|
+
},
|
|
2925
|
+
"searchParams": {
|
|
2926
|
+
"type": "object",
|
|
2927
|
+
"additionalProperties": {
|
|
2928
|
+
"type": "string"
|
|
2929
|
+
}
|
|
2924
2930
|
}
|
|
2925
2931
|
}
|
|
2926
2932
|
},
|
|
@@ -2932,6 +2938,12 @@
|
|
|
2932
2938
|
"enum": [
|
|
2933
2939
|
"default"
|
|
2934
2940
|
]
|
|
2941
|
+
},
|
|
2942
|
+
"searchParams": {
|
|
2943
|
+
"type": "object",
|
|
2944
|
+
"additionalProperties": {
|
|
2945
|
+
"type": "string"
|
|
2946
|
+
}
|
|
2935
2947
|
}
|
|
2936
2948
|
}
|
|
2937
2949
|
},
|
|
@@ -3185,7 +3197,7 @@
|
|
|
3185
3197
|
},
|
|
3186
3198
|
"hydrate": {
|
|
3187
3199
|
"type": "boolean",
|
|
3188
|
-
"description": "When true, enables entity hydration to resolve nested $relation references in-place.",
|
|
3200
|
+
"description": "When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.",
|
|
3189
3201
|
"default": false
|
|
3190
3202
|
},
|
|
3191
3203
|
"fields": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.1.1",
|
|
4
4
|
"description": "JavaScript client library for the epilot Core Entity API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -71,5 +71,6 @@
|
|
|
71
71
|
"typescript": "^4.1.3",
|
|
72
72
|
"webpack": "^5.18.0",
|
|
73
73
|
"webpack-cli": "^4.4.0"
|
|
74
|
-
}
|
|
75
|
-
|
|
74
|
+
},
|
|
75
|
+
"gitHead": "5ee9d86af83c0c0786e0254d37bc59e9154480fb"
|
|
76
|
+
}
|