fix: declare types in .ts files (#3840)

`.d.ts` files are not type checked as they are usually machine generated.

Switch to using `.ts` files instead so we get some compiler safety.

Refs: ipfs/aegir#849

packages/interface-ipfs-core/package.json

@@ -13,10 +13,11 @@
     "ipfs-utils/src/files/glob-source": false
   },
   "scripts": {
+    "clean": "rimraf ./dist",
     "build": "aegir build",
     "lint": "aegir lint",
     "test": "echo 'No tests here'",
-    "dep-check": "aegir dep-check -i abort-controller -i ipfs-core-types"
+    "dep-check": "aegir dep-check -i abort-controller -i ipfs-core-types -i rimraf"
   },
   "files": [
     "src/",
@@ -80,6 +81,9 @@
     "sinon": "^11.1.1",
     "uint8arrays": "^3.0.0"
   },
+  "devDependencies": {
+    "rimraf": "^3.0.2"
+  },
   "contributors": [
     "Alan Shaw <alan.shaw@protocol.ai>",
     "Alan Shaw <alan@tableflip.io>",

packages/ipfs-cli/src/types.d.ts → packages/ipfs-cli/src/types.ts

@@ -1,4 +1,5 @@
-import { IPFS } from 'ipfs-core-types'
+import type { IPFS } from 'ipfs-core-types'
+import type { Multiaddr } from 'multiaddr'
 
 declare module '@hapi/hapi' {
   interface ServerInfo {

packages/ipfs-core-types/package.json

@@ -3,16 +3,30 @@
   "version": "0.7.0",
   "description": "IPFS interface definitions used by implementations for API compatibility.",
   "leadMaintainer": "Alex Potsides <alex@achingbrain.net>",
-  "types": "src/index.d.ts",
+  "types": "dist/src/index.d.ts",
   "homepage": "https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-core-types#readme",
   "bugs": "https://github.com/ipfs/js-ipfs/issues",
   "scripts": {
+    "clean": "rimraf ./dist",
     "lint": "aegir ts -p check && aegir lint",
     "test": "aegir ts -p check"
   },
   "files": [
-    "src"
+    "src",
+    "dist",
+    "!dist/*.tsbuildinfo"
   ],
+  "typesVersions": {
+    "*": {
+      "src/*": [
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/": [
+        "dist/src/index"
+      ]
+    }
+  },
   "eslintConfig": {
     "extends": "ipfs"
   },
@@ -33,7 +47,8 @@
     "multiformats": "^9.4.1"
   },
   "devDependencies": {
-    "aegir": "^35.0.2"
+    "aegir": "^35.0.2",
+    "rimraf": "^3.0.2"
   },
   "contributors": [
     "Irakli Gozalishvili <dev@gozala.io>"

packages/ipfs-core-types/src/block/index.d.ts → packages/ipfs-core-types/src/block/index.ts

@@ -1,5 +1,5 @@
-import { AbortOptions, PreloadOptions } from '../utils'
-import { CID, CIDVersion } from 'multiformats/cid'
+import type { AbortOptions, PreloadOptions } from '../utils'
+import type { CID, CIDVersion } from 'multiformats/cid'
 
 export interface API<OptionExtension = {}> {
   /**

packages/ipfs-core-types/src/config/index.d.ts → packages/ipfs-core-types/src/config/index.ts

@@ -1,5 +1,5 @@
 import type { AbortOptions } from '../utils'
-import { API as ProfilesAPI } from './profiles'
+import type { API as ProfilesAPI } from './profiles'
 
 export interface API<OptionExtension = {}> {
   /**

packages/ipfs-core-types/src/dag/index.d.ts → packages/ipfs-core-types/src/dag/index.ts

@@ -1,5 +1,5 @@
-import { AbortOptions, PreloadOptions, IPFSPath } from '../utils'
-import { CID, CIDVersion } from 'multiformats/cid'
+import type { AbortOptions, PreloadOptions, IPFSPath } from '../utils'
+import type { CID, CIDVersion } from 'multiformats/cid'
 
 export interface API<OptionExtension = {}> {
   /**

packages/ipfs-core-types/src/files/index.d.ts → packages/ipfs-core-types/src/files/index.ts

@@ -1,6 +1,6 @@
-import { AbortOptions, IPFSPath } from '../utils'
-import { CID, CIDVersion } from 'multiformats/cid'
-import { Mtime, MtimeLike } from 'ipfs-unixfs'
+import type { AbortOptions, IPFSPath } from '../utils'
+import type { CID, CIDVersion } from 'multiformats/cid'
+import type { Mtime, MtimeLike } from 'ipfs-unixfs'
 import type { AddProgressFn } from '../root'
 
 export interface API<OptionExtension = {}> {

packages/ipfs-core-types/src/index.d.ts → packages/ipfs-core-types/src/index.ts

@@ -1,23 +1,23 @@
-import { API as RootAPI } from './root'
-import { API as BitswapAPI } from './bitswap'
-import { API as BlockAPI } from './block'
-import { API as BootstrapAPI } from './bootstrap'
-import { API as ConfigAPI } from './config'
-import { API as DAGAPI } from './dag'
-import { API as DHTAPI } from './dht'
-import { API as DiagAPI } from './diag'
-import { API as FilesAPI } from './files'
-import { API as KeyAPI } from './key'
-import { API as LogAPI } from './log'
-import { API as NameAPI } from './name'
-import { API as ObjectAPI } from './object'
-import { API as PinAPI } from './pin'
-import { API as PubsubAPI } from './pubsub'
-import { Refs, Local } from './refs'
-import { API as RepoAPI } from './repo'
-import { API as StatsAPI } from './stats'
-import { API as SwarmAPI } from './swarm'
-import { AbortOptions, Await, AwaitIterable } from './utils'
+import type { API as RootAPI } from './root'
+import type { API as BitswapAPI } from './bitswap'
+import type { API as BlockAPI } from './block'
+import type { API as BootstrapAPI } from './bootstrap'
+import type { API as ConfigAPI } from './config'
+import type { API as DAGAPI } from './dag'
+import type { API as DHTAPI } from './dht'
+import type { API as DiagAPI } from './diag'
+import type { API as FilesAPI } from './files'
+import type { API as KeyAPI } from './key'
+import type { API as LogAPI } from './log'
+import type { API as NameAPI } from './name'
+import type { API as ObjectAPI } from './object'
+import type { API as PinAPI } from './pin'
+import type { API as PubsubAPI } from './pubsub'
+import type { Refs, Local } from './refs'
+import type { API as RepoAPI } from './repo'
+import type { API as StatsAPI } from './stats'
+import type { API as SwarmAPI } from './swarm'
+import type { AbortOptions, Await, AwaitIterable } from './utils'
 import type { BlockCodec } from 'multiformats/codecs/interface'
 import type { MultibaseCodec } from 'multiformats/bases/interface'
 import type { MultihashHasher } from 'multiformats/hashes/interface'

packages/ipfs-core-types/src/name/index.d.ts → packages/ipfs-core-types/src/name/index.ts

@@ -1,4 +1,4 @@
-import { CID } from 'multiformats/cid'
+import type { CID } from 'multiformats/cid'
 import type { AbortOptions } from '../utils'
 import type { API as PubsubAPI } from './pubsub'
 

packages/ipfs-core-types/src/pin/remote/index.d.ts → packages/ipfs-core-types/src/pin/remote/index.ts

@@ -1,7 +1,7 @@
-import { CID } from 'multiformats/cid'
-import { Multiaddr } from 'multiaddr'
-import { API as Service } from './service'
-import { AbortOptions } from '../../utils'
+import type { CID } from 'multiformats/cid'
+import type { Multiaddr } from 'multiaddr'
+import type { API as Service } from './service'
+import type { AbortOptions } from '../../utils'
 
 export interface API<OptionExtension = {}> {
   /**

packages/ipfs-core-types/src/pin/remote/service/index.d.ts → packages/ipfs-core-types/src/pin/remote/service/index.ts

@@ -1,4 +1,4 @@
-import { AbortOptions } from '../../../utils'
+import type { AbortOptions } from '../../../utils'
 
 export interface API<OptionExtension = {}> {
   /**

packages/ipfs-core-types/src/repo/index.d.ts → packages/ipfs-core-types/src/repo/index.ts

@@ -1,5 +1,5 @@
 import type { AbortOptions } from '../utils'
-import { CID } from 'multiformats/cid'
+import type { CID } from 'multiformats/cid'
 
 export interface API<OptionExtension = {}> {
   /**

packages/ipfs-core-types/src/root.d.ts → packages/ipfs-core-types/src/root.ts

@@ -1,7 +1,7 @@
-import { AbortOptions, PreloadOptions, IPFSPath, ImportCandidateStream, ImportCandidate } from './utils'
-import { CID, CIDVersion } from 'multiformats/cid'
-import { Mtime } from 'ipfs-unixfs'
-import { Multiaddr } from 'multiaddr'
+import type { AbortOptions, PreloadOptions, IPFSPath, ImportCandidateStream, ImportCandidate } from './utils'
+import type { CID, CIDVersion } from 'multiformats/cid'
+import type { Mtime } from 'ipfs-unixfs'
+import type { Multiaddr } from 'multiaddr'
 
 export interface API<OptionExtension = {}> {
   /**

packages/ipfs-core-types/src/stats/index.d.ts → packages/ipfs-core-types/src/stats/index.ts

@@ -1,6 +1,6 @@
 import type { AbortOptions } from '../utils'
-import { API as BitswapAPI } from '../bitswap'
-import { API as RepoAPI } from '../repo'
+import type { API as BitswapAPI } from '../bitswap'
+import type { API as RepoAPI } from '../repo'
 
 export interface API<OptionExtension = {}> {
   bitswap: BitswapAPI<OptionExtension>['stat']

packages/ipfs-core-types/src/utils.d.ts → packages/ipfs-core-types/src/utils.ts

@@ -1,5 +1,5 @@
-import { CID } from 'multiformats/cid'
-import { Mtime, MtimeLike } from 'ipfs-unixfs'
+import type { CID } from 'multiformats/cid'
+import type { Mtime, MtimeLike } from 'ipfs-unixfs'
 
 export type Entry<Content extends AsyncIterable<Uint8Array>|Blob> =
   | FileEntry<Content>

packages/ipfs-core-utils/src/types.d.ts → packages/ipfs-core-utils/src/types.ts

@@ -1,6 +1,6 @@
-import { MultibaseCodec } from 'multiformats/bases/interface'
-import { BlockCodec } from 'multiformats/codecs/interface'
-import { MultihashHasher } from 'multiformats/hashes/interface'
+import type { MultibaseCodec } from 'multiformats/bases/interface'
+import type { BlockCodec } from 'multiformats/codecs/interface'
+import type { MultihashHasher } from 'multiformats/hashes/interface'
 
 export interface LoadBaseFn { (codeOrName: string): Promise<MultibaseCodec<any>> }
 export interface LoadCodecFn { (codeOrName: number | string): Promise<BlockCodec<any, any>> }

packages/ipfs-core/src/types.d.ts → packages/ipfs-core/src/types.ts

@@ -1,11 +1,13 @@
 import type { KeyType } from 'libp2p-crypto'
 import type PeerId from 'peer-id'
 import type { Config as IPFSConfig } from 'ipfs-core-types/src/config'
-import type Libp2p, { Libp2pOptions } from 'libp2p'
+import type Libp2p from 'libp2p'
+import type { Libp2pOptions } from 'libp2p'
 
 import type { IPFSRepo } from 'ipfs-repo'
 import type { ProgressCallback as MigrationProgressCallback } from 'ipfs-repo-migrations'
-import type Network, { Options as NetworkOptions } from './components/network'
+import type Network from './components/network'
+import type { Options as NetworkOptions } from './components/network'
 
 import type { Datastore } from 'interface-datastore'
 

packages/ipfs-grpc-client/src/types.d.ts → packages/ipfs-grpc-client/src/types.ts

@@ -1,6 +1,6 @@
-import { agent as HttpAgent } from 'http'
-import { agent as HttpsAgent } from 'https'
-import { Multiaddr } from 'multiaddr'
+import type { Agent as HttpAgent } from 'http'
+import type { Agent as HttpsAgent } from 'https'
+import type { Multiaddr } from 'multiaddr'
 
 export interface Options {
   url: string | URL | Multiaddr

packages/ipfs-grpc-server/src/types.d.ts → packages/ipfs-grpc-server/src/types.ts

@@ -1,6 +1,6 @@
-import { Pushable } from 'it-pushable'
-import { EventEmitter } from 'events'
-import { Multiaddr } from 'multiaddr'
+import type { Pushable } from 'it-pushable'
+import type { EventEmitter } from 'events'
+import type { Multiaddr } from 'multiaddr'
 
 export interface Options {
   socket?: WebsocketServer

packages/ipfs-http-client/src/types.d.ts → packages/ipfs-http-client/src/types.ts

@@ -1,6 +1,6 @@
-import { Agent as HttpAgent } from 'http'
-import { Agent as HttpsAgent } from 'https'
-import { Multiaddr } from 'multiaddr'
+import type { Agent as HttpAgent } from 'http'
+import type { Agent as HttpsAgent } from 'https'
+import type { Multiaddr } from 'multiaddr'
 import type { BlockCodec } from 'multiformats/codecs/interface'
 import type { MultihashHasher } from 'multiformats/hashes/interface'
 import type { MultibaseCodec } from 'multiformats/bases/interface'

packages/ipfs-http-gateway/src/types.ts

@@ -0,0 +1,14 @@
+import type { IPFS } from 'ipfs-core-types'
+import type { Request, Server } from '@hapi/hapi'
+import type { Multiaddr } from 'multiaddr'
+
+declare module '@hapi/hapi' {
+  interface ServerApplicationState {
+    ipfs: IPFS
+  }
+  interface ServerInfo {
+    ma: Multiaddr
+  }
+}
+
+export type { Request, Server }

packages/ipfs-http-server/src/types.d.ts → packages/ipfs-http-server/src/types.ts

@@ -1,7 +1,7 @@
-import { IPFS } from 'ipfs-core-types'
-import { Request, Server } from '@hapi/hapi'
-import Multiaddr from 'multiaddrs'
-import { Mtime } from 'ipfs-unixfs'
+import type { IPFS } from 'ipfs-core-types'
+import type { Request, Server } from '@hapi/hapi'
+import type { Multiaddr } from 'multiaddr'
+import type { Mtime } from 'ipfs-unixfs'
 
 declare module '@hapi/hapi' {
   interface ServerApplicationState {
@@ -15,7 +15,7 @@ declare module '@hapi/hapi' {
   }
 }
 
-export { Request, Server }
+export type { Request, Server }
 
 interface MultipartUpload {
   name: string

packages/ipfs-message-port-protocol/src/files.d.ts → packages/ipfs-message-port-protocol/src/files.ts

@@ -1,5 +1,5 @@
-import { Mtime } from 'ipfs-unixfs'
-import { EncodedCID } from './cid'
+import type { Mtime } from 'ipfs-unixfs'
+import type { EncodedCID } from './cid'
 
 export interface EncodedStat {
   cid: EncodedCID

packages/ipfs-message-port-protocol/src/root.d.ts → packages/ipfs-message-port-protocol/src/root.ts

@@ -1,6 +1,8 @@
 import type { Mtime } from 'ipfs-unixfs'
 import type { RemoteIterable } from './core'
-import type { FileType } from './data'
+import type { EncodedCID } from './cid'
+
+export type FileType = 'dir' | 'file'
 
 export type EncodedFileContent = ArrayBufferView | ArrayBuffer | Blob | string | RemoteIterable<ArrayBufferView> | RemoteIterable<ArrayBuffer>