@xsai/stream-object 0.0.28 → 0.0.29

package/dist/index.d.ts

@@ -28,7 +28,7 @@ Matches any primitive, `void`, `Date`, or `RegExp` value.
 type BuiltIns = Primitive | void | Date | RegExp;
 
 /**
-@see PartialDeep
+@see {@link PartialDeep}
 */
 type PartialDeepOptions = {
 	/**
@@ -37,6 +37,32 @@ type PartialDeepOptions = {
 	@default false
 	*/
 	readonly recurseIntoArrays?: boolean;
+
+	/**
+	Allows `undefined` values in non-tuple arrays.
+
+	- When set to `true`, elements of non-tuple arrays can be `undefined`.
+	- When set to `false`, only explicitly defined elements are allowed in non-tuple arrays, ensuring stricter type checking.
+
+	@default true
+
+	@example
+	You can prevent `undefined` values in non-tuple arrays by passing `{recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}` as the second type argument:
+
+	```
+	import type {PartialDeep} from 'type-fest';
+
+	type Settings = {
+		languages: string[];
+	};
+
+	declare const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}>;
+
+	partialSettings.languages = [undefined]; // Error
+	partialSettings.languages = []; // Ok
+	```
+	*/
+	readonly allowUndefinedInNonTupleArrays?: boolean;
 };
 
 /**
@@ -52,12 +78,12 @@ import type {PartialDeep} from 'type-fest';
 
 const settings: Settings = {
 	textEditor: {
-		fontSize: 14;
-		fontColor: '#000000';
-		fontWeight: 400;
-	}
-	autocomplete: false;
-	autosave: true;
+		fontSize: 14,
+		fontColor: '#000000',
+		fontWeight: 400
+	},
+	autocomplete: false,
+	autosave: true
 };
 
 const applySavedSettings = (savedSettings: PartialDeep<Settings>) => {
@@ -72,7 +98,7 @@ By default, this does not affect elements in array and tuple types. You can chan
 ```
 import type {PartialDeep} from 'type-fest';
 
-interface Settings {
+type Settings = {
 	languages: string[];
 }
 
@@ -81,6 +107,8 @@ const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true}> = {
 };
 ```
 
+@see {@link PartialDeepOptions}
+
 @category Object
 @category Array
 @category Set
@@ -101,8 +129,8 @@ type PartialDeep<T, Options extends PartialDeepOptions = {}> = T extends BuiltIn
 							? Options['recurseIntoArrays'] extends true
 								? ItemType[] extends T // Test for arrays (non-tuples) specifically
 									? readonly ItemType[] extends T // Differentiate readonly and mutable arrays
-										? ReadonlyArray<PartialDeep<ItemType | undefined, Options>>
-										: Array<PartialDeep<ItemType | undefined, Options>>
+										? ReadonlyArray<PartialDeep<Options['allowUndefinedInNonTupleArrays'] extends false ? ItemType : ItemType | undefined, Options>>
+										: Array<PartialDeep<Options['allowUndefinedInNonTupleArrays'] extends false ? ItemType : ItemType | undefined, Options>>
 									: PartialObjectDeep<T, Options> // Tuples behave properly
 								: T // If they don't opt into array testing, just use the original type
 							: PartialObjectDeep<T, Options>

package/dist/index.js

@@ -4,226 +4,235 @@ import { streamText } from '@xsai/stream-text';
 
 var parse = {};
 
-(function (exports) {
-	Object.defineProperty(exports, "__esModule", { value: true });
-	exports.parse = void 0;
-	function parse(s) {
-	    if (s === undefined) {
-	        return undefined;
-	    }
-	    if (s === null) {
-	        return null;
-	    }
-	    if (s === '') {
-	        return '';
-	    }
-	    // remove incomplete escaped characters at the end of the string
-	    s = s.replace(/\\+$/, match => match.length % 2 === 0 ? match : match.slice(0, -1));
-	    try {
-	        return JSON.parse(s);
-	    }
-	    catch (e) {
-	        const [data, reminding] = s.trimLeft()[0] === ':'
-	            ? parseAny(s, e)
-	            : parseAny(s, e, parseStringWithoutQuote);
-	        parse.lastParseReminding = reminding;
-	        if (parse.onExtraToken && reminding.length > 0) {
-	            parse.onExtraToken(s, data, reminding);
-	        }
-	        return data;
-	    }
-	}
-	exports.parse = parse;
-	(function (parse) {
-	    parse.onExtraToken = (text, data, reminding) => {
-	        console.error('parsed json with extra tokens:', {
-	            text,
-	            data,
-	            reminding,
-	        });
-	    };
-	})(parse = exports.parse || (exports.parse = {}));
-	function parseAny(s, e, fallback) {
-	    const parser = parsers[s[0]] || fallback;
-	    if (!parser) {
-	        console.error(`no parser registered for ${JSON.stringify(s[0])}:`, { s });
-	        throw e;
-	    }
-	    return parser(s, e);
-	}
-	function parseStringCasual(s, e, delimiters) {
-	    if (s[0] === '"') {
-	        return parseString(s);
-	    }
-	    if (s[0] === "'") {
-	        return parseSingleQuoteString(s);
-	    }
-	    return parseStringWithoutQuote(s, e, delimiters);
-	}
-	const parsers = {};
-	function skipSpace(s) {
-	    return s.trimLeft();
-	}
-	parsers[' '] = parseSpace;
-	parsers['\r'] = parseSpace;
-	parsers['\n'] = parseSpace;
-	parsers['\t'] = parseSpace;
-	function parseSpace(s, e) {
-	    s = skipSpace(s);
-	    return parseAny(s, e);
-	}
-	parsers['['] = parseArray;
-	function parseArray(s, e) {
-	    s = s.substr(1); // skip starting '['
-	    const acc = [];
-	    s = skipSpace(s);
-	    for (; s.length > 0;) {
-	        if (s[0] === ']') {
-	            s = s.substr(1); // skip ending ']'
-	            break;
-	        }
-	        const res = parseAny(s, e, (s, e) => parseStringWithoutQuote(s, e, [',', ']']));
-	        acc.push(res[0]);
-	        s = res[1];
-	        s = skipSpace(s);
-	        if (s[0] === ',') {
-	            s = s.substring(1);
-	            s = skipSpace(s);
-	        }
-	    }
-	    return [acc, s];
-	}
-	for (const c of '0123456789.-'.slice()) {
-	    parsers[c] = parseNumber;
-	}
-	function parseNumber(s) {
-	    for (let i = 0; i < s.length; i++) {
-	        const c = s[i];
-	        if (parsers[c] === parseNumber) {
-	            continue;
-	        }
-	        const num = s.substring(0, i);
-	        s = s.substring(i);
-	        return [numToStr(num), s];
-	    }
-	    return [numToStr(s), ''];
-	}
-	function numToStr(s) {
-	    if (s === '-') {
-	        return -0;
-	    }
-	    const num = +s;
-	    if (Number.isNaN(num)) {
-	        return s;
-	    }
-	    return num;
-	}
-	parsers['"'] = parseString;
-	function parseString(s) {
-	    for (let i = 1; i < s.length; i++) {
-	        const c = s[i];
-	        if (c === '\\') {
-	            i++;
-	            continue;
-	        }
-	        if (c === '"') {
-	            const str = fixEscapedCharacters(s.substring(0, i + 1));
-	            s = s.substring(i + 1);
-	            return [JSON.parse(str), s];
-	        }
-	    }
-	    return [JSON.parse(fixEscapedCharacters(s) + '"'), ''];
-	}
-	function fixEscapedCharacters(s) {
-	    return s.replace(/\n/g, '\\n').replace(/\t/g, '\\t').replace(/\r/g, '\\r');
-	}
-	parsers["'"] = parseSingleQuoteString;
-	function parseSingleQuoteString(s) {
-	    for (let i = 1; i < s.length; i++) {
-	        const c = s[i];
-	        if (c === '\\') {
-	            i++;
-	            continue;
-	        }
-	        if (c === "'") {
-	            const str = fixEscapedCharacters(s.substring(0, i + 1));
-	            s = s.substring(i + 1);
-	            return [JSON.parse('"' + str.slice(1, -1) + '"'), s];
-	        }
-	    }
-	    return [JSON.parse('"' + fixEscapedCharacters(s.slice(1)) + '"'), ''];
-	}
-	function parseStringWithoutQuote(s, e, delimiters = [' ']) {
-	    const index = Math.min(...delimiters.map(delimiter => {
-	        const index = s.indexOf(delimiter);
-	        return index === -1 ? s.length : index;
-	    }));
-	    const value = s.substring(0, index).trim();
-	    const rest = s.substring(index);
-	    return [value, rest];
-	}
-	parsers['{'] = parseObject;
-	function parseObject(s, e) {
-	    s = s.substr(1); // skip starting '{'
-	    const acc = {};
-	    s = skipSpace(s);
-	    for (; s.length > 0;) {
-	        if (s[0] === '}') {
-	            s = s.substr(1); // skip ending '}'
-	            break;
-	        }
-	        const keyRes = parseStringCasual(s, e, [':', '}']);
-	        const key = keyRes[0];
-	        s = keyRes[1];
-	        s = skipSpace(s);
-	        if (s[0] !== ':') {
-	            acc[key] = undefined;
-	            break;
-	        }
-	        s = s.substr(1); // skip ':'
-	        s = skipSpace(s);
-	        if (s.length === 0) {
-	            acc[key] = undefined;
-	            break;
-	        }
-	        const valueRes = parseAny(s, e);
-	        acc[key] = valueRes[0];
-	        s = valueRes[1];
-	        s = skipSpace(s);
-	        if (s[0] === ',') {
-	            s = s.substr(1);
-	            s = skipSpace(s);
-	        }
-	    }
-	    return [acc, s];
-	}
-	parsers['t'] = parseTrue;
-	function parseTrue(s, e) {
-	    return parseToken(s, `true`, true, e);
-	}
-	parsers['f'] = parseFalse;
-	function parseFalse(s, e) {
-	    return parseToken(s, `false`, false, e);
-	}
-	parsers['n'] = parseNull;
-	function parseNull(s, e) {
-	    return parseToken(s, `null`, null, e);
-	}
-	function parseToken(s, tokenStr, tokenVal, e) {
-	    for (let i = tokenStr.length; i >= 1; i--) {
-	        if (s.startsWith(tokenStr.slice(0, i))) {
-	            return [tokenVal, s.slice(i)];
-	        }
-	    }
-	    /* istanbul ignore next */
-	    {
-	        const prefix = JSON.stringify(s.slice(0, tokenStr.length));
-	        console.error(`unknown token starting with ${prefix}:`, { s });
-	        throw e;
-	    }
-	}
-	
-} (parse));
+var hasRequiredParse;
+
+function requireParse () {
+	if (hasRequiredParse) return parse;
+	hasRequiredParse = 1;
+	(function (exports) {
+		Object.defineProperty(exports, "__esModule", { value: true });
+		exports.parse = undefined;
+		function parse(s) {
+		    if (s === undefined) {
+		        return undefined;
+		    }
+		    if (s === null) {
+		        return null;
+		    }
+		    if (s === '') {
+		        return '';
+		    }
+		    // remove incomplete escaped characters at the end of the string
+		    s = s.replace(/\\+$/, match => match.length % 2 === 0 ? match : match.slice(0, -1));
+		    try {
+		        return JSON.parse(s);
+		    }
+		    catch (e) {
+		        const [data, reminding] = s.trimLeft()[0] === ':'
+		            ? parseAny(s, e)
+		            : parseAny(s, e, parseStringWithoutQuote);
+		        parse.lastParseReminding = reminding;
+		        if (parse.onExtraToken && reminding.length > 0) {
+		            parse.onExtraToken(s, data, reminding);
+		        }
+		        return data;
+		    }
+		}
+		exports.parse = parse;
+		(function (parse) {
+		    parse.onExtraToken = (text, data, reminding) => {
+		        console.error('parsed json with extra tokens:', {
+		            text,
+		            data,
+		            reminding,
+		        });
+		    };
+		})(parse = exports.parse || (exports.parse = {}));
+		function parseAny(s, e, fallback) {
+		    const parser = parsers[s[0]] || fallback;
+		    if (!parser) {
+		        console.error(`no parser registered for ${JSON.stringify(s[0])}:`, { s });
+		        throw e;
+		    }
+		    return parser(s, e);
+		}
+		function parseStringCasual(s, e, delimiters) {
+		    if (s[0] === '"') {
+		        return parseString(s);
+		    }
+		    if (s[0] === "'") {
+		        return parseSingleQuoteString(s);
+		    }
+		    return parseStringWithoutQuote(s, e, delimiters);
+		}
+		const parsers = {};
+		function skipSpace(s) {
+		    return s.trimLeft();
+		}
+		parsers[' '] = parseSpace;
+		parsers['\r'] = parseSpace;
+		parsers['\n'] = parseSpace;
+		parsers['\t'] = parseSpace;
+		function parseSpace(s, e) {
+		    s = skipSpace(s);
+		    return parseAny(s, e);
+		}
+		parsers['['] = parseArray;
+		function parseArray(s, e) {
+		    s = s.substr(1); // skip starting '['
+		    const acc = [];
+		    s = skipSpace(s);
+		    for (; s.length > 0;) {
+		        if (s[0] === ']') {
+		            s = s.substr(1); // skip ending ']'
+		            break;
+		        }
+		        const res = parseAny(s, e, (s, e) => parseStringWithoutQuote(s, e, [',', ']']));
+		        acc.push(res[0]);
+		        s = res[1];
+		        s = skipSpace(s);
+		        if (s[0] === ',') {
+		            s = s.substring(1);
+		            s = skipSpace(s);
+		        }
+		    }
+		    return [acc, s];
+		}
+		for (const c of '0123456789.-'.slice()) {
+		    parsers[c] = parseNumber;
+		}
+		function parseNumber(s) {
+		    for (let i = 0; i < s.length; i++) {
+		        const c = s[i];
+		        if (parsers[c] === parseNumber) {
+		            continue;
+		        }
+		        const num = s.substring(0, i);
+		        s = s.substring(i);
+		        return [numToStr(num), s];
+		    }
+		    return [numToStr(s), ''];
+		}
+		function numToStr(s) {
+		    if (s === '-') {
+		        return -0;
+		    }
+		    const num = +s;
+		    if (Number.isNaN(num)) {
+		        return s;
+		    }
+		    return num;
+		}
+		parsers['"'] = parseString;
+		function parseString(s) {
+		    for (let i = 1; i < s.length; i++) {
+		        const c = s[i];
+		        if (c === '\\') {
+		            i++;
+		            continue;
+		        }
+		        if (c === '"') {
+		            const str = fixEscapedCharacters(s.substring(0, i + 1));
+		            s = s.substring(i + 1);
+		            return [JSON.parse(str), s];
+		        }
+		    }
+		    return [JSON.parse(fixEscapedCharacters(s) + '"'), ''];
+		}
+		function fixEscapedCharacters(s) {
+		    return s.replace(/\n/g, '\\n').replace(/\t/g, '\\t').replace(/\r/g, '\\r');
+		}
+		parsers["'"] = parseSingleQuoteString;
+		function parseSingleQuoteString(s) {
+		    for (let i = 1; i < s.length; i++) {
+		        const c = s[i];
+		        if (c === '\\') {
+		            i++;
+		            continue;
+		        }
+		        if (c === "'") {
+		            const str = fixEscapedCharacters(s.substring(0, i + 1));
+		            s = s.substring(i + 1);
+		            return [JSON.parse('"' + str.slice(1, -1) + '"'), s];
+		        }
+		    }
+		    return [JSON.parse('"' + fixEscapedCharacters(s.slice(1)) + '"'), ''];
+		}
+		function parseStringWithoutQuote(s, e, delimiters = [' ']) {
+		    const index = Math.min(...delimiters.map(delimiter => {
+		        const index = s.indexOf(delimiter);
+		        return index === -1 ? s.length : index;
+		    }));
+		    const value = s.substring(0, index).trim();
+		    const rest = s.substring(index);
+		    return [value, rest];
+		}
+		parsers['{'] = parseObject;
+		function parseObject(s, e) {
+		    s = s.substr(1); // skip starting '{'
+		    const acc = {};
+		    s = skipSpace(s);
+		    for (; s.length > 0;) {
+		        if (s[0] === '}') {
+		            s = s.substr(1); // skip ending '}'
+		            break;
+		        }
+		        const keyRes = parseStringCasual(s, e, [':', '}']);
+		        const key = keyRes[0];
+		        s = keyRes[1];
+		        s = skipSpace(s);
+		        if (s[0] !== ':') {
+		            acc[key] = undefined;
+		            break;
+		        }
+		        s = s.substr(1); // skip ':'
+		        s = skipSpace(s);
+		        if (s.length === 0) {
+		            acc[key] = undefined;
+		            break;
+		        }
+		        const valueRes = parseAny(s, e);
+		        acc[key] = valueRes[0];
+		        s = valueRes[1];
+		        s = skipSpace(s);
+		        if (s[0] === ',') {
+		            s = s.substr(1);
+		            s = skipSpace(s);
+		        }
+		    }
+		    return [acc, s];
+		}
+		parsers['t'] = parseTrue;
+		function parseTrue(s, e) {
+		    return parseToken(s, `true`, true, e);
+		}
+		parsers['f'] = parseFalse;
+		function parseFalse(s, e) {
+		    return parseToken(s, `false`, false, e);
+		}
+		parsers['n'] = parseNull;
+		function parseNull(s, e) {
+		    return parseToken(s, `null`, null, e);
+		}
+		function parseToken(s, tokenStr, tokenVal, e) {
+		    for (let i = tokenStr.length; i >= 1; i--) {
+		        if (s.startsWith(tokenStr.slice(0, i))) {
+		            return [tokenVal, s.slice(i)];
+		        }
+		    }
+		    /* istanbul ignore next */
+		    {
+		        const prefix = JSON.stringify(s.slice(0, tokenStr.length));
+		        console.error(`unknown token starting with ${prefix}:`, { s });
+		        throw e;
+		    }
+		}
+		
+	} (parse));
+	return parse;
+}
+
+var parseExports = requireParse();
 
 const streamObject = async (options) => await streamText({
   ...options,
@@ -233,15 +242,15 @@ const streamObject = async (options) => await streamText({
       name: options.schemaName ?? "json_schema",
       schema: await toJSONSchema(options.schema).then((json) => clean({
         ...json,
-        $schema: void 0
+        $schema: undefined
       })),
       strict: true
     },
     type: "json_schema"
   },
-  schema: void 0,
-  schemaDescription: void 0,
-  schemaName: void 0
+  schema: undefined,
+  schemaDescription: undefined,
+  schemaName: undefined
 }).then(({ chunkStream, finishReason, textStream: rawTextStream, usage }) => {
   const [textStream, rawPartialObjectStream] = rawTextStream.tee();
   let partialObjectData = "";
@@ -250,7 +259,7 @@ const streamObject = async (options) => await streamText({
     transform: (chunk, controller) => {
       partialObjectData += chunk;
       try {
-        const data = parse.parse(partialObjectData);
+        const data = parseExports.parse(partialObjectData);
         if (JSON.stringify(partialObjectSnapshot) !== JSON.stringify(data)) {
           partialObjectSnapshot = data;
           controller.enqueue(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xsai/stream-object",
-  "version": "0.0.28",
+  "version": "0.0.29",
   "type": "module",
   "author": "Moeru AI",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "@gcornut/valibot-json-schema": "^0.42.0",
     "@xsai/providers": "",
     "best-effort-json-parser": "^1.1.2",
-    "type-fest": "^4.31.0",
+    "type-fest": "^4.32.0",
     "valibot": "^0.42.1"
   },
   "scripts": {