@1password/sdk 0.4.0-beta.2 → 0.4.0

package/README.md

@@ -18,7 +18,7 @@
 
 To use the 1Password JavaScript SDK in your project:
 
-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.
+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:
 
    **macOS or Linux**

package/dist/configuration.d.ts

@@ -1,6 +1,6 @@
 import { ClientAuthConfig } from "./core.js";
 export declare const LANGUAGE = "JS";
-export declare const VERSION = "0040002";
+export declare const VERSION = "0040003";
 export interface ClientConfiguration {
     auth: Auth;
     integrationName: string;
@@ -8,7 +8,7 @@ export interface ClientConfiguration {
 }
 type Auth = string | DesktopAuth;
 /**
- * Setting that specifies that a client should use the desktop app to authenticate.
+ * Setting that specifies a client should use the desktop app to authenticate. Set accountName to your 1Password account name as shown at the top left sidebar of the app, or your account UUID.
  */
 export declare class DesktopAuth {
     accountName: string;

package/dist/configuration.js

@@ -9,7 +9,7 @@ const version_js_1 = require("./version.js");
 exports.LANGUAGE = "JS";
 exports.VERSION = version_js_1.SDK_BUILD_NUMBER;
 /**
- * Setting that specifies that a client should use the desktop app to authenticate.
+ * Setting that specifies a client should use the desktop app to authenticate. Set accountName to your 1Password account name as shown at the top left sidebar of the app, or your account UUID.
  */
 class DesktopAuth {
     constructor(accountName) {

package/dist/groups.d.ts

@@ -4,10 +4,16 @@ import { Group, GroupGetParams } from "./types.js";
  * The Groups API holds all the operations the SDK client can perform on 1Password groups.
  */
 export interface GroupsApi {
+    /**
+     * Get a group by its ID and parameters.
+     */
     get(groupId: string, groupParams: GroupGetParams): Promise<Group>;
 }
 export declare class Groups implements GroupsApi {
     #private;
     constructor(inner: InnerClient);
+    /**
+     * Get a group by its ID and parameters.
+     */
     get(groupId: string, groupParams: GroupGetParams): Promise<Group>;
 }

package/dist/groups.js

@@ -29,6 +29,9 @@ class Groups {
         _Groups_inner.set(this, void 0);
         __classPrivateFieldSet(this, _Groups_inner, inner, "f");
     }
+    /**
+     * Get a group by its ID and parameters.
+     */
     get(groupId, groupParams) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {

package/dist/items.d.ts

@@ -17,7 +17,7 @@ export interface ItemsApi {
      */
     createAll(vaultId: string, params: ItemCreateParams[]): Promise<ItemsUpdateAllResponse>;
     /**
-     * Get an item by vault and item ID
+     * Get an item by vault and item ID.
      */
     get(vaultId: string, itemId: string): Promise<Item>;
     /**
@@ -31,7 +31,7 @@ export interface ItemsApi {
     /**
      * Delete an item.
      */
-    delete(vaultId: string, itemId: string): any;
+    delete(vaultId: string, itemId: string): Promise<void>;
     /**
      * Delete items in batch, within a single vault.
      */
@@ -39,7 +39,7 @@ export interface ItemsApi {
     /**
      * Archive an item.
      */
-    archive(vaultId: string, itemId: string): any;
+    archive(vaultId: string, itemId: string): Promise<void>;
     /**
      * List items based on filters.
      */
@@ -59,7 +59,7 @@ export declare class Items implements ItemsApi {
      */
     createAll(vaultId: string, params: ItemCreateParams[]): Promise<ItemsUpdateAllResponse>;
     /**
-     * Get an item by vault and item ID
+     * Get an item by vault and item ID.
      */
     get(vaultId: string, itemId: string): Promise<Item>;
     /**

package/dist/items.js

@@ -73,7 +73,7 @@ class Items {
         });
     }
     /**
-     * Get an item by vault and item ID
+     * Get an item by vault and item ID.
      */
     get(vaultId, itemId) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/items_files.d.ts

@@ -2,19 +2,19 @@ import { InnerClient } from "./core.js";
 import { DocumentCreateParams, FileAttributes, FileCreateParams, Item } from "./types.js";
 export interface ItemsFilesApi {
     /**
-     * Attach files to Items
+     * Attach files to Items.
      */
     attach(item: Item, fileParams: FileCreateParams): Promise<Item>;
     /**
-     * Read file content from the Item
+     * Read file content from the Item.
      */
     read(vaultId: string, itemId: string, attr: FileAttributes): Promise<Uint8Array>;
     /**
-     * Delete a field file from Item using the section and field IDs
+     * Delete a field file from Item using the section and field IDs.
      */
     delete(item: Item, sectionId: string, fieldId: string): Promise<Item>;
     /**
-     * Replace the document file within a document item
+     * Replace the document file within a document item.
      */
     replaceDocument(item: Item, docParams: DocumentCreateParams): Promise<Item>;
 }
@@ -22,19 +22,19 @@ export declare class ItemsFiles implements ItemsFilesApi {
     #private;
     constructor(inner: InnerClient);
     /**
-     * Attach files to Items
+     * Attach files to Items.
      */
     attach(item: Item, fileParams: FileCreateParams): Promise<Item>;
     /**
-     * Read file content from the Item
+     * Read file content from the Item.
      */
     read(vaultId: string, itemId: string, attr: FileAttributes): Promise<Uint8Array>;
     /**
-     * Delete a field file from Item using the section and field IDs
+     * Delete a field file from Item using the section and field IDs.
      */
     delete(item: Item, sectionId: string, fieldId: string): Promise<Item>;
     /**
-     * Replace the document file within a document item
+     * Replace the document file within a document item.
      */
     replaceDocument(item: Item, docParams: DocumentCreateParams): Promise<Item>;
 }

package/dist/items_files.js

@@ -30,7 +30,7 @@ class ItemsFiles {
         __classPrivateFieldSet(this, _ItemsFiles_inner, inner, "f");
     }
     /**
-     * Attach files to Items
+     * Attach files to Items.
      */
     attach(item, fileParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -50,7 +50,7 @@ class ItemsFiles {
         });
     }
     /**
-     * Read file content from the Item
+     * Read file content from the Item.
      */
     read(vaultId, itemId, attr) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -71,7 +71,7 @@ class ItemsFiles {
         });
     }
     /**
-     * Delete a field file from Item using the section and field IDs
+     * Delete a field file from Item using the section and field IDs.
      */
     delete(item, sectionId, fieldId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -92,7 +92,7 @@ class ItemsFiles {
         });
     }
     /**
-     * Replace the document file within a document item
+     * Replace the document file within a document item.
      */
     replaceDocument(item, docParams) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/sdk.d.ts

@@ -3,10 +3,10 @@ import { Client } from "./client.js";
 export declare const DEFAULT_INTEGRATION_NAME = "Unknown";
 export declare const DEFAULT_INTEGRATION_VERSION = "Unknown";
 export { Secrets } from "./secrets.js";
+export { DesktopAuth } from "./configuration.js";
 export * from "./client.js";
 export * from "./errors.js";
 export * from "./types.js";
-export { DesktopAuth } from "./configuration.js";
 /**
  * Creates a default 1Password SDK client.
  * @returns The authenticated 1Password SDK client.

package/dist/sdk.js

@@ -32,11 +32,11 @@ exports.DEFAULT_INTEGRATION_VERSION = "Unknown";
 // auto-generated static exports
 var secrets_js_1 = require("./secrets.js");
 Object.defineProperty(exports, "Secrets", { enumerable: true, get: function () { return secrets_js_1.Secrets; } });
+var configuration_js_1 = require("./configuration.js");
+Object.defineProperty(exports, "DesktopAuth", { enumerable: true, get: function () { return configuration_js_1.DesktopAuth; } });
 __exportStar(require("./client.js"), exports);
 __exportStar(require("./errors.js"), exports);
 __exportStar(require("./types.js"), exports);
-var configuration_js_1 = require("./configuration.js");
-Object.defineProperty(exports, "DesktopAuth", { enumerable: true, get: function () { return configuration_js_1.DesktopAuth; } });
 /**
  * Creates a default 1Password SDK client.
  * @returns The authenticated 1Password SDK client.

package/dist/secrets.d.ts

@@ -29,5 +29,8 @@ export declare class Secrets implements SecretsApi {
      * Validate the secret reference to ensure there are no syntax errors.
      */
     static validateSecretReference(secretReference: string): void;
+    /**
+     * Generate a password using the provided recipe.
+     */
     static generatePassword(recipe: PasswordRecipe): GeneratePasswordResponse;
 }

package/dist/secrets.js

@@ -85,6 +85,9 @@ class Secrets {
         };
         sharedCore.invoke_sync(invocationConfig);
     }
+    /**
+     * Generate a password using the provided recipe.
+     */
     static generatePassword(recipe) {
         const sharedCore = new core_js_1.SharedCore();
         const invocationConfig = {

package/dist/types.d.ts

@@ -120,7 +120,7 @@ export interface Group {
  */
 export interface GroupAccess {
     /** The group's ID */
-    group_id: string;
+    groupId: string;
     /** The group's set of permissions for the vault */
     permissions: number;
 }
@@ -130,9 +130,9 @@ export interface GroupGetParams {
 /** Represents a group's access to a 1Password vault. */
 export interface GroupVaultAccess {
     /** The vault's ID */
-    vault_id: string;
+    vaultId: string;
     /** The group's ID */
-    group_id: string;
+    groupId: string;
     /** The group's set of permissions for the vault */
     permissions: number;
 }
@@ -610,6 +610,11 @@ export interface Vault {
     /** The access information associated with the vault. */
     access?: VaultAccess[];
 }
+export interface VaultCreateParams {
+    title: string;
+    description?: string;
+    allowAdminsAccess?: boolean;
+}
 /** Represents the possible query parameters used for retrieving extra information about a vault. */
 export interface VaultGetParams {
     /** The vault's accessor params. */
@@ -639,6 +644,10 @@ export interface VaultOverview {
     /** The time the vault was updated at */
     updatedAt: Date;
 }
+export interface VaultUpdateParams {
+    title?: string;
+    description?: string;
+}
 export type ItemListFilter = {
     type: "ByState";
     content: {

package/dist/vaults.d.ts

@@ -1,29 +1,83 @@
 import { InnerClient } from "./core.js";
-import { GroupAccess, GroupVaultAccess, Vault, VaultGetParams, VaultListParams, VaultOverview } from "./types.js";
+import { GroupAccess, GroupVaultAccess, Vault, VaultCreateParams, VaultGetParams, VaultListParams, VaultOverview, VaultUpdateParams } from "./types.js";
 /**
  * The Vaults API holds all the operations the SDK client can perform on 1Password vaults.
  */
 export interface VaultsApi {
+    /**
+     * Create a new user vault.
+     */
+    create(params: VaultCreateParams): Promise<Vault>;
     /**
      * List information about vaults that's configurable based on some input parameters.
      */
-    list(params: VaultListParams | undefined): Promise<VaultOverview[]>;
-    getOverview(vaultUuid: string): Promise<VaultOverview>;
-    get(vaultUuid: string, vaultParams: VaultGetParams): Promise<Vault>;
-    grantGroupPermissions(vaultId: string, groupPermissionsList: GroupAccess[]): any;
-    updateGroupPermissions(groupPermissionsList: GroupVaultAccess[]): any;
-    revokeGroupPermissions(vaultId: string, groupId: string): any;
+    list(params?: VaultListParams): Promise<VaultOverview[]>;
+    /**
+     * Get an overview of a vault by its ID.
+     */
+    getOverview(vaultId: string): Promise<VaultOverview>;
+    /**
+     * Get detailed vault information by vault ID and parameters.
+     */
+    get(vaultId: string, vaultParams: VaultGetParams): Promise<Vault>;
+    /**
+     * Update a vault
+     */
+    update(vaultId: string, params: VaultUpdateParams): Promise<Vault>;
+    /**
+     * Delete a vault by its ID.
+     */
+    delete(vaultId: string): Promise<void>;
+    /**
+     * Grant group permissions to a vault.
+     */
+    grantGroupPermissions(vaultId: string, groupPermissionsList: GroupAccess[]): Promise<void>;
+    /**
+     * Update group permissions for vaults.
+     */
+    updateGroupPermissions(groupPermissionsList: GroupVaultAccess[]): Promise<void>;
+    /**
+     * Revoke group permissions from a vault.
+     */
+    revokeGroupPermissions(vaultId: string, groupId: string): Promise<void>;
 }
 export declare class Vaults implements VaultsApi {
     #private;
     constructor(inner: InnerClient);
+    /**
+     * Create a new user vault.
+     */
+    create(params: VaultCreateParams): Promise<Vault>;
     /**
      * List information about vaults that's configurable based on some input parameters.
      */
-    list(params: VaultListParams | undefined): Promise<VaultOverview[]>;
-    getOverview(vaultUuid: string): Promise<VaultOverview>;
-    get(vaultUuid: string, vaultParams: VaultGetParams): Promise<Vault>;
+    list(params?: VaultListParams): Promise<VaultOverview[]>;
+    /**
+     * Get an overview of a vault by its ID.
+     */
+    getOverview(vaultId: string): Promise<VaultOverview>;
+    /**
+     * Get detailed vault information by vault ID and parameters.
+     */
+    get(vaultId: string, vaultParams: VaultGetParams): Promise<Vault>;
+    /**
+     * Update a vault
+     */
+    update(vaultId: string, params: VaultUpdateParams): Promise<Vault>;
+    /**
+     * Delete a vault by its ID.
+     */
+    delete(vaultId: string): Promise<void>;
+    /**
+     * Grant group permissions to a vault.
+     */
     grantGroupPermissions(vaultId: string, groupPermissionsList: GroupAccess[]): Promise<void>;
+    /**
+     * Update group permissions for vaults.
+     */
     updateGroupPermissions(groupPermissionsList: GroupVaultAccess[]): Promise<void>;
+    /**
+     * Revoke group permissions from a vault.
+     */
     revokeGroupPermissions(vaultId: string, groupId: string): Promise<void>;
 }

package/dist/vaults.js

@@ -29,6 +29,25 @@ class Vaults {
         _Vaults_inner.set(this, void 0);
         __classPrivateFieldSet(this, _Vaults_inner, inner, "f");
     }
+    /**
+     * Create a new user vault.
+     */
+    create(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Vaults_inner, "f").id,
+                    parameters: {
+                        name: "VaultsCreate",
+                        parameters: {
+                            params,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
     /**
      * List information about vaults that's configurable based on some input parameters.
      */
@@ -48,7 +67,10 @@ class Vaults {
             return JSON.parse(yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
         });
     }
-    getOverview(vaultUuid) {
+    /**
+     * Get an overview of a vault by its ID.
+     */
+    getOverview(vaultId) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {
                 invocation: {
@@ -56,7 +78,7 @@ class Vaults {
                     parameters: {
                         name: "VaultsGetOverview",
                         parameters: {
-                            vault_uuid: vaultUuid,
+                            vault_id: vaultId,
                         },
                     },
                 },
@@ -64,7 +86,10 @@ class Vaults {
             return JSON.parse(yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
         });
     }
-    get(vaultUuid, vaultParams) {
+    /**
+     * Get detailed vault information by vault ID and parameters.
+     */
+    get(vaultId, vaultParams) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {
                 invocation: {
@@ -72,7 +97,7 @@ class Vaults {
                     parameters: {
                         name: "VaultsGet",
                         parameters: {
-                            vault_uuid: vaultUuid,
+                            vault_id: vaultId,
                             vault_params: vaultParams,
                         },
                     },
@@ -81,6 +106,48 @@ class Vaults {
             return JSON.parse(yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
         });
     }
+    /**
+     * Update a vault
+     */
+    update(vaultId, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Vaults_inner, "f").id,
+                    parameters: {
+                        name: "VaultsUpdate",
+                        parameters: {
+                            vault_id: vaultId,
+                            params,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Delete a vault by its ID.
+     */
+    delete(vaultId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Vaults_inner, "f").id,
+                    parameters: {
+                        name: "VaultsDelete",
+                        parameters: {
+                            vault_id: vaultId,
+                        },
+                    },
+                },
+            };
+            yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig);
+        });
+    }
+    /**
+     * Grant group permissions to a vault.
+     */
     grantGroupPermissions(vaultId, groupPermissionsList) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {
@@ -98,6 +165,9 @@ class Vaults {
             yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig);
         });
     }
+    /**
+     * Update group permissions for vaults.
+     */
     updateGroupPermissions(groupPermissionsList) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {
@@ -114,6 +184,9 @@ class Vaults {
             yield __classPrivateFieldGet(this, _Vaults_inner, "f").invoke(invocationConfig);
         });
     }
+    /**
+     * Revoke group permissions from a vault.
+     */
     revokeGroupPermissions(vaultId, groupId) {
         return __awaiter(this, void 0, void 0, function* () {
             const invocationConfig = {

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SDK_VERSION = "0.4.0-beta.2";
-export declare const SDK_BUILD_NUMBER = "0040002";
+export declare const SDK_VERSION = "0.4.0";
+export declare const SDK_BUILD_NUMBER = "0040003";

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.4.0-beta.2";
-exports.SDK_BUILD_NUMBER = "0040002";
-const SDK_CORE_VERSION = "0.4.0-beta.2";
+exports.SDK_VERSION = "0.4.0";
+exports.SDK_BUILD_NUMBER = "0040003";
+const SDK_CORE_VERSION = "0.4.0";

package/package.json

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