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

package/README.md

@@ -14,17 +14,62 @@
 
 ---
 
-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.
-
-1Password SDKs support authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/). 
-
-## ❗ 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.
-
-1Password SDKs currently only support operations on text and concealed fields. As a result, you can't edit items that include information saved in other types of fields.
-
-When managing items with 1Password SDKs, you must use [unique identifiers (IDs)](https://developer.1password.com/docs/sdks/concepts#unique-identifiers) in place of vault, item, and field names.
+## Supported functionality
+
+1Password SDKs are in active development. We're keen to hear what you'd like to see next. Let us know by [upvoting](https://github.com/1Password/onepassword-sdk-js/issues) or [filing](https://github.com/1Password/onepassword-sdk-js/issues/new/choose) an issue.
+
+### Item management
+
+Operations:
+
+- [x] [Retrieve secrets](https://developer.1password.com/docs/sdks/load-secrets)
+- [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#edit-an-item)
+- [x] [Delete items](https://developer.1password.com/docs/sdks/manage-items#delete-an-item)
+- [ ] List items
+- [ ] Add & update tags on items 
+
+Field types:
+- [x] API Keys
+- [x] Passwords
+- [x] Concealed fields
+- [x] Text fields
+- [x] Notes
+- [x] SSH private keys (partially supported: supported in resolving secret references, not yet supported in item create/get/update)
+- [ ] SSH public keys, fingerprint and key type
+- [ ] One-time passwords \
+- [ ] Files attachments and Document items
+- [x] URLs
+- [x] Credit card number & type
+- [x] Phone numbers
+
+### Vault management
+- [ ] Retrieve vaults
+- [ ] Create vaults ([#50](https://github.com/1Password/onepassword-sdk-js/issues/50))
+- [ ] Update vaults
+- [ ] Delete vaults
+- [ ] List vaults
+
+### User & access management
+- [ ] Provision users
+- [ ] Retrieve users
+- [ ] List users
+- [ ] Suspend users
+- [ ] Create groups
+- [ ] Update group membership
+- [ ] Update vault access & permissions
+
+### 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/)
+- [ ] User authentication
+- [ ] 1Password Connect. For now, use [1Password/connect-sdk-go](https://github.com/1Password/connect-sdk-go).
 
 ## 🚀 Get started
 

package/dist/client.d.ts

@@ -1,8 +1,10 @@
 import { InnerClient } from "./core.js";
 import { SecretsApi } from "./secrets.js";
 import { ItemsApi } from "./items.js";
+import { VaultsApi } from "./vaults.js";
 export declare class Client {
     secrets: SecretsApi;
     items: ItemsApi;
+    vaults: VaultsApi;
     constructor(innerClient: InnerClient);
 }

package/dist/client.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
 const secrets_js_1 = require("./secrets.js");
 const items_js_1 = require("./items.js");
+const vaults_js_1 = require("./vaults.js");
 class Client {
     constructor(innerClient) {
         this.secrets = new secrets_js_1.SecretsSource(innerClient);
         this.items = new items_js_1.ItemsSource(innerClient);
+        this.vaults = new vaults_js_1.VaultsSource(innerClient);
     }
 }
 exports.Client = Client;

package/dist/configuration.d.ts

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

package/dist/configuration.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOsName = exports.clientAuthConfig = exports.VERSION = exports.LANGUAGE = void 0;
 const os_1 = __importDefault(require("os"));
-const version_js_1 = require("../release/version.js");
+const version_js_1 = require("./version.js");
 exports.LANGUAGE = "JS";
 exports.VERSION = version_js_1.SDK_BUILD_NUMBER;
 /**

package/dist/items.d.ts

@@ -1,5 +1,6 @@
 import { InnerClient } from "./core.js";
 import * as types from "./types.js";
+import { SdkIterable } from "./iterator.js";
 /**
  *  The Items API holds all operations the SDK client can perform on 1Password items.
  */
@@ -20,6 +21,10 @@ export interface ItemsApi {
      *  Delete an item.
      */
     delete(vaultId: string, itemId: string): Promise<void>;
+    /**
+     *  List all items
+     */
+    listAll(vaultId: string): Promise<SdkIterable<types.ItemOverview>>;
 }
 export declare class ItemsSource implements ItemsApi {
     #private;
@@ -40,4 +45,8 @@ export declare class ItemsSource implements ItemsApi {
      *  Delete an item.
      */
     delete(vaultId: string, itemId: string): Promise<void>;
+    /**
+     *  List all items
+     */
+    listAll(vaultId: string): Promise<SdkIterable<types.ItemOverview>>;
 }

package/dist/items.js

@@ -22,6 +22,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _ItemsSource_inner;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ItemsSource = void 0;
+const iterator_js_1 = require("./iterator.js");
 class ItemsSource {
     constructor(inner) {
         _ItemsSource_inner.set(this, void 0);
@@ -35,7 +36,7 @@ class ItemsSource {
             const invocationConfig = {
                 clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
                 invocation: {
-                    name: "Create",
+                    name: "ItemsCreate",
                     parameters: {
                         params,
                     },
@@ -52,7 +53,7 @@ class ItemsSource {
             const invocationConfig = {
                 clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
                 invocation: {
-                    name: "Get",
+                    name: "ItemsGet",
                     parameters: {
                         vault_id: vaultId,
                         item_id: itemId,
@@ -70,7 +71,7 @@ class ItemsSource {
             const invocationConfig = {
                 clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
                 invocation: {
-                    name: "Put",
+                    name: "ItemsPut",
                     parameters: {
                         item,
                     },
@@ -87,7 +88,7 @@ class ItemsSource {
             const invocationConfig = {
                 clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
                 invocation: {
-                    name: "Delete",
+                    name: "ItemsDelete",
                     parameters: {
                         vault_id: vaultId,
                         item_id: itemId,
@@ -97,6 +98,23 @@ class ItemsSource {
             yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig);
         });
     }
+    /**
+     *  List all items
+     */
+    listAll(vaultId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
+                invocation: {
+                    name: "ItemsListAll",
+                    parameters: {
+                        vault_id: vaultId,
+                    },
+                },
+            };
+            return new iterator_js_1.SdkIterable(JSON.parse(yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig)));
+        });
+    }
 }
 exports.ItemsSource = ItemsSource;
 _ItemsSource_inner = new WeakMap();

package/dist/iterator.d.ts

@@ -0,0 +1,6 @@
+export declare class SdkIterable<T> implements AsyncIterable<T> {
+    private readonly elements;
+    constructor(elements: T[]);
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+    private asyncIterator;
+}

package/dist/iterator.js

@@ -0,0 +1,32 @@
+"use strict";
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdkIterable = void 0;
+class SdkIterable {
+    constructor(elements) {
+        this.elements = elements;
+    }
+    [Symbol.asyncIterator]() {
+        return this.asyncIterator();
+    }
+    asyncIterator() {
+        return __asyncGenerator(this, arguments, function* asyncIterator_1() {
+            for (const element of this.elements) {
+                yield yield __await(yield __await(Promise.resolve(element)));
+            }
+        });
+    }
+}
+exports.SdkIterable = SdkIterable;

package/dist/secrets.js

@@ -35,7 +35,7 @@ class SecretsSource {
             const invocationConfig = {
                 clientId: __classPrivateFieldGet(this, _SecretsSource_inner, "f").id,
                 invocation: {
-                    name: "Resolve",
+                    name: "SecretsResolve",
                     parameters: {
                         secret_reference: secretReference,
                     },

package/dist/types.d.ts

@@ -47,9 +47,9 @@ export interface ItemField {
     /** The field's title */
     title: string;
     /** The ID of the section containing the field. Built-in fields such as usernames and passwords don't require a section. */
-    section_id?: string;
+    sectionId?: string;
     /** The field's type */
-    field_type: ItemFieldType;
+    fieldType: ItemFieldType;
     /** The string representation of the field's value */
     value: string;
     /** Field type-specific attributes. */
@@ -71,23 +71,48 @@ export interface Item {
     /** The item's category */
     category: ItemCategory;
     /** The ID of the vault where the item is saved */
-    vault_id: string;
+    vaultId: string;
     /** The item's fields */
     fields: ItemField[];
     /** The item's sections */
     sections: ItemSection[];
+    /** The item's version */
+    version: number;
 }
 export interface ItemCreateParams {
+    /** The item's category */
     category: ItemCategory;
-    vault_id: string;
+    /** The ID of the vault where the item is saved */
+    vaultId: string;
+    /** The item's title */
     title: string;
+    /** The item's fields */
     fields: ItemField[];
+    /** The item's sections */
     sections: ItemSection[];
 }
+/** Represents a decrypted 1Password item. */
+export interface ItemOverview {
+    /** The item's ID */
+    id: string;
+    /** The item's title */
+    title: string;
+    /** The item's category */
+    category: ItemCategory;
+    /** The ID of the vault where the item is saved */
+    vaultId: string;
+}
 /** 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;
+    errorMessage?: string;
+}
+/** Represents a decrypted 1Password vault. */
+export interface VaultOverview {
+    /** The vault's ID */
+    id: string;
+    /** The vault's title */
+    title: string;
 }

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Generated by typeshare 1.9.2
+ Generated by typeshare 1.10.0-beta.7
 */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ItemFieldType = exports.ItemCategory = void 0;

package/dist/vaults.d.ts

@@ -0,0 +1,20 @@
+import { InnerClient } from "./core.js";
+import * as types from "./types.js";
+import { SdkIterable } from "./iterator.js";
+/**
+ *  The Vaults API holds all the operations the SDK client can perform on 1Password vaults.
+ */
+export interface VaultsApi {
+    /**
+     *  List all vaults
+     */
+    listAll(): Promise<SdkIterable<types.VaultOverview>>;
+}
+export declare class VaultsSource implements VaultsApi {
+    #private;
+    constructor(inner: InnerClient);
+    /**
+     *  List all vaults
+     */
+    listAll(): Promise<SdkIterable<types.VaultOverview>>;
+}

package/dist/vaults.js

@@ -0,0 +1,48 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _VaultsSource_inner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VaultsSource = void 0;
+const iterator_js_1 = require("./iterator.js");
+class VaultsSource {
+    constructor(inner) {
+        _VaultsSource_inner.set(this, void 0);
+        __classPrivateFieldSet(this, _VaultsSource_inner, inner, "f");
+    }
+    /**
+     *  List all vaults
+     */
+    listAll() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                clientId: __classPrivateFieldGet(this, _VaultsSource_inner, "f").id,
+                invocation: {
+                    name: "VaultsListAll",
+                    parameters: {},
+                },
+            };
+            return new iterator_js_1.SdkIterable(JSON.parse(yield __classPrivateFieldGet(this, _VaultsSource_inner, "f").core.invoke(invocationConfig)));
+        });
+    }
+}
+exports.VaultsSource = VaultsSource;
+_VaultsSource_inner = new WeakMap();

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const SDK_VERSION = "0.1.0-beta.15";
+export declare const SDK_BUILD_NUMBER = "0010015";

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1password/sdk",
-  "version": "0.1.0-beta.13",
+  "version": "0.1.0-beta.15",
   "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",