@1password/sdk 0.1.0-beta.1 → 0.1.0-beta.10

package/README.md

@@ -0,0 +1,92 @@
+<p align="center">
+  <a href="https://1password.com">
+      <h1 align="center">1Password JavaScript SDK (beta)</h1>
+  </a>
+</p>
+
+<p align="center">
+ <h4 align="center"> ❗ The 1Password SDK project is in beta. Future iterations may bring backwards-incompatible changes.</h4>
+</p>
+
+<p align="center">
+   <a href="https://developer.1password.com/docs/sdks/">Documentation</a> | <a href="https://github.com/1Password/onepassword-sdk-js/tree/main/examples">Examples</a>
+<br/>
+
+---
+
+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.
+
+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.
+
+## 🚀 Get started
+
+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:
+
+   **macOS or Linux**
+
+   ```bash
+   export OP_SERVICE_ACCOUNT_TOKEN=<your-service-account-token>
+   ```
+
+   **Windows**
+
+   ```powershell
+   $Env:OP_SERVICE_ACCOUNT_TOKEN = "<your-service-account-token>"
+   ```
+
+2. Install the 1Password JavaScript SDK in your project:
+
+   ```bash
+   ## NPM
+   npm install @1password/sdk@beta
+   ```
+
+   ```bash
+   ## PNPM
+   pnpm add @1password/sdk@beta
+   ```
+
+   ```bash
+   ## Yarn
+   yarn add @1password/sdk@beta
+   ```
+
+3. Use the JavaScript SDK in your project:
+
+```js
+import { createClient } from "@1password/sdk";
+
+// Creates an authenticated client.
+const client = await createClient({
+  auth: process.env.OP_SERVICE_ACCOUNT_TOKEN,
+  integrationName: "My 1Password Integration",
+  integrationVersion: "v1.0.0",
+});
+
+// Fetches a secret.
+const secret = await client.secrets.resolve("op://vault/item/field");
+```
+
+Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secrets-reference-syntax/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code.
+
+Inside `createClient()`, set `integrationName` to the name of your application and `integrationVersion` to the version of your application.
+
+## 📖 Learn more
+
+- [Load secrets with 1Password SDKs](https://developer.1password.com/docs/sdks/load-secrets)
+- [Manage items with 1Password SDKs](https://developer.1password.com/docs/sdks/manage-items)
+- [1Password SDK concepts](https://developer.1password.com/docs/sdks/concepts)

package/dist/client.d.ts

@@ -1,12 +1,8 @@
-import { SecretsAPI } from "./secrets.js";
-import { ClientAuthConfig, Core } from "./core.js";
-import { ClientConfiguration, InnerClient } from "./configuration.js";
-export declare const DEFAULT_INTEGRATION_NAME = "Unknown";
-export declare const DEFAULT_INTEGRATION_VERSION = "Unknown";
-export declare function createClient(config: ClientConfiguration): Promise<Client>;
-export declare function createClientWithCore(config: ClientConfiguration, core: Core): Promise<Client>;
+import { InnerClient } from "./core.js";
+import { SecretsApi } from "./secrets.js";
+import { ItemsApi } from "./items.js";
 export declare class Client {
-    secrets: SecretsAPI;
+    secrets: SecretsApi;
+    items: ItemsApi;
     constructor(innerClient: InnerClient);
 }
-export declare function createClientAuthConfig(userConfig: ClientConfiguration): ClientAuthConfig;

package/dist/client.js

@@ -1,90 +1,12 @@
 "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 __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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createClientAuthConfig = exports.Client = exports.createClientWithCore = exports.createClient = exports.DEFAULT_INTEGRATION_VERSION = exports.DEFAULT_INTEGRATION_NAME = void 0;
+exports.Client = void 0;
 const secrets_js_1 = require("./secrets.js");
-const core_js_1 = require("./core.js");
-const os = __importStar(require("os"));
-exports.DEFAULT_INTEGRATION_NAME = "Unknown";
-exports.DEFAULT_INTEGRATION_VERSION = "Unknown";
-const LANGUAGE = "JS";
-const VERSION = "0010001"; // v0.1.0
-const finalizationRegistry = new FinalizationRegistry((heldClientId) => {
-    const sharedCore = new core_js_1.SharedCore();
-    sharedCore.releaseClient(heldClientId);
-});
-function createClient(config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return createClientWithCore(config, new core_js_1.SharedCore());
-    });
-}
-exports.createClient = createClient;
-function createClientWithCore(config, core) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const authConfig = createClientAuthConfig(config);
-        const clientID = yield core.initClient(authConfig);
-        const inner = {
-            id: parseInt(clientID),
-            core: core,
-        };
-        const client = new Client(inner);
-        // Cleans up associated memory from core when client instance goes out of scope.
-        finalizationRegistry.register(client, inner.id);
-        return client;
-    });
-}
-exports.createClientWithCore = createClientWithCore;
-// Client represents a client instance of the SDK.
+const items_js_1 = require("./items.js");
 class Client {
     constructor(innerClient) {
         this.secrets = new secrets_js_1.SecretsSource(innerClient);
+        this.items = new items_js_1.ItemsSource(innerClient);
     }
 }
 exports.Client = Client;
