@twin.org/entity-storage-connector-file 0.0.3-next.2 → 0.0.3-next.21

package/dist/types/fileEntityStorageConnector.d.ts

@@ -1,5 +1,7 @@
+import { type IContextIds } from "@twin.org/context";
+import { type IHealth } from "@twin.org/core";
 import { type EntityCondition, type IEntitySchema, type SortDirection } from "@twin.org/entity";
-import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
+import { type IEntityStorageConnector, type IMigrationOptions } from "@twin.org/entity-storage-models";
 import type { IFileEntityStorageConnectorConstructorOptions } from "./models/IFileEntityStorageConnectorConstructorOptions.js";
 /**
  * Class for performing entity storage operations in file.
@@ -25,6 +27,11 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
      * @returns The class name of the component.
      */
     className(): string;
+    /**
+     * Returns the health status of the component.
+     * @returns The health status of the component, can return multiple entries for elements within the component.
+     */
+    health(): Promise<IHealth[]>;
     /**
      * Get the schema for the entities.
      * @returns The schema for the entities.
@@ -51,6 +58,29 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
         property: keyof T;
         value: unknown;
     }[]): Promise<void>;
+    /**
+     * Set multiple entities in a batch.
+     * @param entities The entities to set.
+     * @returns Nothing.
+     */
+    setBatch(entities: T[]): Promise<void>;
+    /**
+     * Remove all entities from the storage.
+     * @returns Nothing.
+     */
+    empty(): Promise<void>;
+    /**
+     * Remove multiple entities by id.
+     * @param ids The ids of the entities to remove.
+     * @returns Nothing.
+     */
+    removeBatch(ids: string[]): Promise<void>;
+    /**
+     * Teardown the storage by deleting the underlying store file.
+     * @param nodeLoggingComponentType The node logging component type.
+     * @returns True if the teardown process was successful.
+     */
+    teardown(nodeLoggingComponentType?: string): Promise<boolean>;
     /**
      * Remove the entity.
      * @param id The id of the entity to remove.
@@ -84,4 +114,37 @@ export declare class FileEntityStorageConnector<T = unknown> implements IEntityS
          */
         cursor?: string;
     }>;
+    /**
+     * Count all the entities which match the conditions.
+     * @param conditions The optional conditions to match for the entities.
+     * @returns The total count of entities in the storage.
+     */
+    count(conditions?: EntityCondition<T>): Promise<number>;
+    /**
+     * Get a unique list of all the context ids from the storage.
+     * @returns The list of unique context ids.
+     */
+    getPartitionContextIds(): Promise<IContextIds[]>;
+    /**
+     * Create the target connector for performing the migration it will use a temporary storage location.
+     * @param newEntitySchema The name of the new entity schema to create the connector for.
+     * @returns Connector for performing the migration.
+     */
+    createTargetConnector<U>(newEntitySchema: string): Promise<IEntityStorageConnector<U>>;
+    /**
+     * Finalize the migration by tearing down the old connector and replacing it with the target connector.
+     * @param targetConnector The target connector to finalize the migration with.
+     * @param options The options to control how the migration is finalized.
+     * @param loggingComponentType The optional component type to use for logging the migration progress.
+     * @returns A promise that resolves when the migration is finalized.
+     */
+    finalizeMigration<U>(targetConnector: FileEntityStorageConnector<U>, options?: IMigrationOptions<T, U>, loggingComponentType?: string): Promise<IEntityStorageConnector<U>>;
+    /**
+     * Cleanup the migration if a migration fails or needs to be aborted.
+     * @param targetConnector The target connector to cleanup the migration with.
+     * @param options The options to control how the migration is cleaned up.
+     * @param loggingComponentType The optional component type to use for logging the migration progress.
+     * @returns A promise that resolves when the migration is cleaned up.
+     */
+    cleanupMigration<U>(targetConnector: IEntityStorageConnector<U> | undefined, options?: IMigrationOptions<T, U>, loggingComponentType?: string): Promise<void>;
 }

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

@@ -6,4 +6,14 @@ export interface IFileEntityStorageConnectorConfig {
      * The directory to use for storage.
      */
     directory: string;
+    /**
+     * The number of free bytes below which the health check reports an error.
+     * Defaults to 100 MB.
+     */
+    diskErrorThresholdBytes?: number;
+    /**
+     * The number of free bytes below which the health check reports a warning.
+     * Defaults to 500 MB.
+     */
+    diskWarningThresholdBytes?: number;
 }