@brickset-api/types 0.0.14 → 0.0.16

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @brickset-api/types
 
+## 0.0.16
+
+### Patch Changes
+
+- ed9db77: Update endpoints
+
+## 0.0.15
+
+### Patch Changes
+
+- 2d77e7e: Update types
+
 ## 0.0.14
 
 ### Patch Changes

package/data/get-themes.ts

@@ -0,0 +1,11 @@
+export type GetThemes = GetThemesBase;
+
+export type GetThemesOptions = unknown;
+
+export type GetThemesBase = {
+  theme: String;
+  setCount: Number;
+  subthemeCount: Number;
+  yearFrom: Number;
+  yearTo: Number;
+};

package/endpoints.ts

@@ -1,4 +1,5 @@
 import type { GetSets } from "./data/get-sets";
+import type { GetThemes } from "./data/get-themes";
 
 export type KnownAuthenticatedEndpoint =
   | '/setCollection';
@@ -25,14 +26,15 @@ export type ApiKeyOptions = {
   apiKey: string;
 };
 
-export type AuthenticatedOptions = ApiKeyOptions & {
+export type AuthenticatedOptions = {
   userHash: string;
 };
 
 export type OptionsByEndpoint<Endpoint extends string> =
   Endpoint extends UrlWithParams<'/api/v3.asmx/getSets'> ? Options & ApiKeyOptions :
-  Endpoint extends '/api/v3.asmx/getThemes' ? Options & ApiKeyOptions :
-  Partial<AuthenticatedOptions & ApiKeyOptions>;
+  Endpoint extends KnownAuthenticatedEndpoint ? Options & ApiKeyOptions & AuthenticatedOptions :
+  Endpoint extends KnownEndpoint ? Options & ApiKeyOptions :
+  Partial<ApiKeyOptions>;
 
 // Common Brickset API v3 response
 export type ApiResponse<T> = { status: 'success' } & T | { status: 'error'; message: string };
@@ -42,7 +44,7 @@ export type ApiResponse<T> = { status: 'success' } & T | { status: 'error'; mess
 // result type for endpoint
 export type EndpointType<Url extends KnownEndpoint | (string & {})> =
   Url extends UrlWithParams<'/api/v3.asmx/getSets'> ? ApiResponse<{ matches: number; sets: GetSets[] }> :
-  Url extends '/api/v3.asmx/getThemes' ? ApiResponse<{ matches: number, themes: string[] }> :
+  Url extends '/api/v3.asmx/getThemes' ? ApiResponse<{ matches: number, themes: GetThemes[] }> :
   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.14",
+  "version": "0.0.16",
   "description": "TypeScript types for all datastructures used by the Brickset API",
   "license": "MIT",
   "repository": {