auto-reset-event 1.1.1-master.5c3023c → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) William Wong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -15,7 +15,7 @@ Run `npm install auto-reset-event`.
 ## Code snippets
 
 ```js
-import createAutoResetEvent from 'auto-reset-event';
+import { createAutoResetEvent } from 'auto-reset-event';
 
 // Create an acquire-release queue
 const acquire = createAutoResetEvent();
@@ -32,7 +32,7 @@ release();
 ## Full sample
 
 ```js
-import createAutoResetEvent from 'auto-reset-event';
+import { createAutoResetEvent } from 'auto-reset-event';
 import delay from 'delay';
 
 async function main() {
@@ -73,7 +73,7 @@ We can use `auto-reset-event` to easily slow down concurrent requests by limitin
 
 ```js
 import { createServer } from 'restify';
-import createAutoResetEvent from 'auto-reset-event';
+import { createAutoResetEvent } from 'auto-reset-event';
 import delay from 'delay';
 import serveHandler from 'serve-handler';
 

package/dist/auto-reset-event.d.mts

@@ -0,0 +1,3 @@
+declare function createAutoResetEvent(): () => Promise<() => void>;
+
+export { createAutoResetEvent };

package/dist/auto-reset-event.d.ts

@@ -0,0 +1,3 @@
+declare function createAutoResetEvent(): () => Promise<() => void>;
+
+export { createAutoResetEvent };

package/dist/auto-reset-event.js

@@ -0,0 +1,47 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createAutoResetEvent: () => createAutoResetEvent
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/createAutoResetEvent.ts
+function createAutoResetEvent() {
+  const queue = [];
+  const release = () => {
+    queue.shift();
+    queue[0] && queue[0].resolve(release);
+  };
+  return () => {
+    const resolvers = Promise.withResolvers();
+    queue.push(resolvers);
+    if (queue[0] === resolvers) {
+      resolvers.resolve(release);
+    }
+    return resolvers.promise;
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createAutoResetEvent
+});
+//# sourceMappingURL=auto-reset-event.js.map

package/dist/auto-reset-event.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/createAutoResetEvent.ts"],"sourcesContent":["export { default as createAutoResetEvent } from './createAutoResetEvent.ts';\n","export default function createAutoResetEvent() {\n  const queue: PromiseWithResolvers<() => void>[] = [];\n  const release = () => {\n    queue.shift();\n\n    queue[0] && queue[0].resolve(release);\n  };\n\n  return () => {\n    const resolvers = Promise.withResolvers<() => void>();\n\n    queue.push(resolvers);\n\n    if (queue[0] === resolvers) {\n      resolvers.resolve(release);\n    }\n\n    return resolvers.promise;\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAe,SAAR,uBAAwC;AAC7C,QAAM,QAA4C,CAAC;AACnD,QAAM,UAAU,MAAM;AACpB,UAAM,MAAM;AAEZ,UAAM,CAAC,KAAK,MAAM,CAAC,EAAE,QAAQ,OAAO;AAAA,EACtC;AAEA,SAAO,MAAM;AACX,UAAM,YAAY,QAAQ,cAA0B;AAEpD,UAAM,KAAK,SAAS;AAEpB,QAAI,MAAM,CAAC,MAAM,WAAW;AAC1B,gBAAU,QAAQ,OAAO;AAAA,IAC3B;AAEA,WAAO,UAAU;AAAA,EACnB;AACF;","names":[]}

package/dist/auto-reset-event.mjs

@@ -0,0 +1,20 @@
+// src/createAutoResetEvent.ts
+function createAutoResetEvent() {
+  const queue = [];
+  const release = () => {
+    queue.shift();
+    queue[0] && queue[0].resolve(release);
+  };
+  return () => {
+    const resolvers = Promise.withResolvers();
+    queue.push(resolvers);
+    if (queue[0] === resolvers) {
+      resolvers.resolve(release);
+    }
+    return resolvers.promise;
+  };
+}
+export {
+  createAutoResetEvent
+};
+//# sourceMappingURL=auto-reset-event.mjs.map

package/dist/auto-reset-event.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/createAutoResetEvent.ts"],"sourcesContent":["export default function createAutoResetEvent() {\n  const queue: PromiseWithResolvers<() => void>[] = [];\n  const release = () => {\n    queue.shift();\n\n    queue[0] && queue[0].resolve(release);\n  };\n\n  return () => {\n    const resolvers = Promise.withResolvers<() => void>();\n\n    queue.push(resolvers);\n\n    if (queue[0] === resolvers) {\n      resolvers.resolve(release);\n    }\n\n    return resolvers.promise;\n  };\n}\n"],"mappings":";AAAe,SAAR,uBAAwC;AAC7C,QAAM,QAA4C,CAAC;AACnD,QAAM,UAAU,MAAM;AACpB,UAAM,MAAM;AAEZ,UAAM,CAAC,KAAK,MAAM,CAAC,EAAE,QAAQ,OAAO;AAAA,EACtC;AAEA,SAAO,MAAM;AACX,UAAM,YAAY,QAAQ,cAA0B;AAEpD,UAAM,KAAK,SAAS;AAEpB,QAAI,MAAM,CAAC,MAAM,WAAW;AAC1B,gBAAU,QAAQ,OAAO;AAAA,IAC3B;AAEA,WAAO,UAAU;AAAA,EACnB;AACF;","names":[]}

package/package.json

@@ -1,17 +1,43 @@
 {
   "name": "auto-reset-event",
-  "version": "1.1.1-master.5c3023c",
+  "version": "2.0.0",
   "description": "An acquire-release one semantic implemented in Promise.",
-  "main": "lib/index.js",
+  "files": [
+    "./*.js",
+    "./dist/"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/auto-reset-event.d.mts",
+        "default": "./dist/auto-reset-event.mjs"
+      },
+      "require": {
+        "types": "./dist/auto-reset-event.d.ts",
+        "default": "./dist/auto-reset-event.js"
+      }
+    }
+  },
+  "main": "./dist/auto-reset-event.js",
+  "typings": "./dist/auto-reset-event.d.ts",
   "scripts": {
-    "build": "babel --out-dir lib src --ignore **/*.spec.js,**/*.test.js",
-    "prestart": "npm run build:babel",
-    "start": "npm run build:babel -- --skip-initial-build --watch",
-    "test": "jest --collectCoverage true"
+    "build": "tsup",
+    "bump": "npm run bump:prod && npm run bump:dev",
+    "bump:dev": "PACKAGES_TO_BUMP=$(cat package.json | jq -r '(.pinDependencies // {}) as $P | (.localPeerDependencies // {}) as $L | (.devDependencies // {}) | to_entries | map(select(.key as $K | $L | has($K) | not)) | map(.key + \"@\" + ($P[.key] // [\"latest\"])[0]) | join(\" \")') && [ ! -z \"$PACKAGES_TO_BUMP\" ] && npm install $PACKAGES_TO_BUMP || true",
+    "bump:prod": "PACKAGES_TO_BUMP=$(cat package.json | jq -r '(.pinDependencies // {}) as $P | (.localPeerDependencies // {}) as $L | (.dependencies // {}) | to_entries | map(select(.key as $K | $L | has($K) | not)) | map(.key + \"@\" + ($P[.key] // [\"latest\"])[0]) | join(\" \")') && [ ! -z \"$PACKAGES_TO_BUMP\" ] && npm install $PACKAGES_TO_BUMP || true",
+    "precommit": "npm run precommit:eslint && npm run precommit:publint && npm run precommit:typescript:production && npm run precommit:typescript:test",
+    "precommit:eslint": "ESLINT_USE_FLAT_CONFIG=false eslint ./src/",
+    "precommit:publint": "publint",
+    "precommit:typescript:production": "tsc --noEmit --project ./src/tsconfig.precommit.production.json",
+    "precommit:typescript:test": "tsc --noEmit --project ./src/tsconfig.precommit.test.json",
+    "prepack": "cp ../../CHANGELOG.md . && cp ../../LICENSE . && cp ../../README.md .",
+    "start": "npm run build -- --onSuccess \"touch ../pages/package.json\" --watch",
+    "switch": "cat package.json | jq --arg SWITCH_NAME $SWITCH_NAME -r '(.[\"switch:\" + $SWITCH_NAME] // {}) as $TEMPLATE | .devDependencies += ($TEMPLATE.devDependencies // {}) | .dependencies += ($TEMPLATE.dependencies // {})' | tee ./package.json.tmp && mv ./package.json.tmp ./package.json",
+    "test": "node --test ${CI:---watch} **/*.{spec,test}.{[jt]s,[jt]sx,c[jt]s,m[jt]s}"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/compulim/auto-reset-event.git"
+    "url": "https://github.com/compulim/auto-reset-event.git"
   },
   "keywords": [
     "auto reset event",
@@ -24,22 +50,17 @@
     "url": "https://github.com/compulim/auto-reset-event/issues"
   },
   "homepage": "https://github.com/compulim/auto-reset-event#readme",
-  "dependencies": {
-    "@babel/runtime": "7.9.6",
-    "p-defer": "3.0.0",
-    "p-defer-es5": "1.0.1"
-  },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.6",
-    "@babel/plugin-proposal-object-rest-spread": "^7.9.6",
-    "@babel/plugin-transform-runtime": "^7.5.5",
-    "@babel/preset-env": "^7.9.6",
-    "babel-jest": "^26.0.1",
-    "babel-plugin-add-module-exports": "^1.0.2",
-    "delay": "^4.3.0",
-    "has-resolved": "^1.1.0",
-    "jest": "^26.0.1",
-    "regenerator-runtime": "^0.13.5"
+    "@tsconfig/recommended": "^1.0.13",
+    "@tsconfig/strictest": "^2.0.8",
+    "@types/node": "^25.0.3",
+    "expect": "^30.2.0",
+    "has-resolved": "^2.0.0",
+    "publint": "^0.3.16",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "auto-reset-event": "^2.0.0"
   }
 }

package/.github/workflows/node.js.yml

@@ -1,92 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches:
-      - master
-    tags:
-      - '*'
-
-  pull_request:
-    branches:
-      - master
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x]
-
-    steps:
-      - name: Checking out for ${{ github.ref }}
-        uses: actions/checkout@v2
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - run: npx version-from-git --no-git-tag-version
-        if: ${{ startsWith(github.ref, 'refs/heads/') }}
-
-      - run: npm ci
-
-      - run: npm run build --if-present
-
-      - run: npm test
-
-      - run: npm pack
-
-      - uses: actions/upload-artifact@v2
-        if: ${{ matrix.node-version == '14.x' }}
-        with:
-          name: npm-tarball
-          path: '*.tgz'
-
-  publish:
-    needs: build
-    runs-on: ubuntu-latest
-    if: ${{ startsWith(github.ref, 'refs/heads/') || startsWith(github.ref, 'refs/tags/') }}
-
-    steps:
-      - uses: actions/download-artifact@v2
-        with:
-          name: npm-tarball
-
-      - name: Read package.json
-        id: read-package-json
-        run: |
-          echo "::set-output name=name::$(tar xOf *.tgz package/package.json | jq -r '.name')"
-          echo "::set-output name=version::$(tar xOf *.tgz package/package.json | jq -r '.version')"
-          echo "::set-output name=tarball::$(ls *.tgz)"
-          echo "::set-output name=date::$(date +%Y-%m-%d)"
-
-      - name: Run npm publish ${{ steps.read-package-json.outputs.name }}@${{ steps.read-package-json.outputs.version }}
-        run: |
-          npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
-          npm publish *.tgz --tag master
-
-      - uses: actions/create-release@v1
-        id: create-release
-        if: ${{ startsWith(github.ref, 'refs/tags/') }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: '[${{ steps.read-package-json.outputs.version }}] - ${{ steps.read-package-json.outputs.date }}'
-          draft: true
-
-      - uses: actions/upload-release-asset@v1
-        if: ${{ startsWith(github.ref, 'refs/tags/') }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create-release.outputs.upload_url }}
-          asset_path: ./${{ steps.read-package-json.outputs.tarball }}
-          asset_name: ${{ steps.read-package-json.outputs.tarball }}
-          asset_content_type: application/octet-stream

package/CHANGELOG.md

@@ -1,45 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [1.1.0] - 2020-05-26
-
-### Changed
-
-- Bump dependencies, in PR [#5](https://github.com/compulim/auto-reset-event/pull/5)
-   - [`@babel/cli@7.8.4`](https://npmjs.com/package/@babel/cli)
-   - [`@babel/core@7.9.6`](https://npmjs.com/package/@babel/core)
-   - [`@babel/plugin-proposal-object-rest-spread@7.9.6`](https://npmjs.com/package/@babel/plugin-proposal-object-rest-spread)
-   - [`@babel/plugin-transform-runtime@7.5.5`](https://npmjs.com/package/@babel/plugin-transform-runtime)
-   - [`@babel/preset-env@7.9.6`](https://npmjs.com/package/@babel/preset-env)
-   - [`@babel/runtime@7.9.6`](https://npmjs.com/package/@babel/runtime)
-   - [`babel-jest@26.0.1`](https://npmjs.com/package/babel-jest)
-   - [`babel-plugin-add-module-exports@1.0.2`](https://npmjs.com/package/babel-plugin-add-module-exports)
-   - [`delay@4.3.0`](https://npmjs.com/package/delay)
-   - [`has-resolved@1.1.0`](https://npmjs.com/package/has-resolved)
-   - [`jest@26.0.1`](https://npmjs.com/package/jest)
-   - [`p-defer-es5@1.0.1`](https://npmjs.com/package/p-defer-es5)
-   - [`p-defer@3.0.0`](https://npmjs.com/package/p-defer)
-   - [`regenerator-runtime@0.13.5`](https://npmjs.com/package/regenerator-runtime)
-
-- Bump dependencies, in PR [#1](https://github.com/compulim/auto-reset-event/pull/1)
-   - [@babel/cli@^7.5.5](https://www.npmjs.com/package/@babel/cli)
-   - [@babel/core@^7.5.5](https://www.npmjs.com/package/@babel/core)
-   - [@babel/plugin-transform-runtime@^7.5.5](https://www.npmjs.com/package/@babel/plugin-transform-runtime)
-   - [@babel/preset-env@^7.5.5](https://www.npmjs.com/package/@babel/preset-env)
-   - [babel-jest@^24.8.0](https://www.npmjs.com/package/babel-jest)
-   - [delay@^4.3.0](https://www.npmjs.com/package/delay)
-   - [has-resolved@^1.1.0](https://www.npmjs.com/package/has-resolved)
-   - [jest@^24.8.0](https://www.npmjs.com/package/jest)
-   - [regenerator-runtime@^0.13.2](https://www.npmjs.com/package/regenerator-runtime)
-
-## [1.0.0] - 2018-10-03
-
-### Added
-
-- Initial public release

package/babel.config.json

@@ -1,16 +0,0 @@
-{
-  "plugins": [
-    "@babel/plugin-transform-runtime"
-  ],
-  "presets": [
-    [
-      "@babel/preset-env",
-      {
-        "targets": {
-          "node": "10"
-        },
-        "forceAllTransforms": true
-      }
-    ]
-  ]
-}

package/lib/createAutoResetEvent.js

@@ -1,32 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var _pDeferEs = _interopRequireDefault(require("p-defer-es5"));
-
-var _default = function _default() {
-  var queue = [];
-
-  var release = function release() {
-    queue.shift();
-    queue[0] && queue[0].resolve(release);
-  };
-
-  return function () {
-    var deferred = (0, _pDeferEs["default"])();
-    queue.push(deferred);
-
-    if (queue[0] === deferred) {
-      deferred.resolve(release);
-    }
-
-    return deferred.promise;
-  };
-};
-
-exports["default"] = _default;

package/lib/index.js

@@ -1,13 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var _createAutoResetEvent = _interopRequireDefault(require("./createAutoResetEvent"));
-
-var _default = _createAutoResetEvent["default"];
-exports["default"] = _default;

package/samples/simple.js

@@ -1,27 +0,0 @@
-import createAutoResetEvent from '../src/createAutoResetEvent';
-import delay from 'delay';
-
-export default async function () {
-  const acquire = createAutoResetEvent();
-
-  await Promise.all([
-    (async () => {
-      const release = await acquire();
-
-      console.log('You will see this first.');
-      await delay(1000);
-
-      release();
-    })(),
-    (async () => {
-      const release = await acquire();
-
-      console.log('You will see this after a second.');
-      await delay(1000);
-
-      release();
-    })(),
-  ]);
-
-  console.log('You will see this last, after two seconds.');
-}

package/samples/simple.test.js

@@ -1,5 +0,0 @@
-import main from './simple';
-
-test('sample run correctly', async () => {
-  await main();
-});

package/src/createAutoResetEvent.js

@@ -1,22 +0,0 @@
-import createDeferred from 'p-defer-es5';
-
-export default () => {
-  const queue = [];
-  const release = () => {
-    queue.shift();
-
-    queue[0] && queue[0].resolve(release);
-  };
-
-  return () => {
-    const deferred = createDeferred();
-
-    queue.push(deferred);
-
-    if (queue[0] === deferred) {
-      deferred.resolve(release);
-    }
-
-    return deferred.promise;
-  };
-}

package/src/createAutoResetEvent.test.js

@@ -1,20 +0,0 @@
-import 'regenerator-runtime/runtime';
-import hasResolved from 'has-resolved';
-
-import createAutoResetEvent from './createAutoResetEvent';
-
-test('should acquire one at a time', async () => {
-  const acquire = createAutoResetEvent();
-
-  const p1 = acquire();
-  const p2 = acquire();
-
-  expect(await hasResolved(p1)).toBe(true);
-  expect(await hasResolved(p2)).toBe(false);
-
-  (await p1)();
-
-  expect(await hasResolved(p2)).toBe(true);
-
-  (await p2)();
-});

package/src/index.js

@@ -1,3 +0,0 @@
-import createAutoResetEvent from './createAutoResetEvent';
-
-export default createAutoResetEvent