@swarm.ing/pieui 3.0.9 → 3.0.10

package/dist/util/ajaxCommonUtils.d.ts

@@ -25,7 +25,19 @@ export type GetAjaxSubmitOptions = {
     timeout?: number;
     /** Retry policy for failed requests. No retries if omitted. */
     retryPolicy?: RetryPolicy;
+    /**
+     * Extra `fetch` options merged into every request the submit function
+     * makes (`headers`, `credentials`, `mode`, `cache`, a caller `signal`, …).
+     * `body` is ignored — it is always the collected FormData. See
+     * {@link buildRequestInit} for how the merge works.
+     */
+    fetchOptions?: RequestInit;
 };
+/**
+ * Submit function returned by {@link getAjaxSubmit}. `fetchOptions` given here
+ * override the ones passed when the submit function was built.
+ */
+export type AjaxSubmitFn = (extraKwargs?: Record<string, any>, fetchOptions?: RequestInit) => Promise<any>;
 /**
  * The origin a dep value is read from. `dom` is the default for any name
  * without a recognized prefix.
@@ -148,10 +160,14 @@ export declare const readAjaxKeyAsync: (depName: string, renderingLogEnabled?: b
  *                               `url:`, `telegram:cloud:` and `telegram:secure:`
  *                               prefixes read those client sources.
  * @param pathname               Path segment appended to `api/ajax_content`.
- * @param options                See {@link GetAjaxSubmitOptions}.
- * @returns An `async (extraKwargs?) => Promise<any>` submit function.
+ * @param options                See {@link GetAjaxSubmitOptions}, including
+ *                               `fetchOptions` — arbitrary `fetch` init merged
+ *                               into every request (see
+ *                               {@link buildRequestInit}).
+ * @returns An {@link AjaxSubmitFn}: `async (extraKwargs?, fetchOptions?)`,
+ *          where the call-time `fetchOptions` win over the ones given here.
  */
-export declare const getAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigurationType, kwargs?: Record<string, any>, depsNames?: Array<string>, pathname?: string, options?: GetAjaxSubmitOptions) => (extraKwargs?: Record<string, any>) => Promise<any>;
+export declare const getAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigurationType, kwargs?: Record<string, any>, depsNames?: Array<string>, pathname?: string, options?: GetAjaxSubmitOptions) => AjaxSubmitFn;
 /**
  * React hook wrapper around {@link getAjaxSubmit}. Reads `apiServer` and
  * `enableRenderingLog` from {@link usePieConfig} and memoizes the submit
@@ -164,13 +180,19 @@ export declare const getAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigura
  * @param depsNames              Names of DOM inputs whose current values should
  *                               be sent alongside the request.
  * @param pathname               Path segment appended to `api/ajax_content`.
- * @param options                Optional `timeout` (ms) and `retryPolicy`.
+ * @param options                Optional `timeout` (ms), `retryPolicy` and
+ *                               `fetchOptions`. Since memoization is keyed on
+ *                               the stringified options, pass values that
+ *                               survive `JSON.stringify` here — a per-call
+ *                               `AbortSignal` belongs in the submit call's own
+ *                               `fetchOptions` argument instead.
  * @returns A memoized submit function; see {@link getAjaxSubmit}.
  */
 export declare const useAjaxSubmit: (setUiAjaxConfiguration?: SetUiAjaxConfigurationType, kwargs?: Record<string, any>, depsNames?: Array<string>, pathname?: string, options?: {
     timeout?: number;
     retryPolicy?: RetryPolicy;
-}) => (extraKwargs?: Record<string, any>) => Promise<any>;
+    fetchOptions?: RequestInit;
+}) => AjaxSubmitFn;
 /** One ajax endpoint's submit config, discovered from a card's `data`. */
 export type AjaxEndpointConfig = {
     /** `'default'` for the primary `pathname`, else the field prefix (`search`). */
@@ -196,5 +218,6 @@ export declare const discoverAjaxEndpoints: (data?: Record<string, any>) => Arra
 export declare const useAjaxSubmits: (data?: Record<string, any>, setUiAjaxConfiguration?: SetUiAjaxConfigurationType, options?: {
     timeout?: number;
     retryPolicy?: RetryPolicy;
-}) => Record<string, (extraKwargs?: Record<string, any>) => Promise<any>>;
+    fetchOptions?: RequestInit;
+}) => Record<string, AjaxSubmitFn>;
 //# sourceMappingURL=ajaxCommonUtils.d.ts.map

