@claspo/common 7.3.1-dev.4 → 7.3.1

package/out/document/hidden-fields.interface.d.ts

@@ -1,46 +0,0 @@
-export declare enum SourceType {
-    STATIC = "STATIC",
-    DATA_LAYER = "DATA_LAYER",
-    URL_QUERY_PARAMS = "URL_QUERY_PARAMS",
-    JS_API_VARIABLE = "JS_API_VARIABLE",
-    COOKIE = "COOKIE",
-    LOCAL_STORAGE = "LOCAL_STORAGE"
-}
-export interface HiddenFieldSourceArgumentI {
-    name: string;
-    value: string;
-    type?: string;
-    placeholder?: string;
-    [key: string]: any;
-}
-export interface StaticSourceConfigI {
-    value: string;
-    [key: string]: any;
-}
-export interface HiddenFieldArgumentsConfigI {
-    arguments?: HiddenFieldSourceArgumentI[];
-    fallbackValue?: string;
-    [key: string]: any;
-}
-export interface HiddenFieldConfigBySource {
-    [SourceType.STATIC]: StaticSourceConfigI;
-    [SourceType.DATA_LAYER]: HiddenFieldArgumentsConfigI;
-    [SourceType.URL_QUERY_PARAMS]: HiddenFieldArgumentsConfigI;
-    [SourceType.JS_API_VARIABLE]: HiddenFieldArgumentsConfigI;
-    [SourceType.COOKIE]: HiddenFieldArgumentsConfigI;
-    [SourceType.LOCAL_STORAGE]: HiddenFieldArgumentsConfigI;
-}
-export interface HiddenFieldSharedBaseI {
-    id: string;
-    name: string;
-    label: string;
-    options: [];
-    type: 'HIDDEN';
-}
-export type HiddenFieldSharedI<S extends SourceType = SourceType> = HiddenFieldSharedBaseI & {
-    sourceType: S;
-    config: HiddenFieldConfigBySource[S];
-};
-export type AnyHiddenFieldSharedI = {
-    [S in SourceType]: HiddenFieldSharedI<S>;
-}[SourceType];

package/out/package.json

@@ -1,50 +0,0 @@
-{
-  "name": "@claspo/common",
-  "version": "7.3.1-dev.3",
-  "description": "",
-  "main": "index.js",
-  "engines": {
-    "node": ">=18.16.0"
-  },
-  "directories": {
-    "test": "test"
-  },
-  "files": [
-    "**/*.js",
-    "**/*.ts",
-    "**/package.json",
-    "!**/*.test.js",
-    "!**/*.test.d.ts",
-    "!**/*.spec.js",
-    "!**/*.spec.d.ts"
-  ],
-  "scripts": {
-    "test": "jest --no-cache --coverage",
-    "build": "rm -rf out && tsc --project tsconfig.json && npm run minify",
-    "build:docs": "rm -rf ./docs && typedoc --options typedoc.md.json && npx concat-md --decrease-title-levels docs > docs/index.md && find docs -name '*.md' ! -name 'index.md' -delete",
-    "minify": "find out -name '*.js' ! -name '*.d.js' -exec terser {} --compress --mangle --output {} \\;",
-    "dev": " tsc --project tsconfig.json --watch",
-    "package": "npm i && npm run test && npm run build && npm run build:docs && cp package.json README.md LICENSE.md out && cd out && npm publish --access=public && cd ..",
-    "sync:docs": "node ../../scripts/sync-docs.js --package=common"
-  },
-  "dependencies": {
-    "velocityjs": "2.1.6"
-  },
-  "devDependencies": {
-    "@types/jest": "^27.5.1",
-    "concat-md": "^0.5.1",
-    "glob": "^8.0.3",
-    "jest": "^28.1.0",
-    "jest-environment-jsdom": "^28.1.0",
-    "terser": "^5.37.0",
-    "ts-jest": "^28.0.3",
-    "ts-node": "^10.8.0",
-    "typedoc": "^0.28.0",
-    "typedoc-plugin-markdown": "^4.4.1",
-    "typedoc-plugin-no-inherit": "^1.6.1",
-    "typescript": "^5.8.2"
-  },
-  "author": "alex-chernysh",
-  "license": "LICENSE.md",
-  "homepage": "https://docs.claspo.io/docs/claspocommon"
-}

