# arnoudkooi/sn-utils architecture

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

- Interactive diagram: https://gitdiagram.com/arnoudkooi/sn-utils
- Repository: https://github.com/arnoudkooi/sn-utils

## Overview

##### Project type and purpose
- Type: A browser extension (Chrome/Firefox/Edge/Safari) adding developer utilities to ServiceNow.
- Purpose: Inject UI panels (code search, snippet management, script sync, diff viewer, Monaco-based code editor) into ServiceNow pages; provide popup/options pages; coordinate across frames via background scripts.

##### File structure
- Top‐level “manifest.json” declares extension contexts: background scripts, content_scripts, browser_action (popup), sidepanel, options_page.
- “background.js”/“bgscriptmodern.js” run in the background (service worker/event page).
- “content_script_all_frames.js” & “content_script_parent.js” inject into SN frames.
- UI pages under project root: popup.html/js, sidepanel.html/js, codesearch.html/js, codeeditor.html/js, diff.html, scriptsync.html/js, snippets.html/js, viewdata.html/js, settingeditor.html, welcome.html.
- “css/” folder holds styles for each UI page.
- “js/monaco/” and subfolders embed the Monaco editor library.
- “publish/” manifests for other browsers.
- Supporting libs in “js/”: DataStream.js, Tinycon.js, datatables, moment, md5, instancetag, jquery.deserialize, etc.

##### README
- Confirms it is a ServiceNow utilities extension.
- No external backend—everything runs client-side within the browser.
- Mentions on-prem vs. hosted manifests.

##### Main components & their interactions
a. Manifest (manifest.json) – defines extension entry points and permissions (tabs, storage, activeTab, scripting).
b. Background scripts – listen for browser events (popup click, messages from content scripts), manage shared state/storage, route messages.
c. Content scripts – injected into ServiceNow pages (all frames & parent), detect ServiceNow environment, inject the sidepanel and interact with page DOM.
d. UI pages – popup.html (quick-access menu), sidepanel.html (embedded panel in SN layout), codesearch.html, codeeditor.html, diff.html, scriptsync.html, snippets.html, viewdata.html, settingeditor.html, welcome.html. Each page uses its CSS and JS to render UI, call extension APIs, exchange messages with background/content scripts.
e. Libraries – Monaco Editor (for code editing/diff), DataTables (for tables), Moment.js (datetime), md5, etc.
f. Assets – CSS, images, audio (alert.mp3), webfonts.

##### Architectural patterns & design principles
- Event-driven/messaging architecture using Chrome runtime.sendMessage/onMessage.
- Separation of concerns: background (logic & state), content (page integration), UI pages (presentation).
- Modular file layout: each UI feature in its own HTML/JS/CSS set.
- Reuse of common libraries (monaco, jQuery, DataTables).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Manifest
    manifest["Manifest (manifest.json)"]:::config
    click manifest "https://github.com/arnoudkooi/sn-utils/blob/master/manifest.json"

    %% Background Service Worker
    subgraph "Background Service Worker" 
        direction TB
        bg1["background.js"]:::background
        bg2["js/bgscript.js"]:::background
        bg3["js/bgscriptmodern.js"]:::background
    end
    click bg1 "https://github.com/arnoudkooi/sn-utils/blob/master/background.js"
    click bg2 "https://github.com/arnoudkooi/sn-utils/blob/master/js/bgscript.js"
    click bg3 "https://github.com/arnoudkooi/sn-utils/blob/master/js/bgscriptmodern.js"

    %% Content Scripts
    subgraph "Content Scripts" 
        direction TB
        cs1["content_script_all_frames.js"]:::content
        cs2["content_script_parent.js"]:::content
        cs3["inject.js"]:::content
        cs4["inject_next.js"]:::content
        cs5["inject_parent.js"]:::content
    end
    click cs1 "https://github.com/arnoudkooi/sn-utils/blob/master/content_script_all_frames.js"
    click cs2 "https://github.com/arnoudkooi/sn-utils/blob/master/content_script_parent.js"
    click cs3 "https://github.com/arnoudkooi/sn-utils/blob/master/inject.js"
    click cs4 "https://github.com/arnoudkooi/sn-utils/blob/master/inject_next.js"
    click cs5 "https://github.com/arnoudkooi/sn-utils/blob/master/inject_parent.js"

    %% UI Pages
    subgraph "UI Pages" 
        direction TB
        subgraph "Popup UI"
            popup["popup.html"]:::ui
            pupjs["popup.js"]:::ui
            pupcss["css/style.css"]:::ui
        end
        subgraph "Sidepanel UI"
            sidehtml["sidepanel.html"]:::ui
            sidejs["js/sidepanel.js"]:::ui
            sidecss1["css/sidepanel.css"]:::ui
            sidecss2["css/inject.css"]:::ui
        end
        subgraph "Code Search UI"
            cshtml["codesearch.html"]:::ui
            csjs["codesearch.js"]:::ui
            cscss["css/codesearch.css"]:::ui
        end
        subgraph "Code Editor UI"
            cehtml["codeeditor.html"]:::ui
            cecss["css/codeeditor.css"]:::ui
            ce1["js/monaco/codeeditor.js"]:::ui
            ce2["js/monaco/libsource.js"]:::ui
            ce3["js/monaco/vs/**"]:::ui
        end
        subgraph "Diff Viewer UI"
            diffhtml["diff.html"]:::ui
            diffcss["css/diff.css"]:::ui
            diff1["js/monaco/compare.js"]:::ui
            diff2["js/monaco/diff.js"]:::ui
        end
        subgraph "Script Sync UI"
            sshtml["scriptsync.html"]:::ui
            ssjs["scriptsync.js"]:::ui
            sscss["css/scriptsync.css"]:::ui
        end
        subgraph "Snippets UI"
            snhtml["snippets.html"]:::ui
            snjs["js/snippets.js"]:::ui
            sncss["css/snippets.css"]:::ui
        end
        subgraph "View Data UI"
            vdhtml["viewdata.html"]:::ui
            vdjs["viewdata.js"]:::ui
            vdcss["css/viewdata.css"]:::ui
        end
        subgraph "Settings Editor UI"
            sethtml["settingeditor.html"]:::ui
            setjs["js/monaco/settingeditor.js"]:::ui
            setcss["css/options.css"]:::ui
        end
        subgraph "Welcome Page"
            welhtml["welcome.html"]:::ui
            welcss["css/style.css"]:::ui
        end
    end
    click popup "https://github.com/arnoudkooi/sn-utils/blob/master/popup.html"
    click pupjs "https://github.com/arnoudkooi/sn-utils/blob/master/popup.js"
    click pupcss "https://github.com/arnoudkooi/sn-utils/blob/master/css/style.css"
    click sidehtml "https://github.com/arnoudkooi/sn-utils/blob/master/sidepanel.html"
    click sidejs "https://github.com/arnoudkooi/sn-utils/blob/master/js/sidepanel.js"
    click sidecss1 "https://github.com/arnoudkooi/sn-utils/blob/master/css/sidepanel.css"
    click sidecss2 "https://github.com/arnoudkooi/sn-utils/blob/master/css/inject.css"
    click cshtml "https://github.com/arnoudkooi/sn-utils/blob/master/codesearch.html"
    click csjs "https://github.com/arnoudkooi/sn-utils/blob/master/codesearch.js"
    click cscss "https://github.com/arnoudkooi/sn-utils/blob/master/css/codesearch.css"
    click cehtml "https://github.com/arnoudkooi/sn-utils/blob/master/codeeditor.html"
    click cecss "https://github.com/arnoudkooi/sn-utils/blob/master/css/codeeditor.css"
    click ce1 "https://github.com/arnoudkooi/sn-utils/blob/master/js/monaco/codeeditor.js"
    click ce2 "https://github.com/arnoudkooi/sn-utils/blob/master/js/monaco/libsource.js"
    click ce3 "https://github.com/arnoudkooi/sn-utils/tree/master/js/monaco/vs/**"
    click diffhtml "https://github.com/arnoudkooi/sn-utils/blob/master/diff.html"
    click diffcss "https://github.com/arnoudkooi/sn-utils/blob/master/css/diff.css"
    click diff1 "https://github.com/arnoudkooi/sn-utils/blob/master/js/monaco/compare.js"
    click diff2 "https://github.com/arnoudkooi/sn-utils/blob/master/js/monaco/diff.js"
    click sshtml "https://github.com/arnoudkooi/sn-utils/blob/master/scriptsync.html"
    click ssjs "https://github.com/arnoudkooi/sn-utils/blob/master/scriptsync.js"
    click sscss "https://github.com/arnoudkooi/sn-utils/blob/master/css/scriptsync.css"
    click snhtml "https://github.com/arnoudkooi/sn-utils/blob/master/snippets.html"
    click snjs "https://github.com/arnoudkooi/sn-utils/blob/master/js/snippets.js"
    click sncss "https://github.com/arnoudkooi/sn-utils/blob/master/css/snippets.css"
    click vdhtml "https://github.com/arnoudkooi/sn-utils/blob/master/viewdata.html"
    click vdjs "https://github.com/arnoudkooi/sn-utils/blob/master/viewdata.js"
    click vdcss "https://github.com/arnoudkooi/sn-utils/blob/master/css/viewdata.css"
    click sethtml "https://github.com/arnoudkooi/sn-utils/blob/master/settingeditor.html"
    click setjs "https://github.com/arnoudkooi/sn-utils/blob/master/js/monaco/settingeditor.js"
    click setcss "https://github.com/arnoudkooi/sn-utils/blob/master/css/options.css"
    click welhtml "https://github.com/arnoudkooi/sn-utils/blob/master/welcome.html"
    click welcss "https://github.com/arnoudkooi/sn-utils/blob/master/css/style.css"

    %% Shared Libraries
    subgraph "Shared Libraries" 
        direction TB
        lib1["js/monaco/..."]:::lib
        lib2["js/DataStream.js"]:::lib
        lib3["js/Tinycon.js"]:::lib
        lib4["js/datatables-datetime.js"]:::lib
        lib5["js/datetime-moment.js"]:::lib
        lib6["js/moment.js"]:::lib
        lib7["js/md5.js"]:::lib
        lib8["js/instancetag.js"]:::lib
        lib9["js/jquery.deserialize.js"]:::lib
    end
    click lib1 "https://github.com/arnoudkooi/sn-utils/tree/master/js/monaco/"
    click lib2 "https://github.com/arnoudkooi/sn-utils/blob/master/js/DataStream.js"
    click lib3 "https://github.com/arnoudkooi/sn-utils/blob/master/js/Tinycon.js"
    click lib4 "https://github.com/arnoudkooi/sn-utils/blob/master/js/datatables-datetime.js"
    click lib5 "https://github.com/arnoudkooi/sn-utils/blob/master/js/datetime-moment.js"
    click lib6 "https://github.com/arnoudkooi/sn-utils/blob/master/js/moment.js"
    click lib7 "https://github.com/arnoudkooi/sn-utils/blob/master/js/md5.js"
    click lib8 "https://github.com/arnoudkooi/sn-utils/blob/master/js/instancetag.js"
    click lib9 "https://github.com/arnoudkooi/sn-utils/blob/master/js/jquery.deserialize.js"

    %% Storage & External
    storage[(chrome.storage)]:::storage
    sncloud(("ServiceNow Page")):::external

    %% Connections
    manifest -->|"registers"| bg1
    manifest -->|"registers"| cs1
    manifest -->|"registers"| popup
    manifest -->|"registers"| sidehtml

    bg1 <-->|"chrome.runtime.sendMessage"| cs1
    bg1 <-->|"chrome.runtime.onMessage"| popup
    popup <-->|"chrome.runtime.sendMessage"| bg1
    sidehtml <-->|"chrome.runtime.sendMessage"| bg1

    cs1 -->|"injects UI"| sncloud
    sncloud -->|"DOM scripts"| cs1

    bg1 <-->|"chrome.storage.*"| storage
    popup <-->|"chrome.storage.*"| storage

    %% UI Pages load libraries
    popup -->|"loads"| lib2
    popup --> lib3
    popup --> lib6
    cehtml --> lib1
    diffhtml --> lib1
    cshtml --> lib4

    %% Styles
    classDef config fill:#f9f,stroke:#333,stroke-width:1px,shape:hexagon
    classDef background fill:#f96,stroke:#333,stroke-width:1px
    classDef content fill:#9f6,stroke:#333,stroke-width:1px
    classDef ui fill:#69f,stroke:#333,stroke-width:1px
    classDef lib fill:#ccc,stroke:#333,stroke-width:1px
    classDef storage fill:#bbf,stroke:#333,stroke-width:1px
    classDef external fill:#eef,stroke:#333,stroke-width:1px,shape:cloud
```
