@crvouga/mockingbird-service-rxvortex 1.8.1 → 2.0.0

package/openapi.yaml

@@ -0,0 +1,579 @@
+openapi: 3.1.0
+info:
+  title: RxVortex (Strive) pharmacy API (Mockingbird subset)
+  description: |
+    Stateful mock subset of the RxVortex / Strive compounding-pharmacy API: client-credentials
+    token, order submit, status, cancel, lookup by sender order id (recovery), and the preset
+    catalog. Hand-authored from the consumer's adapters (the vendor publishes no spec).
+  version: "1"
+  x-mockingbird-upstream:
+    note: >-
+      Hand-authored from the wire shapes our consumer reads and writes
+      (rxvortex-auth.service.ts, rxvortex-fulfillment.adapter.ts, rxvortex-live.client.ts).
+servers:
+  - url: https://sandbox.rxvortex.com
+security:
+  - bearerAuth: []
+paths:
+  /api/v1/generate-access-token:
+    post:
+      operationId: GenerateAccessToken
+      security: []
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [client_id, client_secret]
+              properties:
+                client_id:
+                  type: string
+                  minLength: 1
+                  maxLength: 64
+                client_secret:
+                  type: string
+                  minLength: 1
+                  maxLength: 64
+      responses:
+        "200":
+          description: Access token
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TokenResponse"
+        "401":
+          description: Bad credentials
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+        "422":
+          description: Validation failed
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ValidationError"
+  /api/v1/orders:
+    post:
+      operationId: CreateOrder
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateOrderBody"
+      responses:
+        "200":
+          description: Order accepted
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateOrderResponse"
+        "401":
+          description: Unauthenticated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+        "409":
+          description: Duplicate sender_order_id
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+        "422":
+          description: Validation failed
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ValidationError"
+  /api/v1/orders/{orderId}:
+    parameters:
+      - name: orderId
+        in: path
+        required: true
+        description: The vendor order tracking id, or the sender order id (our payment id).
+        schema:
+          type: string
+          x-mockingbird-resource-ref:
+            type: order
+            missing: RXV-00000000-MISSING
+    get:
+      operationId: GetOrder
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: Order status
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OrderStatus"
+        "401":
+          description: Unauthenticated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+        "404":
+          description: Unknown order
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+    delete:
+      operationId: CancelOrder
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: false
+      responses:
+        "200":
+          description: Cancelled
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CancelResponse"
+        "401":
+          description: Unauthenticated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+        "404":
+          description: Unknown order
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+        "409":
+          description: Not cancellable in its current status
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+  /api/v1/preset-catalog-items:
+    get:
+      operationId: ListPresetCatalogItems
+      x-mockingbird:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: Preset catalog
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [data]
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/CatalogItem"
+        "401":
+          description: Unauthenticated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorBody"
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+  schemas:
+    TokenResponse:
+      type: object
+      required: [access_token, token_type, expires_in]
+      properties:
+        access_token:
+          type: string
+          x-mockingbird-volatile:
+            kind: token
+        token_type:
+          type: string
+          enum: [Bearer]
+        expires_in:
+          type: integer
+    Address:
+      type: object
+      required: [line1, city, state, postal_code, country]
+      properties:
+        line1:
+          type: string
+          minLength: 1
+          maxLength: 80
+        line2:
+          type: string
+          maxLength: 80
+        city:
+          type: string
+          minLength: 1
+          maxLength: 40
+        state:
+          type: string
+          pattern: "^[A-Z]{2}$"
+        postal_code:
+          type: string
+          pattern: "^[0-9]{5}(-[0-9]{4})?$"
+        country:
+          type: string
+          enum: [US]
+    Patient:
+      type: object
+      required: [sender_patient_id, first_name, last_name, dob, gender, email, phone, address]
+      properties:
+        sender_patient_id:
+          type: string
+          minLength: 1
+          maxLength: 64
+        first_name:
+          type: string
+          minLength: 1
+          maxLength: 40
+        last_name:
+          type: string
+          minLength: 1
+          maxLength: 40
+        dob:
+          type: string
+          pattern: "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$"
+        gender:
+          type: string
+          enum: [male, female]
+        email:
+          type: string
+          format: email
+          maxLength: 120
+        phone:
+          type: string
+          pattern: "^[0-9]{3}-[0-9]{3}-[0-9]{4}$"
+        address:
+          $ref: "#/components/schemas/Address"
+    Prescriber:
+      type: object
+      required: [first_name, last_name, npi]
+      properties:
+        first_name:
+          type: string
+          minLength: 1
+          maxLength: 40
+        last_name:
+          type: string
+          minLength: 1
+          maxLength: 40
+        npi:
+          type: string
+          pattern: "^[0-9]{10}$"
+        dea_number:
+          type: string
+          maxLength: 20
+        license_number:
+          type: string
+          maxLength: 20
+        license_state:
+          type: string
+          maxLength: 2
+        phone:
+          type: string
+          maxLength: 20
+        address:
+          $ref: "#/components/schemas/Address"
+    MedicationRequest:
+      type: object
+      required:
+        - type
+        - preset_catalog_id
+        - sender_med_request_id
+        - medication_name
+        - quantity
+        - quantity_units
+        - days_supply_duration
+        - refills
+        - instructions
+      properties:
+        type:
+          type: string
+          enum: [new]
+        preset_catalog_id:
+          type: string
+          x-mockingbird-resource-ref:
+            type: catalog_item
+            missing: 00000000-0000-4000-8000-000000000000
+        sender_med_request_id:
+          type: string
+          minLength: 1
+          maxLength: 64
+        medication_name:
+          type: string
+          minLength: 1
+          maxLength: 120
+        medication_strength:
+          type: string
+          maxLength: 60
+        medication_form:
+          type: string
+          maxLength: 40
+        quantity:
+          type: number
+          exclusiveMinimum: 0
+          maximum: 1000
+        quantity_units:
+          type: string
+          enum: [mL, grams, each]
+        days_supply_duration:
+          type: integer
+          minimum: 1
+          maximum: 365
+        refills:
+          type: integer
+          minimum: 0
+          maximum: 12
+        instructions:
+          type: string
+          minLength: 1
+          maxLength: 500
+        note:
+          type: string
+          maxLength: 1000
+        authored_on_datetime:
+          type: string
+          maxLength: 40
+        clinical_difference:
+          type: string
+          maxLength: 1000
+        schedule_code:
+          type: string
+          enum: ["2", "3", "4", "5"]
+    ClinicalList:
+      type: object
+      properties:
+        has_known_allergies:
+          type: boolean
+        has_known_diseases:
+          type: boolean
+        has_known_medications:
+          type: boolean
+        entries:
+          type: array
+          maxItems: 5
+          items:
+            type: object
+            required: [description]
+            properties:
+              description:
+                type: string
+                maxLength: 200
+    CreateOrderBody:
+      type: object
+      required: [patient, prescriber, order, medication_requests]
+      properties:
+        patient:
+          $ref: "#/components/schemas/Patient"
+        prescriber:
+          $ref: "#/components/schemas/Prescriber"
+        order:
+          type: object
+          required: [bill_to, ship_to, sender_order_id]
+          properties:
+            bill_to:
+              type: string
+              enum: [practice, patient]
+            ship_to:
+              type: string
+              enum: [patient, practice]
+            sender_order_id:
+              type: string
+              minLength: 1
+              maxLength: 64
+        medication_requests:
+          type: array
+          minItems: 1
+          maxItems: 3
+          items:
+            $ref: "#/components/schemas/MedicationRequest"
+        clinical:
+          type: object
+          properties:
+            allergies:
+              $ref: "#/components/schemas/ClinicalList"
+            diseases:
+              $ref: "#/components/schemas/ClinicalList"
+            medications:
+              $ref: "#/components/schemas/ClinicalList"
+        shipment:
+          type: object
+          properties:
+            recipient_first_name:
+              type: string
+              maxLength: 40
+            recipient_last_name:
+              type: string
+              maxLength: 40
+            recipient_email:
+              type: string
+              maxLength: 80
+            recipient_phone:
+              type: string
+              maxLength: 20
+            address:
+              $ref: "#/components/schemas/Address"
+    CreateOrderResponse:
+      type: object
+      required: [success, message, order_tracking_id, sender_order_id, status]
+      properties:
+        success:
+          type: boolean
+        message:
+          type: string
+        order_tracking_id:
+          type: string
+          x-mockingbird-resource:
+            type: order
+            identity: true
+          x-mockingbird-volatile:
+            kind: id
+        sender_order_id:
+          type: string
+        status:
+          type: string
+    OrderStatus:
+      type: object
+      required:
+        - order_tracking_id
+        - tracking_id
+        - orderReferenceID
+        - sender_order_id
+        - rxstatus
+        - orderstatus
+        - shipping_status
+        - cancellable
+        - created_at
+        - updated_at
+      properties:
+        order_tracking_id:
+          type: string
+          x-mockingbird-volatile:
+            kind: id
+        tracking_id:
+          type: string
+          x-mockingbird-volatile:
+            kind: id
+        orderReferenceID:
+          type: string
+          x-mockingbird-volatile:
+            kind: id
+        sender_order_id:
+          type: string
+        rxstatus:
+          type: string
+        orderstatus:
+          type: string
+        shipping_status:
+          type: string
+        delivered_date:
+          type: ["string", "null"]
+        trackingnumber:
+          type: ["string", "null"]
+        shippingservice:
+          type: ["string", "null"]
+        shippingcarrier:
+          type: ["string", "null"]
+        shipmenttrackingurl:
+          type: ["string", "null"]
+        cancellable:
+          type: boolean
+        created_at:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+        updated_at:
+          type: string
+          x-mockingbird-volatile:
+            kind: timestamp
+    CancelResponse:
+      type: object
+      required: [success, message, order_tracking_id, rxstatus]
+      properties:
+        success:
+          type: boolean
+        message:
+          type: string
+        order_tracking_id:
+          type: string
+          x-mockingbird-volatile:
+            kind: id
+        rxstatus:
+          type: string
+    CatalogItem:
+      type: object
+      required: [catalog_id, medication_name, status]
+      properties:
+        catalog_id:
+          type: string
+          x-mockingbird-resource:
+            type: catalog_item
+            identity: true
+        medication_name:
+          type: string
+        medication_strength:
+          type: ["string", "null"]
+        package_size:
+          type: ["string", "null"]
+        quantity:
+          type: ["number", "null"]
+        quantity_units:
+          type: ["string", "null"]
+        medication_form:
+          type: ["string", "null"]
+        route:
+          type: ["string", "null"]
+        states:
+          type: array
+          items:
+            type: string
+        status:
+          type: string
+          enum: [active, inactive]
+    ErrorBody:
+      type: object
+      required: [message]
+      properties:
+        message:
+          type: string
+        success:
+          type: boolean
+    ValidationError:
+      type: object
+      required: [message, errors]
+      properties:
+        message:
+          type: string
+        errors:
+          oneOf:
+            - type: object
+              additionalProperties:
+                type: array
+                items:
+                  type: string
+            - type: array
+              items:
+                type: object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvouga/mockingbird-service-rxvortex",
-  "version": "1.8.1",
+  "version": "2.0.0",
   "description": "Stateful mock of the RxVortex (Strive) pharmacy API: OAuth token, order submit, status, cancel, recovery by sender order id, preset catalog, and signed status webhooks.",
   "license": "MIT",
   "type": "module",
