@quantum-hub/qhub-service 1.6.2 → 1.8.1

package/dist/client.d.ts

@@ -1,5 +1,5 @@
-import { type HubService, HubServiceClient as BaseHubServiceClient } from '@quantum-hub/qhub-api/service';
 import { HubPlatformClient as BaseHubPlatformClient } from '@quantum-hub/qhub-api/platform';
+import { type HubService, HubServiceClient as BaseHubServiceClient } from '@quantum-hub/qhub-api/service';
 import { type DataPoolGrant } from './datapool.js';
 type ServiceApiClient = InstanceType<typeof BaseHubServiceClient>['serviceApi'];
 type DataPoolGrantsClient = InstanceType<typeof BaseHubPlatformClient>['dataPoolGrants'];

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,IAAI,qBAAqB,EAAC,MAAM,gCAAgC,CAAA;AACzF,OAAO,EAAC,KAAK,UAAU,EAAE,gBAAgB,IAAI,oBAAoB,EAAC,MAAM,+BAA+B,CAAA;AAEvG,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;AAOlF,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;IAsB/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,9 +1,11 @@
-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 { HubServiceClient as BaseHubServiceClient } from '@quantum-hub/qhub-api/service';
+import { ClientCredentials } from 'simple-oauth2';
 import { ReferenceType } from './datapool.js';
 export const DEFAULT_TOKEN_ENDPOINT = 'https://gateway.hub.kipu-quantum.com/token';
 const GRANT_CACHE_BUFFER_SECONDS = 30;