package/out/velocity/SysVelocityRenderer.js

@@ -1 +0,0 @@
-import*as Velocity from"velocityjs";import SysVelocityContext from"./SysVelocityContext";const sysCtx=(new SysVelocityContext).create();export default class SysVelocityRenderer{render(e,t){return Velocity.render(e,Object.assign(Object.assign({},sysCtx),t))}}

package/src/DefaultEventEmitter.test.ts

@@ -1,84 +0,0 @@
-import DefaultEventEmitter from './DefaultEventEmitter';
-
-describe('DefaultEventEmitter', () => {
-
-  it('should not call listeners for event other events', function () {
-
-    // GIVEN
-    const defaultEventEmitter = new DefaultEventEmitter();
-    const mockCallback = jest.fn(x => 42 + x);
-    defaultEventEmitter.on('event 1', mockCallback);
-    // WHEN
-    defaultEventEmitter.emit('event 2', 324);
-
-    // THEN
-    expect(mockCallback.mock.calls.length).toBe(0);
-  });
-
-  it('should call listeners for event * ', function () {
-
-    // GIVEN
-    const defaultEventEmitter = new DefaultEventEmitter();
-    const mockCallback = jest.fn(x => 42 + x);
-    defaultEventEmitter.on('*', mockCallback);
-    // WHEN
-    defaultEventEmitter.emit('any', 324);
-
-    // THEN
-    expect(mockCallback.mock.calls[0][0]).toBe(324);
-  });
-
-  it('should call listeners for specific event', function () {
-
-    // GIVEN
-    const defaultEventEmitter = new DefaultEventEmitter();
-    const mockCallback = jest.fn(x => 42 + x);
-    defaultEventEmitter.on('event name', mockCallback);
-    // WHEN
-    defaultEventEmitter.emit('event name', 324);
-
-    // THEN
-    expect(mockCallback.mock.calls[0][0]).toBe(324);
-  });
-
-  it('off', function () {
-
-    // GIVEN
-    const emitter = new DefaultEventEmitter();
-    const mockCallback = jest.fn(x => 42 + x);
-    const eventName = 'event name';
-
-    // WHEN
-    const listener = emitter.on(eventName, mockCallback);
-
-    // THEN
-    expect(Object.keys(emitter.listeners[eventName]).length).toBe(1);
-
-    // WHEN
-    listener.off();
-
-    // THEN
-    expect(Object.keys(emitter.listeners[eventName]).length).toBe(0);
-  });
-
-  it('destroy', function () {
-    // GIVEN
-    const emitter = new DefaultEventEmitter();
-    const mockCallback = jest.fn(x => 42 + x);
-
-    // WHEN
-    const listener1 = emitter.on('event 1', mockCallback);
-    const listener2 = emitter.on('event 2', mockCallback);
-
-    // THEN
-    expect(Object.values(emitter.listeners).length).toBe(2 + 1);
-
-    // WHEN
-    emitter.destroy();
-
-    // THEN
-    expect(Object.values(emitter.listeners).length).toBe(1);
-  });
-
-
-});

package/src/DefaultEventEmitter.ts

