@quantum-hub/qhub-service 1.7.0 → 1.8.1

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.7.0",
+  "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",