@brickset-api/types 0.0.7 → 0.0.9

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @brickset-api/types
 
+## 0.0.9
+
+### Patch Changes
+
+- 92ab17b: Update types
+
+## 0.0.8
+
+### Patch Changes
+
+- 8974e13: Update types
+
 ## 0.0.7
 
 ### Patch Changes

package/data/get-sets.ts

@@ -1,4 +1,6 @@
-export type GetSets = GetSets_Response;
+export type GetSets = GetSetsResponse;
+
+export type Item = ItemBase;
 
 export type GetSetsOptions = {
   setID?: number;
@@ -21,14 +23,14 @@ export type GetSetsOptions = {
   extendedData?: boolean;
 };
 
-interface GetSets_Response {
+interface GetSetsResponse {
   message?: string;
   status: string;
   matches?: number;
-  sets?: GetSets_Base[];
+  sets?: ItemBase[];
 }
 
-interface GetSets_Base {
+interface ItemBase {
   setID: number;
   number: string;
   numberVariant: string;
@@ -41,37 +43,15 @@ interface GetSets_Base {
   released: boolean;
   pieces: number;
   minifigs: number;
-  image: {
-    thumbnailURL: string;
-    imageURL: string;
-  };
+  image: Image;
   bricksetURL: string;
-  collection: {}
-  collections: {
-    ownedBy: number;
-    wantedBy: number;
-  };
+  collection: Collection;
+  collections: Collections;
   LEGOCom: {
-    US: {
-      retailPrice: number;
-      dateFirstAvailable: string;
-      dateLastAvailable: string;
-    };
-    UK: {
-      retailPrice: number;
-      dateFirstAvailable: string;
-      dateLastAvailable: string;
-    };
-    CA: {
-      retailPrice: number;
-      dateFirstAvailable: string;
-      dateLastAvailable: string;
-    };
-    DE: {
-      retailPrice: number;
-      dateFirstAvailable: string;
-      dateLastAvailable: string;
-    };
+    US: LEGOComDetails;
+    UK: LEGOComDetails;
+    CA: LEGOComDetails;
+    DE: LEGOComDetails;
   };
   rating: number;
   reviewCount: number;
@@ -79,20 +59,56 @@ interface GetSets_Base {
   availability: string;
   instructionsCount: number;
   additionalImageCount: number;
-  ageRange: {
-    min: number;
-    max: number;
-  };
-  dimensions: {
-    height: number;
-    width: number;
-    depth: number;
-    weight: number;
-  };
-  barcodes: {
-    EAN: string;
-    UPC: string;
-  };
-  extendedData: {};
+  ageRange: AgeRange;
+  dimensions: Dimensions;
+  barcodes: Barcodes;
+  extendedData: ExtendedData;
   lastUpdated: string;
 }
+
+interface LEGOComDetails {
+  retailPrice?: number;
+  dateFirstAvailable?: string;
+  dateLastAvailable?: string;
+}
+
+interface Dimensions {
+  height?: number;
+  width?: number;
+  depth?: number;
+  weight?: number;
+}
+
+interface ExtendedData {
+  notes: string;
+  tags: string[];
+  description: string;
+}
+
+interface Collection {
+  owned?: boolean;
+  wanted?: boolean;
+  qtyOwned?: number;
+  rating?: number;
+  notes: string;
+}
+
+interface Collections {
+  ownedBy?: number;
+  wantedBy?: number;
+}
+
+interface Barcodes {
+  EAN: string;
+  UPC: string;
+}
+
+interface AgeRange {
+  min?: number;
+  max?: number;
+}
+
+interface Image {
+  thumbnailURL: string;
+  imageURL: string;
+}

package/endpoints.ts

@@ -1,13 +1,10 @@
 import type { GetSets } from "./data/get-sets";
 
-// options
-type Options = {};
-
 export type KnownAuthenticatedEndpoint =
-  | '/v3.asmx/setCollection';
+  | '/setCollection';
 
 export type KnownUnauthorizedEndpoint =
-  | '/v3.asmx/getSets';
+  | '/getSets';
 
 export type KnownEndpoint = KnownAuthenticatedEndpoint | KnownUnauthorizedEndpoint;
 
@@ -17,9 +14,19 @@ type CombineParameters<P1 extends string, P2 extends string> = `${P1}&${P2}` | `
 type WithParameters<Url extends string, Parameters extends string | undefined> =
   Parameters extends undefined ? Url : `${Url}?${Parameters}`;
 
-  // helper for paginated endpoints
-  type PaginationParameters = `pageNumber=${number}` | CombineParameters<`pageNumber=${number}`, `pageSize=${number}`>;
-  type PaginatedEndpointUrl<Endpoint extends KnownEndpoint> = Endpoint | WithParameters<Endpoint, PaginationParameters>;
+// helper for paginated endpoints
+type PaginationParameters = `pageNumber=${number}` | CombineParameters<`pageNumber=${number}`, `pageSize=${number}`>;
+type PaginatedEndpointUrl<Endpoint extends KnownEndpoint> = Endpoint | WithParameters<Endpoint, PaginationParameters>;
+
+// helper for endpoints with parameters
+type ParamsParameter = `params=${string}`;
+type EndpointWithParams<Endpoint extends KnownEndpoint> = WithParameters<Endpoint, ParamsParameter>;
+
+type BulkExpandedManyEndpointUrl<Endpoint extends KnownEndpoint> = EndpointWithParams<Endpoint>;
+type BulkExpandedEndpointUrl<Endpoint extends KnownEndpoint> = BulkExpandedManyEndpointUrl<Endpoint> | Endpoint;
+
+// options
+type Options = {};
 
 export type ApiKeyOptions = {
   apiKey: string;
@@ -30,13 +37,15 @@ export type AuthenticatedOptions = ApiKeyOptions &{
 };
 
 export type OptionsByEndpoint<Endpoint extends string> =
+  Endpoint extends BulkExpandedEndpointUrl<KnownEndpoint & KnownUnauthorizedEndpoint> ? Options & ApiKeyOptions :
   Endpoint extends KnownAuthenticatedEndpoint ? Options & AuthenticatedOptions :
   Endpoint extends KnownUnauthorizedEndpoint ? Options & ApiKeyOptions :
+  Endpoint extends KnownEndpoint ? Options & ApiKeyOptions :
   ApiKeyOptions & Partial<AuthenticatedOptions>;
 
 // result type for endpoint
 export type EndpointType<Url extends KnownEndpoint | (string & {})> =
-  Url extends '/v3.asmx/getSets' ? GetSets :
+  Url extends BulkExpandedEndpointUrl<'/getSets'> ? GetSets :
   unknown;
 
 export type ValidateEndpointUrl<T extends string> = unknown extends EndpointType<T> ? 'unknown endpoint url' : T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brickset-api/types",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "TypeScript types for all datastructures used by the Brickset API",
   "license": "MIT",
   "repository": {