@oystehr/sdk 3.0.2 → 3.0.3

package/dist/esm/resources/classes/z3-ext.d.ts

@@ -1,10 +1,32 @@
 import { SDKResource } from '../../client/client';
+import { Z3GetPresignedUrlParams, Z3GetPresignedUrlResponse } from '../types';
+/**
+ * Uploads a file to the bucket and key. Files should be Blobs.
+ *
+ * @param params upload file params
+ */
 export declare function uploadFile(this: SDKResource, { bucketName, 'objectPath+': key, file, }: {
     bucketName: string;
     'objectPath+': string;
     file: Blob;
 }): Promise<void>;
+/**
+ * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.
+ *
+ * @param params download file params
+ */
 export declare function downloadFile(this: SDKResource, { bucketName, 'objectPath+': key, }: {
     bucketName: string;
     'objectPath+': string;
 }): Promise<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
+ */
+export declare function getPresignedUrlForZ3Url(this: SDKResource, params: {
+    url: string;
+    action: Z3GetPresignedUrlParams['action'];
+}): Promise<Z3GetPresignedUrlResponse>;

package/dist/esm/resources/classes/z3-ext.js

@@ -1,5 +1,12 @@
 import { __awaiter } from '../../node_modules/tslib/tslib.es6.js';
+import { defaultProjectApiUrl } from '../../client/client.js';
+import { OystehrSdkError } from '../../errors/index.js';
 
