penpal 6.2.0

package/lib/parent/monitorIframeRemoval.js

@@ -0,0 +1,22 @@
+const CHECK_IFRAME_IN_DOC_INTERVAL = 60000;
+/**
+ * Monitors for iframe removal and destroys connection if iframe
+ * is found to have been removed from DOM. This is to prevent memory
+ * leaks when the iframe is removed from the document and the consumer
+ * hasn't called destroy(). Without this, event listeners attached to
+ * the window would stick around and since the event handlers have a
+ * reference to the iframe in their closures, the iframe would stick
+ * around too.
+ */
+export default (iframe, destructor) => {
+    const { destroy, onDestroy } = destructor;
+    const checkIframeInDocIntervalId = setInterval(() => {
+        if (!iframe.isConnected) {
+            clearInterval(checkIframeInDocIntervalId);
+            destroy();
+        }
+    }, CHECK_IFRAME_IN_DOC_INTERVAL);
+    onDestroy(() => {
+        clearInterval(checkIframeInDocIntervalId);
+    });
+};

package/lib/parent/validateIframeHasSrcOrSrcDoc.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (iframe: HTMLIFrameElement) => void;
+export default _default;

package/lib/parent/validateIframeHasSrcOrSrcDoc.js

@@ -0,0 +1,8 @@
+import { ErrorCode } from '../enums';
+export default (iframe) => {
+    if (!iframe.src && !iframe.srcdoc) {
+        const error = new Error('Iframe must have src or srcdoc property defined.');
+        error.code = ErrorCode.NoIframeSrc;
+        throw error;
+    }
+};

package/lib/startConnectionTimeout.d.ts

@@ -0,0 +1,6 @@
+declare const _default: (timeout: number | undefined, callback: Function) => Function;
+/**
+ * Starts a timeout and calls the callback with an error
+ * if the timeout completes before the stop function is called.
+ */
+export default _default;

package/lib/startConnectionTimeout.js

@@ -0,0 +1,18 @@
+import { ErrorCode } from './enums';
+/**
+ * Starts a timeout and calls the callback with an error
+ * if the timeout completes before the stop function is called.
+ */
+export default (timeout, callback) => {
+    let timeoutId;
+    if (timeout !== undefined) {
+        timeoutId = window.setTimeout(() => {
+            const error = new Error(`Connection timed out after ${timeout}ms`);
+            error.code = ErrorCode.ConnectionTimeout;
+            callback(error);
+        }, timeout);
+    }
+    return () => {
+        clearTimeout(timeoutId);
+    };
+};

package/lib/types.d.ts

