Merge pull request #4 from jrfso/next

v0.2.0 Simplify generic types, export mutative helpers
jrfso · Oct 5, 2024 · 18b8925 · 18b8925
2 parents 393c15c + c7fa52a
commit 18b8925
Show file tree

Hide file tree

Showing 18 changed files with 192 additions and 181 deletions.
diff --git a/labs/demo-server/package.json b/labs/demo-server/package.json
@@ -31,8 +31,8 @@
     "start-win": "nodemon",
     "start-bin": "node bin/jrfs-demo-server.cjs",
     "test": "echo 'Sorry, no tests yet!'",
-    "watch": "tsc -w --noEmit --pretty --skipLibCheck --project tsconfig.eslint.json",
-    "watch-build": "node --watch-path=./src --watch-path=../../node_modules/@jrfs ../../scripts/build-esm.mjs"
+    "watch": "node --watch-path=./src --watch-path=../../node_modules/@jrfs ../../scripts/build-esm.mjs",
+    "watch-ts": "tsc -w --noEmit --pretty --skipLibCheck --project tsconfig.eslint.json"
   },
   "nodemonConfig": {
     "delay": "250ms",

diff --git a/labs/demo-server/src/api/project/repo/fs.ts b/labs/demo-server/src/api/project/repo/fs.ts
@@ -1,4 +1,3 @@
-// import { apply } from "mutative";
 // Local
 import { Maybe, Tags, Type, Static, apiController, define } from "@/common/api";
 import { Entry, TransactionOutParams } from "@jrfs/node";

diff --git a/labs/demo-shared/package.json b/labs/demo-shared/package.json
@@ -27,7 +27,7 @@
     "lint-fix": "eslint . --ext .ts --fix",
     "lint-ts": "tsc --noEmit --pretty --project ./tsconfig.eslint.json",
     "rm-build": "shx rm -rf lib/*",
-    "watch-build": "node --watch-path=./src --watch-path=../../node_modules/@jrfs ../../scripts/build-esm.mjs lib --tsconfig tsconfig.prod.json"
+    "watch": "node --watch-path=./src --watch-path=../../node_modules/@jrfs ../../scripts/build-esm.mjs lib --tsconfig tsconfig.prod.json"
   },
   "dependencies": {
     "nanoid": "^5.0.7"

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jrfs/core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "JRFS core library.",
   "repository": "github:jrfso/jrfs",
   "homepage": "https://github.com/jrfso/jrfs/tree/master/packages/core",
@@ -32,7 +32,7 @@
     "lint-fix": "eslint . --ext .ts --fix",
     "lint-ts": "tsc --noEmit --pretty --project ./tsconfig.eslint.json",
     "rm-build": "shx rm -rf lib/*",
-    "watch-build": "node --watch-path=./src ../../scripts/build-esm.mjs lib --tsconfig tsconfig.prod.json"
+    "watch": "node --watch-path=./src ../../scripts/build-esm.mjs lib --tsconfig tsconfig.prod.json"
   },
   "dependencies": {
     "mutative": "1.0.11"

diff --git a/packages/core/src/Driver.ts b/packages/core/src/Driver.ts
@@ -3,25 +3,22 @@ import type {
   Entry,
   FileTree,
   FileTypeProvider,
-  FileTypes,
   MutativePatches,
 } from "@/index";
 import { type CreateShortIdFunction } from "@/helpers";
 import { INTERNAL } from "@/internal/types";
 import { WritableFileTree } from "@/WritableFileTree";
 
 /** Base JRFS driver class. */
-export abstract class Driver<FT extends FileTypes<FT>> {
-  #fileTree: WritableFileTree;
-  #fileTypes: FileTypeProvider<FT>;
+export abstract class Driver {
+  #createShortId: CreateShortIdFunction;
+  #fileTree = null! as WritableFileTree;
+  #fileTypes: FileTypeProvider<any>;
   /** `true` if {@link open}, `false` if {@link close}d */
   #opened = false;
 
-  constructor(props: DriverProps<FT>) {
-    this.#fileTree = WritableFileTree[INTERNAL].create(
-      props.fileTree,
-      props.createShortId,
-    );
+  constructor(props: DriverProps) {
+    this.#createShortId = props.createShortId;
     this.#fileTypes = props.fileTypes;
   }
 
@@ -63,11 +60,15 @@ export abstract class Driver<FT extends FileTypes<FT>> {
   /** Handles opening the repo. */
   protected abstract onOpen(): Promise<void>;
 
-  async open() {
+  async open(fileTree: FileTree) {
     const opened = this.#opened;
     if (opened) {
       throw new Error(`Driver has already opened ${this}`);
     }
+    this.#fileTree = WritableFileTree[INTERNAL].create(
+      fileTree,
+      this.#createShortId,
+    );
     await this.onOpen();
     // Save state.
     this.#opened = true;
@@ -164,15 +165,11 @@ export interface TransactionParams {
 }
 
 /** Callback to create a driver. */
-export type DriverFactory = <FT extends FileTypes<FT>>(
-  props: DriverProps<FT>,
-  options: any,
-) => Driver<FT>;
+export type DriverFactory = (props: DriverProps, options: any) => Driver;
 
-export interface DriverProps<FT extends FileTypes<FT>> {
+export interface DriverProps {
   createShortId: CreateShortIdFunction;
-  fileTypes: FileTypeProvider<FT>;
-  fileTree: FileTree;
+  fileTypes: FileTypeProvider<any>;
 }
 /**
  * Interface to declare a driver options types onto.
@@ -187,9 +184,6 @@ export interface DriverTypeOptions {
   // e.g. ["fs"]: FsDriverOptions;
 }
 /** Interface to declare driver types onto. */
-export interface DriverTypes<
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  FT extends FileTypes<FT>,
-> {
+export interface DriverTypes {
   // e.g. ["fs"]: FsDriver;
 }