saferx-pharma-sdk 1.1.0 → 1.3.0

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "saferx-pharma-sdk",
-        "X-Fern-SDK-Version": "1.1.0",
-        "User-Agent": "saferx-pharma-sdk/1.1.0",
+        "X-Fern-SDK-Version": "1.3.0",
+        "User-Agent": "saferx-pharma-sdk/1.3.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/api/types/ClinicalAlert.d.ts

@@ -2,7 +2,7 @@
  * Clinical safety alert from cross-drug analysis
  */
 export interface ClinicalAlert {
-    /** SFX_ID of the drug involved */
+    /** sfrx_id of the drug involved */
     drug_id?: string | undefined;
     /** Drug name (English) */
     drug?: string | undefined;

package/dist/cjs/api/types/ClinicalData.d.ts

@@ -5,7 +5,7 @@ import type * as SafeRx from "../index.js";
  * is provided in the request.
  */
 export interface ClinicalData {
-    /** Per-drug clinical data keyed by SFX_ID */
+    /** Per-drug clinical data keyed by sfrx_id */
     drug_specific?: Record<string, SafeRx.DrugClinicalData> | undefined;
     /** Cross-drug condition-related alerts (requires `patient_profile.conditions`) */
     condition_alerts?: SafeRx.ClinicalAlert[] | undefined;

package/dist/cjs/api/types/Interaction.d.ts

@@ -1,22 +1,47 @@
 export interface Interaction {
-    /** SFX_ID of the first drug in the interaction pair */
-    drug_1_id?: string | undefined;
-    /** SFX_ID of the second drug in the interaction pair */
-    drug_2_id?: string | undefined;
+    /** sfrx_id of the first drug in the interaction pair */
+    sfrx_id_1?: string | undefined;
+    /** sfrx_id of the second drug in the interaction pair */
+    sfrx_id_2?: string | undefined;
     /**
-     * Interaction severity level.
-     * - `2` — Minor: minimal clinical significance
-     * - `3` — Moderate: may require monitoring or dose adjustment
-     * - `4` — Major: avoid combination if possible, close monitoring required
-     * - `5` — Contraindicated: do not use together
+     * Interaction severity level (clinical interactions only).
+     * - `1` — Minor: minimal clinical significance
+     * - `2` — Moderate: may require monitoring or dose adjustment
+     * - `3` — Major: avoid combination if possible, close monitoring required
+     * - `4` — Contraindicated: do not use together
+     *
+     * The API filters out noise interactions (severity ≤ 0) by default.
+     * The internal V8 scale extends to -3 (noise) and 0 (unknown),
+     * but these are never returned in the public response.
      */
     severity?: number | undefined;
+    /**
+     * Original severity before route-based or noise adjustments.
+     * Uses the full V8 scale: -3 (decreased efficacy), -2 (pharmacokinetic),
+     * -1 (metabolic), 0 (unknown), 1-4 (clinical). May differ from
+     * `severity` when route adjustments apply.
+     */
+    base_severity?: number | undefined;
     /** Human-readable severity label */
     severity_name?: Interaction.SeverityName | undefined;
+    /**
+     * Noise classification for this interaction, if applicable.
+     * Null for clinically significant interactions. Possible values:
+     * `"DECREASED_EFFICACY"`, `"PHARMACOKINETIC"`, `"METABOLIC"`.
+     */
+    noise_type?: (string | null) | undefined;
     /** Interaction mechanism or clinical description (English) */
     description?: string | undefined;
     /** Interaction description in Arabic */
     description_ar?: string | undefined;
+    /** Expected clinical effect of the interaction (English) */
+    clinical_effect?: (string | null) | undefined;
+    /** Expected clinical effect in Arabic */
+    clinical_effect_ar?: (string | null) | undefined;
+    /** Clinical management strategy (English) */
+    management?: (string | null) | undefined;
+    /** Clinical management strategy in Arabic */
+    management_ar?: (string | null) | undefined;
     /** Clinical recommendation for managing this interaction (English) */
     recommendation?: string | undefined;
     /** Clinical recommendation in Arabic */

package/dist/cjs/api/types/ReproductiveSafetyData.d.ts

@@ -27,4 +27,28 @@ export interface ReproductiveSafetyData {
     lactation_rationale?: string | undefined;
     pregnancy_warning?: SafeRx.ReproductiveWarning | undefined;
     lactation_warning?: SafeRx.ReproductiveWarning | undefined;
+    /** First trimester pregnancy risk classification */
+    preg_t1_risk?: (string | null) | undefined;
+    /** First trimester clinical note */
+    preg_t1_note?: (string | null) | undefined;
+    /** First trimester note in Arabic */
+    preg_t1_ar?: (string | null) | undefined;
+    /** Second trimester pregnancy risk classification */
+    preg_t2_risk?: (string | null) | undefined;
+    /** Second trimester clinical note */
+    preg_t2_note?: (string | null) | undefined;
+    /** Second trimester note in Arabic */
+    preg_t2_ar?: (string | null) | undefined;
+    /** Third trimester pregnancy risk classification */
+    preg_t3_risk?: (string | null) | undefined;
+    /** Third trimester clinical note */
+    preg_t3_note?: (string | null) | undefined;
+    /** Third trimester note in Arabic */
+    preg_t3_ar?: (string | null) | undefined;
+    /** Measured drug concentration in breast milk (mg/L) */
+    lact_milk_level_mgl?: (number | null) | undefined;
+    /** Milk-to-plasma concentration ratio */
+    lact_mp_ratio?: (number | null) | undefined;
+    /** Relative Infant Dose (%) — percentage of maternal dose received by infant */
+    lact_rid?: (number | null) | undefined;
 }

package/dist/cjs/api/types/ResolvedDrug.d.ts

@@ -7,7 +7,12 @@ export interface ResolvedDrug {
      * SafeRx product identifier. Primary key used across all safety
      * domains. Format: `SRX-{category}-{sequence}`.
      */
-    SFX_ID: string;
+    sfrx_id: string;
+    /**
+     * Parent product identifier for strength/pack variants of the same drug.
+     * Null if this product has no parent.
+     */
+    parent_sfrx_id?: (string | null) | undefined;
     /** Registered trade name with strength and pack size */
     brand_name: string;
     /** Active pharmaceutical ingredient(s), pipe-separated for combinations */
@@ -15,13 +20,13 @@ export interface ResolvedDrug {
     /** Pharmaceutical dosage form */
     form: string;
     /** Marketing authorization holder */
-    manufacturer?: string | undefined;
+    manufacturer_en?: string | undefined;
     /** ATC-based therapeutic classification, pipe-separated hierarchy */
     therapeutic_class?: string | undefined;
     /** Primary prescribing specialty */
     medical_specialty?: string | undefined;
-    /** Distribution company (may be empty) */
-    distributor?: string | undefined;
+    /** Distribution/supply company (may be empty) */
+    supplier_en?: string | undefined;
     /** Product barcode (may be empty) */
     barcode?: string | undefined;
     /** Current price in Egyptian Pounds (EGP) */

package/dist/cjs/api/types/SafetyData.d.ts

@@ -6,17 +6,17 @@ import type * as SafeRx from "../index.js";
  */
 export interface SafetyData {
     /**
-     * Adverse effects data keyed by SFX_ID. Includes risk level,
+     * Adverse effects data keyed by sfrx_id. Includes risk level,
      * Black Box Warnings, severe/common effects, monitoring, and
      * dose classification.
      */
     side_effects?: Record<string, SafeRx.SideEffectsData> | undefined;
     interactions?: SafeRx.InteractionsData | undefined;
-    /** Pregnancy & lactation risk data keyed by SFX_ID */
+    /** Pregnancy & lactation risk data keyed by sfrx_id */
     reproductive_safety?: Record<string, SafeRx.ReproductiveSafetyData> | undefined;
-    /** Food-drug interaction data keyed by SFX_ID */
+    /** Food-drug interaction data keyed by sfrx_id */
     food?: Record<string, SafeRx.FoodData> | undefined;
     clinical?: SafeRx.ClinicalData | undefined;
-    /** Maximum daily dose data keyed by SFX_ID */
+    /** Maximum daily dose data keyed by sfrx_id */
     dosing?: Record<string, SafeRx.DosingData> | undefined;
 }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.1.0";
+export declare const SDK_VERSION = "1.3.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.1.0";
+exports.SDK_VERSION = "1.3.0";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "saferx-pharma-sdk",
-        "X-Fern-SDK-Version": "1.1.0",
-        "User-Agent": "saferx-pharma-sdk/1.1.0",
+        "X-Fern-SDK-Version": "1.3.0",
+        "User-Agent": "saferx-pharma-sdk/1.3.0",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/api/types/ClinicalAlert.d.mts

@@ -2,7 +2,7 @@
  * Clinical safety alert from cross-drug analysis
  */
 export interface ClinicalAlert {
-    /** SFX_ID of the drug involved */
+    /** sfrx_id of the drug involved */
     drug_id?: string | undefined;
     /** Drug name (English) */
     drug?: string | undefined;

package/dist/esm/api/types/ClinicalData.d.mts

@@ -5,7 +5,7 @@ import type * as SafeRx from "../index.mjs";
  * is provided in the request.
  */
 export interface ClinicalData {
-    /** Per-drug clinical data keyed by SFX_ID */
+    /** Per-drug clinical data keyed by sfrx_id */
     drug_specific?: Record<string, SafeRx.DrugClinicalData> | undefined;
     /** Cross-drug condition-related alerts (requires `patient_profile.conditions`) */
     condition_alerts?: SafeRx.ClinicalAlert[] | undefined;

package/dist/esm/api/types/Interaction.d.mts

@@ -1,22 +1,47 @@
 export interface Interaction {
-    /** SFX_ID of the first drug in the interaction pair */
-    drug_1_id?: string | undefined;
-    /** SFX_ID of the second drug in the interaction pair */
-    drug_2_id?: string | undefined;
+    /** sfrx_id of the first drug in the interaction pair */
+    sfrx_id_1?: string | undefined;
+    /** sfrx_id of the second drug in the interaction pair */
+    sfrx_id_2?: string | undefined;
     /**
-     * Interaction severity level.
-     * - `2` — Minor: minimal clinical significance
-     * - `3` — Moderate: may require monitoring or dose adjustment
-     * - `4` — Major: avoid combination if possible, close monitoring required
-     * - `5` — Contraindicated: do not use together
+     * Interaction severity level (clinical interactions only).
+     * - `1` — Minor: minimal clinical significance
+     * - `2` — Moderate: may require monitoring or dose adjustment
+     * - `3` — Major: avoid combination if possible, close monitoring required
+     * - `4` — Contraindicated: do not use together
+     *
+     * The API filters out noise interactions (severity ≤ 0) by default.
+     * The internal V8 scale extends to -3 (noise) and 0 (unknown),
+     * but these are never returned in the public response.
      */
     severity?: number | undefined;
+    /**
+     * Original severity before route-based or noise adjustments.
+     * Uses the full V8 scale: -3 (decreased efficacy), -2 (pharmacokinetic),
+     * -1 (metabolic), 0 (unknown), 1-4 (clinical). May differ from
+     * `severity` when route adjustments apply.
+     */
+    base_severity?: number | undefined;
     /** Human-readable severity label */
     severity_name?: Interaction.SeverityName | undefined;
+    /**
+     * Noise classification for this interaction, if applicable.
+     * Null for clinically significant interactions. Possible values:
+     * `"DECREASED_EFFICACY"`, `"PHARMACOKINETIC"`, `"METABOLIC"`.
+     */
+    noise_type?: (string | null) | undefined;
     /** Interaction mechanism or clinical description (English) */
     description?: string | undefined;
     /** Interaction description in Arabic */
     description_ar?: string | undefined;
+    /** Expected clinical effect of the interaction (English) */
+    clinical_effect?: (string | null) | undefined;
+    /** Expected clinical effect in Arabic */
+    clinical_effect_ar?: (string | null) | undefined;
+    /** Clinical management strategy (English) */
+    management?: (string | null) | undefined;
+    /** Clinical management strategy in Arabic */
+    management_ar?: (string | null) | undefined;
     /** Clinical recommendation for managing this interaction (English) */
     recommendation?: string | undefined;
     /** Clinical recommendation in Arabic */

package/dist/esm/api/types/ReproductiveSafetyData.d.mts

@@ -27,4 +27,28 @@ export interface ReproductiveSafetyData {
     lactation_rationale?: string | undefined;
     pregnancy_warning?: SafeRx.ReproductiveWarning | undefined;
     lactation_warning?: SafeRx.ReproductiveWarning | undefined;
+    /** First trimester pregnancy risk classification */
+    preg_t1_risk?: (string | null) | undefined;
+    /** First trimester clinical note */
+    preg_t1_note?: (string | null) | undefined;
+    /** First trimester note in Arabic */
+    preg_t1_ar?: (string | null) | undefined;
+    /** Second trimester pregnancy risk classification */
+    preg_t2_risk?: (string | null) | undefined;
+    /** Second trimester clinical note */
+    preg_t2_note?: (string | null) | undefined;
+    /** Second trimester note in Arabic */
+    preg_t2_ar?: (string | null) | undefined;
+    /** Third trimester pregnancy risk classification */
+    preg_t3_risk?: (string | null) | undefined;
+    /** Third trimester clinical note */
+    preg_t3_note?: (string | null) | undefined;
+    /** Third trimester note in Arabic */
+    preg_t3_ar?: (string | null) | undefined;
+    /** Measured drug concentration in breast milk (mg/L) */
+    lact_milk_level_mgl?: (number | null) | undefined;
+    /** Milk-to-plasma concentration ratio */
+    lact_mp_ratio?: (number | null) | undefined;
+    /** Relative Infant Dose (%) — percentage of maternal dose received by infant */
+    lact_rid?: (number | null) | undefined;
 }

package/dist/esm/api/types/ResolvedDrug.d.mts

@@ -7,7 +7,12 @@ export interface ResolvedDrug {
      * SafeRx product identifier. Primary key used across all safety
      * domains. Format: `SRX-{category}-{sequence}`.
      */
-    SFX_ID: string;
+    sfrx_id: string;
+    /**
+     * Parent product identifier for strength/pack variants of the same drug.
+     * Null if this product has no parent.
+     */
+    parent_sfrx_id?: (string | null) | undefined;
     /** Registered trade name with strength and pack size */
     brand_name: string;
     /** Active pharmaceutical ingredient(s), pipe-separated for combinations */
@@ -15,13 +20,13 @@ export interface ResolvedDrug {
     /** Pharmaceutical dosage form */
     form: string;
     /** Marketing authorization holder */
-    manufacturer?: string | undefined;
+    manufacturer_en?: string | undefined;
     /** ATC-based therapeutic classification, pipe-separated hierarchy */
     therapeutic_class?: string | undefined;
     /** Primary prescribing specialty */
     medical_specialty?: string | undefined;
-    /** Distribution company (may be empty) */
-    distributor?: string | undefined;
+    /** Distribution/supply company (may be empty) */
+    supplier_en?: string | undefined;
     /** Product barcode (may be empty) */
     barcode?: string | undefined;
     /** Current price in Egyptian Pounds (EGP) */

package/dist/esm/api/types/SafetyData.d.mts

@@ -6,17 +6,17 @@ import type * as SafeRx from "../index.mjs";
  */
 export interface SafetyData {
     /**
-     * Adverse effects data keyed by SFX_ID. Includes risk level,
+     * Adverse effects data keyed by sfrx_id. Includes risk level,
      * Black Box Warnings, severe/common effects, monitoring, and
      * dose classification.
      */
     side_effects?: Record<string, SafeRx.SideEffectsData> | undefined;
     interactions?: SafeRx.InteractionsData | undefined;
-    /** Pregnancy & lactation risk data keyed by SFX_ID */
+    /** Pregnancy & lactation risk data keyed by sfrx_id */
     reproductive_safety?: Record<string, SafeRx.ReproductiveSafetyData> | undefined;
-    /** Food-drug interaction data keyed by SFX_ID */
+    /** Food-drug interaction data keyed by sfrx_id */
     food?: Record<string, SafeRx.FoodData> | undefined;
     clinical?: SafeRx.ClinicalData | undefined;
-    /** Maximum daily dose data keyed by SFX_ID */
+    /** Maximum daily dose data keyed by sfrx_id */
     dosing?: Record<string, SafeRx.DosingData> | undefined;
 }

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.1.0";
+export declare const SDK_VERSION = "1.3.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.1.0";
+export const SDK_VERSION = "1.3.0";

package/package.json

@@ -1,11 +1,7 @@
 {
     "name": "saferx-pharma-sdk",
-    "version": "1.1.0",
+    "version": "1.3.0",
     "private": false,
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/KaRamHelal/SafeRx_Pharma.git"
-    },
     "type": "commonjs",
     "main": "./dist/cjs/index.js",
     "module": "./dist/esm/index.mjs",

package/README.md

@@ -1,398 +0,0 @@
-# Saferx TypeScript Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FKaRamHelal%2FSafeRx_Pharma)
-[![npm shield](https://img.shields.io/npm/v/saferx-pharma-sdk)](https://www.npmjs.com/package/saferx-pharma-sdk)
-
-The Saferx TypeScript library provides convenient access to the Saferx APIs from TypeScript.
-
-## Table of Contents
-
-- [What S Here](#what-s-here)
-- [Quick Start](#quick-start)
-- [Sd Ks](#sd-ks)
-- [Mcp Server](#mcp-server)
-- [Safety Domains](#safety-domains)
-- [Api Tiers](#api-tiers)
-- [Documentation](#documentation)
-- [Links](#links)
-- [License](#license)
-- [Installation](#installation)
-- [Reference](#reference)
-- [Usage](#usage)
-- [Request and Response Types](#request-and-response-types)
-- [Exception Handling](#exception-handling)
-- [Advanced](#advanced)
-  - [Additional Headers](#additional-headers)
-  - [Additional Query String Parameters](#additional-query-string-parameters)
-  - [Retries](#retries)
-  - [Timeouts](#timeouts)
-  - [Aborting Requests](#aborting-requests)
-  - [Access Raw Response Data](#access-raw-response-data)
-  - [Logging](#logging)
-  - [Runtime Compatibility](#runtime-compatibility)
-- [Contributing](#contributing)
-
-## What's Here
-
-```
-SafeRx_Pharma/
-├── openapi/                  # OpenAPI 3.1.1 spec (source of truth)
-│   └── drug-safety-v1.yaml   # ~2000 lines, fully typed
-├── mcp-server/               # MCP server for AI assistants
-│   └── src/index.ts           # Published: @saferx_pharma/mcp-server
-├── fern/                     # Fern docs + SDK generation config
-│   ├── docs.yml               # docs.saferx.online (26 pages)
-│   ├── docs/                  # Documentation content (MDX)
-│   ├── generators.yml         # SDK generators (Python, TS, C#, Java, Go, Swift)
-│   └── apis/                  # API definitions per SDK
-├── postman/                  # Postman collection (8 requests)
-└── LICENSE                   # MIT
-```
-
-## Quick Start
-
-### Get a Free API Key
-
-```bash
-# Step 1: Request verification code
-curl -X POST https://saferx.online/api/developers/keys/free \
-  -H "Content-Type: application/json" \
-  -d '{"email": "you@example.com"}'
-
-# Step 2: Verify with the 6-digit code from your email
-curl -X POST https://saferx.online/api/developers/keys/free/verify \
-  -H "Content-Type: application/json" \
-  -d '{"email": "you@example.com", "code": "123456"}'
-```
-
-### Check Drug Safety
-
-```bash
-curl -X POST https://saferx.online/api/drug_safety/check \
-  -H "X-SafeRx-API-Key: YOUR_KEY" \
-  -H "Content-Type: application/json" \
-  -H "User-Agent: MyApp/1.0" \
-  -d '{"drugs": ["Augmentin 1g", "Marivan", "Glucophage 500"]}'
-```
-
-Returns safety data across all 6 domains in ~40ms.
-
-## SDKs
-
-| Language | Package | Install |
-|----------|---------|---------|
-| Python | [`saferx-pharma`](https://pypi.org/project/saferx-pharma/) | `pip install saferx-pharma` |
-| TypeScript | [`saferx-pharma-sdk`](https://www.npmjs.com/package/saferx-pharma-sdk) | `npm install saferx-pharma-sdk` |
-| C# | [`SafeRx`](https://www.nuget.org/packages/SafeRx) | `dotnet add package SafeRx` |
-
-```python
-from saferx import SafeRxClient
-
-client = SafeRxClient(api_key="sfx_free_...")
-result = client.drug_safety.check(drugs=["Augmentin 1g", "Marivan"])
-```
-
-```typescript
-import { SafeRxClient } from "saferx-pharma-sdk";
-
-const client = new SafeRxClient({ apiKey: "sfx_free_..." });
-const result = await client.drugSafety.check({ drugs: ["Augmentin 1g", "Marivan"] });
-```
-
-## MCP Server
-
-For AI assistants (Claude Desktop, Claude Code, Cursor):
-
-```bash
-npx @saferx_pharma/mcp-server
-```
-
-Requires `SAFERX_API_KEY` environment variable. See [`mcp-server/README.md`](mcp-server/README.md) for configuration details.
-
-## Safety Domains
-
-| Domain | Code | Coverage |
-|--------|------|----------|
-| Adverse Effects | `ae` | 920K+ effects, Black Box Warnings |
-| Drug Interactions | `ddi` | 337K+ interaction pairs |
-| Pregnancy & Lactation | `pllr` | 24K+ products, 0-7 risk scale |
-| Food Interactions | `food` | 38K+ interactions |
-| Clinical Considerations | `clinical` | 5 populations, 14 conditions |
-| Dosing | `dose` | 19K+ products, dual-source |
-
-## API Tiers
-
-| | Free | Pro | Enterprise |
-|---|------|-----|------------|
-| Requests/min | 20 | 60 | Custom |
-| Requests/day | 60 | 500 | Custom |
-| Max drugs/request | 20 | 20 | 50 |
-| Auth | API Key | API Key | API Key |
-| Database | Full (28,557 products) | Full | Full |
-| Support | Email | Priority | Dedicated |
-
-## Documentation
-
-- [API Reference](https://saferx.docs.buildwithfern.com) — Interactive endpoint docs
-- [Integration Guides](https://saferx.docs.buildwithfern.com/guides/integration-guides/pharmacy-dispensing) — Pharmacy, Hospital EHR, POS, Mobile, AI Agent
-- [OpenAPI Spec](openapi/drug-safety-v1.yaml) — Machine-readable API definition
-- [Postman Collection](postman/SafeRx-Drug-Safety-API.postman_collection.json) — Import and test in seconds
-
-## Links
-
-- **Website:** [saferx.online](https://saferx.online)
-- **Developer Portal:** [saferx.online/developer.html](https://saferx.online/developer.html)
-- **npm:** [@saferx_pharma/mcp-server](https://www.npmjs.com/package/@saferx_pharma/mcp-server)
-- **Status:** [saferx.instatus.com](https://saferx.instatus.com)
-- **Support:** support@saferx.online
-
-## License
-
-MIT
-
-## Installation
-
-```sh
-npm i -s saferx-pharma-sdk
-```
-
-## Reference
-
-A full reference for this library is available [here](https://github.com/KaRamHelal/SafeRx_Pharma/blob/HEAD/./reference.md).
-
-## Usage
-
-Instantiate and use the client with the following:
-
-```typescript
-import { SafeRxClient } from "saferx-pharma-sdk";
-
-const client = new SafeRxClient({ apiKey: "YOUR_API_KEY" });
-await client.drugSafety.check({
-    drugs: ["Augmentin 1g", "Glucophage 500mg"],
-    lang: "ar"
-});
-```
-
-## Request and Response Types
-
-The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
-following namespace:
-
-```typescript
-import { SafeRx } from "saferx-pharma-sdk";
-
-const request: SafeRx.DrugSafetyCheckRequest = {
-    ...
-};
-```
-
-## Exception Handling
-
-When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
-will be thrown.
-
-```typescript
-import { SafeRxError } from "saferx-pharma-sdk";
-
-try {
-    await client.drugSafety.check(...);
-} catch (err) {
-    if (err instanceof SafeRxError) {
-        console.log(err.statusCode);
-        console.log(err.message);
-        console.log(err.body);
-        console.log(err.rawResponse);
-    }
-}
-```
-
-## Advanced
-
-### Additional Headers
-
-If you would like to send additional headers as part of the request, use the `headers` request option.
-
-```typescript
-import { SafeRxClient } from "saferx-pharma-sdk";
-
-const client = new SafeRxClient({
-    ...
-    headers: {
-        'X-Custom-Header': 'custom value'
-    }
-});
-
-const response = await client.drugSafety.check(..., {
-    headers: {
-        'X-Custom-Header': 'custom value'
-    }
-});
-```
-
-### Additional Query String Parameters
-
-If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
-
-```typescript
-const response = await client.drugSafety.check(..., {
-    queryParams: {
-        'customQueryParamKey': 'custom query param value'
-    }
-});
-```
-
-### Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
-retry limit (default: 2).
-
-A request is deemed retryable when any of the following HTTP status codes is returned:
-
-- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
-- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
-- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-
-Use the `maxRetries` request option to configure this behavior.
-
-```typescript
-const response = await client.drugSafety.check(..., {
-    maxRetries: 0 // override maxRetries at the request level
-});
-```
-
-### Timeouts
-
-The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
-
-```typescript
-const response = await client.drugSafety.check(..., {
-    timeoutInSeconds: 30 // override timeout to 30s
-});
-```
-
-### Aborting Requests
-
-The SDK allows users to abort requests at any point by passing in an abort signal.
-
-```typescript
-const controller = new AbortController();
-const response = await client.drugSafety.check(..., {
-    abortSignal: controller.signal
-});
-controller.abort(); // aborts the request
-```
-
-### Access Raw Response Data
-
-The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
-The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
-
-```typescript
-const { data, rawResponse } = await client.drugSafety.check(...).withRawResponse();
-
-console.log(data);
-console.log(rawResponse.headers['X-My-Header']);
-```
-
-### Logging
-
-The SDK supports logging. You can configure the logger by passing in a `logging` object to the client options.
-
-```typescript
-import { SafeRxClient, logging } from "saferx-pharma-sdk";
-
-const client = new SafeRxClient({
-    ...
-    logging: {
-        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
-        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
-        silent: false, // defaults to true, set to false to enable logging
-    }
-});
-```
-The `logging` object can have the following properties:
-- `level`: The log level to use. Defaults to `logging.LogLevel.Info`.
-- `logger`: The logger to use. Defaults to a `logging.ConsoleLogger`.
-- `silent`: Whether to silence the logger. Defaults to `true`.
-
-The `level` property can be one of the following values:
-- `logging.LogLevel.Debug`
-- `logging.LogLevel.Info`
-- `logging.LogLevel.Warn`
-- `logging.LogLevel.Error`
-
-To provide a custom logger, you can pass in an object that implements the `logging.ILogger` interface.
-
-<details>
-<summary>Custom logger examples</summary>
-
-Here's an example using the popular `winston` logging library.
-```ts
-import winston from 'winston';
-
-const winstonLogger = winston.createLogger({...});
-
-const logger: logging.ILogger = {
-    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
-    info: (msg, ...args) => winstonLogger.info(msg, ...args),
-    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
-    error: (msg, ...args) => winstonLogger.error(msg, ...args),
-};
-```
-
-Here's an example using the popular `pino` logging library.
-
-```ts
-import pino from 'pino';
-
-const pinoLogger = pino({...});
-
-const logger: logging.ILogger = {
-  debug: (msg, ...args) => pinoLogger.debug(args, msg),
-  info: (msg, ...args) => pinoLogger.info(args, msg),
-  warn: (msg, ...args) => pinoLogger.warn(args, msg),
-  error: (msg, ...args) => pinoLogger.error(args, msg),
-};
-```
-</details>
-
-
-### Runtime Compatibility
-
-
-The SDK works in the following runtimes:
-
-
-
-- Node.js 18+
-- Vercel
-- Cloudflare Workers
-- Deno v1.25+
-- Bun 1.0+
-- React Native
-
-### Customizing Fetch Client
-
-The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
-unsupported environment, this provides a way for you to break glass and ensure the SDK works.
-
-```typescript
-import { SafeRxClient } from "saferx-pharma-sdk";
-
-const client = new SafeRxClient({
-    ...
-    fetcher: // provide your implementation here
-});
-```
-
-## Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically.
-Additions made directly to this library would have to be moved over to our generation code,
-otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
-a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
-an issue first to discuss with us!
-
-On the other hand, contributions to the README are always very welcome!

package/reference.md

@@ -1,335 +0,0 @@
-# Reference
-## Drug Safety
-<details><summary><code>client.drugSafety.<a href="/src/api/resources/drugSafety/client/Client.ts">check</a>({ ...params }) -> SafeRx.DrugSafetyCheckResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Screen one or more drugs across six safety domains in a single request.
-
-The API resolves drug names via fuzzy matching, runs all requested safety
-checks in parallel, and returns a unified response with alerts bubbled to
-the top for easy triage.
-
-**Typical response time:** ~40ms (warm cache, 3 drugs, all domains).
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.drugSafety.check({
-    drugs: ["Augmentin 1g", "Glucophage 500mg", "Marivan"],
-    lang: "en"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `SafeRx.DrugSafetyCheckRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `DrugSafetyClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.drugSafety.<a href="/src/api/resources/drugSafety/client/Client.ts">getMetadata</a>() -> SafeRx.MetadataResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Returns available populations, conditions, database versions, risk level
-scales, and current tier limits.
-
-Use this endpoint to:
-- Populate dropdown menus with valid population and condition values
-- Check database versions and coverage statistics
-- Verify your tier and rate limits
-- Cache metadata locally (changes infrequently — safe to cache for 24 hours)
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.drugSafety.getMetadata();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `DrugSafetyClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.drugSafety.<a href="/src/api/resources/drugSafety/client/Client.ts">getDrugSafetyHealth</a>() -> SafeRx.GetDrugSafetyHealthResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Returns health status of the Drug Safety API subsystem including
-overall system health and availability.
-
-No authentication required. Designed for monitoring services.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.drugSafety.getDrugSafetyHealth();
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `DrugSafetyClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-## Developers
-<details><summary><code>client.developers.<a href="/src/api/resources/developers/client/Client.ts">createFreeKey</a>({ ...params }) -> SafeRx.CreateFreeKeyDevelopersResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Step 1 of 2: Request a verification code to get a free API key.
-
-- Sends a 6-digit code to your email (expires in 30 minutes)
-- Max 5 codes per email per hour (anti-spam)
-- If email already has a verified key, returns it immediately
-- Use POST /api/developers/keys/free/verify with the code to receive your key
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.developers.createFreeKey({
-    email: "developer@example.com"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `SafeRx.CreateFreeKeyDevelopersRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `DevelopersClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.developers.<a href="/src/api/resources/developers/client/Client.ts">verifyFreeKey</a>({ ...params }) -> SafeRx.VerifyFreeKeyDevelopersResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Step 2 of 2: Verify your email with the 6-digit code and receive your API key.
-
-- Code expires after 30 minutes
-- Max 5 wrong attempts per code (then must request new code)
-- On success: issues sfx_free_ key (persistent, 1 per email)
-- Free tier: 20 requests/minute, 60 requests/day
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.developers.verifyFreeKey({
-    email: "developer@example.com",
-    code: "123456"
-});
-
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `SafeRx.VerifyFreeKeyDevelopersRequest` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `DevelopersClient.RequestOptions` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>