@qbraid-core/jobs 0.10.2 → 0.12.0

package/README.md

@@ -15,6 +15,22 @@ npm install @qbraid-core/jobs
 
 ## Usage Example
 
+### V1 API (Recommended)
+
+```typescript
+import { QbraidSessionV1 } from '@qbraid-core/base';
+import { QuantumJobsClientV1 } from '@qbraid-core/jobs';
+
+const session = new QbraidSessionV1('your-api-key');
+const client = new QuantumJobsClientV1(session);
+
+const jobs = await client.getJobs();
+
+jobs.forEach(job => console.log(`${job.qrn} - ${job.status}`));
+```
+
+### V0 API (Legacy)
+
 ```typescript
 import { QuantumJobsClient } from '@qbraid-core/jobs';
 

package/dist/src/client.d.ts

@@ -1,9 +1,37 @@
 import { QbraidSession, QbraidClient } from '@qbraid-core/base';
-import { QuantumJobResponse, JobQueryParams, DeleteSingleJobResponse, DeleteMultipleJobsResponse, CancelResponse } from './types';
+import { QbraidClientV1, QbraidSessionV1 } from '@qbraid-core/base';
+import { QuantumJobResponse, JobQueryParams, DeleteSingleJobResponse, DeleteMultipleJobsResponse, CancelResponse, PlatformJob, JobQueryParamsV1, DeleteJobResponseV1, DeleteMultipleJobsResponseV1, CancelJobResponseV1 } from './types';
 export declare class QuantumJobsClient extends QbraidClient {
-    constructor(session?: QbraidSession);
+    constructor(session: QbraidSession);
     getJobs(params?: JobQueryParams): Promise<QuantumJobResponse>;
     deleteJob(jobId: string): Promise<DeleteSingleJobResponse>;
     deleteMultipleJobs(jobIdArray: string[]): Promise<DeleteMultipleJobsResponse>;
     cancelJobs(jobId: string): Promise<CancelResponse>;
 }
+export declare class QuantumJobsClientV1 extends QbraidClientV1 {
+    constructor(session: QbraidSessionV1);
+    /**
+     * Get jobs from the V1 API.
+     * @param params - Optional query parameters to filter jobs
+     * @returns Array of PlatformJob objects
+     */
+    getJobs(params?: JobQueryParamsV1): Promise<PlatformJob[]>;
+    /**
+     * Delete a single job by its QRN.
+     * @param jobQrn - The job QRN to delete
+     * @returns Delete response
+     */
+    deleteJob(jobQrn: string): Promise<DeleteJobResponseV1>;
+    /**
+     * Delete multiple jobs by their QRNs.
+     * @param jobQrns - Array of job QRNs to delete
+     * @returns Delete response with lists of deleted and failed jobs
+     */
+    deleteMultipleJobs(jobQrns: string[]): Promise<DeleteMultipleJobsResponseV1>;
+    /**
+     * Cancel a job by its QRN.
+     * @param jobQrn - The job QRN to cancel
+     * @returns Cancel response
+     */
+    cancelJob(jobQrn: string): Promise<CancelJobResponseV1>;
+}

package/dist/src/client.js

@@ -2,8 +2,9 @@
 // Copyright (c) 2025, qBraid Development Team
 // All rights reserved.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuantumJobsClient = void 0;
+exports.QuantumJobsClientV1 = exports.QuantumJobsClient = void 0;
 const base_1 = require("@qbraid-core/base");
+const base_2 = require("@qbraid-core/base");
 class QuantumJobsClient extends base_1.QbraidClient {
     constructor(session) {
         super(session);
@@ -42,4 +43,51 @@ class QuantumJobsClient extends base_1.QbraidClient {
     }
 }
 exports.QuantumJobsClient = QuantumJobsClient;
+class QuantumJobsClientV1 extends base_2.QbraidClientV1 {
+    // NOTE: the QbraidSessionV1 object might change as we introduce the
+    // microservice architecture for the V1 API. For now, we go through
+    // the new api, so we have the same pattern as devices
+    constructor(session) {
+        super(session);
+    }
+    /**
+     * Get jobs from the V1 API.
+     * @param params - Optional query parameters to filter jobs
+     * @returns Array of PlatformJob objects
+     */
+    async getJobs(params) {
+        const response = await this.session.client.get('/jobs', { params });
+        return response?.data ?? [];
+    }
+    /**
+     * Delete a single job by its QRN.
+     * @param jobQrn - The job QRN to delete
+     * @returns Delete response
+     */
+    async deleteJob(jobQrn) {
+        const response = await this.session.client.delete(`/jobs/${jobQrn}`);
+        return response?.data ?? { message: 'Unknown error' };
+    }
+    /**
+     * Delete multiple jobs by their QRNs.
+     * @param jobQrns - Array of job QRNs to delete
+     * @returns Delete response with lists of deleted and failed jobs
+     */
+    async deleteMultipleJobs(jobQrns) {
+        const response = await this.session.client.delete('/jobs', {
+            data: { jobQrns },
+        });
+        return response?.data ?? { message: 'Unknown error' };
+    }
+    /**
+     * Cancel a job by its QRN.
+     * @param jobQrn - The job QRN to cancel
+     * @returns Cancel response
+     */
+    async cancelJob(jobQrn) {
+        const response = await this.session.client.put(`/jobs/${jobQrn}/cancel`);
+        return response?.data ?? { message: 'Unknown error' };
+    }
+}
+exports.QuantumJobsClientV1 = QuantumJobsClientV1;
 //# sourceMappingURL=client.js.map

package/dist/src/client.js.map

@@ -1 +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,CAAqB,eAAe,EAAE;YAClF,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"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;AAEvB,4CAAgE;AAChE,4CAAoE;AAepE,MAAa,iBAAkB,SAAQ,mBAAY;IACjD,YAAY,OAAsB;QAChC,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,CAAqB,eAAe,EAAE;YAClF,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;AAED,MAAa,mBAAoB,SAAQ,qBAAc;IACrD,oEAAoE;IACpE,mEAAmE;IACnE,sDAAsD;IACtD,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,MAAyB;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAgB,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACnF,OAAO,QAAQ,EAAE,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,MAAc;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAsB,SAAS,MAAM,EAAE,CAAC,CAAC;QAC1F,OAAO,QAAQ,EAAE,IAAI,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAAiB;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAA+B,OAAO,EAAE;YACvF,IAAI,EAAE,EAAE,OAAO,EAAE;SAClB,CAAC,CAAC;QACH,OAAO,QAAQ,EAAE,IAAI,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,MAAc;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAsB,SAAS,MAAM,SAAS,CAAC,CAAC;QAC9F,OAAO,QAAQ,EAAE,IAAI,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IACxD,CAAC;CACF;AAjDD,kDAiDC"}

package/dist/src/index.d.ts

@@ -1,5 +1,7 @@
 /**
  * @module jobs
  */
-export { QuantumJobsClient } from './client';
-export type { QuantumJobData, QuantumJobResponse, DeleteSingleJobResponse, DeleteMultipleJobsResponse, CancelResponse, } from './types';
+export { QuantumJobsClient, QuantumJobsClientV1 } from './client';
+export type { Tag, TimeStamps, JobQueryParams, QuantumJobData, QuantumJobResponse, DeleteSingleJobResponse, DeleteMultipleJobsResponse, CancelResponse, } from './types';
+export { JobStatus } from './types';
+export type { ExperimentType, Vendor, Provider, ProgramFormat, S3Destination, TimeStampsV1, Program, JobBase, JobRequest, RuntimeJob, PlatformJob, JobQueryParamsV1, DeleteJobResponseV1, DeleteMultipleJobsResponseV1, CancelJobResponseV1, } from './types';

package/dist/src/index.js

@@ -2,10 +2,14 @@
 // Copyright (c) 2025, qBraid Development Team
 // All rights reserved.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuantumJobsClient = void 0;
+exports.JobStatus = exports.QuantumJobsClientV1 = exports.QuantumJobsClient = void 0;
 /**
  * @module jobs
  */
 var client_1 = require("./client");
 Object.defineProperty(exports, "QuantumJobsClient", { enumerable: true, get: function () { return client_1.QuantumJobsClient; } });
+Object.defineProperty(exports, "QuantumJobsClientV1", { enumerable: true, get: function () { return client_1.QuantumJobsClientV1; } });
+// V1 Types
+var types_1 = require("./types");
+Object.defineProperty(exports, "JobStatus", { enumerable: true, get: function () { return types_1.JobStatus; } });
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;AAEvB;;GAEG;AACH,mCAAkE;AAAzD,2GAAA,iBAAiB,OAAA;AAAE,6GAAA,mBAAmB,OAAA;AAc/C,WAAW;AACX,iCAAoC;AAA3B,kGAAA,SAAS,OAAA"}

package/dist/src/types.d.ts

@@ -69,3 +69,145 @@ export interface DeleteMultipleJobsResponse {
 export interface CancelResponse {
     message: string;
 }
+/**
+ * Enumeration for job statuses.
+ */
+export declare enum JobStatus {
+    INITIALIZING = "INITIALIZING",
+    QUEUED = "QUEUED",
+    VALIDATING = "VALIDATING",
+    RUNNING = "RUNNING",
+    CANCELLING = "CANCELLING",
+    CANCELLED = "CANCELLED",
+    HOLD = "HOLD",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Experiment type enumeration.
+ */
+export type ExperimentType = 'gate_model' | 'annealing' | 'analog' | 'other';
+/**
+ * Vendor type enumeration.
+ */
+export type Vendor = 'aws' | 'azure' | 'ibm' | 'ionq' | 'qbraid';
+/**
+ * Provider type enumeration.
+ */
+export type Provider = 'aqt' | 'aws' | 'azure' | 'equal1' | 'ibm' | 'iqm' | 'ionq' | 'nec' | 'oqc' | 'pasqal' | 'quantinuum' | 'quera' | 'rigetti' | 'qbraid';
+/**
+ * Program format type.
+ */
+export type ProgramFormat = 'qasm2' | 'qasm3' | 'qir.bc' | 'qir.ll' | 'analog';
+/**
+ * Schema for S3 output destination.
+ */
+export interface S3Destination {
+    bucket: string;
+    directory: string;
+}
+/**
+ * Model for capturing time-related information in a job.
+ */
+export interface TimeStampsV1 {
+    createdAt: string;
+    endedAt?: string | null;
+    executionDuration?: number | null;
+}
+/**
+ * Schema for quantum program.
+ */
+export interface Program {
+    format: ProgramFormat;
+    data: unknown;
+}
+/**
+ * Base schema for job fields shared across models.
+ * Does not include 'program' field.
+ */
+export interface JobBase {
+    name?: string | null;
+    shots: number;
+    deviceQrn: string;
+    tags: Record<string, string | number | boolean>;
+    runtimeOptions: Record<string, unknown>;
+}
+/**
+ * Schema for job submission request body.
+ * Extends JobBase and adds the 'program' field.
+ */
+export interface JobRequest extends JobBase {
+    program: Program;
+}
+/**
+ * Schema for runtime job model - base job information.
+ * Extends JobBase (not JobRequest) so it does not include 'program' field.
+ */
+export interface RuntimeJob extends JobBase {
+    jobQrn: string;
+    batchJobQrn?: string | null;
+    vendor: Vendor;
+    provider: Provider;
+    status: JobStatus;
+    statusMsg?: string | null;
+    experimentType: ExperimentType;
+    queuePosition?: number | null;
+    timeStamps?: TimeStampsV1 | null;
+    cost?: number | null;
+    estimatedCost: number;
+    metadata: Record<string, unknown>;
+}
+/**
+ * Schema for platform job model - complete job information.
+ * Includes all fields from RuntimeJob + platform-specific fields.
+ */
+export interface PlatformJob extends RuntimeJob {
+    jobVrn?: string | null;
+    organizationUserId: string;
+    escrowTransactionId?: string | null;
+    settlementTransactionId?: string | null;
+    deviceId: string;
+    providerId: string;
+    error?: string | null;
+    s3Destination: S3Destination;
+}
+/**
+ * Query parameters for fetching jobs (V1).
+ */
+export interface JobQueryParamsV1 {
+    jobQrn?: string;
+    deviceQrn?: string;
+    status?: JobStatus;
+    vendor?: Vendor;
+    provider?: Provider;
+    search?: string;
+    sortOrder?: 'asc' | 'desc';
+    sortBy?: 'status' | 'createdAt' | 'endedAt' | 'experimentType';
+    experimentType?: ExperimentType;
+    page?: number;
+    limit?: number;
+}
+/**
+ * Response for deleting a single job (V1).
+ */
+export interface DeleteJobResponseV1 {
+    message: string;
+    jobQrn?: string;
+}
+/**
+ * Response for deleting multiple jobs (V1).
+ */
+export interface DeleteMultipleJobsResponseV1 {
+    message: string;
+    deletedJobs?: string[];
+    failedJobs?: string[];
+}
+/**
+ * Response for cancelling a job (V1).
+ */
+export interface CancelJobResponseV1 {
+    message: string;
+    jobQrn?: string;
+    status?: JobStatus;
+}

package/dist/src/types.js

@@ -2,4 +2,22 @@
 // Copyright (c) 2025, qBraid Development Team
 // All rights reserved.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobStatus = void 0;
+// ==================== V1 Types ====================
+/**
+ * Enumeration for job statuses.
+ */
+var JobStatus;
+(function (JobStatus) {
+    JobStatus["INITIALIZING"] = "INITIALIZING";
+    JobStatus["QUEUED"] = "QUEUED";
+    JobStatus["VALIDATING"] = "VALIDATING";
+    JobStatus["RUNNING"] = "RUNNING";
+    JobStatus["CANCELLING"] = "CANCELLING";
+    JobStatus["CANCELLED"] = "CANCELLED";
+    JobStatus["HOLD"] = "HOLD";
+    JobStatus["COMPLETED"] = "COMPLETED";
+    JobStatus["FAILED"] = "FAILED";
+    JobStatus["UNKNOWN"] = "UNKNOWN";
+})(JobStatus || (exports.JobStatus = JobStatus = {}));
 //# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;AAkFvB,qDAAqD;AAErD;;GAEG;AACH,IAAY,SAWX;AAXD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,8BAAiB,CAAA;IACjB,sCAAyB,CAAA;IACzB,gCAAmB,CAAA;IACnB,sCAAyB,CAAA;IACzB,oCAAuB,CAAA;IACvB,0BAAa,CAAA;IACb,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;AACrB,CAAC,EAXW,SAAS,yBAAT,SAAS,QAWpB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@qbraid-core/jobs",
   "description": "Client for the qBraid Quantum Jobs service.",
-  "version": "0.10.2",
+  "version": "0.12.0",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "author": "qBraid Development Team",
@@ -28,8 +28,16 @@
     "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.10.2"
+  "browser": {
+    "https": false,
+    "http": false,
+    "os": false,
+    "fs": false,
+    "path": false
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "@qbraid-core/base": "0.12.0"
   },
   "scripts": {
     "clean": "rimraf dist tsconfig.tsbuildinfo src/*.d.ts src/*.js",