-function createClientAuthConfig(userConfig) {
-    return {
-        serviceAccountToken: userConfig.auth,
-        programmingLanguage: LANGUAGE,
-        sdkVersion: VERSION,
-        integrationName: userConfig.integrationName,
-        integrationVersion: userConfig.integrationVersion,
-        requestLibraryName: "Fetch API",
-        requestLibraryVersion: "Fetch API",
-        // Only supported on Node.js
-        os: os.type(),
-        osVersion: os.version(),
-        architecture: os.arch(),
-    };
-}
-exports.createClientAuthConfig = createClientAuthConfig;

package/dist/client_builder.d.ts

@@ -0,0 +1,8 @@
+import { Core } from "./core.js";
+import { ClientConfiguration } from "./configuration.js";
+import { Client } from "./client.js";
+/**
+ * Creates a 1Password SDK client with a given core implementation.
+ * @returns The authenticated 1Password SDK client.
+ */
+export declare const createClientWithCore: (config: ClientConfiguration, core: Core) => Promise<Client>;

package/dist/client_builder.js

@@ -0,0 +1,34 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClientWithCore = void 0;
+const configuration_js_1 = require("./configuration.js");
+const client_js_1 = require("./client.js");
+const finalizationRegistry = new FinalizationRegistry((heldClient) => {
+    heldClient.core.releaseClient(heldClient.id);
+});
+/**
+ * Creates a 1Password SDK client with a given core implementation.
+ * @returns The authenticated 1Password SDK client.
+ */
+const createClientWithCore = (config, core) => __awaiter(void 0, void 0, void 0, function* () {
+    const authConfig = (0, configuration_js_1.clientAuthConfig)(config);
+    const clientId = yield core.initClient(authConfig);
+    const inner = {
+        id: parseInt(clientId, 10),
+        core,
+    };
+    const client = new client_js_1.Client(inner);
+    // Cleans up associated memory from core when client instance goes out of scope.
+    finalizationRegistry.register(client, inner);
+    return client;
+});
+exports.createClientWithCore = createClientWithCore;

package/dist/configuration.d.ts

@@ -1,12 +1,14 @@
-import { Core } from "./core.js";
-export interface InnerClient {
-    id: number;
-    core: Core;
-}
+import { ClientAuthConfig } from "./core.js";
 export interface ClientConfiguration {
     auth: Auth;
     integrationName: string;
     integrationVersion: string;
 }
 type Auth = string;
+/**
+ * Creates a default client configuration.
+ * @returns The client configuration to instantiate the client with.
+ */
+export declare const clientAuthConfig: (userConfig: ClientConfiguration) => ClientAuthConfig;
+export declare const getOsName: () => string;
 export {};

package/dist/configuration.js

@@ -1,2 +1,59 @@
 "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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOsName = exports.clientAuthConfig = void 0;
+const os = __importStar(require("os"));
+const LANGUAGE = "JS";
+const VERSION = "0010009"; // v0.1.0-beta.9
+/**
+ * Creates a default client configuration.
+ * @returns The client configuration to instantiate the client with.
+ */
+const clientAuthConfig = (userConfig) => {
+    // TODO: Add logic for computing the correct sanitized version value for each platform
+    const defaultOsVersion = "0.0.0";
+    return {
+        serviceAccountToken: userConfig.auth,
+        programmingLanguage: LANGUAGE,
+        sdkVersion: VERSION,
+        integrationName: userConfig.integrationName,
+        integrationVersion: userConfig.integrationVersion,
+        requestLibraryName: "Fetch API",
+        requestLibraryVersion: "Fetch API",
+        os: (0, exports.getOsName)(),
+        osVersion: defaultOsVersion,
+        architecture: os.arch(),
+    };
+};
+exports.clientAuthConfig = clientAuthConfig;
+const getOsName = () => {
+    // Only supported on Node.js
+    const os_name = os.type().toLowerCase();
+    if (os_name === "windows_nt") {
+        return "windows";
+    }
+    return os_name;
+};
+exports.getOsName = getOsName;

