@fern-api/fdr-sdk 1.0.4-92b8658c63 → 1.0.4-cab13ddd2d

package/dist/api-definition/__test__/prune.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prune.test.js","sourceRoot":"","sources":["../../../src/api-definition/__test__/prune.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,MAAM,eAAe,GAAmC;IACpD,IAAI,EAAE,WAAoB;IAC1B,KAAK,EAAE;QACH,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,SAAS;QACjB,KAAK,EAAE,SAAS;QAChB,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,SAAS;KACrB;CACJ,CAAC;AAEF,MAAM,SAAS,GAA8B;IACzC,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC;IACnC,WAAW,EAAE,YAAY;IACzB,WAAW,EAAE,YAAY;IACzB,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,EAAE;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,EAAE;IACR,kBAAkB,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;IACtD,YAAY,EAAE;QACV;YACI,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,qBAAqB;YAC9B,SAAS,EAAE,SAAS;SACvB;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE;QACb;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC;YAChC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;YACzB,OAAO,EAAE,SAAS;SACrB;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE,SAAS;IAC1B,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,SAAS;IACpB,IAAI,EAAE,SAAS;IACf,SAAS,EAAE,SAAS;IACpB,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,SAAS;IACnB,gBAAgB,EAAE,SAAS;IAC3B,oBAAoB,EAAE,SAAS;CAClC,CAAC;AAEF,MAAM,SAAS,GAA8B;IACzC,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC;IACnC,WAAW,EAAE,YAAY;IACzB,WAAW,EAAE,YAAY;IACzB,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,EAAE;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,EAAE;IACR,kBAAkB,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;IACtD,YAAY,EAAE;QACV;YACI,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,qBAAqB;YAC9B,SAAS,EAAE,SAAS;SACvB;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE,SAAS;IAC1B,cAAc,EAAE;QACZ;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;YACjC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;SAC5B;KACJ;IACD,eAAe,EAAE,SAAS;IAC1B,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,SAAS;IACpB,IAAI,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IACnC,SAAS,EAAE,SAAS;IACpB,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,MAAM,EAAE,SAAS;IACjB,QAAQ,EAAE,SAAS;IACnB,gBAAgB,EAAE,SAAS;IAC3B,oBAAoB,EAAE,SAAS;CAClC,CAAC;AAEF,MAAM,UAAU,GAA4B;IACxC,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC;IACrC,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,EAAE;IACb,IAAI,EAAE,EAAE;IACR,QAAQ,EAAE;QACN;YACI,IAAI,EAAE,SAAS,CAAC,kBAAkB,CAAC,WAAW,CAAC;YAC/C,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,SAAS;YACtB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE;gBACF,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,UAAU;oBAChB,OAAO,EAAE,SAAS;oBAClB,KAAK,EAAE;wBACH,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACH,IAAI,EAAE,IAAI;4BACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;4BAC3B,OAAO,EAAE,SAAS;yBACrB;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,kBAAkB,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;IACtD,YAAY,EAAE;QACV;YACI,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC;YACtC,OAAO,EAAE,qBAAqB;YAC9B,SAAS,EAAE,SAAS;SACvB;KACJ;IACD,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE,SAAS;IAC1B,cAAc,EAAE,SAAS;IACzB,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,QAAQ,EAAE,SAAS;CACtB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,KAAK,GAA0B;IACjC,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,SAAS;IACtB,YAAY,EAAE,SAAS;IACvB,KAAK,EAAE;QACH,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;KACzB;IACD,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,UAAU,GAAsB;IAClC,IAAI,EAAE,YAAY;IAClB,SAAS,EAAE,WAAW;IACtB,WAAW,EAAE,SAAS;CACzB,CAAC;AAEF,MAAM,GAAG,GAAyB;IAC9B,EAAE,EAAE,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC;IACjC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE;QACP,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS;QACzB,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS;KAC5B;IACD,QAAQ,EAAE,EAAE;IACZ,UAAU,EAAE;QACR,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,UAAU;KAC9B;IACD,iBAAiB,EAAE,EAAE;IACrB,KAAK,EAAE;QACH,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;QAChC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;QAChC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;QAChC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK;KACnC;IACD,WAAW,EAAE,EAAE;IACf,KAAK,EAAE;QACH,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU;KAC5C;IACD,aAAa,EAAE;QACX;YACI,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;YACjC,UAAU,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3B,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,WAAW,EAAE,SAAS;YACtB,YAAY,EAAE,SAAS;YACvB,cAAc,EAAE,SAAS;SAC5B;KACJ;IACD,qBAAqB,EAAE,SAAS;CACnC,CAAC;AAEF,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACnB,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE;YACtB,IAAI,EAAE,UAAU;YAChB,UAAU,EAAE,SAAS,CAAC,EAAE;SAC3B,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE;YACtB,IAAI,EAAE,UAAU;YAChB,UAAU,EAAE,SAAS,CAAC,EAAE;SAC3B,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE;YACtB,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,UAAU,CAAC,EAAE;SAC7B,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/api-definition/__test__/unwrap.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=unwrap.test.d.ts.map

package/dist/api-definition/__test__/unwrap.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unwrap.test.d.ts","sourceRoot":"","sources":["../../../src/api-definition/__test__/unwrap.test.ts"],"names":[],"mappings":""}

package/dist/api-definition/__test__/unwrap.test.js

@@ -0,0 +1,587 @@
+import { PropertyKey, TypeId } from "../latest";
+import { unwrapObjectType, unwrapReference } from "../unwrap";
+const PRIMITIVE_SHAPE = {
+    type: "alias",
+    value: {
+        type: "primitive",
+        value: {
+            type: "string",
+            format: undefined,
+            regex: undefined,
+            minLength: undefined,
+            maxLength: undefined,
+            default: undefined
+        }
+    }
+};
+describe("unwrapReference", () => {
+    it("should noop for a non-reference", () => {
+        expect(unwrapReference(PRIMITIVE_SHAPE.value, {})).toMatchInlineSnapshot(`
+      {
+        "availability": undefined,
+        "default": undefined,
+        "descriptions": [],
+        "isNullable": false,
+        "isOptional": false,
+        "shape": {
+          "type": "primitive",
+          "value": {
+            "default": undefined,
+            "format": undefined,
+            "maxLength": undefined,
+            "minLength": undefined,
+            "regex": undefined,
+            "type": "string",
+          },
+        },
+        "visitedTypeIds": Set {},
+      }
+    `);
+    });
+    it("should unwrap a reference", () => {
+        const shape = {
+            type: "id",
+            id: TypeId("foo"),
+            default: undefined
+        };
+        const types = {
+            [TypeId("foo")]: {
+                name: "foo",
+                shape: PRIMITIVE_SHAPE,
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        expect(unwrapReference(shape, types)).toMatchInlineSnapshot(`
+      {
+        "availability": undefined,
+        "default": undefined,
+        "descriptions": [],
+        "isNullable": false,
+        "isOptional": false,
+        "shape": {
+          "type": "primitive",
+          "value": {
+            "default": undefined,
+            "format": undefined,
+            "maxLength": undefined,
+            "minLength": undefined,
+            "regex": undefined,
+            "type": "string",
+          },
+        },
+        "visitedTypeIds": Set {
+          "foo",
+        },
+      }
+    `);
+    });
+    it("should unwrap to unknown", () => {
+        const shape = {
+            type: "id",
+            id: TypeId("foo"),
+            default: undefined
+        };
+        expect(unwrapReference(shape, {})).toMatchInlineSnapshot(`
+      {
+        "availability": undefined,
+        "default": undefined,
+        "descriptions": [],
+        "isNullable": false,
+        "isOptional": false,
+        "shape": {
+          "displayName": undefined,
+          "type": "unknown",
+        },
+        "visitedTypeIds": Set {
+          "foo",
+        },
+      }
+    `);
+    });
+    it("should unwrap optionals", () => {
+        const shape = {
+            type: "id",
+            id: TypeId("foo"),
+            default: undefined
+        };
+        const types = {
+            [TypeId("foo")]: {
+                name: "foo",
+                shape: {
+                    type: "alias",
+                    value: {
+                        type: "optional",
+                        shape: PRIMITIVE_SHAPE,
+                        default: undefined
+                    }
+                },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        expect(unwrapReference(shape, types)).toMatchInlineSnapshot(`
+      {
+        "availability": undefined,
+        "default": undefined,
+        "descriptions": [],
+        "isNullable": false,
+        "isOptional": true,
+        "shape": {
+          "type": "primitive",
+          "value": {
+            "default": undefined,
+            "format": undefined,
+            "maxLength": undefined,
+            "minLength": undefined,
+            "regex": undefined,
+            "type": "string",
+          },
+        },
+        "visitedTypeIds": Set {
+          "foo",
+        },
+      }
+    `);
+    });
+    it("should unwrap optionals with defaults", () => {
+        const shape = {
+            type: "id",
+            id: TypeId("foo"),
+            default: undefined
+        };
+        const types = {
+            [TypeId("foo")]: {
+                name: "foo",
+                shape: {
+                    type: "alias",
+                    value: {
+                        type: "optional",
+                        shape: PRIMITIVE_SHAPE,
+                        default: "testing-a"
+                    }
+                },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        expect(unwrapReference(shape, types).default).toBe("testing-a");
+    });
+    it("should prefer shallowest default value", () => {
+        const shape = {
+            type: "optional",
+            shape: {
+                type: "alias",
+                value: {
+                    type: "id",
+                    id: TypeId("foo"),
+                    default: undefined
+                }
+            },
+            default: "testing-b"
+        };
+        const types = {
+            [TypeId("foo")]: {
+                name: "foo",
+                shape: {
+                    type: "alias",
+                    value: {
+                        type: "optional",
+                        shape: PRIMITIVE_SHAPE,
+                        default: "testing-a" // this should be ignored
+                    }
+                },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        expect(unwrapReference(shape, types).default).toBe("testing-b");
+    });
+    it("should return unknown on infinite circular reference", () => {
+        const shape = {
+            type: "id",
+            id: TypeId("foo"),
+            default: undefined
+        };
+        const types = {
+            [TypeId("foo")]: {
+                name: "foo",
+                shape: { type: "alias", value: shape },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        expect(unwrapReference(shape, types).shape.type).toBe("unknown");
+    });
+    it("should return the least stable availability level, and collect all descriptions", () => {
+        const shape = {
+            type: "id",
+            id: TypeId("a"),
+            default: undefined
+        };
+        const types = {
+            [TypeId("a")]: {
+                name: "a",
+                shape: {
+                    type: "alias",
+                    value: { type: "id", id: TypeId("b"), default: undefined }
+                },
+                description: "a",
+                availability: "Stable",
+                displayName: undefined
+            },
+            [TypeId("b")]: {
+                name: "b",
+                shape: {
+                    type: "alias",
+                    value: {
+                        type: "optional",
+                        shape: {
+                            type: "alias",
+                            value: {
+                                type: "id",
+                                id: TypeId("c"),
+                                default: undefined
+                            }
+                        },
+                        default: undefined
+                    }
+                },
+                description: "b",
+                availability: "Deprecated",
+                displayName: undefined
+            },
+            [TypeId("c")]: {
+                name: "c",
+                shape: PRIMITIVE_SHAPE,
+                description: "c",
+                availability: "InDevelopment",
+                displayName: undefined
+            }
+        };
+        const unwrapped = unwrapReference(shape, types);
+        expect(unwrapped.shape).toStrictEqual(PRIMITIVE_SHAPE.value);
+        expect(unwrapped.availability).toBe("Deprecated");
+        expect(unwrapped.descriptions).toStrictEqual(["a", "b", "c"]);
+        expect(unwrapped.isOptional).toBe(true);
+    });
+    it("should unwrap default value of enums", () => {
+        const types = {
+            [TypeId("a")]: {
+                name: "a",
+                shape: {
+                    type: "enum",
+                    values: [
+                        {
+                            value: "a",
+                            description: undefined,
+                            availability: undefined
+                        },
+                        {
+                            value: "b",
+                            description: undefined,
+                            availability: undefined
+                        }
+                    ],
+                    default: "a"
+                },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        expect(unwrapReference({
+            type: "id",
+            id: TypeId("a"),
+            default: undefined
+        }, types).default).toBe("a");
+        expect(unwrapReference({
+            type: "id",
+            id: TypeId("a"),
+            // this default overrides the default set by the enum:
+            default: {
+                type: "enum",
+                value: "b"
+            }
+        }, types).default).toBe("b");
+    });
+});
+describe("unwrapObjectType", () => {
+    it("should unwrap and sort required before optionals, and preserve order otherwise", () => {
+        const shape = {
+            type: "object",
+            extends: [],
+            properties: [
+                {
+                    key: PropertyKey("d"),
+                    valueShape: {
+                        type: "alias",
+                        value: {
+                            type: "optional",
+                            shape: PRIMITIVE_SHAPE,
+                            default: undefined
+                        }
+                    },
+                    description: undefined,
+                    availability: undefined,
+                    propertyAccess: undefined
+                },
+                {
+                    key: PropertyKey("a"),
+                    valueShape: {
+                        type: "alias",
+                        value: {
+                            type: "optional",
+                            shape: PRIMITIVE_SHAPE,
+                            default: undefined
+                        }
+                    },
+                    description: undefined,
+                    availability: undefined,
+                    propertyAccess: undefined
+                },
+                {
+                    key: PropertyKey("c"),
+                    valueShape: PRIMITIVE_SHAPE,
+                    description: undefined,
+                    availability: undefined,
+                    propertyAccess: undefined
+                },
+                {
+                    key: PropertyKey("b"),
+                    valueShape: PRIMITIVE_SHAPE,
+                    description: undefined,
+                    availability: undefined,
+                    propertyAccess: undefined
+                }
+            ],
+            extraProperties: undefined
+        };
+        expect(unwrapObjectType(shape, {}).properties.map((p) => p.key)).toStrictEqual([
+            PropertyKey("c"),
+            PropertyKey("b"),
+            PropertyKey("d"),
+            PropertyKey("a")
+        ]);
+    });
+    it("should unwrap extended objects", () => {
+        const shape = {
+            type: "object",
+            extends: [TypeId("c"), TypeId("b")],
+            properties: [
+                {
+                    key: PropertyKey("a"),
+                    valueShape: PRIMITIVE_SHAPE,
+                    description: undefined,
+                    availability: undefined,
+                    propertyAccess: undefined
+                },
+                {
+                    key: PropertyKey("d"),
+                    valueShape: {
+                        type: "alias",
+                        value: {
+                            type: "optional",
+                            shape: PRIMITIVE_SHAPE,
+                            default: undefined
+                        }
+                    },
+                    description: undefined,
+                    availability: undefined,
+                    propertyAccess: undefined
+                }
+            ],
+            extraProperties: undefined
+        };
+        const types = {
+            [TypeId("b")]: {
+                name: "b",
+                shape: {
+                    type: "object",
+                    extends: [],
+                    properties: [
+                        {
+                            key: PropertyKey("b"),
+                            valueShape: PRIMITIVE_SHAPE,
+                            description: undefined,
+                            availability: undefined,
+                            propertyAccess: undefined
+                        }
+                    ],
+                    extraProperties: undefined
+                },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            },
+            [TypeId("c")]: {
+                name: "c",
+                shape: {
+                    type: "object",
+                    extends: [],
+                    properties: [
+                        {
+                            key: PropertyKey("c"),
+                            valueShape: PRIMITIVE_SHAPE,
+                            description: undefined,
+                            availability: undefined,
+                            propertyAccess: undefined
+                        }
+                    ],
+                    extraProperties: undefined
+                },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        expect(unwrapObjectType(shape, types).properties.map((p) => p.key)).toStrictEqual([
+            PropertyKey("a"),
+            PropertyKey("b"),
+            PropertyKey("c"),
+            PropertyKey("d")
+        ]);
+    });
+    it("should mark properties of optional extended objects as optional", () => {
+        const shape = {
+            type: "object",
+            extends: [TypeId("b")],
+            properties: [
+                {
+                    key: PropertyKey("a"),
+                    valueShape: PRIMITIVE_SHAPE,
+                    description: undefined,
+                    availability: undefined,
+                    propertyAccess: undefined
+                }
+            ],
+            extraProperties: undefined
+        };
+        const types = {
+            [TypeId("b")]: {
+                name: "b",
+                shape: {
+                    type: "alias",
+                    value: {
+                        type: "optional",
+                        shape: {
+                            type: "alias",
+                            value: {
+                                type: "id",
+                                id: TypeId("c"),
+                                default: undefined
+                            }
+                        },
+                        default: undefined
+                    }
+                },
+                description: "description-1",
+                availability: "GenerallyAvailable",
+                displayName: undefined
+            },
+            [TypeId("c")]: {
+                name: "b",
+                shape: {
+                    type: "object",
+                    extends: [],
+                    properties: [
+                        {
+                            key: PropertyKey("b"),
+                            valueShape: {
+                                type: "alias",
+                                value: {
+                                    type: "optional",
+                                    shape: PRIMITIVE_SHAPE,
+                                    default: undefined
+                                }
+                            },
+                            description: undefined,
+                            availability: "Deprecated",
+                            propertyAccess: undefined
+                        },
+                        {
+                            key: PropertyKey("c"),
+                            valueShape: PRIMITIVE_SHAPE,
+                            description: undefined,
+                            availability: undefined,
+                            propertyAccess: undefined
+                        }
+                    ],
+                    extraProperties: undefined
+                },
+                description: "description-2",
+                availability: undefined,
+                displayName: undefined
+            }
+        };
+        const unwrapped = unwrapObjectType(shape, types);
+        expect(unwrapped.properties).toStrictEqual([
+            {
+                key: PropertyKey("a"),
+                valueShape: PRIMITIVE_SHAPE,
+                description: undefined,
+                availability: undefined,
+                propertyAccess: undefined
+            },
+            {
+                key: PropertyKey("c"),
+                valueShape: {
+                    type: "alias",
+                    value: {
+                        type: "optional",
+                        shape: PRIMITIVE_SHAPE,
+                        default: undefined
+                    }
+                },
+                description: undefined,
+                // availability is the least stable of the extended object
+                availability: "GenerallyAvailable",
+                propertyAccess: undefined
+            },
+            {
+                key: PropertyKey("b"),
+                valueShape: {
+                    type: "alias",
+                    value: {
+                        type: "optional",
+                        shape: PRIMITIVE_SHAPE,
+                        default: undefined
+                    }
+                },
+                description: undefined,
+                // availability is the least stable of the extended object
+                // and Deprecated is sorted after GenerallyAvailable
+                availability: "Deprecated",
+                propertyAccess: undefined
+            }
+        ]);
+        expect(unwrapped.descriptions).toStrictEqual(["description-1", "description-2"]);
+    });
+    it("should gracefully handle circular reference", () => {
+        const unwrapped = unwrapObjectType({
+            extends: [TypeId("id")],
+            properties: [],
+            extraProperties: undefined
+        }, {
+            [TypeId("id")]: {
+                name: "test",
+                shape: {
+                    type: "object",
+                    extends: [TypeId("id")],
+                    properties: [],
+                    extraProperties: undefined
+                },
+                description: undefined,
+                availability: undefined,
+                displayName: undefined
+            }
+        });
+        expect(unwrapped.properties.length).toBe(0);
+    });
+});
+//# sourceMappingURL=unwrap.test.js.map

package/dist/api-definition/__test__/unwrap.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unwrap.test.js","sourceRoot":"","sources":["../../../src/api-definition/__test__/unwrap.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAuB,MAAM,EAAsC,MAAM,WAAW,CAAC;AAEzG,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE9D,MAAM,eAAe,GAAc;IAC/B,IAAI,EAAE,OAAO;IACb,KAAK,EAAE;QACH,IAAI,EAAE,WAAoB;QAC1B,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,SAAS;YACjB,KAAK,EAAE,SAAS;YAChB,SAAS,EAAE,SAAS;YACpB,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,SAAS;SACrB;KACJ;CACJ,CAAC;AAEF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,qBAAqB,CACpE;;;;;;;;;;;;;;;;;;;;KAoBP,CACI,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACjC,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC;YACjB,OAAO,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACb,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,qBAAqB,CACvD;;;;;;;;;;;;;;;;;;;;;;KAsBP,CACI,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAChC,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC;YACjB,OAAO,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;KAe5D,CAAC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAC/B,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC;YACjB,OAAO,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACb,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE,eAAe;wBACtB,OAAO,EAAE,SAAS;qBACrB;iBACJ;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,qBAAqB,CACvD;;;;;;;;;;;;;;;;;;;;;;KAsBP,CACI,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC7C,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC;YACjB,OAAO,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACb,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE,eAAe;wBACtB,OAAO,EAAE,WAAW;qBACvB;iBACJ;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAC9C,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE;gBACH,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,IAAI;oBACV,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC;oBACjB,OAAO,EAAE,SAAS;iBACrB;aACJ;YACD,OAAO,EAAE,WAAW;SACvB,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACb,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE,eAAe;wBACtB,OAAO,EAAE,WAAW,CAAC,yBAAyB;qBACjD;iBACJ;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC5D,MAAM,KAAK,GAAkB;YACzB,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC;YACjB,OAAO,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE;gBACb,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE;gBACtC,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iFAAiF,EAAE,GAAG,EAAE;QACvF,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;YACf,OAAO,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE;iBAC7D;gBACD,WAAW,EAAE,GAAG;gBAChB,YAAY,EAAE,QAAQ;gBACtB,WAAW,EAAE,SAAS;aACzB;YACD,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACH,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE;gCACH,IAAI,EAAE,IAAI;gCACV,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;gCACf,OAAO,EAAE,SAAS;6BACrB;yBACJ;wBACD,OAAO,EAAE,SAAS;qBACrB;iBACJ;gBACD,WAAW,EAAE,GAAG;gBAChB,YAAY,EAAE,YAAY;gBAC1B,WAAW,EAAE,SAAS;aACzB;YACD,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,GAAG;gBAChB,YAAY,EAAE,eAAe;gBAC7B,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QACF,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC7D,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE;oBACH,IAAI,EAAE,MAAM;oBACZ,MAAM,EAAE;wBACJ;4BACI,KAAK,EAAE,GAAG;4BACV,WAAW,EAAE,SAAS;4BACtB,YAAY,EAAE,SAAS;yBAC1B;wBACD;4BACI,KAAK,EAAE,GAAG;4BACV,WAAW,EAAE,SAAS;4BACtB,YAAY,EAAE,SAAS;yBAC1B;qBACJ;oBACD,OAAO,EAAE,GAAG;iBACf;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QAEF,MAAM,CACF,eAAe,CACX;YACI,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;YACf,OAAO,EAAE,SAAS;SACrB,EACD,KAAK,CACR,CAAC,OAAO,CACZ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEZ,MAAM,CACF,eAAe,CACX;YACI,IAAI,EAAE,IAAI;YACV,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;YACf,sDAAsD;YACtD,OAAO,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,GAAG;aACb;SACJ,EACD,KAAK,CACR,CAAC,OAAO,CACZ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACtF,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;YACX,UAAU,EAAE;gBACR;oBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;oBACrB,UAAU,EAAE;wBACR,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACH,IAAI,EAAE,UAAU;4BAChB,KAAK,EAAE,eAAe;4BACtB,OAAO,EAAE,SAAS;yBACrB;qBACJ;oBACD,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;oBACvB,cAAc,EAAE,SAAS;iBAC5B;gBACD;oBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;oBACrB,UAAU,EAAE;wBACR,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACH,IAAI,EAAE,UAAU;4BAChB,KAAK,EAAE,eAAe;4BACtB,OAAO,EAAE,SAAS;yBACrB;qBACJ;oBACD,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;oBACvB,cAAc,EAAE,SAAS;iBAC5B;gBACD;oBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;oBACrB,UAAU,EAAE,eAAe;oBAC3B,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;oBACvB,cAAc,EAAE,SAAS;iBAC5B;gBACD;oBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;oBACrB,UAAU,EAAE,eAAe;oBAC3B,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;oBACvB,cAAc,EAAE,SAAS;iBAC5B;aACJ;YACD,eAAe,EAAE,SAAS;SAC7B,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC;YAC3E,WAAW,CAAC,GAAG,CAAC;YAChB,WAAW,CAAC,GAAG,CAAC;YAChB,WAAW,CAAC,GAAG,CAAC;YAChB,WAAW,CAAC,GAAG,CAAC;SACnB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACtC,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;YACnC,UAAU,EAAE;gBACR;oBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;oBACrB,UAAU,EAAE,eAAe;oBAC3B,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;oBACvB,cAAc,EAAE,SAAS;iBAC5B;gBACD;oBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;oBACrB,UAAU,EAAE;wBACR,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACH,IAAI,EAAE,UAAU;4BAChB,KAAK,EAAE,eAAe;4BACtB,OAAO,EAAE,SAAS;yBACrB;qBACJ;oBACD,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;oBACvB,cAAc,EAAE,SAAS;iBAC5B;aACJ;YACD,eAAe,EAAE,SAAS;SAC7B,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE;oBACX,UAAU,EAAE;wBACR;4BACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;4BACrB,UAAU,EAAE,eAAe;4BAC3B,WAAW,EAAE,SAAS;4BACtB,YAAY,EAAE,SAAS;4BACvB,cAAc,EAAE,SAAS;yBAC5B;qBACJ;oBACD,eAAe,EAAE,SAAS;iBAC7B;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;YACD,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE;oBACX,UAAU,EAAE;wBACR;4BACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;4BACrB,UAAU,EAAE,eAAe;4BAC3B,WAAW,EAAE,SAAS;4BACtB,YAAY,EAAE,SAAS;4BACvB,cAAc,EAAE,SAAS;yBAC5B;qBACJ;oBACD,eAAe,EAAE,SAAS;iBAC7B;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC;YAC9E,WAAW,CAAC,GAAG,CAAC;YAChB,WAAW,CAAC,GAAG,CAAC;YAChB,WAAW,CAAC,GAAG,CAAC;YAChB,WAAW,CAAC,GAAG,CAAC;SACnB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,KAAK,GAAyB;YAChC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,UAAU,EAAE;gBACR;oBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;oBACrB,UAAU,EAAE,eAAe;oBAC3B,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;oBACvB,cAAc,EAAE,SAAS;iBAC5B;aACJ;YACD,eAAe,EAAE,SAAS;SAC7B,CAAC;QACF,MAAM,KAAK,GAAmC;YAC1C,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACH,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE;gCACH,IAAI,EAAE,IAAI;gCACV,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;gCACf,OAAO,EAAE,SAAS;6BACrB;yBACJ;wBACD,OAAO,EAAE,SAAS;qBACrB;iBACJ;gBACD,WAAW,EAAE,eAAe;gBAC5B,YAAY,EAAE,oBAAoB;gBAClC,WAAW,EAAE,SAAS;aACzB;YACD,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE;oBACX,UAAU,EAAE;wBACR;4BACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;4BACrB,UAAU,EAAE;gCACR,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACH,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE,eAAe;oCACtB,OAAO,EAAE,SAAS;iCACrB;6BACJ;4BACD,WAAW,EAAE,SAAS;4BACtB,YAAY,EAAE,YAAY;4BAC1B,cAAc,EAAE,SAAS;yBAC5B;wBACD;4BACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;4BACrB,UAAU,EAAE,eAAe;4BAC3B,WAAW,EAAE,SAAS;4BACtB,YAAY,EAAE,SAAS;4BACvB,cAAc,EAAE,SAAS;yBAC5B;qBACJ;oBACD,eAAe,EAAE,SAAS;iBAC7B;gBACD,WAAW,EAAE,eAAe;gBAC5B,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CAAC;QAEF,MAAM,SAAS,GAAG,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAEjD,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,aAAa,CAAC;YACvC;gBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;gBACrB,UAAU,EAAE,eAAe;gBAC3B,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,cAAc,EAAE,SAAS;aAC5B;YACD;gBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;gBACrB,UAAU,EAAE;oBACR,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE,eAAe;wBACtB,OAAO,EAAE,SAAS;qBACrB;iBACJ;gBACD,WAAW,EAAE,SAAS;gBACtB,0DAA0D;gBAC1D,YAAY,EAAE,oBAAoB;gBAClC,cAAc,EAAE,SAAS;aAC5B;YACD;gBACI,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;gBACrB,UAAU,EAAE;oBACR,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE,eAAe;wBACtB,OAAO,EAAE,SAAS;qBACrB;iBACJ;gBACD,WAAW,EAAE,SAAS;gBACtB,0DAA0D;gBAC1D,oDAAoD;gBACpD,YAAY,EAAE,YAAY;gBAC1B,cAAc,EAAE,SAAS;aAC5B;SACJ,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,MAAM,SAAS,GAAG,gBAAgB,CAC9B;YACI,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACvB,UAAU,EAAE,EAAE;YACd,eAAe,EAAE,SAAS;SAC7B,EACD;YACI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE;gBACZ,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBACvB,UAAU,EAAE,EAAE;oBACd,eAAe,EAAE,SAAS;iBAC7B;gBACD,WAAW,EAAE,SAAS;gBACtB,YAAY,EAAE,SAAS;gBACvB,WAAW,EAAE,SAAS;aACzB;SACJ,CACJ,CAAC;QAEF,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/api-definition/availability.d.ts

@@ -0,0 +1,18 @@
+import * as Latest from "./latest";
+/**
+ * The order of availability levels, from most stable to least stable.
+ *
+ * This is used to sort the availability levels in the UI, and to determine the stability level of a type reference when multiple are available.
+ */
+export declare const AvailabilityOrder: readonly ["Stable", "GenerallyAvailable", "Beta", "PreRelease", "InDevelopment", "Deprecated"];
+/**
+ * @param availabilities an array of availability levels
+ * @returns the **least** stable availability level from the input array
+ */
+export declare function coalesceAvailability(availabilities: (Latest.Availability | null | undefined)[]): Latest.Availability | undefined;
+type AvailabilityValues = (typeof Latest.Availability)[keyof typeof Latest.Availability];
+type CheckAvailabilityOrder<T extends readonly AvailabilityValues[]> = T[number] extends AvailabilityValues ? AvailabilityValues extends T[number] ? true : false : false;
+type Assert<T extends true> = T;
+export type CheckAssert = Assert<CheckAvailabilityOrder<typeof AvailabilityOrder>>;
+export {};
+//# sourceMappingURL=availability.d.ts.map

package/dist/api-definition/availability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"availability.d.ts","sourceRoot":"","sources":["../../src/api-definition/availability.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,gGAOpB,CAAC;AAEX;;;GAGG;AACH,wBAAgB,oBAAoB,CAChC,cAAc,EAAE,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,GAC3D,MAAM,CAAC,YAAY,GAAG,SAAS,CAOjC;AAGD,KAAK,kBAAkB,GAAG,CAAC,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC;AACzF,KAAK,sBAAsB,CAAC,CAAC,SAAS,SAAS,kBAAkB,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,kBAAkB,GACrG,kBAAkB,SAAS,CAAC,CAAC,MAAM,CAAC,GAChC,IAAI,GACJ,KAAK,GACT,KAAK,CAAC;AACZ,KAAK,MAAM,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC;AAChC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,sBAAsB,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC"}

package/dist/api-definition/availability.js

@@ -0,0 +1,27 @@
+import * as Latest from "./latest";
+/**
+ * The order of availability levels, from most stable to least stable.
+ *
+ * This is used to sort the availability levels in the UI, and to determine the stability level of a type reference when multiple are available.
+ */
+export const AvailabilityOrder = [
+    Latest.Availability.Stable,
+    Latest.Availability.GenerallyAvailable,
+    Latest.Availability.Beta,
+    Latest.Availability.PreRelease,
+    Latest.Availability.InDevelopment,
+    Latest.Availability.Deprecated
+];
+/**
+ * @param availabilities an array of availability levels
+ * @returns the **least** stable availability level from the input array
+ */
+export function coalesceAvailability(availabilities) {
+    for (const availability of [...AvailabilityOrder].reverse()) {
+        if (availabilities.includes(availability)) {
+            return availability;
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=availability.js.map