feat: add @stdlib/utils/jsonify-keys

lib/node_modules/@stdlib/utils/jsonify-keys/README.md

@@ -0,0 +1,157 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# JSONify keys
+
+> Parse a [JSON][json]-like string as [JSON][json].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var jsonifyKeys = require( '@stdlib/utils/jsonify-keys' );
+```
+
+#### jsonifyKeys( str\[, reviver] )
+
+Parses a [JSON][json]-like `string` as [JSON][json].
+
+```javascript
+var out = jsonifyKeys( '{"beep":"boop"}' );
+// returns {'beep':'boop'}
+```
+
+If unable to parse a `string` as [JSON][json], the function returns an error.
+
+```javascript
+var out = jsonifyKeys( 'beep' );
+// returns <SyntaxError>
+```
+
+To transform the `string` being parsed, provide a `reviver`.
+
+```javascript
+function reviver( key, value ) {
+    if ( key === '' ) {
+        return value;
+    }
+    if ( key === 'beep' ) {
+        return value;
+    }
+}
+
+var str = '{ beep: "boop", a: "b"}';
+var out = jsonifyKeys( str, reviver );
+// returns {'beep':'boop'}
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   In contrast to the native [`JSON.parse()`][json-parse], this implementation throws a `TypeError` if provided **any** value which is not a `string`.
+
+    ```javascript
+    var out = JSON.parse( null );
+    // returns null
+
+    out = jsonifyKeys( null );
+    // throws <TypeError>
+    ```
+
+-   In contrast to the native [`JSON.parse()`][json-parse], this implementation does **not** throw a `SyntaxError` if unable to parse a `string` as [JSON][json].
+
+    ```javascript
+    var out = jsonifyKeys( '{ beep: "boop}' );
+    // returns <SyntaxError>
+
+    out = JSON.parse( '{ "beep": "boop}' );
+    // throws <SyntaxError>
+    ```
+
+-   In contrast to the native [`JSON.parse()`][json-parse], this implementation throws a `TypeError` if provided a `reviver` argument which is **not** a `function`.
+
+    ```javascript
+    var out = JSON.parse( '{"a":"b"}', [] );
+    // returns {'a':'b'}
+
+    out = jsonifyKeys( '{ a: "b"}', [] );
+    // throws <TypeError>
+    ```
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var jsonifyKeys = require( '@stdlib/utils/jsonify-keys' );
+
+var out;
+
+out = jsonifyKeys( '{ beep: "boop"}' );
+// returns {'beep':'boop'}
+
+out = jsonifyKeys( '3.14' );
+// returns 3.14
+
+out = jsonifyKeys( 'true' );
+// returns true
+
+out = jsonifyKeys( 'null' );
+// returns null
+
+out = jsonifyKeys( '{"beep":"boop}' );
+// returns <SyntaxError>
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[json]: http://www.json.org/
+
+[json-parse]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/utils/jsonify-keys/benchmark/benchmark.js

@@ -0,0 +1,50 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var fromCodePoint = require( '@stdlib/string/from-code-point' );
+var pkg = require( './../package.json' ).name;
+var jsonifyKeys = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var str;
+	var out;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		str = '{ beep: "boop",'+fromCodePoint( 97 + (i%26) ) + ':true}';
+		out = jsonifyKeys( str );
+		if ( out instanceof Error ) {
+			b.fail( out.message );
+		}
+	}
+	b.toc();
+	if ( out instanceof Error ) {
+		b.fail( 'should return JSON' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/utils/jsonify-keys/docs/repl.txt

@@ -0,0 +1,41 @@
+
+{{alias}}( str[, reviver] )
+    Attempts to parse a JSON-like string as JSON.
+
+    Function behavior differs from `JSON.parse()` as follows:
+
+    - throws a `TypeError` if provided any value which is not a string.
+    - throws a `TypeError` if provided a `reviver` argument which is not a
+    function.
+    - returns, rather than throws, a `SyntaxError` if unable to parse a string
+    as JSON.
+
+    Parameters
+    ----------
+    str: string
+        String to parse.
+
+    reviver: Function (optional)
+        Transformation function.
+
+    Returns
+    -------
+    out: any|Error
+        Parsed value or an error.
+
+    Examples
+    --------
+    > var obj = {{alias}}( '{ beep: "boop"}' )
+    { 'beep': 'boop' }
+
+    // Provide a reviver:
+    > function reviver( key, value ) {
+    ...     if ( key === '' ) { return value; }
+    ...     if ( key === 'beep' ) { return value; }
+    ... };
+    > var str = '{ beep: "boop", a: "b" }';
+    > var out = {{alias}}( str, reviver )
+    { 'beep': 'boop' }
+
+    See Also
+    --------

lib/node_modules/@stdlib/utils/jsonify-keys/docs/types/index.d.ts

@@ -0,0 +1,37 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Attempts to parse a JSON-like string as JSON.
+*
+* @param str - string to parse
+* @param reviver - transformation function
+* @returns parsed value or parse error
+*
+* @example
+* var obj = jsonifyKeys( '{ beep: "boop" }' );
+* // returns {'beep':'boop'}
+*/
+declare function jsonifyKeys( str: string, reviver?: Function ): any;
+
+
+// EXPORTS //
+
+export = jsonifyKeys;

lib/node_modules/@stdlib/utils/jsonify-keys/docs/types/test.ts

@@ -0,0 +1,55 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import jsonifyKeys = require( './index' );
+
+
+// TESTS //
+
+// The function returns a parsed value...
+{
+	jsonifyKeys( '{beep:"boop"}' ); // $ExpectType any
+	jsonifyKeys( '"beep"' ); // $ExpectType any
+	jsonifyKeys( '22' ); // $ExpectType any
+}
+
+// The function does not compile if the first argument is a value other than a string...
+{
+	jsonifyKeys( true ); // $ExpectError
+	jsonifyKeys( false ); // $ExpectError
+	jsonifyKeys( 5 ); // $ExpectError
+	jsonifyKeys( [] ); // $ExpectError
+	jsonifyKeys( {} ); // $ExpectError
+	jsonifyKeys( ( x: number ): number => x ); // $ExpectError
+}
+
+// The function does not compile if the second argument is a value other than a function...
+{
+	jsonifyKeys( '{beep:"boop"}', true ); // $ExpectError
+	jsonifyKeys( '{beep:"boop"}', false ); // $ExpectError
+	jsonifyKeys( '{beep:"boop"}', 5 ); // $ExpectError
+	jsonifyKeys( '{beep:"boop"}', [] ); // $ExpectError
+	jsonifyKeys( '{beep:"boop"}', {} ); // $ExpectError
+	jsonifyKeys( '{beep:"boop"}', 'baz' ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	jsonifyKeys(); // $ExpectError
+	jsonifyKeys( '{beep:"boop"}', 'baz', 'boz' ); // $ExpectError
+}

lib/node_modules/@stdlib/utils/jsonify-keys/examples/index.js

@@ -0,0 +1,41 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+var jsonifyKeys = require( './../lib' );
+
+var out = jsonifyKeys( '{beep:"boop"}' );
+console.log( out );
+// => {'beep':'boop'}
+
+out = jsonifyKeys( '3.14' );
+console.log( out );
+// => 3.14
+
+out = jsonifyKeys( 'true' );
+console.log( out );
+// => true
+
+out = jsonifyKeys( 'null' );
+console.log( out );
+// => null
+
+out = jsonifyKeys( '{ beep: "boop }' );
+console.log( out instanceof Error );
+// => true