@qbraid-core/compute 0.4.0

package/README.md

@@ -0,0 +1,34 @@
+<img align="right" width="100" alt="qbraid" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid.png">
+
+# [@qbraid-core/compute](https://qbraid.github.io/qbraid-core-js/modules/compute.html)
+
+[![Stable][preview-stability]](https://qbraid.github.io/qbraid-core-js/#launch-stages)
+[![npm](https://img.shields.io/npm/v/@qbraid-core/compute?color=blue)](https://npm.im/@qbraid-core/compute)
+
+Client for the qBraid Compute Manager.
+
+## Installation
+
+```bash
+npm install @qbraid-core/compute
+```
+
+## Usage Example
+
+```typescript
+import { ComputeManagerClient } from '@qbraid-core/compute';
+
+const client = new ComputeManagerClient();
+
+const computeProfiles = await client.getComputeManagerAsync('<<your-email>>');
+
+computeProfiles.forEach(profile => console.log(`${profile.slug} - ${profile.description}`));
+```
+
+## License
+
+This software is proprietary and subject to the terms of the [qBraid Commercial Software License](https://qbraid.github.io/qbraid-core-js/#license).
+
+[stable-stability]: https://img.shields.io/badge/stability-stable-green
+[preview-stability]: https://img.shields.io/badge/stability-preview-orange
+[deprecated-stability]: https://img.shields.io/badge/stability-deprecated-red

package/dist/src/client.d.ts

@@ -0,0 +1,13 @@
+import { QbraidClient, QbraidSession } from '@qbraid-core/base';
+import { AxiosResponse } from 'axios';
+import { ComputeProfile, UserServerStatus } from './types';
+export declare class ComputeManagerClient extends QbraidClient {
+    private qBraidURLs;
+    constructor(session?: QbraidSession, hubURL?: string, labURL?: string);
+    getComputeManager(userEmail: string): Promise<ComputeProfile[]>;
+    getUserLabToken(userApiKey: string): Promise<string>;
+    startServer(labToken: string, profileSlug?: string): Promise<AxiosResponse>;
+    stopServer(labToken: string, labUserName: string): Promise<AxiosResponse>;
+    statusServer(labToken: string, labUserName: string): Promise<UserServerStatus>;
+    getProfilePrice(profileSlug: string): Promise<number>;
+}

package/dist/src/client.js

@@ -0,0 +1,63 @@
+"use strict";
+// Copyright (c) 2025, qBraid Development Team
+// All rights reserved.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComputeManagerClient = void 0;
+const base_1 = require("@qbraid-core/base");
+const context_1 = require("@qbraid-core/base/src/context");
+const axios_1 = __importDefault(require("axios"));
+class ComputeManagerClient extends base_1.QbraidClient {
+    qBraidURLs;
+    constructor(session, hubURL = context_1.DEFAULT_HUB_URL, labURL = context_1.DEFAULT_LAB_URL) {
+        super(session);
+        this.qBraidURLs = {
+            hub: hubURL,
+            lab: labURL,
+        };
+    }
+    async getComputeManager(userEmail) {
+        const response = await this.session.client.get(`/api/lab/compute/get-profiles/${userEmail}`);
+        return response.data;
+    }
+    async getUserLabToken(userApiKey) {
+        const response = await this.session.client.get('/api/lab/compute/tokens', {
+            headers: {
+                'api-key': userApiKey,
+            },
+        });
+        const data = response.data;
+        const tokenData = data.token;
+        return tokenData.token;
+    }
+    async startServer(labToken, profileSlug = '2vCPU_4GB') {
+        const response = await this.session.client.post('/api/lab/compute/start/server', {
+            labToken: labToken,
+            labURL: this.qBraidURLs['lab'],
+            slug: profileSlug,
+        });
+        return response;
+    }
+    async stopServer(labToken, labUserName) {
+        const response = await axios_1.default.delete(`${this.qBraidURLs['hub']}/hub/api/users/${labUserName}/server`, { headers: { Authorization: `token ${labToken}` } });
+        return response;
+    }
+    async statusServer(labToken, labUserName) {
+        const response = await axios_1.default.get(`${this.qBraidURLs['hub']}/hub/api/users/${labUserName}`, {
+            headers: {
+                Authorization: `token ${labToken}`,
+                Accept: '*/*',
+                'Content-Type': 'application/json; charset=utf-8',
+            },
+        });
+        return response.data;
+    }
+    async getProfilePrice(profileSlug) {
+        const response = await this.session.client.get(`/api/lab/compute/get-profile-price/${profileSlug}`);
+        return response.data;
+    }
+}
+exports.ComputeManagerClient = ComputeManagerClient;
+//# sourceMappingURL=client.js.map

package/dist/src/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;;;;AAEvB,4CAAgE;AAChE,2DAAiF;AACjF,kDAA6C;AAI7C,MAAa,oBAAqB,SAAQ,mBAAY;IAC5C,UAAU,CAA4B;IAE9C,YACE,OAAuB,EACvB,SAAiB,yBAAe,EAChC,SAAiB,yBAAe;QAEhC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG;YAChB,GAAG,EAAE,MAAM;YACX,GAAG,EAAE,MAAM;SACZ,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAC5C,iCAAiC,SAAS,EAAE,CAC7C,CAAC;QACF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,UAAkB;QACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAmB,yBAAyB,EAAE;YAC1F,OAAO,EAAE;gBACP,SAAS,EAAE,UAAU;aACtB;SACF,CAAC,CAAC;QAEH,MAAM,IAAI,GAAqB,QAAQ,CAAC,IAAI,CAAC;QAC7C,MAAM,SAAS,GAAa,IAAI,CAAC,KAAK,CAAC;QACvC,OAAO,SAAS,CAAC,KAAK,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,QAAgB,EAAE,cAAsB,WAAW;QACnE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE;YAC/E,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YAC9B,IAAI,EAAE,WAAW;SAClB,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,WAAmB;QACpD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,MAAM,CACjC,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kBAAkB,WAAW,SAAS,EAC/D,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,QAAQ,EAAE,EAAE,EAAE,CACpD,CAAC;QACF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,WAAmB;QACtD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,kBAAkB,WAAW,EAAE,EAAE;YACzF,OAAO,EAAE;gBACP,aAAa,EAAE,SAAS,QAAQ,EAAE;gBAClC,MAAM,EAAE,KAAK;gBACb,cAAc,EAAE,iCAAiC;aAClD;SACF,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,WAAmB;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAC5C,sCAAsC,WAAW,EAAE,CACpD,CAAC;QACF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF;AApED,oDAoEC"}

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module compute
+ */
+export { ComputeManagerClient } from './client';
+export type { ComputeProfile, UserServerStatus } from './types';

package/dist/src/index.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright (c) 2025, qBraid Development Team
+// All rights reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComputeManagerClient = void 0;
+/**
+ * @module compute
+ */
+var client_1 = require("./client");
+Object.defineProperty(exports, "ComputeManagerClient", { enumerable: true, get: function () { return client_1.ComputeManagerClient; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;AAEvB;;GAEG;AACH,mCAAgD;AAAvC,8GAAA,oBAAoB,OAAA"}

package/dist/src/types.d.ts

@@ -0,0 +1,78 @@
+export interface ComputeProfile {
+    slug: string;
+    display_name: string;
+    description: string;
+    plan: string;
+    node_env: string;
+    machineInternalName: string;
+    documentationDetails: string;
+    rateDollar: number;
+    rateTimeFrame: string;
+    rateRatioOffered: number;
+    visibility: string;
+    lastRefreshDateTime?: Date;
+    kubespawner_override: {
+        image: string;
+        cpu_guarantee: number;
+        cpu_limit: number;
+        mem_limit: string;
+        mem_guarantee: string;
+        start_timeout?: number;
+        node_selector?: {
+            'cloud.google.com/gke-accelerator'?: string;
+        };
+        tolerations?: Array<{
+            key?: string;
+            operator?: string;
+            value?: string;
+            effect?: string;
+        }>;
+        extra_resource_limits?: {
+            'nvidia.com/gpu'?: number;
+        };
+    };
+}
+export interface ServerDetails {
+    name: string;
+    ready: boolean;
+    stopped: boolean;
+    pending: string;
+    url: string;
+    progress_url: string;
+    started: string;
+    last_activity: string;
+    user_options: Record<string, unknown>;
+    full_url?: string;
+    full_progress_url?: string;
+    state?: Record<string, unknown>;
+}
+export interface UserServerStatus {
+    name: string;
+    admin: boolean;
+    roles: string[];
+    groups: string[];
+    server: string;
+    pending: string;
+    last_activity: string;
+    servers: Record<string, ServerDetails>;
+    auth_state?: Record<string, unknown>;
+    session_id?: string;
+    scopes?: string[];
+}
+export interface LabToken {
+    token: string;
+    user: string;
+    id: string;
+    kind: string;
+    roles: string[];
+    scopes: string[];
+    created: string;
+    last_activity: string;
+    expires_at: string;
+    note: string;
+    session_id: string;
+    oauth_client: string;
+}
+export interface LabTokenResponse {
+    token: LabToken;
+}

package/dist/src/types.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) 2025, qBraid Development Team
+// All rights reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@qbraid-core/compute",
+  "description": "Client for the qBraid Compute service.",
+  "version": "0.4.0",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "author": "qBraid Development Team",
+  "license": "Proprietary",
+  "files": [
+    "dist/src"
+  ],
+  "keywords": [
+    "qbraid",
+    "qbraid-core",
+    "qbraid-core-js",
+    "qbraid compute",
+    "qbraid cloud",
+    "qbraid api",
+    "qbraid apis",
+    "cloud",
+    "quantum",
+    "quantum computing"
+  ],
+  "repository": {
+    "type": "git",
+    "directory": "packages/compute",
+    "url": "git+https://github.com/qBraid/qbraid-core-js.git"
+  },
+  "homepage": "https://qbraid.github.io/qbraid-core-js/modules/compute.html",
+  "dependencies": {
+    "@qbraid-core/base": "0.4.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo src/*.d.ts src/*.js",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "format": "prettier --write \"src/**/*.{ts,json}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,json}\"",
+    "docs": "typedoc"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}