@glint/type-test 2.0.0-alpha.1 → 2.0.1-unstable.0e67291

package/README.md

@@ -117,3 +117,4 @@ let hi: string = 'hi';
   {{expectTypeOf hi to.beAssignableToTypeOf a}}
 </template>
 ```
+

package/lib/index.d.ts

@@ -0,0 +1,88 @@
+import { DirectInvokable, HasContext } from '@glint/template/-private/integration';
+import { Equal, Extends, IsAny, IsNever, IsUnknown } from 'expect-type';
+interface UnaryExpectations<T> {
+    string: [Equal<T, string>, 'Expected type to be `string`, but got'];
+    number: [Equal<T, number>, 'Expected type to be `number`, but got'];
+    boolean: [Equal<T, boolean>, 'Expected type to be `boolean`, but got'];
+    symbol: [Equal<T, symbol>, 'Expected type to be a `symbol`, but got'];
+    any: [IsAny<T>, 'Expected type to be `any`, but got'];
+    unknown: [IsUnknown<T>, 'Expected type to be `unknown`, but got'];
+    never: [IsNever<T>, 'Expected type to be `never`, but got'];
+    null: [Equal<T, null>, 'Expected type to be `null`, but got'];
+    undefined: [Equal<T, undefined>, 'Expected type to be `undefined`, but got'];
+}
+interface BinaryExpectations<T, U> {
+    equal: [Equal<T, U>, 'Expected first type to be identical to the second'];
+    assignableTo: [Extends<T, U>, 'Expected first type to be assignable to the second'];
+}
+declare const Expectation: unique symbol;
+type Expectation<T> = {
+    [Expectation]: T;
+};
+type UnaryExpectationKind = keyof UnaryExpectations<any>;
+type UnaryExpectation<K extends UnaryExpectationKind> = Expectation<K>;
+type BinaryExpectationKind = keyof BinaryExpectations<any, any>;
+type BinaryExpectation<K extends BinaryExpectationKind> = Expectation<K>;
+type UnmetExpectation<M, T> = [M, T];
+type TypeTestTemplate<T> = abstract new () => HasContext<{
+    this: T;
+    args: {
+        expectTypeOf: typeof expectTypeOf;
+        to: typeof to;
+    };
+    blocks: {};
+    element: unknown;
+}>;
+type ExpectTypeOf = DirectInvokable<{
+    <T, E extends UnaryExpectationKind>(actual: T, expectation: UnaryExpectation<E>): UnaryExpectations<T>[E] extends [false, infer M] ? UnmetExpectation<M, T> : void;
+    <T, E extends BinaryExpectationKind, U>(actual: T, expectation: BinaryExpectation<E>, expected: U): BinaryExpectations<T, U>[E] extends [false, infer M] ? UnmetExpectation<M, [T, U]> : void;
+}>;
+/**
+ * Given a value, an expectation, and potentially a second value as the
+ * target of that expectation, confirms whether the type of that value
+ * meets the constraints set by the given expectation.
+ *
+ * ```handlebars
+ * {{expectTypeOf 123 to.beNumber}}
+ * {{expectTypeOf 123 to.equalTypeOf (add 1 2)}}
+ * ```
+ */
+export declare const expectTypeOf: ExpectTypeOf;
+/**
+ * Provides a set of possible expectations to apply against the
+ * type of a value passed to `{{expectTypeOf}}`.
+ */
+export declare const to: {
+    equalTypeOf: BinaryExpectation<'equal'>;
+    beAssignableToTypeOf: BinaryExpectation<'assignableTo'>;
+    beString: UnaryExpectation<'string'>;
+    beNumber: UnaryExpectation<'number'>;
+    beBoolean: UnaryExpectation<'boolean'>;
+    beSymbol: UnaryExpectation<'symbol'>;
+    beAny: UnaryExpectation<'any'>;
+    beUnknown: UnaryExpectation<'unknown'>;
+    beNever: UnaryExpectation<'never'>;
+    beNull: UnaryExpectation<'null'>;
+    beUndefined: UnaryExpectation<'undefined'>;
+};
+/**
+ * Given a loose-mode template (e.g. as defined using `hbs`), this
+ * wrapper sets the context of that template appropriately. It receives
+ * the `expectTypeOf` and `to` imports from this module as args, and
+ * optionally takes an initial `context` parameter that determines the
+ * type of the `{{this}}` value in the template.
+ *
+ * ```typescript
+ * typeTest(
+ *   { message: 'hello' },
+ *   hbs`
+ *     {{@expectTypeOf this.message @to.beString}}
+ *   `
+ * );
+ * ```
+ */
+export declare function typeTest<T>(context: T, template: TypeTestTemplate<T>): void;
+export declare function typeTest(template: TypeTestTemplate<null>): void;
+export declare function typeTest(...args: Array<unknown>): void;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAKxE,UAAU,iBAAiB,CAAC,CAAC;IAC3B,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,uCAAuC,CAAC,CAAC;IACpE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,uCAAuC,CAAC,CAAC;IACpE,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,wCAAwC,CAAC,CAAC;IACvE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,yCAAyC,CAAC,CAAC;IACtE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,oCAAoC,CAAC,CAAC;IACtD,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,wCAAwC,CAAC,CAAC;IAClE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,sCAAsC,CAAC,CAAC;IAC5D,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,qCAAqC,CAAC,CAAC;IAC9D,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,0CAA0C,CAAC,CAAC;CAC9E;AAED,UAAU,kBAAkB,CAAC,CAAC,EAAE,CAAC;IAC/B,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,mDAAmD,CAAC,CAAC;IAC1E,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,oDAAoD,CAAC,CAAC;CACrF;AAID,OAAO,CAAC,MAAM,WAAW,EAAE,OAAO,MAAM,CAAC;AACzC,KAAK,WAAW,CAAC,CAAC,IAAI;IAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC;AAE3C,KAAK,oBAAoB,GAAG,MAAM,iBAAiB,CAAC,GAAG,CAAC,CAAC;AACzD,KAAK,gBAAgB,CAAC,CAAC,SAAS,oBAAoB,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AACvE,KAAK,qBAAqB,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAChE,KAAK,iBAAiB,CAAC,CAAC,SAAS,qBAAqB,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAMzE,KAAK,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAIrC,KAAK,gBAAgB,CAAC,CAAC,IAAI,QAAQ,WAAW,UAAU,CAAC;IACvD,IAAI,EAAE,CAAC,CAAC;IACR,IAAI,EAAE;QAAE,YAAY,EAAE,OAAO,YAAY,CAAC;QAAC,EAAE,EAAE,OAAO,EAAE,CAAA;KAAE,CAAC;IAC3D,MAAM,EAAE,EAAE,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC,CAAC;AAEH,KAAK,YAAY,GAAG,eAAe,CAAC;IAClC,CAAC,CAAC,EAAE,CAAC,SAAS,oBAAoB,EAChC,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC/B,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IACpF,CAAC,CAAC,EAAE,CAAC,SAAS,qBAAqB,EAAE,CAAC,EACpC,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC,EACjC,QAAQ,EAAE,CAAC,GACV,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC9F,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,YAAY,EAAE,YAAY,CAAC;AAEhD;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE;IACvB,WAAW,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACxC,oBAAoB,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACxD,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACrC,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACrC,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACvC,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACrC,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC/B,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACjC,WAAW,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AACrF,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AACzE,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC"}

package/lib/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glint/type-test",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.1-unstable.0e67291",
   "repository": "typed-ember/glint",
   "description": "Tools for testing inferred types in Glint-enabled templates",
   "license": "MIT",
@@ -14,14 +14,19 @@
     "README.md",
     "lib"
   ],
+  "scripts": {
+    "test": "echo 'no standalone tests within this project'",
+    "test:typecheck": "glint -p __tests__",
+    "test:tsc": "echo 'no standalone tsc within this project'"
+  },
   "dependencies": {
     "expect-type": "^0.15.0"
   },
   "peerDependencies": {
-    "@glint/template": "*"
+    "@glint/template": "1.6.1-unstable.0e67291"
   },
   "devDependencies": {
-    "@glint/template": "1.6.0-alpha.0"
+    "@glint/template": "1.6.1-unstable.0e67291"
   },
   "release-plan": {
     "semverIncrementAs": {
@@ -34,10 +39,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "test": "echo 'no standalone tests within this project'",
-    "test:typecheck": "glint -p __tests__",
-    "test:tsc": "echo 'no standalone tsc within this project'"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 The Ember TypeScript team and contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.