@pfdev/api-types 3.0.14 → 3.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pfdev/api-types",
-  "version": "3.0.14",
+  "version": "3.0.16",
   "description": "TypeScript types for PF API V3",
   "main": "index.ts",
   "types": "index.ts",

package/v3.ts

@@ -34,13 +34,19 @@ export const CardSchema = Type.Object(
     name: Type.String({ description: 'Card name' }),
     number: Type.String({ description: 'Card number within set' }),
     rarity: Type.Optional(Type.String({ description: 'Card rarity' })),
+    artist: Type.Optional(Type.String({ description: 'Card artist' })),
     images: CardImagesSchema,
     setid: Type.String({ description: 'Set this card belongs to' }),
     setname: Type.String({ description: 'Name of the set' }),
-    price: Type.Optional(Type.Number({ description: 'Lowest price across all variants' })),
+    price: Type.Optional(Type.Number({ description: 'Price of the lowest-priced variant' })),
     change_1d: Type.Optional(Type.Number({ description: '1-day price change as a percentage' })),
     change_1d_value: Type.Optional(Type.Number({ description: '1-day price change in dollars' })),
-    variants: Type.Optional(Type.Array(Type.String(), { description: 'Available variants for this card' }))
+    variants: Type.Optional(Type.Array(Type.String(), { description: 'Available variants for this card' })),
+    variant_prices: Type.Optional(
+      Type.Record(Type.String(), PriceStatsSchema, {
+        description: 'Prices and period changes keyed by variant name. Only present when requested via include=variant_prices. Variants without price data map to an empty object.'
+      })
+    )
   },
   {
     title: 'Card',
@@ -64,45 +70,31 @@ export const CardListResponseSchema = Type.Object(
 
 export type CardListResponse = Static<typeof CardListResponseSchema>;
 
+export const CardListSortSchema = Type.Union([
+  Type.Literal('number_asc'),
+  Type.Literal('number_desc'),
+  Type.Literal('name_asc'),
+  Type.Literal('name_desc'),
+  Type.Literal('price_asc'),
+  Type.Literal('price_desc')
+], { default: 'number_asc', description: 'Sort order. Defaults to number_asc.' });
+
+export type CardListSort = Static<typeof CardListSortSchema>;
+
 export const CardListQuerySchema = Type.Object(
   {
     setid: Type.Optional(Type.String({ description: 'Filter by set ID' })),
-    name: Type.Optional(Type.String({ description: 'Search by card name' })),
+    search: Type.Optional(Type.String({ minLength: 1, description: 'Search by card name and/or number. Tokens with digits match card number; other tokens match card name.' })),
+    sort: Type.Optional(CardListSortSchema),
+    include: Type.Optional(Type.Literal('variant_prices', { description: 'Include per-variant prices and period changes on each card' })),
     limit: Type.Optional(Type.Number({ minimum: 1, maximum: 250, default: 50, description: 'Max results to return' })),
     offset: Type.Optional(Type.Number({ minimum: 0, default: 0, description: 'Pagination offset' }))
   },
-  { description: 'At least one of setid or name must be provided' }
+  { description: 'At least one of setid or search must be provided' }
 );
 
 export type CardListQuery = Static<typeof CardListQuerySchema>;
 
-export const CardSearchSortSchema = Type.Union([
-  Type.Literal('number_asc'),
-  Type.Literal('number_desc'),
-  Type.Literal('name_asc'),
-  Type.Literal('name_desc'),
-  Type.Literal('price_asc'),
-  Type.Literal('price_desc')
-]);
-
-export type CardSearchSort = Static<typeof CardSearchSortSchema>;
-
-export const CardSearchQuerySchema = Type.Object({
-  q: Type.String({ minLength: 1, description: 'Search query. Tokens with digits match card number; other tokens match card name.' }),
-  sort: Type.Optional(Type.Union([
-    Type.Literal('number_asc'),
-    Type.Literal('number_desc'),
-    Type.Literal('name_asc'),
-    Type.Literal('name_desc'),
-    Type.Literal('price_asc'),
-    Type.Literal('price_desc')
-  ], { default: 'number_asc', description: 'Sort order. Defaults to number_asc.' })),
-  limit: Type.Optional(Type.Number({ minimum: 1, maximum: 100, default: 25, description: 'Max results to return' })),
-  offset: Type.Optional(Type.Number({ minimum: 0, default: 0, description: 'Pagination offset' }))
-});
-
-export type CardSearchQuery = Static<typeof CardSearchQuerySchema>;
-
 export const CardBatchQuerySchema = Type.Object({
   ids: Type.String({
     minLength: 1,
@@ -140,7 +132,7 @@ export const CardDetailSchema = Type.Object(
     nationalPokedexNumbers: Type.Optional(Type.Array(Type.Number(), { description: 'National Pokédex numbers' })),
     legalities: Type.Optional(Type.Any({ description: 'Format legalities' })),
     regulationMark: Type.Optional(Type.String({ description: 'Regulation mark' })),
-    price: Type.Optional(Type.Number({ description: 'Lowest price across all variants' })),
+    price: Type.Optional(Type.Number({ description: 'Price of the lowest-priced variant' })),
     change_1d: Type.Optional(Type.Number({ description: '1-day price change as a percentage' })),
     change_1d_value: Type.Optional(Type.Number({ description: '1-day price change in dollars' })),
     variants: Type.Optional(Type.Array(Type.String(), { description: 'Available variants for this card' })),
@@ -735,7 +727,8 @@ const DetectedCardSchema = Type.Object(
 
 const MatchedCardSchema = Type.Intersect(
   [
-    CardSchema,
+    // Vision returns variant_prices as an array, not CardSchema's map
+    Type.Omit(CardSchema, ['variant_prices']),
     Type.Object({
       score: Type.Number({ description: 'Fuzzy match score — higher is a better match' }),
       variant_prices: Type.Array(VariantPriceSchema, { description: 'Per-variant prices with extended period changes' })