@qbraid-core/devices 0.11.0 → 0.12.1

package/README.md

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

package/dist/src/client.d.ts

@@ -1,6 +1,16 @@
 import { QbraidClient, QbraidSession } from '@qbraid-core/base';
-import { Device, DeviceQueryParams } from './types';
+import { QbraidClientV1, QbraidSessionV1 } from '@qbraid-core/base';
+import { Device, DeviceQueryParams, PlatformDevice, DeviceQueryParamsV1 } from './types';
 export declare class QuantumDevicesClient extends QbraidClient {
     constructor(session: QbraidSession);
     getDevices(params?: DeviceQueryParams): Promise<Device[]>;
 }
+export declare class QuantumDevicesClientV1 extends QbraidClientV1 {
+    constructor(session: QbraidSessionV1);
+    /**
+     * Get devices from the V1 API.
+     * @param params - Optional query parameters to filter devices
+     * @returns Array of PlatformDevice objects
+     */
+    getDevices(params?: DeviceQueryParamsV1): Promise<PlatformDevice[]>;
+}

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.QuantumDevicesClient = void 0;
+exports.QuantumDevicesClientV1 = exports.QuantumDevicesClient = void 0;
 const base_1 = require("@qbraid-core/base");
+const base_2 = require("@qbraid-core/base");
 class QuantumDevicesClient extends base_1.QbraidClient {
     constructor(session) {
         super(session);
@@ -14,4 +15,20 @@ class QuantumDevicesClient extends base_1.QbraidClient {
     }
 }
 exports.QuantumDevicesClient = QuantumDevicesClient;
+class QuantumDevicesClientV1 extends base_2.QbraidClientV1 {
+    constructor(session) {
+        super(session);
+    }
+    /**
+     * Get devices from the V1 API.
+     * @param params - Optional query parameters to filter devices
+     * @returns Array of PlatformDevice objects
+     */
+    async getDevices(params) {
+        // V1 API returns a wrapper: { success: boolean, data: PlatformDevice[] }
+        const response = await this.session.client.get('/devices', { params });
+        return response?.data?.data ?? [];
+    }
+}
+exports.QuantumDevicesClientV1 = QuantumDevicesClientV1;
 //# 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;AAIhE,MAAa,oBAAqB,SAAQ,mBAAY;IACpD,YAAY,OAAsB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAA0B;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAW,kBAAkB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACzF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF;AATD,oDASC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;AAEvB,4CAAgE;AAChE,4CAAoE;AAIpE,MAAa,oBAAqB,SAAQ,mBAAY;IACpD,YAAY,OAAsB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAA0B;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAW,kBAAkB,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QACzF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF;AATD,oDASC;AAED,MAAa,sBAAuB,SAAQ,qBAAc;IACxD,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,MAA4B;QAC3C,yEAAyE;QACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAC5C,UAAU,EACV,EAAE,MAAM,EAAE,CACX,CAAC;QACF,OAAO,QAAQ,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CACF;AAlBD,wDAkBC"}

package/dist/src/index.d.ts

@@ -1,5 +1,7 @@
 /**
  * @module devices
  */
-export { QuantumDevicesClient } from './client';
-export type { Device, DevicePricing } from './types';
+export { QuantumDevicesClient, QuantumDevicesClientV1 } from './client';
+export type { Device, DevicePricing, DeviceQueryParams } from './types';
+export type { PlatformDevice, DeviceQueryParamsV1, DevicePricingV1, PricingModelV1, Vendor, DeviceType, ExperimentType, } from './types';
+export { DeviceStatus, DeviceVerification } 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.QuantumDevicesClient = void 0;
+exports.DeviceVerification = exports.DeviceStatus = exports.QuantumDevicesClientV1 = exports.QuantumDevicesClient = void 0;
 /**
  * @module devices
  */
 var client_1 = require("./client");
 Object.defineProperty(exports, "QuantumDevicesClient", { enumerable: true, get: function () { return client_1.QuantumDevicesClient; } });
+Object.defineProperty(exports, "QuantumDevicesClientV1", { enumerable: true, get: function () { return client_1.QuantumDevicesClientV1; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "DeviceStatus", { enumerable: true, get: function () { return types_1.DeviceStatus; } });
+Object.defineProperty(exports, "DeviceVerification", { enumerable: true, get: function () { return types_1.DeviceVerification; } });
 //# 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,mCAAgD;AAAvC,8GAAA,oBAAoB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAC9C,uBAAuB;;;AAEvB;;GAEG;AACH,mCAAwE;AAA/D,8GAAA,oBAAoB,OAAA;AAAE,gHAAA,sBAAsB,OAAA;AAerD,iCAA2D;AAAlD,qGAAA,YAAY,OAAA;AAAE,2GAAA,kBAAkB,OAAA"}

package/dist/src/types.d.ts

@@ -31,3 +31,95 @@ export interface DeviceQueryParams {
     runPackage?: string;
     [key: string]: unknown;
 }
+/**
+ * Enumeration for device verification statuses.
+ */
+export declare enum DeviceVerification {
+    VERIFIED = "verified",
+    UNVERIFIED = "unverified",
+    PENDING = "pending",
+    FAILED = "failed"
+}
+/**
+ * Enumeration for device operational statuses.
+ */
+export declare enum DeviceStatus {
+    ONLINE = "ONLINE",
+    UNAVAILABLE = "UNAVAILABLE",
+    OFFLINE = "OFFLINE",
+    RETIRED = "RETIRED"
+}
+/**
+ * Device type enumeration.
+ */
+export type DeviceType = 'SIMULATOR' | 'QPU';
+/**
+ * Vendor type enumeration.
+ */
+export type Vendor = 'aws' | 'azure' | 'ibm' | 'ionq' | 'qbraid' | 'NEEDS ADMIN APPROVAL';
+/**
+ * Experiment type / paradigm enumeration.
+ */
+export type ExperimentType = 'gate_model' | 'annealing' | 'analog' | 'other';
+/**
+ * Pricing model enumeration.
+ */
+export type PricingModelV1 = 'fixed' | 'dynamic';
+/**
+ * Device pricing information (V1).
+ */
+export interface DevicePricingV1 {
+    perTask: number;
+    perShot: number;
+    perMinute: number;
+}
+export interface RuntimeDevice {
+    name: string;
+    qrn: string;
+    vrn: string;
+    vendor: Vendor;
+    deviceType: DeviceType;
+    runInputTypes: string[];
+    status: DeviceStatus;
+    statusMsg?: string | null;
+    nextAvailable?: string | null;
+    queueDepth?: number | null;
+    avgQueueTime?: number | null;
+    numberQubits?: number | null;
+    modality?: string | null;
+    noiseModels?: string[] | null;
+    pricingModel?: PricingModelV1 | null;
+    pricing?: DevicePricingV1 | null;
+    directAccess: boolean;
+}
+/**
+ * Device V2 schema - complete device information matching Python PlatformDevice.
+ * Includes all fields from RuntimeDevice + platform-specific fields.
+ */
+export interface PlatformDevice extends RuntimeDevice {
+    providerId: string;
+    visibility: 'public' | 'private';
+    paradigm: ExperimentType;
+    verified: DeviceVerification;
+    requestedBy?: string | null;
+    pendingEdits?: unknown | null;
+    image?: string | null;
+    description?: string | null;
+    activeVersion?: string | null;
+    whiteListedDomains?: string[] | null;
+    blackListedDomains?: string[] | null;
+    notes?: string | null;
+}
+/**
+ * Query parameters for fetching devices (V1).
+ */
+export interface DeviceQueryParamsV1 {
+    qrn?: string;
+    vendor?: Vendor;
+    deviceType?: DeviceType;
+    status?: DeviceStatus;
+    visibility?: 'public' | 'private';
+    paradigm?: ExperimentType;
+    verified?: DeviceVerification;
+    providerId?: string;
+}

package/dist/src/types.js

@@ -2,4 +2,26 @@
 // Copyright (c) 2025, qBraid Development Team
 // All rights reserved.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceStatus = exports.DeviceVerification = void 0;
+// ==================== V1 Types ====================
+/**
+ * Enumeration for device verification statuses.
+ */
+var DeviceVerification;
+(function (DeviceVerification) {
+    DeviceVerification["VERIFIED"] = "verified";
+    DeviceVerification["UNVERIFIED"] = "unverified";
+    DeviceVerification["PENDING"] = "pending";
+    DeviceVerification["FAILED"] = "failed";
+})(DeviceVerification || (exports.DeviceVerification = DeviceVerification = {}));
+/**
+ * Enumeration for device operational statuses.
+ */
+var DeviceStatus;
+(function (DeviceStatus) {
+    DeviceStatus["ONLINE"] = "ONLINE";
+    DeviceStatus["UNAVAILABLE"] = "UNAVAILABLE";
+    DeviceStatus["OFFLINE"] = "OFFLINE";
+    DeviceStatus["RETIRED"] = "RETIRED";
+})(DeviceStatus || (exports.DeviceStatus = DeviceStatus = {}));
 //# 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;;;AAwCvB,qDAAqD;AAErD;;GAEG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,2CAAqB,CAAA;IACrB,+CAAyB,CAAA;IACzB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;AACnB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAED;;GAEG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;AACrB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@qbraid-core/devices",
   "description": "Client for the qBraid Quantum Devices service.",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "author": "qBraid Development Team",
@@ -37,7 +37,7 @@
   },
   "dependencies": {},
   "peerDependencies": {
-    "@qbraid-core/base": "0.11.0"
+    "@qbraid-core/base": "0.12.1"
   },
   "scripts": {
     "clean": "rimraf dist tsconfig.tsbuildinfo src/*.d.ts src/*.js",