@1password/sdk 0.1.5 → 0.1.7

package/README.md

@@ -84,8 +84,9 @@ Operations:
 - [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)
 - [x] [Delete items](https://developer.1password.com/docs/sdks/manage-items#delete-an-item)
+- [x] Archive items
 - [x] [List items](https://developer.1password.com/docs/sdks/list-vaults-items/)
-- [x] Add & update tags on items
+- [x] Share items
 - [x] Generate PIN, random and memorable passwords
 
 Field types:
@@ -94,15 +95,18 @@ Field types:
 - [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
+- [x] SSH private keys, public keys, fingerprint and key type (partially supported: supported in resolving secret references, not yet supported in item create/get/update)
 - [x] One-time passwords
 - [x] URLs
 - [x] Websites (used to suggest and autofill logins)
 - [x] Phone numbers
 - [x] Credit card types
 - [x] Credit card numbers
-- [ ] File attachments and Document items
+- [x] Emails
+- [x] References to other items
+- [ ] Address
+- [ ] Date / MM/YY
+- [ ] Files attachments and Document items
 
 ### Vault management
 - [ ] Retrieve vaults

package/dist/configuration.d.ts

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

package/dist/core.js

@@ -11,24 +11,40 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SharedCore = void 0;
 const sdk_core_1 = require("@1password/sdk-core");
+const errors_1 = require("./errors");
 /**
  *  An implementation of the `Core` interface that shares resources across all clients.
  */
 class SharedCore {
     invoke_sync(config) {
         const serializedConfig = JSON.stringify(config);
-        return (0, sdk_core_1.invoke_sync)(serializedConfig);
+        try {
+            return (0, sdk_core_1.invoke_sync)(serializedConfig);
+        }
+        catch (e) {
+            (0, errors_1.throwError)(e);
+        }
     }
     initClient(config) {
         return __awaiter(this, void 0, void 0, function* () {
             const serializedConfig = JSON.stringify(config);
-            return (0, sdk_core_1.init_client)(serializedConfig);
+            try {
+                return yield (0, sdk_core_1.init_client)(serializedConfig);
+            }
+            catch (e) {
+                (0, errors_1.throwError)(e);
+            }
         });
     }
     invoke(config) {
         return __awaiter(this, void 0, void 0, function* () {
             const serializedConfig = JSON.stringify(config);
-            return (0, sdk_core_1.invoke)(serializedConfig);
+            try {
+                return yield (0, sdk_core_1.invoke)(serializedConfig);
+            }
+            catch (e) {
+                (0, errors_1.throwError)(e);
+            }
         });
     }
     releaseClient(clientId) {

package/dist/errors.d.ts

@@ -0,0 +1,5 @@
+export declare class RateLimitExceededError extends Error {
+    message: string;
+    constructor(message: string);
+}
+export declare const throwError: (errString: string) => never;

package/dist/errors.js

@@ -0,0 +1,27 @@
+"use strict";
+// Code generated by op-codegen - DO NOT EDIT MANUALLY
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwError = exports.RateLimitExceededError = void 0;
+class RateLimitExceededError extends Error {
+    constructor(message) {
+        super();
+        this.message = message;
+    }
+}
+exports.RateLimitExceededError = RateLimitExceededError;
+const throwError = (errString) => {
+    let err;
+    try {
+        err = JSON.parse(errString);
+    }
+    catch (e) {
+        throw new Error(errString);
+    }
+    switch (err.name) {
+        case "RateLimitExceeded":
+            throw new RateLimitExceededError(err.message);
+        default:
+            throw new Error(err.message);
+    }
+};
+exports.throwError = throwError;

package/dist/items.d.ts

@@ -1,52 +1,63 @@
 import { InnerClient } from "./core.js";
-import * as types from "./types.js";
 import { SdkIterable } from "./iterator.js";
+import { Item, ItemCreateParams, ItemOverview } from "./types.js";
+import { ItemsSharesApi } from "./items_shares.js";
 /**
  * The Items API holds all operations the SDK client can perform on 1Password items.
  */
 export interface ItemsApi {
+    shares: ItemsSharesApi;
     /**
-     * Create a new item
+     * Create a new item.
      */
-    create(params: types.ItemCreateParams): Promise<types.Item>;
+    create(params: ItemCreateParams): Promise<Item>;
     /**
      * Get an item by vault and item ID
      */
-    get(vaultId: string, itemId: string): Promise<types.Item>;
+    get(vaultId: string, itemId: string): Promise<Item>;
     /**
      * Update an existing item.
      */
-    put(item: types.Item): Promise<types.Item>;
+    put(item: Item): Promise<Item>;
     /**
      * Delete an item.
      */
     delete(vaultId: string, itemId: string): any;
+    /**
+     * Archive an item.
+     */
+    archive(vaultId: string, itemId: string): any;
     /**
      * List all items
      */
-    listAll(vaultId: string): Promise<SdkIterable<types.ItemOverview>>;
+    listAll(vaultId: string): Promise<SdkIterable<ItemOverview>>;
 }
 export declare class Items implements ItemsApi {
     #private;
+    shares: ItemsSharesApi;
     constructor(inner: InnerClient);
     /**
-     * Create a new item
+     * Create a new item.
      */
-    create(params: types.ItemCreateParams): Promise<types.Item>;
+    create(params: ItemCreateParams): Promise<Item>;
     /**
      * Get an item by vault and item ID
      */
-    get(vaultId: string, itemId: string): Promise<types.Item>;
+    get(vaultId: string, itemId: string): Promise<Item>;
     /**
      * Update an existing item.
      */
-    put(item: types.Item): Promise<types.Item>;
+    put(item: Item): Promise<Item>;
     /**
      * Delete an item.
      */
     delete(vaultId: string, itemId: string): Promise<void>;
+    /**
+     * Archive an item.
+     */
+    archive(vaultId: string, itemId: string): Promise<void>;
     /**
      * List all items
      */
-    listAll(vaultId: string): Promise<SdkIterable<types.ItemOverview>>;
+    listAll(vaultId: string): Promise<SdkIterable<ItemOverview>>;
 }

package/dist/items.js

@@ -24,13 +24,15 @@ var _Items_inner;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Items = void 0;
 const iterator_js_1 = require("./iterator.js");
+const items_shares_js_1 = require("./items_shares.js");
 class Items {
     constructor(inner) {
         _Items_inner.set(this, void 0);
         __classPrivateFieldSet(this, _Items_inner, inner, "f");
+        this.shares = new items_shares_js_1.ItemsShares(inner);
     }
     /**
-     * Create a new item
+     * Create a new item.
      */
     create(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -107,6 +109,26 @@ class Items {
             yield __classPrivateFieldGet(this, _Items_inner, "f").core.invoke(invocationConfig);
         });
     }
+    /**
+     * Archive an item.
+     */
+    archive(vaultId, itemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsArchive",
+                        parameters: {
+                            vault_id: vaultId,
+                            item_id: itemId,
+                        },
+                    },
+                },
+            };
+            yield __classPrivateFieldGet(this, _Items_inner, "f").core.invoke(invocationConfig);
+        });
+    }
     /**
      * List all items
      */

