@pfdev/api-types 3.0.18 → 3.0.19

package/package.json

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

package/v3.ts

@@ -10,6 +10,8 @@ import { Static, Type } from '@sinclair/typebox';
 export const PriceStatsSchema = Type.Object(
   {
     current_price: Type.Optional(Type.Number({ description: 'Current price' })),
+    price_date: Type.Optional(Type.String({ description: 'Date (YYYY-MM-DD) this price was last updated' })),
+    change_1d_value: Type.Optional(Type.Number({ description: '1-day price change in dollars' })),
     change_1d: Type.Optional(Type.Number({ description: '1-day price change as a percentage' })),
     change_7d: Type.Optional(Type.Number({ description: '7-day price change as a percentage' })),
     change_1m: Type.Optional(Type.Number({ description: '30-day price change as a percentage' })),
@@ -28,6 +30,38 @@ const CardImagesSchema = Type.Object(
   { title: 'CardImages' }
 );
 
+const GradedVariantPricesSchema = Type.Record(
+  Type.String(),
+  Type.Record(Type.String(), PriceStatsSchema),
+  { description: 'Graded prices and period changes keyed by variant then grade' }
+);
+
+// Fields on every card used for filtering and for web URLs
+const CardFilterFields = {
+  supertype: Type.Optional(Type.Union([Type.String(), Type.Null()], { description: 'Supertype (Pokémon, Trainer, Energy)' })),
+  subtypes: Type.Optional(Type.Union([Type.Array(Type.String()), Type.Null()], { description: 'Card subtypes' })),
+  types: Type.Optional(Type.Union([Type.Array(Type.String()), Type.Null()], { description: 'Card types' })),
+  nationalPokedexNumbers: Type.Optional(Type.Union([Type.Array(Type.Number()), Type.Null()], { description: 'National Pokédex numbers' })),
+  regulationMark: Type.Optional(Type.Union([Type.String(), Type.Null()], { description: 'Regulation mark' })),
+  set_release_date: Type.Optional(Type.Union([Type.String(), Type.Null()], { description: 'Release date of the set' })),
+  series: Type.Optional(Type.Union([Type.String(), Type.Null()], { description: 'Series the set belongs to' })),
+  slug: Type.Optional(Type.Union([Type.String(), Type.Null()], { description: 'URL slug for the card' })),
+  set_slug: Type.Optional(Type.Union([Type.String(), Type.Null()], { description: 'URL slug for the set' }))
+};
+
+const PriceVariantSchema = Type.Optional(Type.Union([Type.String(), Type.Null()], {
+  description: 'Variant that price, change_1d and change_1d_value come from (the lowest-priced variant)'
+}));
+
+const PriceDateSchema = Type.Optional(Type.Union([Type.String(), Type.Null()], {
+  description: 'Date (YYYY-MM-DD) the price was last updated, for the variant in price_variant'
+}));
+
+const CardIncludeSchema = Type.Optional(Type.String({
+  pattern: '^(variant_prices|graded_variants_prices)(,(variant_prices|graded_variants_prices))*$',
+  description: 'Comma-separated extras to include on each card: variant_prices (per-variant prices and period changes), graded_variants_prices (graded prices keyed by variant then grade)'
+}));
+
 export const CardSchema = Type.Object(
   {
     cardid: Type.String({ description: 'Unique card identifier' }),
@@ -38,15 +72,22 @@ export const CardSchema = Type.Object(
     images: CardImagesSchema,
     setid: Type.String({ description: 'Set this card belongs to' }),
     setname: Type.String({ description: 'Name of the set' }),
+    ...CardFilterFields,
     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' })),
+    price_variant: PriceVariantSchema,
+    price_date: PriceDateSchema,
     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.'
       })
-    )
+    ),
+    graded_variants_prices: Type.Optional({
+      ...GradedVariantPricesSchema,
+      description: 'Graded prices and period changes keyed by variant then grade. Only present when requested via include=graded_variants_prices; empty when the card has no graded prices.'
+    })
   },
   {
     title: 'Card',
@@ -88,7 +129,7 @@ export const CardListQuerySchema = Type.Object(
     setid: Type.Optional(Type.String({ description: 'Filter by set ID' })),
     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' })),
+    include: CardIncludeSchema,
     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' }))
   },
@@ -102,7 +143,7 @@ export const CardBatchQuerySchema = Type.Object({
     minLength: 1,
     description: 'Comma-separated list of card IDs (e.g. "xy1-2,base1-4"). Duplicates are deduped. Max 200 IDs per request.'
   }),
-  include: Type.Optional(Type.Literal('variant_prices', { description: 'Include per-variant prices and period changes on each card' }))
+  include: CardIncludeSchema
 });
 
 export type CardBatchQuery = Static<typeof CardBatchQuerySchema>;
@@ -135,6 +176,12 @@ 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' })),
+    set_release_date: CardFilterFields.set_release_date,
+    series: CardFilterFields.series,
+    slug: CardFilterFields.slug,
+    set_slug: CardFilterFields.set_slug,
+    price_variant: PriceVariantSchema,
+    price_date: PriceDateSchema,
     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' })),
@@ -142,13 +189,7 @@ export const CardDetailSchema = Type.Object(
     variant_prices: Type.Optional(
       Type.Record(Type.String(), PriceStatsSchema, { description: 'Prices and period changes keyed by variant name' })
     ),
-    graded_variants_prices: Type.Optional(
-      Type.Record(
-        Type.String(),
-        Type.Record(Type.String(), PriceStatsSchema),
-        { description: 'Graded prices and period changes keyed by variant then grade' }
-      )
-    )
+    graded_variants_prices: Type.Optional(GradedVariantPricesSchema)
   },
   {
     title: 'CardDetail',
@@ -516,6 +557,17 @@ export const ListTypeSchema = Type.Union(
 
 export type ListType = Static<typeof ListTypeSchema>;
 
+export const ListCoverCardSchema = Type.Object(
+  {
+    cardid: Type.String(),
+    variant: Type.String(),
+    image: Type.Union([Type.String(), Type.Null()], { description: 'Small card image URL' })
+  },
+  { title: 'ListCoverCard' }
+);
+
+export type ListCoverCard = Static<typeof ListCoverCardSchema>;
+
 export const ListSchema = Type.Object(
   {
     uuid: Type.String({ format: 'uuid' }),
@@ -530,7 +582,11 @@ export const ListSchema = Type.Object(
     }),
     card_count: Type.Integer({ description: 'Total entries, including duplicates' }),
     unique_count: Type.Integer({ description: 'Distinct cardids' }),
-    total_value: Type.Number({ description: 'Sum of current USD prices of every entry' })
+    total_value: Type.Number({ description: 'Sum of current USD prices of every entry' }),
+    cover: Type.Array(ListCoverCardSchema, {
+      maxItems: 3,
+      description: 'Up to 3 cards for the list tile: the most recently added entries, or the first slots for binders. Empty when the list has no cards.'
+    })
   },
   { title: 'List' }
 );