@1password/sdk 0.0.0-credential-broker-dev-preview

package/dist/environments.js

@@ -0,0 +1,132 @@
+"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 _Environments_inner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Environments = void 0;
+const types_js_1 = require("./types.js");
+class Environments {
+    constructor(inner) {
+        _Environments_inner.set(this, void 0);
+        __classPrivateFieldSet(this, _Environments_inner, inner, "f");
+    }
+    /**
+     * Get environment variables belonging to an Environment.
+     */
+    getVariables(environmentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Environments_inner, "f").id,
+                    parameters: {
+                        name: "EnvironmentsGetVariables",
+                        parameters: {
+                            environment_id: environmentId,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Environments_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Get a single secret from an Environment.
+     *
+     * `environment_name_id` accepts either the Environment's name or its
+     * ID; a name that matches more than one Environment is an error.
+     *
+     * `secret_name` is the name of the secret to get, matched
+     * case-insensitively; a name that matches more than one secret in the
+     * Environment is an error.
+     *
+     * `reveal` controls whether a concealed secret's value is returned;
+     * when `reveal` is `false`, a concealed value is withheld.
+     */
+    getSecret(environmentNameId, secretName, reveal) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Environments_inner, "f").id,
+                    parameters: {
+                        name: "EnvironmentsGetSecret",
+                        parameters: {
+                            environment_name_id: environmentNameId,
+                            secret_name: secretName,
+                            reveal,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Environments_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * List all secrets in an Environment.
+     *
+     * `environment_name_id` accepts either the Environment's name or its
+     * ID; a name that matches more than one Environment is an error.
+     *
+     * `reveal` controls whether concealed secrets' values are returned;
+     * when `reveal` is `false`, concealed values are withheld.
+     */
+    listSecrets(environmentNameId, reveal) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Environments_inner, "f").id,
+                    parameters: {
+                        name: "EnvironmentsListSecrets",
+                        parameters: {
+                            environment_name_id: environmentNameId,
+                            reveal,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Environments_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Create a new Environment.
+     *
+     * `environment_name` accepts a name for the new Environment. The name is
+     * trimmed. A name that is empty after trimming is an error.
+     */
+    create(environmentName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Environments_inner, "f").id,
+                    parameters: {
+                        name: "EnvironmentsCreate",
+                        parameters: {
+                            environment_name: environmentName,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Environments_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+}
+exports.Environments = Environments;
+_Environments_inner = new WeakMap();

package/dist/errors.d.ts

@@ -0,0 +1,13 @@
+export declare class DesktopSessionExpiredError extends Error {
+    message: string;
+    constructor(message: string);
+}
+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

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

package/dist/groups.d.ts

@@ -0,0 +1,19 @@
+import { InnerClient } from "./core.js";
+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

@@ -0,0 +1,54 @@
+"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 _Groups_inner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Groups = void 0;
+const types_js_1 = require("./types.js");
+class Groups {
+    constructor(inner) {
+        _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 = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Groups_inner, "f").id,
+                    parameters: {
+                        name: "GroupsGet",
+                        parameters: {
+                            group_id: groupId,
+                            group_params: groupParams,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Groups_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+}
+exports.Groups = Groups;
+_Groups_inner = new WeakMap();

package/dist/items.d.ts

@@ -0,0 +1,89 @@
+import { InnerClient } from "./core.js";
+import { Item, ItemCreateParams, ItemListFilter, ItemOverview, ItemsDeleteAllResponse, ItemsGetAllResponse, ItemsUpdateAllResponse } from "./types.js";
+import { ItemsSharesApi } from "./items_shares.js";
+import { ItemsFilesApi } from "./items_files.js";
+/**
+ * The Items API holds all operations the SDK client can perform on 1Password items.
+ */
+export interface ItemsApi {
+    shares: ItemsSharesApi;
+    files: ItemsFilesApi;
+    /**
+     * Create a new item.
+     */
+    create(params: ItemCreateParams): Promise<Item>;
+    /**
+     * Create items in batch, within a single vault.
+     */
+    createAll(vaultId: string, params: ItemCreateParams[]): Promise<ItemsUpdateAllResponse>;
+    /**
+     * Get an item by vault and item ID.
+     */
+    get(vaultId: string, itemId: string): Promise<Item>;
+    /**
+     * Get items by vault and their item IDs.
+     */
+    getAll(vaultId: string, itemIds: string[]): Promise<ItemsGetAllResponse>;
+    /**
+     * Update an existing item.
+     */
+    put(item: Item): Promise<Item>;
+    /**
+     * Delete an item.
+     */
+    delete(vaultId: string, itemId: string): Promise<void>;
+    /**
+     * Delete items in batch, within a single vault.
+     */
+    deleteAll(vaultId: string, itemIds: string[]): Promise<ItemsDeleteAllResponse>;
+    /**
+     * Archive an item.
+     */
+    archive(vaultId: string, itemId: string): Promise<void>;
+    /**
+     * List items based on filters.
+     */
+    list(vaultId: string, ...filters: ItemListFilter[]): Promise<ItemOverview[]>;
+}
+export declare class Items implements ItemsApi {
+    #private;
+    shares: ItemsSharesApi;
+    files: ItemsFilesApi;
+    constructor(inner: InnerClient);
+    /**
+     * Create a new item.
+     */
+    create(params: ItemCreateParams): Promise<Item>;
+    /**
+     * Create items in batch, within a single vault.
+     */
+    createAll(vaultId: string, params: ItemCreateParams[]): Promise<ItemsUpdateAllResponse>;
+    /**
+     * Get an item by vault and item ID.
+     */
+    get(vaultId: string, itemId: string): Promise<Item>;
+    /**
+     * Get items by vault and their item IDs.
+     */
+    getAll(vaultId: string, itemIds: string[]): Promise<ItemsGetAllResponse>;
+    /**
+     * Update an existing item.
+     */
+    put(item: Item): Promise<Item>;
+    /**
+     * Delete an item.
+     */
+    delete(vaultId: string, itemId: string): Promise<void>;
+    /**
+     * Delete items in batch, within a single vault.
+     */
+    deleteAll(vaultId: string, itemIds: string[]): Promise<ItemsDeleteAllResponse>;
+    /**
+     * Archive an item.
+     */
+    archive(vaultId: string, itemId: string): Promise<void>;
+    /**
+     * List items based on filters.
+     */
+    list(vaultId: string, ...filters: ItemListFilter[]): Promise<ItemOverview[]>;
+}

package/dist/items.js

@@ -0,0 +1,216 @@
+"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 _Items_inner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Items = void 0;
+const types_js_1 = require("./types.js");
+const items_shares_js_1 = require("./items_shares.js");
+const items_files_js_1 = require("./items_files.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);
+        this.files = new items_files_js_1.ItemsFiles(inner);
+    }
+    /**
+     * Create a new item.
+     */
+    create(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsCreate",
+                        parameters: {
+                            params,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Create items in batch, within a single vault.
+     */
+    createAll(vaultId, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsCreateAll",
+                        parameters: {
+                            vault_id: vaultId,
+                            params,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Get an item by vault and item ID.
+     */
+    get(vaultId, itemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsGet",
+                        parameters: {
+                            vault_id: vaultId,
+                            item_id: itemId,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Get items by vault and their item IDs.
+     */
+    getAll(vaultId, itemIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsGetAll",
+                        parameters: {
+                            vault_id: vaultId,
+                            item_ids: itemIds,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Update an existing item.
+     */
+    put(item) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsPut",
+                        parameters: {
+                            item,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * Delete an item.
+     */
+    delete(vaultId, itemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsDelete",
+                        parameters: {
+                            vault_id: vaultId,
+                            item_id: itemId,
+                        },
+                    },
+                },
+            };
+            yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig);
+        });
+    }
+    /**
+     * Delete items in batch, within a single vault.
+     */
+    deleteAll(vaultId, itemIds) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsDeleteAll",
+                        parameters: {
+                            vault_id: vaultId,
+                            item_ids: itemIds,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+    /**
+     * 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").invoke(invocationConfig);
+        });
+    }
+    /**
+     * List items based on filters.
+     */
+    list(vaultId, ...filters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                invocation: {
+                    clientId: __classPrivateFieldGet(this, _Items_inner, "f").id,
+                    parameters: {
+                        name: "ItemsList",
+                        parameters: {
+                            vault_id: vaultId,
+                            filters,
+                        },
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _Items_inner, "f").invoke(invocationConfig), types_js_1.ReviverFunc);
+        });
+    }
+}
+exports.Items = Items;
+_Items_inner = new WeakMap();

package/dist/items_files.d.ts

@@ -0,0 +1,40 @@
+import { InnerClient } from "./core.js";
+import { DocumentCreateParams, FileAttributes, FileCreateParams, Item } from "./types.js";
+export interface ItemsFilesApi {
+    /**
+     * Attach files to Items.
+     */
+    attach(item: Item, fileParams: FileCreateParams): Promise<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(item: Item, sectionId: string, fieldId: string): Promise<Item>;
+    /**
+     * Replace the document file within a document item.
+     */
+    replaceDocument(item: Item, docParams: DocumentCreateParams): Promise<Item>;
+}
+export declare class ItemsFiles implements ItemsFilesApi {
+    #private;
+    constructor(inner: InnerClient);
+    /**
+     * Attach files to Items.
+     */
+    attach(item: Item, fileParams: FileCreateParams): Promise<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(item: Item, sectionId: string, fieldId: string): Promise<Item>;
+    /**
+     * Replace the document file within a document item.
+     */
+    replaceDocument(item: Item, docParams: DocumentCreateParams): Promise<Item>;
+}