@endo/promise-kit 1.1.2 → 1.1.3

package/README.md

@@ -1,3 +1,72 @@
 # Promise Kit
 
-A helper for making promises
+The promise-kit package provides a simple abstraction for creating and managing a promise. It exports, `makePromiseKit` which is a utility function used to create a Promise and its associated resolver and rejector functions. This is particularly useful in asynchronous programming, where you might need to create a promise and resolve or reject it at a later point in time.
+Note that this serves as a "ponyfill" for `Promise.withResolvers`, making certain accommodations to ensure that the resulting promises can pipeline messages through `@endo/eventual-send`.
+
+## Usage
+
+Here’s an example of how `makePromiseKit` might be used in an Agoric smart contract or JavaScript program:
+
+### Basic Example
+
+```javascript
+import { makePromiseKit } from '@endo/promise-kit';
+
+function asyncOperation() {
+
+  const { promise, resolve, reject } = makePromiseKit();
+  setTimeout(() => {
+    const success = true; // Simulating success or failure
+    if (success) {
+      resolve("Operation successful!");
+    } else {
+      reject("Operation failed!");
+    }
+  }, 2000); 
+
+  return promise;
+}
+
+async function handleAsyncOperation() {
+  try {
+    const result = await asyncOperation();
+    console.log(result); // "Operation successful!"
+  } catch (error) {
+    console.error(error); // "Operation failed!"
+  }
+}
+
+handleAsyncOperation();
+```
+
+### Creating Multiple Promise Kits
+
+You can create multiple promise kits for managing various asynchronous tasks.
+
+```javascript
+const kit1 = makePromiseKit();
+const kit2 = makePromiseKit();
+
+kit1.promise.then(value => console.log('Kit 1 resolved with:', value));
+kit2.promise.then(value => console.log('Kit 2 resolved with:', value));
+
+kit1.resolve('First success');
+kit2.resolve('Second success');
+
+```
+
+## API
+
+### `makePromiseKit()`
+Creates a new promise kit.
+
+**Returns**
+- **`promise`**: The promise object.
+- **`resolve`**: The resolve function for the promise.
+- **`reject`**: The reject function for the promise.
+
+## Links
+[Repository](https://github.com/endojs/endo/tree/master/packages/promise-kit)
+
+## License
+This package is licensed under the Apache-2.0 License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@endo/promise-kit",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Helper for making promises",
   "keywords": [
     "promise"
@@ -26,8 +26,8 @@
   },
   "scripts": {
     "build": "exit 0",
-    "build:types": "tsc --build tsconfig.build.json",
-    "clean:types": "git clean -f '*.d.ts*'",
+    "prepack": "tsc --build tsconfig.build.json",
+    "postpack": "git clean -f '*.d.ts*'",
     "cover": "c8 ava",
     "lint": "yarn lint:types && yarn lint:eslint",
     "lint-check": "yarn lint",
@@ -38,20 +38,19 @@
     "test:xs": "exit 0"
   },
   "dependencies": {
-    "ses": "^1.5.0"
+    "ses": "^1.6.0"
   },
   "devDependencies": {
-    "@types/node": "^16.6.0",
-    "ava": "^6.1.2",
-    "babel-eslint": "^10.0.3",
+    "ava": "^6.1.3",
+    "babel-eslint": "^10.1.0",
     "c8": "^7.14.0",
     "eslint": "^8.57.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-eslint-comments": "^3.1.2",
-    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.29.1",
     "prettier": "^3.2.5",
-    "typescript": "~5.5.0-dev.20240327"
+    "typescript": "5.5.2"
   },
   "files": [
     "LICENSE*",
@@ -70,7 +69,8 @@
   },
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/test-*.*",
+      "test/**/*.test.*"
     ],
     "timeout": "2m"
   },
@@ -80,5 +80,5 @@
   "typeCoverage": {
     "atLeast": 90.9
   },
-  "gitHead": "08e59bc0d262565165636c2e3875bbe3dcb91cf8"
+  "gitHead": "681b813ccb1fa177905dabf2ed3f5f248cb33ce7"
 }

package/src/memo-race.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"memo-race.d.ts","sourceRoot":"","sources":["memo-race.js"],"names":[],"mappings":";qBAmCiD,CAAC;aAApC,CAAC,KAAK,CAAC,EAAE,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,KAAM,IAAI;YAC/C,CAAC,GAAG,CAAC,EAAE,GAAG,KAAM,IAAI;;gCAIpB,KAAK,GACb;IAAC,OAAO,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;CAAC,GAC1C;IAAC,OAAO,EAAE,IAAI,CAAC;IAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAAC;AAgE1C;;;;;;;;;;;;GAYG;AACH,sBAF6B,CAAC,wGAgC7B"}
+{"version":3,"file":"memo-race.d.ts","sourceRoot":"","sources":["memo-race.js"],"names":[],"mappings":";qBAiCc,CAAC;aAED,CAAC,KAAK,CAAC,EAAE,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,KAAM,IAAI;YAC/C,CAAC,GAAG,CAAC,EAAE,GAAG,KAAM,IAAI;;gCAIpB,KAAK,GACb;IAAC,OAAO,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;CAAC,GAC1C;IAAC,OAAO,EAAE,IAAI,CAAC;IAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAAC;AAgE1C;;;;;;;;;;;;GAYG;AACH,sBANa,CAAC,EACqB,CAAC,SAAtB,kBAAmB,wCAEtB,QAAQ,CAAC,CAAC,CAAC,GACT,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAgC/B"}

package/src/promise-executor-kit.d.ts

@@ -4,5 +4,5 @@ export function makeReleasingExecutorKit<T>(): Pick<import("./types.js").Promise
 /**
  * The promise executor
  */
-export type PromiseExecutor<T> = (resolve: (value: import('./types.js').ERef<T>) => void, reject: (reason: any) => void) => any;
+export type PromiseExecutor<T> = (resolve: (value: import("./types.js").ERef<T>) => void, reject: (reason: any) => void) => any;
 //# sourceMappingURL=promise-executor-kit.d.ts.map

package/src/promise-executor-kit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"promise-executor-kit.d.ts","sourceRoot":"","sources":["promise-executor-kit.js"],"names":[],"mappings":"AAiBO,yCAFmG,CAAC;;EAqC1G;;;;4BA/C4C,CAAC,cAAnC,CAAC,KAAK,EAAE,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,UAC7C,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI"}
+{"version":3,"file":"promise-executor-kit.d.ts","sourceRoot":"","sources":["promise-executor-kit.js"],"names":[],"mappings":"AAiBO,yCAHM,CAAC,KACD,IAAI,CAAC,OAAO,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC,GAAG;IAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;CAAC,CAqC5G;;;;4BAjDY,CAAC,cAEH,CAAC,KAAK,EAAE,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,UAC7C,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI"}

package/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":";;;uBAKsB,CAAC;aAFT,CAAC,KAAK,EAAE,IAAI,CAEJ,CAAC,AAFK,CAAC,KAAK,IAAI;YACxB,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI;aACrB,OAAO,CAAC,CAAC,CAAC;;;;;0BAOA,CAAC,IAAZ,UAAU,CAAC,CAAC,CAAC;;;;;;;iBAKG,CAAC,IAAD,CAAC,AAAhB,GAAG,WAAW,CAAC,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":";;;uBACa,CAAC;aAEA,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI;YACxB,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI;aACrB,OAAO,CAAC,CAAC,CAAC;;;;;0BAMX,CAAC,IACD,UAAU,CAAC,CAAC,CAAC;;;;;;;iBAIb,CAAC,IACD,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC"}