@prismatic-io/spectral 3.1.0

package/dist/util.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util.test.js

@@ -0,0 +1,286 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fast_check_1 = __importDefault(require("fast-check"));
+const util_1 = __importDefault(require("./util"));
+describe("util", () => {
+    const bufferArbitrary = fast_check_1.default
+        .base64String()
+        .map((v) => Buffer.from(v, "base64"));
+    const uint8ArrayArbitrary = bufferArbitrary.map((b) => new Uint8Array(b));
+    const unknowns = () => fast_check_1.default.constantFrom(undefined);
+    const emptyStrings = () => fast_check_1.default.constantFrom("");
+    describe("boolean", () => {
+        const booleanStringValues = {
+            truthy: ["true", "t", "T", "yes", "y", "Y"],
+            falsy: ["false", "f", "F", "no", "n", "N", ""],
+        };
+        const truthy = () => fast_check_1.default.constantFrom(true, ...booleanStringValues.truthy);
+        const falsy = () => fast_check_1.default.constantFrom(false, ...booleanStringValues.falsy);
+        const invalidValues = fast_check_1.default.oneof(fast_check_1.default.integer(), fast_check_1.default
+            .string()
+            .filter((v) => !booleanStringValues.truthy.includes(v) &&
+            !booleanStringValues.falsy.includes(v)), fast_check_1.default.float(), fast_check_1.default.double());
+        it("detects boolean value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.boolean(), (v) => expect(util_1.default.types.isBool(v)).toStrictEqual(true)));
+        });
+        it("detects non-boolean value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(util_1.default.types.isBool(v)).toStrictEqual(false)));
+        });
+        it("coerces truthy values to true", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(truthy(), (v) => expect(util_1.default.types.toBool(v)).toStrictEqual(true)));
+        });
+        it("coerces falsy values to false", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(falsy(), (v) => expect(util_1.default.types.toBool(v)).toStrictEqual(false)));
+        });
+        it("allows for boolean default to false for undefined inputs and undefined default", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => expect(util_1.default.types.toBool(v)).toStrictEqual(false)));
+        });
+        it("allows for boolean default of false for undefined inputs", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => expect(util_1.default.types.toBool(v, false)).toStrictEqual(false)));
+        });
+        it("allows for boolean default of true for undefined inputs", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => expect(util_1.default.types.toBool(v, true)).toStrictEqual(true)));
+        });
+        it("allows for boolean default to false for empty string inputs and undefined default", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(emptyStrings(), (v) => expect(util_1.default.types.toBool(v)).toStrictEqual(false)));
+        });
+        it("allows for boolean default of false for empty string inputs", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(emptyStrings(), (v) => expect(util_1.default.types.toBool(v, false)).toStrictEqual(false)));
+        });
+        it("allows for boolean default of true for empty string inputs", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(emptyStrings(), (v) => expect(util_1.default.types.toBool(v, true)).toStrictEqual(true)));
+        });
+    });
+    describe("integer", () => {
+        const invalidValues = fast_check_1.default.oneof(fast_check_1.default.string().filter((v) => Number.isNaN(Number.parseInt(v)) && v !== ""));
+        it("detects integer value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.integer(), (v) => expect(util_1.default.types.isInt(v)).toStrictEqual(true)));
+        });
+        it("detects non-integer value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(util_1.default.types.isInt(v)).toStrictEqual(false)));
+        });
+        it("coerces integer values", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.integer(), (v) => expect(util_1.default.types.toInt(v.toString())).toStrictEqual(v)));
+        });
+        it("coerces a float to an int", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.float(), (v) => expect(util_1.default.types.toInt(v)).toStrictEqual(~~v)));
+        });
+        it("throws when coercing non-integer values", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(() => util_1.default.types.toInt(v)).toThrow("cannot be coerced to int")));
+        });
+        it("Allows for default value of 0 when value is undefined", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => expect(util_1.default.types.toInt(v)).toStrictEqual(0)));
+        });
+        it("Allows for default values when value is undefined", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => expect(util_1.default.types.toInt(v, 20)).toStrictEqual(20)));
+        });
+        it("Allows for default value of 0 when value is empty string", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(emptyStrings(), (v) => expect(util_1.default.types.toInt(v)).toStrictEqual(0)));
+        });
+        it("Allows for default values when value is empty string", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(emptyStrings(), (v) => expect(util_1.default.types.toInt(v, 20)).toStrictEqual(20)));
+        });
+    });
+    describe("number", () => {
+        const validValues = fast_check_1.default.string().filter((v) => !Number.isNaN(Number(v)));
+        const invalidValues = fast_check_1.default.string().filter((v) => Number.isNaN(Number(v)));
+        it("detects things that can be cast to a number", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(validValues, (v) => expect(util_1.default.types.isNumber(v)).toStrictEqual(true)));
+        });
+        it("detects things that cannot be cast to a number", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(util_1.default.types.isNumber(v)).toStrictEqual(false)));
+        });
+        it("returns a number when given a number", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.float(), (v) => expect(util_1.default.types.toNumber(v)).toStrictEqual(v)));
+        });
+        it("returns a number when given something that can be cast to number", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(validValues, (v) => expect(util_1.default.types.toNumber(v)).toStrictEqual(Number(v))));
+        });
+        it("throws when coercing non-number values", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(() => util_1.default.types.toNumber(v)).toThrow("cannot be coerced to a number")));
+        });
+        it("returns the default value when a value is missing", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => expect(util_1.default.types.toNumber(v, 5.5)).toStrictEqual(5.5)));
+        });
+    });
+    describe("bigint", () => {
+        const invalidValues = fast_check_1.default.string().filter((v) => {
+            try {
+                BigInt(v);
+                return false;
+            }
+            catch (error) {
+                return true;
+            }
+        });
+        it("detects bigint value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.bigInt(), (v) => expect(util_1.default.types.isBigInt(v)).toStrictEqual(true)));
+        });
+        it("detects non-bigint value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(util_1.default.types.isBigInt(v)).toStrictEqual(false)));
+        });
+        it("coerces bigint values", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.bigInt(), (v) => expect(util_1.default.types.toBigInt(v.toString())).toStrictEqual(v)));
+        });
+        it("throws when coercing non-bigint values", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(() => util_1.default.types.toBigInt(v)).toThrow("cannot be coerced to bigint")));
+        });
+    });
+    describe("date", () => {
+        const invalidValues = fast_check_1.default.oneof(
+        // Filter out numerical strings as many of those are valid enough for ISO
+        // TODO: Figure out if this is fine or if we should only accept specific formats
+        fast_check_1.default.string().filter((v) => !Number.parseInt(v)));
+        it("detects date value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.date(), (v) => expect(util_1.default.types.isDate(v)).toStrictEqual(true)));
+        });
+        it("detects non-date value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(util_1.default.types.isDate(v)).toStrictEqual(false)));
+        });
+        it("coerces date values", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.date(), (v) => expect(util_1.default.types.toDate(v.toISOString())).toStrictEqual(v)));
+        });
+        it("throws when coercing non-date values", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(() => util_1.default.types.toDate(v)).toThrow("cannot be coerced to date")));
+        });
+    });
+    describe("url", () => {
+        const invalidValues = fast_check_1.default.oneof(fast_check_1.default.string());
+        it("detects url value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.oneof(fast_check_1.default.webUrl(), fast_check_1.default.domain().map((v) => `https://${v}`)), (v) => expect(util_1.default.types.isUrl(v)).toStrictEqual(true)));
+        });
+        it("detects non-url value", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(invalidValues, (v) => expect(util_1.default.types.isUrl(v)).toStrictEqual(false)));
+        });
+    });
+    describe("buffer data payload", () => {
+        it("detects buffer data payload", () => {
+            const payloadTypes = fast_check_1.default.record({
+                data: bufferArbitrary,
+                contentType: fast_check_1.default.string(),
+            });
+            fast_check_1.default.assert(fast_check_1.default.property(payloadTypes, (v) => {
+                expect(util_1.default.types.isBufferDataPayload(v)).toStrictEqual(true);
+            }));
+        });
+        it("coerces string to plain text buffer", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.string(), (v) => {
+                expect(util_1.default.types.toBufferDataPayload(v)).toMatchObject({
+                    data: Buffer.from(v, "utf-8"),
+                    contentType: "text/plain",
+                });
+            }));
+        });
+        it("serializes data to JSON and coerces to json text buffer", () => {
+            const jsonTypes = fast_check_1.default.oneof(fast_check_1.default.array(fast_check_1.default.anything()), fast_check_1.default.object());
+            fast_check_1.default.assert(fast_check_1.default.property(jsonTypes, (v) => expect(util_1.default.types.toBufferDataPayload(v)).toMatchObject({
+                data: Buffer.from(JSON.stringify(v), "utf-8"),
+                contentType: "application/json",
+            })));
+        });
+        it("directly returns DataPayload", () => {
+            const payloadTypes = fast_check_1.default.record({
+                data: bufferArbitrary,
+                contentType: fast_check_1.default.string(),
+                suggestedExtension: fast_check_1.default.oneof(fast_check_1.default.constant(undefined), fast_check_1.default.string()),
+            });
+            fast_check_1.default.assert(fast_check_1.default.property(payloadTypes, (v) => expect(util_1.default.types.toBufferDataPayload(v)).toStrictEqual(v)));
+        });
+        it("returns buffer with unknown content type", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(bufferArbitrary, (v) => expect(util_1.default.types.toBufferDataPayload(v)).toMatchObject({
+                data: v,
+                contentType: "application/octet-stream",
+            })));
+        });
+        it("handles Uint8Array as a Buffer", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(uint8ArrayArbitrary, (v) => expect(util_1.default.types.toBufferDataPayload(v)).toMatchObject({
+                data: Buffer.from(v),
+                contentType: "application/octet-stream",
+            })));
+        });
+    });
+    describe("data", () => {
+        it("detects data payload", () => {
+            const payloadTypes = fast_check_1.default.record({
+                data: bufferArbitrary,
+                contentType: fast_check_1.default.string(),
+            });
+            fast_check_1.default.assert(fast_check_1.default.property(payloadTypes, (v) => {
+                expect(util_1.default.types.isData(v)).toStrictEqual(true);
+            }));
+        });
+        it("coerces string to plain text buffer", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(fast_check_1.default.string(), (v) => {
+                expect(util_1.default.types.toData(v)).toMatchObject({
+                    data: Buffer.from(v, "utf-8"),
+                    contentType: "text/plain",
+                });
+            }));
+        });
+        it("serializes data to JSON and coerces to json text buffer", () => {
+            const jsonTypes = fast_check_1.default.oneof(fast_check_1.default.array(fast_check_1.default.anything()), fast_check_1.default.object());
+            fast_check_1.default.assert(fast_check_1.default.property(jsonTypes, (v) => expect(util_1.default.types.toData(v)).toMatchObject({
+                data: Buffer.from(JSON.stringify(v), "utf-8"),
+                contentType: "application/json",
+            })));
+        });
+        it("directly returns DataPayload", () => {
+            const payloadTypes = fast_check_1.default.record({
+                data: bufferArbitrary,
+                contentType: fast_check_1.default.string(),
+                suggestedExtension: fast_check_1.default.oneof(fast_check_1.default.constant(undefined), fast_check_1.default.string()),
+            });
+            fast_check_1.default.assert(fast_check_1.default.property(payloadTypes, (v) => expect(util_1.default.types.toData(v)).toStrictEqual(v)));
+        });
+        it("returns buffer with unknown content type", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(bufferArbitrary, (v) => expect(util_1.default.types.toData(v)).toMatchObject({
+                data: v,
+                contentType: "application/octet-stream",
+            })));
+        });
+        it("handles Uint8Array as a Buffer", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(uint8ArrayArbitrary, (v) => expect(util_1.default.types.toData(v)).toMatchObject({
+                data: Buffer.from(v),
+                contentType: "application/octet-stream",
+            })));
+        });
+    });
+    describe("string", () => {
+        it("coerces plain text buffer to string", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(bufferArbitrary, (v) => {
+                expect(util_1.default.types.toString(v)).toStrictEqual(v.toString());
+            }));
+        });
+        it("coerces unknown value to empty string", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => {
+                expect(util_1.default.types.toString(v)).toStrictEqual("");
+            }));
+        });
+        it("coerces unknown value to given default string", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(unknowns(), (v) => {
+                expect(util_1.default.types.toString(v, "hello, world")).toStrictEqual("hello, world");
+            }));
+        });
+    });
+    //TODO add an arbitrary for KeyValueList to test unique values
+    describe("KeyValueList", () => {
+        it("coerces KeyValueList to object", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(bufferArbitrary, () => {
+                const fakeData = [
+                    { key: "foo", value: "bar" },
+                    { key: "myKey", value: "myValue" },
+                ];
+                const expectedData = { foo: "bar", myKey: "myValue" };
+                expect(util_1.default.types.keyValPairListToObject(fakeData)).toStrictEqual(expectedData);
+            }));
+        });
+        it("handles KeyValueList as undefined", () => {
+            fast_check_1.default.assert(fast_check_1.default.property(bufferArbitrary, () => {
+                expect(util_1.default.types.keyValPairListToObject(undefined)).toStrictEqual({});
+            }));
+        });
+    });
+});

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@prismatic-io/spectral",
+  "version": "3.1.0",
+  "description": "Utility library for building Prismatic components",
+  "keywords": [
+    "prismatic"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "homepage": "https://prismatic.io",
+  "bugs": {
+    "url": "https://github.com/prismatic-io/spectral"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prismatic-io/spectral.git"
+  },
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "yarn run format && yarn run lint && yarn run clean && tsc",
+    "prepack": "yarn run build",
+    "format": "yarn run lint-fix && prettier --loglevel error --write 'src/**/*.ts' '*.{ts,js,json}' '!sidebars.{js,jse}'",
+    "check-format": "prettier --check 'src/**/*.ts' '*.{ts,js,json}' '!sidebars.{js,jse}'",
+    "check": "yarn run check-format && yarn run lint",
+    "lint": "eslint --ext .ts,.js src/",
+    "lint-fix": "eslint --fix --ext .ts,.js src/",
+    "test": "jest --maxWorkers=4",
+    "docs": "rm -f sidebars.{js,jse} && typedoc"
+  },
+  "files": [
+    "dist/"
+  ],
+  "dependencies": {
+    "date-fns": "2.17.0",
+    "jest-mock": "27.0.3",
+    "valid-url": "1.0.9"
+  },
+  "devDependencies": {
+    "@types/jest": "26.0.23",
+    "@types/node": "14.14.35",
+    "@types/valid-url": "1.0.3",
+    "@typescript-eslint/eslint-plugin": "4.27.0",
+    "@typescript-eslint/parser": "4.27.0",
+    "eslint": "7.28.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-jest": "24.3.6",
+    "eslint-plugin-prettier": "3.4.0",
+    "fast-check": "2.16.0",
+    "jest": "27.0.4",
+    "prettier": "2.3.1",
+    "ts-jest": "27.0.3",
+    "typedoc": "0.17.7",
+    "typedoc-plugin-markdown": "2.4.2",
+    "typedoc-plugin-remove-references": "0.0.5",
+    "typescript": "4.3.4"
+  },
+  "eslintConfig": {
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "env": {
+      "node": true
+    },
+    "parserOptions": {
+      "project": [
+        "./tsconfig.json"
+      ]
+    },
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:@typescript-eslint/recommended-requiring-type-checking",
+      "prettier"
+    ],
+    "rules": {
+      "@typescript-eslint/explicit-function-return-type": "off",
+      "@typescript-eslint/restrict-template-expressions": "off"
+    }
+  }
+}