@twin.org/entity-storage-models 0.0.1-next.14 → 0.0.1-next.16

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/entity-storage-models - Changelog
 
-## v0.0.1-next.14
+## v0.0.1-next.16
 
 - Initial Release

package/docs/reference/interfaces/IEntityStorageComponent.md

@@ -20,15 +20,21 @@ Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
@@ -48,19 +54,27 @@ Get an entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to get, or the index value if secondaryIndex is set.
 
-• **secondaryIndex?**: keyof `T`
+##### secondaryIndex?
+
+keyof `T`
 
 Get the item using a secondary index.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
@@ -80,15 +94,21 @@ Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
@@ -102,59 +122,63 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 Query all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **orderBy?**: keyof `T`
+##### orderBy?
+
+keyof `T`
 
 The order for the results.
 
-• **orderByDirection?**: `SortDirection`
+##### orderByDirection?
+
+`SortDirection`
 
 The direction for the order, defaults to ascending.
 
-• **properties?**: keyof `T`[]
+##### properties?
+
+keyof `T`[]
 
 The optional properties to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The user identity to use with storage operations.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use with storage operations.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
-
-##### entities
-
-> **entities**: `Partial`\<`T`\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IEntityStorageConnector.md

@@ -14,13 +14,13 @@ Interface describing an entity storage connector.
 
 ### getSchema()
 
-> **getSchema**(): `IEntitySchema`\<`unknown`\>
+> **getSchema**(): `IEntitySchema`
 
 Get the schema for the entities.
 
 #### Returns
 
-`IEntitySchema`\<`unknown`\>
+`IEntitySchema`
 
 The schema for the entities.
 
@@ -34,11 +34,15 @@ Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -58,15 +62,21 @@ Get an entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to get, or the index value if secondaryIndex is set.
 
-• **secondaryIndex?**: keyof `T`
+##### secondaryIndex?
+
+keyof `T`
 
 Get the item using a secondary index.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -86,11 +96,15 @@ Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
-• **conditions?**: `object`[]
+##### conditions?
+
+`object`[]
 
 The optional conditions to match for the entities.
 
@@ -104,47 +118,45 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 Query all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof `T`[]
+##### properties?
+
+keyof `T`[]
 
 The optional properties to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
-
-##### entities
-
-> **entities**: `Partial`\<`T`\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/variables/EntityStorageConnectorFactory.md

@@ -1,5 +1,5 @@
 # Variable: EntityStorageConnectorFactory
 
-> `const` **EntityStorageConnectorFactory**: `Factory`\<[`IEntityStorageConnector`](../interfaces/IEntityStorageConnector.md)\<`unknown`\>\>
+> `const` **EntityStorageConnectorFactory**: `Factory`\<[`IEntityStorageConnector`](../interfaces/IEntityStorageConnector.md)\>
 
 Factory for creating entity storage connectors.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-models",
-	"version": "0.0.1-next.14",
+	"version": "0.0.1-next.16",
 	"description": "Models which define the structure of the entity storage contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -23,9 +23,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},