@quantum-hub/qhub-service 1.0.0

package/README.md

@@ -0,0 +1,44 @@
+# Kipu Quantum Hub Service SDK
+
+## Installation
+
+The package can be installed using `npm`:
+
+```bash
+npm install @quantum-hub/qhub-service
+```
+
+## Usage
+
+```typescript
+const serviceEndpoint = "..."
+const accessKeyId = "..."
+const secretAccessKey = "..."
+
+// Create a new client instance
+const client = new HubServiceClient(serviceEndpoint, accessKeyId, secretAccessKey)
+
+// List all service executions
+const serviceExecutions = await client.api().getServiceExecutions()
+
+// Start a new service execution
+let serviceExecution = await client.api().startExecution({n_coin_tosses: 2, shots: 100}, {timeoutInSeconds: 60})
+
+// Check the status of the service execution
+serviceExecution = await client.api().getStatus({id: serviceExecution.id!})
+
+// Wait for the service execution to finish
+const finalStates = ["SUCCEEDED", "CANCELLED", "FAILED"]
+while (!finalStates.includes(serviceExecution.status!)) {
+  serviceExecution = await client.api().getStatus({id: serviceExecution.id!})
+}
+
+// Get the result of the service execution
+const result = await client.api().getResult({id: serviceExecution.id!})
+
+// Get the logs of the service execution
+const logs = await client.api().getLogs({id: serviceExecution.id!})
+
+// Cancel the service execution if it is still pending or running
+await client.api().cancelExecution({id: serviceExecution.id!})
+```

package/dist/client.d.ts

@@ -0,0 +1,19 @@
+import { HubServiceClient as BaseHubServiceClient } from '@quantum-hub/qhub-api/service';
+type ServiceApiClient = InstanceType<typeof BaseHubServiceClient>['serviceApi'];
+export declare const DEFAULT_TOKEN_ENDPOINT = "https://gateway.hub.kipu-quantum.com/token";
+export declare class HubServiceAuth {
+    private accessToken;
+    private readonly accessKeyId;
+    private readonly secretAccessKey;
+    private readonly tokenEndpoint;
+    constructor(accessKeyId: string, secretAccessKey: string, tokenEndpoint?: string);
+    getAccessToken(): Promise<string>;
+    private fetchAccessToken;
+}
+export declare class HubServiceClient {
+    private _api;
+    constructor(serviceEndpoint: string, accessKeyId?: string, secretAccessKey?: string, tokenEndpoint?: string);
+    api(): ServiceApiClient;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,IAAI,oBAAoB,EAAC,MAAM,+BAA+B,CAAA;AAEtF,KAAK,gBAAgB,GAAG,YAAY,CAAC,OAAO,oBAAoB,CAAC,CAAC,YAAY,CAAC,CAAA;AAE/E,eAAO,MAAM,sBAAsB,+CAA+C,CAAA;AAElF,qBAAa,cAAc;IACzB,OAAO,CAAC,WAAW,CAAyB;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;gBAE1B,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,GAAE,MAA+B;IAMlG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAYvC,OAAO,CAAC,gBAAgB;CAiBzB;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,IAAI,CAAsB;gBAEtB,eAAe,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,aAAa,GAAE,MAA+B;IAe5H,GAAG,IAAI,gBAAgB;CAG/B"}

package/dist/client.js

@@ -0,0 +1,61 @@
+import { ClientCredentials } from 'simple-oauth2';
+import { HubServiceClient as BaseHubServiceClient } from '@quantum-hub/qhub-api/service';
+export const DEFAULT_TOKEN_ENDPOINT = 'https://gateway.hub.kipu-quantum.com/token';
+export class HubServiceAuth {
+    accessToken;
+    accessKeyId;
+    secretAccessKey;
+    tokenEndpoint;
+    constructor(accessKeyId, secretAccessKey, tokenEndpoint = DEFAULT_TOKEN_ENDPOINT) {
+        this.accessKeyId = accessKeyId;
+        this.secretAccessKey = secretAccessKey;
+        this.tokenEndpoint = tokenEndpoint;
+    }
+    async getAccessToken() {
+        if (!this.accessToken) {
+            this.accessToken = await this.fetchAccessToken();
+        }
+        if (this.accessToken.expired()) {
+            this.accessToken = await this.accessToken.refresh();
+        }
+        return this.accessToken.token.access_token;
+    }
+    fetchAccessToken() {
+        const client = new ClientCredentials({
+            auth: {
+                tokenHost: this.tokenEndpoint,
+                tokenPath: '/token',
+            },
+            client: {
+                id: this.accessKeyId,
+                secret: this.secretAccessKey,
+            },
+            options: {
+                authorizationMethod: 'body',
+                bodyFormat: 'form'
+            }
+        });
+        return client.getToken({});
+    }
+}
+export class HubServiceClient {
+    _api;
+    constructor(serviceEndpoint, accessKeyId, secretAccessKey, tokenEndpoint = DEFAULT_TOKEN_ENDPOINT) {
+        if (accessKeyId && secretAccessKey) {
+            const auth = new HubServiceAuth(accessKeyId, secretAccessKey, tokenEndpoint);
+            this._api = new BaseHubServiceClient({
+                environment: () => serviceEndpoint,
+                token: async () => auth.getAccessToken(),
+            });
+        }
+        else {
+            this._api = new BaseHubServiceClient({
+                environment: () => serviceEndpoint,
+                token: async () => Math.random().toString(36).slice(2),
+            });
+        }
+    }
+    api() {
+        return this._api.serviceApi;
+    }
+}

package/dist/datapool.d.ts

@@ -0,0 +1,12 @@
+export declare enum ReferenceType {
+    DATAPOOL = "DATAPOOL"
+}
+export interface DataPoolReference {
+    id: string;
+    ref: ReferenceType;
+}
+/**
+ * Factory function to create DataPoolReference objects with ref always set to DATAPOOL.
+ */
+export declare function withDataPoolReference(id: string): DataPoolReference;
+//# sourceMappingURL=datapool.d.ts.map

package/dist/datapool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"datapool.d.ts","sourceRoot":"","sources":["../src/datapool.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa;IACvB,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,aAAa,CAAA;CACnB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAKnE"}

package/dist/datapool.js

@@ -0,0 +1,13 @@
+export var ReferenceType;
+(function (ReferenceType) {
+    ReferenceType["DATAPOOL"] = "DATAPOOL";
+})(ReferenceType || (ReferenceType = {}));
+/**
+ * Factory function to create DataPoolReference objects with ref always set to DATAPOOL.
+ */
+export function withDataPoolReference(id) {
+    return {
+        id,
+        ref: ReferenceType.DATAPOOL,
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client.js';
+export * from './datapool.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './client.js';
+export * from './datapool.js';

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@quantum-hub/qhub-service",
+  "version": "1.0.0",
+  "description": "SDK to interact with managed services on the Kipu Quantum Hub.",
+  "author": "Kipu Quantum GmbH",
+  "contributors": [
+    "Harzenetter, Lukas <lukas.harzenetter@kipu-quantum.com>",
+    "Wurster, Michael <michael.wurster@kipu-quantum.com>"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@quantum-hub/qhub-api": "^1",
+    "simple-oauth2": "^5"
+  },
+  "devDependencies": {
+    "@types/node": "^22",
+    "@types/simple-oauth2": "^5",
+    "dotenv": "^17",
+    "eslint": "^9",
+    "shx": "^0.4.0",
+    "typescript": "^5",
+    "typescript-eslint": "^8",
+    "vitest": "^4"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}