# gaurangtandon/prokeys architecture

> Architecture diagram of the GitHub repository gaurangtandon/prokeys, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gaurangtandon/prokeys
- Repository: https://github.com/gaurangtandon/prokeys

## Overview

ProKeys is a browser extension for expanding snippets and applying text productivity features inside web pages. The main workflow begins when a user types in a page: content-script detection checks the configured trigger, prepares the snippet (including documented placeholders and macros), then inserts it into the editor. Options provide snippet and settings management; background messaging and browser storage support shared data. The graph also preserves documented backup/restore, auto-insert, and browser-access capabilities. Some modules are only indexed or partially excerpted, so uncertain implementation links are omitted.

Main entry points: [`js/snippetClasses.js`](https://github.com/gaurangtandon/prokeys/blob/master/js/snippetClasses.js) (Snippet model), [`js/commonDataHandlers.js`](https://github.com/gaurangtandon/prokeys/blob/master/js/commonDataHandlers.js) (Shared data handlers), [`js/detector.js`](https://github.com/gaurangtandon/prokeys/blob/master/js/detector.js) (Content detection), [`js/options.js`](https://github.com/gaurangtandon/prokeys/blob/master/js/options.js) (Options interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_page["Page interaction"]
  node_detector["Content detection<br/>[detector.js]"]
  node_auto["Auto-insert pairs"]
  node_modal["Site-block modal<br/>[modalHandlers.js]"]
end

subgraph group_snippets["Snippet features"]
  node_snippetmodel["Snippet model<br/>[snippetClasses.js]"]
  node_snippetedit["Snippet editing<br/>[snippetWork.js]"]
  node_date["Date macros<br/>[dateFns.js]"]
end

subgraph group_settings["Configuration and data"]
  node_options["Options interface<br/>[options.js]"]
  node_backup["Backup and export<br/>[backupWork.js]"]
  node_restore["Import and restore<br/>[restoreFns.js]"]
  node_data["Shared data handlers"]
end

subgraph group_browser["Browser integration"]
  node_background["Background services<br/>[background.js]"]
  node_browserapis["Browser APIs"]
end

subgraph group_internal["Shared utilities"]
  node_utilities["Shared utilities<br/>[pre.js]"]
  node_textmethods["Text formatting<br/>[textmethods.js]"]
  node_primitive["DOM extensions<br/>[primitiveExtend.js]"]
  node_proto["Prototype registration<br/>[protoExtend.js]"]
end

node_user(("Extension user"))
node_webpage["Web page editor"]

node_user -->|"types into"| node_webpage
node_webpage -->|"triggers detection"| node_detector
node_detector -->|"prepares expansion"| node_snippetmodel
node_detector -->|"inserts text"| node_webpage
node_detector -->|"checks pairs"| node_auto
node_snippetmodel -->|"evaluates date macros"| node_date
node_snippetmodel -->|"uses helpers"| node_utilities
node_snippetmodel -->|"formats text"| node_textmethods
node_snippetedit -->|"edits snippets"| node_snippetmodel
node_snippetedit -->|"saves snippets"| node_data
node_options -->|"saves settings"| node_data
node_options -->|"starts backup"| node_backup
node_options -->|"starts restore"| node_restore
node_restore -->|"builds folders"| node_snippetmodel
node_restore -->|"saves restored data"| node_data
node_modal -->|"saves site rules"| node_data
node_data -->|"sends data messages"| node_background
node_background -.->|"uses browser services"| node_browserapis
node_data -->|"queries and messages tabs"| node_browserapis
node_primitive -->|"registers extensions"| node_proto
node_primitive -->|"uses text helpers"| node_textmethods
node_primitive -->|"uses date helper"| node_date

click node_detector "https://github.com/gaurangtandon/prokeys/blob/master/js/detector.js"
click node_auto "https://github.com/gaurangtandon/prokeys/blob/master/js/autoInsertFunctionality.js"
click node_modal "https://github.com/gaurangtandon/prokeys/blob/master/js/modalHandlers.js"
click node_snippetmodel "https://github.com/gaurangtandon/prokeys/blob/master/js/snippetClasses.js"
click node_snippetedit "https://github.com/gaurangtandon/prokeys/blob/master/js/snippetWork.js"
click node_options "https://github.com/gaurangtandon/prokeys/blob/master/js/options.js"
click node_backup "https://github.com/gaurangtandon/prokeys/blob/master/js/backupWork.js"
click node_restore "https://github.com/gaurangtandon/prokeys/blob/master/js/restoreFns.js"
click node_data "https://github.com/gaurangtandon/prokeys/blob/master/js/commonDataHandlers.js"
click node_background "https://github.com/gaurangtandon/prokeys/blob/master/js/background.js"
click node_date "https://github.com/gaurangtandon/prokeys/blob/master/js/dateFns.js"
click node_utilities "https://github.com/gaurangtandon/prokeys/blob/master/js/pre.js"
click node_textmethods "https://github.com/gaurangtandon/prokeys/blob/master/js/textmethods.js"
click node_primitive "https://github.com/gaurangtandon/prokeys/blob/master/js/primitiveExtend.js"
click node_proto "https://github.com/gaurangtandon/prokeys/blob/master/js/protoExtend.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_detector,node_auto,node_modal,node_user toneBlue
class node_snippetmodel,node_snippetedit,node_date toneAmber
class node_options,node_backup,node_restore,node_data toneMint
class node_background,node_browserapis toneRose
class node_utilities,node_textmethods,node_primitive,node_proto,node_webpage toneIndigo
```

## Components

### Page interaction

- [Content detection](https://github.com/gaurangtandon/prokeys/blob/master/js/detector.js): `js/detector.js`
- [Auto-insert pairs](https://github.com/gaurangtandon/prokeys/blob/master/js/autoInsertFunctionality.js): `js/autoInsertFunctionality.js`
- [Site-block modal](https://github.com/gaurangtandon/prokeys/blob/master/js/modalHandlers.js): `js/modalHandlers.js`

### Snippet features

- [Snippet model](https://github.com/gaurangtandon/prokeys/blob/master/js/snippetClasses.js): `js/snippetClasses.js`
- [Snippet editing](https://github.com/gaurangtandon/prokeys/blob/master/js/snippetWork.js): `js/snippetWork.js`
- [Date macros](https://github.com/gaurangtandon/prokeys/blob/master/js/dateFns.js): `js/dateFns.js`

### Configuration and data

- [Options interface](https://github.com/gaurangtandon/prokeys/blob/master/js/options.js): `js/options.js`
- [Backup and export](https://github.com/gaurangtandon/prokeys/blob/master/js/backupWork.js): `js/backupWork.js`
- [Import and restore](https://github.com/gaurangtandon/prokeys/blob/master/js/restoreFns.js): `js/restoreFns.js`
- [Shared data handlers](https://github.com/gaurangtandon/prokeys/blob/master/js/commonDataHandlers.js): `js/commonDataHandlers.js`

### Browser integration

- [Background services](https://github.com/gaurangtandon/prokeys/blob/master/js/background.js): `js/background.js`
- **Browser APIs**

### Shared utilities

- [Shared utilities](https://github.com/gaurangtandon/prokeys/blob/master/js/pre.js): `js/pre.js`
- [Text formatting](https://github.com/gaurangtandon/prokeys/blob/master/js/textmethods.js): `js/textmethods.js`
- [DOM extensions](https://github.com/gaurangtandon/prokeys/blob/master/js/primitiveExtend.js): `js/primitiveExtend.js`
- [Prototype registration](https://github.com/gaurangtandon/prokeys/blob/master/js/protoExtend.js): `js/protoExtend.js`

### Other components

- **Extension user**
- **Web page editor**

## Connections

- Extension user → Web page editor: types into (evidence: `README.md`)
- Web page editor → Content detection: triggers detection (evidence: `README.md`)
- Content detection → Snippet model: prepares expansion (evidence: `README.md`)
- Content detection → Web page editor: inserts text (evidence: `README.md`)
- Content detection → Auto-insert pairs: checks pairs (evidence: `js/detector.js`)
- Snippet model → Date macros: evaluates date macros (evidence: `js/snippetClasses.js`)
- Snippet model → Shared utilities: uses helpers (evidence: `js/snippetClasses.js`)
- Snippet model → Text formatting: formats text (evidence: `js/snippetClasses.js`)
- Snippet editing → Snippet model: edits snippets (evidence: `js/snippetWork.js`)
- Snippet editing → Shared data handlers: saves snippets (evidence: `js/snippetWork.js`)
- Options interface → Shared data handlers: saves settings (evidence: `js/options.js`)
- Options interface → Backup and export: starts backup (evidence: `js/options.js`)
- Options interface → Import and restore: starts restore (evidence: `js/options.js`)
- Import and restore → Snippet model: builds folders (evidence: `js/restoreFns.js`)
- Import and restore → Shared data handlers: saves restored data (evidence: `js/restoreFns.js`)
- Site-block modal → Shared data handlers: saves site rules (evidence: `js/modalHandlers.js`)
- Shared data handlers → Background services: sends data messages (evidence: `js/commonDataHandlers.js`)
- Background services → Browser APIs: uses browser services
- Shared data handlers → Browser APIs: queries and messages tabs (evidence: `js/commonDataHandlers.js`)
- DOM extensions → Prototype registration: registers extensions (evidence: `js/primitiveExtend.js`)
- DOM extensions → Text formatting: uses text helpers (evidence: `js/primitiveExtend.js`)
- DOM extensions → Date macros: uses date helper (evidence: `js/primitiveExtend.js`)