package/dist/items_shares.d.ts

@@ -0,0 +1,32 @@
+import { InnerClient } from "./core.js";
+import { Item, ItemShareAccountPolicy, ItemShareParams, ValidRecipient } from "./types.js";
+export interface ItemsSharesApi {
+    /**
+     * Get the item sharing policy of your account.
+     */
+    getAccountPolicy(vaultId: string, itemId: string): Promise<ItemShareAccountPolicy>;
+    /**
+     * Validate the recipients of an item sharing link.
+     */
+    validateRecipients(policy: ItemShareAccountPolicy, recipients: string[]): Promise<ValidRecipient[]>;
+    /**
+     * Create a new item sharing link.
+     */
+    create(item: Item, policy: ItemShareAccountPolicy, params: ItemShareParams): Promise<string>;
+}
+export declare class ItemsShares implements ItemsSharesApi {
+    #private;
+    constructor(inner: InnerClient);
+    /**
+     * Get the item sharing policy of your account.
+     */
+    getAccountPolicy(vaultId: string, itemId: string): Promise<ItemShareAccountPolicy>;
+    /**
+     * Validate the recipients of an item sharing link.
+     */
+    validateRecipients(policy: ItemShareAccountPolicy, recipients: string[]): Promise<ValidRecipient[]>;
+    /**
+     * Create a new item sharing link.
+     */
+    create(item: Item, policy: ItemShareAccountPolicy, params: ItemShareParams): Promise<string>;
+}

