@1password/sdk 0.1.0-beta.1

package/dist/client.d.ts

@@ -0,0 +1,12 @@
+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>;
+export declare class Client {
+    secrets: SecretsAPI;
+    constructor(innerClient: InnerClient);
+}
+export declare function createClientAuthConfig(userConfig: ClientConfiguration): ClientAuthConfig;

package/dist/client.js

@@ -0,0 +1,90 @@
+"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;
+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.
+class Client {
+    constructor(innerClient) {
+        this.secrets = new secrets_js_1.SecretsSource(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/configuration.d.ts

@@ -0,0 +1,12 @@
+import { Core } from "./core.js";
+export interface InnerClient {
+    id: number;
+    core: Core;
+}
+export interface ClientConfiguration {
+    auth: Auth;
+    integrationName: string;
+    integrationVersion: string;
+}
+type Auth = string;
+export {};

package/dist/configuration.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core.d.ts

@@ -0,0 +1,31 @@
+export interface Core {
+    initClient(config: ClientAuthConfig): Promise<string>;
+    invoke(config: InvokeConfig): Promise<string>;
+    releaseClient(clientId: number): void;
+}
+export interface ClientAuthConfig {
+    serviceAccountToken: string;
+    programmingLanguage: string;
+    sdkVersion: string;
+    integrationName: string;
+    integrationVersion: string;
+    requestLibraryName: string;
+    requestLibraryVersion: string;
+    os: string;
+    osVersion: string;
+    architecture: string;
+}
+export interface InvokeConfig {
+    clientId: number;
+    invocation: Invocation;
+}
+interface Invocation {
+    name: string;
+    parameters: string;
+}
+export declare class SharedCore implements Core {
+    initClient(config: ClientAuthConfig): Promise<string>;
+    invoke(config: InvokeConfig): Promise<string>;
+    releaseClient(clientId: number): void;
+}
+export {};

package/dist/core.js

@@ -0,0 +1,33 @@
+"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.SharedCore = void 0;
+const sdk_core_1 = require("@1password/sdk-core");
+// An implementation of the `Core` interface that shares resources across all clients.
+class SharedCore {
+    initClient(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const serializedConfig = JSON.stringify(config);
+            return (0, sdk_core_1.init_client)(serializedConfig);
+        });
+    }
+    invoke(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const serializedConfig = JSON.stringify(config);
+            return (0, sdk_core_1.invoke)(serializedConfig);
+        });
+    }
+    releaseClient(clientId) {
+        const serializedId = JSON.stringify(clientId);
+        (0, sdk_core_1.release_client)(serializedId);
+    }
+}
+exports.SharedCore = SharedCore;

package/dist/secrets.d.ts

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

package/dist/secrets.js

@@ -0,0 +1,34 @@
+"use strict";
+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 _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);
+    }
+}
+exports.SecretsSource = SecretsSource;
+_SecretsSource_inner = new WeakMap();

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@1password/sdk",
+  "version": "0.1.0-beta.1",
+  "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",
+    "test": "npm run build && jest",
+    "prettier": "prettier --check 'src/*.ts'",
+    "prepare": "npm run build"
+  },
+  "author": "1Password",
+  "license": "MIT",
+  "files": [
+    "./dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/client.d.ts",
+      "default": "./dist/client.js"
+    }
+  },
+  "main": "./dist/client.js",
+  "types": "./dist/client.d.ts",
+  "dependencies": {
+    "@1password/sdk-core": "0.1.0-beta.1"
+  },
+  "devDependencies": {
+    "@1password/eslint-config": "^4.0.0",
+    "@1password/prettier-config": "^1.1.3",
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.11",
+    "jest": "^29.7.0",
+    "eslint": "^8.54.0",
+    "prettier-plugin-organize-imports": "^3.2.3",
+    "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",
+    "babel-jest": "^29.7.0"
+  }
+}