@brickset-api/types 0.0.8 → 0.0.10

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @brickset-api/types
 
+## 0.0.10
+
+### Patch Changes
+
+- df6f3b5: Create new release
+
+## 0.0.9
+
+### Patch Changes
+
+- 92ab17b: Update types
+
 ## 0.0.8
 
 ### Patch Changes

package/data/get-sets.ts

@@ -1,4 +1,4 @@
-export type GetSets = GetSets_Response;
+export type GetSets = GetSetsResponse;
 
 export type Item = ItemBase;
 
@@ -23,7 +23,7 @@ export type GetSetsOptions = {
   extendedData?: boolean;
 };
 
-interface GetSets_Response {
+interface GetSetsResponse {
   message?: string;
   status: string;
   matches?: number;

package/endpoints.ts

@@ -1,13 +1,12 @@
 import type { GetSets } from "./data/get-sets";
 
-// options
-type Options = {};
-
 export type KnownAuthenticatedEndpoint =
-  | '/v3.asmx/setCollection';
+  | '/setCollection';
 
 export type KnownUnauthorizedEndpoint =
-  | '/v3.asmx/getSets';
+  | '/api/v3.asmx/getSets'
+  | '/api/v3.asmx/getThemes'
+  | '/api/v3.asmx/getYears';
 
 export type KnownEndpoint = KnownAuthenticatedEndpoint | KnownUnauthorizedEndpoint;
 
@@ -17,9 +16,12 @@ 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 endpoints with parameters
+type ParamsParameter = `params=${string}`;
+type EndpointWithParams<Endpoint extends KnownEndpoint> = WithParameters<Endpoint, ParamsParameter>;
+
+// options
+type Options = {};
 
 export type ApiKeyOptions = {
   apiKey: string;
@@ -30,13 +32,19 @@ export type AuthenticatedOptions = ApiKeyOptions &{
 };
 
 export type OptionsByEndpoint<Endpoint extends string> =
-  Endpoint extends KnownAuthenticatedEndpoint ? Options & AuthenticatedOptions :
-  Endpoint extends KnownUnauthorizedEndpoint ? Options & ApiKeyOptions :
-  ApiKeyOptions & Partial<AuthenticatedOptions>;
+  Endpoint extends '/api/v3.asmx/getSets' ? Options & { params: string } & ApiKeyOptions :
+  Endpoint extends '/api/v3.asmx/getThemes' ? Options & ApiKeyOptions :
+  Endpoint extends '/api/v3.asmx/getYears' ? Options & { theme?: string } & ApiKeyOptions :
+  Partial<AuthenticatedOptions & ApiKeyOptions>;
+
+type ApiResponse<T> = {
+  status: string;
+  message?: string;
+} & T;
 
 // result type for endpoint
 export type EndpointType<Url extends KnownEndpoint | (string & {})> =
-  Url extends '/v3.asmx/getSets' ? GetSets :
+  Url extends '/api/v3.asmx/getSets' ? ApiResponse<{ sets: 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.8",
+  "version": "0.0.10",
   "description": "TypeScript types for all datastructures used by the Brickset API",
   "license": "MIT",
   "repository": {