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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
import { describe, expect, it } from 'vitest'
import { renderParamsTypes } from '../../sdk-core/src/params-types'
describe('renderParamsTypes', () => {
const files = renderParamsTypes({
components: {
schemas: {
Product: { type: 'object', properties: { id: { type: 'string' } } },
PriceParams: {
type: 'object',
properties: {
amount: { type: 'string', format: 'decimal' },
compare_at_amount: { type: 'string', nullable: true },
},
required: ['amount'],
},
WidgetCreateParams: {
type: 'object',
properties: {
name: { type: 'string', description: 'The name.' },
status: { type: 'string', enum: ['draft', "it's"] },
weight: { type: 'number', nullable: true },
kind: { anyOf: [{ type: 'string', enum: ['tax', 'duty'] }, { type: 'string' }] },
country_code: { $ref: '#/components/schemas/CountryCode' },
country_iso: {
type: 'string',
deprecated: true,
description: 'The old name. Deprecated: Use country_code.',
},
tags: { type: 'array', items: { type: 'string' } },
metadata: { type: 'object', additionalProperties: true },
value: {},
prices: { type: 'array', items: { $ref: '#/components/schemas/PriceParams' } },
main_price: { allOf: [{ $ref: '#/components/schemas/PriceParams' }], nullable: true },
options: {
type: 'array',
items: {
type: 'object',
properties: { name: { type: 'string' } },
required: ['name'],
},
},
},
required: ['name'],
},
},
},
})
const source = files.get('WidgetCreateParams.ts') ?? ''
it('writes one file per request schema and an index of them', () => {
expect([...files.keys()]).toEqual(['PriceParams.ts', 'WidgetCreateParams.ts', 'index.ts'])
expect(files.get('index.ts')).toContain(
"export type { PriceParams } from './PriceParams'\nexport type { WidgetCreateParams } from './WidgetCreateParams'\n",
)
})
it('imports the request types a type references', () => {
expect(source).toContain("import type { PriceParams } from './PriceParams'\n")
expect(source).toContain("import type { CountryCode } from '../generated'\n")
expect(source).toContain(' country_code?: CountryCode\n')
})
it('maps each kind of value', () => {
expect(files.get('PriceParams.ts')).toContain(
' amount: string\n compare_at_amount?: string | null\n',
)
expect(source).toContain(' /** The name. */\n name: string\n')
expect(source).toContain(" status?: 'draft' | 'it\\'s'\n")
expect(source).toContain(' weight?: number | null\n')
expect(source).toContain(" kind?: 'tax' | 'duty' | (string & {})\n")
expect(source).toContain(
' /**\n * The old name.\n * @deprecated Use country_code.\n */\n country_iso?: string\n',
)
expect(source).toContain(' tags?: string[]\n')
expect(source).toContain(' metadata?: Record<string, unknown>\n')
expect(source).toContain(' value?: unknown\n')
expect(source).toContain(' prices?: PriceParams[]\n')
expect(source).toContain(' main_price?: PriceParams | null\n')
expect(source).toContain(' options?: {\n name: string\n }[]\n')
})
it('refuses a reference to a response schema', () => {
expect(() =>
renderParamsTypes({
components: {
schemas: {
BadParams: {
type: 'object',
properties: { product: { $ref: '#/components/schemas/Product' } },
},
},
},
}),
).toThrow(/not a request schema/)
})
})