package/dist/core.d.ts

@@ -1,8 +1,23 @@
+/**
+ *  Exposes the SDK core to the host JS SDK.
+ */
 export interface Core {
+    /**
+     *  Allocates a new authenticated client and returns its id.
+     */
     initClient(config: ClientAuthConfig): Promise<string>;
+    /**
+     *  Calls business logic from a given client and returns the result.
+     */
     invoke(config: InvokeConfig): Promise<string>;
+    /**
+     *  Deallocates memory held by the given client in the SDK core when it goes out of scope.
+     */
     releaseClient(clientId: number): void;
 }
+/**
+ *  Wraps configuration information needed to allocate and authenticate a client instance and sends it to the SDK core.
+ */
 export interface ClientAuthConfig {
     serviceAccountToken: string;
     programmingLanguage: string;
@@ -15,17 +30,44 @@ export interface ClientAuthConfig {
     osVersion: string;
     architecture: string;
 }
+/**
+ *  Contains the information sent to the SDK core when you call (invoke) a function.
+ */
 export interface InvokeConfig {
+    /**
+     *  Identifies the client instance for which you called the function.
+     */
     clientId: number;
     invocation: Invocation;
 }
+/**
+ *  Calls certain logic from the SDK core, with the given parameters.
+ */
 interface Invocation {
+    /**
+     *  Functionality name
+     */
     name: string;
-    parameters: string;
+    /**
+     *  Parameters
+     */
+    parameters: {
+        [key: string]: unknown;
+    };
 }
+/**
+ *  An implementation of the `Core` interface that shares resources across all clients.
+ */
 export declare class SharedCore implements Core {
     initClient(config: ClientAuthConfig): Promise<string>;
     invoke(config: InvokeConfig): Promise<string>;
     releaseClient(clientId: number): void;
 }
+/**
+ *  Represents the client instance on which a call is made.
+ */
+export interface InnerClient {
+    id: number;
+    core: Core;
+}
 export {};

package/dist/core.js

@@ -11,7 +11,9 @@ 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");
-// An implementation of the `Core` interface that shares resources across all clients.
+/**
+ *  An implementation of the `Core` interface that shares resources across all clients.
+ */
 class SharedCore {
     initClient(config) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/items.d.ts

@@ -0,0 +1,28 @@
+import { InnerClient } from "./core.js";
+import * as types from "./types.js";
+export interface ItemsApi {
+    /**
+     *  Create a new item
+     */
+    create(item: types.Item): Promise<types.Item>;
+    /**
+     *  Get an item by vault and item ID
+     */
+    get(vaultId: string, itemId: string): Promise<types.Item>;
+    /**
+     *  Update an existing item. Warning: Only text and concealed fields are currently supported. Other fields will be permanently lost when you update an item.
+     */
+    update(item: types.Item): Promise<types.Item>;
+    /**
+     *  Delete an item. Warning:  Information saved in fields other than text and concealed fields will be permanently lost.
+     */
+    delete(vaultId: string, itemId: string): Promise<void>;
+}
+export declare class ItemsSource implements ItemsApi {
+    #private;
+    constructor(inner: InnerClient);
+    create(item: types.Item): Promise<types.Item>;
+    get(vaultId: string, itemId: string): Promise<types.Item>;
+    update(item: types.Item): Promise<types.Item>;
+    delete(vaultId: string, itemId: string): Promise<void>;
+}

package/dist/items.js

@@ -0,0 +1,90 @@
+"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 _ItemsSource_inner;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemsSource = void 0;
+class ItemsSource {
+    constructor(inner) {
+        _ItemsSource_inner.set(this, void 0);
+        __classPrivateFieldSet(this, _ItemsSource_inner, inner, "f");
+    }
+    create(item) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
+                invocation: {
+                    name: "Create",
+                    parameters: {
+                        item,
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig));
+        });
+    }
+    get(vaultId, itemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
+                invocation: {
+                    name: "Get",
+                    parameters: {
+                        vault_id: vaultId,
+                        item_id: itemId,
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig));
+        });
+    }
+    update(item) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
+                invocation: {
+                    name: "Update",
+                    parameters: {
+                        item,
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig));
+        });
+    }
+    delete(vaultId, itemId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                clientId: __classPrivateFieldGet(this, _ItemsSource_inner, "f").id,
+                invocation: {
+                    name: "Delete",
+                    parameters: {
+                        vault_id: vaultId,
+                        item_id: itemId,
+                    },
+                },
+            };
+            yield __classPrivateFieldGet(this, _ItemsSource_inner, "f").core.invoke(invocationConfig);
+        });
+    }
+}
+exports.ItemsSource = ItemsSource;
+_ItemsSource_inner = new WeakMap();

