Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

7.6 KB
Raw Blame
import { HttpResponse, http } from 'msw'
import { describe, expect, it } from 'vitest'
import { API_PREFIX, createTestClient, paginated } from './helpers'
import { server } from './mocks/server'

const sampleRole = {
  id: 'role_abc123',
  name: 'admin',
  created_at: '2026-05-01T00:00:00Z',
  updated_at: '2026-05-01T00:00:00Z',
}

const sampleCategory = {
  id: 'cat_abc123',
  name: 'Apparel',
  permalink: 'apparel',
}

const sampleVariant = {
  id: 'variant_abc123',
  sku: 'SKU-1',
  price: '19.99',
}

const sampleCountry = {
  id: 'country_abc123',
  iso: 'US',
  name: 'United States',
}

describe('roles', () => {
  describe('list', () => {
    it('GETs /roles and returns paginated data', async () => {
      server.use(http.get(`${API_PREFIX}/roles`, () => HttpResponse.json(paginated([sampleRole]))))

      const res = await createTestClient().roles.list()

      expect(res.data).toHaveLength(1)
      expect(res.data[0]?.id).toBe('role_abc123')
    })

    it('wraps Ransack predicates via transformListParams', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/roles`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(paginated([]))
        }),
      )

      await createTestClient().roles.list({ name_cont: 'admin' })

      expect(url!.searchParams.get('q[name_cont]')).toBe('admin')
    })
  })

  describe('get', () => {
    it('GETs /roles/:id and forwards expand params', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/roles/role_abc123`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(sampleRole)
        }),
      )

      const res = await createTestClient().roles.get('role_abc123', { expand: ['permissions'] })

      expect(res.id).toBe('role_abc123')
      expect(url!.searchParams.get('expand')).toBe('permissions')
    })
  })
})

describe('categories', () => {
  describe('list', () => {
    it('GETs /categories and returns paginated data', async () => {
      server.use(
        http.get(`${API_PREFIX}/categories`, () => HttpResponse.json(paginated([sampleCategory]))),
      )

      const res = await createTestClient().categories.list()

      expect(res.data).toHaveLength(1)
      expect(res.data[0]?.id).toBe('cat_abc123')
    })

    it('wraps Ransack predicates via transformListParams', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/categories`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(paginated([]))
        }),
      )

      await createTestClient().categories.list({ name_cont: 'apparel' })

      expect(url!.searchParams.get('q[name_cont]')).toBe('apparel')
    })
  })
})

describe('variants', () => {
  describe('list', () => {
    it('GETs /variants and returns paginated data', async () => {
      server.use(
        http.get(`${API_PREFIX}/variants`, () => HttpResponse.json(paginated([sampleVariant]))),
      )

      const res = await createTestClient().variants.list()

      expect(res.data).toHaveLength(1)
      expect(res.data[0]?.id).toBe('variant_abc123')
    })

    it('wraps Ransack predicates via transformListParams', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/variants`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(paginated([]))
        }),
      )

      await createTestClient().variants.list({ sku_cont: 'SKU' })

      expect(url!.searchParams.get('q[sku_cont]')).toBe('SKU')
    })

    it('sends the sales context as itself, not as filters', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/variants`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(paginated([]))
        }),
      )

      await createTestClient().variants.list({
        search: 'shirt',
        market_id: 'mkt_eu',
        channel_id: 'ch_web',
        customer_id: undefined,
      })

      expect(url!.searchParams.get('market_id')).toBe('mkt_eu')
      expect(url!.searchParams.get('channel_id')).toBe('ch_web')
      expect(url!.searchParams.has('customer_id')).toBe(false)
      expect(url!.searchParams.get('q[market_id]')).toBeNull()
      expect(url!.searchParams.get('q[search]')).toBe('shirt')
    })

    it('sends a draft order as the sales context', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/variants`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(paginated([]))
        }),
      )

      await createTestClient().variants.list({ order_id: 'or_abc' })

      expect(url!.searchParams.get('order_id')).toBe('or_abc')
      expect(url!.searchParams.get('q[order_id]')).toBeNull()
    })
  })

  describe('get', () => {
    it('GETs /variants/:id and forwards expand params', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/variants/variant_abc123`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(sampleVariant)
        }),
      )

      const res = await createTestClient().variants.get('variant_abc123', {
        expand: ['stock_levels'],
      })

      expect(res.id).toBe('variant_abc123')
      expect(url!.searchParams.get('expand')).toBe('stock_levels')
    })
  })
})

describe('countries', () => {
  describe('list', () => {
    it('GETs /countries and returns paginated data', async () => {
      server.use(
        http.get(`${API_PREFIX}/countries`, () => HttpResponse.json(paginated([sampleCountry]))),
      )

      const res = await createTestClient().countries.list()

      expect(res.data).toHaveLength(1)
      expect(res.data[0]?.id).toBe('country_abc123')
    })

    it('wraps Ransack predicates via transformListParams', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/countries`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(paginated([]))
        }),
      )

      await createTestClient().countries.list({ name_cont: 'United' })

      expect(url!.searchParams.get('q[name_cont]')).toBe('United')
    })
  })

  describe('get', () => {
    it('GETs /countries/:iso and forwards expand=states', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/countries/US`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json(sampleCountry)
        }),
      )

      const res = await createTestClient().countries.get('US', { expand: ['states'] })

      expect(res.iso).toBe('US')
      expect(url!.searchParams.get('expand')).toBe('states')
    })
  })
})

describe('tags', () => {
  describe('list', () => {
    it('GETs /tags and returns the tag list', async () => {
      server.use(
        http.get(`${API_PREFIX}/tags`, () => HttpResponse.json({ data: [{ name: 'vip' }] })),
      )

      const res = await createTestClient().tags.list({ taggable_type: 'customer' })

      expect(res.data).toHaveLength(1)
      expect(res.data[0]?.name).toBe('vip')
    })

    it('forwards taggable_type + q filter params', async () => {
      let url: URL | null = null
      server.use(
        http.get(`${API_PREFIX}/tags`, ({ request }) => {
          url = new URL(request.url)
          return HttpResponse.json({ data: [] })
        }),
      )

      await createTestClient().tags.list({ taggable_type: 'customer', q: 'vi' })

      expect(url!.searchParams.get('taggable_type')).toBe('customer')
      expect(url!.searchParams.get('q')).toBe('vi')
    })
  })
})