@wishknish/knishio-client-ts 0.8.1 → 0.8.3

package/dist/index.d.cts

@@ -274,10 +274,12 @@ interface ValidationResult$1 {
     expected?: string;
     actual?: unknown;
 }
+type RequestPolicy = 'cache-first' | 'cache-only' | 'network-only' | 'cache-and-network';
 interface GraphQLRequest {
     query: string;
     variables?: Record<string, unknown>;
     operationName?: string | null;
+    context?: Record<string, unknown>;
 }
 interface GraphQLResponse<T = unknown> {
     data?: T | null;
@@ -1118,6 +1120,7 @@ declare class KnishIOClient {
     private $__client;
     private $__serverSdkVersion;
     private $__logging;
+    private $__defaultRequestPolicy;
     private $__authTokenObjects;
     private $__authToken;
     private $__authInProcess;
@@ -1136,8 +1139,9 @@ declare class KnishIOClient {
         } | null;
         serverSdkVersion?: number;
         logging?: boolean;
+        defaultRequestPolicy?: RequestPolicy | null;
     });
-    initialize({ uri, cellSlug, socket, client, serverSdkVersion, logging }: {
+    initialize({ uri, cellSlug, socket, client, serverSdkVersion, logging, defaultRequestPolicy }: {
         uri: string | string[];
         cellSlug?: string | null;
         socket?: {
@@ -1147,12 +1151,15 @@ declare class KnishIOClient {
         client?: GraphQLClient | null;
         serverSdkVersion?: number;
         logging?: boolean;
+        defaultRequestPolicy?: RequestPolicy | null;
     }): void;
     getRandomUri(): string;
     switchEncryption(encrypt: boolean): boolean;
     deinitialize(): void;
     subscribe(): GraphQLClient;
     getServerSdkVersion(): number;
+    getDefaultRequestPolicy(): RequestPolicy | null;
+    setDefaultRequestPolicy(policy: RequestPolicy | null): void;
     reset(): void;
     client(): GraphQLClient;
     setUri(uri: string | string[]): void;
@@ -1177,7 +1184,7 @@ declare class KnishIOClient {
         molecule?: Molecule | null;
     }): Promise<T>;
     private withMoleculeLock;
-    executeQuery(query: Query | Mutation, variables?: Record<string, any> | null): Promise<Response | null>;
+    executeQuery(query: Query | Mutation, variables?: Record<string, any> | null, context?: Record<string, any>): Promise<Response | null>;
     private handlePositionDrift;
     setSecret(secret: string): void;
     setAuthToken(authToken: AuthToken): void;
@@ -1226,7 +1233,7 @@ declare class KnishIOClient {
     queryContinuId({ bundle }: {
         bundle: BundleHash | string;
     }): Promise<Response>;
-    queryMeta({ metaType, metaId, key, value, latest, fields: _fields, filter, queryArgs, count, countBy, throughAtom, throughMolecule, values, keys, atomValues }: {
+    queryMeta({ metaType, metaId, key, value, latest, fields: _fields, filter, queryArgs, count, countBy, throughAtom, throughMolecule, values, keys, atomValues, requestPolicy }: {
         metaType: MetaType | string;
         metaId?: MetaId | string | null;
         key?: string | null;
@@ -1242,6 +1249,7 @@ declare class KnishIOClient {
         values?: any[] | null;
         keys?: string[] | null;
         atomValues?: any[] | null;
+        requestPolicy?: 'cache-first' | 'cache-only' | 'network-only' | 'cache-and-network' | null;
     }): Promise<Response>;
     queryMetaVerified(params: {
         metaType: MetaType | string;

package/dist/index.d.ts

@@ -274,10 +274,12 @@ interface ValidationResult$1 {
     expected?: string;
     actual?: unknown;
 }
+type RequestPolicy = 'cache-first' | 'cache-only' | 'network-only' | 'cache-and-network';
 interface GraphQLRequest {
     query: string;
     variables?: Record<string, unknown>;
     operationName?: string | null;
+    context?: Record<string, unknown>;
 }
 interface GraphQLResponse<T = unknown> {
     data?: T | null;
@@ -1118,6 +1120,7 @@ declare class KnishIOClient {
     private $__client;
     private $__serverSdkVersion;
     private $__logging;
+    private $__defaultRequestPolicy;
     private $__authTokenObjects;
     private $__authToken;
     private $__authInProcess;
@@ -1136,8 +1139,9 @@ declare class KnishIOClient {
         } | null;
         serverSdkVersion?: number;
         logging?: boolean;
+        defaultRequestPolicy?: RequestPolicy | null;
     });
-    initialize({ uri, cellSlug, socket, client, serverSdkVersion, logging }: {
+    initialize({ uri, cellSlug, socket, client, serverSdkVersion, logging, defaultRequestPolicy }: {
         uri: string | string[];
         cellSlug?: string | null;
         socket?: {
@@ -1147,12 +1151,15 @@ declare class KnishIOClient {
         client?: GraphQLClient | null;
         serverSdkVersion?: number;
         logging?: boolean;
+        defaultRequestPolicy?: RequestPolicy | null;
     }): void;
     getRandomUri(): string;
     switchEncryption(encrypt: boolean): boolean;
     deinitialize(): void;
     subscribe(): GraphQLClient;
     getServerSdkVersion(): number;
+    getDefaultRequestPolicy(): RequestPolicy | null;
+    setDefaultRequestPolicy(policy: RequestPolicy | null): void;
     reset(): void;
     client(): GraphQLClient;
     setUri(uri: string | string[]): void;
@@ -1177,7 +1184,7 @@ declare class KnishIOClient {
         molecule?: Molecule | null;
     }): Promise<T>;
     private withMoleculeLock;
-    executeQuery(query: Query | Mutation, variables?: Record<string, any> | null): Promise<Response | null>;
+    executeQuery(query: Query | Mutation, variables?: Record<string, any> | null, context?: Record<string, any>): Promise<Response | null>;
     private handlePositionDrift;
     setSecret(secret: string): void;
     setAuthToken(authToken: AuthToken): void;
@@ -1226,7 +1233,7 @@ declare class KnishIOClient {
     queryContinuId({ bundle }: {
         bundle: BundleHash | string;
     }): Promise<Response>;
-    queryMeta({ metaType, metaId, key, value, latest, fields: _fields, filter, queryArgs, count, countBy, throughAtom, throughMolecule, values, keys, atomValues }: {
+    queryMeta({ metaType, metaId, key, value, latest, fields: _fields, filter, queryArgs, count, countBy, throughAtom, throughMolecule, values, keys, atomValues, requestPolicy }: {
         metaType: MetaType | string;
         metaId?: MetaId | string | null;
         key?: string | null;
@@ -1242,6 +1249,7 @@ declare class KnishIOClient {
         values?: any[] | null;
         keys?: string[] | null;
         atomValues?: any[] | null;
+        requestPolicy?: 'cache-first' | 'cache-only' | 'network-only' | 'cache-and-network' | null;
     }): Promise<Response>;
     queryMetaVerified(params: {
         metaType: MetaType | string;

package/dist/index.iife.js

@@ -24045,7 +24045,8 @@ ${operationTypes.join("\n")}
     client: external_exports.unknown().optional(),
     socket: external_exports.unknown().optional(),
     serverSdkVersion: external_exports.number().int().min(1).optional(),
-    logging: external_exports.boolean().optional()
+    logging: external_exports.boolean().optional(),
+    defaultRequestPolicy: external_exports.enum(["cache-first", "cache-only", "network-only", "cache-and-network"]).nullable().optional()
   }).strict();
   external_exports.object({
     token: external_exports.string().min(1, "Auth token cannot be empty"),
@@ -28486,14 +28487,14 @@ ${operationTypes.join("\n")}
       });
     }
     async query(request) {
-      const { query, variables } = request;
-      const result = await this.$__client.query(query, variables || {}).toPromise();
+      const { query, variables, context } = request;
+      const result = await this.$__client.query(query, variables || {}, context).toPromise();
       return this.formatResponse(result);
     }
     async mutation(request) {
-      const { query, variables } = request;
+      const { query, variables, context } = request;
       const mutationString = request.mutation || query;
-      const result = await this.$__client.mutation(mutationString, variables || {}).toPromise();
+      const result = await this.$__client.mutation(mutationString, variables || {}, context).toPromise();
       return this.formatResponse(result);
     }
     // Alias for mutation() to match JS SDK interface
@@ -29005,7 +29006,11 @@ ${operationTypes.join("\n")}
     client: external_exports.unknown().optional(),
     socket: external_exports.unknown().optional(),
     serverSdkVersion: external_exports.number().int().min(1).max(10).default(4),
-    logging: external_exports.boolean().default(false)
+    logging: external_exports.boolean().default(false),
+    // Optional default urql request policy for reads (server/sync clients pass
+    // 'network-only'). Permitted by the strict schema so the constructor option
+    // isn't rejected.
+    defaultRequestPolicy: external_exports.enum(["cache-first", "cache-only", "network-only", "cache-and-network"]).nullable().optional()
   }).strict();
   var EnvironmentConfigSchema = external_exports.object({
     NODE_ENV: external_exports.enum(["development", "production", "test"]).default("development"),
@@ -32773,6 +32778,10 @@ ${operationTypes.join("\n")}
     $__client;
     $__serverSdkVersion = 3;
     $__logging = false;
+    // Default urql request policy applied to reads when the caller doesn't pass
+    // one. null = urql's default (cache-first). Server/sync clients set this to
+    // 'network-only' so a long-lived client never serves a stale cached read.
+    $__defaultRequestPolicy = null;
     $__authTokenObjects = {};
     $__authToken = null;
     $__authInProcess = false;
@@ -32812,13 +32821,15 @@ ${operationTypes.join("\n")}
         serverSdkVersion = 3,
         logging = false
       } = validatedConfig;
+      const defaultRequestPolicy = config.defaultRequestPolicy ?? null;
       this.initialize({
         uri,
         cellSlug,
         socket,
         client,
         serverSdkVersion,
-        logging
+        logging,
+        defaultRequestPolicy
       });
     }
     /**
@@ -32830,7 +32841,8 @@ ${operationTypes.join("\n")}
       socket = null,
       client = null,
       serverSdkVersion = 3,
-      logging = false
+      logging = false,
+      defaultRequestPolicy = null
     }) {
       this.reset();
       this.$__logging = logging;
@@ -32852,6 +32864,7 @@ ${operationTypes.join("\n")}
         encrypt: this.$__encrypt
       });
       this.$__serverSdkVersion = serverSdkVersion;
+      this.$__defaultRequestPolicy = defaultRequestPolicy;
     }
     /**
      * Get random uri from specified this.$__uris
@@ -32899,6 +32912,20 @@ ${operationTypes.join("\n")}
     getServerSdkVersion() {
       return this.$__serverSdkVersion;
     }
+    /**
+     * Gets the client's default urql request policy (null = urql default).
+     */
+    getDefaultRequestPolicy() {
+      return this.$__defaultRequestPolicy;
+    }
+    /**
+     * Sets the default urql request policy applied to reads that don't specify
+     * one. Pass 'network-only' on a long-lived server/sync client so it never
+     * serves a stale cached read; null restores urql's default (cache-first).
+     */
+    setDefaultRequestPolicy(policy) {
+      this.$__defaultRequestPolicy = policy;
+    }
     /**
      * Reset common properties
      */
@@ -33087,7 +33114,7 @@ ${operationTypes.join("\n")}
     /**
      * Executes a query or mutation
      */
-    async executeQuery(query, variables = null) {
+    async executeQuery(query, variables = null, context = {}) {
       if (this.$__authToken && this.$__authToken.isExpired() && !this.$__authInProcess) {
         this.log("info", "KnishIOClient::executeQuery() - Access token is expired. Getting new one...");
         await this.requestAuthToken({
@@ -33103,7 +33130,8 @@ ${operationTypes.join("\n")}
           return response;
         });
       }
-      return await query.execute({ variables: variables || {} });
+      const effectiveContext = this.$__defaultRequestPolicy && !context.requestPolicy ? { requestPolicy: this.$__defaultRequestPolicy, ...context } : context;
+      return await query.execute({ variables: variables || {}, context: effectiveContext });
     }
     /**
      * When a ProposeMolecule submission is rejected for a position-related
@@ -33436,7 +33464,8 @@ ${operationTypes.join("\n")}
       throughMolecule = false,
       values = null,
       keys = null,
-      atomValues = null
+      atomValues = null,
+      requestPolicy = null
     }) {
       this.log("info", `KnishIOClient::queryMeta() - Querying metaType: ${metaType}, metaId: ${metaId}...`);
       let query;
@@ -33488,7 +33517,8 @@ ${operationTypes.join("\n")}
           cellSlug: this.getCellSlug()
         });
       }
-      return this.executeQuery(query, variables);
+      const context = requestPolicy ? { requestPolicy } : {};
+      return this.executeQuery(query, variables, context);
     }
     /**
      * Queries meta assets and verifies cryptographic integrity of associated molecules.