@pushwoosh/kit-helpers 4.11.2 → 4.12.0

package/callWithRetry.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Retry / polling policy for a single operation.
+ *
+ * Retry is always opt-in: `callWithRetry` is the only entry point, so plain calls run once and
+ * non-idempotent operations are never retried unless a policy is passed.
+ */
+export type RetryPolicy<T> = {
+    /** Maximum number of attempts, including the first one. Must be a positive integer. */
+    readonly attempts: number;
+    /** Delay in milliseconds between two consecutive attempts. */
+    readonly delay: number;
+    /**
+     * Poll predicate. Return `true` when the result is final and the loop must stop.
+     * Omit it to stop on the first successful result (plain retry, without polling).
+     */
+    readonly until?: (result: T) => boolean;
+    /**
+     * Decide whether to retry after a thrown error. Return `true` to retry.
+     * Omit it and errors propagate immediately, which keeps non-idempotent operations safe.
+     */
+    readonly retryOnError?: (error: unknown, attempt: number) => boolean;
+};
+/**
+ * Raised when a retry / polling policy runs out of attempts before its stop condition is met.
+ */
+export declare class RetryExhaustedError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Run an async operation under a retry / polling policy — the single place that owns the
+ * attempt loop and the delay between attempts. Callers describe *when* to stop (`until`) and
+ * *whether* to retry on error (`retryOnError`); they never hand-write the loop themselves.
+ *
+ * @param operation - operation to run; receives the 1-based attempt number.
+ * @param policy - retry / polling policy.
+ */
+export declare const callWithRetry: <T>(operation: (attempt: number) => Promise<T>, policy: RetryPolicy<T>) => Promise<T>;

package/callWithRetry.js

@@ -0,0 +1,57 @@
+/**
+ * Raised when a retry / polling policy runs out of attempts before its stop condition is met.
+ */
+export class RetryExhaustedError extends Error {
+  constructor(message = 'Retry attempts exhausted!') {
+    super(message);
+    this.name = 'RetryExhaustedError';
+  }
+}
+const sleep = ms => new Promise(resolve => {
+  setTimeout(resolve, ms);
+});
+/**
+ * Run an async operation under a retry / polling policy — the single place that owns the
+ * attempt loop and the delay between attempts. Callers describe *when* to stop (`until`) and
+ * *whether* to retry on error (`retryOnError`); they never hand-write the loop themselves.
+ *
+ * @param operation - operation to run; receives the 1-based attempt number.
+ * @param policy - retry / polling policy.
+ */
+export const callWithRetry = async (operation, policy) => {
+  if (!Number.isInteger(policy.attempts) || policy.attempts < 1) {
+    throw new RangeError(`callWithRetry: "attempts" must be a positive integer, got ${policy.attempts}.`);
+  }
+  let lastAttempt = {
+    kind: 'unmet'
+  };
+  for (let attempt = 1; attempt <= policy.attempts; attempt += 1) {
+    try {
+      // eslint-disable-next-line no-await-in-loop
+      const result = await operation(attempt);
+      if (!policy.until || policy.until(result)) {
+        return result;
+      }
+      lastAttempt = {
+        kind: 'unmet'
+      };
+    } catch (error) {
+      var _policy$retryOnError;
+      if (((_policy$retryOnError = policy.retryOnError) === null || _policy$retryOnError === void 0 ? void 0 : _policy$retryOnError.call(policy, error, attempt)) !== true) {
+        throw error;
+      }
+      lastAttempt = {
+        kind: 'error',
+        error
+      };
+    }
+    if (attempt < policy.attempts) {
+      // eslint-disable-next-line no-await-in-loop
+      await sleep(policy.delay);
+    }
+  }
+  if (lastAttempt.kind === 'error') {
+    throw lastAttempt.error;
+  }
+  throw new RetryExhaustedError(`Retry policy exhausted after ${policy.attempts} attempt(s) without meeting the stop condition.`);
+};

package/expand.d.ts

@@ -1,11 +1,12 @@
-import React, { type FC, type ReactNode } from 'react';
+import { type FC, type ReactNode } from 'react';
 type ExpandTransitionProps = {
     className?: string;
     timeout?: number;
     externalClassName?: string;
     internalClassName?: string;
+    children?: ReactNode;
 };
