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

package/dist/client.d.ts

@@ -1,12 +1,24 @@
-import { SecretsAPI } from "./secrets.js";
+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>;
+/**
+ * Creates a default 1Password SDK client.
+ * @returns The authenticated 1Password SDK client.
+ */
+export declare const createClient: (config: ClientConfiguration) => Promise<Client>;
+/**
+ * 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>;
 export declare class Client {
-    secrets: SecretsAPI;
+    secrets: SecretsApi;
     constructor(innerClient: InnerClient);
 }
-export declare function createClientAuthConfig(userConfig: ClientConfiguration): ClientAuthConfig;
+/**
+ * Creates a default client configuration.
+ * @returns The client configuration to instantiate the client with.
+ */
+export declare const clientAuthConfig: (userConfig: ClientConfiguration) => ClientAuthConfig;

package/dist/client.js

@@ -32,38 +32,39 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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.clientAuthConfig = exports.Client = exports.createClientWithCore = exports.createClient = exports.DEFAULT_INTEGRATION_VERSION = exports.DEFAULT_INTEGRATION_NAME = void 0;
+const os = __importStar(require("os"));
 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);
+const finalizationRegistry = new FinalizationRegistry((heldClient) => {
+    heldClient.core.releaseClient(heldClient.id);
 });
-function createClient(config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return createClientWithCore(config, new core_js_1.SharedCore());
-    });
-}
+/**
+ * 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, exports.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;
-    });
-}
+/**
+ * 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, exports.clientAuthConfig)(config);
+    const clientId = yield core.initClient(authConfig);
+    const inner = {
+        id: parseInt(clientId, 10),
+        core,
+    };
+    const client = new Client(inner);
+    // Cleans up associated memory from core when client instance goes out of scope.
+    finalizationRegistry.register(client, inner);
+    return client;
+});
 exports.createClientWithCore = createClientWithCore;
 // Client represents a client instance of the SDK.
 class Client {
@@ -72,7 +73,13 @@ class Client {
     }
 }
 exports.Client = Client;
-function createClientAuthConfig(userConfig) {
+/**
+ * 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,
@@ -82,9 +89,9 @@ function createClientAuthConfig(userConfig) {
         requestLibraryName: "Fetch API",
         requestLibraryVersion: "Fetch API",
         // Only supported on Node.js
-        os: os.type(),
-        osVersion: os.version(),
+        os: os.type().toLowerCase(),
+        osVersion: defaultOsVersion,
         architecture: os.arch(),
     };
-}
-exports.createClientAuthConfig = createClientAuthConfig;
+};
+exports.clientAuthConfig = clientAuthConfig;

package/dist/secrets.d.ts

@@ -1,8 +1,8 @@
 import { InnerClient } from "./configuration.js";
-export interface SecretsAPI {
+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");
@@ -20,14 +29,16 @@ class SecretsSource {
         __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: secretReference,
+                },
+            };
+            return __classPrivateFieldGet(this, _SecretsSource_inner, "f").core.invoke(invocationConfig);
+        });
     }
 }
 exports.SecretsSource = SecretsSource;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@1password/sdk",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.2",
   "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'",
+    "prettier-fix": "prettier --write 'src/*.ts'",
+    "eslint": "eslint -c .eslintrc.json 'src/*.ts'",
     "prepare": "npm run build"
   },
   "author": "1Password",
@@ -23,7 +24,7 @@
   "main": "./dist/client.js",
   "types": "./dist/client.d.ts",
   "dependencies": {
-    "@1password/sdk-core": "0.1.0-beta.1"
+    "@1password/sdk-core": "0.1.0-beta.2"
   },
   "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",