v1.0 release with async iterator fix (huan/memory-card#39)

Author: huan

.eslintrc.js .eslintrc.cjs

@@ -53,9 +53,13 @@ export interface AsyncMapLike<K = any, V = any> {
 
 }
 ```
+
 ## History
 
-### master
+### master v1.0 (Nov 27, 2021)
+
+1. Remove sync interface: `[Symbol.toStringTag]()` and `[Symbol.iterator]()`
+1. Add async interface: `[Symbol.asyncIterator]()`
 
 ### v0.2 (July 25, 2020)
 

README.md

@@ -1,11 +1,18 @@
 {
   "name": "async-map-like",
-  "version": "0.2.5",
+  "version": "1.0.0",
   "description": "ES6 Map TypeScript Interface with Async Support",
-  "main": "dist/src/mod.js",
-  "typings": "dist/src/mod.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/mod.js",
+      "require": "./dist/cjs/src/mod.js"
+    }
+  },
+  "typings": "./dist/esm/src/mod.d.ts",
   "engines": {
-    "node": ">= 12"
+    "node": ">=16",
+    "npm": ">=7"
   },
   "keywords": [
     "async",
@@ -15,14 +22,15 @@
   ],
   "scripts": {
     "clean": "shx rm -fr dist/*",
-    "dist": "npm run clean && tsc",
-    "pack": "npm pack",
-    "lint": "npm run lint:es && npm run lint:ts",
-    "lint:ts": "tsc --noEmit",
-    "test": "npm run lint && npm run test:unit",
-    "test:unit": "blue-tape -r ts-node/register \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
+    "dist": "npm-run-all clean build dist:commonjs",
+    "build": "tsc && tsc -p tsconfig.cjs.json",
+    "dist:commonjs": "jq -n \"{ type: \\\"commonjs\\\" }\" > dist/cjs/package.json",
+    "lint": "npm-run-all lint:es lint:ts",
+    "lint:ts": "tsc --isolatedModules --noEmit",
+    "test": "npm-run-all lint test:unit",
+    "test:unit": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" tap \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
     "test:pack": "bash -x scripts/npm-pack-testing.sh",
-    "lint:es": "eslint --ignore-pattern tests/fixtures/ '{bin,examples,scripts,src,tests}/**/*.ts'"
+    "lint:es": "eslint --ignore-pattern tests/fixtures/ \"{bin,examples,scripts,src,tests}/**/*.ts\""
   },
   "repository": {
     "type": "git",
@@ -35,13 +43,10 @@
   },
   "homepage": "https://github.com/huan/async-map-like#readme",
   "devDependencies": {
-    "@chatie/eslint-config": "^0.12.1",
+    "@chatie/eslint-config": "^1.0.4",
     "@chatie/git-scripts": "^0.6.2",
     "@chatie/semver": "^0.4.7",
-    "@chatie/tsconfig": "^0.10.1",
-    "pkg-jq": "^0.2.4",
-    "shx": "^0.3.2",
-    "tstest": "^0.4.10"
+    "@chatie/tsconfig": "^4.5.3"
   },
   "dependencies": {},
   "git": {

package.json

@@ -2,23 +2,56 @@
 set -e
 
 npm run dist
-npm run pack
+npm pack
 
 TMPDIR="/tmp/npm-pack-testing.$$"
 mkdir "$TMPDIR"
 mv *-*.*.*.tgz "$TMPDIR"
 cp tests/fixtures/smoke-testing.ts "$TMPDIR"
 
 cd $TMPDIR
+
 npm init -y
 npm install *-*.*.*.tgz \
   @types/node \
   typescript \
 
+#
+# CommonJS
+#
+./node_modules/.bin/tsc \
+  --esModuleInterop \
+  --lib esnext \
+  --noEmitOnError \
+  --noImplicitAny \
+  --skipLibCheck \
+  --target es5 \
+  --module CommonJS \
+  --moduleResolution node \
+  smoke-testing.ts
+
+echo
+echo "CommonJS: pack testing..."
+node smoke-testing.js
+
+#
+# ES Modules
+#
+
+# https://stackoverflow.com/a/59203952/1123955
+echo "`jq '.type="module"' package.json`" > package.json
+
 ./node_modules/.bin/tsc \
-  --lib esnext,dom \
+  --esModuleInterop \
+  --lib esnext \
   --noEmitOnError \
   --noImplicitAny \
+  --skipLibCheck \
+  --target es2020 \
+  --module es2020 \
+  --moduleResolution node \
   smoke-testing.ts
 
+echo
+echo "ES Module: pack testing..."
 node smoke-testing.js

scripts/npm-pack-testing.sh

@@ -1,8 +1,8 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
 
 import { test }  from 'tstest'
 
-import { AsyncMapLike } from './async-map-like'
+import type { AsyncMapLike } from './async-map-like.js'
 
 test('AsyncMapLike Interface via object', async (t) => {
   const mapCollection = {
@@ -23,10 +23,10 @@ test('AsyncMapLike Interface via object', async (t) => {
   }
 
   const mapIterable = {
-    [Symbol.iterator] : () : AsyncIterableIterator<[any, any]> => { return {} as any },
     entries           : () : AsyncIterableIterator<[any, any]> => { return {} as any },
     keys              : () : AsyncIterableIterator<any> => { return {} as any },
     values            : () : AsyncIterableIterator<any> => { return {} as any },
+    [Symbol.asyncIterator]: () : AsyncIterableIterator<[any, any]> => { return {} as any },
   }
 
   const mapLike: AsyncMapLike<any, any> = {
@@ -67,12 +67,10 @@ test('AsyncMapLike Interface via class', async (t) => {
     /**
      * Iterables
      */
-    [Symbol.iterator] () : AsyncIterableIterator<[string, number]> { return {} as any }
     entries           () : AsyncIterableIterator<[string, number]> { return {} as any }
     keys              () : AsyncIterableIterator<string> { return {} as any }
     values            () : AsyncIterableIterator<number> { return {} as any }
-
-    get [Symbol.toStringTag] () { return 'test' }
+    [Symbol.asyncIterator] () : AsyncIterableIterator<[any, any]> { return {} as any }
 
   }
 
@@ -108,17 +106,25 @@ test('AsyncMapLike Interface via class generic', async (t) => {
     get size () { return Promise.resolve(42) }
 
     /**
-     * Iterables
+     * AsyncIterables
      */
-    [Symbol.iterator] () : AsyncIterableIterator<[K, V]> { return {} as any }
     entries           () : AsyncIterableIterator<[K, V]> { return {} as any }
     keys              () : AsyncIterableIterator<K> { return {} as any }
     values            () : AsyncIterableIterator<V> { return {} as any }
-
-    get [Symbol.toStringTag] () { return 'test' }
+    [Symbol.asyncIterator] () : AsyncIterableIterator<[any, any]> {
+      return {
+        [Symbol.asyncIterator]: this[Symbol.asyncIterator],
+        next: () => Promise.resolve({ done: true, value: undefined }),
+      }
+    }
 
   }
 
   const mapLike = new TestAsyncMapLike<string, number>()
   t.ok(mapLike, 'should be implement-able from AsyncMapLike')
+
+  /**
+   * Just check for the types
+   */
+  for await (const kv of mapLike) { void kv }
 })

src/async-map-like.spec.ts

@@ -1,3 +1,11 @@
+/* eslint-disable no-use-before-define */
+import type { MapLike } from './map-like.js'
+
+type MapLikeNoSync<K, V> = Omit<
+  MapLike<K, V>,
+  typeof Symbol.toStringTag | typeof Symbol.iterator
+>
+
 type IteratorMethod = 'entries' | 'keys' | 'values'
 type GetMethod      = 'get'
 type AnyFunction    = (...args: any) => any
@@ -29,6 +37,23 @@ type Asyncify<NAME, T> = T extends AnyFunction ?
    */
   : Promise<T>
 
-export type AsyncMapLike<K, V> = {
-  [N in keyof Map<K, V>]: Asyncify<N, Map<K, V>[N]>
+type AsyncMapBase<K, V> = {
+  [N in keyof MapLikeNoSync<K, V>]: Asyncify<N, MapLikeNoSync<K, V>[N]>
+}
+
+interface AsyncMapIterator<K, V> {
+  /**
+   * Huan(202111): we have removed the `[Symbol.iterator]`, and add the below `[Symbol.asyncIterator]` for Async
+   */
+  [Symbol.asyncIterator]: () => AsyncifyIterator<
+    ReturnType<
+      Map<K, V>[typeof Symbol.iterator]
+    >
+  >
+}
+
+type AsyncMapLike<K, V> = AsyncMapBase<K, V> & AsyncMapIterator<K, V>
+
+export type {
+  AsyncMapLike,
 }

src/async-map-like.ts

@@ -1,8 +1,8 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
 
 import { test }  from 'tstest'
 
-import { MapLike } from './map-like'
+import type { MapLike } from './map-like.js'
 
 test('MapLike Interface', async (t) => {
   const mapLike: MapLike<any, any> = new Map<any, any>()

src/map-like.spec.ts

@@ -1,4 +1,4 @@
-export { VERSION }      from './version'
+export { VERSION }      from './version.js'
 
-export { MapLike }      from './map-like'
-export { AsyncMapLike } from './async-map-like'
+export type { MapLike }      from './map-like.js'
+export type { AsyncMapLike } from './async-map-like.js'

src/mod.ts

@@ -1,9 +1,9 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
 
 import { test }  from 'tstest'
 
-import { VERSION } from './version'
+import { VERSION } from './version.js'
 
-test('Make sure the VERSION is fresh in source code', async (t) => {
+test('Make sure the VERSION is fresh in source code', async t => {
   t.equal(VERSION, '0.0.0', 'version should be 0.0.0 in source code, only updated before publish to NPM')
 })

src/version.spec.ts

@@ -1,10 +1,10 @@
-#!/usr/bin/env ts-node
-import test from 'blue-tape'
+#!/usr/bin/env -S node --no-warnings --loader ts-node/esm
+import { test } from 'tstest'
 
-import {
+import type {
   MapLike,
   AsyncMapLike,
-}               from '../src/mod'
+}               from '../src/mod.js'
 
 test('integrate testing', async t => {
   let mapLike      : undefined | MapLike<any, any>

tests/integration.spec.ts

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "dist/cjs",
+  },
+}

tsconfig.cjs.json

@@ -1,18 +1,15 @@
 {
   "extends": "@chatie/tsconfig",
   "compilerOptions": {
-    "outDir": "dist",
-    "target": "es6"
+    "outDir": "dist/esm",
   },
   "exclude": [
     "node_modules/",
     "dist/",
     "tests/fixtures/",
   ],
   "include": [
-    "app/**/*.ts",
     "bin/*.ts",
-    "bot/**/*.ts",
     "examples/**/*.ts",
     "scripts/**/*.ts",
     "src/**/*.ts",