@twin.org/entity-storage-connector-file 0.0.3-next.6 → 0.0.3-next.7

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Entity Storage Connector File
+# Entity Storage Connector File
 
-Entity Storage connector implementation using file storage.
+This package provides a file-backed backend for persisting entities on local or mounted disks in straightforward environments. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,20 @@
-# @twin.org/entity-storage-connector-file - Changelog
+# Changelog
+
+## [0.0.3-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.3-next.6...entity-storage-connector-file-v0.0.3-next.7) (2026-03-13)
+
+
+### Bug Fixes
+
+* adding tests and fixes for dot notation ([#76](https://github.com/twinfoundation/entity-storage/issues/76)) ([3879337](https://github.com/twinfoundation/entity-storage/commit/387933797e33543e4d8b2d49b8beeb792512a4ff))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.6 to 0.0.3-next.7
 
 ## [0.0.3-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-file-v0.0.3-next.5...entity-storage-connector-file-v0.0.3-next.6) (2026-01-21)
 

package/docs/examples.md

@@ -1 +1,69 @@
-# @twin.org/entity-storage-connector-file - Examples
+# Entity Storage Connector File Examples
+
+Use this page to see local-file storage workflows for bootstrapping, entity lifecycle operations, and filtered querying.
+
+## FileEntityStorageConnector
+
+```typescript
+import {
+  FileEntityStorageConnector,
+  type IFileEntityStorageConnectorConstructorOptions
+} from '@twin.org/entity-storage-connector-file';
+import {
+  ComparisonOperator,
+  LogicalOperator,
+  SortDirection,
+  type EntityCondition
+} from '@twin.org/entity';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const options: IFileEntityStorageConnectorConstructorOptions = {
+  entitySchema: 'Profile',
+  config: {
+    directory: './data/profiles'
+  }
+};
+
+const connector = new FileEntityStorageConnector<Profile>(options);
+await connector.bootstrap();
+
+const className = connector.className();
+const schema = connector.getSchema();
+
+await connector.set({
+  id: 'profile-1',
+  email: 'ada@example.com',
+  status: 'active',
+  createdAt: '2026-03-09T10:30:00.000Z'
+});
+
+const byPrimaryKey = await connector.get('profile-1');
+const bySecondaryIndex = await connector.get('ada@example.com', 'email');
+
+const activeCondition: EntityCondition<Profile> = {
+  logicalOperator: LogicalOperator.And,
+  conditions: [
+    {
+      property: 'status',
+      comparison: ComparisonOperator.Equals,
+      value: 'active'
+    }
+  ]
+};
+
+const result = await connector.query(
+  activeCondition,
+  [{ property: 'createdAt', sortDirection: SortDirection.Descending }],
+  ['id', 'email', 'status'],
+  undefined,
+  25
+);
+
+await connector.remove('profile-1');
+```

package/docs/reference/classes/FileEntityStorageConnector.md

@@ -34,7 +34,7 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -42,7 +42,7 @@ Runtime name for the class.
 
 ## Methods
 
-### bootstrap()
+### bootstrap() {#bootstrap}
 
 > **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
@@ -68,7 +68,7 @@ True if the bootstrapping process was successful.
 
 ***
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -86,7 +86,7 @@ The class name of the component.
 
 ***
 
-### getSchema()
+### getSchema() {#getschema}
 
 > **getSchema**(): `IEntitySchema`
 
@@ -104,7 +104,7 @@ The schema for the entities.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
@@ -142,7 +142,7 @@ The object if it can be found or undefined.
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
@@ -174,7 +174,7 @@ The id of the entity.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
@@ -206,7 +206,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IFileEntityStorageConnectorConfig.md

@@ -4,7 +4,7 @@ Configuration for the File Entity Storage Connector.
 
 ## Properties
 
-### directory
+### directory {#directory}
 
 > **directory**: `string`
 

package/docs/reference/interfaces/IFileEntityStorageConnectorConstructorOptions.md

@@ -4,7 +4,7 @@ Options for the File Entity Storage Connector constructor.
 
 ## Properties
 
-### entitySchema
+### entitySchema {#entityschema}
 
 > **entitySchema**: `string`
 
@@ -12,7 +12,7 @@ The name of the entity schema.
 
 ***
 
-### partitionContextIds?
+### partitionContextIds? {#partitioncontextids}
 
 > `optional` **partitionContextIds**: `string`[]
 
@@ -20,7 +20,7 @@ The keys to use from the context ids to create partitions.
 
 ***
 
-### config
+### config {#config}
 
 > **config**: [`IFileEntityStorageConnectorConfig`](IFileEntityStorageConnectorConfig.md)
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/entity-storage-connector-file",
-	"version": "0.0.3-next.6",
-	"description": "Entity Storage connector implementation using file storage",
+	"version": "0.0.3-next.7",
+	"description": "File-based connector that stores entities on disk for straightforward deployments.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/entity-storage.git",
@@ -17,7 +17,7 @@
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.3-next.6",
+		"@twin.org/entity-storage-models": "0.0.3-next.7",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},