@twin.org/entity-storage-service 0.0.3-next.9 → 0.9.0

package/docs/open-api/spec.json

@@ -28,6 +28,17 @@
 				"tags": [
 					"EntityStorage"
 				],
+				"parameters": [
+					{
+						"name": "conditions",
+						"description": "The optional conditions to match for the entity, JSON encoded array of property/value pairs.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					}
+				],
 				"security": [
 					{
 						"jwtBearerAuthScheme": []
@@ -115,6 +126,91 @@
 					}
 				}
 			},
+			"delete": {
+				"operationId": "entityStorageEmpty",
+				"summary": "Remove all entries from entity storage.",
+				"tags": [
+					"EntityStorage"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Remove all entries from entity storage.",
+					"required": true,
+					"content": {
+						"text/plain": {
+							"schema": {
+								"$ref": "#/components/schemas/EntityStorageEmptyRequest"
+							}
+						}
+					}
+				},
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
 			"get": {
 				"operationId": "entityStorageList",
 				"summary": "Query entries from entity storage.",
@@ -265,6 +361,200 @@
 				}
 			}
 		},
+		"/entity-storage/batch": {
+			"post": {
+				"operationId": "entityStorageSetBatch",
+				"summary": "Set multiple entries in entity storage.",
+				"tags": [
+					"EntityStorage"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Set multiple entries in entity storage.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/EntityStorageSetBatchRequest"
+							},
+							"examples": {
+								"entityStorageSetBatchRequestExample": {
+									"value": [
+										{
+											"id": "12345",
+											"name": "My Item"
+										},
+										{
+											"id": "67890",
+											"name": "My Other Item"
+										}
+									]
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"delete": {
+				"operationId": "entityStorageRemoveBatch",
+				"summary": "Remove multiple entries from entity storage by id.",
+				"tags": [
+					"EntityStorage"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Remove multiple entries from entity storage by id.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/EntityStorageRemoveBatchRequest"
+							},
+							"examples": {
+								"entityStorageRemoveBatchRequestExample": {
+									"value": [
+										"12345",
+										"67890"
+									]
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
 		"/entity-storage/{id}": {
 			"get": {
 				"operationId": "entityStorageGet",
@@ -292,6 +582,15 @@
 						"schema": {
 							"type": "string"
 						}
+					},
+					{
+						"name": "conditions",
+						"description": "The optional conditions to match for the entity, JSON encoded array of property/value pairs.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
 					}
 				],
 				"security": [
@@ -415,6 +714,15 @@
 						},
 						"style": "simple",
 						"example": "12345"
+					},
+					{
+						"name": "conditions",
+						"description": "The optional conditions to match for the entity, JSON encoded array of property/value pairs.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
 					}
 				],
 				"security": [
@@ -506,10 +814,128 @@
 					}
 				}
 			}
+		},
+		"/entity-storage/count": {
+			"get": {
+				"operationId": "entityStorageCount",
+				"summary": "Count entries in entity storage.",
+				"tags": [
+					"EntityStorage"
+				],
+				"parameters": [
+					{
+						"name": "conditions",
+						"description": "The optional conditions to filter the count, JSON encoded EntityCondition.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "The response for counting entries in entity storage.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/EntityStorageCountResponse"
+								},
+								"examples": {
+									"entityStorageCountResponseExample": {
+										"value": {
+											"count": 1
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
 		}
 	},
 	"components": {
 		"schemas": {
+			"EntityStorageCountResponse": {
+				"type": "object",
+				"properties": {
+					"count": {
+						"type": "number",
+						"description": "The total count of entities."
+					}
+				},
+				"required": [
+					"count"
+				],
+				"description": "The body of the response."
+			},
+			"EntityStorageEmptyRequest": {
+				"description": "Remove all entries from entity storage.",
+				"type": "object"
+			},
 			"EntityStorageGetResponse": {
 				"description": "The data for the requested entity."
 			},
@@ -531,6 +957,18 @@
 				],
 				"description": "The list of entries from the query."
 			},
+			"EntityStorageRemoveBatchRequest": {
+				"type": "array",
+				"items": {
+					"type": "string"
+				},
+				"description": "The ids of the entities to remove."
+			},
+			"EntityStorageSetBatchRequest": {
+				"type": "array",
+				"items": {},
+				"description": "The entities to set."
+			},
 			"EntityStorageSetRequest": {
 				"description": "The data to be used in the entity."
 			},
@@ -544,7 +982,7 @@
 					},
 					"message": {
 						"type": "string",
-						"description": "The message for the error."
+						"description": "The message for the error as an i18n key."
 					},
 					"source": {
 						"type": "string",

package/docs/reference/classes/EntityStorageService.md

@@ -62,7 +62,7 @@ The class name of the component.
 
 ### set() {#set}
 
-> **set**(`entity`): `Promise`\<`void`\>
+> **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
 Set an entity.
 
@@ -74,6 +74,12 @@ Set an entity.
 
 The entity to set.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -86,9 +92,35 @@ The id of the entity.
 
 ***
 
+### setBatch() {#setbatch}
+
+> **setBatch**(`entities`): `Promise`\<`void`\>
+
+Set multiple entities in a batch.
+
+#### Parameters
+
+##### entities
+
+`T`[]
+
+The entities to set.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageComponent.setBatch`
+
+***
+
 ### get() {#get}
 
-> **get**(`id`, `secondaryIndex?`): `Promise`\<`T` \| `undefined`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
 Get an entity.
 
@@ -106,6 +138,12 @@ keyof `T`
 
 Get the item using a secondary index.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`T` \| `undefined`\>
@@ -120,7 +158,7 @@ The object if it can be found or undefined.
 
 ### remove() {#remove}
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
 Remove the entity.
 
@@ -132,6 +170,12 @@ Remove the entity.
 
 The id of the entity to remove.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -144,6 +188,76 @@ Nothing.
 
 ***
 
+### removeBatch() {#removebatch}
+
+> **removeBatch**(`ids`): `Promise`\<`void`\>
+
+Remove multiple entities by id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+The ids of the entities to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageComponent.removeBatch`
+
+***
+
+### empty() {#empty}
+
+> **empty**(): `Promise`\<`void`\>
+
+Remove all entities from the storage.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageComponent.empty`
+
+***
+
+### count() {#count}
+
+> **count**(`conditions?`): `Promise`\<`number`\>
+
+Count all the entities which match the conditions.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`T`\>
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The total count of entities in the storage.
+
+#### Implementation of
+
+`IEntityStorageComponent.count`
+
+***
+
 ### query() {#query}
 
 > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>

package/docs/reference/classes/SchemaVersion.md

@@ -0,0 +1,39 @@
+# Class: SchemaVersion
+
+Tracks the currently applied schema version for each managed entity schema.
+One record per schema name. Written once on first boot, then updated after
+each successful migration.
+
+## Constructors
+
+### Constructor
+
+> **new SchemaVersion**(): `SchemaVersion`
+
+#### Returns
+
+`SchemaVersion`
+
+## Properties
+
+### schemaName {#schemaname}
+
+> **schemaName**: `string`
+
+The entity schema type name — primary key.
+
+***
+
+### version {#version}
+
+> **version**: `number`
+
+The currently deployed version of this schema.
+
+***
+
+### updatedAt {#updatedat}
+
+> **updatedAt**: `string`
+
+ISO 8601 timestamp of the last version write.