@oystehr/sdk 3.0.2 → 3.0.3

package/dist/cjs/client/client.d.ts

@@ -1,5 +1,6 @@
 import { OystehrConfig } from '../config';
 import { FhirBundle, FhirResource } from '../resources/types';
+export declare const defaultProjectApiUrl = "https://project-api.zapehr.com/v1";
 /**
  * Optional parameter that can be passed to the client methods. It allows
  * overriding the access token or project ID, and setting various headers,
@@ -29,7 +30,7 @@ interface InternalClientRequest extends OystehrClientRequest {
 type FhirData<T extends FhirResource> = T | T[] | FhirBundle<T>;
 export type FhirFetcherResponse<T extends FhirData<FhirResource> = any> = T;
 export declare class SDKResource {
-    private readonly config;
+    protected readonly config: OystehrConfig;
     constructor(config: OystehrConfig);
     protected request(path: string, method: string): FetcherFunction;
     protected fhirRequest<T extends FhirResource = any>(path: string, method: string): (params: any, request?: InternalClientRequest) => Promise<FhirFetcherResponse<T>>;

package/dist/cjs/index.cjs

@@ -1161,6 +1161,11 @@ class Version extends SDKResource {
     }
 }
 
+/**
+ * Uploads a file to the bucket and key. Files should be Blobs.
+ *
+ * @param params upload file params
+ */
 function uploadFile$1({ bucketName, 'objectPath+': key, file, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const uploadUrl = yield this.request('/z3/{bucketName}/{objectPath+}', 'post')({
@@ -1174,6 +1179,11 @@ function uploadFile$1({ bucketName, 'objectPath+': key, file, }) {
         });
     });
 }
+/**
+ * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.
+ *
+ * @param params download file params
+ */
 function downloadFile({ bucketName, 'objectPath+': key, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const uploadUrl = yield this.request('/z3/{bucketName}/{objectPath+}', 'post')({
@@ -1190,13 +1200,64 @@ function downloadFile({ bucketName, 'objectPath+': key, }) {
         return resp.arrayBuffer();
     });
 }
+/**
+ * This helper performs a `getPresignedUrl` request for Z3 URLs of the forms
+ * `https://projects-api.oystehr.com/v1/z3/<bucket>/<key>` or `z3://<bucket>/<key>`
+ * instead of the standard SDK `Z3GetPresignedUrlParams`.
+ *
+ * @param params url and action
+ */
+function getPresignedUrlForZ3Url(params) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        let bucket;
+        let key;
+        const url = new URL(params.url);
+        if (url.protocol === 'z3:') {
+            // remove leading forward slash
+            const z3PathParts = url.pathname.split('/').slice(1);
+            bucket = url.hostname;
+            key = z3PathParts.join('/');
+        }
+        else if (url.href.startsWith((_a = this.config.projectApiUrl) !== null && _a !== void 0 ? _a : defaultProjectApiUrl)) {
+            // remove leading `/v1/z3`
+            const httpsPathParts = url.pathname.split('/').slice(3);
+            bucket = httpsPathParts[0];
+            key = httpsPathParts.slice(1).join('/');
+        }
+        else {
+            throw new OystehrSdkError({ message: 'Invalid Z3 URL', code: 400 });
+        }
+        const requestParams = {
+            action: 'upload',
+            bucketName: bucket,
+            'objectPath+': key,
+        };
+        return this.request('/z3/{bucketName}/{objectPath+}', 'post')(requestParams);
+    });
+}
 
 // AUTOGENERATED -- DO NOT EDIT
 class Z3 extends SDKResource {
     constructor(config) {
         super(config);
+        /**
+         * Uploads a file to the bucket and key. Files should be Blobs.
+         * @param params upload file params
+         */
         this.uploadFile = uploadFile$1;
+        /**
+         * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.
+         * @param params download file params
+         */
         this.downloadFile = downloadFile;
+        /**
+         * This helper performs a `getPresignedUrl` request for Z3 URLs of the forms
+         * `https://projects-api.oystehr.com/v1/z3/<bucket>/<key>` * or `z3://<bucket>/<key>`
+         * instead of the standard SDK `Z3GetPresignedUrlParams`.
+         * @param params url and action
+         */
+        this.getPresignedUrlForZ3Url = getPresignedUrlForZ3Url;
         /**
          * List all Z3 Buckets. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.
          *