@1password/sdk 0.5.0-beta.1 → 0.5.1-beta.1

package/README.md

@@ -5,7 +5,7 @@
 </p>
 
 <p align="center">
- <h4 align="center">Build integrations that programmatically access your secrets in 1Password.</h4>
+ <h4 align="center">Build integrations that programmatically interact with 1Password.</h4>
 </p>
 
 <p align="center">
@@ -16,7 +16,62 @@
 
 ## 🚀 Get started
 
-To use the 1Password JavaScript SDK in your project:
+You can choose between two [authentication methods](https://developer.1password.com/docs/sdks/concepts#authentication) for the 1Password JavaScript SDK: local authorization prompts from the [1Password desktop app](#option-1-1password-desktop-app) or automated authentication with a [1Password Service Account](#option-2-1password-service-account).
+
+*This project is licensed under [MIT](./LICENSE). Use of the 1Password APIs and services accessed through these tools is governed by the [1Password API Terms of Service](https://1password.com/legal/api-sdk-terms-of-service).*
+
+### Option 1: 1Password desktop app
+
+[1Password desktop app authentication](https://developer.1password.com/docs/sdks/concepts#1password-desktop-app) is best for local integrations that require minimal setup from end users and sensitive workflows that require human-in-the-loop approval.
+
+1. Install the [1Password desktop app](https://1password.com/downloads/) and sign in to your account in the app.
+2. Select your account or collection at the top of the sidebar, then navigate to **Settings** > **Developer**.
+3. Under Integrate with the 1Password SDKs, select **Integrate with other apps**.
+4. If you want to authenticate with biometrics, navigate to **Settings** > **Security**, then turn on the option to unlock using [Touch ID](https://support.1password.com/touch-id-mac/),  [Windows Hello](https://support.1password.com/windows-hello/), or [system authentication](https://support.1password.com/system-authentication-linux/).
+5. Install the 1Password JavaScript SDK in your project:
+
+   ```bash
+   ## NPM
+   npm install @1password/sdk
+   ```
+
+   ```bash
+   ## PNPM
+   pnpm add @1password/sdk
+   ```
+
+   ```bash
+   ## Yarn
+   yarn add @1password/sdk
+
+6. To use the Javascript SDK in your project, replace `your-account-name` in the code below with the name of your 1Password account as it appears at the top left sidebar of the 1Password desktop app.
+
+```js
+const sdk = require("@1password/sdk");
+
+async function main() {
+  // Creates an authenticated client.
+  const client = await sdk.createClient({
+    auth: new sdk.DesktopAuth("your-account-name"),
+    // Set the following to your own integration name and version.
+    integrationName: "My 1Password Integration",
+    integrationVersion: "v1.0.0",
+  });
+
+  // Fetches a secret.
+  const secret = await client.secrets.resolve("op://vault/item/field");
+}
+
+main()
+```
+
+Inside `createClient()`, set `integrationName` to the name of your application and `integrationVersion` to the version of your application.
+
+Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secret-reference-syntax/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code.
+
+### Option 2: 1Password Service Account
+
+[Service account authentication](https://developer.1password.com/docs/sdks/concepts/#1password-service-account) is best for automated access and limiting your integration to least privilege access.
 
 1. [Create a service account](https://my.1password.com/developer-tools/infrastructure-secrets/serviceaccount/?source=github-sdk) and give it the appropriate permissions in the vaults where the items you want to use with the SDK are saved.
 2. Provision your service account token. We recommend provisioning your token from the environment. For example, to export your token to the `OP_SERVICE_ACCOUNT_TOKEN` environment variable:
@@ -53,18 +108,22 @@ To use the 1Password JavaScript SDK in your project:
 4. Use the JavaScript SDK in your project:
 
 ```js
-import { createClient } from "@1password/sdk";
-
-// Creates an authenticated client.
-const client = await createClient({
-  auth: process.env.OP_SERVICE_ACCOUNT_TOKEN,
-  // Set the following to your own integration name and version.
-  integrationName: "My 1Password Integration",
-  integrationVersion: "v1.0.0",
-});
-
-// Fetches a secret.
-const secret = await client.secrets.resolve("op://vault/item/field");
+const sdk = require("@1password/sdk");
+
+async function main() {
+  // Creates an authenticated client.
+  const client = await sdk.createClient({
+    auth: process.env.OP_SERVICE_ACCOUNT_TOKEN,
+    // Set the following to your own integration name and version.
+    integrationName: "My 1Password Integration",
+    integrationVersion: "v1.0.0",
+  });
+
+  // Fetches a secret.
+  const secret = await client.secrets.resolve("op://vault/item/field");
+}
+
+main()
 ```
 
 Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secret-reference-syntax/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code.
@@ -77,9 +136,10 @@ Inside `createClient()`, set `integrationName` to the name of your application a
 
 ### Item management
 
-Operations:
+**Operations:**
 
 - [x] [Retrieve secrets](https://developer.1password.com/docs/sdks/load-secrets)
+- [Read 1Password Environments (beta)](https://developer.1password.com/docs/sdks/environments)
 - [x] [Retrieve items](https://developer.1password.com/docs/sdks/manage-items#get-an-item)
 - [x] [Create items](https://developer.1password.com/docs/sdks/manage-items#create-an-item)
 - [x] [Update items](https://developer.1password.com/docs/sdks/manage-items#update-an-item)
@@ -89,7 +149,8 @@ Operations:
 - [x] [Share items](https://developer.1password.com/docs/sdks/share-items)
 - [x] [Generate PIN, random and memorable passwords](https://developer.1password.com/docs/sdks/manage-items#generate-a-password)
 
-Field types:
+**Field types:**
+
 - [x] API Keys
 - [x] Passwords
 - [x] Concealed fields
@@ -112,42 +173,57 @@ Field types:
 - [ ] Passkeys
 
 ### Vault management
-- [ ] Retrieve vaults
-- [ ] Create vaults ([#50](https://github.com/1Password/onepassword-sdk-js/issues/50))
-- [ ] Update vaults
-- [ ] Delete vaults
-- [x] [List vaults](https://developer.1password.com/docs/sdks/list-vaults-items/)
+
+- [x] [Retrieve vaults](https://developer.1password.com/docs/sdks/vaults#get-a-vault-overview)
+- [x] [Create vaults](https://developer.1password.com/docs/sdks/vaults#create-a-vault)
+- [x] [Update vaults](https://developer.1password.com/docs/sdks/vaults#update-a-vault)
+- [x] [Delete vaults](https://developer.1password.com/docs/sdks/vaults#delete-a-vault)
+- [x] [List vaults](https://developer.1password.com/docs/sdks/list-vaults-items#list-vaults)
+- [x] [Manage group vault permissions](https://developer.1password.com/docs/sdks/vault-permissions)
+- [ ] Manage user vault permissions
 
 ### User & access management
+
 - [ ] Provision users
 - [ ] Retrieve users
 - [ ] List users
 - [ ] Suspend users
+- [x] [Retrieve groups](https://developer.1password.com/docs/sdks/groups/)
+- [ ] List groups
 - [ ] Create groups
 - [ ] Update group membership
-- [ ] Update vault access & permissions
+
+## Environments management
+
+- [x] [Read 1Password Environments](/docs/sdks/environments) (beta)
 
 ### Compliance & reporting
+
 - [ ] Watchtower insights
 - [ ] Travel mode
 - [ ] Events. For now, use [1Password Events Reporting API](https://developer.1password.com/docs/events-api/) directly.
 
 ### Authentication
 
-- [x] [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/)
-- [x] [Workload identity](#workload-identity-beta) (beta)
-- [ ] User authentication
+- [x] [1Password Service Accounts](https://developer.1password.com/docs/sdks/concepts#1password-service-account)
+- [x] [Workload identity](#workload-identity-public-preview) (public preview)
+- [x] [User authentication](https://developer.1password.com/docs/sdks/concepts#1password-desktop-app)
 - [ ] 1Password Connect. For now, use [1Password/connect-sdk-js](https://github.com/1Password/connect-sdk-js).
 
-### Workload identity (beta)
+### Workload identity (public preview)
 
-> **Private beta.** Currently available for GitHub Actions via 1Password Credential Broker.
+> **Public Preview** This feature is currently in *public preview*. Please see documentation [here](https://www.1password.dev/environments/credential-broker).
 
 Instead of a service account token, you can authenticate a workload by providing an OIDC token fetcher and your workload details. The SDK calls your `oidcFetcher` to obtain a token when it needs one.
 
 ## 📖 Learn more
 
-- [Load secrets with 1Password SDKs](https://developer.1password.com/docs/sdks/load-secrets)
-- [Manage items with 1Password SDKs](https://developer.1password.com/docs/sdks/manage-items)
-- [List vaults and items with 1Password SDKs](https://developer.1password.com/docs/sdks/list-vaults-items)
+- [Load secrets](https://developer.1password.com/docs/sdks/load-secrets)
+- [Manage items](https://developer.1password.com/docs/sdks/manage-items)
+- [Manage files](https://developer.1password.com/docs/sdks/files)
+- [Share items](https://developer.1password.com/docs/sdks/share-items)
+- [List vaults and items](https://developer.1password.com/docs/sdks/list-vaults-items)
+- [Manage vaults](https://developer.1password.com/docs/sdks/vaults)
+- [Manage vault permissions](https://developer.1password.com/docs/sdks/vault-permissions)
+- [Manage groups](https://developer.1password.com/docs/sdks/groups)
 - [1Password SDK concepts](https://developer.1password.com/docs/sdks/concepts)

package/dist/configuration.d.ts

@@ -1,6 +1,6 @@
 import { ClientAuthConfig, WorkloadDetails } from "./core.js";
 export declare const LANGUAGE = "JS";
-export declare const VERSION = "0050001";
+export declare const VERSION = "0050101";
 export interface ClientConfiguration {
     auth?: Auth;
     integrationName: string;

package/dist/errors.d.ts

@@ -6,4 +6,8 @@ export declare class RateLimitExceededError extends Error {
     message: string;
     constructor(message: string);
 }
+export declare class AuthExpiredError extends Error {
+    message: string;
+    constructor(message: string);
+}
 export declare const throwError: (errString: string) => never;

package/dist/errors.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by op-codegen - DO NOT EDIT MANUALLY
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throwError = exports.RateLimitExceededError = exports.DesktopSessionExpiredError = void 0;
+exports.throwError = exports.AuthExpiredError = exports.RateLimitExceededError = exports.DesktopSessionExpiredError = void 0;
 class DesktopSessionExpiredError extends Error {
     constructor(message) {
         super();
@@ -16,6 +16,13 @@ class RateLimitExceededError extends Error {
     }
 }
 exports.RateLimitExceededError = RateLimitExceededError;
+class AuthExpiredError extends Error {
+    constructor(message) {
+        super();
+        this.message = message;
+    }
+}
+exports.AuthExpiredError = AuthExpiredError;
 const throwError = (errString) => {
     let err;
     try {
@@ -29,6 +36,8 @@ const throwError = (errString) => {
             throw new DesktopSessionExpiredError(err.message);
         case "RateLimitExceeded":
             throw new RateLimitExceededError(err.message);
+        case "AuthExpired":
+            throw new AuthExpiredError(err.message);
         default:
             throw new Error(err.message);
     }

package/dist/shared_lib_core.d.ts

@@ -5,6 +5,13 @@ import { Core } from "./core";
 export declare class SharedLibCore implements Core {
     private lib;
     private acccountName;
+    /**
+     * Loads the 1Password desktop app's shared library.
+     *
+     * Throws if the desktop app can't be found or its library can't be loaded, so
+     * `createClient` rejects and the caller can handle it (for example, fall back
+     * to another auth method). It doesn't log the error itself.
+     */
     constructor(accountName: string);
     /**
      * callSharedLibrary - send string to native function, receive string back.

package/dist/shared_lib_core.js

@@ -93,29 +93,30 @@ const find1PasswordLibPath = () => {
  * SharedLibCore: wrapper around the dynamically loaded shared library
  */
 class SharedLibCore {
+    /**
+     * Loads the 1Password desktop app's shared library.
+     *
+     * Throws if the desktop app can't be found or its library can't be loaded, so
+     * `createClient` rejects and the caller can handle it (for example, fall back
+     * to another auth method). It doesn't log the error itself.
+     */
     constructor(accountName) {
         this.lib = null;
-        try {
-            const libPath = find1PasswordLibPath();
-            const moduleStub = { exports: {} };
-            process.dlopen(moduleStub, libPath);
-            // Safely check the structure of the loaded module before casting.
-            if (typeof moduleStub === "object" &&
-                moduleStub !== null &&
-                typeof moduleStub.exports === "object" &&
-                moduleStub.exports !== null &&
-                "sendMessage" in moduleStub.exports &&
-                typeof moduleStub.exports.sendMessage ===
-                    "function") {
-                this.lib = moduleStub.exports;
-            }
-            else {
-                throw new Error("Failed to initialize native library: sendMessage function not found on module.");
-            }
+        const libPath = find1PasswordLibPath();
+        const moduleStub = { exports: {} };
+        process.dlopen(moduleStub, libPath);
+        // Safely check the structure of the loaded module before casting.
+        if (typeof moduleStub === "object" &&
+            moduleStub !== null &&
+            typeof moduleStub.exports === "object" &&
+            moduleStub.exports !== null &&
+            "sendMessage" in moduleStub.exports &&
+            typeof moduleStub.exports.sendMessage ===
+                "function") {
+            this.lib = moduleStub.exports;
         }
-        catch (e) {
-            console.error("A critical error occurred while loading the native addon:", e);
-            this.lib = null;
+        else {
+            throw new Error("Failed to initialize native library: sendMessage function not found on module.");
         }
         this.acccountName = accountName;
     }

package/dist/types.d.ts

@@ -18,7 +18,14 @@ export interface DocumentCreateParams {
     /** The content of the file */
     content: Uint8Array;
 }
-/** Represents an environment variable (name:value pair) and its masked state */
+/**
+ * One environment variable resolved by the credential broker.
+ *
+ * Shared between the Environments API (`GetVariablesResponse`) and the
+ * Credentials API (`CredentialResponse::Environment`, gated on
+ * `brokered-access`), since both surfaces read from the same credential
+ * broker enclave endpoint.
+ */
 export interface EnvironmentVariable {
     /** An environment variable's name */
     name: string;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.5.0-beta.1";
-export declare const SDK_BUILD_NUMBER = "0050001";
+export declare const SDK_VERSION = "0.5.1-beta.1";
+export declare const SDK_BUILD_NUMBER = "0050101";

package/dist/version.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_BUILD_NUMBER = exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.5.0-beta.1";
-exports.SDK_BUILD_NUMBER = "0050001";
-const SDK_CORE_VERSION = "0.5.0-beta.1";
+exports.SDK_VERSION = "0.5.1-beta.1";
+exports.SDK_BUILD_NUMBER = "0050101";
+const SDK_CORE_VERSION = "0.5.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1password/sdk",
-  "version": "0.5.0-beta.1",
+  "version": "0.5.1-beta.1",
   "description": "The 1Password JavaScript SDK offers programmatic read access to your secrets in 1Password in an interface native to JavaScript. The SDK currently supports `Node.JS`",
   "scripts": {
     "build": "tsc",
@@ -26,7 +26,7 @@
   "main": "./dist/sdk.js",
   "types": "./dist/sdk.d.ts",
   "dependencies": {
-    "@1password/sdk-core": "0.5.0-beta.1"
+    "@1password/sdk-core": "0.5.0"
   },
   "devDependencies": {
     "@1password/eslint-config": "^4.0.0",
@@ -43,5 +43,10 @@
     "prettier-plugin-organize-imports": "^3.2.3",
     "ts-jest": "^29.1.1",
     "typescript": "^5.3.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/1Password/onepassword-sdk-js.git",
+    "directory": "client"
   }
 }