@1password/sdk 0.1.0-beta.11 → 0.1.0-beta.13

package/README.md

@@ -16,12 +16,8 @@
 
 The 1Password JavaScript SDK offers programmatic access to your secrets in 1Password with JavaScript. The SDK currently supports `Node.js`. During the beta, you can create, retrieve, update, and delete items and resolve secret references.
 
-## 🔑 Authentication
-
 1Password SDKs support authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/). 
 
-Before you get started, [create a service account](https://developer.1password.com/docs/service-accounts/get-started/#create-a-service-account) and give it the appropriate permissions in the vaults where the items you want to use with the SDK are saved.
-
 ## ❗ Limitations
 
 1Password SDKs don't yet support using secret references with query parameters, so you can't retrieve file attachments or SSH keys, or get more information about field metadata.
@@ -34,7 +30,8 @@ When managing items with 1Password SDKs, you must use [unique identifiers (IDs)]
 
 To use the 1Password JavaScript SDK in your project:
 
-1. Provision your [service account](#authentication) token. We recommend provisioning your token from the environment. For example, to export your token to the `OP_SERVICE_ACCOUNT_TOKEN` environment variable:
+1. [Create a service account](https://my.1password.com/developer-tools/infrastructure-secrets/serviceaccount/) 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:
 
    **macOS or Linux**
 
@@ -48,7 +45,7 @@ To use the 1Password JavaScript SDK in your project:
    $Env:OP_SERVICE_ACCOUNT_TOKEN = "<your-service-account-token>"
    ```
 
-2. Install the 1Password JavaScript SDK in your project:
+3. Install the 1Password JavaScript SDK in your project:
 
    ```bash
    ## NPM
@@ -65,7 +62,7 @@ To use the 1Password JavaScript SDK in your project:
    yarn add @1password/sdk@beta
    ```
 
-3. Use the JavaScript SDK in your project:
+4. Use the JavaScript SDK in your project:
 
 ```js
 import { createClient } from "@1password/sdk";
@@ -73,6 +70,7 @@ 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",
 });

package/dist/configuration.d.ts

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

package/dist/configuration.js

@@ -1,32 +1,13 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOsName = exports.clientAuthConfig = void 0;
-const os = __importStar(require("os"));
-const LANGUAGE = "JS";
-const VERSION = "0010011"; // v0.1.0-beta.11
+exports.getOsName = exports.clientAuthConfig = exports.VERSION = exports.LANGUAGE = void 0;
+const os_1 = __importDefault(require("os"));
+const version_js_1 = require("../release/version.js");
+exports.LANGUAGE = "JS";
+exports.VERSION = version_js_1.SDK_BUILD_NUMBER;
 /**
  * Creates a default client configuration.
  * @returns The client configuration to instantiate the client with.
@@ -36,21 +17,21 @@ const clientAuthConfig = (userConfig) => {
     const defaultOsVersion = "0.0.0";
     return {
         serviceAccountToken: userConfig.auth,
-        programmingLanguage: LANGUAGE,
-        sdkVersion: VERSION,
+        programmingLanguage: exports.LANGUAGE,
+        sdkVersion: exports.VERSION,
         integrationName: userConfig.integrationName,
         integrationVersion: userConfig.integrationVersion,
         requestLibraryName: "Fetch API",
         requestLibraryVersion: "Fetch API",
         os: (0, exports.getOsName)(),
         osVersion: defaultOsVersion,
-        architecture: os.arch(),
+        architecture: os_1.default.arch(),
     };
 };
 exports.clientAuthConfig = clientAuthConfig;
 const getOsName = () => {
     // Only supported on Node.js
-    const os_name = os.type().toLowerCase();
+    const os_name = os_1.default.type().toLowerCase();
     if (os_name === "windows_nt") {
         return "windows";
     }

package/dist/items.d.ts

@@ -1,18 +1,21 @@
 import { InnerClient } from "./core.js";
 import * as types from "./types.js";
+/**
+ *  The Items API holds all operations the SDK client can perform on 1Password items.
+ */
 export interface ItemsApi {
     /**
      *  Create a new item
      */
-    create(item: types.Item): Promise<types.Item>;
+    create(params: types.ItemCreateParams): Promise<types.Item>;
     /**
      *  Get an item by vault and item ID
      */
     get(vaultId: string, itemId: string): Promise<types.Item>;
     /**
-     *  Update an existing item. You can currently only edit text and concealed fields.
+     *  Update an existing item.
      */
-    update(item: types.Item): Promise<types.Item>;
+    put(item: types.Item): Promise<types.Item>;
     /**
      *  Delete an item.
      */
@@ -21,8 +24,20 @@ export interface ItemsApi {
 export declare class ItemsSource implements ItemsApi {
     #private;
     constructor(inner: InnerClient);
-    create(item: types.Item): Promise<types.Item>;
+    /**
+     *  Create a new item
+     */
+    create(params: types.ItemCreateParams): Promise<types.Item>;
+    /**
+     *  Get an item by vault and item ID
+     */
     get(vaultId: string, itemId: string): Promise<types.Item>;
-    update(item: types.Item): Promise<types.Item>;
+    /**
+     *  Update an existing item.
+     */
+    put(item: types.Item): Promise<types.Item>;
+    /**
+     *  Delete an item.
+     */
     delete(vaultId: string, itemId: string): Promise<void>;
 }

package/dist/items.js

@@ -27,20 +27,26 @@ class ItemsSource {
         _ItemsSource_inner.set(this, void 0);
         __classPrivateFieldSet(this, _ItemsSource_inner, inner, "f");
     }
-    create(item) {
+    /**
+     *  Create a new item
+     */
+    create(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {
                 clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
                 invocation: {
                     name: "Create",
                     parameters: {
-                        item,
+                        params,
                     },
                 },
             };
             return JSON.parse(yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig));
         });
     }
+    /**
+     *  Get an item by vault and item ID
+     */
     get(vaultId, itemId) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {
@@ -56,12 +62,15 @@ class ItemsSource {
             return JSON.parse(yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig));
         });
     }