package/dist/items_shares.js

@@ -0,0 +1,94 @@
+"use strict";
+// Code generated by op-codegen - DO NOT EDIT MANUALLY
+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 _ItemsShares_inner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemsShares = void 0;
+class ItemsShares {
+    constructor(inner) {
+        _ItemsShares_inner.set(this, void 0);
+        __classPrivateFieldSet(this, _ItemsShares_inner, inner, "f");
+    }
+    /**
+     * Get the item sharing policy of your account.
+     */
+    getAccountPolicy(vaultId, itemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _ItemsShares_inner, "f").id,
+                    parameters: {
+                        name: "ItemsSharesGetAccountPolicy",
+                        parameters: {
+                            vault_id: vaultId,
+                            item_id: itemId,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _ItemsShares_inner, "f").core.invoke(invocationConfig));
+        });
+    }
+    /**
+     * Validate the recipients of an item sharing link.
+     */
+    validateRecipients(policy, recipients) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _ItemsShares_inner, "f").id,
+                    parameters: {
+                        name: "ItemsSharesValidateRecipients",
+                        parameters: {
+                            policy,
+                            recipients,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _ItemsShares_inner, "f").core.invoke(invocationConfig));
+        });
+    }
+    /**
+     * Create a new item sharing link.
+     */
+    create(item, policy, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _ItemsShares_inner, "f").id,
+                    parameters: {
+                        name: "ItemsSharesCreate",
+                        parameters: {
+                            item,
+                            policy,
+                            params,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _ItemsShares_inner, "f").core.invoke(invocationConfig));
+        });
+    }
+}
+exports.ItemsShares = ItemsShares;
+_ItemsShares_inner = new WeakMap();

package/dist/sdk.d.ts

@@ -4,6 +4,7 @@ export declare const DEFAULT_INTEGRATION_NAME = "Unknown";
 export declare const DEFAULT_INTEGRATION_VERSION = "Unknown";
 export { Secrets } from "./secrets.js";
 export * from "./client.js";
+export * from "./errors.js";
 export * from "./types.js";
 /**
  * Creates a default 1Password SDK client.

package/dist/sdk.js

@@ -32,6 +32,7 @@ exports.DEFAULT_INTEGRATION_VERSION = "Unknown";
 var secrets_js_1 = require("./secrets.js");
 Object.defineProperty(exports, "Secrets", { enumerable: true, get: function () { return secrets_js_1.Secrets; } });
 __exportStar(require("./client.js"), exports);
+__exportStar(require("./errors.js"), exports);
 __exportStar(require("./types.js"), exports);
 /**
  * Creates a default 1Password SDK client.

package/dist/secrets.d.ts

@@ -1,5 +1,5 @@
 import { InnerClient } from "./core.js";
-import * as types from "./types.js";
+import { GeneratePasswordResponse, PasswordRecipe } from "./types.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>
@@ -21,5 +21,5 @@ export declare class Secrets implements SecretsApi {
      * Validate the secret reference to ensure there are no syntax errors.
      */
     static validateSecretReference(secretReference: string): void;
