@ms-cloudpack/common-types-browser 0.5.6 → 0.6.1

package/README.md

@@ -1,26 +1,23 @@
 # @ms-cloudpack/common-types-browser
 
-This package provides types that are specific to the browser environment. There are two ways to use this package.
+This package provides Cloudpack types that are specific to the browser environment. There are two ways to use this package.
 
-## Directly: You can import types directly from this package
+## Import types directly
 
 ```typescript
 import { PageSessionContext } from '@ms-cloudpack/common-types-browser';
 ```
 
-This is useful for server code. However, if you are writing code that runs in the browser, you should consider the second option.
+This is useful for server code, since it **does not** define the `window.__cloudpack` global.
 
-## Configure tsconfig.json to have @ms-cloudpack/common-types by default
+## Configure tsconfig.json to include the globals
+
+This makes `window.__cloudpack` and `window.__pageEvents` available to your code. (You can combine this with importing individual types as needed.)
 
 ```json
 {
-  "extends": "@ms-cloudpack/scripts/tsconfig.browser.json",
-  "include": ["./src"],
   "compilerOptions": {
-    "types": ["@ms-cloudpack/common-types-browser"],
-    "customConditions": ["browser"]
+    "types": ["@ms-cloudpack/common-types-browser/global"]
   }
 }
 ```
-
-This will make the types from this package available by default in your browser code.

package/global.d.ts

@@ -0,0 +1,11 @@
+import type { CloudpackGlobal, PageErrorsGlobal } from './index.js';
+
+export {}; // Make this a module
+
+declare global {
+  interface Window {
+    __cloudpack?: CloudpackGlobal;
+    /** Track uncaught errors (defined in `errorHandler.inline.ts` and read by the overlay) */
+    __pageErrors?: PageErrorsGlobal;
+  }
+}

package/index.d.ts

@@ -1,5 +1,3 @@
-export {}; // Make this a module
-
 /** Client and server side object for Cloudpack to detect app-specific page load time entry */
 export interface PageLoadTimePerformanceEntry {
   /** The name of the performance mark/measure to query. */
@@ -60,31 +58,29 @@ export interface BootstrapInput {
   entryScripts?: string[];
 }
 
-declare global {
-  interface Window {
-    __cloudpack?: {
-      /** Get page load time for telemetry (defined in `getPageLoadTime.inline.ts`) */
-      getPageLoadTime?: () => Promise<number>;
-      /** Get cache hit ratio for telemetry (defined in `getBrowserCacheRatio.inline.ts`) */
-      getBrowserCacheRatio?: () => {
-        ratio: number;
-        hit: number;
-        total: number;
-      };
-      /** Set up a Cloudpack app in side-loading scenarios (defined in `bootstrap.inline.ts`) */
-      bootstrap?: (input: BootstrapInput) => void;
+/** Types for `window.__cloudpack` */
+export interface CloudpackGlobal {
+  /** Get page load time for telemetry (defined in `getPageLoadTime.inline.ts`) */
+  getPageLoadTime?: () => Promise<number>;
+  /** Get cache hit ratio for telemetry (defined in `getBrowserCacheRatio.inline.ts`) */
+  getBrowserCacheRatio?: () => {
+    ratio: number;
+    hit: number;
+    total: number;
+  };
+  /** Set up a Cloudpack app in side-loading scenarios (defined in `bootstrap.inline.ts`) */
+  bootstrap?: (input: BootstrapInput) => void;
+
+  /** Whether the bootstrap script has run (defined in `bootstrap.inline.ts`). */
+  hasBootstrapRun?: boolean;
 
-      /** Whether the bootstrap script has run (defined in `bootstrap.inline.ts`). */
-      hasBootstrapRun?: boolean;
+  /** Client-side context object for a Cloudpack session (defined by the app server while rendering HTML routes) */
+  pageSessionContext?: PageSessionContext;
+}
 
-      /** Client-side context object for a Cloudpack session (defined by the app server while rendering HTML routes) */
-      pageSessionContext?: PageSessionContext;
-    };
-    /** Track uncaught errors (defined in `errorHandler.inline.ts` and read by the overlay) */
-    __pageErrors: {
-      uncaughtErrors: ErrorEvent[];
-      uncaughtRejections: PromiseRejectionEvent[];
-      unregister: () => void;
-    };
-  }
+/** Types for Cloudpack `window.__pageErrors` */
+export interface PageErrorsGlobal {
+  uncaughtErrors: ErrorEvent[];
+  uncaughtRejections: PromiseRejectionEvent[];
+  unregister: () => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/common-types-browser",
-  "version": "0.5.6",
+  "version": "0.6.1",
   "description": "Types for Cloudpack browser globals.",
   "license": "MIT",
   "types": "index.d.ts",
@@ -9,6 +9,10 @@
       "types": "./index.d.ts",
       "default": null
     },
+    "./global": {
+      "types": "./global.d.ts",
+      "default": null
+    },
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -21,6 +25,6 @@
     "@ms-cloudpack/scripts": "^0.0.1"
   },
   "files": [
-    "index.d.ts"
+    "*.d.ts"
   ]
 }