@@ -1,96 +0,0 @@
-import UuidGenerator from './UuidGenerator';
-
-/**
- * Callback function type for event listeners.
- * @param value - The emitted event value
- * @param eventName - The name of the emitted event
- * @param params - Additional parameters passed with the event
- */
-type EventCallback = (value: any, eventName: string, params: any) => void;
-
-/**
- * Map structure for storing event listeners.
- * Keys are event names, values are maps of listener IDs to callbacks.
- */
-type ListenersMap = Record<string, Record<string, EventCallback>>;
-
-/**
- * A simple event emitter implementation for pub/sub communication.
- * Supports named events and wildcard listeners that receive all events.
- * @example
- * const emitter = new DefaultEventEmitter();
- * const subscription = emitter.on('user:login', (data) => console.log(data));
- * emitter.emit('user:login', { userId: 123 });
- * subscription.off(); // Unsubscribe
- */
-export default class DefaultEventEmitter {
-  /**
-   * Creates the initial listeners state with wildcard listener support.
-   * @returns Empty listeners map with wildcard entry
-   */
-  static createDefaultListenersState = (): ListenersMap => ({
-    '*': {}
-  });
-
-  /** Map of event names to their registered listeners */
-  listeners: ListenersMap;
-
-  /**
-   * Creates a new DefaultEventEmitter instance.
-   */
-  constructor() {
-    this.listeners = DefaultEventEmitter.createDefaultListenersState();
-  }
-
-  /**
-   * Emits an event to all registered listeners.
-   * Also triggers wildcard listeners that receive all events.
-   * @param eventName - The name of the event to emit
-   * @param value - The value to pass to listeners
-   * @param params - Optional additional parameters
-   */
-  emit(eventName: string, value: any, params: any = null): void {
-    const eventListeners = this.listeners[eventName];
-
-    if (eventListeners) {
-      Object.values(eventListeners).forEach(cb => cb(value, eventName, params));
-    }
-
-    Object.values(this.listeners['*']).forEach(cb => cb(value, eventName, params));
-  }
-
-  /**
-   * Registers a listener for a specific event.
-   * Use '*' as event name to listen to all events.
-   * @param eventName - The event name to listen for
-   * @param listener - The callback function to invoke when the event is emitted
-   * @returns An object with an `off` method to unsubscribe
-   */
-  on(eventName: string, listener: EventCallback): { off: () => void } {
-    const uuid = UuidGenerator.generate();
-    const eventListeners = this.listeners[eventName];
-
-    if (eventListeners) {
-      eventListeners[uuid] = listener;
-    } else {
-      this.listeners[eventName] = {
-        [uuid]: listener,
-      };
-    }
-
-    return {
-      off: () => {
-        if (this.listeners?.[eventName]?.[uuid]) {
-          delete this.listeners[eventName][uuid];
-        }
-      }
-    };
-  }
-
-  /**
-   * Removes all event listeners and resets the emitter to initial state.
-   */
-  destroy(): void {
-    this.listeners = DefaultEventEmitter.createDefaultListenersState();
-  }
-}

package/src/HttpAbortableLoader.ts

@@ -1,35 +0,0 @@
-export default class HttpAbortableLoader {
-  url: string;
-  headers: Record<string, string>;
-  httpClient: any;
-  loaded: boolean;
-  abortController: AbortController | null = null;
-
-  constructor(url: string, headers: Record<string, string>, httpClient: any) {
-    this.url = url;
-    this.headers = headers;
-    this.httpClient = httpClient;
-    this.loaded = false;
-  }
-
-  load(): Promise<any> {
-    if (window.AbortController) {
-      this.abortController = new AbortController();
-    }
-
-    return this.httpClient
-      .execute(this.url, 'GET', null, this.headers, this.abortController && this.abortController.signal)
-      .then((r: any) => {
-        this.loaded = true;
-        return r;
-      });
-  }
-
-  isLoaded(): boolean {
-    return this.loaded;
-  }
-
-  abortLoading(): void {
-    this.abortController && this.abortController.abort();
-  }
-}

package/src/InAppLayoutType.ts

@@ -1,6 +0,0 @@
-export enum InAppLayoutType {
-  SLIDE_UP = 'SLIDE_UP',
-  POP_UP = 'POP_UP',
-  FULL = 'FULL',
-  BOTTOM_BAR = 'BOTTOM_BAR',
-}

package/src/LayoutType.ts

@@ -1,18 +0,0 @@
-/**
- * Enumeration of widget layout types.
- * Determines how the widget is positioned and displayed on the page.
- */
-export enum LayoutType {
-  /** Widget embedded directly in the page content */
-  BUILT_IN= 'BUILT_IN',
-  /** Dialog / Popup */
-  DETACHED = 'DETACHED',
-  /** Floating box positioned relative to viewport corners */
-  FLOATING_BOX = 'FLOATING_BOX',
-  /** Horizontal bar fixed to top or bottom of viewport */
-  FLOATING_BAR = 'FLOATING_BAR',
-  /** Launcher trigger element that opens the main widget */
-  LAUNCHER = 'LAUNCHER',
-  /** Overlay that locks page content until user interaction */
-  CONTENT_LOCKER = 'CONTENT_LOCKER',
-}

package/src/PrizePool.interface.ts

@@ -1,32 +0,0 @@
-export interface PrizePoolModelI {
-  id: string;
-  sourceType: PrizeSourceType;
-  distributionType?: PrizeDistributionType;
-  options?: PrizePoolOptionI[];
-}
-
-export enum PrizeSourceType {
-  MANUAL = 'MANUAL',
-}
-
-export enum PrizeDistributionType {
-  PERCENT_CHANCE = 'PERCENT_CHANCE',
-}
-
-export interface PrizePoolOptionI {
-  valueType: PrizeOptionValueType;
-  value: string;
-  code: string;
-  weight: number;
-  id?: string;
-  config?: PrizeOptionConfigI;
-}
-
-export enum PrizeOptionValueType {
-  DISCOUNT_PERCENTAGE = 'DISCOUNT_PERCENTAGE',
-  CUSTOM = 'CUSTOM',
-}
-
-export interface PrizeOptionConfigI {
-  imageUrl?: string;
-}

package/src/RenderMode.ts

@@ -1,10 +0,0 @@
-/**
- * Enumeration of widget rendering modes.
- * Determines how the widget responds to model changes.
- */
-export enum RenderMode {
-  /** Runtime mode for end users - optimized for performance */
-  STATIC = 'STATIC',
-  /** Editor mode with live updates - responds to model changes in real-time */
-  UPDATING = 'UPDATING'
-}

package/src/UuidGenerator.ts

@@ -1,16 +0,0 @@
-export default class UuidGenerator {
-
-  static generate(): string {
-    let result = '';
-    let i: string;
-
-    for (let j = 0; j < 32; j++) {
-      if (j === 8 || j === 12 || j === 16 || j === 20) {
-        result += '-';
-      }
-      i = Math.floor(Math.random() * 16).toString(16).toUpperCase();
-      result += i;
-    }
-    return result;
-  }
-}

package/src/WidgetInitConfig.interface.ts

