@geins/core 0.8.0 → 0.10.0

package/dist/base/baseApiService.d.ts

@@ -1,6 +1,7 @@
-import type { GeinsSettings } from '@geins/types';
+import type { GeinsSettings, RequestContext } from '@geins/types';
 import type { MerchantApiClient } from '../api-client/merchantApiClient';
 import { GraphQLQueryOptions } from '../api-client/merchantApiClient';
+import type { DocumentNode } from '@apollo/client/core';
 /** Function that returns a MerchantApiClient instance. */
 export type ApiClientGetter = () => MerchantApiClient;
 /**
@@ -21,11 +22,35 @@ export declare abstract class BaseApiService {
     destroy(): void;
     /**
      * Merges caller-provided variables with default languageId, marketId, and channelId from settings.
-     * @param vars - Variables to enrich with defaults.
+     *
+     * Per-request overrides: if `vars` already contains `languageId`, `marketId`, or `channelId`
+     * those values are used as-is and the SDK-level settings are ignored for that field.
+     * This mirrors the shape of {@link RequestContext} and allows callers to pass a
+     * `RequestContext` object directly as part of `vars` to override locale/market on a
+     * per-request basis without reinitialising the SDK.
+     *
+     * @param vars - Variables to enrich with defaults. Pre-existing `languageId`, `marketId`,
+     *   or `channelId` fields take precedence over the SDK-level settings.
      * @returns The enriched variables object.
-     * @throws {GeinsError} If locale or market is missing when not provided in vars.
+     * @throws {GeinsError} If locale or market is missing from both `vars` and the SDK settings.
      */
     protected createVariables(vars: Record<string, unknown>): Record<string, unknown>;
+    /**
+     * Builds a complete {@link GraphQLQueryOptions} object from a query, caller variables,
+     * and an optional {@link RequestContext}.
+     *
+     * - Extracts `userToken` from the request context and routes it to the
+     *   {@link GraphQLQueryOptions.userToken} field (which becomes an `Authorization: Bearer`
+     *   header via {@link MerchantApiClient.buildContext}).
+     * - Merges remaining context fields (`languageId`, `marketId`, `channelId`) into the
+     *   GraphQL variables via {@link createVariables}.
+     *
+     * @param query - The GraphQL document or string to execute.
+     * @param vars - Caller-provided variables (e.g. `{ alias: '/about' }`).
+     * @param requestContext - Optional per-request overrides including auth token.
+     * @returns A ready-to-execute query options object.
+     */
+    protected createQueryOptions(query: DocumentNode | string, vars: Record<string, unknown>, requestContext?: RequestContext): GraphQLQueryOptions;
     /**
      * Executes a GraphQL query via the API client.
      * @param options - Query and variables to execute.