@forklaunch/common 0.2.10 → 0.3.0

package/lib/index.d.mts

@@ -13,6 +13,8 @@ declare function extractArgumentNames(func: {
     toString(): string;
 }): string[];
 
+declare function isAsyncGenerator<T>(value: unknown): value is AsyncGenerator<T>;
+
 /**
  * Type guard that checks if a value is of type never
  * @param value - The value to check
@@ -20,6 +22,8 @@ declare function extractArgumentNames(func: {
  */
 declare function isNever(value: never): value is never;
 
+declare function isNodeJsWriteableStream(value: unknown): value is NodeJS.WritableStream;
+
 /**
  * Check if the given object is a record.
  *
@@ -42,6 +46,15 @@ declare function isRecord(obj: unknown): obj is Record<string, unknown>;
  */
 declare function isTrue(value: true): true;
 
+declare class InMemoryFile extends File {
+    content: string;
+    constructor(content: string, name: string, { type, endings, lastModified }: {
+        type?: string;
+        endings?: 'transparent' | 'native';
+        lastModified?: number;
+    });
+}
+
 /**
  * A no-operation function that does nothing when called.
  * This is commonly used as a default or placeholder function
@@ -55,11 +68,14 @@ declare function isTrue(value: true): true;
  * }
  * ```
  */
-declare function noop(): void;
+declare function noop(..._args: unknown[]): void;
+
+declare function readableStreamToAsyncIterable<T>(stream: ReadableStream<T>): AsyncIterable<T>;
+
+declare function safeParse<T>(input: unknown): T;
 
 /**
  * Safely stringifies any JavaScript value, handling special cases like:
- * - Circular references
  * - Error objects
  * - BigInt
  * - Functions
@@ -74,11 +90,6 @@ declare function noop(): void;
  *
  * @example
  * ```typescript
- * // Handle circular references
- * const circular = { a: 1 };
- * circular.self = circular;
- * safeStringify(circular); // '{"a":1,"self":"[Circular Reference]"}'
- *
  * // Handle Error objects
  * safeStringify(new Error("test")); // '{"name":"Error","message":"test","stack":"..."}'
  *
@@ -160,6 +171,8 @@ type InstanceTypeRecord<T extends Record<string, new (...args: never[]) => unkno
     [K in keyof T]: InstanceType<T[K]>;
 };
 
+type ExclusiveRecord<T, U> = T extends object ? U extends object ? T & Record<Exclude<keyof T, keyof U>, never> : T : T;
+
 /**
  * A type that represents the values of an object type `T`.
  *
@@ -215,6 +228,8 @@ type MakePropertyOptionalIfChildrenOptional<T> = {
     [K in keyof T as AllPropertiesOptional<T[K]> extends true ? never : K]: T[K];
 };
 
+type MimeType = 'application/json' | 'application/xml' | 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/html' | 'text/plain' | 'image/jpeg' | 'image/png' | 'video/mp4' | 'audio/mpeg' | 'application/pdf' | 'application/zip' | 'application/octet-stream' | string;
+
 /**
  * A type that "prettifies" the structure of an object type `T`.
  *
@@ -238,4 +253,8 @@ type Prettify<T> = {
  */
 type RemoveTrailingSlash<T extends string> = T extends `${infer Route}/` ? Route : T;
 
-export { type Flatten, type FlattenKeys, type FlattenValues, type IdDto, type IdsDto, type InstanceTypeRecord, type MakePropertyOptionalIfChildrenOptional, type Prettify, type RecordTimingDto, type RemoveTrailingSlash, type ReturnTypeRecord, extractArgumentNames, isNever, isRecord, isTrue, noop, safeStringify, sortObjectKeys, stripUndefinedProperties };
+type TypeSafeFunction = (...args: never[]) => unknown;
+
+type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+
+export { type ExclusiveRecord, type Flatten, type FlattenKeys, type FlattenValues, type IdDto, type IdsDto, InMemoryFile, type InstanceTypeRecord, type MakePropertyOptionalIfChildrenOptional, type MimeType, type Prettify, type RecordTimingDto, type RemoveTrailingSlash, type ReturnTypeRecord, type TypeSafeFunction, type UnionToIntersection, extractArgumentNames, isAsyncGenerator, isNever, isNodeJsWriteableStream, isRecord, isTrue, noop, readableStreamToAsyncIterable, safeParse, safeStringify, sortObjectKeys, stripUndefinedProperties };

