[secure-json-parse] add typings. (#38841)

types/secure-json-parse/index.d.ts

@@ -0,0 +1,14 @@
+// Type definitions for secure-json-parse 1.0
+// Project: https://github.com/fastify/secure-json-parse#readme
+// Definitions by: Sjoerd Diepen <https://github.com/OSjoerdWie>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+export type Reviver = (this: any, key: string, value: any) => any;
+
+export interface ParseOptions {
+	protoAction: "error" | "remove" | "ignore";
+}
+
+export function parse(input: string, reviver?: Reviver, options?: ParseOptions): any;
+export function safeParse(input: string, reviver?: Reviver): any;
+export function scan(input: any, options?: ParseOptions): void;

types/secure-json-parse/secure-json-parse-tests.ts

@@ -0,0 +1,42 @@
+import { parse, safeParse, scan } from "secure-json-parse";
+
+const reviverFunc = (_key: string, value: any) => typeof value === "number" ? value * 2 : value;
+
+let result: any;
+let tryResult = false;
+
+const simpleJson = "{\"a\": 3, \"b\": 4}";
+result = safeParse(simpleJson); // result === { a: 3, b: 4 }
+result = safeParse(simpleJson, reviverFunc); // result === { a: 6, b: 8 }
+result = parse(simpleJson); // result === { a: 3, b: 4 }
+result = parse(simpleJson, reviverFunc); // result === { a: 6, b: 8 }
+try {
+	scan(JSON.parse(simpleJson));
+	tryResult = true;
+} catch (error) {
+	tryResult = false;
+} // tryResult === true;
+
+const jsonWithProto = "{\"a\": 3, \"__proto__\": 4}";
+result = safeParse(jsonWithProto); // result === null
+result = safeParse(jsonWithProto, reviverFunc); // result === null
+result = parse(jsonWithProto, undefined, { protoAction: "remove" }); // result === { a: 3 }
+result = parse(jsonWithProto, reviverFunc, { protoAction: "remove" }); // result === { a: 6 }
+try {
+	scan(JSON.parse(jsonWithProto));
+	tryResult = true;
+} catch (error) {
+	tryResult = false;
+} // tryResult === false;
+
+const jsonWithNestedProto = "{\"a\": {\"__proto__\": 3}}";
+result = safeParse(jsonWithNestedProto); // result === null
+result = safeParse(jsonWithNestedProto, reviverFunc); // result === null
+result = parse(jsonWithNestedProto, undefined, { protoAction: "remove" }); // result === { a: {} }
+result = parse(jsonWithNestedProto, reviverFunc, { protoAction: "remove" }); // result === { a: {} }
+try {
+	scan(JSON.parse(jsonWithNestedProto), { protoAction: "remove" });
+	tryResult = true;
+} catch (error) {
+	tryResult = false;
+} // tryResult === true;

types/secure-json-parse/tsconfig.json

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "secure-json-parse-tests.ts"
+    ]
+}

types/secure-json-parse/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }