test: apply api.d.ts validations in all packages (#112)

Author: bd82

packages/language-server/test/implementation-matches-public-api.ts

@@ -0,0 +1,20 @@
+import * as publicApi from "../api";
+import * as implementation from "../src/api";
+
+// https://www.typescriptlang.org/docs/handbook/generics.html#generic-constraints
+type AssertIsSubSet<SUBSET extends SUPERSET, SUPERSET> = [SUBSET, SUPERSET];
+
+// TODO: export these helper types from test-utils
+// Because TypeScript uses a Structural Typing system
+// We can perform logical assertions on the API vs Impel
+// using discrete math semantics (subsets/supersets)
+// See: https://www.typescriptlang.org/docs/handbook/type-compatibility.html
+type EnsureAllDeclaredAreExposedAtRuntime = AssertIsSubSet<
+  typeof implementation,
+  typeof publicApi
+>;
+
+type EnsureNoRedundantAreExposedAtRuntime = AssertIsSubSet<
+  typeof publicApi,
+  typeof implementation
+>;

packages/xml-views-completion/test/implementation-matches-public-api.ts

@@ -0,0 +1,20 @@
+import * as publicApi from "../api";
+import * as implementation from "../src/api";
+
+// https://www.typescriptlang.org/docs/handbook/generics.html#generic-constraints
+type AssertIsSubSet<SUBSET extends SUPERSET, SUPERSET> = [SUBSET, SUPERSET];
+
+// TODO: export these helper types from test-utils
+// Because TypeScript uses a Structural Typing system
+// We can perform logical assertions on the API vs Impel
+// using discrete math semantics (subsets/supersets)
+// See: https://www.typescriptlang.org/docs/handbook/type-compatibility.html
+type EnsureAllDeclaredAreExposedAtRuntime = AssertIsSubSet<
+  typeof implementation,
+  typeof publicApi
+>;
+
+type EnsureNoRedundantAreExposedAtRuntime = AssertIsSubSet<
+  typeof publicApi,
+  typeof implementation
+>;

packages/xml-views-validation/test/implementation-matches-public-api.ts

@@ -0,0 +1,20 @@
+import * as publicApi from "../api";
+import * as implementation from "../src/api";
+
+// https://www.typescriptlang.org/docs/handbook/generics.html#generic-constraints
+type AssertIsSubSet<SUBSET extends SUPERSET, SUPERSET> = [SUBSET, SUPERSET];
+
+// TODO: export these helper types from test-utils
+// Because TypeScript uses a Structural Typing system
+// We can perform logical assertions on the API vs Impel
+// using discrete math semantics (subsets/supersets)
+// See: https://www.typescriptlang.org/docs/handbook/type-compatibility.html
+type EnsureAllDeclaredAreExposedAtRuntime = AssertIsSubSet<
+  typeof implementation,
+  typeof publicApi
+>;
+
+type EnsureNoRedundantAreExposedAtRuntime = AssertIsSubSet<
+  typeof publicApi,
+  typeof implementation
+>;

test-packages/test-utils/api.d.ts

@@ -109,7 +109,10 @@ export function expectXMLAttribute(
 
 export function isObject(value: unknown): value is Record<string, unknown>;
 
-export function getFQN(model: UI5SemanticModel, target: unknown): string;
+export function getFQN(
+  model: UI5SemanticModel,
+  target: unknown
+): string | undefined;
 
 export function expectExists(value: unknown, message: string): asserts value;
 

test-packages/test-utils/src/utils/semantic-model-builder.ts

@@ -15,10 +15,10 @@ import {
   UI5Field,
   UI5EnumValue,
   UI5DeprecatedInfo,
+  UI5Association,
 } from "@ui5-language-assistant/semantic-model-types";
 
 import { PartialWithName } from "../../api";
-import { Ui5Association } from "@ui5-language-assistant/semantic-model/src/api-json";
 
 const baseUI5NodeDefaults: BaseUI5Node = {
   name: "",
@@ -89,20 +89,13 @@ export function buildUI5Constructor(
 }
 
 export function buildUI5Association(
-  opts: PartialWithName<Ui5Association>
-): Ui5Association {
+  opts: PartialWithName<UI5Association>
+): UI5Association {
   return {
     ...baseUI5NodeDefaults,
-    cardinality: undefined,
-    deprecated: undefined,
-    description: "",
-    experimental: undefined,
-    methods: [],
-    name: undefined,
-    since: undefined,
-    singularName: undefined,
-    type: "",
-    visibility: undefined,
+    kind: "UI5Association",
+    cardinality: "0..n",
+    type: undefined,
     ...opts,
   };
 }

test-packages/test-utils/test/implementation-matches-public-api.ts

@@ -0,0 +1,20 @@
+import * as publicApi from "../api";
+import * as implementation from "../src/api";
+
+// https://www.typescriptlang.org/docs/handbook/generics.html#generic-constraints
+type AssertIsSubSet<SUBSET extends SUPERSET, SUPERSET> = [SUBSET, SUPERSET];
+
+// TODO: export these helper types from test-utils
+// Because TypeScript uses a Structural Typing system
+// We can perform logical assertions on the API vs Impel
+// using discrete math semantics (subsets/supersets)
+// See: https://www.typescriptlang.org/docs/handbook/type-compatibility.html
+type EnsureAllDeclaredAreExposedAtRuntime = AssertIsSubSet<
+  typeof implementation,
+  typeof publicApi
+>;
+
+type EnsureNoRedundantAreExposedAtRuntime = AssertIsSubSet<
+  typeof publicApi,
+  typeof implementation
+>;