@pfdev/api-types 3.0.24 → 3.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pfdev/api-types",
-  "version": "3.0.24",
+  "version": "3.0.27",
   "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'
 }));
@@ -98,6 +102,7 @@ export const CardSchema = Type.Object(
     ...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,
@@ -195,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' }
 );
@@ -268,6 +276,7 @@ export const CardDetailSchema = Type.Object(
     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: {
@@ -660,7 +669,7 @@ export const ListSchema = Type.Object(
     icon: Type.Union([Type.String(), Type.Null()]),
     color: Type.Union([Type.String(), Type.Null()]),
     is_private: Type.Boolean(),
-    type: Type.Union([ListTypeSchema, Type.Null()]),
+    type: ListTypeSchema,
     binder_config: Type.Union([Type.Number(), Type.Null()], {
       description: 'Binder layout preset. Only set for binders.'
     }),
@@ -724,6 +733,90 @@ export const ListPatchRequestSchema = Type.Object(
 
 export type ListPatchRequest = Static<typeof ListPatchRequestSchema>;
 
+export const ListEntrySchema = Type.Object(
+  {
+    uuid: Type.String({ format: 'uuid', description: 'Unique ID of this entry' }),
+    list_uuid: Type.String({ format: 'uuid' }),
+    cardid: Type.String(),
+    variant_id: Type.Union([Type.Integer(), Type.Null()], { description: 'Variant id (pfdata_variant_definitions.id); matches variants[].id on cards. Null when the variant has no definition.' }),
+    added_at: Type.String({ description: 'When this entry was added' }),
+    slot: Type.Union([Type.Integer(), Type.Null()], { description: 'Binder slot. Null for lists.' }),
+    inventory_uuid: Type.Union([Type.String({ format: 'uuid' }), Type.Null()], { description: 'Inventory copy linked to this binder slot. Null for lists and unlinked slots.' })
+  },
+  { title: 'ListEntry' }
+);
+
+export type ListEntry = Static<typeof ListEntrySchema>;
+
+export const ListEntriesResponseSchema = Type.Array(ListEntrySchema, {
+  title: 'ListEntriesResponse',
+  description: 'Entries in the order they were added.'
+});
+
+const MAX_BATCH = 500;
+
+export const ListEntriesAddRequestSchema = Type.Object(
+  {
+    cards: Type.Array(
+      Type.Object({
+        cardid: Type.String({ minLength: 1 }),
+        variant_id: Type.Integer({ minimum: 1, description: 'Variant id (variants[].id on the card). Must be one of the card\'s variants and not hidden.' })
+      }),
+      { minItems: 1, maxItems: MAX_BATCH }
+    )
+  },
+  { title: 'ListEntriesAddRequest', additionalProperties: false }
+);
+
+export type ListEntriesAddRequest = Static<typeof ListEntriesAddRequestSchema>;
+
+export const ListEntryParamSchema = Type.Object({
+  uuid: Type.String({ format: 'uuid', description: 'UUID of the list' }),
+  entry_uuid: Type.String({ format: 'uuid', description: 'UUID of the entry' })
+});
+
+export type ListEntryParam = Static<typeof ListEntryParamSchema>;
+
+export const ListEntriesDeleteRequestSchema = Type.Object(
+  {
+    uuids: Type.Array(Type.String({ format: 'uuid' }), { minItems: 1, maxItems: MAX_BATCH })
+  },
+  { title: 'ListEntriesDeleteRequest', additionalProperties: false }
+);
+
+export type ListEntriesDeleteRequest = Static<typeof ListEntriesDeleteRequestSchema>;
+
+export const ListCardLimitErrorSchema = Type.Object(
+  {
+    error: Type.String(),
+    message: Type.String(),
+    code: Type.Literal('LIST_CARD_LIMIT'),
+    limit: Type.Integer(),
+    used: Type.Integer({ description: 'Entries currently in the list' }),
+    remaining: Type.Integer({ description: 'Entries that can still be added. 0 when the list is at or over its limit.' })
+  },
+  { title: 'ListCardLimitError' }
+);
+
+export type ListCardLimitError = Static<typeof ListCardLimitErrorSchema>;
+
+const UsageCountSchema = Type.Object({
+  used: Type.Integer(),
+  limit: Type.Integer({ description: '-1 = unlimited' })
+});
+
+export const ListUsageResponseSchema = Type.Object(
+  {
+    lists: UsageCountSchema,
+    binders: UsageCountSchema,
+    cards_per_list: Type.Integer({ description: '-1 = unlimited' }),
+    cards_per_binder: Type.Integer({ description: '-1 = unlimited' })
+  },
+  { title: 'ListUsageResponse' }
+);
+
+export type ListUsageResponse = Static<typeof ListUsageResponseSchema>;
+
 // ============= USERS =============