/*! * Copyright (c) Microsoft Corporation and contributors. All rights reserved. * Licensed under the MIT License. */ import type { JsonString } from "@fluidframework/core-interfaces/internal"; import { JsonStringify } from "@fluidframework/core-interfaces/internal"; import { assertIdenticalTypes, createInstanceOf, parameterAcceptedAs } from "./testUtils.js"; import type { ConstHeterogenousEnum, NumericEnum } from "./testValues.js"; import { jsonStringOfString, jsonStringOfObjectWithArrayOfNumbers, jsonStringOfStringRecordOfNumbers, jsonStringOfStringRecordOfNumberOrUndefined, jsonStringOfBigInt, jsonStringOfUnknown, } from "./testValues.js"; const jsonStringOfLiteral = JsonStringify("literal"); describe("JsonString", () => { it("`JsonString` is assignable to `string`", () => { parameterAcceptedAs(jsonStringOfString); parameterAcceptedAs(jsonStringOfLiteral); parameterAcceptedAs(jsonStringOfObjectWithArrayOfNumbers); parameterAcceptedAs(jsonStringOfStringRecordOfNumbers); parameterAcceptedAs(jsonStringOfStringRecordOfNumberOrUndefined); parameterAcceptedAs(jsonStringOfBigInt); parameterAcceptedAs(jsonStringOfUnknown); }); it("`string` is not assignable to `JsonString`", () => { parameterAcceptedAs>( // @ts-expect-error Type 'string' is not assignable to type 'JsonString' "a string", ); }); it("object is not assignable to `JsonString`", () => { parameterAcceptedAs>( // @ts-expect-error Type '{ property: string; }' is not assignable to type 'JsonString' { property: "value" }, ); }); describe("is covariant over T", () => { it('`JsonString<"literal">` is assignable to `JsonString`', () => { parameterAcceptedAs>(jsonStringOfLiteral); }); it("`JsonString>` is assignable to `JsonString>`", () => { parameterAcceptedAs>>( jsonStringOfStringRecordOfNumbers, ); }); it("`JsonString>` is assignable to `JsonString>`", () => { parameterAcceptedAs>>( jsonStringOfStringRecordOfNumberOrUndefined, ); }); it("`JsonString` is assignable to `JsonString`", () => { parameterAcceptedAs>(jsonStringOfBigInt); }); it("`JsonString | JsonString` is assignable to `JsonString`", () => { const jsonStringUnion = Math.random() < 0.5 ? jsonStringOfString : jsonStringOfObjectWithArrayOfNumbers; parameterAcceptedAs>(jsonStringUnion); }); }); describe("is not contravariant over T", () => { it('`JsonString` is not assignable to `JsonString<"literal">`', () => { parameterAcceptedAs>( // @ts-expect-error Type 'string' is not assignable to type '"literal"' jsonStringOfString, ); }); it("`JsonString>` is not assignable to `JsonString>`", () => { parameterAcceptedAs>>( // @ts-expect-error Type 'Record' is not assignable to type 'Record' jsonStringOfStringRecordOfNumberOrUndefined, ); }); it("`JsonString` is not assignable to `JsonString`", () => { parameterAcceptedAs>( // @ts-expect-error Type 'unknown' is not assignable to type 'bigint' jsonStringOfUnknown, ); }); it("`JsonString` is not assignable to `JsonString`", () => { parameterAcceptedAs>( // @ts-expect-error Type 'JsonString' is not assignable to type 'JsonString' jsonStringOfString as JsonString, ); }); }); type ExtractJsonStringBrand> = T extends string & infer B ? B : never; // Practically `JsonString` is the same as `JsonString | JsonString` // since all encodings are the same and parsing from either produces the same // `A|B` result. it("`JsonString` is assignable to `JsonString | JsonString` without enums involved", () => { // Setup const explicitBrandUnion = createInstanceOf< string & ( | ExtractJsonStringBrand> | ExtractJsonStringBrand> ) >(); const explicitPostBrandUnion = createInstanceOf< | (string & ExtractJsonStringBrand>) | (string & ExtractJsonStringBrand>) >(); assertIdenticalTypes(explicitBrandUnion, explicitPostBrandUnion); assertIdenticalTypes( explicitBrandUnion, createInstanceOf>(), ); assertIdenticalTypes( explicitPostBrandUnion, createInstanceOf | JsonString<{ arrayOfNumbers: number[] }>>(), ); assertIdenticalTypes( createInstanceOf>(), createInstanceOf | JsonString<{ arrayOfNumbers: number[] }>>(), ); // Act and Verify parameterAcceptedAs | JsonString<{ arrayOfNumbers: number[] }>>( jsonStringOfString as JsonString, ); }); it("`JsonString` is assignable to `JsonString | JsonString` with enums involved", () => { parameterAcceptedAs | JsonString<{ arrayOfNumbers: number[] }>>( createInstanceOf>(), ); parameterAcceptedAs< JsonString | JsonString<{ arrayOfNumbers: number[] }> >(createInstanceOf>()); parameterAcceptedAs | JsonString>( createInstanceOf>(), ); }); });