@@ -8,7 +8,10 @@
   "files": [
     "dist",
     "README.md",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "DISCOVERY.md",
+    "SUPPORT.md",
+    "openapi.yaml"
   ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -57,7 +60,29 @@
       "description": "RxVortex is a pharmacy order platform whose API lets telehealth partners submit, track and cancel prescription orders with pharmacies such as Strive."
     },
     "parity": "Orders and status webhooks",
-    "parityTier": "cold"
+    "parityTier": "cold",
+    "discovery": {
+      "guide": "DISCOVERY.md",
+      "behavior": "README.md",
+      "capabilities": "SUPPORT.md",
+      "contract": "openapi.yaml",
+      "types": "dist/index.d.ts",
+      "oracle": {
+        "kind": "Live vendor API or sandbox",
+        "command": "bun run parity:service -- rxvortex",
+        "note": "Run from a Mockingbird checkout; credentials come only from .env.local or GitHub Actions secrets. Missing credentials exit 2."
+      },
+      "introspection": [
+        "GET /__admin/health",
+        "GET /__admin",
+        "GET /__admin/state",
+        "GET /__admin/requests",
+        "GET /__admin/metrics",
+        "GET /__admin/faults/presets",
+        "GET /__admin/ui"
+      ],
+      "reporting": "https://github.com/crvouga/mockingbird/blob/main/docs/REPORTING_ISSUES.md"
+    }
   },
   "scripts": {
     "generate": "bun ../../openapi/codegen/dist/cli.js",
@@ -72,7 +97,7 @@
     "pack:check": "bun ../../../scripts/pack-check.ts"
   },
   "dependencies": {
-    "@crvouga/mockingbird-service-sqlite": "1.3.0",
+    "@crvouga/mockingbird-service-sqlite": "2.0.0",
     "hono": "4.11.9"
   },
   "devDependencies": {