refactor options

Author: ngxson

packages/gguf/src/gguf.ts

@@ -273,7 +273,7 @@ export async function gguf(
 	offset += tensorCount.length;
 	const numKv = readVersionedSize(r.view, offset, version, littleEndian);
 	offset += numKv.length;
-	const metadata: GGUFMetadata = {
+	const metadata: GGUFMetadata<{ strict: false }> = {
 		version,
 		tensor_count: tensorCount.value,
 		kv_count: numKv.value,
@@ -308,9 +308,6 @@ export async function gguf(
 			}
 		}
 		offset += valueResult.length;
-		/// TODO(fix typing)
-		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-		// @ts-ignore
 		metadata[keyResult.value] = valueResult.value;
 	}
 

packages/gguf/src/types.spec.ts

@@ -1,30 +1,30 @@
 import { describe, it } from "vitest";
 import type { gguf } from "./gguf";
-import type { GGUFMetadata, GGUFParseOutput, GGUFType } from "./types";
+import type { GGUFMetadata, GGUFParseOutput } from "./types";
 
 describe("gguf-types", () => {
 	it("gguf() type can be casted between STRICT and NON_STRICT (at compile time)", async () => {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		const result: Awaited<ReturnType<typeof gguf>> = null as any;
-		const strictType = result as GGUFParseOutput<GGUFType.STRICT>;
+		const strictType = result as GGUFParseOutput<{ strict: true }>;
 		// @ts-expect-error because the key "abc" does not exist
 		strictType.metadata.abc = 123;
-		const nonStrictType = result as GGUFParseOutput<GGUFType.NON_STRICT>;
+		const nonStrictType = result as GGUFParseOutput<{ strict: false }>;
 		nonStrictType.metadata.abc = 123; // PASS, because it can be anything
 		// @ts-expect-error because ArrayBuffer is not a MetadataValue
 		nonStrictType.metadata.fff = ArrayBuffer;
 	});
 
 	it("GGUFType.NON_STRICT should be correct (at compile time)", async () => {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		const model: GGUFMetadata<GGUFType.NON_STRICT> = null as any;
+		const model: GGUFMetadata<{ strict: false }> = null as any;
 		model.kv_count = 123n;
 		model.abc = 456; // PASS, because it can be anything
 	});
 
 	it("GGUFType.STRICT should be correct (at compile time)", async () => {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		const model: GGUFMetadata<GGUFType.STRICT> = null as any;
+		const model: GGUFMetadata<{ strict: true }> = null as any;
 
 		if (model["general.architecture"] === "whisper") {
 			model["encoder.whisper.block_count"] = 0;

packages/gguf/src/types.ts

@@ -110,17 +110,21 @@ export type Whisper = GGUFGeneralInfo<"whisper"> &
 
 /// Types for parse output
 
-export enum GGUFType {
-	STRICT,
-	NON_STRICT,
+export interface GGUFMetadataOptions {
+	/**
+   * Enable strict type for known GGUF fields.
+   * 
+	 * @default true
+   */
+  strict: boolean;
 }
 
-export type GGUFMetadata<TGGUFType extends GGUFType = GGUFType.STRICT> = {
+export type GGUFMetadata<Options extends GGUFMetadataOptions = { strict: true }> = {
 	version: Version;
 	tensor_count: bigint;
 	kv_count: bigint;
 } & GGUFModelKV &
-	(TGGUFType extends GGUFType.STRICT ? unknown : Record<string, MetadataValue>);
+	(Options extends { strict: true } ? unknown : Record<string, MetadataValue>);
 
 export type GGUFModelKV = (NoModelMetadata | ModelMetadata) & (NoTokenizer | Tokenizer);
 
@@ -132,7 +136,7 @@ export interface GGUFTensorInfo {
 	offset: bigint;
 }
 
-export interface GGUFParseOutput<TGGUFType extends GGUFType = GGUFType.STRICT> {
-	metadata: GGUFMetadata<TGGUFType>;
+export interface GGUFParseOutput<Options extends GGUFMetadataOptions = { strict: true }> {
+	metadata: GGUFMetadata<Options>;
 	tensorInfos: GGUFTensorInfo[];
 }