@quantum-hub/qhub-service 1.2.2 → 1.3.0

package/dist/client.d.ts

@@ -1,6 +1,24 @@
-import { HubServiceClient as BaseHubServiceClient, type HubService } from '@quantum-hub/qhub-api/service';
+import { type HubService, HubServiceClient as BaseHubServiceClient } from '@quantum-hub/qhub-api/service';
+import { HubPlatformClient as BaseHubPlatformClient } from '@quantum-hub/qhub-api/platform';
+import { type DataPoolGrant } from './datapool.js';
 type ServiceApiClient = InstanceType<typeof BaseHubServiceClient>['serviceApi'];
+type DataPoolGrantsClient = InstanceType<typeof BaseHubPlatformClient>['dataPoolGrants'];
 export declare const DEFAULT_TOKEN_ENDPOINT = "https://gateway.hub.kipu-quantum.com/token";
+export interface HubPlatformClientOptions {
+    apiKey: string;
+    platformEndpoint?: string;
+    organizationId?: string;
+}
+export declare class HubPlatformClient {
+    private _client;
+    private readonly _organizationId;
+    constructor(options: HubPlatformClientOptions);
+    get organizationId(): string | undefined;
+    get dataPoolGrants(): DataPoolGrantsClient;
+}
+export interface RunOptions {
+    grants?: DataPoolGrant[];
+}
 export declare class HubServiceAuth {
     private accessToken;
     private readonly accessKeyId;
@@ -12,9 +30,12 @@ export declare class HubServiceAuth {
 }
 export declare class HubServiceClient {
     private _api;
-    constructor(serviceEndpoint: string, accessKeyId?: string, secretAccessKey?: string, tokenEndpoint?: string);
+    private readonly _platform;
+    private _grantCache;
+    constructor(serviceEndpoint: string, accessKeyId?: string, secretAccessKey?: string, tokenEndpoint?: string, platformClient?: HubPlatformClient);
     api(): ServiceApiClient;
-    run(request: Record<string, unknown>, secrets?: Record<string, unknown>, tags?: string[]): Promise<HubService.ServiceExecution>;
+    run(request: Record<string, unknown>, secrets?: Record<string, unknown>, tags?: string[], options?: RunOptions): Promise<HubService.ServiceExecution>;
+    private _acquireGrant;
 }
 export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,IAAI,oBAAoB,EAAE,KAAK,UAAU,EAAC,MAAM,+BAA+B,CAAA;AAEvG,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;IAIjB,GAAG,CACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,IAAI,CAAC,EAAE,MAAM,EAAE,GACd,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;CASxC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,KAAK,UAAU,EAAE,gBAAgB,IAAI,oBAAoB,EAAC,MAAM,+BAA+B,CAAA;AACvG,OAAO,EAAC,iBAAiB,IAAI,qBAAqB,EAAC,MAAM,gCAAgC,CAAA;AACzF,OAAO,EAAC,KAAK,aAAa,EAAgB,MAAM,eAAe,CAAA;AAE/D,KAAK,gBAAgB,GAAG,YAAY,CAAC,OAAO,oBAAoB,CAAC,CAAC,YAAY,CAAC,CAAA;AAC/E,KAAK,oBAAoB,GAAG,YAAY,CAAC,OAAO,qBAAqB,CAAC,CAAC,gBAAgB,CAAC,CAAA;AAExF,eAAO,MAAM,sBAAsB,+CAA+C,CAAA;AAIlF,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAoB;gBAExC,OAAO,EAAE,wBAAwB;IAQ7C,IAAI,cAAc,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED,IAAI,cAAc,IAAI,oBAAoB,CAEzC;CACF;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;CACzB;AAED,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;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA+B;IACzD,OAAO,CAAC,WAAW,CAAuD;gBAGtE,eAAe,EAAE,MAAM,EACvB,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,EACxB,aAAa,GAAE,MAA+B,EAC9C,cAAc,CAAC,EAAE,iBAAiB;IAkB/B,GAAG,IAAI,gBAAgB;IAIjB,GAAG,CACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,IAAI,CAAC,EAAE,MAAM,EAAE,EACf,OAAO,CAAC,EAAE,UAAU,GACrB,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;YAwBzB,aAAa;CAkB5B"}

package/dist/client.js

@@ -1,6 +1,26 @@
 import { ClientCredentials } from 'simple-oauth2';
 import { HubServiceClient as BaseHubServiceClient } from '@quantum-hub/qhub-api/service';
+import { HubPlatformClient as BaseHubPlatformClient } from '@quantum-hub/qhub-api/platform';
+import { ReferenceType } from './datapool.js';
 export const DEFAULT_TOKEN_ENDPOINT = 'https://gateway.hub.kipu-quantum.com/token';
+const GRANT_CACHE_BUFFER_SECONDS = 30;
+export class HubPlatformClient {
+    _client;
+    _organizationId;
+    constructor(options) {
+        this._client = new BaseHubPlatformClient({
+            apiKey: options.apiKey,
+            ...(options.platformEndpoint ? { environment: () => options.platformEndpoint } : {}),
+        });
+        this._organizationId = options.organizationId;
+    }
+    get organizationId() {
+        return this._organizationId;
+    }
+    get dataPoolGrants() {
+        return this._client.dataPoolGrants;
+    }
+}
 export class HubServiceAuth {
     accessToken;
     accessKeyId;
@@ -40,7 +60,9 @@ export class HubServiceAuth {
 }
 export class HubServiceClient {
     _api;
-    constructor(serviceEndpoint, accessKeyId, secretAccessKey, tokenEndpoint = DEFAULT_TOKEN_ENDPOINT) {
+    _platform;
+    _grantCache = new Map();
+    constructor(serviceEndpoint, accessKeyId, secretAccessKey, tokenEndpoint = DEFAULT_TOKEN_ENDPOINT, platformClient) {
         if (accessKeyId && secretAccessKey) {
             const auth = new HubServiceAuth(accessKeyId, secretAccessKey, tokenEndpoint);
             this._api = new BaseHubServiceClient({
@@ -54,17 +76,48 @@ export class HubServiceClient {
                 token: async () => Math.random().toString(36).slice(2),
             });
         }
+        this._platform = platformClient;
     }
     api() {
         return this._api.serviceApi;
     }
-    async run(request, secrets, tags) {
+    async run(request, secrets, tags, options) {
         if (tags !== undefined && !('$tags' in request)) {
             request['$tags'] = tags;
         }
         if (secrets !== undefined && !('$secrets' in request)) {
             request['$secrets'] = secrets;
         }
+        if (options?.grants) {
+            if (!this._platform) {
+                throw new Error('apiKey is required for data pool grant acquisition');
+            }
+            await Promise.all(options.grants.map(async (g) => {
+                const token = await this._acquireGrant(g.datapoolId, g.applicationId, g.permission ?? 'MODIFY');
+                request[g.name] = { id: g.datapoolId, ref: ReferenceType.DATAPOOL, grant: token };
+            }));
+        }
         return this.api().startExecution(request);
     }
+    async _acquireGrant(datapoolId, applicationId, permission) {
+        const cacheKey = `${datapoolId}:${applicationId}:${permission}`;
+        const cached = this._grantCache.get(cacheKey);
+        if (cached && Date.now() / 1000 < cached.expiry - GRANT_CACHE_BUFFER_SECONDS) {
+            return cached.token;
+        }
+        const grant = await this._platform.dataPoolGrants.createGrant(datapoolId, {
+            applicationId,
+            permission,
+            'X-OrganizationId': this._platform.organizationId,
+        });
+        const token = grant.token;
+        const expiry = parseJwtExpiry(token);
+        this._grantCache.set(cacheKey, { token, expiry });
+        return token;
+    }
+}
+function parseJwtExpiry(token) {
+    const payload = token.split('.')[1];
+    const decoded = JSON.parse(atob(payload));
+    return decoded.exp ?? 0;
 }

package/dist/datapool.d.ts

@@ -1,9 +1,20 @@
 export declare enum ReferenceType {
     DATAPOOL = "DATAPOOL"
 }
+export declare enum DataPoolPermission {
+    VIEW = "VIEW",
+    MODIFY = "MODIFY"
+}
 export interface DataPoolReference {
     id: string;
     ref: ReferenceType;
+    grant?: string;
+}
+export interface DataPoolGrant {
+    name: string;
+    datapoolId: string;
+    applicationId: string;
+    permission?: DataPoolPermission;
 }
 /**
  * Factory function to create DataPoolReference objects with ref always set to DATAPOOL.

package/dist/datapool.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"datapool.d.ts","sourceRoot":"","sources":["../src/datapool.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa;IACvB,QAAQ,aAAa;CACtB;AAED,oBAAY,kBAAkB;IAC5B,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,aAAa,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,kBAAkB,CAAA;CAChC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,iBAAiB,CAKnE"}

package/dist/datapool.js

@@ -2,6 +2,11 @@ export var ReferenceType;
 (function (ReferenceType) {
     ReferenceType["DATAPOOL"] = "DATAPOOL";
 })(ReferenceType || (ReferenceType = {}));
+export var DataPoolPermission;
+(function (DataPoolPermission) {
+    DataPoolPermission["VIEW"] = "VIEW";
+    DataPoolPermission["MODIFY"] = "MODIFY";
+})(DataPoolPermission || (DataPoolPermission = {}));
 /**
  * Factory function to create DataPoolReference objects with ref always set to DATAPOOL.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantum-hub/qhub-service",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "SDK to interact with managed services on the Kipu Quantum Hub.",
   "author": "Kipu Quantum GmbH",
   "contributors": [