feat: Add pin.add to ipfs-message-port

packages/interface-ipfs-core/src/pin/add-all.js

@@ -119,7 +119,7 @@ module.exports = (common, options) => {
  }())
  })
 
- it('should respect timeout option when pinning a block', () => {
+ it('should respect timeout option when pinning a blocks', () => {
  return testTimeout(() => ipfs.pin.addAll([new CID('Qmd7qZS4T7xXtsNFdRoK1trfMs5zU94EpokQ9WFtxdPxsZ')], {
  timeout: 1
  }))

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

@@ -1,6 +1,6 @@
 import type { AbortOptions, AwaitIterable } from '../utils'
 import type CID from 'cids'
-import type { API as remote } from './remote'
+import type { API as RemoteAPI } from './remote'
 
 export interface API<OptionExtension = {}> {
  /**
@@ -32,7 +32,7 @@ export interface API<OptionExtension = {}> {
  * // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
  * ```
  */
- addAll: (source: AwaitIterable<AddInput>, options?: AddAllOptions & OptionExtension) => AsyncIterable<CID>
+ addAll: (source: PinSource, options?: AddAllOptions & OptionExtension) => AsyncIterable<CID>
 
  /**
  * List all the objects pinned to local storage
@@ -90,9 +90,9 @@ export interface API<OptionExtension = {}> {
  * // CID('QmWATWQ7fVPP2EFGu71UkfnqhYXDYH566qy47CnJDgvs8u')
  * ```
  */
- rmAll: (source: AwaitIterable<RmAllInput>, options?: AbortOptions & OptionExtension) => AsyncIterable<CID>
+ rmAll: (source: PinSource, options?: AbortOptions & OptionExtension) => AsyncIterable<CID>
 
- remote
+ remote: RemoteAPI<OptionExtension>
 }
 
 export interface AddOptions extends AbortOptions {
@@ -124,50 +124,62 @@ export interface AddAllOptions extends AbortOptions {
  lock?: boolean
 }
 
-export interface AddInput {
- /**
- * A CID to pin - nb. you must pass either `cid` or `path`, not both
- */
- cid?: CID
+export type Metadata = Record<string, any>
+export type ToPin =
+ | CID
+ | string
+ | ToPinWithCID
+ | ToPinWithPath
 
+export interface ToPinWithPath extends PinDetails {
  /**
- * An IPFS path to pin - nb. you must pass either `cid` or `path`, not both
- */
- path?: string
+ * An IPFS path to pin.
+ */
+ path: string
+
+ cid?: undefined
+}
+
+export interface ToPinWithCID extends PinDetails {
+ path?: undefined
+ cid: CID
+}
 
+export interface PinDetails {
  /**
  * If true, pin all blocked linked to from the pinned CID
  */
  recursive?: boolean
 
+ metadata?: Metadata
+
  /**
  * A human readable string to store with this pin
  */
  comments?: string
 }
 
-export type PinType = 'recursive' | 'direct' | 'indirect' | 'all'
-
-export type PinQueryType = 'recursive' | 'direct' | 'indirect' | 'all'
-
-export interface LsOptions extends AbortOptions {
- paths?: CID | CID[] | string | string[]
+export type PinSource = AwaitIterable<ToPin>
+
+export type PinType =
+ | 'recursive'
+ | 'direct'
+ | 'indirect'
+export type PinQueryType =
+ | PinType
+ | 'all'
+export interface LsOptions extends AbortOptions {
+ paths?: CID | string | Array<CID | string>
  type?: PinQueryType
 }
 
 export interface LsResult {
  cid: CID
  type: PinType | string
- metadata?: Record<string, any>
+ metadata?: Metadata
 }
 
 export interface RmOptions extends AbortOptions {
  recursive?: boolean
 }
 
-export interface RmAllInput {
- cid?: CID
- path?: string
- recursive?: boolean
-}
-

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

@@ -0,0 +1,21 @@
+/**
+ * @template {Iterable<any>} T
+ * @template U
+ * @param {T|U} value
+ * @returns {value is T}
+ */
+const isIterable = (value) =>
+ // @ts-ignore
+ value && value[Symbol.iterator]
+
+/**
+ * @template {AsyncIterable<any>} T
+ * @template U
+ * @param {T|U} value
+ * @returns {value is T}
+ */
+const isAsyncIterable = value =>
+ // @ts-ignore
+ value && value[Symbol.asyncIterator]
+
+module.exports = { isIterable, isAsyncIterable }

packages/ipfs-core-utils/src/pins/normalise-input.js

@@ -2,6 +2,7 @@
 
 const errCode = require('err-code')
 const CID = require('cids')
+const { isIterable, isAsyncIterable } = require('../iterable')
 
 /**
  * @typedef {Object} Pinnable
@@ -42,24 +43,33 @@ const CID = require('cids')
  * AsyncIterable<{ path: CID|String, recursive:boolean, metadata }>
  * ```
  *
- * @param {Source} input
- * @returns {AsyncIterable<Pin>}
+ * @param {import('ipfs-core-types/src/pin').ToPin|import('ipfs-core-types/src/pin').PinSource} input
+ * @returns {AsyncIterable<import('ipfs-core-types/src/pin').ToPinWithPath>}
  */
-// eslint-disable-next-line complexity
-module.exports = async function * normaliseInput (input) {
+async function * normaliseInput (input) {
  // must give us something
  if (input === null || input === undefined) {
  throw errCode(new Error(`Unexpected input: ${input}`), 'ERR_UNEXPECTED_INPUT')
  }
 
  // CID|String
- if (CID.isCID(input)) {
- yield toPin({ cid: input })
+ if (CID.isCID(input) || typeof input === 'string' || input instanceof String) {
+ return yield toPin(input)
+ }
+
+ // Iterable<?>
+ if (isIterable(input)) {
+ for (const each of input) {
+ yield toPin(each)
+ }
  return
  }
 
- if (input instanceof String || typeof input === 'string') {
- yield toPin({ path: input })
+ // AsyncIterable<?>
+ if (isAsyncIterable(input)) {
+ for await (const each of input) {
+ yield toPin(each)
+ }
  return
  }
 
@@ -70,84 +80,31 @@ module.exports = async function * normaliseInput (input) {
  return yield toPin(input)
  }
 
- // Iterable<?>
- if (Symbol.iterator in input) {
- // @ts-ignore
- const iterator = input[Symbol.iterator]()
- const first = iterator.next()
- if (first.done) return iterator
-
- // Iterable<CID|String>
- if (CID.isCID(first.value) || first.value instanceof String || typeof first.value === 'string') {
- yield toPin({ cid: first.value })
- for (const cid of iterator) {
- yield toPin({ cid })
- }
- return
- }
-
- // Iterable<{ cid: CID recursive, metadata }>
- if (first.value.cid != null || first.value.path != null) {
- yield toPin(first.value)
- for (const obj of iterator) {
- yield toPin(obj)
- }
- return
- }
-
- throw errCode(new Error('Unexpected input: ' + typeof input), 'ERR_UNEXPECTED_INPUT')
- }
-
- // AsyncIterable<?>
- if (Symbol.asyncIterator in input) {
- // @ts-ignore
- const iterator = input[Symbol.asyncIterator]()
- const first = await iterator.next()
- if (first.done) return iterator
-
- // AsyncIterable<CID|String>
- if (CID.isCID(first.value) || first.value instanceof String || typeof first.value === 'string') {
- yield toPin({ cid: first.value })
- for await (const cid of iterator) {
- yield toPin({ cid })
- }
- return
- }
-
- // AsyncIterable<{ cid: CID|String recursive, metadata }>
- if (first.value.cid != null || first.value.path != null) {
- yield toPin(first.value)
- for await (const obj of iterator) {
- yield toPin(obj)
- }
- return
- }
-
- throw errCode(new Error('Unexpected input: ' + typeof input), 'ERR_UNEXPECTED_INPUT')
- }
-
  throw errCode(new Error('Unexpected input: ' + typeof input), 'ERR_UNEXPECTED_INPUT')
 }
 
 /**
- * @param {Pinnable} input
+ * @param {import('ipfs-core-types/src/pin').ToPin | InstanceType<typeof String>} input
+ * @param {{recursive?:boolean}} [options]
+ * @returns {import('ipfs-core-types/src/pin').ToPinWithPath}
  */
-function toPin (input) {
- const path = input.cid || `${input.path}`
-
- if (!path) {
- throw errCode(new Error('Unexpected input: Please path either a CID or an IPFS path'), 'ERR_UNEXPECTED_INPUT')
- }
-
- /** @type {Pin} */
- const pin = {
- path,
- recursive: input.recursive !== false
- }
-
- if (input.metadata != null) {
- pin.metadata = input.metadata
+const toPin = (input, options) => {
+ if (typeof input === 'string') {
+ return { path: input, ...options }
+ } else if (input instanceof String) {
+ return { path: input.toString(), ...options }
+ } else if (CID.isCID(input)) {
+ return { path: input.toString(), ...options }
+ } else {
+ return {
+ path: `${input.path == null ? input.cid : input.path}`,
+ recursive: input.recursive !== false,
+ ...(input.metadata && { metadata: input.metadata})
+ }
  }
+}
 
- return pin
+module.exports = {
+ normaliseInput,
+ toPin
 }

packages/ipfs-core/package.json

@@ -69,7 +69,7 @@
  "err-code": "^3.0.1",
  "hamt-sharding": "^2.0.0",
  "hashlru": "^2.3.0",
- "interface-datastore": "^3.0.3",
+ "interface-datastore": "^4.0.0",
  "ipfs-bitswap": "^5.0.1",
  "ipfs-block-service": "^0.19.0",
  "ipfs-core-types": "^0.3.1",
@@ -122,6 +122,7 @@
  "uint8arrays": "^2.1.3"
  },
  "devDependencies": {
+ "libp2p-interfaces": "^0.8.4",
  "@types/dlv": "^1.1.2",
  "aegir": "^32.1.0",
  "delay": "^5.0.0",