🤖 Merge PR DefinitelyTyped#72112 Add types for the npm package "json-source-map". by @rehmsen

Author: rehmsen

types/json-source-map/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/json-source-map/index.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Parses JSON string.
+ *
+ * @param source The JSON string to parse.
+ * @param _ Unused - reveserved for reviver of JSON.parse.
+ * @param options.bigint If true, parse large integers as BigInt
+ * @returns Object with properties:
+ *   data: The parsed data.
+ *   pointers: An object where each key is a JSON pointer (RFC 6901), each
+ *     corresponding value is a Mapping object.
+ */
+export function parse(
+    source: string,
+    _?: unknown,
+    options?: ParseOptions,
+): {
+    data: unknown;
+    pointers: Pointers;
+};
+
+/**
+ * Stringifies JavaScript data.
+ *
+ * @param data The data to convert to JSON.
+ * @param _ Unused - reserved for replacer of JSON.stringify.
+ * @param options If number or string, like the space parameter of
+ *   JSON.stringify, but if it is a string, it may only contain characters
+ *   space, tab ('\t'), caret return ('\r') and line feed ('\n') - using any
+ *   other character throws an exception.
+ * @param options.space: Like above.
+ * @param options.es6: If true, stringify ES6 Maps, Sets and Typed arrays as
+ *   JSON arrays.
+ */
+export function stringify(
+    data: number | bigint | boolean | string | object,
+    _?: unknown,
+    options?: StringifyOptions | number | string,
+): {
+    json: string;
+    pointers: Pointers;
+};
+
+export interface ParseOptions {
+    /** Parse large integers as BigInt */
+    bigint?: boolean;
+}
+
+export interface StringifyOptions {
+    /**
+     * Like the space parameter of JSON.stringify, but if it is a string, it may
+     * only contain characters space, tab ('\t'), caret return ('\r') and line
+     * feed ('\n') - using any other character throws an exception.
+     */
+    space?: number | string;
+
+    /** Stringify ES6 Maps, Sets and Typed arrays (as JSON arrays). */
+    es6?: boolean;
+}
+
+export interface Pointers {
+    /**
+     * Each key is a JSON pointer
+     * ([RFC 6901](https://datatracker.ietf.org/doc/html/rfc6901)).
+     */
+    [pointer: string]: Mapping;
+}
+
+export interface Mapping {
+    /**
+     * Location of the beginning of the key in JSON string. This property is
+     * only present if parent data is an object (rather than array).
+     */
+    key?: Location;
+
+    /**
+     * Location of the end of the key in JSON string. This property is only
+     * present if parent data is an object.
+     */
+    keyEnd?: Location;
+
+    /** Location of the beginning of the value in JSON string. */
+    value: Location;
+
+    /** Location of the end of the value in JSON string. */
+    valueEnd: Location;
+}
+
+/** Location in the source string - zero-based numbers. */
+export interface Location {
+    /** Line number in JSON file. */
+    line: number;
+
+    /** Column number in JSON string (from the beginning of line. */
+    column: number;
+
+    /** Column number in JSON string (from the beginning of line. */
+    pos: number;
+}

types/json-source-map/json-source-map-tests.ts

@@ -0,0 +1,13 @@
+import { parse, stringify } from "json-source-map";
+
+const stringifyResult = stringify({ foo: "bar" }, null, 2);
+// $ExpectType string
+const json = stringifyResult.json;
+// $ExpectType Pointers
+const stringifyPointers = stringifyResult.pointers;
+
+const parseResult = parse("{ \"foo\": \"bar\" }");
+// $ExpectType unknown
+const data = parseResult.data;
+// $ExpectType Pointers
+const parsePointers = parseResult.pointers;

types/json-source-map/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/json-source-map",
+    "version": "0.6.9999",
+    "projects": [
+        "https://github.com/epoberezkin/json-source-map#readme"
+    ],
+    "devDependencies": {
+        "@types/json-source-map": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Ole Rehmsen",
+            "githubUsername": "rehmsen"
+        }
+    ]
+}

types/json-source-map/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "json-source-map-tests.ts"
+    ]
+}