package/lib/index.d.ts

@@ -13,6 +13,8 @@ declare function extractArgumentNames(func: {
     toString(): string;
 }): string[];
 
+declare function isAsyncGenerator<T>(value: unknown): value is AsyncGenerator<T>;
+
 /**
  * Type guard that checks if a value is of type never
  * @param value - The value to check
@@ -20,6 +22,8 @@ declare function extractArgumentNames(func: {
  */
 declare function isNever(value: never): value is never;
 
+declare function isNodeJsWriteableStream(value: unknown): value is NodeJS.WritableStream;
+
 /**
  * Check if the given object is a record.
  *
@@ -42,6 +46,15 @@ declare function isRecord(obj: unknown): obj is Record<string, unknown>;
  */
 declare function isTrue(value: true): true;
 
+declare class InMemoryFile extends File {
+    content: string;
+    constructor(content: string, name: string, { type, endings, lastModified }: {
+        type?: string;
+        endings?: 'transparent' | 'native';
+        lastModified?: number;
+    });
+}
+
 /**
  * A no-operation function that does nothing when called.
  * This is commonly used as a default or placeholder function
@@ -55,11 +68,14 @@ declare function isTrue(value: true): true;
  * }
  * ```
  */
-declare function noop(): void;
+declare function noop(..._args: unknown[]): void;
+
+declare function readableStreamToAsyncIterable<T>(stream: ReadableStream<T>): AsyncIterable<T>;
+
+declare function safeParse<T>(input: unknown): T;
 
 /**
  * Safely stringifies any JavaScript value, handling special cases like:
- * - Circular references
  * - Error objects
  * - BigInt
  * - Functions
@@ -74,11 +90,6 @@ declare function noop(): void;
  *
  * @example
  * ```typescript
- * // Handle circular references
- * const circular = { a: 1 };
- * circular.self = circular;
- * safeStringify(circular); // '{"a":1,"self":"[Circular Reference]"}'
- *
  * // Handle Error objects
  * safeStringify(new Error("test")); // '{"name":"Error","message":"test","stack":"..."}'
  *
@@ -160,6 +171,8 @@ type InstanceTypeRecord<T extends Record<string, new (...args: never[]) => unkno
     [K in keyof T]: InstanceType<T[K]>;
 };
 
+type ExclusiveRecord<T, U> = T extends object ? U extends object ? T & Record<Exclude<keyof T, keyof U>, never> : T : T;
+
 /**
  * A type that represents the values of an object type `T`.
  *
@@ -215,6 +228,8 @@ type MakePropertyOptionalIfChildrenOptional<T> = {
     [K in keyof T as AllPropertiesOptional<T[K]> extends true ? never : K]: T[K];
 };
 
+type MimeType = 'application/json' | 'application/xml' | 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/html' | 'text/plain' | 'image/jpeg' | 'image/png' | 'video/mp4' | 'audio/mpeg' | 'application/pdf' | 'application/zip' | 'application/octet-stream' | string;
+
 /**
  * A type that "prettifies" the structure of an object type `T`.
  *
@@ -238,4 +253,8 @@ type Prettify<T> = {
  */
 type RemoveTrailingSlash<T extends string> = T extends `${infer Route}/` ? Route : T;
 
