@ethlete/query 4.3.4 → 4.4.0

package/lib/infinite-query/infinity-query.types.d.ts

@@ -8,9 +8,10 @@ export interface PageParamCalculatorOptions {
     totalPages: number | null;
     itemsPerPage: number;
 }
-export interface TotalPagesExtractorOptions<QueryResponse> {
+export interface TotalPagesExtractorOptions<QueryResponse, Arguments> {
     response: QueryResponse;
     itemsPerPage: number;
+    arguments: Arguments;
 }
 export interface InfinityQueryConfig<QueryCreator extends AnyQueryCreator, Arguments extends BaseArguments | undefined, QueryResponse, InfinityResponse extends unknown[]> {
     /**
@@ -87,7 +88,7 @@ export interface InfinityQueryConfig<QueryCreator extends AnyQueryCreator, Argum
          *
          * @default "totalPages"
          */
-        totalPagesExtractor?: (data: TotalPagesExtractorOptions<QueryResponse>) => number;
+        totalPagesExtractor?: (data: TotalPagesExtractorOptions<QueryResponse, Arguments>) => number;
     };
 }
 type OmitUndefined<T> = T extends undefined ? never : T;

package/lib/query/query.d.ts

@@ -34,6 +34,10 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
      * @internal
      */
     get _enableSmartPolling(): boolean;
+    /**
+     * @internal
+     */
+    get _arguments(): Arguments;
     get store(): Store | null;
     constructor(_client: QueryClient, _queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, _routeWithParams: Route, _args: Arguments);
     execute(options?: ExecuteQueryOptions): this;

package/lib/query-client/query-client.types.d.ts

@@ -1,5 +1,5 @@
 import { GqlTransferOption } from '../query/query.types';
-import { CacheAdapterFn, RequestHeaders, RequestHeadersMethodMap, RequestRetryFn } from '../request';
+import { BuildQueryStringConfig, CacheAdapterFn, RequestHeaders, RequestHeadersMethodMap, RequestRetryFn } from '../request';
 import { QueryClient } from './query-client';
 export interface QueryClientConfig {
     /**
@@ -64,6 +64,10 @@ export interface QueryClientConfig {
              */
             transferVia?: GqlTransferOption;
         };
+        /**
+         * Configuration options for all query strings.
+         */
+        queryParams?: BuildQueryStringConfig;
     };
     /**
      * Parent query client.

package/lib/request/request.types.d.ts

@@ -6,17 +6,10 @@ export interface RequestError<Detail = unknown> {
     statusText: string;
     detail: Detail;
 }
-export type ParamPrimitive = string | number | boolean | null | undefined;
-export type Params = Record<string | number | symbol, ParamPrimitive | ParamArray>;
-export type ParamArray = Array<ParamPrimitive>;
-export type UnfilteredParamPrimitive = string | number | boolean | null | undefined;
-export type QueryParams = {
-    [key: string]: UnfilteredParamPrimitive | UnfilteredParamArray | QueryParams;
-};
+export type RequestHeaders = Record<string, string>;
+export type QueryParams = Record<string | number, unknown | Array<unknown>>;
 export type PathParams = Record<string, string | number>;
-export type UnfilteredParamArray = Array<UnfilteredParamPrimitive>;
 export type CacheAdapterFn = (headers: RequestHeaders) => number | null;
-export type RequestHeaders = Record<string, string>;
 export type RequestHeadersMethodMap = {
     [M in Method]?: RequestHeaders;
 };
@@ -85,3 +78,33 @@ export type RequestEvent<Response = unknown> = {
     type: 'cancel';
     headers: RequestHeaders;
 };
+export interface BuildQueryStringConfig {
+    /**
+     * Object notation to use for nested objects.
+     *
+     * @example
+     * // dot notation
+     * { foo: { bar: 'baz' } } => "foo.bar=baz"
+     *
+     * @example
+     * // bracket notation
+     * { foo: { bar: 'baz' } } => "foo[bar]=baz"
+     *
+     * @default 'bracket'
+     */
+    objectNotation?: 'dot' | 'bracket';
+    /**
+     * Whether to write array indexes in bracket notation.
+     *
+     * @example
+     * // true
+     * { foo: ['bar', 'baz'] } => "foo[0]=bar&foo[1]=baz"
+     *
+     * @example
+     * // false
+     * { foo: ['bar', 'baz'] } => "foo[]=bar&foo[]=baz"
+     *
+     * @default false
+     */
+    writeArrayIndexes?: boolean;
+}

package/lib/request/request.util.d.ts

@@ -1,16 +1,13 @@
-import { Method, ParamArray, Params, QueryParams, RequestError, RequestHeaders, RequestRetryFn, UnfilteredParamPrimitive } from './request.types';
+import { BuildQueryStringConfig, Method, QueryParams, RequestError, RequestHeaders, RequestRetryFn } from './request.types';
 export declare const isRequestError: <T = unknown>(error: unknown) => error is RequestError<T>;
 export declare const buildRoute: (options: {
     base: string;
     route: string | ((args: Record<string, unknown>) => string) | null | undefined;
     pathParams?: Record<string, unknown> | undefined;
     queryParams?: QueryParams | undefined;
+    queryParamConfig?: BuildQueryStringConfig | undefined;
 }) => string;
-export declare const buildQueryString: (params: QueryParams) => string | null;
-export declare const buildQueryArrayString: (key: string, array: ParamArray) => string;
-export declare const buildQueryObjectString: (key: string, object: QueryParams) => string;
-export declare const filterInvalidParams: (params: QueryParams) => Params;
-export declare const isParamValid: (primitive: UnfilteredParamPrimitive) => boolean;
+export declare const buildQueryString: (params: QueryParams, config?: BuildQueryStringConfig) => string | null;
 export declare const extractExpiresInSeconds: (headers: RequestHeaders) => number | null;
 export declare const buildTimestampFromSeconds: (seconds: number | null) => number | null;
 export declare const serializeBody: (body: unknown) => ArrayBuffer | URLSearchParams | Blob | FormData | string | null;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/query",
-  "version": "4.3.4",
+  "version": "4.4.0",
   "dependencies": {
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
     "@angular/common": "^15.2.1 || ^16.0.0",
     "@angular/core": "^15.2.1 || ^16.0.0",
-    "@ethlete/core": "2.7.2"
+    "@ethlete/core": "2.8.0"
   },
   "module": "fesm2022/ethlete-query.mjs",
   "typings": "index.d.ts",