fix(deps): penpal #319

renovate · 2021-07-09T03:32:06Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
penpal	`^3.0.7` -> `^6.0.0`

Release Notes

Aaronius/penpal

`v6.2.2`

Compare Source

Fixes #85 which is an issue where an error would occur under specific timing scenarios when the child iframe is removed from the DOM at about the same time it sends a SYN message. The error didn't cause operational issues, but would still be an uncaught error.

`v6.2.1`

Compare Source

Added some documentation to the readme regarding TypeScript usage.

`v6.2.0`

Compare Source

Added support for a wildcard as a value for childOrigin. This allows the parent to communicate within any child origin.

Thanks @KutnerUri for the contribution!

`v6.1.0`

Compare Source

The methods object passed to connectToParent or connectToChild can now contain nested objects with function values. See https://github.com/Aaronius/penpal/pull/71 for more information.

`v6.0.1`

Compare Source

`v6.0.0`

Compare Source

With a major release comes breaking changes. Here's what you need to know:

NotInIframe error removed

What

The NotInIframe error, which was thrown if connectToParent was called from outside of an iframe, has been removed. Fixes #61.

Why

Previously, if a call was made to connectToParent from outside of an iframe, Penpal would throw an error with the NotInIframe error code. While this was a nice idea, it didn't play well with Cypress. Cypress by default attempts to "modify obstructive code". In other words, if any JavaScript attempts to perform framebusting, Cypress tries to modify the code since such techniques prevent Cypress from working properly. As it turns out, Penpal's check to see if it was running inside of an iframe was not performing framebusting, but Cypress would see it as obstructive code anyway and attempt to modify it, which would actually break testing with Cypress + Penpal entirely. The workaround wasn't great and, given that Penpal's check wasn't providing a lot of value, I decided it would be in consumers' interest to remove the check.

ConnectionDestroyed error reduced in scope

What

Previously, Penpal would reject the connection promise with an error containing the ConnectionDestroyed error code if the consumer called connection.destroy before a connection was made. Fixes #51.

Why

When a consumer calls destroy, they are intentionally destroying the connection and shouldn't be forced to handle a rejected promise as a consequence. It's not an exceptional use case, so it does not merit a rejection. This change should lower development burden, as described in #51.

The ConnectionDestroyed error is still thrown if a child or parent method is called after a connection has been destroyed.

Exported types

What

This is not a breaking change. The following TypeScript types are now exported as named exports: Connection, AsyncMethodReturns, CallSender, Methods, and PenpalError types. Fixes #67.

Why

TypeScript types could previously (and still can) be imported through a child path as follows:

import { Connection } from 'penpal/lib/types';

but that made them less discoverable and the fact that they could be relied on was only implicit. They are now named exports on the top-level module, so they can now be imported as follows:

import { Connection } from 'penpal';

`v5.3.0`

Compare Source

Exposed connection TypeScript type.
Fixed issue where connection would be automatically closed by Penpal if the iframe was located in a web component's shadow DOM.

Big thanks to @lpellegr for his work on these issues!

`v5.2.1`

Compare Source

Rather than creating copies of the typescript declarations for es5, I switched to leveraging the types field in package.json to point to the typings that were generated when the typescript files were compiled to es6. Besides reducing the need for duplicate declarations, it's also advised by the TypeScript documentation.

`v5.2.0`

Compare Source

Now publishing TypeScript typings alongside ES5-generated code.

`v5.1.1`

Compare Source

Removed add-module-exports babel plugin since it's unnecessary. This shouldn't have any effect on consumers.

`v5.1.0`

Compare Source

Prior to v5.0.0, I had transpiled Penpal code to es5 before packaging for npm. Starting with v5.0.0, I decided to only bundle for es6 with the hope that bundler support for es6 would be strong enough that packaging es5 would be unnecessary and consumers could configure their bundler to transpile penpal back to es5 if necessary. Due to popular demand and because bundlers can be a pain to configure to transpile penpal to es5, I added back transpilation to es5.