+/**
+ * Uploads a file to the bucket and key. Files should be Blobs.
+ *
+ * @param params upload file params
+ */
 function uploadFile({ bucketName, 'objectPath+': key, file, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const uploadUrl = yield this.request('/z3/{bucketName}/{objectPath+}', 'post')({
@@ -13,6 +20,11 @@ function uploadFile({ 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')({
@@ -29,6 +41,42 @@ 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);
+    });
+}
 
-export { downloadFile, uploadFile };
+export { downloadFile, getPresignedUrlForZ3Url, uploadFile };
 //# sourceMappingURL=z3-ext.js.map

package/dist/esm/resources/classes/z3-ext.js.map

@@ -1 +1 @@
-{"version":3,"file":"z3-ext.js","sources":["../../../../src/resources/classes/z3-ext.ts"],"sourcesContent":["import { SDKResource } from '../../client/client';\n\nexport async function uploadFile(\n  this: SDKResource,\n  {\n    bucketName,\n    'objectPath+': key,\n    file,\n  }: {\n    bucketName: string;\n    'objectPath+': string;\n    file: Blob;\n  }\n): Promise<void> {\n  const uploadUrl = await this.request(\n    '/z3/{bucketName}/{objectPath+}',\n    'post'\n  )({\n    action: 'upload',\n    bucketName,\n    'objectPath+': key,\n  });\n  await fetch(uploadUrl.signedUrl, {\n    method: 'PUT',\n    body: file,\n  });\n}\n\nexport async function downloadFile(\n  this: SDKResource,\n  {\n    bucketName,\n    'objectPath+': key,\n  }: {\n    bucketName: string;\n    'objectPath+': string;\n  }\n): Promise<ArrayBuffer> {\n  const uploadUrl = await this.request(\n    '/z3/{bucketName}/{objectPath+}',\n    'post'\n  )({\n    action: 'download',\n    bucketName,\n    'objectPath+': key,\n  });\n  const resp = await fetch(uploadUrl.signedUrl, {\n    method: 'GET',\n  });\n  if (!resp.ok) {\n    throw new Error('Failed to download file');\n  }\n  return resp.arrayBuffer();\n}\n"],"names":[],"mappings":";;AAEM,SAAgB,UAAU,CAE9B,EACE,UAAU,EACV,aAAa,EAAE,GAAG,EAClB,IAAI,GAKL,EAAA;;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAClC,gCAAgC,EAChC,MAAM,CACP,CAAC;AACA,YAAA,MAAM,EAAE,QAAQ;YAChB,UAAU;AACV,YAAA,aAAa,EAAE,GAAG;AACnB,SAAA,CAAC,CAAC;AACH,QAAA,MAAM,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE;AAC/B,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,IAAI,EAAE,IAAI;AACX,SAAA,CAAC,CAAC;KACJ,CAAA,CAAA;AAAA,CAAA;AAEK,SAAgB,YAAY,CAEhC,EACE,UAAU,EACV,aAAa,EAAE,GAAG,GAInB,EAAA;;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAClC,gCAAgC,EAChC,MAAM,CACP,CAAC;AACA,YAAA,MAAM,EAAE,UAAU;YAClB,UAAU;AACV,YAAA,aAAa,EAAE,GAAG;AACnB,SAAA,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE;AAC5C,YAAA,MAAM,EAAE,KAAK;AACd,SAAA,CAAC,CAAC;AACH,QAAA,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;AACZ,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAC5C,SAAA;AACD,QAAA,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;KAC3B,CAAA,CAAA;AAAA;;;;"}
+{"version":3,"file":"z3-ext.js","sources":["../../../../src/resources/classes/z3-ext.ts"],"sourcesContent":["import { defaultProjectApiUrl, SDKResource } from '../../client/client';\nimport { OystehrSdkError } from '../../errors';\nimport { Z3GetPresignedUrlParams, Z3GetPresignedUrlResponse } from '../types';\n\n/**\n * Uploads a file to the bucket and key. Files should be Blobs.\n *\n * @param params upload file params\n */\nexport async function uploadFile(\n  this: SDKResource,\n  {\n    bucketName,\n    'objectPath+': key,\n    file,\n  }: {\n    bucketName: string;\n    'objectPath+': string;\n    file: Blob;\n  }\n): Promise<void> {\n  const uploadUrl = await this.request(\n    '/z3/{bucketName}/{objectPath+}',\n    'post'\n  )({\n    action: 'upload',\n    bucketName,\n    'objectPath+': key,\n  });\n  await fetch(uploadUrl.signedUrl, {\n    method: 'PUT',\n    body: file,\n  });\n}\n\n/**\n * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.\n *\n * @param params download file params\n */\nexport async function downloadFile(\n  this: SDKResource,\n  {\n    bucketName,\n    'objectPath+': key,\n  }: {\n    bucketName: string;\n    'objectPath+': string;\n  }\n): Promise<ArrayBuffer> {\n  const uploadUrl = await this.request(\n    '/z3/{bucketName}/{objectPath+}',\n    'post'\n  )({\n    action: 'download',\n    bucketName,\n    'objectPath+': key,\n  });\n  const resp = await fetch(uploadUrl.signedUrl, {\n    method: 'GET',\n  });\n  if (!resp.ok) {\n    throw new Error('Failed to download file');\n  }\n  return resp.arrayBuffer();\n}\n\n/**\n * This helper performs a `getPresignedUrl` request for Z3 URLs of the forms\n * `https://projects-api.oystehr.com/v1/z3/<bucket>/<key>` or `z3://<bucket>/<key>`\n * instead of the standard SDK `Z3GetPresignedUrlParams`.\n *\n * @param params url and action\n */\nexport async function getPresignedUrlForZ3Url(\n  this: SDKResource,\n  params: { url: string; action: Z3GetPresignedUrlParams['action'] }\n): Promise<Z3GetPresignedUrlResponse> {\n  let bucket: string;\n  let key: string;\n  const url = new URL(params.url);\n  if (url.protocol === 'z3:') {\n    // remove leading forward slash\n    const z3PathParts = url.pathname.split('/').slice(1);\n    bucket = url.hostname;\n    key = z3PathParts.join('/');\n  } else if (url.href.startsWith(this.config.projectApiUrl ?? defaultProjectApiUrl)) {\n    // remove leading `/v1/z3`\n    const httpsPathParts = url.pathname.split('/').slice(3);\n    bucket = httpsPathParts[0];\n    key = httpsPathParts.slice(1).join('/');\n  } else {\n    throw new OystehrSdkError({ message: 'Invalid Z3 URL', code: 400 });\n  }\n  const requestParams: Z3GetPresignedUrlParams = {\n    action: 'upload',\n    bucketName: bucket,\n    'objectPath+': key,\n  };\n  return this.request('/z3/{bucketName}/{objectPath+}', 'post')(requestParams);\n}\n"],"names":[],"mappings":";;;;AAIA;;;;AAIG;AACG,SAAgB,UAAU,CAE9B,EACE,UAAU,EACV,aAAa,EAAE,GAAG,EAClB,IAAI,GAKL,EAAA;;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAClC,gCAAgC,EAChC,MAAM,CACP,CAAC;AACA,YAAA,MAAM,EAAE,QAAQ;YAChB,UAAU;AACV,YAAA,aAAa,EAAE,GAAG;AACnB,SAAA,CAAC,CAAC;AACH,QAAA,MAAM,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE;AAC/B,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,IAAI,EAAE,IAAI;AACX,SAAA,CAAC,CAAC;KACJ,CAAA,CAAA;AAAA,CAAA;AAED;;;;AAIG;AACG,SAAgB,YAAY,CAEhC,EACE,UAAU,EACV,aAAa,EAAE,GAAG,GAInB,EAAA;;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAClC,gCAAgC,EAChC,MAAM,CACP,CAAC;AACA,YAAA,MAAM,EAAE,UAAU;YAClB,UAAU;AACV,YAAA,aAAa,EAAE,GAAG;AACnB,SAAA,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE;AAC5C,YAAA,MAAM,EAAE,KAAK;AACd,SAAA,CAAC,CAAC;AACH,QAAA,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;AACZ,YAAA,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAC5C,SAAA;AACD,QAAA,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;KAC3B,CAAA,CAAA;AAAA,CAAA;AAED;;;;;;AAMG;AACG,SAAgB,uBAAuB,CAE3C,MAAkE,EAAA;;;AAElE,QAAA,IAAI,MAAc,CAAC;AACnB,QAAA,IAAI,GAAW,CAAC;QAChB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAChC,QAAA,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,EAAE;;AAE1B,YAAA,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACrD,YAAA,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC;AACtB,YAAA,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7B,SAAA;AAAM,aAAA,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA,EAAA,GAAA,IAAI,CAAC,MAAM,CAAC,aAAa,MAAI,IAAA,IAAA,EAAA,KAAA,KAAA,CAAA,GAAA,EAAA,GAAA,oBAAoB,CAAC,EAAE;;AAEjF,YAAA,MAAM,cAAc,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACxD,YAAA,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;AAC3B,YAAA,GAAG,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzC,SAAA;AAAM,aAAA;AACL,YAAA,MAAM,IAAI,eAAe,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;AACrE,SAAA;AACD,QAAA,MAAM,aAAa,GAA4B;AAC7C,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,UAAU,EAAE,MAAM;AAClB,YAAA,aAAa,EAAE,GAAG;SACnB,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC;;AAC9E;;;;"}

package/dist/esm/resources/classes/z3.d.ts

@@ -4,8 +4,23 @@ import { OystehrConfig } from '../../config';
 import * as ext from './z3-ext';
 export declare class Z3 extends SDKResource {
     constructor(config: OystehrConfig);
+    /**
+     * Uploads a file to the bucket and key. Files should be Blobs.
+     * @param params upload file params
+     */
     uploadFile: typeof ext.uploadFile;
+    /**
+     * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.
+     * @param params download file params
+     */
     downloadFile: typeof ext.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
+     */
+    getPresignedUrlForZ3Url: typeof ext.getPresignedUrlForZ3Url;
     /**
      * List all Z3 Buckets. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.
      *

package/dist/esm/resources/classes/z3.js

@@ -1,12 +1,27 @@
 import { SDKResource } from '../../client/client.js';
-import { uploadFile, downloadFile } from './z3-ext.js';
+import { uploadFile, downloadFile, getPresignedUrlForZ3Url } from './z3-ext.js';
 
 // 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;
+        /**
+         * 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.
          *

package/dist/esm/resources/classes/z3.js.map

@@ -1 +1 @@
-{"version":3,"file":"z3.js","sources":["../../../../src/resources/classes/z3.ts"],"sourcesContent":["// AUTOGENERATED -- DO NOT EDIT\n\nimport {\n  OystehrClientRequest,\n  Z3CreateBucketParams,\n  Z3CreateBucketResponse,\n  Z3DeleteBucketParams,\n  Z3DeleteObjectParams,\n  Z3GetPresignedUrlParams,\n  Z3GetPresignedUrlResponse,\n  Z3ListBucketsResponse,\n  Z3ListObjectsParams,\n  Z3ListObjectsResponse,\n} from '../..';\nimport { SDKResource } from '../../client/client';\nimport { OystehrConfig } from '../../config';\nimport * as ext from './z3-ext';\n\nexport class Z3 extends SDKResource {\n  constructor(config: OystehrConfig) {\n    super(config);\n  }\n  uploadFile = ext.uploadFile;\n  downloadFile = ext.downloadFile;\n  /**\n   * List all Z3 Buckets. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:ListBuckets`\n   * Access Policy Resource: `Z3:BucketName`\n   */\n  listBuckets = (request?: OystehrClientRequest): Promise<Z3ListBucketsResponse> => this.request('/z3', 'get')(request);\n  /**\n   * Create a Z3 Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:CreateBucket`\n   * Access Policy Resource: `Z3:BucketName`\n   */\n  createBucket = (params: Z3CreateBucketParams, request?: OystehrClientRequest): Promise<Z3CreateBucketResponse> =>\n    this.request('/z3/{bucketName}', 'put')(params, request);\n  /**\n   * Delete the Z3 Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:DeleteBucket`\n   * Access Policy Resource: `Z3:BucketName`\n   */\n  deleteBucket = (params: Z3DeleteBucketParams, request?: OystehrClientRequest): Promise<void> =>\n    this.request('/z3/{bucketName}', 'delete')(params, request);\n  /**\n   * List all Z3 Objects at the provided path in the Bucket with the provided name [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:ListObjects`\n   * Access Policy Resource: `Z3:BucketName:ObjectPath`\n   */\n  listObjects = (params: Z3ListObjectsParams, request?: OystehrClientRequest): Promise<Z3ListObjectsResponse> =>\n    this.request('/z3/{bucketName}/{objectPath+}', 'get')(params, request);\n  /**\n   * Get a link for downloading or uploading a Z3 Object to the provided path in the Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:PutObject` or `Z3:GetObject`\n   * Access Policy Resource: `Z3:BucketName:ObjectPath`\n   */\n  getPresignedUrl = (\n    params: Z3GetPresignedUrlParams,\n    request?: OystehrClientRequest\n  ): Promise<Z3GetPresignedUrlResponse> => this.request('/z3/{bucketName}/{objectPath+}', 'post')(params, request);\n  /**\n   * Delete the Z3 Object at the provided path in the Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:DeleteObject`\n   * Access Policy Resource: `Z3:BucketName:ObjectPath`\n   */\n  deleteObject = (params: Z3DeleteObjectParams, request?: OystehrClientRequest): Promise<void> =>\n    this.request('/z3/{bucketName}/{objectPath+}', 'delete')(params, request);\n}\n"],"names":["ext.uploadFile","ext.downloadFile"],"mappings":";;;AAAA;AAkBM,MAAO,EAAG,SAAQ,WAAW,CAAA;AACjC,IAAA,WAAA,CAAY,MAAqB,EAAA;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;AAEhB,QAAA,IAAA,CAAA,UAAU,GAAGA,UAAc,CAAC;AAC5B,QAAA,IAAA,CAAA,YAAY,GAAGC,YAAgB,CAAC;AAChC;;;;;AAKG;AACH,QAAA,IAAA,CAAA,WAAW,GAAG,CAAC,OAA8B,KAAqC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;AACtH;;;;;AAKG;QACH,IAAY,CAAA,YAAA,GAAG,CAAC,MAA4B,EAAE,OAA8B,KAC1E,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3D;;;;;AAKG;QACH,IAAY,CAAA,YAAA,GAAG,CAAC,MAA4B,EAAE,OAA8B,KAC1E,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC9D;;;;;AAKG;QACH,IAAW,CAAA,WAAA,GAAG,CAAC,MAA2B,EAAE,OAA8B,KACxE,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACzE;;;;;AAKG;QACH,IAAe,CAAA,eAAA,GAAG,CAChB,MAA+B,EAC/B,OAA8B,KACS,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACjH;;;;;AAKG;QACH,IAAY,CAAA,YAAA,GAAG,CAAC,MAA4B,EAAE,OAA8B,KAC1E,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAnD3E;AAoDF;;;;"}
+{"version":3,"file":"z3.js","sources":["../../../../src/resources/classes/z3.ts"],"sourcesContent":["// AUTOGENERATED -- DO NOT EDIT\n\nimport {\n  OystehrClientRequest,\n  Z3CreateBucketParams,\n  Z3CreateBucketResponse,\n  Z3DeleteBucketParams,\n  Z3DeleteObjectParams,\n  Z3GetPresignedUrlParams,\n  Z3GetPresignedUrlResponse,\n  Z3ListBucketsResponse,\n  Z3ListObjectsParams,\n  Z3ListObjectsResponse,\n} from '../..';\nimport { SDKResource } from '../../client/client';\nimport { OystehrConfig } from '../../config';\nimport * as ext from './z3-ext';\n\nexport class Z3 extends SDKResource {\n  constructor(config: OystehrConfig) {\n    super(config);\n  }\n  /**\n   * Uploads a file to the bucket and key. Files should be Blobs.\n   * @param params upload file params\n   */\n  uploadFile = ext.uploadFile;\n  /**\n   * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.\n   * @param params download file params\n   */\n  downloadFile = ext.downloadFile;\n  /**\n   * This helper performs a `getPresignedUrl` request for Z3 URLs of the forms\n   * `https://projects-api.oystehr.com/v1/z3/<bucket>/<key>` * or `z3://<bucket>/<key>`\n   * instead of the standard SDK `Z3GetPresignedUrlParams`.\n   * @param params url and action\n   */\n  getPresignedUrlForZ3Url = ext.getPresignedUrlForZ3Url;\n  /**\n   * List all Z3 Buckets. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:ListBuckets`\n   * Access Policy Resource: `Z3:BucketName`\n   */\n  listBuckets = (request?: OystehrClientRequest): Promise<Z3ListBucketsResponse> => this.request('/z3', 'get')(request);\n  /**\n   * Create a Z3 Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:CreateBucket`\n   * Access Policy Resource: `Z3:BucketName`\n   */\n  createBucket = (params: Z3CreateBucketParams, request?: OystehrClientRequest): Promise<Z3CreateBucketResponse> =>\n    this.request('/z3/{bucketName}', 'put')(params, request);\n  /**\n   * Delete the Z3 Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:DeleteBucket`\n   * Access Policy Resource: `Z3:BucketName`\n   */\n  deleteBucket = (params: Z3DeleteBucketParams, request?: OystehrClientRequest): Promise<void> =>\n    this.request('/z3/{bucketName}', 'delete')(params, request);\n  /**\n   * List all Z3 Objects at the provided path in the Bucket with the provided name [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:ListObjects`\n   * Access Policy Resource: `Z3:BucketName:ObjectPath`\n   */\n  listObjects = (params: Z3ListObjectsParams, request?: OystehrClientRequest): Promise<Z3ListObjectsResponse> =>\n    this.request('/z3/{bucketName}/{objectPath+}', 'get')(params, request);\n  /**\n   * Get a link for downloading or uploading a Z3 Object to the provided path in the Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:PutObject` or `Z3:GetObject`\n   * Access Policy Resource: `Z3:BucketName:ObjectPath`\n   */\n  getPresignedUrl = (\n    params: Z3GetPresignedUrlParams,\n    request?: OystehrClientRequest\n  ): Promise<Z3GetPresignedUrlResponse> => this.request('/z3/{bucketName}/{objectPath+}', 'post')(params, request);\n  /**\n   * Delete the Z3 Object at the provided path in the Bucket with the provided name. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.\n   *\n   * Access Policy Action: `Z3:DeleteObject`\n   * Access Policy Resource: `Z3:BucketName:ObjectPath`\n   */\n  deleteObject = (params: Z3DeleteObjectParams, request?: OystehrClientRequest): Promise<void> =>\n    this.request('/z3/{bucketName}/{objectPath+}', 'delete')(params, request);\n}\n"],"names":["ext.uploadFile","ext.downloadFile","ext.getPresignedUrlForZ3Url"],"mappings":";;;AAAA;AAkBM,MAAO,EAAG,SAAQ,WAAW,CAAA;AACjC,IAAA,WAAA,CAAY,MAAqB,EAAA;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;AAEhB;;;AAGG;AACH,QAAA,IAAA,CAAA,UAAU,GAAGA,UAAc,CAAC;AAC5B;;;AAGG;AACH,QAAA,IAAA,CAAA,YAAY,GAAGC,YAAgB,CAAC;AAChC;;;;;AAKG;AACH,QAAA,IAAA,CAAA,uBAAuB,GAAGC,uBAA2B,CAAC;AACtD;;;;;AAKG;AACH,QAAA,IAAA,CAAA,WAAW,GAAG,CAAC,OAA8B,KAAqC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;AACtH;;;;;AAKG;QACH,IAAY,CAAA,YAAA,GAAG,CAAC,MAA4B,EAAE,OAA8B,KAC1E,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3D;;;;;AAKG;QACH,IAAY,CAAA,YAAA,GAAG,CAAC,MAA4B,EAAE,OAA8B,KAC1E,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC9D;;;;;AAKG;QACH,IAAW,CAAA,WAAA,GAAG,CAAC,MAA2B,EAAE,OAA8B,KACxE,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACzE;;;;;AAKG;QACH,IAAe,CAAA,eAAA,GAAG,CAChB,MAA+B,EAC/B,OAA8B,KACS,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACjH;;;;;AAKG;QACH,IAAY,CAAA,YAAA,GAAG,CAAC,MAA4B,EAAE,OAA8B,KAC1E,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAlE3E;AAmEF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oystehr/sdk",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Oystehr SDK",
   "scripts": {
     "lint": "eslint .",

package/src/client/client.ts

@@ -4,7 +4,7 @@ import { OystehrFHIRError, OystehrSdkError } from '../errors';
 import { FhirBundle, FhirResource, OperationOutcome } from '../resources/types';
 
 type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
-const defaultProjectApiUrl = 'https://project-api.zapehr.com/v1';
+export const defaultProjectApiUrl = 'https://project-api.zapehr.com/v1';
 const defaultFhirApiUrl = 'https://fhir-api.zapehr.com';
 const STATUS_CODES_TO_RETRY = [408, 429, 500, 502, 503, 504];
 const ERROR_CODES_TO_RETRY = [
@@ -50,7 +50,7 @@ type FhirData<T extends FhirResource> = T | T[] | FhirBundle<T>;
 export type FhirFetcherResponse<T extends FhirData<FhirResource> = any> = T;
 
 export class SDKResource {
-  private readonly config: OystehrConfig;
+  protected readonly config: OystehrConfig;
   constructor(config: OystehrConfig) {
     this.config = config;
   }

package/src/resources/classes/z3-ext.ts

@@ -1,5 +1,12 @@
-import { SDKResource } from '../../client/client';
+import { defaultProjectApiUrl, SDKResource } from '../../client/client';
+import { OystehrSdkError } from '../../errors';
+import { Z3GetPresignedUrlParams, Z3GetPresignedUrlResponse } from '../types';
 
+/**
+ * Uploads a file to the bucket and key. Files should be Blobs.
+ *
+ * @param params upload file params
+ */
 export async function uploadFile(
   this: SDKResource,
   {
@@ -26,6 +33,11 @@ export async function uploadFile(
   });
 }
 
+/**
+ * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.
+ *
+ * @param params download file params
+ */
 export async function downloadFile(
   this: SDKResource,
   {
@@ -52,3 +64,38 @@ export async function downloadFile(
   }
   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
+ */
+export async function getPresignedUrlForZ3Url(
+  this: SDKResource,
+  params: { url: string; action: Z3GetPresignedUrlParams['action'] }
+): Promise<Z3GetPresignedUrlResponse> {
+  let bucket: string;
+  let key: string;
+  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(this.config.projectApiUrl ?? 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: Z3GetPresignedUrlParams = {
+    action: 'upload',
+    bucketName: bucket,
+    'objectPath+': key,
+  };
+  return this.request('/z3/{bucketName}/{objectPath+}', 'post')(requestParams);
+}

package/src/resources/classes/z3.ts

@@ -20,8 +20,23 @@ export class Z3 extends SDKResource {
   constructor(config: OystehrConfig) {
     super(config);
   }
+  /**
+   * Uploads a file to the bucket and key. Files should be Blobs.
+   * @param params upload file params
+   */
   uploadFile = ext.uploadFile;
+  /**
+   * Downloads an object matching the bucket and key. File content is returned as an ArrayBuffer.
+   * @param params download file params
+   */
   downloadFile = ext.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
+   */
+  getPresignedUrlForZ3Url = ext.getPresignedUrlForZ3Url;
   /**
    * List all Z3 Buckets. [Z3](https://docs.oystehr.com/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.
    *