@ms-cloudpack/common-types-browser 0.2.0

package/README.md

@@ -0,0 +1,26 @@
+# @ms-cloudpack/common-types-browser
+
+This package provides 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
+
+```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.
+
+## Configure tsconfig.json to have @ms-cloudpack/common-types by default
+
+```json
+{
+  "extends": "@ms-cloudpack/scripts/tsconfig.browser.json",
+  "include": ["./src"],
+  "compilerOptions": {
+    "types": ["@ms-cloudpack/common-types-browser"],
+    "customConditions": ["browser"]
+  }
+}
+```
+
+This will make the types from this package available by default in your browser code.

package/index.d.ts

@@ -0,0 +1,35 @@
+export {}; // Make this a module
+
+export interface PageSessionContext {
+  sessionId: string;
+  apiUrl: string;
+  currentSequence: number;
+  bundleServerUrl: string;
+}
+
+export interface BootstrapInput {
+  inlineScripts: string[];
+  overlayScript: string;
+  importMap: {
+    imports: Record<string, string>;
+    scopes?: Record<string, Record<string, string>>;
+  };
+  pageSessionContext: PageSessionContext;
+  entryScript?: string;
+}
+
+declare global {
+  interface Window {
+    __cloudpack?: {
+      getPageLoadTime?: () => Promise<number>;
+      getBrowserCacheRatio?: () => number;
+      bootstrap?: (input: BootstrapInput) => void;
+      pageSessionContext?: PageSessionContext;
+    };
+    __pageErrors: {
+      uncaughtErrors: ErrorEvent[];
+      uncaughtRejections: PromiseRejectionEvent[];
+      unregister: () => void;
+    };
+  }
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@ms-cloudpack/common-types-browser",
+  "version": "0.2.0",
+  "description": "The Cloudpack overlay ux.",
+  "license": "MIT",
+  "main": "",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "api": "cloudpack-scripts api",
+    "lint:update": "cloudpack-scripts lint-update",
+    "lint": "cloudpack-scripts lint"
+  },
+  "devDependencies": {
+    "@ms-cloudpack/eslint-plugin-internal": "^0.0.1",
+    "@ms-cloudpack/scripts": "^0.0.1"
+  },
+  "files": [
+    "index.d.ts"
+  ]
+}