@twin.org/entity-storage-connector-file 0.0.1-next.14 → 0.0.1-next.15

package/dist/cjs/index.cjs

@@ -39,8 +39,6 @@ class FileEntityStorageConnector {
     /**
      * Create a new instance of FileEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);

package/dist/esm/index.mjs

@@ -37,8 +37,6 @@ class FileEntityStorageConnector {
     /**
      * Create a new instance of FileEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);

package/dist/types/fileEntityStorageConnector.d.ts

@@ -1,6 +1,6 @@
 import { type EntityCondition, type IEntitySchema, type SortDirection } from "@twin.org/entity";
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
-import type { IFileEntityStorageConnectorConfig } from "./models/IFileEntityStorageConnectorConfig";
+import type { IFileEntityStorageConnectorConstructorOptions } from "./models/IFileEntityStorageConnectorConstructorOptions";
 /**
  * Class for performing entity storage operations in file.
  */
@@ -12,13 +12,8 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
     /**
      * Create a new instance of FileEntityStorageConnector.
      * @param options The options for the connector.
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        entitySchema: string;
-        config: IFileEntityStorageConnectorConfig;
-    });
+    constructor(options: IFileEntityStorageConnectorConstructorOptions);
     /**
      * Bootstrap the connector by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./fileEntityStorageConnector";
 export * from "./models/IFileEntityStorageConnectorConfig";
+export * from "./models/IFileEntityStorageConnectorConstructorOptions";

package/dist/types/models/IFileEntityStorageConnectorConstructorOptions.d.ts

@@ -0,0 +1,14 @@
+import type { IFileEntityStorageConnectorConfig } from "./IFileEntityStorageConnectorConfig";
+/**
+ * Options for the File Entity Storage Connector constructor.
+ */
+export interface IFileEntityStorageConnectorConstructorOptions {
+    /**
+     * The name of the entity schema.
+     */
+    entitySchema: string;
+    /**
+     * The configuration for the connector.
+     */
+    config: IFileEntityStorageConnectorConfig;
+}

package/docs/changelog.md

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

package/docs/reference/classes/FileEntityStorageConnector.md

@@ -20,17 +20,11 @@ Create a new instance of FileEntityStorageConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.entitySchema**: `string`
-
-The name of the entity schema.
-
-• **options.config**: [`IFileEntityStorageConnectorConfig`](../interfaces/IFileEntityStorageConnectorConfig.md)
+[`IFileEntityStorageConnectorConstructorOptions`](../interfaces/IFileEntityStorageConnectorConstructorOptions.md)
 
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
@@ -58,7 +52,9 @@ Bootstrap the connector by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -76,13 +72,13 @@ True if the bootstrapping process was successful.
 
 ### getSchema()
 
-> **getSchema**(): `IEntitySchema`\<`unknown`\>
+> **getSchema**(): `IEntitySchema`
 
 Get the schema for the entities.
 
 #### Returns
 
-`IEntitySchema`\<`unknown`\>
+`IEntitySchema`
 
 The schema for the entities.
 
@@ -100,15 +96,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.
 
@@ -132,11 +134,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.
 
@@ -160,11 +166,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.
 
@@ -182,51 +192,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
 
 Find 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.
-
 #### Implementation of
 
 `IEntityStorageConnector.query`

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IFileEntityStorageConnectorConfig](interfaces/IFileEntityStorageConnectorConfig.md)
+- [IFileEntityStorageConnectorConstructorOptions](interfaces/IFileEntityStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IFileEntityStorageConnectorConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IFileEntityStorageConnectorConstructorOptions
+
+Options for the File Entity Storage Connector constructor.
+
+## Properties
+
+### entitySchema
+
+> **entitySchema**: `string`
+
+The name of the entity schema.
+
+***
+
+### config
+
+> **config**: [`IFileEntityStorageConnectorConfig`](IFileEntityStorageConnectorConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-file",
-	"version": "0.0.1-next.14",
+	"version": "0.0.1-next.15",
 	"description": "Entity Storage connector implementation using file storage",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.14",
+		"@twin.org/entity-storage-models": "0.0.1-next.15",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},