chore: add exports for files (#343)

No more deep imports, instead export files.

This means browsers don't accidentally import node's `fs` module via `FSLock`, etc.

Author: achingbrain

packages/ipfs-repo/README.md

@@ -21,13 +21,10 @@ This is the implementation of the [IPFS repo spec](https://github.com/ipfs/specs
 - [Background](#background)
 - [Install](#install)
   - [npm](#npm)
-  - [Use in Node.js](#use-in-nodejs)
-  - [Use in a browser with browserify, webpack or any other bundler](#use-in-a-browser-with-browserify-webpack-or-any-other-bundler)
-  - [Use in a browser Using a script tag](#use-in-a-browser-using-a-script-tag)
 - [Usage](#usage)
 - [API](#api)
   - [Setup](#setup)
-    - [`new Repo(path[, options])`](#new-repopath-options)
+    - [`createRepo(path[, options])`](#createrepopath-options)
     - [`Promise repo.init()`](#promise-repoinit)
     - [`Promise repo.open()`](#promise-repoopen)
     - [`Promise repo.close()`](#promise-repoclose)
@@ -117,33 +114,18 @@ This provides a well defined interface for creating and interacting with an IPFS
 > npm install ipfs-repo
 ```
 
-### Use in Node.js
-
-```js
-var IPFSRepo from 'ipfs-repo')
-```
-
-### Use in a browser with browserify, webpack or any other bundler
-
 ```js
-var IPFSRepo from 'ipfs-repo')
-```
-
-### Use in a browser Using a script tag
-
-Loading this module through a script tag will make the `IpfsRepo` obj available in the global namespace.
-
-```html
-<script src="https://unpkg.com/ipfs-repo/dist/index.min.js"></script>
+import { createRepo } from 'ipfs-repo'
 ```
 
 ## Usage
 
 Example:
 
 ```js
-const Repo from 'ipfs-repo')
-const repo = new Repo('/tmp/ipfs-repo')
+import { createRepo } from 'ipfs-repo'
+
+const repo = createRepo('/tmp/ipfs-repo')
 
 await repo.init({ cool: 'config' })
 await repo.open()
@@ -166,7 +148,7 @@ This now has created the following structure, either on disk or as an in memory
 
 ### Setup
 
-#### `new Repo(path[, options])`
+#### `createRepo(path[, options])`
 
 Creates an IPFS Repo.
 
@@ -184,7 +166,7 @@ Arguments:
     * `datastore` (defaults to [`datastore-level`](https://github.com/ipfs/js-datastore-level#readme)). Defines the back-end type used as the key-value store used for gets and puts of values at `repo.datastore`.
 
 ```js
-const repo = new Repo('path/to/repo')
+const repo = createRepo('path/to/repo')
 ```
 
 #### `Promise repo.init()`
@@ -367,8 +349,8 @@ Returned promise resolves to an `Object` with the following keys:
 IPFS Repo comes with two built in locks: memory and fs. These can be imported via the following:
 
 ```js
-const fsLock from 'ipfs-repo/src/lock')  // Default in Node.js
-const memoryLock from 'ipfs-repo/src/lock-memory')  // Default in browser
+import { FSLock } from 'ipfs-repo/locks/fs'  // Default in Node.js
+import { MemoryLock } from 'ipfs-repo/locks/memory'  // Default in browser
 ```
 
 You can also provide your own custom Lock. It must be an object with the following interface:

packages/ipfs-repo/package.json

@@ -3,9 +3,21 @@
   "version": "13.0.2",
   "description": "IPFS Repo implementation",
   "leadMaintainer": "Alex Potsides <[email protected]>",
+  "type": "module",
   "main": "src/index.js",
   "types": "types/src/index.d.ts",
-  "type": "module",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "types/*",
+        "types/src/*"
+      ],
+      "types/*": [
+        "types/*",
+        "types/src/*"
+      ]
+    }
+  },
   "files": [
     "*",
     "!**/*.tsbuildinfo"
@@ -19,11 +31,35 @@
   "publishConfig": {
     "directory": "dist"
   },
+  "exports": {
+    ".": {
+      "import": "./src/index.js"
+    },
+    "./constants": {
+      "import": "./src/constants.js"
+    },
+    "./errors": {
+      "import": "./src/errors.js"
+    },
+    "./pin-types": {
+      "import": "./src/pin-types.js"
+    },
+    "./locks/memory": {
+      "import": "./src/locks/memory.js"
+    },
+    "./locks/fs": {
+      "browser": "./src/locks/memory.js",
+      "import": "./src/locks/fs.js"
+    },
+    "./utils/blockstore": {
+      "import": "./src/utils/blockstore.js"
+    },
+    "./utils/level": {
+      "import": "./src/utils/level.js"
+    }
+  },
   "browser": {
-    "rimraf": false,
-    "datastore-fs": "datastore-level",
-    "./src/locks/fs.js": "./src/locks/memory.js",
-    "./src/default-options.js": "./src/default-options.browser.js"
+    "rimraf": false
   },
   "scripts": {
     "clean": "rimraf dist types",

packages/ipfs-repo/src/config.js

@@ -4,7 +4,7 @@ import PQueue from 'p-queue'
 import _get from 'just-safe-get'
 import _set from 'just-safe-set'
 import errCode from 'err-code'
-import { NotFoundError } from './errors/index.js'
+import { NotFoundError } from './errors.js'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import { getWithFallback, hasWithFallback } from './utils/level.js'

packages/ipfs-repo/src/default-options.browser.js

@@ -1,6 +1,4 @@
-import * as FsLock from './locks/fs.js'
-
-// Default configuration for a repo in node.js
+import { MemoryLock } from './locks/memory.js'
 
 /**
  * @type {Partial<import('./types').Options>}
@@ -9,5 +7,5 @@ export default {
   autoMigrate: true,
   onMigrationProgress: () => {},
   repoOwner: true,
-  repoLock: FsLock
+  repoLock: MemoryLock
 }

packages/ipfs-repo/src/default-options.js

@@ -31,7 +31,7 @@ const MFS_ROOT_KEY = new Key('/local/filesroot')
  *
  * @param {object} config
  * @param {import('./types').GCLock} config.gcLock
- * @param {import('./pins').Pins} config.pins
+ * @param {import('./types').Pins} config.pins
  * @param {Blockstore} config.blockstore
  * @param {import('interface-datastore').Datastore} config.root
  * @param {loadCodec} config.loadCodec
@@ -69,7 +69,7 @@ export function gc ({ gcLock, pins, blockstore, root, loadCodec }) {
  * Get Set of CIDs of blocks to keep
  *
  * @param {object} config
- * @param {import('./pins').Pins} config.pins
+ * @param {import('./pin-manager').Pins} config.pins
  * @param {import('interface-blockstore').Blockstore} config.blockstore
  * @param {import('interface-datastore').Datastore} config.root
  * @param {loadCodec} config.loadCodec

packages/ipfs-repo/src/errors/index.js renamed to packages/ipfs-repo/src/errors.js

@@ -12,15 +12,12 @@ import { apiAddr } from './api-addr.js'
 import { createIdStore } from './idstore.js'
 import defaultOptions from './default-options.js'
 import defaultDatastore from './default-datastore.js'
-import * as ERRORS from './errors/index.js'
-import { PinManager, PinTypes as PinTypesImport } from './pins.js'
+import * as ERRORS from './errors.js'
+import { PinManager } from './pin-manager.js'
 import { createPinnedBlockstore } from './pinned-blockstore.js'
 // @ts-ignore - no types
 import mortice from 'mortice'
 import { gc } from './gc.js'
-import * as MemoryLock from './locks/memory.js'
-import * as FSLock from './locks/fs.js'
-import * as BlockstoreUtils from './utils/blockstore.js'
 
 const log = debug('ipfs:repo')
 
@@ -439,21 +436,6 @@ export function createRepo (path, loadCodec, backends, options) {
   return new Repo(path, loadCodec, backends, options)
 }
 
-export const repoVersion = CONSTANTS.repoVersion
-
-export const errors = ERRORS
-
-export const utils = {
-  blockstore: BlockstoreUtils
-}
-
-export const locks = {
-  memory: MemoryLock,
-  fs: FSLock
-}
-
-export const PinTypes = PinTypesImport
-
 /**
  * @param {import('./types').Config} _config
  */

packages/ipfs-repo/src/gc.js

@@ -1,4 +1,4 @@
-import { LockExistsError } from '../errors/index.js'
+import { LockExistsError } from '../errors.js'
 import path from 'path'
 import debug from 'debug'
 import { lock as properLock, check } from 'proper-lockfile'
@@ -28,7 +28,7 @@ const STALE_TIME = 20000
  * @param {string} dir
  * @returns {Promise<LockCloser>}
  */
-export const lock = async (dir) => {
+const lock = async (dir) => {
   const file = path.join(dir, lockFile)
   log('locking %s', file)
   let release
@@ -52,8 +52,13 @@ export const lock = async (dir) => {
  * @param {string} dir
  * @returns {Promise<boolean>}
  */
-export const locked = (dir) => {
+const locked = (dir) => {
   const file = path.join(dir, lockFile)
 
   return check(dir, { lockfilePath: file, stale: STALE_TIME })
 }
+
+export const FSLock = {
+  lock,
+  locked
+}

packages/ipfs-repo/src/index.js

@@ -1,5 +1,5 @@
 
-import { LockExistsError } from '../errors/index.js'
+import { LockExistsError } from '../errors.js'
 import debug from 'debug'
 
 const log = debug('ipfs:repo:lock:memory')
@@ -18,7 +18,7 @@ const LOCKS = {}
  * @param {string} dir
  * @returns {Promise<LockCloser>}
  */
-export async function lock (dir) {
+async function lock (dir) {
   const file = dir + '/' + lockFile
   log('locking %s', file)
 
@@ -43,9 +43,14 @@ export async function lock (dir) {
  * @param {string} dir
  * @returns {Promise<boolean>}
  */
-export async function locked (dir) {
+async function locked (dir) {
   const file = dir + '/' + lockFile
   log(`checking lock: ${file}`)
 
   return Boolean(LOCKS[file])
 }
+
+export const MemoryLock = {
+  lock,
+  locked
+}

packages/ipfs-repo/src/locks/fs.js

@@ -12,6 +12,7 @@ import {
   keyToMultihash
 } from './utils/blockstore.js'
 import { walkDag } from './utils/walk-dag.js'
+import { PinTypes } from './pin-types.js'
 
 /**
  * @typedef {object} PinInternal
@@ -38,17 +39,6 @@ function invalidPinTypeErr (type) {
   return errCode(new Error(errMsg), 'ERR_INVALID_PIN_TYPE')
 }
 
-export const PinTypes = {
-  /** @type {'direct'} */
-  direct: ('direct'),
-  /** @type {'recursive'} */
-  recursive: ('recursive'),
-  /** @type {'indirect'} */
-  indirect: ('indirect'),
-  /** @type {'all'} */
-  all: ('all')
-}
-
 /**
  * @implements {Pins}
  */

packages/ipfs-repo/src/locks/memory.js

@@ -0,0 +1,11 @@
+
+export const PinTypes = {
+  /** @type {'direct'} */
+  direct: 'direct',
+  /** @type {'recursive'} */
+  recursive: 'recursive',
+  /** @type {'indirect'} */
+  indirect: 'indirect',
+  /** @type {'all'} */
+  all: 'all'
+}

packages/ipfs-repo/src/pins.js renamed to packages/ipfs-repo/src/pin-manager.js

@@ -1,15 +1,15 @@
 
 import map from 'it-map'
 import errCode from 'err-code'
-import { PinTypes } from './pins.js'
+import { PinTypes } from './pin-types.js'
 
 /**
  * @typedef {import('interface-datastore').Query} Query
  * @typedef {import('interface-datastore').Datastore} Datastore
  * @typedef {import('interface-datastore').Options} DatastoreOptions
  * @typedef {import('interface-blockstore').Blockstore} Blockstore
  * @typedef {import('multiformats/cid').CID} CID
- * @typedef {import('./pins').Pins} Pins
+ * @typedef {import('./pin-manager').Pins} Pins
  */
 
 /**

packages/ipfs-repo/src/pin-types.js

@@ -1,5 +1,5 @@
 
-import { NotFoundError } from '../errors/index.js'
+import { NotFoundError } from '../errors.js'
 
 /**
  * @typedef {import('interface-datastore').Datastore} Datastore

packages/ipfs-repo/src/pinned-blockstore.js

@@ -20,7 +20,7 @@ import * as dagCbor from '@ipld/dag-cbor'
 import * as dagPb from '@ipld/dag-pb'
 import { loadCodec } from './fixtures/load-codec.js'
 import { createBackend } from './fixtures/create-backend.js'
-import * as MemoryLock from '../src/locks/memory.js'
+import { MemoryLock } from '../src/locks/memory.js'
 
 async function makePair () {
   const data = new TextEncoder().encode(`hello-${Math.random()}`)