@standardserver/shared 0.0.12 → 0.0.16

package/README.md

@@ -0,0 +1,25 @@
+# @standardserver/shared
+
+<div align="center">
+  <a href="https://codecov.io/gh/middleapi/standardserver">
+    <img alt="codecov" src="https://codecov.io/gh/middleapi/standardserver/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@standardserver/shared">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40standardserver%2Fshared?logo=npm" />
+  </a>
+  <a href="https://github.com/middleapi/standardserver/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/middleapi/standardserver?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+  <a href="https://deepwiki.com/middleapi/standardserver">
+    <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
+  </a>
+</div>
+
+This package contains shared types and utilities for the `@standardserver` ecosystem. It has no runtime dependencies and can be used in any JavaScript environment.
+
+## Learn more
+
+For the higher-level project overview, see the root [Standard Server README](../../README.md).

package/dist/index.d.mts

@@ -1,17 +1,5 @@
 declare function toArray<T>(value: T): T extends readonly any[] ? T : (T extends undefined | null ? never : T[]);
 
-declare const PACKAGE_NAME = "@standardserver/shared";
-declare const PACKAGE_VERSION = "0.0.12";
-/**
- * Generates a unique symbol for the specified name within the package scope.
- * The symbol is globally registered using `Symbol.for` to ensure consistency across modules.
- *
- * @remarks
- * - Ensure names are unique to avoid symbol collisions within the package.
- * - Ensure package versions are synchronized (e.g., when the core package is updated, this package should also be updated).
- */
-declare function getPackageSymbol(name: string): symbol;
-
 /**
  * Error thrown when an operation is aborted.
  * Uses the standardized 'AbortError' name for consistency with JavaScript APIs.
@@ -35,11 +23,18 @@ declare class SequentialIdGenerator {
     generate(): string;
 }
 
+type AsyncCleanupFnState = {
+    kind: 'success';
+    error?: undefined;
+} | {
+    kind: 'error';
+    error: unknown;
+} | {
+    kind: 'cancelled';
+    error?: unknown;
+};
 interface AsyncCleanupFn {
-    (state: {
-        isCancelled: boolean;
-        error?: unknown;
-    }): Promise<void>;
+    (state: AsyncCleanupFnState): Promise<void>;
 }
 
 declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
@@ -126,5 +121,5 @@ declare function sleep(ms: number, { signal }?: SleepOptions): Promise<void>;
 
 declare function tryDecodeURIComponent(value: string): string;
 
-export { AbortError, AsyncIteratorClass, PACKAGE_NAME, PACKAGE_VERSION, Queue, SequentialIdGenerator, emitUnhandledRejection, getOrBind, getPackageSymbol, isAsyncIteratorObject, isTypescriptObject, omit, parseEmptyableJSON, sequential, sleep, stringifyJSON, toArray, tryDecodeURIComponent };
+export { AbortError, AsyncIteratorClass, Queue, SequentialIdGenerator, emitUnhandledRejection, getOrBind, isAsyncIteratorObject, isTypescriptObject, omit, parseEmptyableJSON, sequential, sleep, stringifyJSON, toArray, tryDecodeURIComponent };
 export type { AsyncCleanupFn, AsyncIteratorClassNextFn, GetOrBindOptions, SleepOptions };

package/dist/index.d.ts

@@ -1,17 +1,5 @@
 declare function toArray<T>(value: T): T extends readonly any[] ? T : (T extends undefined | null ? never : T[]);
 
-declare const PACKAGE_NAME = "@standardserver/shared";
-declare const PACKAGE_VERSION = "0.0.12";
-/**
- * Generates a unique symbol for the specified name within the package scope.
- * The symbol is globally registered using `Symbol.for` to ensure consistency across modules.
- *
- * @remarks
- * - Ensure names are unique to avoid symbol collisions within the package.
- * - Ensure package versions are synchronized (e.g., when the core package is updated, this package should also be updated).
- */
-declare function getPackageSymbol(name: string): symbol;
-
 /**
  * Error thrown when an operation is aborted.
  * Uses the standardized 'AbortError' name for consistency with JavaScript APIs.
@@ -35,11 +23,18 @@ declare class SequentialIdGenerator {
     generate(): string;
 }
 
+type AsyncCleanupFnState = {
+    kind: 'success';
+    error?: undefined;
+} | {
+    kind: 'error';
+    error: unknown;
+} | {
+    kind: 'cancelled';
+    error?: unknown;
+};
 interface AsyncCleanupFn {
-    (state: {
-        isCancelled: boolean;
-        error?: unknown;
-    }): Promise<void>;
+    (state: AsyncCleanupFnState): Promise<void>;
 }
 
 declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
@@ -126,5 +121,5 @@ declare function sleep(ms: number, { signal }?: SleepOptions): Promise<void>;
 
 declare function tryDecodeURIComponent(value: string): string;
 
-export { AbortError, AsyncIteratorClass, PACKAGE_NAME, PACKAGE_VERSION, Queue, SequentialIdGenerator, emitUnhandledRejection, getOrBind, getPackageSymbol, isAsyncIteratorObject, isTypescriptObject, omit, parseEmptyableJSON, sequential, sleep, stringifyJSON, toArray, tryDecodeURIComponent };
+export { AbortError, AsyncIteratorClass, Queue, SequentialIdGenerator, emitUnhandledRejection, getOrBind, isAsyncIteratorObject, isTypescriptObject, omit, parseEmptyableJSON, sequential, sleep, stringifyJSON, toArray, tryDecodeURIComponent };
 export type { AsyncCleanupFn, AsyncIteratorClassNextFn, GetOrBindOptions, SleepOptions };

package/dist/index.mjs

@@ -2,12 +2,6 @@ function toArray(value) {
   return Array.isArray(value) ? value : value === void 0 || value === null ? [] : [value];
 }
 
-const PACKAGE_NAME = "@standardserver/shared";
-const PACKAGE_VERSION = "0.0.12";
-function getPackageSymbol(name) {
-  return Symbol.for(`${PACKAGE_NAME}@${PACKAGE_VERSION}/${name}`);
-}
-
 class AbortError extends Error {
   constructor(...rest) {
     super(...rest);
@@ -72,7 +66,7 @@ class AsyncIteratorClass {
       } finally {
         if (this.isDone && !this.isExecuteComplete) {
           this.isExecuteComplete = true;
-          await this.cleanup(errorRef ? { isCancelled: false, error: errorRef.value } : { isCancelled: false });
+          await this.cleanup(errorRef ? { kind: "error", error: errorRef.value } : { kind: "success" });
         }
       }
     });
@@ -81,7 +75,7 @@ class AsyncIteratorClass {
     this.isDone = true;
     if (!this.isExecuteComplete) {
       this.isExecuteComplete = true;
-      await this.cleanup({ isCancelled: true });
+      await this.cleanup({ kind: "cancelled" });
     }
     return { done: true, value };
   }
@@ -89,7 +83,7 @@ class AsyncIteratorClass {
     this.isDone = true;
     if (!this.isExecuteComplete) {
       this.isExecuteComplete = true;
-      await this.cleanup({ isCancelled: true, error });
+      await this.cleanup({ kind: "cancelled", error });
     }
     throw error;
   }
@@ -100,7 +94,7 @@ class AsyncIteratorClass {
     this.isDone = true;
     if (!this.isExecuteComplete) {
       this.isExecuteComplete = true;
-      await this.cleanup({ isCancelled: true });
+      await this.cleanup({ kind: "cancelled" });
     }
   }
   [Symbol.asyncIterator]() {
@@ -240,4 +234,4 @@ function tryDecodeURIComponent(value) {
   }
 }
 
-export { AbortError, AsyncIteratorClass, PACKAGE_NAME, PACKAGE_VERSION, Queue, SequentialIdGenerator, emitUnhandledRejection, getOrBind, getPackageSymbol, isAsyncIteratorObject, isTypescriptObject, omit, parseEmptyableJSON, sequential, sleep, stringifyJSON, toArray, tryDecodeURIComponent };
+export { AbortError, AsyncIteratorClass, Queue, SequentialIdGenerator, emitUnhandledRejection, getOrBind, isAsyncIteratorObject, isTypescriptObject, omit, parseEmptyableJSON, sequential, sleep, stringifyJSON, toArray, tryDecodeURIComponent };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@standardserver/shared",
   "type": "module",
-  "version": "0.0.12",
+  "version": "0.0.16",
   "license": "MIT",
   "homepage": "https://standardserver.dev",
   "repository": {
@@ -11,6 +11,7 @@
   },
   "sideEffects": false,
   "exports": {
+    "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs",