@goodgamestudios/cxf-webshop 7.0.0-qa.2 → 7.0.0-qa.22

package/TYPES_REFACTORING.md

@@ -1,308 +0,0 @@
-# Types Refactoring Summary
-
-## Overview
-
-All exported types and interfaces in the `/src` folder have been reviewed and reorganized for better maintainability and clarity.
-
----
-
-## What Was Done
-
-### 1. Created `types.ts` - Central Type Repository
-A new file consolidating all cross-cutting types and interfaces:
-
-**Moved into `types.ts`:**
-- ✅ **Handler Types** (from `handlers/postMessageHandlers.ts`, `handlers/pushHandlers.ts`, `handlers/reducers.ts`)
-  - `Handler` - Generic handler function type
-  - `Handlers` - Dictionary of handlers
-  - `PushHandler` - Push notification handler type
-  - `PushHandlers` - Dictionary of push handlers
-  - `CxfReducers` - CXF event reducers map
-
-- ✅ **Event Payload Types** (from various handler files)
-  - `OpenIGSPayload` - From `handlers/eventHandlers.ts`
-  - `OnRewardProperties` - From `handlers/pushHandlers.ts`
-  - `OnLemonstandCategoryUpdateProperties` - From `handlers/pushHandlers.ts`
-  - `OnLemonstandNotificationsCreatedProperties` - From `handlers/pushHandlers.ts`
-
-- ✅ **Tracking Types** (from `track.ts`)
-  - `ITrackPayload` - Base tracking payload interface
-  - `IRanchWebShopCallProperties` - Specific tracking properties
-
-- ✅ **URL Types** (from `url.ts`)
-  - `ICreateCatalogUrlProperties` - URL generation properties
-
-- ✅ **Events Enum** (from `common.ts`)
-  - `WebshopEvents` - Webshop event names enum
-
-### 2. Updated `common.ts`
-Kept only generic, reusable utility types:
-- ❌ Removed: `WebshopEvents` enum (moved to `types.ts`)
-- ✅ Kept: `IDictionary`, `AnyVoidFn`, `Fn`, `PromiseFn`, `IPushMessageData`, `IPushMessage`
-
-### 3. Domain-Specific Types Remain in Place
-These types stayed in their original files as they're domain-specific:
-
-| File | Types Kept | Rationale |
-|------|-----------|-----------|
-| `cxf.ts` | `IGameApi`, `ICXF` | CXF integration domain |
-| `config.ts` | `GameSpecificConfig`, `Config` | Configuration domain |
-| `store.ts` | `IStore` | State management domain |
-| `storage.ts` | `IStorageData` | Local storage domain |
-| `ping.ts` | `PingProperties` | Ping utility domain |
-| `globalState.ts` | `IProvider<T>` | Internal to global state |
-| `messages/IShopMessageBus.ts` | `IShopMessageBus` | Message bus interface |
-
----
-
-## Files Modified
-
-### Created (1)
-- ✨ `src/types.ts` - 129 lines of consolidated type definitions
-
-### Updated (10)
-1. `src/common.ts` - Removed WebshopEvents enum
-2. `src/config.ts` - Import WebshopEvents from types.ts
-3. `src/handlers/eventHandlers.ts` - Import OpenIGSPayload from types.ts
-4. `src/handlers/postMessageHandlers.ts` - Import Handlers, WebshopEvents from types.ts
-5. `src/handlers/pushHandlers.ts` - Import all payload types from types.ts
-6. `src/handlers/reducers.ts` - Import CxfReducers, WebshopEvents from types.ts
-7. `src/track.ts` - Import tracking types from types.ts
-8. `src/url.ts` - Import ICreateCatalogUrlProperties from types.ts
-9. `src/README.md` - Added types organization section
-10. `src/FILE_LIST.md` - Updated file count and structure
-
-### Documentation (1)
-- 📖 `src/TYPES_ORGANIZATION.md` - Comprehensive guide (267 lines)
-
----
-
-## Before & After
-
-### Before: Types Scattered Across Files
-
-```typescript
-// handlers/eventHandlers.ts
-export interface OpenIGSPayload { ... }
-
-// handlers/postMessageHandlers.ts
-export type Handler = (...args: any[]) => void
-export type Handlers = IDictionary<Handler>
-
-// handlers/pushHandlers.ts
-export type PushHandler = (...args: any[]) => void
-export type PushHandlers = IDictionary<PushHandler>
-export interface OnRewardProperties { ... }
-export interface OnLemonstandCategoryUpdateProperties { ... }
-
-// track.ts
-export interface IRanchWebShopCallProperties { ... }
-export interface ITrackPayload { ... }
-
-// url.ts
-export interface ICreateCatalogUrlProperties { ... }
-
-// common.ts
-export enum WebshopEvents { ... }
-```
-
-### After: Consolidated in `types.ts`
-
-```typescript
-// types.ts - Single source of truth
-export type Handler = (...args: any[]) => void
-export type Handlers = IDictionary<Handler>
-export type PushHandler = (...args: any[]) => void
-export type PushHandlers = IDictionary<PushHandler>
-export type CxfReducers = IDictionary<() => void>
-
-export interface OpenIGSPayload { ... }
-export interface OnRewardProperties { ... }
-export interface OnLemonstandCategoryUpdateProperties { ... }
-export interface OnLemonstandNotificationsCreatedProperties { ... }
-
-export interface ITrackPayload { ... }
-export interface IRanchWebShopCallProperties extends ITrackPayload { ... }
-
-export interface ICreateCatalogUrlProperties { ... }
-
-export enum WebshopEvents { ... }
-```
-
----
-
-## Import Pattern Changes
-
-### Before
-```typescript
-// Multiple imports from different files
-import { WebshopEvents } from '../common'
-import { Handler, Handlers } from '../handlers/postMessageHandlers'
-import { OpenIGSPayload } from '../handlers/eventHandlers'
-import { PushHandler, PushHandlers } from '../handlers/pushHandlers'
-```
-
-### After
-```typescript
-// Single import for all shared types
-import { 
-    Handler, 
-    Handlers, 
-    PushHandlers, 
-    OpenIGSPayload, 
-    WebshopEvents 
-} from '../types'
-```
-
----
-
-## Benefits Achieved
-
-### ✅ Organization
-- Single source of truth for cross-cutting types
-- Clear separation between generic utils and shared types
-- Related types grouped together logically
-
-### ✅ Maintainability
-- Easier to find type definitions
-- Reduced duplication risk
-- Clear naming conventions with JSDoc comments
-
-### ✅ Developer Experience
-- Fewer import statements
-- Clearer module dependencies
-- Better IDE autocomplete and navigation
-
-### ✅ Scalability
-- Established pattern for future type additions
-- Clear decision tree for type placement
-- Documentation for onboarding
-
----
-
-## Organization Principles
-
-### Types go in `types.ts` when:
-1. ✅ Used by multiple modules
-2. ✅ Defines handler signatures
-3. ✅ Represents event payloads/properties
-4. ✅ Cross-cutting concerns (tracking, URLs, etc.)
-5. ✅ Application-specific enums
-
-### Types stay in domain files when:
-1. ✅ Specific to a single domain (Config, Store, CXF)
-2. ✅ Only used within one module
-3. ✅ Represents core domain concepts
-4. ✅ Implementation details
-
-### Types stay in `common.ts` when:
-1. ✅ Generic utility types
-2. ✅ Could be used in any TypeScript project
-3. ✅ No application-specific logic
-
----
-
-## Statistics
-
-| Metric | Count |
-|--------|-------|
-| Types consolidated into types.ts | 12+ |
-| Files updated | 10 |
-| New documentation files | 1 |
-| Lines of documentation added | 267 |
-| Import statements simplified | 8+ |
-| Removed duplicate type exports | 12+ |
-
----
-
-## Type Distribution
-
-```
-Total Exported Types: ~45
-
-types.ts (new):        12 types  (26%)  - Shared/cross-cutting
-common.ts:             6 types   (13%)  - Generic utilities
-Domain files:          27 types  (61%)  - Domain-specific
-```
-
----
-
-## Documentation
-
-### New Documentation Created
-- **TYPES_ORGANIZATION.md** - Comprehensive guide
-  - Where to find types
-  - When to add new types
-  - Decision tree for type placement
-  - Import patterns
-  - Best practices
-
-### Updated Documentation
-- **README.md** - Added types organization section
-- **FILE_LIST.md** - Updated file inventory
-- **INDEX.md** - Added types documentation link
-
----
-
-## Migration Guide
-
-### For Developers
-
-**Finding a type:**
-1. Check `types.ts` for handler/payload/event types
-2. Check `common.ts` for generic utility types
-3. Check domain files (`config.ts`, `store.ts`, etc.) for domain types
-
-**Adding a new type:**
-1. Is it used by multiple modules? → Consider `types.ts`
-2. Is it a generic utility? → Consider `common.ts`
-3. Is it domain-specific? → Keep in domain file
-
-**See [TYPES_ORGANIZATION.md](./src/TYPES_ORGANIZATION.md) for detailed guidance**
-
----
-
-## Validation
-
-### All Imports Updated ✅
-- Zero circular dependencies
-- All type references resolved
-- TypeScript compilation successful
-- No runtime errors introduced
-
-### Code Quality ✅
-- JSDoc comments added to all types in types.ts
-- Consistent naming conventions
-- Logical grouping with section headers
-- Clear type relationships (extends, implements)
-
----
-
-## Future Considerations
-
-As the codebase grows:
-- Consider splitting `types.ts` by category (handlers/, payloads/, etc.)
-- Create `types/` directory with categorized files
-- Use TypeScript namespaces for grouping
-- Consider a `contracts/` folder for cross-module interfaces
-
----
-
-## Conclusion
-
-The types refactoring successfully:
-- ✅ Consolidated 12+ scattered type definitions into a single `types.ts` file
-- ✅ Established clear organization principles
-- ✅ Improved developer experience with simpler imports
-- ✅ Created comprehensive documentation
-- ✅ Maintained 100% backward compatibility
-- ✅ Zero breaking changes to functionality
-
-**Result**: Better organized, more maintainable type system with clear patterns for future growth.
-
----
-
-**Completed**: 2024  
-**Status**: Production Ready ✅  
-**Breaking Changes**: None  
-**Documentation**: Complete

