@pfdev/api-types 3.0.29 → 3.0.31

package/package.json

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

package/v3.ts

@@ -156,7 +156,11 @@ const CardListFilterFields = {
   setid: Type.Optional(Type.String({ description: 'Comma-separated set IDs (max 500). A single ID behaves as before.' })),
   rarity: Type.Optional(Type.String({ description: 'Comma-separated rarities (max 50), matched exactly. A rarity matches cards in every language.' })),
   language: Type.Optional(Type.String({ description: 'Comma-separated language codes (EN, JP; max 50)' })),
-  variant_id: Type.Optional(Type.String({ description: 'Comma-separated variant ids (variants[].id, max 50). Matches non-hidden variants only.' }))
+  variant_id: Type.Optional(Type.String({ description: 'Comma-separated variant ids (variants[].id, max 50). Matches non-hidden variants only.' })),
+  pokemon_id: Type.Optional(Type.Integer({
+    minimum: 1,
+    description: 'Only cards tied to this Pokémon (DexEntry.id, as in /dex and /users/me/dex/collection). An unknown id matches no cards.'
+  }))
 };
 
 const CardSearchField = 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.' }));
@@ -457,7 +461,7 @@ export const SealedItemSchema = Type.Object(
     set_name: Type.Optional(Type.String({ description: 'Name of the set' })),
     product_slug: Type.Optional(Type.String({ description: 'Product URL slug' })),
     set_slug: Type.Optional(Type.String({ description: 'Set URL slug' })),
-    image: Type.Optional(Type.String({ description: 'Product image URL' })),
+    image: Type.Optional(Type.String({ description: 'Product image URL (WebP on the Pokefolio CDN). Not every product has an image there yet.' })),
     tcgp_id: Type.Optional(Type.Number({ description: 'TCGPlayer product ID' })),
     language: Type.Optional(Type.String({ description: 'Product language' })),
     price: Type.Optional(Type.Number({ description: 'Current market price' })),
@@ -755,12 +759,22 @@ const ComparisonRangeSchema = Type.Union(
   { description: 'Period the change was measured over. ALL is measured over 1Y, the longest past price available.' }
 );
 
-export const CollectionAllocationSchema = Type.Object(
+const AllocationFields = {
+  value: Type.Number({ description: 'Market value in USD' }),
+  items: Type.Integer({ description: 'Items owned, counting each copy' }),
+  no_price_count: Type.Integer({ description: 'Copies with no current price, counted in items but adding nothing to value' })
+};
+
+export const CollectionAllocationSchema = Type.Object(AllocationFields, { title: 'CollectionAllocation' });
+
+export const CollectionCardAllocationSchema = Type.Object(
   {
-    value: Type.Number({ description: 'Market value in USD' }),
-    items: Type.Integer({ description: 'Items owned, counting each copy' })
+    ...AllocationFields,
+    assumed_raw_count: Type.Integer({
+      description: 'Graded copies valued at the raw price because their grade has no current price'
+    })
   },
-  { title: 'CollectionAllocation' }
+  { title: 'CollectionCardAllocation' }
 );
 
 export const CollectionSummaryResponseSchema = Type.Object(
@@ -768,7 +782,7 @@ export const CollectionSummaryResponseSchema = Type.Object(
     total_value: Type.Number({ description: 'Market value of everything owned, in USD' }),
     items: Type.Integer({ description: 'Items owned, counting each copy' }),
     allocation: Type.Object({
-      cards: CollectionAllocationSchema,
+      cards: CollectionCardAllocationSchema,
       sealed: CollectionAllocationSchema
     })
   },
@@ -1129,6 +1143,9 @@ export const InventorySummaryItemSchema = Type.Object(
     status: Type.Union([Type.Number(), Type.Null()], {
       description: 'Numeric status code. <100 = active, >=100 = sold/past. Null when no details row exists yet.'
     }),
+    grade: Type.Union([Type.String(), Type.Null()], {
+      description: 'Grade of this copy (e.g. "PSA 10"), matching a key of variants[].graded. Null when ungraded or no details row exists yet.'
+    }),
     acquired: Type.Union([Type.String(), Type.Null()], {
       description: 'User-entered acquired date. Null when not set or no details row exists yet.'
     }),