+const PARENT_EXECUTION_TOKEN_ENV = 'KQH_SERVICE_EXECUTION_TOKEN';
+const PARENT_EXECUTION_TOKEN_HEADER = 'X-Parent-Execution-Token';
 export class HubPlatformClient {
     _client;
     _organizationId;
@@ -63,17 +65,20 @@ export class HubServiceClient {
     _platform;
     _grantCache = new Map();
     constructor(serviceEndpoint, accessKeyId, secretAccessKey, tokenEndpoint = DEFAULT_TOKEN_ENDPOINT, platformClient) {
+        const headers = resolveParentExecutionTokenHeader();
         if (accessKeyId && secretAccessKey) {
             const auth = new HubServiceAuth(accessKeyId, secretAccessKey, tokenEndpoint);
             this._api = new BaseHubServiceClient({
                 environment: () => serviceEndpoint,
                 token: async () => auth.getAccessToken(),
+                ...(headers ? { headers } : {}),
             });
         }
         else {
             this._api = new BaseHubServiceClient({
                 environment: () => serviceEndpoint,
                 token: async () => Math.random().toString(36).slice(2),
+                ...(headers ? { headers } : {}),
             });
         }
         this._platform = platformClient;
@@ -105,7 +110,7 @@ export class HubServiceClient {
         if (cached && Date.now() / 1000 < cached.expiry - GRANT_CACHE_BUFFER_SECONDS) {
             return cached.token;
         }
-        const grant = await this._platform.dataPoolGrants.createGrant(datapoolId, {
+        const grant = await this._platform.dataPoolGrants.createDataPoolGrant(datapoolId, {
             applicationId,
             permission,
             'X-OrganizationId': this._platform.organizationId,
@@ -116,6 +121,13 @@ export class HubServiceClient {
         return token;
     }
 }
+function resolveParentExecutionTokenHeader() {
+    const token = process.env[PARENT_EXECUTION_TOKEN_ENV];
+    if (!token) {
+        return undefined;
+    }
+    return { [PARENT_EXECUTION_TOKEN_HEADER]: token };
+}
 function parseJwtExpiry(token) {
     const payload = token.split('.')[1];
     const decoded = JSON.parse(atob(payload));

package/dist/index.d.ts

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

package/dist/index.d.ts.map

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

package/dist/index.js

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

package/dist/result.d.ts

@@ -0,0 +1,28 @@
+import type { HubService } from '@quantum-hub/qhub-api/service';
+/**
+ * A service execution result that separates the service-computed values
+ * (Result data) from the Execution metadata and Result files.
+ *
+ * Construct with {@link ExecutionResult.from}. The service output is never
+ * spread onto the wrapper, so a service field named `data`/`metadata`/`files`
+ * cannot shadow a view method; reach such a field via `result.raw.<field>`.
+ */
+export declare class ExecutionResult {
+    readonly raw: HubService.ResultResponse;
+    private constructor();
+    /** Wrap a raw ResultResponse, e.g. from `client.api().getResult(id)`. */
+    static from(raw: HubService.ResultResponse): ExecutionResult;
+    /**
+     * The service-computed values: every top-level field except the HAL
+     * envelope keys `_links`/`_embedded`. Empty object when none.
+     */
+    data<T = Record<string, unknown>>(): T;
+    /** The embedded execution resource (`_embedded.status`), or `undefined`. */
+    metadata(): HubService.ServiceExecution | undefined;
+    /**
+     * Downloadable result file names, excluding the navigational `status` and
+     * `self` links. Empty array when there are no links.
+     */
+    files(): string[];
+}
+//# sourceMappingURL=result.d.ts.map

package/dist/result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,+BAA+B,CAAA;AAM7D;;;;;;;GAOG;AACH,qBAAa,eAAe;aACY,GAAG,EAAE,UAAU,CAAC,cAAc;IAAlE,OAAO;IAEP,yEAAyE;IACzE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,cAAc,GAAG,eAAe;IAI5D;;;OAGG;IACH,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC;IAMtC,4EAA4E;IAC5E,QAAQ,IAAI,UAAU,CAAC,gBAAgB,GAAG,SAAS;IAInD;;;OAGG;IACH,KAAK,IAAI,MAAM,EAAE;CAGpB"}

package/dist/result.js

@@ -0,0 +1,41 @@
+// HAL navigational links to exclude from result files. `self` is present at
+// runtime but is not declared in the Fern `ResultResponse.Links` type.
+const NAVIGATIONAL_LINKS = ['status', 'self'];
+/**
+ * A service execution result that separates the service-computed values
+ * (Result data) from the Execution metadata and Result files.
+ *
+ * Construct with {@link ExecutionResult.from}. The service output is never
+ * spread onto the wrapper, so a service field named `data`/`metadata`/`files`
+ * cannot shadow a view method; reach such a field via `result.raw.<field>`.
+ */
+export class ExecutionResult {
+    raw;
+    constructor(raw) {
+        this.raw = raw;
+    }
+    /** Wrap a raw ResultResponse, e.g. from `client.api().getResult(id)`. */
+    static from(raw) {
+        return new ExecutionResult(raw);
+    }
+    /**
+     * The service-computed values: every top-level field except the HAL
+     * envelope keys `_links`/`_embedded`. Empty object when none.
+     */
+    data() {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { _links, _embedded, ...rest } = this.raw;
+        return rest;
+    }
+    /** The embedded execution resource (`_embedded.status`), or `undefined`. */
+    metadata() {
+        return this.raw._embedded?.status;
+    }
+    /**
+     * Downloadable result file names, excluding the navigational `status` and
+     * `self` links. Empty array when there are no links.
+     */
+    files() {
+        return Object.keys(this.raw._links ?? {}).filter((rel) => !NAVIGATIONAL_LINKS.includes(rel));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantum-hub/qhub-service",
-  "version": "1.6.2",
+  "version": "1.8.1",
   "description": "SDK to interact with managed services on the Kipu Quantum Hub.",
   "author": "Kipu Quantum GmbH",
   "contributors": [
@@ -31,6 +31,10 @@
     "@quantum-hub/qhub-api": "^1",
     "simple-oauth2": "^5"
   },
+  "overrides": {
+    "form-data": ">=4.0.6",
+    "joi": ">=17.13.4"
+  },
   "devDependencies": {
     "@types/node": "^22",
     "@types/simple-oauth2": "^5",