package/esbuild.build.js

@@ -1,14 +0,0 @@
-import * as esbuild from 'esbuild'
-import * as env from './env.js'
-
-const STAGE = process.env.STAGE || 'development'
-
-await esbuild
-  .build({
-    entryPoints: ['src/index.ts'],
-    bundle: true,
-    minify: true,
-    sourcemap: true,
-    define: { process: JSON.stringify({ env: env[STAGE] }) },
-    outfile: 'dist/webshop-cxf.js',
-  })

package/esbuild.serve.js

@@ -1,25 +0,0 @@
-import * as esbuild from 'esbuild'
-import * as env from './env.js'
-
-const STAGE = process.env.STAGE || 'development'
-const PORT = 1101
-
-process.title = 'esbuild-serve' // required for shutdown process after tests are finished
-
-let ctx = await esbuild.context({
-  entryPoints: ['bdd/src/index.ts'],
-  bundle: true,
-  minify: true,
-  sourcemap: true,
-  define: { process: JSON.stringify({ env: env[STAGE] }) },
-  outdir: 'bdd/src',
-})
-
-await ctx.watch()
-
-let { port } = await ctx.serve({
-        port: PORT,
-        servedir: 'bdd/src',
-})
-
-console.log(`Project is running at http://localhost:${port}/`)