@@ -1,163 +0,0 @@
-import {PrizePoolModelI} from './PrizePool.interface';
-import {ClDocumentI} from './document/Document.interface';
-import {WidgetType} from './WidgetType';
-import {LayoutType} from './LayoutType';
-import {RenderMode} from './RenderMode';
-
-/**
- * Configuration interface for initializing a widget.
- */
-export interface WidgetInitConfigI {
-  /** Document model containing widget structure and content */
-  documentModel: ClDocumentI;
-  /** Layout type */
-  layoutType: LayoutType;
-  /** Widget type */
-  widgetType: WidgetType;
-  /** Base URL for loading static resources */
-  staticResourcesUrl: string;
-  /** Unique identifier for the form variant
-   * @internal
-   * */
-  formVariantId?: string;
-  /**
-   * Site identifier for multi-site deployments
-   * @internal
-   * */
-  siteId?: string;
-  /** Needs for components localization
-   * */
-  browserLanguage?: string;
-  /** Needed for Multi-language widget.
-   * */
-  appearanceLanguage?: string;
-  /** Additional CSS custom properties to apply * */
-  optionalDocumentStyles?: Record<string, string>;
-  /** Enables preview mode (disables tracking and submissions)
-   *  @internal
-   * */
-  previewMode?: boolean;
-  /** Enables editor preview mode
-   * @internal
-   * */
-  editorPreviewMode?: boolean;
-  /** Enables cabinet template preview mode.
-   *  Widgets may render demo content instead of erroring when external data
-   *  (e.g. Shopify store/products) is unavailable.
-   *  @internal
-   * */
-  isTemplatePreview?: boolean;
-  /** Enables demo mode
-   * @internal
-   * */
-  demoMode?: boolean;
-  /** Shows branding elements
-   * @internal
-   * */
-  branded?: boolean;
-  /** Shows upgrade plan button
-   * @internal
-   * */
-  upgradePlanButton?: boolean;
-  /** Initial view (page) index to display */
-  viewIndex?: number;
-  /** Forces mobile environment regardless of actual device
-   * @internal
-   * */
-  forceMobileEnv?: boolean;
-  /** Custom action factory class
-   * @internal
-   * */
-  actionFactoryClass?: any;
-  /** Unique widget identifier
-   *  @internal
-   *  @deprecated
-   * */
-  widgetId?: number;
-  /** Prize pool models for gamification features */
-  prizePoolModels?: PrizePoolModelI[];
-  /** Pre-bundled component classes for static rendering */
-  bundledComponentClasses?: any[];
-  /** Needed only for Multi-language widgets.
-   * Translation strings for internationalization */
-  translations?: TranslationsI;
-  /** Service for tracking user interactions (view, click, etc.)
-   * */
-  trackingService?: TrackingServiceI;
-  /** Disables Google Fonts loading
-   * @internal
-   * */
-  disableGoogleFonts?: boolean;
-  /** Custom layout factory class
-   * @internal
-   * */
-  layoutFactoryClass?: any;
-  /** CSS z-index value for the widget container */
-  zIndex?: number;
-  /** Indicates if running in mobile environment
-   * @internal
-   * */
-  isMobileEnv?: boolean;
-  /** Disables widget interactions
-   * @internal
-   * */
-  disabled?: boolean;
-  /** Disables smart positioning logic
-   * @internal
-   * */
-  disableSmartPosition?: boolean;
-  /** Disables scrollbar width calculation
-   * @internal
-   * */
-  disableScrollbarCalculation?: boolean;
-  /** Disables layout animations* */
-  disableLayoutAnimations?: boolean;
-  /** CSS position value for widget display
-   * @internal */
-  displayPosition?: string;
-  /** Rendering mode
-   * @internal */
-  renderMode?: RenderMode;
-  /** Disables global scroll locking when widget is open */
-  disableGlobalScroll?: boolean;
-  /** Host URL for API requests */
-  hostUrl?: string;
-  /** URL endpoint for contact subscription
-   * @internal */
-  subscribeContactUrl?: string;
-  /** Enables autosave-style submit flow before closing the widget */
-  submitOnClose?: SubmitOnCloseConfigI;
-  /** Prefix for component tag name in order to resolve conflicts between different sources of components on the same page. */
-  productKeyPrefix?: string;
-  /**
-   * Hostname/URL of the user's Shopify store. Consumed by Shopify-integration
-   * widgets (e.g. SysShopifyProductCollectionComponent) to fetch products in
-   * editor / preview contexts. Ignored on real Shopify storefronts where the
-   * component falls back to relative-path requests via isShopifyStorefront().
-   */
-  shopifyStoreUrl?: string;
-  /** Allows additional custom properties */
-  [key: string]: any;
-}
-
-export interface SubmitOnCloseConfigI {
-  enabled: boolean;
-  skipValidation?: boolean;
-}
-
-/**
- * Service interface for tracking user interactions and events.
- */
-export interface TrackingServiceI {
-  /** Sends a custom event with optional payload */
-  send: (eventName: string, payload?: any) => void;
-  /** Tracks a click event on a specific element */
-  trackClick: (elementId: string, payload?: any) => void;
-  /** Tracks a target action (conversion, goal completion, etc.) */
-  trackTargetAction: (actionType: string, payload?: any) => void;
-}
-
-/**
- * Translation dictionary mapping language codes to key-value translation pairs.
- */
-export type TranslationsI = Record<string, Record<string, string>>;