@@ -0,0 +1,114 @@
+import { ErrorCode, MessageType, Resolution } from './enums';
+/**
+ * An ACK handshake message.
+ */
+export declare type AckMessage = {
+    penpal: MessageType.Ack;
+    methodNames: string[];
+};
+/**
+ * Extract keys of T whose values are are assignable to U.
+ */
+declare type ExtractKeys<T, U> = {
+    [P in keyof T]: T[P] extends U ? P : never;
+}[keyof T];
+/**
+ * A mapped type to recursively convert non async methods into async methods and exclude
+ * any non function properties from T.
+ */
+export declare type AsyncMethodReturns<T> = {
+    [K in ExtractKeys<T, Function | object>]: T[K] extends (...args: any) => PromiseLike<any> ? T[K] : T[K] extends (...args: infer A) => infer R ? (...args: A) => Promise<R> : AsyncMethodReturns<T[K]>;
+};
+/**
+ * A method call message.
+ */
+export declare type CallMessage = {
+    penpal: MessageType.Call;
+    id: number;
+    methodName: string;
+    args: any[];
+};
+/**
+ * Methods that may be called that will invoke methods on the remote window.
+ */
+export declare type CallSender = {
+    [index: string]: Function;
+};
+/**
+ * Connection object returned from calling connectToChild or connectToParent.
+ */
+export declare type Connection<TCallSender extends object = CallSender> = {
+    /**
+     * A promise which will be resolved once a connection has been established.
+     */
+    promise: Promise<AsyncMethodReturns<TCallSender>>;
+    /**
+     * A method that, when called, will disconnect any messaging channels.
+     * You may call this even before a connection has been established.
+     */
+    destroy: Function;
+};
+/**
+ * Methods to expose to the remote window.
+ */
+export declare type Methods = {
+    [index: string]: Methods | Function;
+};
+/**
+ * A map of key path to function. The flatted counterpart of Methods.
+ */
+export declare type SerializedMethods = {
+    [index: string]: Function;
+};
+/**
+ * A Penpal-specific error.
+ */
+export declare type PenpalError = Error & {
+    code: ErrorCode;
+};
+/**
+ * A method response message.
+ */
+export declare type ReplyMessage = {
+    penpal: MessageType.Reply;
+    id: number;
+    resolution: Resolution;
+    returnValue: any;
+    returnValueIsError?: boolean;
+};
+/**
+ * A SYN-ACK handshake message.
+ */
+export declare type SynAckMessage = {
+    penpal: MessageType.SynAck;
+    methodNames: string[];
+};
+/**
+ * A SYN handshake message.
+ */
+export declare type SynMessage = {
+    penpal: MessageType.Syn;
+};
+export declare type WindowsInfo = {
+    /**
+     * A friendly name for the local window.
+     */
+    localName: 'Parent' | 'Child';
+    /**
+     * The local window.
+     */
+    local: Window;
+    /**
+     * The remote window.
+     */
+    remote: Window;
+    /**
+     * Origin that should be used for sending messages to the remote window.
+     */
+    originForSending: string;
+    /**
+     * Origin that should be used for receiving messages from the remote window.
+     */
+    originForReceiving: string;
+};
+export {};

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "penpal",
+  "version": "6.2.0",
+  "description": "A promise-based library for communicating with iframes via postMessage.",
+  "author": "Aaron Hardy <aaron@aaronhardy.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Aaronius/penpal/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Aaronius/penpal.git"
+  },
+  "keywords": [
+    "iframe",
+    "postMessage",
+    "promise"
+  ],
+  "main": "es5/index.js",
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "clean": "rimraf lib es5 dist",
+    "build:lib": "tsc",
+    "build:es5": "babel ./src --out-dir ./es5 --extensions '.ts'",
+    "build:dist": "rollup --config rollup.config.js && terser dist/penpal.js -o dist/penpal.min.js -m --source-map",
+    "build:analysis": "node ./scripts/filesize dist/penpal.min.js",
+    "build": "npm-run-all clean build:lib build:es5 build:dist build:analysis",
+    "lint": "eslint **/*.js",
+    "format": "prettier --write \"**/*.{json,ts,js,md,html,babelrc,eslintrc}\"",
+    "test": "npm-run-all clean runTests",
+    "test:watch": "npm-run-all clean runTests:watch",
+    "test:sauce": "npm-run-all build 'runTests -- --sauce'",
+    "runTests": "node ./scripts/test.js",
+    "runTests:watch": "npm run runTests -- --watch",
+    "prepublishOnly": "npm-run-all format lint test build",
+    "prepare": "husky install"
+  },
+  "lint-staged": {
+    "**/*.js": [
+      "eslint --cache --fix"
+    ],
+    "**/*.{json,ts,js,md,html,babelrc,eslintrc}": [
+      "prettier --write"
+    ]
+  },
+  "browserslist": [
+    "last 2 Chrome version",
+    "last 2 Firefox version",
+    "last 2 Safari version",
+    "last 2 Edge version"
+  ],
+  "files": [
+    "lib",
+    "es5",
+    "dist"
+  ],
+  "devDependencies": {
+    "@babel/cli": "^7.2.3",
+    "@babel/core": "^7.3.4",
+    "@babel/preset-env": "^7.3.4",
+    "@babel/preset-typescript": "^7.8.3",
+    "@metahub/karma-rollup-preprocessor": "^6.0.0",
+    "@rollup/plugin-typescript": "^4.0.0",
+    "connect": "^3.6.6",
+    "eslint": "^7.25.0",
+    "eslint-config-prettier": "^6.10.1",
+    "eslint-plugin-import": "^2.14.0",
+    "filesize": "^6.1.0",
+    "husky": "^6.0.0",
+    "jasmine-core": "^3.8.0",
+    "karma": "^5.0.2",
+    "karma-babel-preprocessor": "^8.0.0-beta.0",
+    "karma-chrome-launcher": "^3.1.0",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-jasmine": "^3.1.1",
+    "karma-sauce-launcher": "^4.1.3",
+    "lint-staged": "^11.0.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "2.0.4",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.6.1",
+    "rollup-plugin-babel": "^4.3.2",
+    "rollup-plugin-typescript": "^1.0.1",
+    "serve-static": "^1.13.2",
+    "terser": "^4.6.11",
+    "typescript": "^3.8.3",
+    "yargs": "^15.3.1"
+  }
+}