package/src_old/@types/global.d.ts

@@ -1,2 +0,0 @@
-declare function ggsGetQueryParameters(): string
-declare function ggsGetReferrer(): string

package/src_old/ArgumentNullError.ts

@@ -1,6 +0,0 @@
-export class ArgumentNullError extends Error {
-    constructor(parameterName: string, parameterValue: any) {
-        super(`${parameterName} has null value: ${parameterValue}`)
-        this.name = 'ArgumentNullError'
-    }
-}

package/src_old/app.ts

@@ -1,30 +0,0 @@
-import { DIReader } from './common'
-import { inject } from 'readuz'
-
-export const app: DIReader<void> = inject(
-    (environment) => environment.postMessageHandlers,
-    (environment) => environment.subscribeToCxf,
-    (environment) => environment.log,
-    (environment) => environment.tryCatch,
-    (environment) => environment.preResolveConfig,
-    (postMessageHandlers, subscribeCxf, log, tryCatch, preResolveConfig) => {
-        log('App has started')
-        window.addEventListener(
-            'message',
-            tryCatch(({ data }: MessageEvent) => {
-                if (data) {
-                    const handler = postMessageHandlers[data.name]
-                    if (handler) {
-                        log('POST MESSAGE', data)
-                        handler(data.payload)
-                    }
-                }
-            })
-        )
-        // eslint-disable-next-line array-callback-return
-        Object.entries(subscribeCxf).map(([_, reducer]) => {
-            reducer()
-        })
-        preResolveConfig()
-    }
-)