package/dist/sdk.d.ts

@@ -0,0 +1,11 @@
+import { ClientConfiguration } from "./configuration.js";
+import { Client } from "./client.js";
+export declare const DEFAULT_INTEGRATION_NAME = "Unknown";
+export declare const DEFAULT_INTEGRATION_VERSION = "Unknown";
+export * from "./client.js";
+export * from "./types.js";
+/**
+ * Creates a default 1Password SDK client.
+ * @returns The authenticated 1Password SDK client.
+ */
+export declare const createClient: (config: ClientConfiguration) => Promise<Client>;

package/dist/sdk.js

@@ -0,0 +1,38 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = exports.DEFAULT_INTEGRATION_VERSION = exports.DEFAULT_INTEGRATION_NAME = void 0;
+const core_js_1 = require("./core.js");
+const client_builder_js_1 = require("./client_builder.js");
+exports.DEFAULT_INTEGRATION_NAME = "Unknown";
+exports.DEFAULT_INTEGRATION_VERSION = "Unknown";
+__exportStar(require("./client.js"), exports);
+__exportStar(require("./types.js"), exports);
+/**
+ * Creates a default 1Password SDK client.
+ * @returns The authenticated 1Password SDK client.
+ */
+const createClient = (config) => __awaiter(void 0, void 0, void 0, function* () { return (0, client_builder_js_1.createClientWithCore)(config, new core_js_1.SharedCore()); });
+exports.createClient = createClient;

package/dist/secrets.d.ts

