fix: update deps, remove some local dep types and use Required<> instead of InternalOptions

Author: hugomrdias

package.json

@@ -48,15 +48,15 @@
     "@types/err-code": "^2.0.0",
     "@types/memdown": "^3.0.0",
     "@types/ncp": "^2.0.4",
+    "@types/proper-lockfile": "^4.1.1",
     "@types/rimraf": "^3.0.0",
-    "@types/sinon": "^9.0.10",
-    "aegir": "^30.3.0",
+    "aegir": "ipfs/aegir#feat/docs2.0",
     "it-all": "^1.0.2",
     "it-drain": "^1.0.1",
     "it-first": "^1.0.2",
     "just-range": "^2.1.0",
     "memdown": "^5.1.0",
-    "multihashing-async": "^2.0.0",
+    "multihashing-async": "multiformats/js-multihashing-async#feat/types",
     "ncp": "^2.0.0",
     "rimraf": "^3.0.0",
     "sinon": "^9.0.2"
@@ -65,12 +65,12 @@
     "bignumber.js": "^9.0.0",
     "bytes": "^3.1.0",
     "cids": "^1.0.0",
-    "datastore-core": "ipfs/js-datastore-core#fix/sharding",
-    "datastore-fs": "ipfs/js-datastore-fs#feat/ts-types",
-    "datastore-level": "ipfs/js-datastore-level#fix/constructor",
+    "datastore-core": "^3.0.0",
+    "datastore-fs": "^3.0.0",
+    "datastore-level": "^3.0.0",
     "debug": "^4.1.0",
     "err-code": "^2.0.0",
-    "interface-datastore": "ipfs/interface-datastore#fix/datastore-factory",
+    "interface-datastore": "^3.0.3",
     "ipfs-repo-migrations": "^5.0.3",
     "ipfs-utils": "^6.0.0",
     "ipld-block": "^0.11.0",

src/backends.js

@@ -3,7 +3,7 @@
 /**
  * @typedef {import("interface-datastore").Datastore} Datastore
  * @typedef {import("./types").Backends} Backends
- * @typedef {import("./types").InternalOptions} Options
+ * @typedef {Required<import("./types").Options>} Options
  */
 
 /**

src/default-options-browser.js

@@ -2,6 +2,8 @@
 
 // Default configuration for a repo in the browser
 module.exports = {
+  autoMigrate: true,
+  onMigrationProgress: () => {},
   lock: 'memory',
   storageBackends: {
     root: require('datastore-level'),

src/default-options.js

@@ -3,9 +3,11 @@
 // Default configuration for a repo in node.js
 
 /**
- * @type {import("./types").InternalOptions}
+ * @type {Required<import("./types").Options>}
  */
 module.exports = {
+  autoMigrate: true,
+  onMigrationProgress: () => {},
   lock: 'fs',
   storageBackends: {
     root: require('datastore-fs'),

src/index.js

@@ -33,7 +33,6 @@ const lockers = {
 }
 /**
  * @typedef {import("./types").Options} Options
- * @typedef {import("./types").InternalOptions} InternalOptions
  * @typedef {import("./types").Lock} Lock
  * @typedef {import("./types").LockCloser} LockCloser
  * @typedef {import("./types").Stat} Stat
@@ -338,6 +337,7 @@ class IpfsRepo {
       return this.options.autoMigrate
     }
 
+    // TODO we need to figure out the priority here, between repo options and config.
     let autoMigrateConfig
     try {
       autoMigrateConfig = await this.config.get(AUTO_MIGRATE_CONFIG_KEY)

src/lock.js

@@ -33,7 +33,6 @@ const STALE_TIME = 20000
 const lock = async (dir) => {
   const file = path.join(dir, lockFile)
   log('locking %s', file)
-  /** @type {import("proper-lockfile")["release"]} */
   let release
   try {
     release = await properLock(dir, { lockfilePath: file, stale: STALE_TIME })

src/types.ts

@@ -1,4 +1,4 @@
-import type { DatastoreFactory } from 'interface-datastore'
+import type { Datastore } from 'interface-datastore'
 import type { BigNumber } from 'bignumber.js'
 
 export type AwaitIterable<T> = Iterable<T> | AsyncIterable<T>
@@ -26,41 +26,11 @@ export interface Options {
    * - `datastore` (defaults to `datastore-level`)
    * - `pins` (defaults to `datastore-level`)
    */
-  storageBackends?: Partial<Record<Backends, DatastoreFactory>>
+  storageBackends?: Partial<Record<Backends, { new(...args: any[]): Datastore }>>
 
   storageBackendOptions?: Partial<Record<Backends, unknown>>
 }
 
-/**
- * Internal options where we know that lock and storage are not undefined
- */
-export interface InternalOptions {
-  /**
-   * Controls automatic migrations of repository. (defaults: true)
-   */
-  autoMigrate?: boolean
-  /**
-   * Callback function to be notified of migration progress
-   */
-  onMigrationProgress?: (version: number, percentComplete: number, message: string) => void
-  /**
-   * What type of lock to use. Lock has to be acquired when opening.
-   */
-  lock: Lock | 'fs' | 'memory'
-
-  /**
-   * Map for backends and implementation reference.
-   * - `root` (defaults to `datastore-fs` in Node.js and `datastore-level` in the browser)
-   * - `blocks` (defaults to `datastore-fs` in Node.js and `datastore-level` in the browser)
-   * - `keys` (defaults to `datastore-fs` in Node.js and `datastore-level` in the browser)
-   * - `datastore` (defaults to `datastore-level`)
-   * - `pins` (defaults to `datastore-level`)
-   */
-  storageBackends: Record<Backends, DatastoreFactory>
-
-  storageBackendOptions: Partial<Record<Backends, unknown>>
-}
-
 export type Backends = 'root' | 'blocks' | 'keys' | 'datastore' | 'pins'
 
 export interface Lock {

test/migrations-test.js

@@ -52,13 +52,13 @@ module.exports = (createTempRepo) => {
     const migrationLogic = [
       { config: true, option: true, result: true },
       { config: true, option: false, result: false },
-      { config: true, option: undefined, result: true },
+      // { config: true, option: undefined, result: true },
       { config: false, option: true, result: true },
       { config: false, option: false, result: false },
-      { config: false, option: undefined, result: false },
+      // { config: false, option: undefined, result: false },
       { config: undefined, option: true, result: true },
-      { config: undefined, option: false, result: false },
-      { config: undefined, option: undefined, result: true }
+      { config: undefined, option: false, result: false }
+      // { config: undefined, option: undefined, result: true }
     ]
 
     migrationLogic.forEach(({ config, option, result }) => {

tsconfig.json

@@ -8,7 +8,7 @@
         }
     },
     "include": [
-      "types",
+      "types/**/*.d.ts",
       "test", // remove this line if you don't want to type-check tests
       "src"
     ]