chore: consolidate all the types in one place

Author: Gozala

packages/ipfs-core/src/components/config.js

@@ -505,6 +505,6 @@ module.exports.profiles = profiles
  * @typedef {Object} RoutingConfig
  * @property {string} [Type]
  *
- * @typedef {import('../interface/basic').ToJSON} ToJSON
+ * @typedef {import('ipfs-interface/src/basic').ToJSON} ToJSON
  * @typedef {import('.').AbortOptions} AbortOptions
  */

packages/ipfs-core/src/components/index.js

@@ -362,8 +362,8 @@ const getDefaultOptions = () => ({
  * @typedef {import('peer-id')} PeerId
  * @typedef {import('./libp2p').LibP2P} LibP2P
  * @typedef {import('./pin/pin-manager')} PinManager
- * @typedef {import('../interface/block-service').BlockService} BlockService
- * @typedef {import('../interface/bitswap').Bitswap} BitSwap
+ * @typedef {import('ipfs-interface/src/block-service').BlockService} BlockService
+ * @typedef {import('ipfs-interface/src/bitswap').Bitswap} BitSwap
  * @typedef {import('./ipld').IPLD} IPLD
  * @typedef {import('./gc-lock').GCLock} GCLock
  * @typedef {import('../preload').Preload} Preload

packages/ipfs-core/src/components/ipld.js

@@ -15,9 +15,9 @@ const createIPLD = ({ blockService, print, options }) =>
 module.exports = createIPLD
 
 /**
- * @typedef {import('../interface/ipld').IPLD} IPLD
- * @typedef {import('../interface/ipld').Options} Options
- * @typedef {import('../interface/block-service').BlockService} BlockService
- * @typedef {import('../interface/basic').Block} Block
+ * @typedef {import('ipfs-interface/src/ipld').IPLD} IPLD
+ * @typedef {import('ipfs-interface/src/ipld').Options} Options
+ * @typedef {import('ipfs-interface/src/block-service').BlockService} BlockService
+ * @typedef {import('ipfs-interface/src/block-service').Block} Block
  * @typedef {import('.').Print} Print
  */

packages/ipfs-core/src/components/network.js

@@ -117,7 +117,7 @@ const WEBSOCKET_STAR_PROTO_CODE = 479
  * @typedef {import('.').Repo} Repo
  * @typedef {import('.').Print} Print
  * @typedef {import('.').LibP2P} LibP2P
- * @typedef {import('../interface/bitswap').Bitswap} BitSwap
+ * @typedef {import('ipfs-interface/src/bitswap').Bitswap} BitSwap
  * @typedef {import('.').PeerId} PeerId
  * @typedef {import('.').AbortOptions} AbortOptions
  */

packages/ipfs-core/src/components/root.js

@@ -7,18 +7,17 @@ const createGetAPI = require('./get')
 const createLsAPI = require('./ls')
 
 /**
+ * @typedef {AddAllContext & CatContext & GetContext & ListContext } Context
+ * @typedef {import('./add-all').Context} AddAllContext
+ * @typedef {import('./cat').Context} CatContext
+ * @typedef {import('./get').Context} GetContext
+ * @typedef {import('./ls').Context} ListContext
  * @typedef {import('ipfs-interface').RootAPI} RootAPI
  * @implements {RootAPI}
  */
 class Root {
   /**
-   * @param {Object} config
-   * @param {import('.').Block} config.block
-   * @param {import('.').Pin} config.pin
-   * @param {import('.').GCLock} config.gcLock
-   * @param {import('.').Preload} config.preload
-   * @param {import('.').IPLD} config.ipld
-   * @param {import('ipfs-interface/src/root').ShardingOptions} [config.options]
+   * @param {Context} context
    */
   constructor ({ preload, gcLock, pin, block, ipld, options }) {
     const addAll = createAddAllAPI({

packages/ipfs-core/src/components/storage.js

@@ -295,7 +295,7 @@ const applyProfiles = (config, profiles) => {
  * @typedef {import('.').IPLDOptions} IPLDOptions
  * @typedef {import('.').Print} Print
  * @typedef {import('.').IPFSConfig} IPFSConfig
- * @typedef {import('../interface/repo').Repo<IPFSConfig>} Repo
+ * @typedef {import('ipfs-interface/src/repo').Repo<IPFSConfig>} Repo
  * @typedef {import('libp2p-crypto').KeyType} KeyType
  * @typedef {import('libp2p').LibP2PKeychain} Keychain
  */

packages/ipfs-core/src/interface/basic.ts

@@ -32,6 +32,6 @@ module.exports = (options = {}) => {
 }
 
 /**
- * @typedef {import('../interface/repo').Repo<IPFSConfig>} Repo
+ * @typedef {import('ipfs-interface/src/repo').Repo<IPFSConfig>} Repo
  * @typedef {import('../components/config').IPFSConfig} IPFSConfig
  */

packages/ipfs-core/src/runtime/repo-nodejs.js

@@ -212,7 +212,7 @@ module.exports = Service
 
 /**
  * @template T
- * @typedef {import('../interface/basic').Await<T>} Await
+ * @typedef {import('ipfs-interface/src/basic').Await<T>} Await
  */
 /**
  * @template {(options:any) => any} T

packages/ipfs-core/src/utils/service.js

@@ -1,3 +1,19 @@
+/**
+ * Represents a value that you can await on, which is either value or a promise
+ * of one.
+ */
+export type Await<T> =
+  | T
+  | Promise<T>
+
+/**
+ * Represents an iterable that can be used in `for await` loops, that is either
+ * iterable or an async iterable.
+ */
+export type AwaitIterable<T> =
+  | Iterable<T>
+  | AsyncIterable<T>
+
 /**
  * Common options across all cancellable requests.
  */
@@ -14,18 +30,10 @@ export interface AbortOptions {
   timeout?: number
 }
 
-/**
- * Represents a value that you can await on, which is either value or a promise
- * of one.
- */
-export type Await<T> =
-  | T
-  | Promise<T>
-
-/**
- * Represents an iterable that can be used in `for await` loops, that is either
- * iterable or an async iterable.
- */
-export type AwaitIterable<T> =
-  | Iterable<T>
-  | AsyncIterable<T>
+export type ToJSON =
+  | null
+  | string
+  | number
+  | boolean
+  | ToJSON[]
+  | { toJSON?: () => ToJSON } & { [key: string]: ToJSON }

packages/ipfs-interface/src/basic.ts

@@ -1,5 +1,9 @@
-import { PeerId, CID, Block, Await, BigInteger, AbortOptions } from './basic'
-import { MovingAverage } from './moving-avarage'
+import BigInteger from 'bignumber.js'
+import PeerId from 'peer-id'
+import CID from 'cids'
+import { Block } from './block-service'
+import { AbortOptions, Await } from './basic'
+import { MovingAverage } from './bitswap/moving-avarage'
 import { StoreReader, StoreExporter, StoreImporter } from './store'
 
 export interface Bitswap extends

packages/ipfs-core/src/interface/bitswap.ts renamed to packages/ipfs-interface/src/bitswap.ts

@@ -1,4 +1,5 @@
-import { Block, CID, Await, AbortOptions } from './basic'
+import CID from 'cids'
+import { Await, AbortOptions } from './basic'
 import { StoreReader, StoreImporter, StoreExporter, StoreEraser } from './store'
 import { Bitswap } from './bitswap'
 
@@ -18,3 +19,8 @@ export interface BlockService extends
    */
   put(block: Block, options?:AbortOptions): Await<Block>
 }
+
+export interface Block {
+  cid: CID
+  data: Uint8Array
+}

packages/ipfs-core/src/interface/moving-avarage.ts renamed to packages/ipfs-interface/src/bitswap/moving-avarage.ts

@@ -170,42 +170,3 @@ type HRTime = [number, number]
 
 // It's just a named type alias, but it better captures intent.
 export type Mode = number
-
-/**
- * @typedef {import('../format-mtime').MTime} MTime
- * @typedef {import('../format-mode').Mode} Mode
- * @typedef {Object} Directory
- * @property {string} path
- * @property {Mode} [mode]
- * @property {MTime} [mtime]
- * @property {undefined} [content]
- *
- * @typedef {Object} FileInput
- * @property {string} [path]
- * @property {ToContent} [content]
- * @property {number | string} [mode]
- * @property {UnixTime} [mtime]
- *
- * @typedef {Date | MTime | HRTime} UnixTime
- *
- * Time representation as tuple of two integers, as per the output of
- * [`process.hrtime()`](https://nodejs.org/dist/latest/docs/api/process.html#process_process_hrtime_time).
- * @typedef {[number, number]} HRTime
- *
- * @typedef {string|InstanceType<typeof window.String>|ArrayBufferView|ArrayBuffer|Blob|Iterable<Uint8Array> | AsyncIterable<Uint8Array> | ReadableStream<Uint8Array>} ToContent
- * @typedef {ToContent|FileInput} ToFile
- * @typedef {Iterable<ToFile> | AsyncIterable<ToFile> | ReadableStream<ToFile>} Source
- */
-/**
- * @template {AsyncIterable<Uint8Array>|Blob} Content
- * @typedef {Object} File
- * @property {string} path
- * @property {Mode} [mode]
- * @property {MTime} [mtime]
- * @property {Content} [content]
- */
-
-/**
- * @template {AsyncIterable<Uint8Array>|Blob} Content
- * @typedef {File<Content>|Directory} Entry
- */

packages/ipfs-core/src/interface/block-service.ts renamed to packages/ipfs-interface/src/block-service.ts

@@ -1,7 +1,8 @@
 import { BlockService } from './block-service'
-import { Await, CID, AwaitIterable, AbortOptions } from './basic'
+import CID from 'cids'
+import { Await, AwaitIterable, AbortOptions } from './basic'
 import { StoreReader, StoreExporter, StoreEraser } from './store'
-import { ResolveResult, Format } from './format'
+import { ResolveResult, Format } from './ipld/format'
 
 export interface IPLD<T = any> extends
   StoreReader<CID, T>,

packages/ipfs-core/src/interface/datastore.ts renamed to packages/ipfs-interface/src/datastore.ts

@@ -1,5 +1,6 @@
 
-import { Await, CID } from './basic'
+import CID from 'cids'
+import { Await } from '../basic'
 
 export interface Format <T=any> {
   util: Util<T>

packages/ipfs-interface/src/files.ts

@@ -1,4 +1,6 @@
-import { CID, Block, ToJSON, Await, AbortOptions } from './basic'
+import CID from 'cids'
+import { Block } from './block-service'
+import { ToJSON, Await, AbortOptions } from './basic'
 import { DataStore, Key } from './datastore'
 import {
   ValueStore, StoreReader, Resource, StoreLookup,