MCPcopy Index your code
hub / github.com/1Password/connect-sdk-js

github.com/1Password/connect-sdk-js @v1.4.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.4.2 ↗ · + Follow
196 symbols 400 edges 36 files 55 documented · 28%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

<h1>1Password Connect SDK JS</h1>

Access your 1Password items in your JavaScript/TypeScript applications through your self-hosted 1Password Connect server.

<a href="https://github.com/1Password/connect-sdk-js/raw/v1.4.2/QUICKSTART.md">
    <img alt="Get started" src="https://user-images.githubusercontent.com/45081667/226940040-16d3684b-60f4-4d95-adb2-5757a8f1bc15.png" height="37"/>
</a>

The 1Password Connect SDK JS provides your JavaScript and TypeScript applications access to the 1Password Connect API hosted on your infrastructure and leverages the power of 1Password Secrets Automation.

This library can be used by Node.js applications, tools, and other automations to access and manage items in 1Password vaults.

💾 Installation

You can install the SDK using npm or Yarn.

npm install @1password/connect
yarn add @1password/connect

✨ Get Started

Refer to QUICKSTART.md for code examples on how to start using this library.

🛠️ Development

From the root of the repo you can run the following make commands. You can also run make help to list out all available commands and their descriptions.

make build
make install
make test

💙 Community & Support

🔐 Security

1Password requests you practice responsible disclosure if you discover a vulnerability.

Please file requests by sending an email to bugbounty@agilebits.com.

Extension points exported contracts — how you extend this code

IRequestClient (Interface)
(no doc) [4 implementers]
src/lib/client.ts
Options (Interface)
(no doc)
__test__/mocks/api.mock.ts
OPConfig (Interface)
(no doc)
src/lib/op-connect.ts
ClientConfig (Interface)
(no doc)
src/lib/client.ts
ClientRequestOptions (Interface)
(no doc)
src/lib/client.ts
ItemFieldOptions (Interface)
(no doc)
src/lib/builders.ts

Core symbols most depended-on inside this repo

get
called by 25
src/lib/resources.ts
build
called by 24
src/lib/builders.ts
listVaultsByTitle
called by 23
__test__/mocks/api.mock.ts
listItemsByTitle
called by 21
__test__/mocks/api.mock.ts
setCategory
called by 20
src/lib/builders.ts
sendRequest
called by 16
src/lib/requests.ts
deserialize
called by 15
src/model/models.ts
getItemById
called by 11
__test__/mocks/api.mock.ts

Shape

Method 112
Class 52
Function 16
Interface 10
Enum 6

Languages

TypeScript100%

Modules by API surface

src/lib/resources.ts38 symbols
src/lib/op-connect.ts26 symbols
__test__/mocks/api.mock.ts22 symbols
src/lib/builders.ts17 symbols
src/lib/utils/error.ts11 symbols
src/lib/client.ts10 symbols
src/lib/requests.ts8 symbols
src/model/models.ts5 symbols
src/model/fullItemAllOfFields.ts5 symbols
src/model/fullItem.ts5 symbols
src/lib/utils/query-builder.ts5 symbols
src/model/vault.ts4 symbols

For agents

$ claude mcp add connect-sdk-js \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page