@@ -1,8 +1,8 @@
-import { InnerClient } from "./configuration.js";
-export interface SecretsAPI {
+import { InnerClient } from "./core.js";
+export interface SecretsApi {
     resolve(secretReference: string): Promise<string>;
 }
-export declare class SecretsSource implements SecretsAPI {
+export declare class SecretsSource implements SecretsApi {
     #private;
     constructor(inner: InnerClient);
     resolve(secretReference: string): Promise<string>;

package/dist/secrets.js

@@ -1,4 +1,13 @@
 "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");
@@ -13,21 +22,24 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _SecretsSource_inner;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SecretsSource = void 0;
-// An implementation of the `SecretsAPI` that wraps a `Core`.
 class SecretsSource {
     constructor(inner) {
         _SecretsSource_inner.set(this, void 0);
         __classPrivateFieldSet(this, _SecretsSource_inner, inner, "f");
     }
     resolve(secretReference) {
-        const invocationConfig = {
-            clientId: __classPrivateFieldGet(this, _SecretsSource_inner, "f").id,
-            invocation: {
-                name: "Resolve",
-                parameters: secretReference,
-            },
-        };
-        return __classPrivateFieldGet(this, _SecretsSource_inner, "f").core.invoke(invocationConfig);
+        return __awaiter(this, void 0, void 0, function* () {
+            const invocationConfig = {
+                clientId: __classPrivateFieldGet(this, _SecretsSource_inner, "f").id,
+                invocation: {
+                    name: "Resolve",
+                    parameters: {
+                        secret_reference: secretReference,
+                    },
+                },
+            };
+            return JSON.parse(yield __classPrivateFieldGet(this, _SecretsSource_inner, "f").core.invoke(invocationConfig));
+        });
     }
 }
 exports.SecretsSource = SecretsSource;

package/dist/types.d.ts

@@ -0,0 +1,98 @@
+export declare enum ItemCategory {
+    Login = "Login",
+    SecureNote = "SecureNote",
+    CreditCard = "CreditCard",
+    CryptoWallet = "CryptoWallet",
+    Identity = "Identity",
+    Password = "Password",
+    Document = "Document",
+    ApiCredentials = "ApiCredentials",
+    BankAccount = "BankAccount",
+    Database = "Database",
+    DriverLicense = "DriverLicense",
+    Email = "Email",
+    MedicalRecord = "MedicalRecord",
+    Membership = "Membership",
+    OutdoorLicense = "OutdoorLicense",
+    Passport = "Passport",
+    Rewards = "Rewards",
+    Router = "Router",
+    Server = "Server",
+    SshKey = "SshKey",
+    SocialSecurityNumber = "SocialSecurityNumber",
+    SoftwareLicense = "SoftwareLicense",
+    Person = "Person",
+    Unsupported = "Unsupported"
+}
+export declare enum ItemFieldType {
+    Text = "Text",
+    Concealed = "Concealed",
+    Unsupported = "Unsupported"
+}
+/**
+ *  Stores a field's title and value.
+ */
+export interface ItemField {
+    /**
+     *  The field's ID
+     */
+    id: string;
+    /**
+     *  The field's title
+     */
+    title: string;
+    /**
+     *  The ID of the section containing the field
+     */
+    section_id?: string;
+    /**
+     *  The type of value stored in the field
+     */
+    field_type: ItemFieldType;
+    /**
+     *  The string representation of the field's value
+     */
+    value: string;
+}
+/**
+ *  A section groups together multiple fields in an item.
+ */
+export interface ItemSection {
+    /**
+     *  The ID of the section
+     */
+    id: string;
+    /**
+     *  The title of the section
+     */
+    title: string;
+}
+/**
+ *  Represents a 1Password item.
+ */
+export interface Item {
+    /**
+     *  The item's unique 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
+     */
+    vault_id: string;
+    /**
+     *  The item's fields
+     */
+    fields: ItemField[];
+    /**
+     *  The item's sections
+     */
+    sections: ItemSection[];
+}

package/dist/types.js

@@ -0,0 +1,39 @@
+"use strict";
+/*
+ Generated by typeshare 1.9.2
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ItemFieldType = exports.ItemCategory = void 0;
+var ItemCategory;
+(function (ItemCategory) {
+    ItemCategory["Login"] = "Login";
+    ItemCategory["SecureNote"] = "SecureNote";
+    ItemCategory["CreditCard"] = "CreditCard";
+    ItemCategory["CryptoWallet"] = "CryptoWallet";
+    ItemCategory["Identity"] = "Identity";
+    ItemCategory["Password"] = "Password";
+    ItemCategory["Document"] = "Document";
+    ItemCategory["ApiCredentials"] = "ApiCredentials";
+    ItemCategory["BankAccount"] = "BankAccount";
+    ItemCategory["Database"] = "Database";
+    ItemCategory["DriverLicense"] = "DriverLicense";
+    ItemCategory["Email"] = "Email";
+    ItemCategory["MedicalRecord"] = "MedicalRecord";
+    ItemCategory["Membership"] = "Membership";
+    ItemCategory["OutdoorLicense"] = "OutdoorLicense";
+    ItemCategory["Passport"] = "Passport";
+    ItemCategory["Rewards"] = "Rewards";
+    ItemCategory["Router"] = "Router";
+    ItemCategory["Server"] = "Server";
+    ItemCategory["SshKey"] = "SshKey";
+    ItemCategory["SocialSecurityNumber"] = "SocialSecurityNumber";
+    ItemCategory["SoftwareLicense"] = "SoftwareLicense";
+    ItemCategory["Person"] = "Person";
+    ItemCategory["Unsupported"] = "Unsupported";
+})(ItemCategory || (exports.ItemCategory = ItemCategory = {}));
+var ItemFieldType;
+(function (ItemFieldType) {
+    ItemFieldType["Text"] = "Text";
+    ItemFieldType["Concealed"] = "Concealed";
+    ItemFieldType["Unsupported"] = "Unsupported";
+})(ItemFieldType || (exports.ItemFieldType = ItemFieldType = {}));

package/package.json

@@ -1,29 +1,30 @@
 {
   "name": "@1password/sdk",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.10",
   "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": "npm run clean && tsc",
-    "clean": "rimraf dist",
+    "build": "tsc",
     "test": "npm run build && jest",
     "prettier": "prettier --check 'src/*.ts'",
-    "prepare": "npm run build"
+    "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"
   },
   "author": "1Password",
   "license": "MIT",
-  "files": [
-    "./dist"
-  ],
+  "files": ["./dist"],
   "exports": {
     ".": {
-      "types": "./dist/client.d.ts",
-      "default": "./dist/client.js"
+      "types": "./dist/sdk.d.ts",
+      "default": "./dist/sdk.js"
     }
   },
-  "main": "./dist/client.js",
-  "types": "./dist/client.d.ts",
+  "main": "./dist/sdk.js",
+  "types": "./dist/sdk.d.ts",
   "dependencies": {
-    "@1password/sdk-core": "0.1.0-beta.1"
+    "@1password/sdk-core": "0.1.0-beta.9"
   },
   "devDependencies": {
     "@1password/eslint-config": "^4.0.0",
@@ -36,7 +37,6 @@
     "jest-environment-jsdom": "^29.6.2",
     "prettier": "3.1.1",
     "ts-jest": "^29.1.1",
-    "rimraf": "^5.0.0",
     "typescript": "^5.3.3",
     "@types/node": "^20.11.0",
     "@babel/preset-env": "^7.23.8",