-export declare const ExpandTransition: import("styled-components").StyledComponent<React.FC<ExpandTransitionProps>, any, {}, never>;
+export declare const ExpandTransition: import("styled-components").StyledComponent<FC<ExpandTransitionProps>, any, {}, never>;
 type CollapseProps = {
     expanded: boolean;
     timeout?: number;

package/flex.d.ts

@@ -1,4 +1,4 @@
-import { CommonContainerProps } from './styled-helpers';
+import { type CommonContainerProps } from './styled-helpers';
 type FlexContainerProps = CommonContainerProps & {
     $flexDirection?: 'row' | 'row-reverse' | 'column' | 'column-reverse';
     $flexWrap?: 'nowrap' | 'wrap' | 'wrap-reverse';

package/grid.d.ts

@@ -1,4 +1,4 @@
-import { StrNum, ItemAlignmentValue, CommonContainerProps } from './styled-helpers';
+import { type StrNum, type ItemAlignmentValue, type CommonContainerProps } from './styled-helpers';
 export { toCssValue } from './styled-helpers';
 type GridContainerProps = CommonContainerProps & {
     $gridAutoFlow?: 'row' | 'column' | 'dense' | 'row dense' | 'column dense';

package/index.d.ts

@@ -5,6 +5,8 @@ export * from './hooks/useClickAway';
 export { identifyOpenReplaySession } from './analytics/identifyOpenReplay';
 export { trackEvent } from './analytics/trackEvent';
 export { formatNumber } from './formatNumber';
+export { callWithRetry, RetryExhaustedError } from './callWithRetry';
+export type { RetryPolicy } from './callWithRetry';
 export { readNavigationHistory, writeNavigationHistory } from './navigation';
 export { default as usePersistentFunction } from './hooks/usePersistentFunction';
 export { default as useEffectOnce } from './hooks/useEffectOnce';

package/index.js

@@ -5,6 +5,7 @@ export * from './hooks/useClickAway';
 export { identifyOpenReplaySession } from './analytics/identifyOpenReplay';
 export { trackEvent } from './analytics/trackEvent';
 export { formatNumber } from './formatNumber';
+export { callWithRetry, RetryExhaustedError } from './callWithRetry';
 export { readNavigationHistory, writeNavigationHistory } from './navigation';
 export { default as usePersistentFunction } from './hooks/usePersistentFunction';
 export { default as useEffectOnce } from './hooks/useEffectOnce';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/kit-helpers",
-  "version": "4.11.2",
+  "version": "4.12.0",
   "description": "React component for build Pushwoosh products",
   "main": "index.js",
   "module": "index.js",
@@ -11,7 +11,8 @@
     "build": "pushwoosh-engine lib:build && cp ai-documentation.md dist/ai-documentation.md",
     "playground": "pushwoosh-engine lib:playground",
     "check": "npm run check:lint && npm run check:types",
-    "check:lint": "echo \"Run check:lint\" && eslint .",
+    "check:lint": "echo \"Run check:lint\" && NODE_ENV=production eslint ./src",
+    "check:lint-fix": "echo \"Run check:lint\" && NODE_ENV=production eslint ./src --fix",
     "check:types": "echo \"Run check:types\" && pushwoosh-engine lib:check-types"
   },
   "pre-commit": "check",
@@ -19,30 +20,21 @@
     "react-transition-group": "^4.4.5"
   },
   "devDependencies": {
-    "@pushwoosh/frontend-builder-engine": "^2.1.1",
+    "@pushwoosh/frontend-builder-engine": "^3.0.0",
     "@pushwoosh/kit-constants": "^1.6.0",
-    "@types/react": "^16.14.20",
-    "@types/react-dom": "^16.9.14",
+    "@types/react": "^18.3.2",
+    "@types/react-dom": "^18.3.0",
     "@types/react-transition-group": "^4.4.10",
     "@types/styled-components": "^5.1.34",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
+    "@types/webpack-env": "^1.18.8",
     "cross-env": "^7.0.3",
-    "eslint": "^8.31.0",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-typescript": "^18.0.0",
-    "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-react": "^7.26.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
     "pre-commit": "^1.2.2",
-    "react": "^16.14.0",
-    "react-dom": "^16.14.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "styled-components": "^5.3.11"
   },
   "peerDependencies": {
-    "react": ">=16.14.0",
+    "react": ">=18.0.0",
     "styled-components": ">=5.3.3"
   },
   "engines": {