@qbraid-core/jobs 0.3.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/jobs](https://qbraid.github.io/qbraid-core-js/modules/jobs.html)
+
+[![Stable][preview-stability]](https://qbraid.github.io/qbraid-core-js/#launch-stages)
+[![npm](https://img.shields.io/npm/v/@qbraid-core/jobs?color=blue)](https://npm.im/@qbraid-core/jobs)
+
+Client for the qBraid Quantum Jobs service.
+
+## Installation
+
+```bash
+npm install @qbraid-core/jobs
+```
+
+## Usage Example
+
+```typescript
+import { QuantumJobsClient } from '@qbraid-core/jobs';
+
+const client = new QuantumJobsClient();
+
+const jobs = await client.getJobs();
+
+jobs.forEach(job => console.log(`${job.qbraidJobId} - ${job.status}`));
+```
+
+## 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,9 @@
+import { QbraidSession, QbraidClient } from '@qbraid-core/base';
+import { QuantumJobResponse, JobQueryParams, DeleteSingleJobResponse, DeleteMultipleJobsResponse, CancelResponse } from './types';
+export declare class QuantumJobsClient extends QbraidClient {
+    constructor(session?: QbraidSession);
+    getJobs(params?: JobQueryParams): Promise<QuantumJobResponse[]>;
+    deleteJob(jobId: string): Promise<DeleteSingleJobResponse>;
+    deleteMultipleJobs(jobIdArray: string[]): Promise<DeleteMultipleJobsResponse>;
+    cancelJobs(jobId: string): Promise<CancelResponse>;
+}

package/dist/src/client.js

@@ -0,0 +1,45 @@
+"use strict";
+// Copyright (c) 2025, qBraid Development Team
+// All rights reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuantumJobsClient = void 0;
+const base_1 = require("@qbraid-core/base");
+class QuantumJobsClient extends base_1.QbraidClient {
+    constructor(session) {
+        super(session);
+    }
+    async getJobs(params) {
+        const queryTags = params?.tags?.reduce((accumulator, tag) => {
+            // reducer function for tags
+            accumulator[`tags.${tag.key}`] = tag.value;
+            return accumulator;
+        }, 
+        // object definition and type
+        {});
+        if (params) {
+            delete params.tags;
+        }
+        const finalParams = { ...params, ...queryTags };
+        const response = await this.session.client.get(`/quantum-jobs`, {
+            params: finalParams,
+        });
+        return response.data;
+    }
+    async deleteJob(jobId) {
+        const response = await this.session.client.delete(`/quantum-jobs/${jobId}`);
+        return response.data;
+    }
+    async deleteMultipleJobs(jobIdArray) {
+        const commaSeparatedIds = jobIdArray.join(',');
+        const response = await this.session.client.delete(`/quantum-jobs?ids=${commaSeparatedIds}`, {
+            data: { jobIdArray },
+        });
+        return response.data;
+    }
+    async cancelJobs(jobId) {
+        const response = await this.session.client.put(`/quantum-jobs/cancel/${jobId}`);
+        return response.data;
+    }
+}
+exports.QuantumJobsClient = QuantumJobsClient;
+//# 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;AAUhE,MAAa,iBAAkB,SAAQ,mBAAY;IACjD,YAAY,OAAuB;QACjC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAuB;QACnC,MAAM,SAAS,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,CACpC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;YACnB,4BAA4B;YAC5B,WAAW,CAAC,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC;YAC3C,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,6BAA6B;QAC7B,EAA4B,CAC7B,CAAC;QAEF,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC,IAAI,CAAC;QACrB,CAAC;QAED,MAAM,WAAW,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC;QAChD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAuB,eAAe,EAAE;YACpF,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAa;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAC/C,iBAAiB,KAAK,EAAE,CACzB,CAAC;QACF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,UAAoB;QAC3C,MAAM,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAC/C,qBAAqB,iBAAiB,EAAE,EACxC;YACE,IAAI,EAAE,EAAE,UAAU,EAAE;SACrB,CACF,CAAC;QACF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAa;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAiB,wBAAwB,KAAK,EAAE,CAAC,CAAC;QAChG,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF;AAlDD,8CAkDC"}

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module jobs
+ */
+export { QuantumJobsClient } from './client';
+export type { QuantumJobResponse, DeleteSingleJobResponse, DeleteMultipleJobsResponse, CancelResponse, } 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.QuantumJobsClient = void 0;
+/**
+ * @module jobs
+ */
+var client_1 = require("./client");
+Object.defineProperty(exports, "QuantumJobsClient", { enumerable: true, get: function () { return client_1.QuantumJobsClient; } });
+//# 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,mCAA6C;AAApC,2GAAA,iBAAiB,OAAA"}

package/dist/src/types.d.ts

@@ -0,0 +1,65 @@
+export interface Tag {
+    key: string;
+    value: string;
+}
+export interface TimeStamps {
+    createdAt: string;
+    endedAt: string;
+    executionDuration: number;
+}
+export interface JobQueryParams {
+    page?: number;
+    resultsPerPage?: number;
+    statusGroup?: string;
+    provider?: string;
+    search?: string;
+    tags?: Tag[];
+}
+export interface QuantumJobResponse {
+    timeStamps: TimeStamps;
+    circuitBatchNumQubits: number[];
+    circuitBatchDepth: number[];
+    sites: number[];
+    rabiArray: number[];
+    detuningArray: number[];
+    phaseArray: number[];
+    filling: number[];
+    queuePosition: number | null;
+    queueDepth: number | null;
+    measurements: number[];
+    prelight: boolean;
+    _id: string;
+    email: string;
+    user: string;
+    qbraidDeviceId: string;
+    vendorDeviceId: string;
+    vendorJobId: string;
+    qbraidJobId: string;
+    slurmJobId: number;
+    status: string;
+    qbraidStatus: string;
+    vendor: string;
+    provider: string;
+    escrow: number;
+    shots: number;
+    openQasm: string;
+    experimentType: string;
+    logo: string;
+    logoDark: string;
+    createdAt: string;
+    updatedAt: string;
+    cost: number;
+    statusText: string;
+}
+export interface DeleteSingleJobResponse {
+    message: string;
+    data?: QuantumJobResponse;
+}
+export interface DeleteMultipleJobsResponse {
+    message: string;
+    deletedJobs?: string[];
+    nonDeletedJobs?: string[];
+}
+export interface CancelResponse {
+    message: string;
+}

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,45 @@
+{
+  "name": "@qbraid-core/jobs",
+  "description": "Client for the qBraid Quantum Jobs service.",
+  "version": "0.3.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 jobs",
+    "qbraid quantum jobs",
+    "qbraid cloud",
+    "qbraid api",
+    "qbraid apis",
+    "cloud",
+    "quantum",
+    "quantum computing"
+  ],
+  "repository": {
+    "type": "git",
+    "directory": "packages/jobs",
+    "url": "git+https://github.com/qBraid/qbraid-core-js.git"
+  },
+  "homepage": "https://qbraid.github.io/qbraid-core-js/modules/jobs.html",
+  "dependencies": {
+    "@qbraid-core/base": "0.3.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"
+  }
+}