package/dist/util/ajaxCommonUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ajaxCommonUtils.d.ts","sourceRoot":"","sources":["../../src/util/ajaxCommonUtils.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,CAAA;AACjB,OAAO,EAAE,0BAA0B,EAAe,MAAM,UAAU,CAAA;AAMlE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kJAAkJ;IAClJ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,WAAW,CAAA;CAC5B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACf,KAAK,GACL,KAAK,GACL,cAAc,GACd,gBAAgB,GAChB,QAAQ,GACR,KAAK,GACL,gBAAgB,GAChB,iBAAiB,CAAA;AAmBvB;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,MACvB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,GACpB,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;AAInC,iEAAiE;AACjE,eAAO,MAAM,sBAAsB,SACzB,MAAM,YACF,cAAc,KACzB,IAEF,CAAA;AAED,iFAAiF;AACjF,eAAO,MAAM,wBAAwB,SAAU,MAAM,KAAG,IAEvD,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,0BAA0B,YAC3B,MAAM,GAAG,WAAW,KAC7B,IAkCF,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,YACZ,MAAM,KAChB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAWlC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,WAAW,YACX,MAAM,wBACM,OAAO,KAC7B,KAAK,CAAC,MAAM,GAAG,IAAI,CAgFrB,CAAA;AAwDD;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,YAChB,MAAM,wBACM,OAAO,KAC7B,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAmC9B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,aAAa,4BACG,0BAA0B,WAC3C,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,cAChB,KAAK,CAAC,MAAM,CAAC,aACb,MAAM,YACP,oBAAoB,oBAaH,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,iBA2KjD,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,4BACG,0BAA0B,WAC3C,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,cAChB,KAAK,CAAC,MAAM,CAAC,aACb,MAAM,YACP;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,WAAW,CAAA;CAAE,oBAjM9B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,iBA6NjD,CAAA;AAED,0EAA0E;AAC1E,MAAM,MAAM,kBAAkB,GAAG;IAC7B,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,UACxB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC1B,KAAK,CAAC,kBAAkB,CAkB1B,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,UACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,2BACA,0BAA0B,YACzC;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,WAAW,CAAA;CAAE,KAC1D,MAAM,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CA6BpE,CAAA"}
+{"version":3,"file":"ajaxCommonUtils.d.ts","sourceRoot":"","sources":["../../src/util/ajaxCommonUtils.ts"],"names":[],"mappings":"AAEA,OAAO,UAAU,CAAA;AACjB,OAAO,EAAE,0BAA0B,EAAe,MAAM,UAAU,CAAA;AAMlE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACtB,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kJAAkJ;IAClJ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAC/B,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,WAAW,CAAA;CAC7B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,CACvB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,YAAY,CAAC,EAAE,WAAW,KACzB,OAAO,CAAC,GAAG,CAAC,CAAA;AAEjB;;;GAGG;AACH,MAAM,MAAM,SAAS,GACf,KAAK,GACL,KAAK,GACL,cAAc,GACd,gBAAgB,GAChB,QAAQ,GACR,KAAK,GACL,gBAAgB,GAChB,iBAAiB,CAAA;AAmBvB;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,MACvB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,GACpB,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAA;AAInC,iEAAiE;AACjE,eAAO,MAAM,sBAAsB,SACzB,MAAM,YACF,cAAc,KACzB,IAEF,CAAA;AAED,iFAAiF;AACjF,eAAO,MAAM,wBAAwB,SAAU,MAAM,KAAG,IAEvD,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,0BAA0B,YAC3B,MAAM,GAAG,WAAW,KAC7B,IAkCF,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,YACZ,MAAM,KAChB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAWlC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,WAAW,YACX,MAAM,wBACM,OAAO,KAC7B,KAAK,CAAC,MAAM,GAAG,IAAI,CAgFrB,CAAA;AAwDD;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,YAChB,MAAM,wBACM,OAAO,KAC7B,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAmC9B,CAAA;AAqGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,aAAa,4BACG,0BAA0B,WAC3C,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,cAChB,KAAK,CAAC,MAAM,CAAC,aACb,MAAM,YACP,oBAAoB,KAC/B,YA4LF,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa,4BACG,0BAA0B,WAC3C,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,cAChB,KAAK,CAAC,MAAM,CAAC,aACb,MAAM,YACP;IACN,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,YAAY,CAAC,EAAE,WAAW,CAAA;CAC7B,KACF,YA4BF,CAAA;AAED,0EAA0E;AAC1E,MAAM,MAAM,kBAAkB,GAAG;IAC7B,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACxB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,UACxB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC1B,KAAK,CAAC,kBAAkB,CAkB1B,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,UACjB,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,2BACA,0BAA0B,YACzC;IACN,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,YAAY,CAAC,EAAE,WAAW,CAAA;CAC7B,KACF,MAAM,CAAC,MAAM,EAAE,YAAY,CA2B7B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@swarm.ing/pieui",
-    "version": "3.0.9",
+    "version": "3.0.10",
     "description": "A React component library featuring PieCard component",
     "repository": {
         "type": "git",