package/src/WidgetType.ts

@@ -1,18 +0,0 @@
-/**
- * Enumeration of widget types.
- * Defines the primary purpose and behavior of a widget.
- */
-export enum WidgetType {
-  /** Form for collecting email subscriptions */
-  SUBSCRIPTION_FORM = 'SUBSCRIPTION_FORM',
-  /** Informational popup or notification */
-  INFORMER = 'INFORMER',
-  /** General-purpose form for collecting user data */
-  REQUEST_FORM = 'REQUEST_FORM',
-  /** Trigger element that opens another widget */
-  LAUNCHER = 'LAUNCHER',
-  /** Age verification gate */
-  AGE_VERIFY = 'AGE_VERIFY',
-  /** Trigger element that opens the main widget */
-  TEASER = 'TEASER',
-}

package/src/action/type.ts

@@ -1,7 +0,0 @@
-export function successAction(type: string): string {
-  return `${type}_SUCCESS`;
-}
-
-export function failureAction(type: string): string {
-  return `${type}_FAILED`;
-}

package/src/async/createAsyncIterator.ts

@@ -1,33 +0,0 @@
-interface RangeIterator extends Iterator<number> {
-  current: number;
-  last: number;
-  next(): IteratorResult<number>;
-}
-
-interface RangeIterable extends Iterable<number> {
-  from: number;
-  to: number;
-  [Symbol.iterator](): RangeIterator;
-}
-
-export default function createAsyncIterator(times: number): RangeIterable {
-  return {
-    from: 0,
-    to: times - 1,
-
-    [Symbol.iterator](): RangeIterator { // called once, in the beginning of for..of
-      return {
-        current: this.from,
-        last: this.to,
-
-        next(): IteratorResult<number> { // called every iteration, to get the next value
-          if (this.current <= this.last) {
-            return {done: false, value: this.current++};
-          } else {
-            return {done: true, value: undefined};
-          }
-        }
-      };
-    }
-  };
-}

package/src/async/debounce.ts

@@ -1,28 +0,0 @@
-/**
- * Type representing a debounced version of a function.
- * Preserves the original function's `this` context and parameters.
- * @typeParam T - The original function type
- */
-type DebouncedFunction<T extends (...args: any[]) => any> = (this: ThisParameterType<T>, ...args: Parameters<T>) => void;
-
-/**
- * Creates a debounced version of a function that delays execution
- * until after the specified timeout has elapsed since the last call.
- * @typeParam T - The function type to debounce
- * @param func - The function to debounce
- * @param timeout - Delay in milliseconds before executing (default: 300)
- * @returns A debounced version of the function
- * @example
- * const debouncedSearch = debounce((query: string) => {
- *   fetch(`/api/search?q=${query}`);
- * }, 500);
- */
-export default function debounce<T extends (...args: any[]) => any>(func: T, timeout = 300): DebouncedFunction<T> {
-  let timer: ReturnType<typeof setTimeout>;
-  return function(this: ThisParameterType<T>, ...args: Parameters<T>): void {
-    clearTimeout(timer);
-    timer = setTimeout(() => {
-      func.apply(this, args);
-    }, timeout);
-  };
-}

package/src/async/timeout.ts

@@ -1,3 +0,0 @@
-export default function timeout(ms: number): Promise<void> {
-  return new Promise<void>(resolve => setTimeout(resolve, ms));
-}