@pfdev/api-types 3.0.23 → 3.0.25

package/package.json

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

package/v3.ts

@@ -75,6 +75,10 @@ const PriceVariantIdSchema = Type.Optional(Type.Union([Type.Integer(), Type.Null
   description: 'Id of the variant that price, change_1d and change_1d_value come from (the lowest-priced variant that isn\'t hidden)'
 }));
 
+const MaxPriceVariantIdSchema = Type.Optional(Type.Union([Type.Integer(), Type.Null()], {
+  description: 'Id of the variant max_price comes from (the highest-priced variant that isn\'t hidden)'
+}));
+
 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_id'
 }));
@@ -97,6 +101,8 @@ export const CardSchema = Type.Object(
     setname: Type.String({ description: 'Name of the set' }),
     ...CardFilterFields,
     price: Type.Optional(Type.Number({ description: 'Price of the lowest-priced variant' })),
+    max_price: Type.Optional(Type.Number({ description: 'Price of the highest-priced non-hidden variant' })),
+    max_price_variant_id: MaxPriceVariantIdSchema,
     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_id: PriceVariantIdSchema,
@@ -133,8 +139,14 @@ export const CardListSortSchema = Type.Union([
   Type.Literal('price_asc'),
   Type.Literal('price_desc'),
   Type.Literal('change_asc'),
-  Type.Literal('change_desc')
-], { default: 'number_asc', description: 'Sort order. change_* sorts by 1-day percentage price change. Defaults to number_asc.' });
+  Type.Literal('change_desc'),
+  Type.Literal('release_desc'),
+  Type.Literal('release_asc'),
+  Type.Literal('release_desc_price_desc')
+], {
+  default: 'number_asc',
+  description: 'Sort order. change_* sorts by 1-day percentage price change. release_asc/desc sort by set release date, then card number. release_desc_price_desc sorts by newest set, then max_price descending. Cards from sets with no release date come last in every release sort. Defaults to number_asc.'
+});
 
 export type CardListSort = Static<typeof CardListSortSchema>;
 
@@ -158,7 +170,7 @@ export const CardListQuerySchema = Type.Object(
     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 search, setid, rarity, language or variant_id must be provided' }
+  { description: 'With no search or filters, lists every card' }
 );
 
 export type CardListQuery = Static<typeof CardListQuerySchema>;
@@ -168,7 +180,7 @@ export const CardFacetsQuerySchema = Type.Object(
     ...CardListFilterFields,
     search: CardSearchField
   },
-  { description: 'Same search and filters as /cards; at least one of them must be provided' }
+  { description: 'Same search and filters as /cards. With none, returns the facets for every card' }
 );
 
 export type CardFacetsQuery = Static<typeof CardFacetsQuerySchema>;
@@ -188,7 +200,10 @@ export const CardFacetOptionSchema = Type.Object(
     count: Type.Integer({ description: 'Cards this option matches, ignoring this facet\'s own selection' }),
     variant_count: Type.Integer({ description: 'Non-hidden variants on those cards, same counting rule. With variant_id, only the selected variants count.' }),
     order: Type.Optional(Type.Integer({ description: 'Display order, ascending: variant sort_order; sets by release date, newest first (0 = newest); languages English first. Omitted for rarity.' })),
-    group: Type.Optional(CardFacetGroupSchema)
+    group: Type.Optional(CardFacetGroupSchema),
+    language: Type.Optional(Type.String({
+      description: 'Language code of the set (EN, JP). Set options only.'
+    }))
   },
   { title: 'CardFacetOption' }
 );
@@ -260,6 +275,8 @@ export const CardDetailSchema = Type.Object(
     price_variant_id: PriceVariantIdSchema,
     price_date: PriceDateSchema,
     price: Type.Optional(Type.Number({ description: 'Price of the lowest-priced variant' })),
+    max_price: Type.Optional(Type.Number({ description: 'Price of the highest-priced non-hidden variant' })),
+    max_price_variant_id: MaxPriceVariantIdSchema,
     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: {