@oystehr/sdk 3.0.2 → 3.0.4

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.
    *

package/src/resources/types/ErxMedicationSearchV2Params.ts

@@ -0,0 +1,6 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface ErxMedicationSearchV2Params {
+  name?: string;
+  code?: string;
+}

package/src/resources/types/ErxMedicationSearchV2Response.ts

@@ -0,0 +1,40 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Medications
+ */
+export interface ErxMedicationSearchV2Response {
+  medications?: {
+    /**
+     * Internal identifier for the medication.
+     */
+    id: string;
+    /**
+     * Human readible name of medication.
+     */
+    name: string;
+    codes: {
+      /**
+       * RxNorm Concept Unique (RxCUI) identifier of medication.
+       */
+      rxcui?: string | null;
+      productNDC?: string | null;
+      packageNDC?: string | null;
+      SKU?: string | null;
+      HCPCS?: string | null;
+    };
+    /**
+     * Null implies a medication can not be prescribed
+     */
+    type?: ('RX' | 'OTC') | null;
+    concept?: ('DRUG' | 'PRODUCT' | 'PACKAGE') | null;
+    schedule?: ('I' | 'II' | 'III' | 'IV' | 'V') | null;
+    controlled?: boolean | null;
+    brandName?: string | null;
+    genericName?: string | null;
+    strength?: string | null;
+    form?: string | null;
+    manufacturer?: string | null;
+    description?: string | null;
+  }[];
+}

package/src/resources/types/Z3ListObjectsParams.ts

@@ -3,4 +3,5 @@
 export interface Z3ListObjectsParams {
   bucketName: string;
   'objectPath+': string;
+  direct?: boolean;
 }

package/src/resources/types/index.ts

@@ -99,6 +99,8 @@ export * from './ErxAllergySearchParams';
 export * from './ErxAllergySearchResponse';
 export * from './ErxMedicationSearchParams';
 export * from './ErxMedicationSearchResponse';
+export * from './ErxMedicationSearchV2Params';
+export * from './ErxMedicationSearchV2Response';
 export * from './RoleListResponse';
 export * from './RoleCreateParams';
 export * from './RoleCreateResponse';