Release v0.4.1

Origin-SHA: 80b8f2d8e447ef759b90b6d0a05139acddb8e76c

Author: ryanio

CHANGELOG.md

@@ -1,5 +1,27 @@
 # @opensea/api-types
 
+## 0.4.1
+
+### Patch Changes
+
+- 7969189: Sync OpenAPI spec — pure additive: `Order.asset` and `NftDetailed.subscription` field additions plus pagination defaults loosened on `/api/v2/collections`.
+
+  **New on `Order`:**
+
+  - `asset?: OrderAsset` — `{ identifier?: string; contract: string }`. Surfaces the NFT contract + token ID without loading `protocol_data`. `identifier` is null for collection/criteria offers. Powers the profile endpoints (`/account/{address}/listings`, `/offers`, `/offers_received`) where `protocol_data` is intentionally null for performance. Source: ProjectOpenSea/os2-core#42022.
+
+  **New on `NftDetailed`:**
+
+  - `subscription?: SubscriptionInfoResponse` — `{ expires_at?: string; is_renewable: boolean; is_expired: boolean }`.
+
+  **Loosened on `GET /api/v2/collections`:**
+
+  - `limit` default `10` → `20`, max `100` → `200`.
+
+  **Named exports added:** `OrderAsset`, `SubscriptionInfoResponse`.
+
+  **Tooling:** `update-spec` now runs `biome format` on the output so future syncs don't churn on formatter differences.
+
 ## 0.4.0
 
 ### Minor Changes

opensea-api.json

