@jest-com/types 1.260826.3 → 1.260827.14

package/README.md

@@ -13,16 +13,31 @@ describes the global `JestSDK` object that script creates.
 npm install --save-dev @jest-com/types
 ```
 
-## Usage
+## Setup
 
-Import any type from the package, anywhere in your project:
+TypeScript auto-loads types only from `node_modules/@types/*`, so name this
+package in your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["vite/client", "@jest-com/types"]
+  }
+}
+```
+
+List every type package you rely on. A `types` array replaces TypeScript's
+automatic inclusion, so anything left out of it stops being picked up.
+
+To avoid managing that list, add a `.d.ts` under your source root instead. Vite
+projects already have `src/vite-env.d.ts` for this:
 
 ```typescript
-import type { Jest, PlayerProfile, PurchaseData } from "@jest-com/types";
+/// <reference types="vite/client" />
+/// <reference types="@jest-com/types" />
 ```
 
-That is the whole setup. `JestSDK` and `window.JestSDK` are typed globals in
-every file, not just the one that imports:
+Either way, `JestSDK` and `window.JestSDK` are typed globals in every file:
 
 ```typescript
 await JestSDK.init();
@@ -30,15 +45,10 @@ await JestSDK.init();
 const player = JestSDK.getPlayer();
 ```
 
-If your game only touches the global and never annotates a named type, there is
-nothing for it to import. Add a `.d.ts` file instead, for example
-`src/jestsdk.d.ts`:
+Named types are exported for your own signatures:
 
 ```typescript
-/// <reference types="@jest-com/types" />
+import type { Jest, PlayerProfile, SubscriptionData } from "@jest-com/types";
 ```
 
-TypeScript auto-loads types only from `node_modules/@types/*`, so one or the
-other is needed.
-
 Full docs: https://docs.jest.com/sdk/html5

package/index.d.ts

@@ -1240,7 +1240,7 @@ export interface JestSDK {
 declare global {
   const JestSDK: Jest;
   interface Window {
-    JestSDK: Jest;
+    JestSDK?: Jest;
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jest-com/types",
-  "version": "1.260826.3",
+  "version": "1.260827.14",
   "description": "TypeScript types for the Jest HTML5 game SDK global (window.JestSDK).",
   "keywords": [
     "jest",