-export { type Flatten, type FlattenKeys, type FlattenValues, type IdDto, type IdsDto, type InstanceTypeRecord, type MakePropertyOptionalIfChildrenOptional, type Prettify, type RecordTimingDto, type RemoveTrailingSlash, type ReturnTypeRecord, extractArgumentNames, isNever, isRecord, isTrue, noop, safeStringify, sortObjectKeys, stripUndefinedProperties };
+type TypeSafeFunction = (...args: never[]) => unknown;
+
+type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+
+export { type ExclusiveRecord, type Flatten, type FlattenKeys, type FlattenValues, type IdDto, type IdsDto, InMemoryFile, type InstanceTypeRecord, type MakePropertyOptionalIfChildrenOptional, type MimeType, type Prettify, type RecordTimingDto, type RemoveTrailingSlash, type ReturnTypeRecord, type TypeSafeFunction, type UnionToIntersection, extractArgumentNames, isAsyncGenerator, isNever, isNodeJsWriteableStream, isRecord, isTrue, noop, readableStreamToAsyncIterable, safeParse, safeStringify, sortObjectKeys, stripUndefinedProperties };

package/lib/index.js

@@ -20,11 +20,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // index.ts
 var index_exports = {};
 __export(index_exports, {
+  InMemoryFile: () => InMemoryFile,
   extractArgumentNames: () => extractArgumentNames,
+  isAsyncGenerator: () => isAsyncGenerator,
   isNever: () => isNever,
+  isNodeJsWriteableStream: () => isNodeJsWriteableStream,
   isRecord: () => isRecord,
   isTrue: () => isTrue,
   noop: () => noop,
+  readableStreamToAsyncIterable: () => readableStreamToAsyncIterable,
+  safeParse: () => safeParse,
   safeStringify: () => safeStringify,
   sortObjectKeys: () => sortObjectKeys,
   stripUndefinedProperties: () => stripUndefinedProperties
@@ -59,11 +64,21 @@ function extractArgumentNames(func) {
   return result;
 }
 
+// src/guards/isAsyncGenerator.ts
+function isAsyncGenerator(value) {
+  return value != null && typeof value === "object" && "next" in value && typeof value.next === "function" && "return" in value && typeof value.return === "function" && "throw" in value && typeof value.throw === "function";
+}
+
 // src/guards/isNever.ts
 function isNever(value) {
   return true;
 }
 
+// src/guards/isNodeJsWriteableStream.ts
+function isNodeJsWriteableStream(value) {
+  return value != null && typeof value === "object" && "write" in value && typeof value.write === "function" && "end" in value && typeof value.end === "function";
+}
+
 // src/guards/isRecord.ts
 function isRecord(obj) {
   return obj !== null && typeof obj === "object" && !Array.isArray(obj);
@@ -74,8 +89,47 @@ function isTrue(value) {
   return value;
 }
 
+// src/InMemoryFile.ts
+var InMemoryFile = class extends File {
+  constructor(content, name, {
+    type,
+    endings,
+    lastModified
+  }) {
+    super([Buffer.from(content)], name, {
+      type,
+      endings,
+      lastModified
+    });
+    this.content = content;
+  }
+};
+
 // src/noop.ts
-function noop() {
+function noop(..._args) {
+}
+
+// src/readableStreamToAsyncIterable.ts
+async function* readableStreamToAsyncIterable(stream) {
+  const reader = stream.getReader();
+  try {
+    while (true) {
+      const { value, done } = await reader.read();
+      if (done) break;
+      yield value;
+    }
+  } finally {
+    reader.releaseLock();
+  }
+}
+
+// src/safeParse.ts
+function safeParse(input) {
+  try {
+    return JSON.parse(input);
+  } catch {
+    return input;
+  }
 }
 
 // src/safeStringify.ts
@@ -86,14 +140,7 @@ function safeStringify(arg) {
   if (arg == null) {
     return String(arg);
   }
-  const seen = /* @__PURE__ */ new WeakSet();
   const replacer = (key, value) => {
-    if (value && typeof value === "object") {
-      if (seen.has(value)) {
-        return "[Circular Reference]";
-      }
-      seen.add(value);
-    }
     if (value instanceof Error) {
       return {
         name: value.name,
@@ -181,11 +228,16 @@ function stripUndefinedProperties(obj) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  InMemoryFile,
   extractArgumentNames,
+  isAsyncGenerator,
   isNever,
+  isNodeJsWriteableStream,
   isRecord,
   isTrue,
   noop,
+  readableStreamToAsyncIterable,
+  safeParse,
   safeStringify,
   sortObjectKeys,
   stripUndefinedProperties

package/lib/index.mjs

@@ -26,11 +26,21 @@ function extractArgumentNames(func) {
   return result;
 }
 
+// src/guards/isAsyncGenerator.ts
+function isAsyncGenerator(value) {
+  return value != null && typeof value === "object" && "next" in value && typeof value.next === "function" && "return" in value && typeof value.return === "function" && "throw" in value && typeof value.throw === "function";
+}
+
 // src/guards/isNever.ts
 function isNever(value) {
   return true;
 }
 
+// src/guards/isNodeJsWriteableStream.ts
+function isNodeJsWriteableStream(value) {
+  return value != null && typeof value === "object" && "write" in value && typeof value.write === "function" && "end" in value && typeof value.end === "function";
+}
+
 // src/guards/isRecord.ts
 function isRecord(obj) {
   return obj !== null && typeof obj === "object" && !Array.isArray(obj);
@@ -41,8 +51,47 @@ function isTrue(value) {
   return value;
 }
 
+// src/InMemoryFile.ts
+var InMemoryFile = class extends File {
+  constructor(content, name, {
+    type,
+    endings,
+    lastModified
+  }) {
+    super([Buffer.from(content)], name, {
+      type,
+      endings,
+      lastModified
+    });
+    this.content = content;
+  }
+};
+
 // src/noop.ts
-function noop() {
+function noop(..._args) {
+}
+
+// src/readableStreamToAsyncIterable.ts
+async function* readableStreamToAsyncIterable(stream) {
+  const reader = stream.getReader();
+  try {
+    while (true) {
+      const { value, done } = await reader.read();
+      if (done) break;
+      yield value;
+    }
+  } finally {
+    reader.releaseLock();
+  }
+}
+
+// src/safeParse.ts
+function safeParse(input) {
+  try {
+    return JSON.parse(input);
+  } catch {
+    return input;
+  }
 }
 
 // src/safeStringify.ts
@@ -53,14 +102,7 @@ function safeStringify(arg) {
   if (arg == null) {
     return String(arg);
   }
-  const seen = /* @__PURE__ */ new WeakSet();
   const replacer = (key, value) => {
-    if (value && typeof value === "object") {
-      if (seen.has(value)) {
-        return "[Circular Reference]";
-      }
-      seen.add(value);
-    }
     if (value instanceof Error) {
       return {
         name: value.name,
@@ -147,11 +189,16 @@ function stripUndefinedProperties(obj) {
   );
 }
 export {
+  InMemoryFile,
   extractArgumentNames,
+  isAsyncGenerator,
   isNever,
+  isNodeJsWriteableStream,
   isRecord,
   isTrue,
   noop,
+  readableStreamToAsyncIterable,
+  safeParse,
   safeStringify,
   sortObjectKeys,
   stripUndefinedProperties

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/common",
-  "version": "0.2.10",
+  "version": "0.3.0",
   "description": "Common package for base types, interfaces, implementations.",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -28,15 +28,16 @@
     "lib/**"
   ],
   "devDependencies": {
-    "@eslint/js": "^9.24.0",
+    "@eslint/js": "^9.27.0",
+    "@types/node": "^22.15.21",
     "depcheck": "^1.4.7",
-    "eslint": "^9.24.0",
-    "globals": "^16.0.0",
-    "tsup": "^8.4.0",
-    "typedoc": "^0.28.2",
+    "eslint": "^9.27.0",
+    "globals": "^16.1.0",
+    "tsup": "^8.5.0",
+    "typedoc": "^0.28.4",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.30.1",
-    "vitest": "^3.1.1"
+    "typescript-eslint": "^8.32.1",
+    "vitest": "^3.1.4"
   },
   "scripts": {
     "build": "tsc --noEmit && tsup index.ts --format cjs,esm --no-splitting --tsconfig tsconfig.json --outDir lib --dts --clean",