@shopify/app-bridge-types 0.0.1

package/README.md

@@ -0,0 +1,15 @@
+# `@shopify/app-bridge-types`
+
+**[Join our team and work on libraries like this one.](https://www.shopify.ca/careers)**
+
+[![License: ISC](https://img.shields.io/badge/License-ISC-green.svg)](LICENSE.md)
+
+This is a companion library with TypeScript types for [Shopify App Bridge](https://shopify.dev/docs/api/app-bridge).
+
+## Installation
+
+You can install Shopify App Bridge Types by using [Yarn](https://yarnpkg.com):
+
+```sh
+yarn add --dev @shopify/app-bridge-types
+```

package/index.d.ts

@@ -0,0 +1,9 @@
+import {ShopifyGlobal} from './internal';
+
+export {ShopifyGlobal};
+
+declare global {
+  interface Window {
+    shopify: ShopifyGlobal;
+  }
+}

package/internal.d.ts

@@ -0,0 +1,72 @@
+declare interface AppBridgeConfig {
+    host: string;
+    apiKey: string;
+    shop: string;
+    locale: string;
+    disabledFeatures?: [string];
+}
+
+declare interface Button {
+    id: string;
+    label: string;
+    disabled?: boolean;
+}
+
+declare interface ButtonGroup {
+    id: string;
+    label: string;
+    disabled?: boolean;
+    buttons: Button[];
+}
+
+declare interface Environment {
+    mobile: boolean;
+    embedded: boolean;
+    pos: boolean;
+}
+
+export declare interface ShopifyGlobal {
+    config: AppBridgeConfig;
+    origin: string;
+    ready: Promise<void>;
+    environment: Environment;
+    loading(isLoading?: boolean): void;
+    idToken(): Promise<string>;
+    user(): Promise<User>;
+    titleBar: {
+        setState(state?: TitleBarState): void;
+    };
+    toast: {
+        show(message: string, opts?: Partial<ToastOptions>): string;
+        hide(id: string): void;
+    };
+}
+
+declare interface TitleBarState {
+    title?: string;
+    buttons?: {
+        primary?: Button;
+        secondary?: (Button | ButtonGroup)[];
+    };
+    breadcrumbs?: Button;
+}
+
+declare interface ToastOptions {
+    duration: number;
+    isError: boolean;
+    action: string;
+    onAction: () => void;
+    onDismiss: () => void;
+}
+
+declare interface User {
+    id: string;
+    name: string;
+    firstName?: string;
+    lastName?: string;
+    email: string;
+    accountAccess: string;
+    accountType: string;
+}
+
+export { }

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@shopify/app-bridge-types",
+  "version": "0.0.1",
+  "description": "Companion types library for the Shopify App Bridge script",
+  "license": "ISC",
+  "main": "./index.js",
+  "module": "./index.mjs",
+  "types": "./index.d.ts",
+  "exports": {
+    "types": "./index.d.ts",
+    "module": "./index.mjs",
+    "import": "./index.mjs",
+    "default": "./index.js"
+  },
+  "scripts": {
+    "build": "cjyes && yarn types",
+    "types": "cp ../../dist/app-bridge.d.ts ./internal.d.ts"
+  },
+  "devDependencies": {
+    "cjyes": "^0.3.1"
+  },
+  "files": [
+    "index.d.ts",
+    "internal.d.ts",
+    "index.mjs",
+    "index.js"
+  ]
+}