feat: Simplify createResouceRouter and add option to set subrouter co…

…nfig Signed-off-by: Jorgen Ader <[email protected]>
thorgate · Nov 19, 2024 · dcbc1c1 · dcbc1c1
1 parent 202a6fd
commit dcbc1c1
Show file tree

Hide file tree

Showing 6 changed files with 394 additions and 52 deletions.
diff --git a/packages/core/src/router-builder/builder.ts b/packages/core/src/router-builder/builder.ts
@@ -6,34 +6,30 @@ import {
     Kwargs,
     ObjectMap,
     ResourceInterface,
+    RouteConfig,
     RouteMap,
     RouterDefinition,
 } from '../types';
 
 import {
-    CreateResourceFactory,
     ResourceClassConstructor,
     ResourceConstructorObject,
     ResourceTuple,
     RouterBuilderInterface,
 } from './types';
-import { isResourceConstructorObject, isResourceTuple } from './utils';
+import {
+    createResource,
+    isResourceConstructorObject,
+    isResourceTuple,
+} from './utils';
 
-export class RouterBuilder<
-    Klass extends Resource<any, any, any, any>,
-    InstanceKlass extends Resource<any, any, any, any> = Klass
-> implements RouterBuilderInterface
+export class RouterBuilder<Klass extends Resource<any, any, any, any>>
+    implements RouterBuilderInterface<Klass>
 {
-    private readonly resourceKlass: ResourceClassConstructor<Klass>;
-
-    private readonly createResourceFactory: CreateResourceFactory<InstanceKlass>;
+    public readonly resourceKlass: ResourceClassConstructor<Klass>;
 
-    constructor(
-        resourceKlass: ResourceClassConstructor<Klass>,
-        createResourceFactory: CreateResourceFactory<InstanceKlass>
-    ) {
+    constructor(resourceKlass: ResourceClassConstructor<Klass>) {
         this.resourceKlass = resourceKlass;
-        this.createResourceFactory = createResourceFactory;
     }
 
     resource<
@@ -45,7 +41,7 @@ export class RouterBuilder<
         endpointConfig: ResourceTuple | ResourceConstructorObject | string
     ): ResourceInterface<Params, TFetchResponse, TPostPayload, TPostResponse> {
         if (isString(endpointConfig)) {
-            return this.createResourceFactory(
+            return createResource(
                 this.resourceKlass,
                 endpointConfig,
                 null
@@ -60,7 +56,7 @@ export class RouterBuilder<
         if (isResourceTuple(endpointConfig)) {
             const [apiEndpoint, resourceConfig] =
                 endpointConfig as ResourceTuple;
-            return this.createResourceFactory(
+            return createResource(
                 this.resourceKlass,
                 apiEndpoint,
                 resourceConfig
@@ -75,7 +71,7 @@ export class RouterBuilder<
         if (isResourceConstructorObject(endpointConfig)) {
             const { apiEndpoint, ...resourceConfig } = endpointConfig;
 
-            return this.createResourceFactory(
+            return createResource(
                 this.resourceKlass,
                 apiEndpoint,
                 resourceConfig
@@ -91,10 +87,11 @@ export class RouterBuilder<
     }
 
     router<TRouteMap extends RouteMap>(
-        builder: (build: this) => TRouteMap
+        builder: (build: this) => TRouteMap,
+        config: RouteConfig | null = null
     ): RouterDefinition<TRouteMap> {
         const definition = builder(this);
 
-        return new Router(definition) as Router & TRouteMap;
+        return new Router(definition, config) as Router & TRouteMap;
     }
 }
diff --git a/packages/core/src/router-builder/createResourceRouter.ts b/packages/core/src/router-builder/createResourceRouter.ts
@@ -4,28 +4,16 @@ import { RouteMap, RouterInterface } from '../types';
 
 import { RouterBuilder } from './builder';
 import { CreateResourceRouterOptions } from './types';
-import { createResource } from './utils';
 
 export function createResourceRouter<
     Klass extends Resource<any, any, any, any>,
-    Definitions extends RouteMap,
-    InstanceKlass extends Resource<any, any, any, any> = Klass
+    Definitions extends RouteMap
 >(
-    options: CreateResourceRouterOptions<Klass, Definitions, InstanceKlass>
+    options: CreateResourceRouterOptions<Klass, Definitions>
 ): RouterInterface & Definitions {
-    const {
-        resource,
-        createResourceFactory = createResource as Exclude<
-            typeof options['createResourceFactory'],
-            undefined
-        >,
-        routerBuilder,
-    } = options;
+    const { config, resource, routerBuilder } = options;
 
-    const builder = new RouterBuilder<Klass, InstanceKlass>(
-        resource,
-        createResourceFactory
-    );
+    const builder = new RouterBuilder<Klass>(resource);
 
-    return new Router(routerBuilder(builder)) as Router & Definitions;
+    return new Router(routerBuilder(builder), config) as Router & Definitions;
 }
diff --git a/packages/core/src/router-builder/types.ts b/packages/core/src/router-builder/types.ts
@@ -32,7 +32,11 @@ export type CreateResourceFactory<
     options?: ObjectMap
 ) => InstanceKlass;
 
-export interface RouterBuilderInterface {
+export interface RouterBuilderInterface<
+    Klass extends Resource<any, any, any, any>
+> {
+    resourceKlass: ResourceClassConstructor<Klass>;
+
     resource<
         Params extends Kwargs | null = Kwargs,
         TFetchResponse = any,
@@ -43,25 +47,20 @@ export interface RouterBuilderInterface {
     ): ResourceInterface<Params, TFetchResponse, TPostPayload, TPostResponse>;
 
     router<TRouteMap extends RouteMap>(
-        builder: (build: this) => TRouteMap
+        builder: (build: this) => TRouteMap,
+        config?: RouteConfig | null
     ): RouterInterface & TRouteMap;
 }
 
 export interface CreateResourceRouterOptions<
     Klass extends Resource<any, any, any, any>,
-    Definitions extends RouteMap,
-    InstanceKlass extends Resource<any, any, any, any> = Klass
+    Definitions extends RouteMap
 > {
     /**
      * The resource class to use when creating resources
      */
     resource: ResourceClassConstructor<Klass>;
 
-    /**
-     * Helper function used to create resource instances
-     */
-    createResourceFactory?: CreateResourceFactory<InstanceKlass>;
-
     /**
      * Router configuration
      */
@@ -71,5 +70,5 @@ export interface CreateResourceRouterOptions<
      * Build router definition
      * @param build
      */
-    routerBuilder: (build: RouterBuilderInterface) => Definitions;
+    routerBuilder: (build: RouterBuilderInterface<Klass>) => Definitions;
 }
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -322,6 +322,9 @@ export interface ResourceInterface<
 
     config(requestConfig?: RequestConfig): ConfigType;
 
+    getHeaders(requestConfig?: RequestConfig): Record<string, string | null>;
+    getCookies(requestConfig?: RequestConfig): Record<string, string | null>;
+
     fetch<TResponse = TFetchResponse, TParams extends Params = Params>(
         kwargs?: TParams | null,
         query?: Query | null,
@@ -392,8 +395,6 @@ export interface ResourceInterface<
         urlParams?: TParams | null,
         requestConfig?: RequestConfig | null
     ): string;
-
-    [key: string]: any;
 }
 
 export abstract class ResourceErrorInterface {