package/src_old/combineReaders.ts

@@ -1,8 +0,0 @@
-import { IDictionary } from './common'
-import { Reader } from 'readuz'
-
-export const combineReaders =
-    <E>(readers: IDictionary<Reader<E, any>>) =>
-    (environment: E) => {
-        return Object.fromEntries(Object.entries(readers).map<any>(([key, reader]) => [key, reader(environment)]))
-    }

package/src_old/common.ts

@@ -1,35 +0,0 @@
-import { IEnvironment } from './env'
-import { Reader } from 'readuz'
-
-export interface IDictionary<T> {
-    [key: string]: T
-}
-
-export type AnyVoidFn = (...arguments_: any[]) => void
-
-export type DIReader<TResult> = Reader<IEnvironment, TResult>
-
-export type Fn<A, B> = (a: A) => B
-export type PromiseFn<A, B> = Fn<A, Promise<B>>
-
-type IPushMessageId = string
-
-export type IPushMessageData = {
-    id: IPushMessageId
-    payload: IDictionary<any>
-}
-
-export interface IPushMessage<T> {
-    id: string
-    payload: T
-}
-
-export enum WebshopEvents {
-    CXF_DIALOG_CLOSE = 'cxf.dialog.close',
-    CXF_NATIVE_SUBSCRIPTION_ENABLE = 'cxf.native.subscription.enable',
-    CXF_OPEN_SALES_MSG = 'cxf.webshop.sales.open',
-    CXF_SET_CUSTOMIZATION_SUFFIX = 'cxf.set.customization.surfix',
-    CXF_JOIN_TEMP_SERVER = 'cxf.join.temp.server',
-    LEMONSTAND_CATEGORY_UPDATE = 'lemonstand.category.update',
-    LEMONSTAND_NOTIFICATIONS_CREATED = 'lemonstand.notifs.created',
-}

package/src_old/config.ts

@@ -1,42 +0,0 @@
-import { IDictionary, WebshopEvents } from './common'
-import { CxfEvents } from '@goodgamestudios/cxf-events'
-
-export type GameSpecificConfig = {
-    LEGEND_LEVEL_IS_USED: boolean
-}
-
-const COMMON_CONFIG = {
-    CUSTOMIZATION_URL: process.env.CUSTOMIZATION_URL as string,
-    CUSTOMIZATION_URL_TEMPLATE: process.env.CUSTOMIZATION_URL_TEMPLATE as string,
-    BASE_URL: process.env.BASE_URL as string,
-    CXF_DIALOG_OPEN: 'cxf.dialog.open',
-    CXF_DIALOG_CLOSE: 'cxf.dialog.close',
-    CXF_TRACK_MSG: 'cxf.tracking.message',
-    CXF_BTN_CLICK_MSG: CxfEvents.OpenIGS,
-    CXF_OPEN_SALES_MSG: WebshopEvents.CXF_OPEN_SALES_MSG,
-    WEB_SHOP_CALL_TRACK_ID: 1181,
-    CXF_ERROR: 'cxf.error',
-    CXF_PUSH: 'cxf.push',
-    CXF_AD_STATUS: 'cxf.adBanner.status',
-}
-
-export type Config = typeof COMMON_CONFIG & GameSpecificConfig
-
-const GAME_SPECIFIC_CONFIG: IDictionary<GameSpecificConfig> = {
-    12: {
-        LEGEND_LEVEL_IS_USED: true,
-    },
-    15: {
-        LEGEND_LEVEL_IS_USED: false,
-    },
-    16: {
-        LEGEND_LEVEL_IS_USED: true,
-    },
-}
-
-export const createConfig = (gameId: string): Config => {
-    return {
-        ...COMMON_CONFIG,
-        ...GAME_SPECIFIC_CONFIG[gameId],
-    }
-}