-    update(item) {
+    /**
+     *  Update an existing item.
+     */
+    put(item) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {
                 clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
                 invocation: {
-                    name: "Update",
+                    name: "Put",
                     parameters: {
                         item,
                     },
@@ -70,6 +79,9 @@ class ItemsSource {
             return JSON.parse(yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig));
         });
     }
+    /**
+     *  Delete an item.
+     */
     delete(vaultId, itemId) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {

package/dist/secrets.d.ts

@@ -1,9 +1,19 @@
 import { InnerClient } from "./core.js";
+/**
+ *  The Secrets API includes all operations the SDK client can perform on secrets.
+ *  Use secret reference URIs to securely load secrets from 1Password: op://<vault-name>/<item-name>[/<section-name>]/<field-name>
+ */
 export interface SecretsApi {
+    /**
+     *  Resolve returns the secret the provided secret reference points to.
+     */
     resolve(secretReference: string): Promise<string>;
 }
 export declare class SecretsSource implements SecretsApi {
     #private;
     constructor(inner: InnerClient);
+    /**
+     *  Resolve returns the secret the provided secret reference points to.
+     */
     resolve(secretReference: string): Promise<string>;
 }

package/dist/secrets.js

@@ -27,6 +27,9 @@ class SecretsSource {
         _SecretsSource_inner.set(this, void 0);
         __classPrivateFieldSet(this, _SecretsSource_inner, inner, "f");
     }
+    /**
+     *  Resolve returns the secret the provided secret reference points to.
+     */
     resolve(secretReference) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {

package/dist/types.d.ts

@@ -27,72 +27,67 @@ export declare enum ItemCategory {
 export declare enum ItemFieldType {
     Text = "Text",
     Concealed = "Concealed",
+    CreditCardType = "CreditCardType",
+    Phone = "Phone",
+    Url = "Url",
+    Totp = "Totp",
     Unsupported = "Unsupported"
 }
-/**
- *  Stores a field's title and value.
- */
+/** Field type-specific attributes. */
+export type ItemFieldDetails = 
+/** The computed OTP code and other details */
+{
+    type: "Otp";
+    content: OtpFieldDetails;
+};
+/** Represents a field within an item. */
 export interface ItemField {
-    /**
-     *  The field's ID
-     */
+    /** The field's ID */
     id: string;
-    /**
-     *  The field's title
-     */
+    /** The field's title */
     title: string;
-    /**
-     *  The ID of the section containing the field
-     */
+    /** The ID of the section containing the field. Built-in fields such as usernames and passwords don't require a section. */
     section_id?: string;
-    /**
-     *  The type of value stored in the field
-     */
+    /** The field's type */
     field_type: ItemFieldType;
-    /**
-     *  The string representation of the field's value
-     */
+    /** The string representation of the field's value */
     value: string;
+    /** Field type-specific attributes. */
+    details?: ItemFieldDetails;
 }
-/**
- *  A section groups together multiple fields in an item.
- */
+/** A section groups together multiple fields in an item. */
 export interface ItemSection {
-    /**
-     *  The ID of the section
-     */
+    /** The section's unique ID */
     id: string;
-    /**
-     *  The title of the section
-     */
+    /** The section's title */
     title: string;
 }
-/**
- *  Represents a 1Password item.
- */
+/** Represents a 1Password item. */
 export interface Item {
-    /**
-     *  The item's unique ID
-     */
+    /** The item's ID */
     id: string;
-    /**
-     *  The item's title
-     */
+    /** The item's title */
     title: string;
-    /**
-     *  The item's category
-     */
+    /** The item's category */
     category: ItemCategory;
-    /**
-     *  The ID of the vault where the item is saved
-     */
+    /** The ID of the vault where the item is saved */
     vault_id: string;
-    /**
-     *  The item's fields
-     */
+    /** The item's fields */
     fields: ItemField[];
-    /**
-     *  The item's sections
-     */
+    /** The item's sections */
     sections: ItemSection[];
 }
+export interface ItemCreateParams {
+    category: ItemCategory;
+    vault_id: string;
+    title: string;
+    fields: ItemField[];
+    sections: ItemSection[];
+}
+/** Additional attributes for OTP fields. */
+export interface OtpFieldDetails {
+    /** The OTP code, if successfully computed */
+    code?: string;
+    /** The error message, if the OTP code could not be computed */
+    error_message?: string;
+}

package/dist/types.js

@@ -35,5 +35,9 @@ var ItemFieldType;
 (function (ItemFieldType) {
     ItemFieldType["Text"] = "Text";
     ItemFieldType["Concealed"] = "Concealed";
+    ItemFieldType["CreditCardType"] = "CreditCardType";
+    ItemFieldType["Phone"] = "Phone";
+    ItemFieldType["Url"] = "Url";
+    ItemFieldType["Totp"] = "Totp";
     ItemFieldType["Unsupported"] = "Unsupported";
 })(ItemFieldType || (exports.ItemFieldType = ItemFieldType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1password/sdk",
-  "version": "0.1.0-beta.11",
+  "version": "0.1.0-beta.13",
   "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",
@@ -9,12 +9,14 @@
     "prettier-fix": "prettier --write 'src/*.ts'",
     "eslint": "eslint -c .eslintrc.json 'src/*.ts'",
     "prepare": "rm -rf ./dist && npm run build",
-    "publish-test": "cp ../README.md . && npm publish --tag beta --dry-run && rm ./README.md",
-    "publish-beta": "cp ../README.md . && npm publish --tag beta && rm ./README.md"
+    "publish-test": "cp ../README.md . && npm publish --tag \"${RELEASE_CHANNEL:-beta}\" --dry-run && rm ./README.md",
+    "publish-prod": "cp ../README.md . && npm publish --tag \"${RELEASE_CHANNEL:-beta}\" && rm ./README.md"
   },
   "author": "1Password",
   "license": "MIT",
-  "files": ["./dist"],
+  "files": [
+    "./dist"
+  ],
   "exports": {
     ".": {
       "types": "./dist/sdk.d.ts",
@@ -24,22 +26,22 @@
   "main": "./dist/sdk.js",
   "types": "./dist/sdk.d.ts",
   "dependencies": {
-    "@1password/sdk-core": "0.1.0-beta.9"
+    "@1password/sdk-core": "0.1.0-beta.12"
   },
   "devDependencies": {
     "@1password/eslint-config": "^4.0.0",
     "@1password/prettier-config": "^1.1.3",
+    "@babel/preset-env": "^7.23.8",
     "@jest/globals": "^29.7.0",
     "@types/jest": "^29.5.11",
-    "jest": "^29.7.0",
+    "@types/node": "^20.11.0",
+    "babel-jest": "^29.7.0",
     "eslint": "^8.54.0",
-    "prettier-plugin-organize-imports": "^3.2.3",
+    "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.6.2",
     "prettier": "3.1.1",
+    "prettier-plugin-organize-imports": "^3.2.3",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.3.3",
-    "@types/node": "^20.11.0",
-    "@babel/preset-env": "^7.23.8",
-    "babel-jest": "^29.7.0"
+    "typescript": "^5.3.3"
   }
 }