https://github.com/1password/extension-messaging

Last synced: about 1 year ago
JSON representation

Host: GitHub
URL: https://github.com/1password/extension-messaging
Owner: 1Password
Created: 2022-02-01T22:24:27.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2023-03-18T18:17:15.000Z (over 3 years ago)
Last Synced: 2024-07-09T08:26:36.776Z (almost 2 years ago)
Language: TypeScript
Homepage:
Size: 13.7 KB
Stars: 6
Watchers: 7
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Cross-Extension Save in 1Password

Using the cross-extension communication provided by [`browser.runtime.sendMessage`](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/sendMessage), you can save data within 1Password.

Below we outline the messages that 1Password can accept and the response you can expect. Included in `demo-extension/` are types that can be integrated into an extension for communication with 1Password and a sample extension for how this works.

To use this API and see this demo in action, contact us.

## Messages

1Password supports the following messages from allowed extensions.

### Hello

This message can be sent by either extension to see if the other extension is installed.

Request:

```
{ "name": "hello" }
```

Response:

```
{ "name": "hello", "data": { "buildNumber": 1 } }
```

### Create Item

Sent from your extension to 1Password which opens the 1Password Save Dialog prepopulated with the provided data. The `created` field in the response indicates if the user chose to save the item.

#### Save Request

To save an item to 1Password, you'll need to build a save request:

A save request needs these values:

Field Type Description

title string The suggested title for the item to be saved.

fields array Each object in the array has these properties:

autocomplete (string): The type of field to fill.

value (string or number[]): The value to be filled in the field expressed as the string value or as an array of numbers representing the UTF-8 code points.

Use the autocomplete field name and values defined in the "Autofill" section of the HTML Living Standard.

notes

(optional)

string Notes to save with the item. These can be formatted with Markdown.

For example:

```ts
{
title: "Sample Item",
fields: [
{ autocomplete: "username", value: "wendy.appleseed@1password.com" },
{ autocomplete: "current-password", value: "its-a-secret" },
],
notes: "Item saved while testing the integration.",
});
```

_Request:_

Use helper function `createOPItem` in this package and pass in:

- the ID of the extension where you want to send the message
- the supported item template code for the 1Password item you want to save
- your save request

##### Sample Credit Card Request

```ts
createOPItem("dghdojbkjhnklbpkdaibdccddilifddb", "credit-card", {
title: "Virtual Credit Card Item",
fields: [
{
autocomplete: "cc-name",
value: "Wendy Appleseed",
},
{
autocomplete: "cc-type",
value: "visa",
},
{
autocomplete: "cc-number",
value: "4012888888881881",
},
{
autocomplete: "cc-exp",
value: "202401",
},
{
autocomplete: "cc-csc",
value: "714",
},
{
autocomplete: "street-address",
value: "512 Main Street",
},
{
autocomplete: "address-level2",
value: "Cambridge",
},
{
autocomplete: "address-level1",
value: "MA",
},
{
autocomplete: "postal-code",
value: "02114",
},
{
autocomplete: "country",
value: "US",
},
],
notes: "Credit card item saved while testing the integration.",
});
```

_Response:_

```json
{ "name": "create-item", "data": { "saved": true } }
```

##### Sample Crypto Wallet Request

```ts
createOPItem("dghdojbkjhnklbpkdaibdccddilifddb", "crypto-wallet", {
title: "Sample Crypto Wallet",
fields: [
{
autocomplete: "crypto-address",
value: "sample-wallet-address",
},
{
autocomplete: "crypto-recovery-seed",
value: Array.from(new TextEncoder().encode("sample-recovery-phrase ✨")),
},
],
notes: "Credit card item saved while testing the integration.",
});
```

_Response:_

```json
{ "name": "create-item", "data": { "saved": true } }
```

## Request to be added to the list of allowed extensions

The extension-messaging API is only compatible with extensions approved by 1Password. To request that your extension ID be added to the list, to request support for an item type not listed below, or for more information about the API, contact the 1Password Partnerships team at [support+partnerships@1password.com](mailto:support+partnerships@1password.com).

## Appendix: Supported item templates

| Template | Code |
| -------------- | ---------------- |
| API Credential | `api-credential` |
| Credit Card | `credit-card` |
| Crypto Wallet | `crypto-wallet` |
| Login | `login` |
| Password | `password` |

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/1password/extension-messaging

Awesome Lists containing this project

README