@ahoo-wang/fetcher-decorator 1.5.0 → 1.5.1

package/dist/apiDecorator.d.ts

@@ -1,4 +1,4 @@
-import { Fetcher, RequestHeaders, RequestHeadersCapable, TimeoutCapable } from '@ahoo-wang/fetcher';
+import { AttributesCapable, Fetcher, RequestHeaders, RequestHeadersCapable, TimeoutCapable } from '@ahoo-wang/fetcher';
 import { ResultExtractorCapable } from './resultExtractor';
 import { FetcherCapable } from './fetcherCapable';
 /**
@@ -8,7 +8,7 @@ import { FetcherCapable } from './fetcherCapable';
  * These settings will be used as defaults for all endpoints within the class unless overridden
  * at the method level.
  */
-export interface ApiMetadata extends TimeoutCapable, RequestHeadersCapable, ResultExtractorCapable, FetcherCapable {
+export interface ApiMetadata extends TimeoutCapable, RequestHeadersCapable, ResultExtractorCapable, FetcherCapable, AttributesCapable {
     /**
      * Base path for all endpoints in the class.
      *

package/dist/apiDecorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apiDecorator.d.ts","sourceRoot":"","sources":["../src/apiDecorator.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACpB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,WAAW,WACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,cAAc;IAChB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,gBAAgB,eAAyB,CAAC;AAwDvD,wBAAgB,GAAG,CACjB,QAAQ,GAAE,MAAW,EACrB,QAAQ,GAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAM,IAE3B,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,aAAa,CAAC,KAAG,CAAC,CAgB3E"}
+{"version":3,"file":"apiDecorator.d.ts","sourceRoot":"","sources":["../src/apiDecorator.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,KAAK,iBAAiB,EACtB,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACpB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAGvD;;;;;;GAMG;AACH,MAAM,WAAW,WACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EAAE,iBAAiB;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,gBAAgB,eAAyB,CAAC;AAwDvD,wBAAgB,GAAG,CACjB,QAAQ,GAAE,MAAW,EACrB,QAAQ,GAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAM,IAE3B,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,aAAa,CAAC,KAAG,CAAC,CAgB3E"}

package/dist/functionMetadata.d.ts

@@ -0,0 +1,151 @@
+import { Fetcher, FetchExchangeInit, NamedCapable, ResultExtractor } from '@ahoo-wang/fetcher';
+import { ApiMetadata } from './apiDecorator';
+import { EndpointMetadata } from './endpointDecorator';
+import { ParameterMetadata } from './parameterDecorator';
+/**
+ * Metadata container for a function with HTTP endpoint decorators.
+ *
+ * Encapsulates all the metadata needed to execute an HTTP request
+ * for a decorated method, including API-level defaults, endpoint-specific
+ * configuration, and parameter metadata.
+ */
+export declare class FunctionMetadata implements NamedCapable {
+    /**
+     * Name of the function.
+     */
+    name: string;
+    /**
+     * API-level metadata (class-level configuration).
+     */
+    api: ApiMetadata;
+    /**
+     * Endpoint-level metadata (method-level configuration).
+     */
+    endpoint: EndpointMetadata;
+    /**
+     * Metadata for method parameters.
+     *
+     * Defines the metadata stored for each parameter decorated with @path, @query,
+     * @header, or @body decorators. Stored as a Map keyed by parameter index.
+     *
+     * @remarks
+     * The metadata is stored as a Map<number, ParameterMetadata> where the key is
+     * the parameter index and the value is the parameter metadata. This ensures
+     * correct parameter ordering regardless of decorator application order.
+     */
+    parameters: Map<number, ParameterMetadata>;
+    /**
+     * Creates a new FunctionMetadata instance.
+     *
+     * @param name - The name of the function
+     * @param api - API-level metadata
+     * @param endpoint - Endpoint-level metadata
+     * @param parameters - Parameter metadata array
+     */
+    constructor(name: string, api: ApiMetadata, endpoint: EndpointMetadata, parameters: Map<number, ParameterMetadata>);
+    /**
+     * Gets the fetcher instance to use for this function.
+     *
+     * Returns the fetcher specified in the endpoint metadata, or the API metadata,
+     * or falls back to the default fetcher if none is specified.
+     *
+     * @returns The fetcher instance
+     */
+    get fetcher(): Fetcher;
+    /**
+     * Resolves the complete path by combining base path and endpoint path
+     *
+     * @param parameterPath - Optional path parameter to use instead of endpoint path
+     * @returns The combined URL path
+     */
+    resolvePath(parameterPath?: string): string;
+    /**
+     * Resolves the timeout for the request.
+     *
+     * Returns the timeout specified in the endpoint metadata, or the API metadata,
+     * or undefined if no timeout is specified.
+     *
+     * @returns The timeout value in milliseconds, or undefined
+     */
+    resolveTimeout(): number | undefined;
+    resolveResultExtractor(): ResultExtractor<any>;
+    resolveAttributes(): Record<string, any>;
+    /**
+     * Resolves the request configuration from the method arguments.
+     *
+     * This method processes the runtime arguments according to the parameter metadata
+     * and constructs a FetcherRequest object with path parameters, query parameters,
+     * headers, body, and timeout. It handles various parameter types including:
+     * - Path parameters (@path decorator)
+     * - Query parameters (@query decorator)
+     * - Header parameters (@header decorator)
+     * - Body parameter (@body decorator)
+     * - Complete request object (@request decorator)
+     * - AbortSignal for request cancellation
+     *
+     * The method uses mergeRequest to combine the endpoint-specific configuration
+     * with the parameter-provided request object, where the parameter request
+     * takes precedence over endpoint configuration.
+     *
+     * @param args - The runtime arguments passed to the method
+     * @returns A FetcherRequest object with all request configuration
+     *
+     * @example
+     * ```typescript
+     * // For a method decorated like:
+     * @get('/users/{id}')
+     * getUser(
+     *   @path('id') id: number,
+     *   @query('include') include: string,
+     *   @header('Authorization') auth: string
+     * ): Promise<Response>
+     *
+     * // Calling with: getUser(123, 'profile', 'Bearer token')
+     * // Would produce a request with:
+     * // {
+     * //   method: 'GET',
+     * //   urlParams: {
+     * //     path: { id: 123 },
+     * //     query: { include: 'profile' }
+     * //   },
+     * //   headers: {
+     * //     'Authorization': 'Bearer token',
+     * //     ...apiHeaders,
+     * //     ...endpointHeaders
+     * //   }
+     * // }
+     * ```
+     */
+    resolveExchangeInit(args: any[]): Required<Pick<FetchExchangeInit, 'request' | 'attributes'>>;
+    private processPathParam;
+    private processQueryParam;
+    private processHeaderParam;
+    /**
+     * Processes a request parameter value.
+     *
+     * This method handles the @request() decorator parameter by casting
+     * the provided value to a FetcherRequest. The @request() decorator
+     * allows users to pass a complete FetcherRequest object to customize
+     * the request configuration.
+     *
+     * @param value - The value provided for the @request() parameter
+     * @returns The value cast to FetcherRequest type
+     *
+     * @example
+     * ```typescript
+     * @post('/users')
+     * createUsers(@request() request: FetcherRequest): Promise<Response>
+     *
+     * // Usage:
+     * const customRequest: FetcherRequest = {
+     *   headers: { 'X-Custom': 'value' },
+     *   timeout: 5000
+     * };
+     * await service.createUsers(customRequest);
+     * ```
+     */
+    private processRequestParam;
+    private processAttributeParam;
+    private processAttributesParam;
+}
+//# sourceMappingURL=functionMetadata.d.ts.map

package/dist/functionMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functionMetadata.d.ts","sourceRoot":"","sources":["../src/functionMetadata.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,OAAO,EACP,KAAK,iBAAiB,EAGtB,YAAY,EAEZ,eAAe,EAEhB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAmC,MAAM,sBAAsB,CAAC;AAI1F;;;;;;GAMG;AACH,qBAAa,gBAAiB,YAAW,YAAY;IACnD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,WAAW,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAE3B;;;;;;;;;;OAUG;IACH,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAE3C;;;;;;;OAOG;gBAED,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAQ5C;;;;;;;OAOG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;;OAKG;IACH,WAAW,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM;IAW3C;;;;;;;OAOG;IACH,cAAc,IAAI,MAAM,GAAG,SAAS;IAIpC,sBAAsB,IAAI,eAAe,CAAC,GAAG,CAAC;IAQ9C,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAOxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,mBAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,YAAY,CAAC,CAAC;IA2E7F,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,kBAAkB;IAU1B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,sBAAsB;CAY/B"}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './apiDecorator';
 export * from './endpointDecorator';
 export * from './fetcherCapable';
+export * from './functionMetadata';
 export * from './parameterDecorator';
 export * from './reflection';
 export * from './requestExecutor';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC"}