@travetto/model 2.0.3 → 2.1.2

package/README.md

@@ -196,7 +196,7 @@ export interface ModelBulkSupport extends ModelCrudSupport {
 ```
 
 ## Declaration
-Models are declared via the [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L13) decorator, which allows the system to know that this is a class that is compatible with the module.  The only requirement for a model is the [ModelType](https://github.com/travetto/travetto/tree/main/module/model/src/types/model.ts#L4)
+Models are declared via the [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L12) decorator, which allows the system to know that this is a class that is compatible with the module.  The only requirement for a model is the [ModelType](https://github.com/travetto/travetto/tree/main/module/model/src/types/model.ts#L4)
 
 **Code: ModelType**
 ```typescript
@@ -236,7 +236,7 @@ All fields are optional, but the `id` and `type` are important as those field ty
 |[S3 Model Support](https://github.com/travetto/travetto/tree/main/module/model-s3#readme "S3 backing for the travetto model module.")|X|X| |X|X| |
 |[SQL Model Service](https://github.com/travetto/travetto/tree/main/module/model-sql#readme "SQL backing for the travetto model module, with real-time modeling support for SQL schemas.")|X|X|X|X| |X|
 |[MemoryModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/memory.ts#L50)|X|X|X|X|X|X|
-|[FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L48)|X|X| |X|X|X|
+|[FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L47)|X|X| |X|X|X|
 
 ## Custom Model Service
 In addition to the provided contracts, the module also provides common utilities and shared test suites.  The common utilities are useful for
@@ -375,7 +375,7 @@ export class MemoryPolymorphicSuite extends ModelPolymorphismSuite {
 
 ## CLI - model:export
 
-The module provides the ability to generate an export of the model structure from all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L13)s within the application.  This is useful for being able to generate the appropriate files to manually create the data schemas in production.
+The module provides the ability to generate an export of the model structure from all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L12)s within the application.  This is useful for being able to generate the appropriate files to manually create the data schemas in production.
 
 **Terminal: Running model export**
 ```bash
@@ -390,7 +390,7 @@ Options:
 
 ## CLI - model:install
 
-The module provides the ability to install all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L13)s within the application given the current configuration being targetted.  This is useful for being able to prepare the datastore manually.
+The module provides the ability to install all the various [@Model](https://github.com/travetto/travetto/tree/main/module/model/src/registry/decorator.ts#L12)s within the application given the current configuration being targetted.  This is useful for being able to prepare the datastore manually.
 
 **Terminal: Running model install**
 ```bash

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/model",
   "displayName": "Data Modeling Support",
-  "version": "2.0.3",
+  "version": "2.1.2",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -28,13 +28,13 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/di": "^2.0.3",
-    "@travetto/config": "^2.0.3",
-    "@travetto/registry": "^2.0.2",
-    "@travetto/schema": "^2.0.5"
+    "@travetto/di": "^2.1.2",
+    "@travetto/config": "^2.1.2",
+    "@travetto/registry": "^2.1.2",
+    "@travetto/schema": "^2.1.2"
   },
   "optionalPeerDependencies": {
-    "@travetto/cli": "^2.0.2"
+    "@travetto/cli": "^2.1.2"
   },
   "publishConfig": {
     "access": "public"

package/src/provider/file.ts

@@ -1,4 +1,5 @@
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
+import { createReadStream } from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 
@@ -47,8 +48,8 @@ export class FileModelConfig {
 export class FileModelService implements ModelCrudSupport, ModelStreamSupport, ModelExpirySupport, ModelStorageSupport {
 
   private static async * scanFolder(folder: string, suffix: string) {
-    for (const sub of await fs.promises.readdir(folder)) {
-      for (const file of await fs.promises.readdir(PathUtil.resolveUnix(folder, sub))) {
+    for (const sub of await fs.readdir(folder)) {
+      for (const file of await fs.readdir(PathUtil.resolveUnix(folder, sub))) {
         if (file.endsWith(suffix)) {
           yield [file.replace(suffix, ''), PathUtil.resolveUnix(folder, sub, file)] as [id: string, file: string];
         }
@@ -79,7 +80,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
       dir = path.dirname(resolved);
     }
     if (!await FsUtil.exists(dir)) {
-      await fs.promises.mkdir(dir, { recursive: true });
+      await fs.mkdir(dir, { recursive: true });
     }
     return resolved;
   }
@@ -114,7 +115,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(cls, '.json', id);
 
     if (await FsUtil.exists(file)) {
-      const content = await StreamUtil.streamToBuffer(fs.createReadStream(file));
+      const content = await StreamUtil.streamToBuffer(createReadStream(file));
       return this.checkExpiry(cls, await ModelCrudUtil.load(cls, content));
     }
 
@@ -129,7 +130,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(cls, '.json', item.id);
 
     if (await FsUtil.exists(file)) {
-      throw new ExistsError(cls, item.id);
+      throw new ExistsError(cls, item.id!);
     }
 
     return await this.upsert(cls, item);
@@ -145,7 +146,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const prepped = await ModelCrudUtil.preStore(cls, item, this);
 
     const file = await this.#resolveName(cls, '.json', item.id);
-    await fs.promises.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
+    await fs.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
 
     return prepped;
   }
@@ -155,14 +156,14 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const id = item.id;
     item = await ModelCrudUtil.naivePartialUpdate(cls, item, view, () => this.get(cls, id));
     const file = await this.#resolveName(cls, '.json', item.id);
-    await fs.promises.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
+    await fs.writeFile(file, JSON.stringify(item), { encoding: 'utf8' });
 
     return item as T;
   }
 
   async delete<T extends ModelType>(cls: Class<T>, id: string) {
     const file = await this.#find(cls, '.json', id);
-    await fs.promises.unlink(file);
+    await fs.unlink(file);
   }
 
   async * list<T extends ModelType>(cls: Class<T>) {
@@ -182,18 +183,18 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(STREAMS, BIN, location);
     await Promise.all([
       StreamUtil.writeToFile(input, file),
-      fs.promises.writeFile(file.replace(BIN, META), JSON.stringify(meta), 'utf8')
+      fs.writeFile(file.replace(BIN, META), JSON.stringify(meta), 'utf8')
     ]);
   }
 
   async getStream(location: string) {
     const file = await this.#find(STREAMS, BIN, location);
-    return fs.createReadStream(file);
+    return createReadStream(file);
   }
 
   async describeStream(location: string) {
     const file = await this.#find(STREAMS, META, location);
-    const content = await StreamUtil.streamToBuffer(fs.createReadStream(file));
+    const content = await StreamUtil.streamToBuffer(createReadStream(file));
     const text = JSON.parse(content.toString('utf8'));
     return text as StreamMeta;
   }
@@ -202,8 +203,8 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
     const file = await this.#resolveName(STREAMS, BIN, location);
     if (await FsUtil.exists(file)) {
       await Promise.all([
-        fs.promises.unlink(file),
-        fs.promises.unlink(file.replace('.bin', META))
+        fs.unlink(file),
+        fs.unlink(file.replace('.bin', META))
       ]);
     } else {
       throw new NotFoundError('Stream', location);
@@ -224,7 +225,7 @@ export class FileModelService implements ModelCrudSupport, ModelStreamSupport, M
   // Storage mgmt
   async createStorage() {
     const dir = PathUtil.resolveUnix(this.config.folder, this.config.namespace);
-    await fs.promises.mkdir(dir, { recursive: true });
+    await fs.mkdir(dir, { recursive: true });
   }
 
   async deleteStorage() {

package/test-support/stream.ts

@@ -1,5 +1,6 @@
 import * as assert from 'assert';
-import * as fs from 'fs';
+import * as fs from 'fs/promises';
+import { createReadStream } from 'fs';
 import * as crypto from 'crypto';
 
 import { PathUtil } from '@travetto/boot';
@@ -25,12 +26,12 @@ export abstract class ModelStreamSuite extends BaseModelSuite<ModelStreamSupport
 
   async getStream(resource: string) {
     const file = await ResourceManager.findAbsolute(resource);
-    const stat = await fs.promises.stat(file);
-    const hash = await this.getHash(fs.createReadStream(file));
+    const stat = await fs.stat(file);
+    const hash = await this.getHash(createReadStream(file));
 
     return [
       { size: stat.size, contentType: '', hash, filename: resource },
-      fs.createReadStream(file)
+      createReadStream(file)
     ] as const;
   }