@alwatr/flatomise 5.3.0 → 5.4.0

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.4.0](https://github.com/Alwatr/nanolib/compare/@alwatr/flatomise@1.2.8...@alwatr/flatomise@5.4.0) (2025-02-18)
+
+### Features
+
+* enhance Flatomise interface with promise settlement tracking ([692e7ff](https://github.com/Alwatr/nanolib/commit/692e7ff5ddbc2efef16aaa2ecbeff90e55d63e2a)) by @
+
+### Code Refactoring
+
+* make Flatomise properties readonly for immutability ([14dd30f](https://github.com/Alwatr/nanolib/commit/14dd30f6615d6e4cddf125803267fc9a817f59ac)) by @
+
+### Dependencies update
+
+* **flatomise:** add @alwatr/type-helper to dependencies and TypeScript types ([7a489ab](https://github.com/Alwatr/nanolib/commit/7a489abd39aac2c1189e6697025f82af196e2fe9)) by @
+
+## 5.3.0 (2025-02-03)
+
+### Miscellaneous Chores
+
+* edit README ([3860b3d](https://github.com/Alwatr/nanolib/commit/3860b3df48ab82dc479d5236c2e8579df614aabf)) by @
+
+### Dependencies update
+
+* bump the development-dependencies group across 1 directory with 11 updates ([cb79d07](https://github.com/Alwatr/nanolib/commit/cb79d072a57c79e1c01abff1a293d6757bb65350)) by @
+* update typescript and @types/node to version 5.7.3 and 22.13.0 respectively across multiple packages ([ddab05b](https://github.com/Alwatr/nanolib/commit/ddab05b5d767c30191f36a065e4bc88744e8e3fe)) by @
+
+## 5.0.0 (2024-11-02)
+
+### ⚠ BREAKING CHANGES
+
+* To simplify version management and ensure consistency, all nanolib packages now use the same version as @alwatr/nanolib. This may require updates to your project's dependencies.
+
+### Code Refactoring
+
+* use the same version as @alwatr/nanolib ([60eb860](https://github.com/Alwatr/nanolib/commit/60eb860a0e33dfffe2d1d95e63ce54c60876be06)) by @
+
 ## [5.3.0](https://github.com/Alwatr/nanolib/compare/v5.2.1...v5.3.0) (2025-02-03)
 
 ### Miscellaneous Chores

package/dist/main.cjs

@@ -1,4 +1,4 @@
-/* @alwatr/flatomise v5.3.0 */
+/* @alwatr/flatomise v5.4.0 */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -25,18 +25,20 @@ __export(main_exports, {
 });
 module.exports = __toCommonJS(main_exports);
 var import_package_tracer = require("@alwatr/package-tracer");
-__dev_mode__: import_package_tracer.packageTracer.add("@alwatr/flatomise", "5.3.0");
+__dev_mode__: import_package_tracer.packageTracer.add("@alwatr/flatomise", "5.4.0");
 function newFlatomise() {
-  const flatomise = {};
+  const flatomise = { settled: false };
   flatomise.promise = new Promise((resolve, reject) => {
     flatomise.resolve = resolve;
     flatomise.reject = reject;
   });
+  flatomise.promise.finally(() => {
+    flatomise.settled = true;
+  });
   return flatomise;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   newFlatomise
 });
-/*! For license information please see main.cjs.LEGAL.txt */
 //# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n  promise: Promise<T>;\n  resolve: (value: T | PromiseLike<T>) => void;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  reject: (reason?: any) => void;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n *   console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n  const flatomise: Partial<Flatomise<T>> = {};\n  flatomise.promise = new Promise<T>((resolve, reject) => {\n    flatomise.resolve = resolve;\n    flatomise.reject = reject;\n  });\n  return flatomise as Flatomise<T>;\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,qBAAkB,OAAmB;AA0B9D,SAAS,eAAgC;AAC9C,QAAM,YAAmC,CAAC;AAC1C,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,SAAO;AACT;",
+  "sourcesContent": ["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n  /**\n   * The promise.\n   */\n  readonly promise: Promise<T>;\n\n  /**\n   * Resolve the promise.\n   */\n  readonly resolve: (value: T | PromiseLike<T>) => void;\n\n  /**\n   * Reject the promise.\n   */\n  readonly reject: (reason?: any) => void;\n\n  /**\n   * Whether the promise is settled (resolved or rejected).\n   */\n  readonly settled: boolean;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n *   console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n  const flatomise: Partial<Mutable<Flatomise<T>>> = {settled: false};\n  flatomise.promise = new Promise<T>((resolve, reject) => {\n    flatomise.resolve = resolve;\n    flatomise.reject = reject;\n  });\n  flatomise.promise.finally(() => {\n    flatomise.settled = true;\n  });\n  return flatomise as Flatomise<T>;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,qBAAkB,OAAmB;AAyC9D,SAAS,eAAgC;AAC9C,QAAM,YAA4C,EAAC,SAAS,MAAK;AACjE,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,YAAU,QAAQ,QAAQ,MAAM;AAC9B,cAAU,UAAU;AAAA,EACtB,CAAC;AACD,SAAO;AACT;",
   "names": []
 }

package/dist/main.d.ts

@@ -2,9 +2,22 @@
  * Flat promise that can be resolved or rejected from outside.
  */
 export interface Flatomise<T> {
-    promise: Promise<T>;
-    resolve: (value: T | PromiseLike<T>) => void;
-    reject: (reason?: any) => void;
+    /**
+     * The promise.
+     */
+    readonly promise: Promise<T>;
+    /**
+     * Resolve the promise.
+     */
+    readonly resolve: (value: T | PromiseLike<T>) => void;
+    /**
+     * Reject the promise.
+     */
+    readonly reject: (reason?: any) => void;
+    /**
+     * Whether the promise is settled (resolved or rejected).
+     */
+    readonly settled: boolean;
 }
 /**
  * Create a new Flatomise is a promise that can be resolved or rejected from outside.

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAE7C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAO9C"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAU9C"}

package/dist/main.mjs

@@ -1,18 +1,20 @@
-/* @alwatr/flatomise v5.3.0 */
+/* @alwatr/flatomise v5.4.0 */
 
 // src/main.ts
 import { packageTracer } from "@alwatr/package-tracer";
-__dev_mode__: packageTracer.add("@alwatr/flatomise", "5.3.0");
+__dev_mode__: packageTracer.add("@alwatr/flatomise", "5.4.0");
 function newFlatomise() {
-  const flatomise = {};
+  const flatomise = { settled: false };
   flatomise.promise = new Promise((resolve, reject) => {
     flatomise.resolve = resolve;
     flatomise.reject = reject;
   });
+  flatomise.promise.finally(() => {
+    flatomise.settled = true;
+  });
   return flatomise;
 }
 export {
   newFlatomise
 };
-/*! For license information please see main.mjs.LEGAL.txt */
 //# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/main.ts"],
-  "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n  promise: Promise<T>;\n  resolve: (value: T | PromiseLike<T>) => void;\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  reject: (reason?: any) => void;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n *   console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n  const flatomise: Partial<Flatomise<T>> = {};\n  flatomise.promise = new Promise<T>((resolve, reject) => {\n    flatomise.resolve = resolve;\n    flatomise.reject = reject;\n  });\n  return flatomise as Flatomise<T>;\n}\n"],
-  "mappings": ";;;AAAA,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,qBAAkB,OAAmB;AA0B9D,SAAS,eAAgC;AAC9C,QAAM,YAAmC,CAAC;AAC1C,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,SAAO;AACT;",
+  "sourcesContent": ["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n  /**\n   * The promise.\n   */\n  readonly promise: Promise<T>;\n\n  /**\n   * Resolve the promise.\n   */\n  readonly resolve: (value: T | PromiseLike<T>) => void;\n\n  /**\n   * Reject the promise.\n   */\n  readonly reject: (reason?: any) => void;\n\n  /**\n   * Whether the promise is settled (resolved or rejected).\n   */\n  readonly settled: boolean;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n *   console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n  const flatomise: Partial<Mutable<Flatomise<T>>> = {settled: false};\n  flatomise.promise = new Promise<T>((resolve, reject) => {\n    flatomise.resolve = resolve;\n    flatomise.reject = reject;\n  });\n  flatomise.promise.finally(() => {\n    flatomise.settled = true;\n  });\n  return flatomise as Flatomise<T>;\n}\n"],
+  "mappings": ";;;AACA,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,qBAAkB,OAAmB;AAyC9D,SAAS,eAAgC;AAC9C,QAAM,YAA4C,EAAC,SAAS,MAAK;AACjE,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,YAAU,QAAQ,QAAQ,MAAM;AAC9B,cAAU,UAAU;AAAA,EACtB,CAAC;AACD,SAAO;AACT;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alwatr/flatomise",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "description": "A utility for creating promises that can be externally resolved or rejected.",
   "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
   "keywords": [
@@ -66,13 +66,14 @@
     "clean": "rm -rfv dist *.tsbuildinfo"
   },
   "dependencies": {
-    "@alwatr/package-tracer": "^5.3.0"
+    "@alwatr/package-tracer": "^5.4.0"
   },
   "devDependencies": {
-    "@alwatr/nano-build": "^5.3.0",
+    "@alwatr/nano-build": "^5.4.0",
     "@alwatr/prettier-config": "^5.0.0",
     "@alwatr/tsconfig-base": "^5.0.0",
+    "@alwatr/type-helper": "^5.3.0",
     "typescript": "^5.7.3"
   },
-  "gitHead": "9cfb80ed0666355887d8e3865fc75311420ac371"
+  "gitHead": "074be0d0fe780bf929e163045f8f598cd2697636"
 }