@@ -2906,17 +2906,17 @@
           {
             "name": "limit",
             "in": "query",
-            "description": "Number of collections to return per page",
+            "description": "Number of items to return per page",
             "required": false,
             "schema": {
               "type": "integer",
               "format": "int32",
-              "description": "Number of collections to return per page",
-              "example": 10,
-              "maximum": 100,
+              "description": "Number of items to return per page",
+              "example": 20,
+              "maximum": 200,
               "minimum": 1
             },
-            "example": 10
+            "example": 20
           },
           {
             "name": "next.value",
@@ -6108,6 +6108,9 @@
               "protocol_address": {
                 "type": "string"
               },
+              "asset": {
+                "$ref": "#/components/schemas/OrderAsset"
+              },
               "remaining_quantity": {
                 "type": "integer",
                 "format": "int64"
@@ -6158,6 +6161,9 @@
           "protocol_address": {
             "type": "string"
           },
+          "asset": {
+            "$ref": "#/components/schemas/OrderAsset"
+          },
           "remaining_quantity": {
             "type": "integer",
             "format": "int64"
@@ -6169,6 +6175,18 @@
         },
         "required": ["chain", "order_hash", "remaining_quantity"]
       },
+      "OrderAsset": {
+        "type": "object",
+        "properties": {
+          "identifier": {
+            "type": "string"
+          },
+          "contract": {
+            "type": "string"
+          }
+        },
+        "required": ["contract"]
+      },
       "Parameters": {
         "type": "object",
         "properties": {
@@ -6292,6 +6310,9 @@
               "protocol_address": {
                 "type": "string"
               },
+              "asset": {
+                "$ref": "#/components/schemas/OrderAsset"
+              },
               "remaining_quantity": {
                 "type": "integer",
                 "format": "int64"
@@ -7499,6 +7520,9 @@
           },
           "rarity": {
             "$ref": "#/components/schemas/Rarity"
+          },
+          "subscription": {
+            "$ref": "#/components/schemas/SubscriptionInfoResponse"
           }
         },
         "required": [
@@ -7548,6 +7572,22 @@
         },
         "required": ["strategy_id", "strategy_version"]
       },
+      "SubscriptionInfoResponse": {
+        "type": "object",
+        "properties": {
+          "expires_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "is_renewable": {
+            "type": "boolean"
+          },
+          "is_expired": {
+            "type": "boolean"
+          }
+        },
+        "required": ["is_expired", "is_renewable"]
+      },
       "Trait": {
         "type": "object",
         "properties": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensea/api-types",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Auto-generated TypeScript types from the OpenSea API OpenAPI spec",
   "license": "MIT",
   "author": "OpenSea Developers",

scripts/update-spec.mjs

@@ -8,6 +8,7 @@
  *   node scripts/update-spec.mjs
  */
 
+import { execFileSync } from "node:child_process";
 import { existsSync, writeFileSync } from "node:fs";
 import { resolve, dirname } from "node:path";
 import { fileURLToPath } from "node:url";
@@ -31,6 +32,16 @@ try {
       `${Object.keys(spec.paths || {}).length} paths, ` +
       `${Object.keys(spec.components?.schemas || {}).length} schemas`,
   );
+
+  // Match the repo's JSON formatting (biome inlines short arrays at lineWidth
+  // 80) so diffs reflect real spec changes, not formatter drift.
+  try {
+    execFileSync("pnpm", ["exec", "biome", "format", "--write", outPath], {
+      stdio: "inherit",
+    });
+  } catch (err) {
+    console.warn(`biome format failed (continuing): ${err.message}`);
+  }
 } catch (err) {
   console.error(`Failed to fetch spec: ${err.message}`);
   if (existsSync(outPath)) {

src/generated.ts

@@ -2075,6 +2075,7 @@ export interface components {
             chain: string;
             protocol_data?: components["schemas"]["ProtocolData"];
             protocol_address?: string;
+            asset?: components["schemas"]["OrderAsset"];
             /** Format: int64 */
             remaining_quantity: number;
             /** Format: int64 */
@@ -2089,11 +2090,16 @@ export interface components {
             chain: string;
             protocol_data?: components["schemas"]["ProtocolData"];
             protocol_address?: string;
+            asset?: components["schemas"]["OrderAsset"];
             /** Format: int64 */
             remaining_quantity: number;
             /** Format: int64 */
             order_created_at?: number;
         };
+        OrderAsset: {
+            identifier?: string;
+            contract: string;
+        };
         Parameters: {
             offerer: string;
             offer: components["schemas"]["Item"][];
@@ -2129,6 +2135,7 @@ export interface components {
             chain: string;
             protocol_data?: components["schemas"]["ProtocolData"];
             protocol_address?: string;
+            asset?: components["schemas"]["OrderAsset"];
             /** Format: int64 */
             remaining_quantity: number;
             /** Format: int64 */
@@ -2491,6 +2498,7 @@ export interface components {
             creator: string;
             owners: components["schemas"]["Owner"][];
             rarity?: components["schemas"]["Rarity"];
+            subscription?: components["schemas"]["SubscriptionInfoResponse"];
         };
         Owner: {
             address: string;
@@ -2504,6 +2512,12 @@ export interface components {
             /** Format: int64 */
             rank?: number;
         };
+        SubscriptionInfoResponse: {
+            /** Format: date-time */
+            expires_at?: string;
+            is_renewable: boolean;
+            is_expired: boolean;
+        };
         Trait: {
             trait_type: string;
             display_type?: string;
@@ -5633,8 +5647,8 @@ export interface operations {
         parameters: {
             query?: {
                 /**
-                 * @description Number of collections to return per page
-                 * @example 10
+                 * @description Number of items to return per page
+                 * @example 20
                  */
                 limit?: number;
                 "next.value"?: string;

src/index.ts

@@ -53,6 +53,7 @@ export type Trait = Schemas["Trait"]
 export type TraitData = Schemas["TraitData"]
 export type NumericTraitData = Schemas["NumericTraitData"]
 export type NumericTraitCriteria = Schemas["NumericTraitCriteria"]
+export type SubscriptionInfoResponse = Schemas["SubscriptionInfoResponse"]
 
 // NFTs — batch
 export type BatchNftsRequest = Schemas["BatchNftsRequest"]
@@ -66,6 +67,7 @@ export type NftSalePointResponse = Schemas["NftSalePointResponse"]
 
 // Orders
 export type Order = Schemas["Order"]
+export type OrderAsset = Schemas["OrderAsset"]
 export type Offer = Schemas["Offer"]
 export type Listing = Schemas["Listing"]
 export type OffersResponse = Schemas["OffersResponse"]