@brickset-api/types 0.0.10 → 0.0.12

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @brickset-api/types
 
+## 0.0.12
+
+### Patch Changes
+
+- 12f1397: Update types
+
+## 0.0.11
+
+### Patch Changes
+
+- f315e4d: Update endpoint types
+
 ## 0.0.10
 
 ### Patch Changes

package/data/get-sets.ts

@@ -1,6 +1,4 @@
-export type GetSets = GetSetsResponse;
-
-export type Item = ItemBase;
+export type GetSets = GetSetsBase;
 
 export type GetSetsOptions = {
   setID?: number;
@@ -23,14 +21,7 @@ export type GetSetsOptions = {
   extendedData?: boolean;
 };
 
-interface GetSetsResponse {
-  message?: string;
-  status: string;
-  matches?: number;
-  sets?: ItemBase[];
-}
-
-interface ItemBase {
+interface GetSetsBase {
   setID: number;
   number: string;
   numberVariant: string;

package/endpoints.ts

@@ -10,16 +10,6 @@ export type KnownUnauthorizedEndpoint =
 
 export type KnownEndpoint = KnownAuthenticatedEndpoint | KnownUnauthorizedEndpoint;
 
-// helper types for parameters
-type CombineParameters<P1 extends string, P2 extends string> = `${P1}&${P2}` | `${P2}&${P1}`;
-
-type WithParameters<Url extends string, Parameters extends string | undefined> =
-  Parameters extends undefined ? Url : `${Url}?${Parameters}`;
-
-// helper for endpoints with parameters
-type ParamsParameter = `params=${string}`;
-type EndpointWithParams<Endpoint extends KnownEndpoint> = WithParameters<Endpoint, ParamsParameter>;
-
 // options
 type Options = {};
 
@@ -37,14 +27,9 @@ export type OptionsByEndpoint<Endpoint extends string> =
   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 '/api/v3.asmx/getSets' ? ApiResponse<{ sets: GetSets }> :
+  Url extends '/api/v3.asmx/getSets' ? { status: 'error'; message: string } | { status: 'success'; matches: number; 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.10",
+  "version": "0.0.12",
   "description": "TypeScript types for all datastructures used by the Brickset API",
   "license": "MIT",
   "repository": {
@@ -28,7 +28,7 @@
     "build": "tsc"
   },
   "devDependencies": {
-    "typescript": "5.5.4"
+    "typescript": "5.6.2"
   },
   "publishConfig": {
     "access": "public"