package/src_old/cxf.ts

@@ -1,32 +0,0 @@
-import { DIReader } from './common'
-import { inject } from 'readuz'
-import { CXF as ICXFBase } from '@goodgamestudios/cxf-runtime'
-
-export interface IGameApi {
-    invokeFn(functionName: string, ...arguments_: any[]): Promise<any>
-}
-
-export interface ICXF extends ICXFBase {
-    gameApi: IGameApi
-}
-
-export type GetCxf = () => ICXF
-export const getCxf: DIReader<GetCxf> = inject(
-    (environment) => environment.cxfProvider,
-    (cxfProvider) => () => {
-        const cxf = cxfProvider.get()
-        if (cxf) {
-            return cxf
-        }
-
-        throw new Error('CXF is not loaded')
-    }
-)
-
-export type SetCxf = (cxf: ICXF) => void
-export const setCxf: DIReader<SetCxf> = inject(
-    (environment) => environment.cxfProvider,
-    (cxfProvider) => (value) => {
-        cxfProvider.set(value)
-    }
-)

package/src_old/dialog.ts

@@ -1,25 +0,0 @@
-import { inject } from 'readuz'
-import { DIReader } from './common'
-import { getCxf } from './helpers'
-
-export type RemoveDialog = () => void
-export const removeDialog: DIReader<RemoveDialog> = inject(
-    (environment) => environment.config,
-    (environment) => environment.cxfProvider,
-    ({ CXF_DIALOG_CLOSE }, cxfProvider) =>
-        () => {
-            const cxf = getCxf(cxfProvider)
-            cxf.emit(CXF_DIALOG_CLOSE)
-        }
-)
-
-export type CreateDialog = (url: string) => void
-export const createDialog: DIReader<CreateDialog> = inject(
-    (environment) => environment.config,
-    (environment) => environment.cxfProvider,
-    ({ CXF_DIALOG_OPEN }, cxfProvider) =>
-        (url) => {
-            const cxf = getCxf(cxfProvider)
-            cxf.emit(CXF_DIALOG_OPEN, url)
-        }
-)

package/src_old/env.ts

