Improve options

GW2Treasures · Jul 24, 2024 · 34e7164 · 34e7164
1 parent 2bd4055
commit 34e7164
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/.changeset/rotten-bats-smell.md b/.changeset/rotten-bats-smell.md
@@ -0,0 +1,5 @@
+---
+"@gw2api/fetch": minor
+---
+
+Make `options` parameter optional if it does not contain required properties
diff --git a/.changeset/two-needles-sip.md b/.changeset/two-needles-sip.md
@@ -0,0 +1,6 @@
+---
+"@gw2api/fetch": patch
+"@gw2api/types": patch
+---
+
+Allow passing partial options for unknown endpoints
diff --git a/packages/fetch/src/index.ts b/packages/fetch/src/index.ts
@@ -1,14 +1,18 @@
 import type { AuthenticatedOptions, EndpointType, KnownEndpoint, LocalizedOptions, OptionsByEndpoint } from '@gw2api/types/endpoints';
 import { SchemaVersion } from '@gw2api/types/schema';
 
-// TODO: make `options` optional if `OptionsByEndpoint<Url>` only contains optional props
+type RequiredKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? never : K }[keyof T];
+
+// if OptionsByEndpoint<Url> has no required keys, make the options parameter optional
+type Args<Url extends string, Schema extends SchemaVersion> = RequiredKeys<OptionsByEndpoint<Url>> extends never
+  ? [endpoint: Url, options?: FetchGw2ApiOptions<Schema> & OptionsByEndpoint<Url> & FetchOptions]
+  : [endpoint: Url, options: FetchGw2ApiOptions<Schema> & OptionsByEndpoint<Url> & FetchOptions]
 
 export function fetchGw2Api<
   Url extends KnownEndpoint | (string & {}),
   Schema extends SchemaVersion = undefined
 >(
-  endpoint: Url,
-  options: FetchGw2ApiOptions<Schema> & OptionsByEndpoint<Url> & FetchOptions
+  ...[endpoint, options]: Args<Url, Schema>
 ): Promise<EndpointType<Url, Schema>> {
   const url = new URL(endpoint, 'https://api.guildwars2.com/');
 

diff --git a/packages/types/endpoints.ts b/packages/types/endpoints.ts
@@ -362,7 +362,8 @@ export type OptionsByEndpoint<Endpoint extends string> =
   Endpoint extends KnownAuthenticatedEndpoint ? Options & AuthenticatedOptions :
   Endpoint extends KnownLocalizedEndpoint ? Options & LocalizedOptions :
   Endpoint extends CreateSubtokenUrl<'/v2/createsubtoken'> ? Options & AuthenticatedOptions :
-  Options
+  Endpoint extends KnownEndpoint | BulkExpandedEndpointUrl<KnownBulkExpandedEndpoint, string | number> ? Options :
+  Partial<AuthenticatedOptions & LocalizedOptions>
 
 // result type for endpoint
 export type EndpointType<Url extends KnownEndpoint | (string & {}), Schema extends SchemaVersion = undefined> =