The npm package now includes both es6 and es5 code. If the consumer's bundler is capable of bundling es6 code, it should use the es6 code automatically. If it's not capable of bundling es6 code, then Penpal's es5 code will be used automatically instead.

This should not affect the runtime behavior of Penpal in any way.

`v5.0.2`

Compare Source

Fixes typescript generics to be correct for the returned proxy object (https://github.com/Aaronius/penpal/pull/50).

`v5.0.1`

Compare Source

Allows call sender (child or parent) to be more strongly typed via TypeScript. (https://github.com/Aaronius/penpal/issues/47)

`v5.0.0`

Compare Source

With a major release comes breaking changes. Here's what you need to know:

Importing

What

When using a bundler, import connectToChild as follow:

import { connectToChild } from 'penpal';

and import connectToParent as follows:

import { connectToParent } from 'penpal';

If you're importing error codes, import them as follows:

import { ErrorCode } from 'penpal';

// Reference individual error codes as follows:
// ErrorCode.ConnectionDestroyed
// ErrorCode.ConnectionTimeout
// ErrorCode.NotInIframe
// ErrorCode.NoIframeSrc

Why

Penpal no longer ships with ES5. The ES6 code is set up in such a way that your bundler of choice should properly tree shake unused code. Your bundler, when properly configured, should also perform any transpilation necessary for your browser targets.

EDIT July 8, 2020: As of v5.1.0, ES5 is again included in the npm package, alongside ES6. Bundlers should automatically use the appropriate version.

Regex Support for `parentOrigin`

What

When using connectToParent, you can now specify a regular expression for parentOrigin. By providing a regular expression, you can now load the iframe onto multiple, different domains while ensuring that communication is secured to those domains only.

Why

This need has been raised several times in the past and was a fairly common use case. While this was not a breaking change, it did require significant changes to the handshake process as described in https://github.com/Aaronius/penpal/pull/32#issuecomment-613198637 and due to the higher risk of the change I decided to include it with other breaking changes in v5 rather than adding it to v4.

TypeScript

What

Penpal is now built using TypeScript, so if you're using TypeScript, you now get types for free!

When using a bundler, import connectToChild as follow:

import connectToChild from 'penpal/lib/connectToChild';

and import connectToParent as follows:

import connectToParent from 'penpal/lib/connectToParent';

If you're importing error codes, import them as follows:

import {
  ERR_CONNECTION_DESTROYED,
  ERR_CONNECTION_TIMEOUT,
  ERR_NOT_IN_IFRAME,
  ERR_NO_IFRAME_SRC
} from 'penpal/lib/errorCodes';

Why

By only importing the functionality you need, you can keep your builds slimmer.

Iframe Creation

If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

renovate · 2023-03-25T03:08:08Z

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

fix(deps): penpal

37eb981

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): penpal #319

fix(deps): penpal #319

renovate bot commented Jul 9, 2021 •

edited

renovate bot commented Mar 25, 2023 •

edited

fix(deps): penpal #319

Are you sure you want to change the base?

fix(deps): penpal #319

Conversation

renovate bot commented Jul 9, 2021 • edited

Release Notes

NotInIframe error removed

What

Why

ConnectionDestroyed error reduced in scope

What

Why

Exported types

What

Why

Importing

What

Why

Regex Support for parentOrigin

What

Why

TypeScript

What

Why

Browser Support

What

Why

Importing

What

Why

Iframe Creation

What

Why

Debugging

What

Why

Error Codes

What

Why

TypeScript Declarations

What

Why

Support for srcdoc and data URIs.

What

Why

Configuration

renovate bot commented Mar 25, 2023 • edited

Edited/Blocked Notification

renovate bot commented Jul 9, 2021 •

edited

Regex Support for `parentOrigin`

Support for `srcdoc` and data URIs.

renovate bot commented Mar 25, 2023 •

edited