-    static generatePassword(recipe: types.PasswordRecipe): types.GeneratePasswordResponse;
+    static generatePassword(recipe: PasswordRecipe): GeneratePasswordResponse;
 }

package/dist/types.d.ts

@@ -40,6 +40,8 @@ export declare enum ItemFieldType {
     Phone = "Phone",
     Url = "Url",
     Totp = "Totp",
+    Email = "Email",
+    Reference = "Reference",
     Unsupported = "Unsupported"
 }
 /** Field type-specific attributes. */
@@ -111,6 +113,8 @@ export interface Item {
     fields: ItemField[];
     /** The item's sections */
     sections: ItemSection[];
+    /** The notes of the item */
+    notes: string;
     /** The item's tags */
     tags: string[];
     /** The websites used for autofilling for items of the Login and Password categories. */
@@ -129,6 +133,8 @@ export interface ItemCreateParams {
     fields?: ItemField[];
     /** The item's sections */
     sections?: ItemSection[];
+    /** The item's notes */
+    notes?: string;
     /** The item's tags */
     tags?: string[];
     /** The websites used for autofilling for items of the Login and Password categories. */
@@ -147,6 +153,77 @@ export interface ItemOverview {
     /** The websites used for autofilling for items of the Login and Password categories. */
     websites: Website[];
 }
+/** The valid duration options for sharing an item */
+export declare enum ItemShareDuration {
+    /** The share will expire in one hour */
+    OneHour = "OneHour",
+    /** The share will expire in one day */
+    OneDay = "OneDay",
+    /** The share will expire in seven days */
+    SevenDays = "SevenDays",
+    /** The share will expire in fourteen days */
+    FourteenDays = "FourteenDays",
+    /** The share will expire in thirty days */
+    ThirtyDays = "ThirtyDays"
+}
+/** The allowed types of item sharing, enforced by account policy */
+export declare enum AllowedType {
+    /** Allows creating share links with specific recipients */
+    Authenticated = "Authenticated",
+    /** Allows creating public share links */
+    Public = "Public"
+}
+/** The allowed recipient types of item sharing, enforced by account policy */
+export declare enum AllowedRecipientType {
+    /** Recipients can be specified by email address */
+    Email = "Email",
+    /** Recipients can be specified by domain */
+    Domain = "Domain"
+}
+/**
+ * The account policy for sharing items, set by your account owner/admin
+ * This policy is enforced server-side when sharing items
+ */
+export interface ItemShareAccountPolicy {
+    /** The maximum duration that an item can be shared for */
+    maxExpiry: ItemShareDuration;
+    /** The default duration that an item is shared for */
+    defaultExpiry: ItemShareDuration;
+    /** The maximum number of times an item can be viewed. A null value means unlimited views */
+    maxViews?: number;
+    /** The allowed types of item sharing - either "Authenticated" (share to specific users) or "Public" (share to anyone with a link) */
+    allowedTypes: AllowedType[];
+    /** The allowed recipient types of item sharing - either "Email" or "Domain" */
+    allowedRecipientTypes: AllowedRecipientType[];
+}
+/** The validated recipient of an item share */
+export type ValidRecipient = 
+/** This exact email address */
+{
+    type: "Email";
+    parameters: {
+        email: string;
+    };
+}
+/** Anyone with an email address from the specified domain */
+ | {
+    type: "Domain";
+    parameters: {
+        domain: string;
+    };
+};
+/**
+ * The configuration options for sharing an item
+ * These must respect the account policy on item sharing
+ */
+export interface ItemShareParams {
+    /** Emails or domains of the item share recipients. If not provided, everyone with the share link will have access */
+    recipients?: ValidRecipient[];
+    /** The duration of the share in seconds. If not provided, defaults to the account policy's default expiry */
+    expireAfter?: ItemShareDuration;
+    /** Whether the item can only be viewed once per recipient */
+    oneTimeOnly: boolean;
+}
 /** Additional attributes for OTP fields. */
 export interface OtpFieldDetails {
     /** The OTP code, if successfully computed */

package/dist/types.js

@@ -1,9 +1,9 @@
 "use strict";
 /*
- Generated by typeshare 1.12.0
+ Generated by typeshare 1.13.2
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WordListType = exports.SeparatorType = exports.AutofillBehavior = exports.ItemFieldType = exports.ItemCategory = void 0;
+exports.WordListType = exports.SeparatorType = exports.AllowedRecipientType = exports.AllowedType = exports.ItemShareDuration = exports.AutofillBehavior = exports.ItemFieldType = exports.ItemCategory = void 0;
 var ItemCategory;
 (function (ItemCategory) {
     ItemCategory["Login"] = "Login";
@@ -40,6 +40,8 @@ var ItemFieldType;
     ItemFieldType["Phone"] = "Phone";
     ItemFieldType["Url"] = "Url";
     ItemFieldType["Totp"] = "Totp";
+    ItemFieldType["Email"] = "Email";
+    ItemFieldType["Reference"] = "Reference";
     ItemFieldType["Unsupported"] = "Unsupported";
 })(ItemFieldType || (exports.ItemFieldType = ItemFieldType = {}));
 /**
@@ -57,6 +59,36 @@ var AutofillBehavior;
     /** Never auto-fill on this website */
     AutofillBehavior["Never"] = "Never";
 })(AutofillBehavior || (exports.AutofillBehavior = AutofillBehavior = {}));
+/** The valid duration options for sharing an item */
+var ItemShareDuration;
+(function (ItemShareDuration) {
+    /** The share will expire in one hour */
+    ItemShareDuration["OneHour"] = "OneHour";
+    /** The share will expire in one day */
+    ItemShareDuration["OneDay"] = "OneDay";
+    /** The share will expire in seven days */
+    ItemShareDuration["SevenDays"] = "SevenDays";
+    /** The share will expire in fourteen days */
+    ItemShareDuration["FourteenDays"] = "FourteenDays";
+    /** The share will expire in thirty days */
+    ItemShareDuration["ThirtyDays"] = "ThirtyDays";
+})(ItemShareDuration || (exports.ItemShareDuration = ItemShareDuration = {}));
+/** The allowed types of item sharing, enforced by account policy */
+var AllowedType;
+(function (AllowedType) {
+    /** Allows creating share links with specific recipients */
+    AllowedType["Authenticated"] = "Authenticated";
+    /** Allows creating public share links */
+    AllowedType["Public"] = "Public";
+})(AllowedType || (exports.AllowedType = AllowedType = {}));
+/** The allowed recipient types of item sharing, enforced by account policy */
+var AllowedRecipientType;
+(function (AllowedRecipientType) {
+    /** Recipients can be specified by email address */
+    AllowedRecipientType["Email"] = "Email";
+    /** Recipients can be specified by domain */
+    AllowedRecipientType["Domain"] = "Domain";
+})(AllowedRecipientType || (exports.AllowedRecipientType = AllowedRecipientType = {}));
 var SeparatorType;
 (function (SeparatorType) {
     /**

package/dist/vaults.d.ts

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

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.1.5";
-export declare const SDK_BUILD_NUMBER = "0010501";
+export declare const SDK_VERSION = "0.1.7";
+export declare const SDK_BUILD_NUMBER = "0010701";

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.1.5";
-exports.SDK_BUILD_NUMBER = "0010501";
-const SDK_CORE_VERSION = "0.1.5";
+exports.SDK_VERSION = "0.1.7";
+exports.SDK_BUILD_NUMBER = "0010701";
+const SDK_CORE_VERSION = "0.1.7";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1password/sdk",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "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.1.5"
+    "@1password/sdk-core": "0.1.7"
   },
   "devDependencies": {
     "@1password/eslint-config": "^4.0.0",