@@ -1,127 +0,0 @@
-import { just } from 'readuz'
-import { createCxfReducers, CxfReducers, subscribeToGameEvents, SubscribeToGameEvents } from './handlers/reducers'
-import { DIReader } from './common'
-import { Config, createConfig } from './config'
-import { CreateDialog, createDialog, RemoveDialog, removeDialog } from './dialog'
-import { OnOpen, onOpen } from './handlers/eventHandlers'
-import {
-    entityProvider,
-    getDomain,
-    GetDomain,
-    getPing,
-    GetPing,
-    ggsGetQueryParams as ggsGetQueryParameters,
-    GGSGetQueryParams as GGSGetQueryParameters,
-    ggsGetReferrerValue,
-    GGSGetReferrerValue,
-    IProvider,
-    loadCxf,
-    LoadCxf,
-    Log,
-    log,
-    LogError,
-    logError,
-    ThrowCxfError,
-    throwCxfError,
-    TryCatch,
-    tryCatch,
-} from './helpers'
-import { TrackAction, trackAction, TrackOpenAction, trackOpenAction } from './track'
-import { CreateCustomizationUrl, createCustomizationUrl, CreateIframeUrl, createIframeUrl } from './url'
-import { createPushHandlers, PushHandlers } from './handlers/pushHandlers'
-import { createPostMessageHandlers, Handlers } from './handlers/postMessageHandlers'
-import { GetStorageData, getStorageData, setStorageData, SetStorageData } from './storage'
-import { defaultStore, getStore, GetStore, IStore, setStore, SetStore } from './store'
-import { getCxf, GetCxf, ICXF } from './cxf'
-import { IShopMessageBus } from './messages/IShopMessageBus'
-import { ShopMessageBus } from './messages/ShopMessageBus'
-import { preResolveConfig, PreFetch } from './preFetch'
-import { OfferNotificationsFetchResult, fetchUnreadOfferNotificationsCount } from './fetch'
-
-export interface IEnvironment {
-    config: DIReader<Config>
-
-    cxfProvider: DIReader<IProvider<ICXF>>
-    getCxf: DIReader<GetCxf>
-
-    dialogProvider: DIReader<IProvider<HTMLElement>>
-
-    store: DIReader<IProvider<IStore>>
-    getStore: DIReader<GetStore>
-    setStore: DIReader<SetStore>
-    log: DIReader<Log>
-    logError: DIReader<LogError>
-    throwCxfError: DIReader<ThrowCxfError>
-
-    createDialog: DIReader<CreateDialog>
-    removeDialog: DIReader<RemoveDialog>
-
-    createIframeUrl: DIReader<CreateIframeUrl>
-    createCustomizationUrl: DIReader<CreateCustomizationUrl>
-
-    onOpen: DIReader<OnOpen>
-
-    pushHandlers: DIReader<PushHandlers>
-    postMessageHandlers: DIReader<Handlers>
-    subscribeToCxf: DIReader<CxfReducers>
-    trackOpenAction: DIReader<TrackOpenAction>
-    trackAction: DIReader<TrackAction>
-    loadCxf: DIReader<LoadCxf>
-    tryCatch: DIReader<TryCatch>
-
-    getStorageData: DIReader<GetStorageData>
-    setStorageData: DIReader<SetStorageData>
-    getPing: DIReader<GetPing>
-    subscribeToGameEvents: DIReader<SubscribeToGameEvents>
-    getDomain: DIReader<GetDomain>
-    ggsGetQueryParams: DIReader<GGSGetQueryParameters>
-    ggsGetReferrerValue: DIReader<GGSGetReferrerValue>
-    shopMessageBus: DIReader<IShopMessageBus>
-    preResolveConfig: DIReader<PreFetch>
-    fetchUnreadOfferNotificationsCount: DIReader<OfferNotificationsFetchResult>
-}
-
-export const createEnv = (environment: Partial<IEnvironment>): IEnvironment => {
-    return {
-        config: just(createConfig('15')),
-
-        cxfProvider: just(entityProvider()),
-        getCxf,
-        subscribeToGameEvents,
-
-        dialogProvider: just(entityProvider()),
-
-        store: just(entityProvider(defaultStore({} as ICXF))),
-        getStore,
-        setStore,
-        log: just(log),
-        logError: just(logError),
-        throwCxfError,
-
-        createDialog,
-        removeDialog,
-        pushHandlers: createPushHandlers({}),
-        postMessageHandlers: createPostMessageHandlers({}),
-        subscribeToCxf: createCxfReducers({}),
-        onOpen,
-        createIframeUrl,
-        createCustomizationUrl,
-        trackOpenAction,
-        trackAction,
-        loadCxf: just(loadCxf),
-        tryCatch,
-
-        getStorageData: just(getStorageData),
-        setStorageData: just(setStorageData),
-        getPing,
-        getDomain,
-        ggsGetQueryParams: ggsGetQueryParameters,
-        ggsGetReferrerValue,
-
-        shopMessageBus: just(new ShopMessageBus()),
-        preResolveConfig,
-        fetchUnreadOfferNotificationsCount,
-
-        ...environment,
-    }
-}