# amitind/util architecture

> Architecture diagram of the GitHub repository amitind/util, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/amitind/util
- Repository: https://github.com/amitind/util

## Overview

##### Component Relationships

**[Source Files (*.ts)] → [TypeScript Compiler] → [Distribution Bundles]**
- ↙            ↘
- [NPM]         [JSR]
- ↘            ↙
- [Consumer Applications]

##### Detailed Component Breakdown

- Source Components (Blue rectangles):
- src/main.ts (Entry point)
- src/dom.ts (DOM utilities)
- src/index.ts (Exports)

- Build Configuration (Gray hexagons):
- tsconfig.json
- vite.config.ts
- package.json
- jsr.json

- Distribution Channels (Green rectangles):
- NPM Package
- JSR Package

##### Implementation Details

Specific elements:

a) Utility Functions Groups (use nested containers):
- Random Generators:
- randomString()
- randomNumber()
- binary()

- Array Utilities:
- shuffleArray<T>()
- randomArrayItem<T>()
- randomItemsArray<T>()
- uniqueArrayItems<T>()

- DOM Utilities:
- querySelector<T>()
- querySelectorAll<T>()
- toggleClass()

##### Notes

- Keep the main utility groups visually distinct but show their relationship to the core library
- Dual distribution nature (NPM/JSR) as a key architectural feature
- Type definition generation and distribution
- Build process flow from source to distribution

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Core Library"]
        direction TB
        Entry["Main Entry Point"]:::source
        click Entry "https://github.com/Amitind/util/blob/main/src/main.ts"
        
        subgraph Modules["Utility Modules"]
            direction TB
            Random["Random Generators"]:::module
            Arrays["Array Utilities"]:::module
            DOM["DOM Utilities"]:::module
            click DOM "https://github.com/Amitind/util/blob/main/src/dom.ts"
            
            subgraph RandomFuncs["Random Functions"]
                direction TB
                RS["randomString()"]:::function
                RN["randomNumber()"]:::function
                Binary["binary()"]:::function
            end
            
            subgraph ArrayFuncs["Array Functions"]
                direction TB
                SA["shuffleArray<T>()"]:::function
                RAI["randomArrayItem<T>()"]:::function
                RIA["randomItemsArray<T>()"]:::function
                UAI["uniqueArrayItems<T>()"]:::function
            end
            
            subgraph DOMFuncs["DOM Functions"]
                direction TB
                QS["querySelector<T>()"]:::function
                QSA["querySelectorAll<T>()"]:::function
                TC["toggleClass()"]:::function
            end
        end
        
        Exports["Module Exports"]:::source
        click Exports "https://github.com/Amitind/util/blob/main/src/index.ts"
    end
    
    subgraph Build["Build & Configuration"]
        direction TB
        TSConfig["TypeScript Config"]:::config
        click TSConfig "https://github.com/Amitind/util/blob/main/tsconfig.json"
        ViteConfig["Vite Config"]:::config
        click ViteConfig "https://github.com/Amitind/util/blob/main/vite.config.ts"
        PackageJSON["package.json"]:::config
        click PackageJSON "https://github.com/Amitind/util/blob/main/package.json"
        JSRConfig["jsr.json"]:::config
        click JSRConfig "https://github.com/Amitind/util/blob/main/jsr.json"
    end
    
    subgraph Distribution["Distribution"]
        direction TB
        NPM["NPM Package"]:::dist
        JSR["JSR Package"]:::dist
    end
    
    subgraph CI["CI/CD Pipelines"]
        direction TB
        NPMPipeline["NPM Publish Action"]:::pipeline
        click NPMPipeline "https://github.com/Amitind/util/blob/main/.github/workflows/npm-publish.yml"
        JSRPipeline["JSR Publish Action"]:::pipeline
        click JSRPipeline "https://github.com/Amitind/util/blob/main/.github/workflows/jsr-publish.yml"
    end
    
    Random --> RandomFuncs
    Arrays --> ArrayFuncs
    DOM --> DOMFuncs
    
    Entry --> Modules
    Modules --> Exports
    
    Exports --> Build
    Build --> Distribution
    
    Distribution --> NPMPipeline
    Distribution --> JSRPipeline
    
    classDef source fill:#a8d1ff,stroke:#333,stroke-width:2px
    classDef module fill:#bbdefb,stroke:#333,stroke-width:1px
    classDef function fill:#e3f2fd,stroke:#333,stroke-width:1px
    classDef config fill:#f5f5f5,stroke:#333,stroke-width:2px
    classDef dist fill:#c8e6c9,stroke:#333,stroke-width:2px
    classDef pipeline fill:#ffecb3,stroke:#333,stroke-width:2px
    
    subgraph Legend
        direction TB
        L1["Source File"]:::source
        L2["Module"]:::module
        L3["Function"]:::function
        L4["Config File"]:::config
        L5["Distribution"]:::dist
        L6["CI/CD Pipeline"]:::pipeline
    end
```
