Compare commits

..

11 Commits

Author SHA1 Message Date
doprz
e13722820b refactor: use a local changelog 2025-10-15 12:22:59 -05:00
doprz
e0067f8a76 fix: delete 2025-10-15 12:20:14 -05:00
doprz
a66fd151dd chore: add Sentry env vars to workflow 2025-10-14 20:25:04 -05:00
doprz
006d375605 fix: scripts and CI/CD 2025-10-14 20:06:46 -05:00
doprz
4bbddacabb revert: use cachix/install-nix-action 2025-10-14 16:36:57 -05:00
doprz
18530d9d45 fix: disable flakehub 2025-10-14 16:32:53 -05:00
doprz
3d3e8ced6f refactor(nix): use DeterminateSystems nix CI GHAs 2025-10-14 16:27:56 -05:00
doprz
c9df1bf344 feat(ci): add GHA jobs for release 2025-10-13 14:12:29 -05:00
doprz
d8216aefb6 feat(ci): add nix job 2025-10-13 13:48:00 -05:00
doprz
aeac1bab5b chore: remove .releaserc.json 2025-10-13 13:24:04 -05:00
doprz
1a0757c3e6 feat: add changesets cli 2025-10-13 13:22:17 -05:00
136 changed files with 2110 additions and 5153 deletions

8
.changeset/README.md Normal file
View File

@@ -0,0 +1,8 @@
# Changesets
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

View File

@@ -0,0 +1,5 @@
---
'ut-registration-plus': minor
---
Add CI/CD

11
.changeset/config.json Normal file
View File

@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}

View File

@@ -1,18 +1,23 @@
# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig # File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,node,react,storybookjs # Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,node,react,storybookjs
# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,node,react,storybookjs # Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,node,react,storybookjs
### macOS ### ### macOS
# General # General
.DS_Store .DS_Store
.AppleDouble .AppleDouble
.LSOverride .LSOverride
# Thumbnails # Thumbnails
._*
.\_\*
# Files that might appear in the root of a volume # Files that might appear in the root of a volume
.DocumentRevisions-V100 .DocumentRevisions-V100
.fseventsd .fseventsd
.Spotlight-V100 .Spotlight-V100
@@ -22,221 +27,278 @@
.com.apple.timemachine.donotpresent .com.apple.timemachine.donotpresent
# Directories potentially created on remote AFP share # Directories potentially created on remote AFP share
.AppleDB .AppleDB
.AppleDesktop .AppleDesktop
Network Trash Folder Network Trash Folder
Temporary Items Temporary Items
.apdisk .apdisk
### macOS Patch ### ### macOS Patch
# iCloud generated files
*.icloud # iCloud generated files
\*.icloud
### Node
### Node ###
# Logs # Logs
logs logs
*.log _.log
npm-debug.log* npm-debug.log_
yarn-debug.log* yarn-debug.log*
yarn-error.log* yarn-error.log*
lerna-debug.log* lerna-debug.log*
.pnpm-debug.log* .pnpm-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html) # Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
# Runtime data # Runtime data
pids pids
*.pid _.pid
*.seed _.seed
*.pid.lock \*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover # Directory for instrumented libs generated by jscoverage/JSCover
lib-cov lib-cov
# Coverage directory used by tools like istanbul # Coverage directory used by tools like istanbul
coverage coverage
*.lcov \*.lcov
# nyc test coverage # nyc test coverage
.nyc_output .nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt .grunt
# Bower dependency directory (https://bower.io/) # Bower dependency directory (https://bower.io/)
bower_components bower_components
# node-waf configuration # node-waf configuration
.lock-wscript .lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html) # Compiled binary addons (https://nodejs.org/api/addons.html)
build build
# Dependency directories # Dependency directories
node_modules/ node_modules/
jspm_packages/ jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/) # Snowpack dependency directory (https://snowpack.dev/)
web_modules/ web_modules/
# TypeScript cache # TypeScript cache
*.tsbuildinfo
\*.tsbuildinfo
# Optional npm cache directory # Optional npm cache directory
.npm .npm
# Optional eslint cache # Optional eslint cache
.eslintcache .eslintcache
# Optional stylelint cache # Optional stylelint cache
.stylelintcache .stylelintcache
# Microbundle cache # Microbundle cache
.rpt2_cache/ .rpt2_cache/
.rts2_cache_cjs/ .rts2_cache_cjs/
.rts2_cache_es/ .rts2_cache_es/
.rts2_cache_umd/ .rts2_cache_umd/
# Optional REPL history # Optional REPL history
.node_repl_history .node_repl_history
# Output of 'npm pack' # Output of 'npm pack'
*.tgz
\*.tgz
# Yarn Integrity file # Yarn Integrity file
.yarn-integrity .yarn-integrity
# dotenv environment variable files # dotenv environment variable files
.env .env
.env.development.local .env.development.local
.env.test.local .env.test.local
.env.production.local .env.production.local
.env.local .env.local
.env.* .env.\*
!.env.example !.env.example
# parcel-bundler cache (https://parceljs.org/) # parcel-bundler cache (https://parceljs.org/)
.cache .cache
.parcel-cache .parcel-cache
# Next.js build output # Next.js build output
.next .next
out out
# Nuxt.js build / generate output # Nuxt.js build / generate output
.nuxt .nuxt
dist dist
# Gatsby files # Gatsby files
.cache/ .cache/
# Comment in the public line in if your project uses Gatsby and not Next.js # Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support # https://nextjs.org/blog/next-9-1#public-directory-support
# public # public
# vuepress build output # vuepress build output
.vuepress/dist .vuepress/dist
# vuepress v2.x temp and cache directory # vuepress v2.x temp and cache directory
.temp .temp
# Docusaurus cache and generated files # Docusaurus cache and generated files
.docusaurus .docusaurus
# Serverless directories # Serverless directories
.serverless/ .serverless/
# FuseBox cache # FuseBox cache
.fusebox/ .fusebox/
# DynamoDB Local files # DynamoDB Local files
.dynamodb/ .dynamodb/
# TernJS port file # TernJS port file
.tern-port .tern-port
# Stores VSCode versions used for testing VSCode extensions # Stores VSCode versions used for testing VSCode extensions
.vscode-te .vscode-te
node_modulesst node_modulesst
# yarn v2 # yarn v2
.yarn/cache .yarn/cache
.yarn/unplugged .yarn/unplugged
.yarn/build-state.yml .yarn/build-state.yml
.yarn/install-state.gz .yarn/install-state.gz
.pnp.* .pnp.\*
### Node Patch
### Node Patch ###
# Serverless Webpack directories # Serverless Webpack directories
.webpack/ .webpack/
# Optional stylelint cache # Optional stylelint cache
# SvelteKit build / generate output # SvelteKit build / generate output
.svelte-kit .svelte-kit
### react ### ### react
.DS_*
**/*.backup.*
**/*.back.*
*.sublime* .DS\__
\*\*/_.backup._
\*\*/_.back.\*
_.sublime_
psd psd
thumb thumb
sketch sketch
### VisualStudioCode
### VisualStudioCode ### .vscode/_
.vscode/*
!.vscode/settings.json !.vscode/settings.json
!.vscode/tasks.json !.vscode/tasks.json
!.vscode/launch.json !.vscode/launch.json
!.vscode/extensions.json !.vscode/extensions.json
!.vscode/*.code-snippets !.vscode/_.code-snippets
# Local History for Visual Studio Code # Local History for Visual Studio Code
.history/ .history/
# Built Visual Studio Code Extensions # Built Visual Studio Code Extensions
*.vsix
### VisualStudioCode Patch ### \*.vsix
### VisualStudioCode Patch
# Ignore all local history of files # Ignore all local history of files
.history .history
.ionide .ionide
# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,node,react,storybookjs # End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,node,react,storybookjs
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option) # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
package-lock.json package-lock.json
storybook-static/ storybook-static/
package/ package/
# Version control # Version control
.git .git
.gitignore .gitignore
.gitattributes .gitattributes
# Dependencies # Dependencies
.pnpm-store .pnpm-store
!pnpm-lock.yaml !pnpm-lock.yaml
# Testing # Testing
coverage coverage
.nyc_output .nyc_output
# OS files # OS files
.DS_Store .DS_Store
Thumbs.db Thumbs.db
# Docker # Docker
Dockerfile Dockerfile
.dockerignore .dockerignore
docker-compose* docker-compose\*
# Documentation # Documentation
README.md README.md
CHANGELOG.md CHANGELOG.md
CHANGELOG-local.md
DOCKER_DEV_SETUP.md DOCKER_DEV_SETUP.md
docs/ docs/

View File

@@ -8,5 +8,5 @@ trim_trailing_whitespace = true
indent_size = 4 indent_size = 4
indent_style = space indent_style = space
[*.{nix,yaml,yml}] [*.nix]
indent_size = 2 indent_size = 2

View File

@@ -94,5 +94,3 @@ typings/
config config
.eslintrc.js .eslintrc.js
!.storybook !.storybook
src/lib/chrome-extension-toolkit

View File

@@ -205,7 +205,7 @@ module.exports = {
{ {
target: './src/shared', target: './src/shared',
from: './', from: './',
except: ['./src/shared', './node_modules', './src/lib/chrome-extension-toolkit'], except: ['./src/shared', './node_modules'],
message: 'You cannot import into `shared` from an external directory.', message: 'You cannot import into `shared` from an external directory.',
}, },
], ],
@@ -227,6 +227,6 @@ module.exports = {
'simple-import-sort/imports': 'error', 'simple-import-sort/imports': 'error',
'simple-import-sort/exports': 'error', 'simple-import-sort/exports': 'error',
'import-essentials/restrict-import-depth': 'error', 'import-essentials/restrict-import-depth': 'error',
// 'import-essentials/check-path-alias': 'error', 'import-essentials/check-path-alias': 'error',
}, },
}; };

View File

@@ -1,9 +1,10 @@
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
title: '[BUG] ' title: "[BUG] "
labels: '' labels: ''
assignees: '' assignees: ''
--- ---
**Pre-submission Checklist** **Pre-submission Checklist**
@@ -29,11 +30,11 @@ assignees: ''
**Expected Behavior** **Expected Behavior**
<!-- What you expected to happen --> <!-- A clear and concise description of what you expected to happen -->
**Current Behavior** **Current Behavior**
<!-- What actually happened --> <!-- A clear and concise description of what actually happened -->
**Screenshots** **Screenshots**

View File

@@ -1,9 +1,10 @@
--- ---
name: Feature Request name: Feature Request
about: Suggest an idea for this project about: Suggest an idea for this project
title: '[FEATURE] ' title: "[FEATURE] "
labels: feature labels: feature
assignees: '' assignees: ''
--- ---
**Pre-submission Checklist** **Pre-submission Checklist**
@@ -16,14 +17,18 @@ assignees: ''
- [ ] I have reviewed the documentation to confirm this feature doesn't exist - [ ] I have reviewed the documentation to confirm this feature doesn't exist
- [ ] I have completed all sections below with detailed information - [ ] I have completed all sections below with detailed information
**Your Idea** **Feature Description**
<!-- A clear and concise description of the feature you'd like to see, and how it would work --> <!-- A clear and concise description of the feature you'd like to see -->
**Proposed Solution**
<!-- A clear and concise description of what you want to happen -->
**UI/UX Considerations** **UI/UX Considerations**
<!-- If this feature involves UI changes (aka how it looks), please describe the visual aspects --> <!-- If this feature involves UI changes, please describe the visual aspects -->
**Other** **Technical Implementation Details**
<!-- Any other comments you have can go here! --> <!-- If you have specific technical suggestions, list them here -->

View File

@@ -4,6 +4,7 @@ about: Updating Build Dependencies
title: '' title: ''
labels: build, dependencies labels: build, dependencies
assignees: doprz, Razboy20 assignees: doprz, Razboy20
--- ---
- [ ] Updated Nix Flake - [ ] Updated Nix Flake

View File

@@ -15,6 +15,7 @@ updates:
major-updates: major-updates:
update-types: update-types:
- 'major' - 'major'
ignore: ignore:
- dependency-name: '@crxjs/vite-plugin' - dependency-name: '@crxjs/vite-plugin'
- dependency-name: '@unocss/vite' - dependency-name: '@unocss/vite'

View File

@@ -1,33 +1,43 @@
name: Best Practices name: Best Practices
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
lint: lint:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Setup pnpm - name: Setup pnpm
uses: pnpm/action-setup@v4 uses: pnpm/action-setup@v4
with: with:
version: 10 version: 10
- name: Install dependencies - name: Install dependencies
run: pnpm install run: pnpm install
- name: Run ESLint - name: Run ESLint
run: pnpm run lint run: pnpm run lint
format: format:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Setup pnpm - name: Setup pnpm
uses: pnpm/action-setup@v4 uses: pnpm/action-setup@v4
with: with:
version: 10 version: 10
- name: Install dependencies - name: Install dependencies
run: pnpm install run: pnpm install
- name: Run Prettier - name: Run Prettier
run: pnpm run prettier run: pnpm run prettier

View File

@@ -1,18 +1,24 @@
name: Type Check name: Type Check
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
type-check: type-check:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Setup pnpm - name: Setup pnpm
uses: pnpm/action-setup@v4 uses: pnpm/action-setup@v4
with: with:
version: 10 version: 10
- name: Install dependencies - name: Install dependencies
run: pnpm install run: pnpm install
- name: Run tests - name: Run tests
run: pnpm run check-types run: pnpm run check-types

View File

@@ -1,5 +1,7 @@
name: 'Chromatic' name: 'Chromatic'
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
chromatic: chromatic:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@@ -12,8 +14,10 @@ jobs:
uses: pnpm/action-setup@v4 uses: pnpm/action-setup@v4
with: with:
version: 10 version: 10
- name: Install dependencies - name: Install dependencies
run: pnpm install run: pnpm install
- name: Publish to Chromatic - name: Publish to Chromatic
uses: chromaui/action@latest uses: chromaui/action@latest
with: with:

View File

@@ -1,24 +1,77 @@
name: Create Release name: Release
on: on:
pull_request:
push: push:
branches: branches:
- production - main
- preview
concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs: jobs:
build: nix-check:
name: build extension & create release
runs-on: ubuntu-latest runs-on: ubuntu-latest
concurrency:
group: ${{ github.ref }}
cancel-in-progress: true
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@v5
- name: Get file permission - uses: cachix/install-nix-action@v31
run: chmod -R 777 . with:
- name: Install dependencies github_access_token: ${{ secrets.GITHUB_TOKEN }}
run: npm ci - run: nix flake check
- name: Release with semantic-release
id: semantic-release release:
run: npx --no-install semantic-release name: Release
runs-on: ubuntu-latest
needs: nix-check
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
permissions:
contents: write
pull-requests: write
steps:
- name: Checkout Repo
uses: actions/checkout@v5
with:
fetch-depth: 0
- name: Install Nix
uses: cachix/install-nix-action@v31
with:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
- name: Install Dependencies
run: nix develop .#full --command pnpm install --frozen-lockfile
- name: Create Release Pull Request or Publish
id: changesets
uses: changesets/action@v1
with:
version: nix develop .#full --command pnpm run version
publish: nix develop .#full --command pnpm run release
commit: 'feat(release): version UTRP'
title: 'feat(release): version UTRP'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SENTRY_ORG: longhorn-developers
SENTRY_PROJECT: ut-registration-plus
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
- name: Get UTRP Version and Tag
if: steps.changesets.outputs.hasChangesets == 'false'
id: version
run: |
VERSION=$(nix develop --command node -p "require('./package.json').version")
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "tag=v$VERSION" >> $GITHUB_OUTPUT
- name: Create GitHub Release with Assets
if: steps.changesets.outputs.hasChangesets == 'false'
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ steps.version.outputs.tag }}
name: Release ${{ steps.version.outputs.tag }}
files: |
package/ut-registration-plus-${{ steps.version.outputs.version }}.zip
generate_release_notes: true
draft: false
prerelease: false
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@@ -1,18 +1,24 @@
name: Tests name: Tests
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
test: test:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Setup pnpm - name: Setup pnpm
uses: pnpm/action-setup@v4 uses: pnpm/action-setup@v4
with: with:
version: 10 version: 10
- name: Install dependencies - name: Install dependencies
run: pnpm install run: pnpm install
- name: Run tests - name: Run tests
run: pnpm test run: pnpm test

View File

@@ -1,6 +1,8 @@
name: Validate PR Title name: Validate PR Title
# thank you ben limmer for this workflow: # thank you ben limmer for this workflow:
# https://github.com/blimmer/semantic-release-demo-2/blob/main/.github/workflows/lint-pr.yml # https://github.com/blimmer/semantic-release-demo-2/blob/main/.github/workflows/lint-pr.yml
on: on:
pull_request_target: pull_request_target:
types: types:
@@ -8,6 +10,7 @@ on:
- reopened - reopened
- edited - edited
- synchronize - synchronize
jobs: jobs:
main: main:
runs-on: ubuntu-latest runs-on: ubuntu-latest

7
.gitignore vendored
View File

@@ -212,9 +212,4 @@ package-lock.json
storybook-static/ storybook-static/
package/ package/
# Nix .direnv/
result
result-*
# direnv
.direnv

View File

@@ -1,37 +0,0 @@
{
"branches": [
"production",
{
"name": "preview",
"channel": "alpha",
"prerelease": "alpha"
}
],
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"preset": "conventionalcommits"
}
],
[
"@semantic-release/release-notes-generator",
{
"preset": "conventionalcommits"
}
],
[
"@semantic-release/exec",
{
"prepareCmd": "SEMANTIC_VERSION=${nextRelease.version} npm run build"
}
],
[
"@semantic-release/github",
{
"assets": "build/**/artifacts/*.*",
"failComment": false
}
]
]
}

View File

@@ -23,7 +23,6 @@ export default defineConfig({
'@shared': resolve(root, 'shared'), '@shared': resolve(root, 'shared'),
'@background': resolve(pagesDir, 'background'), '@background': resolve(pagesDir, 'background'),
'@views': resolve(root, 'views'), '@views': resolve(root, 'views'),
'@chrome-extension-toolkit': resolve(root, 'lib/chrome-extension-toolkit'),
}, },
}, },
}); });

8
.vscode/launch.json vendored
View File

@@ -6,9 +6,13 @@
"request": "launch", "request": "launch",
"name": "Run current script", "name": "Run current script",
"runtimeExecutable": "npx", "runtimeExecutable": "npx",
"runtimeArgs": ["tsx"], "runtimeArgs": [
"tsx"
],
"program": "${file}", "program": "${file}",
"skipFiles": ["<node_internals>/**"] "skipFiles": [
"<node_internals>/**"
],
} }
] ]
} }

View File

@@ -26,7 +26,7 @@
"navigation": "Routes", "navigation": "Routes",
"logging": "log", "logging": "log",
"popup": "Layout", "popup": "Layout",
"storage": "Database" "storage": "Database",
}, },
"material-icon-theme.files.associations": { "material-icon-theme.files.associations": {
"tsconfig.extension.json": "tsconfig", "tsconfig.extension.json": "tsconfig",
@@ -36,5 +36,5 @@
"[html]": { "[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode" "editor.defaultFormatter": "esbenp.prettier-vscode"
}, },
"typescript.tsdk": "node_modules/typescript/lib" "typescript.tsdk": "node_modules/typescript/lib",
} }

View File

@@ -1,19 +1,3 @@
## [2.3.0](https://github.com/Longhorn-Developers/UT-Registration-Plus/compare/v2.2.2...v2.3.0) (2026-01-07)
### Features
- add drag-and-drop import for schedules ([#661](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/661)) ([549c52a](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/549c52a39fee718f2bb07cfce33a294835a2246b)), closes [#446](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/446)
- allow bypassing the 10-schedule limit ([#675](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/675)) ([6a67a32](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/6a67a32e4f50a5bdd20aa43789f199b822483e2d))
- condense resourceLinks course schedule ([#676](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/676)) ([cee5f02](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/cee5f0284f09f39ca5ae64559d0b697646c77e74))
- LHD birthday ([#717](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/717)) ([2d18553](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/2d18553f98c5146fa18699ae20462e7dcbc9d35c))
- **nix:** add prettier-version-match check ([#713](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/713)) ([8ccf7fb](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/8ccf7fb37e769ba445f39c140ca9c1c4245cc1c1))
- **nix:** build UTRP ([#714](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/714)) ([38bb29b](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/38bb29b20b97ed3cf8fd6511df16553fed1d58bb))
### Bug Fixes
- .editorconfig syntax for nix files ([b406d4d](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/b406d4dd244a25688c2b9621cf5d441228bd8913))
- toSorted outdated chrome bug ([#694](https://github.com/Longhorn-Developers/UT-Registration-Plus/issues/694)) ([4f5d8c6](https://github.com/Longhorn-Developers/UT-Registration-Plus/commit/4f5d8c6d20e3cfeb7b62520ba1819e297d2cc60f))
## [2.2.2](https://github.com/Longhorn-Developers/UT-Registration-Plus/compare/v2.2.1...v2.2.2) (2025-10-13) ## [2.2.2](https://github.com/Longhorn-Developers/UT-Registration-Plus/compare/v2.2.1...v2.2.2) (2025-10-13)
### Features ### Features

View File

@@ -1,32 +0,0 @@
# UT Registration Plus Code of Conduct
Like the technical community as a whole, the UT Registration Plus team and community is made up of a mixture of professionals and volunteers from all over the world, working on every aspect of the mission - including mentorship, teaching, and connecting people.
Diversity is one of our huge strengths, but it can also lead to communication issues and unhappiness. To that end, we have a few ground rules that we ask people to adhere to. This code applies equally to founders, mentors and those seeking help and guidance.
This isnt an exhaustive list of things that you cant do. Rather, take it in the spirit in which its intended - a guide to make it easier to enrich all of us and the technical communities in which we participate.
This code of conduct applies to all spaces managed by the UT Registration Plus project or Longhorn Developers. This includes IRC, the mailing lists, the issue tracker, DSF events, and any other forums created by the project team which the community uses for communication. In addition, violations of this code outside these spaces may affect a person's ability to participate within them.
If you believe someone is violating the code of conduct, we ask that you report it by emailing [contact@longhorns.dev](mailto:contact@longhorns.dev). For more details please see our
- **Be friendly and patient.**
- **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, colour, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability.
- **Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that we're a world-wide community, so you might not be communicating in someone else's primary language.
- **Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. Its important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the UT Registration Plus community should be respectful when dealing with other members as well as with people outside the UT Registration Plus community.
- **Be careful in the words that you choose.** We are a community of professionals, and we conduct ourselves professionally. Be kind to others. Do not insult or put down other participants. Harassment and other exclusionary behavior aren't acceptable. This includes, but is not limited to:
- Violent threats or language directed against another person.
- Discriminatory jokes and language.
- Posting sexually explicit or violent material.
- Posting (or threatening to post) other people's personally identifying information ("doxing").
- Personal insults, especially those using racist or sexist terms.
- Unwelcome sexual attention.
- Advocating for, or encouraging, any of the above behavior.
- Repeated harassment of others. In general, if someone asks you to stop, then stop.
- **When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time and UT Registration Plus is no exception. It is important that we resolve disagreements and differing views constructively. Remember that were different. The strength of UT Registration Plus comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesnt mean that theyre wrong. Dont forget that it is human to err and blaming each other doesnt get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
Original text courtesy of the [Speak Up! project](http://web.archive.org/web/20141109123859/http://speakup.io/coc.html).
## Questions?
If you have questions, please see . If that doesn't answer your questions, feel free to [contact us](mailto:contact@longhorns.dev).

View File

@@ -205,7 +205,7 @@ Special thanks to the developers and contributors behind these amazing tools and
## Activity ## Activity
![UT-Registration-Plus Activity](https://repobeats.axiom.co/api/embed/47930fa3916ac1b475cd63a05948c449eb5ad502.svg 'UT-Registration-Plus Repobeats analytics image') ![UT-Registration-Plus Activity](https://repobeats.axiom.co/api/embed/47930fa3916ac1b475cd63a05948c449eb5ad502.svg "UT-Registration-Plus Repobeats analytics image")
## Star History ## Star History

View File

@@ -1,10 +0,0 @@
(import (
let
rev = "v1.1.0";
sha256 = "sha256:19d2z6xsvpxm184m41qrpi1bplilwipgnzv9jy17fgw421785q1m";
in
fetchTarball {
inherit sha256;
url = "https://github.com/NixOS/flake-compat/archive/${rev}.tar.gz";
}
) { src = ./.; }).defaultNix

View File

@@ -24,7 +24,7 @@ else
fi fi
# Validate the mode # Validate the mode
if [[ ! " ${SUPPORTED_MODES[*]} " =~ ${mode} ]]; then if [[ ! " ${SUPPORTED_MODES[*]} " =~ " ${mode} " ]]; then
echo "Error: Invalid mode '${mode}'" >&2 echo "Error: Invalid mode '${mode}'" >&2
usage usage
fi fi

79
flake.lock generated
View File

@@ -1,30 +1,30 @@
{ {
"nodes": { "nodes": {
"flake-parts": { "flake-utils": {
"inputs": { "inputs": {
"nixpkgs-lib": "nixpkgs-lib" "systems": "systems"
}, },
"locked": { "locked": {
"lastModified": 1767609335, "lastModified": 1731533236,
"narHash": "sha256-feveD98mQpptwrAEggBQKJTYbvwwglSbOv53uCfH9PY=", "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
"owner": "hercules-ci", "owner": "numtide",
"repo": "flake-parts", "repo": "flake-utils",
"rev": "250481aafeb741edfe23d29195671c19b36b6dca", "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
"type": "github" "type": "github"
}, },
"original": { "original": {
"owner": "hercules-ci", "owner": "numtide",
"repo": "flake-parts", "repo": "flake-utils",
"type": "github" "type": "github"
} }
}, },
"nixpkgs": { "nixpkgs": {
"locked": { "locked": {
"lastModified": 1767640445, "lastModified": 1759831965,
"narHash": "sha256-UWYqmD7JFBEDBHWYcqE6s6c77pWdcU/i+bwD6XxMb8A=", "narHash": "sha256-vgPm2xjOmKdZ0xKA6yLXPJpjOtQPHfaZDRtH+47XEBo=",
"owner": "NixOS", "owner": "NixOS",
"repo": "nixpkgs", "repo": "nixpkgs",
"rev": "9f0c42f8bc7151b8e7e5840fb3bd454ad850d8c5", "rev": "c9b6fb798541223bbb396d287d16f43520250518",
"type": "github" "type": "github"
}, },
"original": { "original": {
@@ -34,59 +34,24 @@
"type": "github" "type": "github"
} }
}, },
"nixpkgs-lib": {
"locked": {
"lastModified": 1765674936,
"narHash": "sha256-k00uTP4JNfmejrCLJOwdObYC9jHRrr/5M/a/8L2EIdo=",
"owner": "nix-community",
"repo": "nixpkgs.lib",
"rev": "2075416fcb47225d9b68ac469a5c4801a9c4dd85",
"type": "github"
},
"original": {
"owner": "nix-community",
"repo": "nixpkgs.lib",
"type": "github"
}
},
"nixpkgs_2": {
"locked": {
"lastModified": 1761236834,
"narHash": "sha256-+pthv6hrL5VLW2UqPdISGuLiUZ6SnAXdd2DdUE+fV2Q=",
"owner": "nixos",
"repo": "nixpkgs",
"rev": "d5faa84122bc0a1fd5d378492efce4e289f8eac1",
"type": "github"
},
"original": {
"owner": "nixos",
"ref": "nixpkgs-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"root": { "root": {
"inputs": { "inputs": {
"flake-parts": "flake-parts", "flake-utils": "flake-utils",
"nixpkgs": "nixpkgs", "nixpkgs": "nixpkgs"
"treefmt-nix": "treefmt-nix"
} }
}, },
"treefmt-nix": { "systems": {
"inputs": {
"nixpkgs": "nixpkgs_2"
},
"locked": { "locked": {
"lastModified": 1767468822, "lastModified": 1681028828,
"narHash": "sha256-MpffQxHxmjVKMiQd0Tg2IM/bSjjdQAM+NDcX6yxj7rE=", "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
"owner": "numtide", "owner": "nix-systems",
"repo": "treefmt-nix", "repo": "default",
"rev": "d56486eb9493ad9c4777c65932618e9c2d0468fc", "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
"type": "github" "type": "github"
}, },
"original": { "original": {
"owner": "numtide", "owner": "nix-systems",
"repo": "treefmt-nix", "repo": "default",
"type": "github" "type": "github"
} }
} }

View File

@@ -1,33 +1,43 @@
{ {
inputs = { inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
flake-parts.url = "github:hercules-ci/flake-parts"; flake-utils.url = "github:numtide/flake-utils";
treefmt-nix.url = "github:numtide/treefmt-nix";
}; };
outputs = outputs =
inputs@{ flake-parts, ... }:
flake-parts.lib.mkFlake { inherit inputs; } {
systems = inputs.nixpkgs.lib.systems.flakeExposed;
imports = [
./nix/packages.nix
./nix/devShells.nix
./nix/treefmt.nix
];
perSystem =
{ system, ... }:
{ {
_module.args.pkgs = import inputs.nixpkgs { self,
inherit system; nixpkgs,
overlays = [ flake-utils,
(final: prev: { }:
nodejs = prev.nodejs_20; # v20.19.5 flake-utils.lib.eachDefaultSystem (
}) system:
let
pkgs = (import nixpkgs { inherit system; });
commonPackages = with pkgs; [
nodejs_20 # v20.19.5
pnpm_10 # v10.18.0
]; ];
config = { };
}; additionalPackages = with pkgs; [
bun
nodePackages.conventional-changelog-cli
sentry-cli
];
in
{
formatter = pkgs.nixfmt-rfc-style;
devShells.default = pkgs.mkShell {
name = "utrp-dev";
buildInputs = commonPackages;
}; };
devShells.full = pkgs.mkShell {
name = "utrp-dev-full";
buildInputs = commonPackages ++ additionalPackages;
}; };
}
);
} }

View File

@@ -1,17 +0,0 @@
# Check release dependencies
check-deps:
./scripts/check-release-deps.sh
# Stage a new release (bump version, changelog, commit, tag)
stage-release version="minor":
./scripts/stage-release.sh {{version}}
# Publish the release (create distribution package)
publish-release:
./scripts/publish-release.sh
# Complete release workflow
release version="minor": check-deps (stage-release version) publish-release
@echo ""
@echo "Complete release workflow finished!"
@echo "Don't forget to push your changes to the remote repository."

View File

@@ -1,30 +0,0 @@
{
perSystem =
{
pkgs,
...
}:
let
commonPackages = with pkgs; [
nodejs # Defined in overlay
pnpm_10 # v10.18.2
];
additionalPackages = with pkgs; [
bun
nodePackages.conventional-changelog-cli
sentry-cli
];
in
{
devShells.default = pkgs.mkShell {
name = "utrp-dev";
packages = commonPackages;
};
devShells.full = pkgs.mkShell {
name = "utrp-dev-full";
packages = commonPackages ++ additionalPackages;
};
};
}

View File

@@ -1,51 +0,0 @@
{
stdenv,
lib,
nodejs,
pnpm_10,
git,
version ? "dev",
gitRev ? "unknown",
gitBranch ? "unknown",
buildScript ? "build",
}:
stdenv.mkDerivation (finalAttrs: {
inherit version;
pname = "ut-registration-plus";
src = ../.;
nativeBuildInputs = [
nodejs
pnpm_10.configHook
git
];
pnpmDeps = pnpm_10.fetchDeps {
inherit (finalAttrs) pname version src;
fetcherVersion = 2;
hash = "sha256-UqHymJWvlTV4glra/6DkxuCxbG5dpPkFcnvq3vuxsJ8=";
};
# Pass git info to the build
VITE_GIT_COMMIT = gitRev;
VITE_GIT_BRANCH = gitBranch;
buildPhase = ''
pnpm run ${buildScript}
'';
installPhase = ''
mkdir -p $out
cp -r dist/* $out/
'';
meta = {
description = "UT Registration Plus";
homepage = "https://github.com/Longhorn-Developers/UT-Registration-Plus";
license = lib.licenses.mit;
maintainers = lib.maintainers.doprz;
platforms = lib.platforms.unix;
};
})

View File

@@ -1,40 +0,0 @@
{ inputs, ... }:
{
perSystem =
{ pkgs, ... }:
let
packageJson = builtins.fromJSON (builtins.readFile ../package.json);
gitRev = inputs.self.shortRev or inputs.self.dirtyShortRev or "dev";
gitBranch = if inputs.self ? ref then inputs.self.ref else "unknown";
baseVersion = packageJson.version;
commonArgs = {
inherit gitRev gitBranch;
};
# Prod variant
ut-registration-plus = pkgs.callPackage ./package.nix (
commonArgs
// {
version = "${baseVersion}+git.${gitRev}";
buildScript = "build";
}
);
# Dev variant
ut-registration-plus-dev = pkgs.callPackage ./package.nix (
commonArgs
// {
version = "${baseVersion}-dev+git.${gitRev}";
buildScript = "build:dev";
}
);
in
{
packages = {
inherit ut-registration-plus ut-registration-plus-dev;
default = ut-registration-plus;
dev = ut-registration-plus-dev;
};
};
}

View File

@@ -1,63 +0,0 @@
{ inputs, ... }:
{
imports = [
inputs.treefmt-nix.flakeModule
];
perSystem =
{ pkgs, ... }:
{
treefmt = {
projectRootFile = "flake.nix";
programs.nixfmt.enable = pkgs.lib.meta.availableOn pkgs.stdenv.buildPlatform pkgs.nixfmt-rfc-style.compiler;
programs.nixfmt.package = pkgs.nixfmt-rfc-style;
# NOTE: Make sure the prettier version in package.json and the one used by treefmt are the same for consistent results
programs.prettier.enable = true;
programs.shellcheck.enable = true;
programs.yamlfmt.enable = true;
programs.dockerfmt.enable = true;
settings.formatter.prettier.excludes = [ "pnpm-lock.yaml" ];
settings.formatter.shellcheck.excludes = [ ".envrc" ];
settings.formatter.yamlfmt.excludes = [ "pnpm-lock.yaml" ];
};
checks = {
prettier-version-match =
pkgs.runCommand "check-prettier-version"
{
buildInputs = [ pkgs.jq ];
}
''
# Extract prettier version from package.json
packageJsonVersion=$(jq -r '.devDependencies.prettier // empty' ${../package.json})
if [ -z "$packageJsonVersion" ]; then
echo "Error: prettier not found in package.json devDependencies"
exit 1
fi
# Remove any semver prefix characters (^, ~, etc...)
packageJsonVersion=$(echo "$packageJsonVersion" | sed 's/^[\^~>=<]*//')
# Get prettier version from nixpkgs
nixVersion="${pkgs.nodePackages.prettier.version}"
if [ "$packageJsonVersion" != "$nixVersion" ]; then
echo ""
echo "ERROR: Prettier version mismatch!"
echo " package.json: $packageJsonVersion"
echo " nixpkgs: $nixVersion"
echo ""
echo "Please update one of the following:"
echo " - Update prettier in package.json to match nixpkgs: $nixVersion"
echo " - Override prettier in your flake to match package.json"
exit 1
fi
touch $out
'';
};
};
}

View File

@@ -1,7 +1,7 @@
{ {
"name": "ut-registration-plus", "name": "ut-registration-plus",
"displayName": "UT Registration Plus", "displayName": "UT Registration Plus",
"version": "2.3.0", "version": "2.2.2",
"description": "UT Registration Plus is a Chrome extension that allows students to easily register for classes.", "description": "UT Registration Plus is a Chrome extension that allows students to easily register for classes.",
"private": true, "private": true,
"homepage": "https://github.com/Longhorn-Developers/UT-Registration-Plus", "homepage": "https://github.com/Longhorn-Developers/UT-Registration-Plus",
@@ -13,6 +13,9 @@
"build:watch": "NODE_ENV='development' vite build --mode development -w", "build:watch": "NODE_ENV='development' vite build --mode development -w",
"zip": "pnpm build && pnpm gulp zipProdBuild", "zip": "pnpm build && pnpm gulp zipProdBuild",
"zip:to-publish": "SENTRY_ENV='production' pnpm zip", "zip:to-publish": "SENTRY_ENV='production' pnpm zip",
"changeset": "changeset",
"version": "changeset version && pnpm run generate-changelog",
"release": "pnpm run zip:to-publish && changeset tag",
"prettier": "prettier src --check", "prettier": "prettier src --check",
"prettier:fix": "prettier src --write", "prettier:fix": "prettier src --write",
"lint": "eslint src --ext ts,tsx --report-unused-disable-directives", "lint": "eslint src --ext ts,tsx --report-unused-disable-directives",
@@ -39,11 +42,9 @@
"@phosphor-icons/react": "^2.1.7", "@phosphor-icons/react": "^2.1.7",
"@sentry/react": "^8.55.0", "@sentry/react": "^8.55.0",
"@tanstack/react-query": "^5.69.0", "@tanstack/react-query": "^5.69.0",
"@tsparticles/engine": "^3.9.1",
"@tsparticles/react": "^3.0.0",
"@tsparticles/slim": "^3.9.1",
"@unocss/vite": "^0.63.6", "@unocss/vite": "^0.63.6",
"@vitejs/plugin-react": "^4.3.4", "@vitejs/plugin-react": "^4.3.4",
"chrome-extension-toolkit": "^0.0.54",
"clsx": "^2.1.1", "clsx": "^2.1.1",
"conventional-changelog": "^6.0.0", "conventional-changelog": "^6.0.0",
"date-fns": "^4.1.0", "date-fns": "^4.1.0",
@@ -64,6 +65,7 @@
"sql.js": "1.11.0" "sql.js": "1.11.0"
}, },
"devDependencies": { "devDependencies": {
"@changesets/cli": "^2.29.7",
"@chromatic-com/storybook": "^2.0.2", "@chromatic-com/storybook": "^2.0.2",
"@commitlint/cli": "^19.7.1", "@commitlint/cli": "^19.7.1",
"@commitlint/config-conventional": "^19.7.1", "@commitlint/config-conventional": "^19.7.1",
@@ -136,10 +138,9 @@
"gulp": "^5.0.0", "gulp": "^5.0.0",
"gulp-execa": "^7.0.1", "gulp-execa": "^7.0.1",
"gulp-zip": "^6.1.0", "gulp-zip": "^6.1.0",
"jsdom": "^28.0.0",
"path": "^0.12.7", "path": "^0.12.7",
"postcss": "^8.5.3", "postcss": "^8.5.3",
"prettier": "3.6.2", "prettier": "^3.5.2",
"react-dev-utils": "^12.0.1", "react-dev-utils": "^12.0.1",
"semantic-release": "^24.2.3", "semantic-release": "^24.2.3",
"storybook": "^8.6.0", "storybook": "^8.6.0",
@@ -162,10 +163,7 @@
}, },
"overrides": { "overrides": {
"es-module-lexer": "^1.5.4" "es-module-lexer": "^1.5.4"
}, }
"onlyBuiltDependencies": [
"@tsparticles/engine"
]
}, },
"volta": { "volta": {
"node": "20.19.4", "node": "20.19.4",

2226
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,78 +0,0 @@
#!/usr/bin/env nu
use std/log
# Check release dependencies
export def main [] {
print "Checking Release Dependencies"
print "=============================\n"
log info "Checking .env file..."
if not (".env" | path exists) {
error make {msg: ".env file not found"}
}
log debug " .env file found"
log info "Validating Sentry configuration..."
# Get env variables dynamically and reduce the table into a record
let env_vars = (
open .env
| lines
| where { |line| ($line | str trim) != "" and not ($line | str starts-with "#") }
| each { |line|
let parts = ($line | split column "=" key value | first)
{ name: ($parts.key | str trim), value: ($parts.value | str trim) }
}
| reduce --fold {} { |it, acc| $acc | merge { ($it.name): $it.value } }
)
let sentry_org = $env_vars | get SENTRY_ORG?
if $sentry_org != "longhorn-developers" {
error make {msg: $"SENTRY_ORG must be set to longhorn-developers in .env\nGot: ($sentry_org)"}
}
log debug $" SENTRY_ORG: ($sentry_org)"
let sentry_project = $env_vars | get SENTRY_PROJECT?
if $sentry_project != "ut-registration-plus" {
error make {msg: $"SENTRY_PROJECT must be set to ut-registration-plus in .env\nGot: ($sentry_project)"}
}
log debug $" SENTRY_PROJECT: ($sentry_project)"
let sentry_auth_token = $env_vars | get SENTRY_AUTH_TOKEN?
if ($sentry_auth_token | is-empty) {
error make {msg: "SENTRY_AUTH_TOKEN must be populated in .env"}
}
log debug " SENTRY_AUTH_TOKEN: [set]"
#Check for required commands
mut missing_deps = []
if (which pnpm | is-empty) {
$missing_deps = ($missing_deps | append "pnpm")
}
if (which npm | is-empty) {
$missing_deps = ($missing_deps | append "npm")
}
if (which conventional-changelog | is-empty) {
$missing_deps = ($missing_deps | append "conventional-changelog")
}
log info "Checking VCS"
if not (which jj | is-empty) {
log debug " Version control: jujutsu"
} else if not (which git | is-empty) {
log debug " Version control: git"
} else {
$missing_deps = ($missing_deps | append "git or jujutsu")
}
if ($missing_deps | length) > 0 {
let deps: string = $missing_deps | str join ", "
let error_msg: string = ("Missing required dependencies: " | append $deps | str join)
error make { msg: $error_msg }
}
log info "All required commands found"
log info "All dependency checks passed"
}

View File

@@ -1,82 +0,0 @@
#!/usr/bin/env bash
set -uo pipefail
# Check Release Dependencies
# Validates environment and requirements before releasing
echo "Checking Release Dependencies"
echo "=============================="
echo ""
# Check if .env file exists
echo "[1/3] Checking .env file..."
if [ ! -f .env ]; then
echo "ERROR: .env file not found"
exit 1
fi
echo " .env file found"
# Source the .env file and validate required variables
set +u
source .env
set -u
echo "[2/3] Validating Sentry configuration..."
if [ -z "${SENTRY_ORG:-}" ] || [ "$SENTRY_ORG" != "longhorn-developers" ]; then
echo "ERROR: SENTRY_ORG must be set to 'longhorn-developers' in .env"
exit 1
fi
echo " SENTRY_ORG: $SENTRY_ORG"
if [ -z "${SENTRY_PROJECT:-}" ] || [ "$SENTRY_PROJECT" != "ut-registration-plus" ]; then
echo "ERROR: SENTRY_PROJECT must be set to 'ut-registration-plus' in .env"
exit 1
fi
echo " SENTRY_PROJECT: $SENTRY_PROJECT"
if [ -z "${SENTRY_AUTH_TOKEN:-}" ]; then
echo "ERROR: SENTRY_AUTH_TOKEN must be populated in .env"
exit 1
fi
echo " SENTRY_AUTH_TOKEN: [set]"
# Check for required commands
echo "[3/3] Checking required commands..."
MISSING_DEPS=()
if ! command -v pnpm &>/dev/null; then
MISSING_DEPS+=("pnpm")
fi
if ! command -v npm &>/dev/null; then
MISSING_DEPS+=("npm")
fi
if ! command -v conventional-changelog &>/dev/null; then
MISSING_DEPS+=("conventional-changelog")
fi
# Check for version control
if command -v jj &>/dev/null; then
echo " Version control: jujutsu"
elif command -v git &>/dev/null; then
echo " Version control: git"
else
MISSING_DEPS+=("git or jujutsu")
fi
if [ ${#MISSING_DEPS[@]} -ne 0 ]; then
echo ""
echo "ERROR: Missing required dependencies:"
for dep in "${MISSING_DEPS[@]}"; do
echo " - $dep"
done
exit 1
fi
echo " All required commands found"
echo ""
echo "All dependency checks passed."

View File

@@ -30,7 +30,7 @@ interface Props {
* @returns A promise that resolves when the changelog is generated. * @returns A promise that resolves when the changelog is generated.
* @throws If there is an error generating the changelog. * @throws If there is an error generating the changelog.
*/ */
async function generateChangelog({ preset, outFile = 'CHANGELOG.md', releaseCount = 1 }: Props): Promise<void> { async function generateChangelog({ preset, outFile = 'CHANGELOG-local.md', releaseCount = 1 }: Props): Promise<void> {
try { try {
// Run the conventional-changelog command to generate changelog // Run the conventional-changelog command to generate changelog
const { stdout, stderr } = await execPromise( const { stdout, stderr } = await execPromise(

View File

@@ -1,31 +0,0 @@
#!/usr/bin/env nu
use std/log
# Publish the release (creates distribution package and displays checksum)
export def main [] {
print "Publishing Release"
print "==================\n"
log info "pnpm zip:to-publish"
let result = (pnpm zip:to-publish | complete)
if ($result.stderr | str contains -i "error") or ($result.stderr | str contains -i "failed") {
error make {msg: "Package creation failed"}
}
# Find and verify the zip file
let zip_files = (ls package/*.zip | where type == file)
if ($zip_files | is-empty) {
error make {msg: "No package found in package/ directory"}
}
# Get last modified zip file
let zip_file = ($zip_files | sort-by -r modified | first | get name)
let checksum = (open $zip_file | hash sha256)
log info "Release published successfully!"
log info "Package ready for distribution:"
log info $"($zip_file)"
log info $"SHA256: ($checksum)"
}

View File

@@ -1,54 +0,0 @@
#!/usr/bin/env bash
set -uo pipefail
# Publish Release
# Creates distribution package and displays checksum
echo "Publishing Release"
echo "=================="
echo ""
# Remove old zip files
echo "[1/2] Creating distribution package..."
rm -f package/*.zip 2>/dev/null || true
TEMP_ZIP=$(mktemp)
trap "rm -f $TEMP_ZIP" EXIT
FORCE_COLOR=1 pnpm zip:to-publish 2>&1 | tee "$TEMP_ZIP"
if grep -qi "error\|failed" "$TEMP_ZIP"; then
echo ""
echo "ERROR: Package creation failed"
exit 1
fi
# Find and verify the zip file
ZIP_FILE=$(find package/ -name "*.zip" -type f -print -quit 2>/dev/null)
if [ -z "$ZIP_FILE" ]; then
echo "ERROR: No package found in package/ directory"
exit 1
fi
# Calculate SHA256 checksum
echo ""
echo "[2/2] Calculating SHA256 checksum..."
echo " Package: $ZIP_FILE"
echo ""
if command -v shasum &>/dev/null; then
shasum -a 256 "$ZIP_FILE"
elif command -v sha256sum &>/dev/null; then
sha256sum "$ZIP_FILE"
else
echo "ERROR: Neither shasum nor sha256sum found"
exit 1
fi
echo ""
echo "Release published successfully!"
echo ""
echo "Package ready for distribution:"
echo " $ZIP_FILE"

View File

@@ -1,29 +0,0 @@
#!/usr/bin/env nu
use check-deps.nu
use stage-release.nu
use publish-release.nu
# UTRP Release workflow
export def main [
--bump: string = "minor", # bump type: major, minor, or patch
--dry-run = true, # Dry run release workflow
] {
check-deps
if $dry_run {
print "\ndry-run todo:"
print "- stage-release"
print "- publish-release"
exit 0
}
mut vcs = ""
if not (which jj | is-empty) { $vcs = "jj" } else if not (which git | is-empty) { $vcs = "git"}
stage-release $bump $vcs
publish-release
print "Release workflow completed!"
}

View File

@@ -1,53 +0,0 @@
import prompts from 'prompts';
import { simpleGit } from 'simple-git';
import { getSourceRef } from '../utils/git/getSourceRef';
import { error, info } from '../utils/log';
const git = simpleGit();
const status = await git.status();
if (status.files.length) {
console.log(error('Working directory is not clean, please commit or stash changes before releasing.'));
process.exit(1);
}
const { destinationBranch } = await prompts({
type: 'select',
name: 'destinationBranch',
message: 'What kind of release do you want to create?',
choices: ['preview', 'production'].map(releaseType => ({
title: releaseType,
value: releaseType,
})),
});
const sourceRef = await getSourceRef(destinationBranch);
const { confirm } = await prompts({
type: 'confirm',
name: 'confirm',
message: `Are you sure you want to create a ${destinationBranch} release from ${sourceRef}?`,
});
if (!confirm) {
console.log(error('Aborting release.'));
process.exit(1);
}
// we fetch the latest changes from the remote
await git.fetch();
// we checkout the source ref, pull the latest changes and then checkout the destination branch
console.info(`Checking out and updating ${sourceRef}...`);
await git.checkout(sourceRef);
await git.pull('origin', sourceRef);
console.info(`Checking out and updating ${destinationBranch}...`);
await git.checkout(destinationBranch);
await git.pull('origin', destinationBranch);
// we trigger the release github action by merging the source ref into the destination branch
console.info(`Merging ${sourceRef} into ${destinationBranch}...`);
await git.merge([sourceRef, '--ff-only']);
await git.push('origin', destinationBranch);
console.info(info(`Release to ${destinationBranch} created! Check github for status`));

View File

@@ -1,97 +0,0 @@
#!/usr/bin/env nu
use std/log
# Stage a new release (bump version, changelog, commit, and tag)
export def main [
version_type: string = "minor", # Version type: major, minor, or patch
vcs: string = "jj", # VCS: jj or git
] {
print "Staging Release"
print "===============\n"
if $version_type not-in ["major, minor", "patch"] {
error make {msg: $"version_type must be major, minor, or patch.\nGot: ($version_type)"}
}
if $vcs not-in ["jj", "git"] {
error make {msg: $"vcs must be jj or git.\nGot: ($vcs)"}
}
log info $"Using ($vcs)"
if $vcs == "git" {
# Check for uncommitted changes (git only)
let status = (git diff-index --quiet HEAD -- | complete)
if $status.exit_code != 0 {
error make {msg: "You have uncommitted changes. Please commit or stash them first."}
}
}
# Bump version in package.json without committing or tagging
log info "Bumping version in package.json..."
npm version $version_type --no-git-tag-version | complete
let new_version = (open package.json | get version)
log debug $"New version: ($new_version)"
changelog
log info "Committing changes..."
if $vcs == "jj" {
jj commit -m $"chore: release v($new_version)"
log debug "Commit created"
# Update main bookmark (jj only)
log info "Updating main bookmark..."
jj bookmark set main -r @
log debug "Bookmark 'main' updated to current commit"
} else {
git add package.json package-lock.json CHANGELOG.md
git commit -m $"chore: release v($new_version)"
}
if $vcs == "jj" {
log info "Creating annotated tag via git..."
jj git export
git tag -a $"v($new_version)" -m $"Release v($new_version)"
jj git import
log debug $"Annotated tag 'v($new_version)' created via git"
} else {
log info "Creating annotated tag..."
git tag -a $"v($new_version)" -m $"Release v($new_version)"
log debug $"Annotated tag 'v($new_version)' created"
}
log info $"Release v($new_version) staged successfully!"
print "Next steps:"
if $vcs == "jj" {
print " - Review changes: jj show @-"
print " - Push to remote: jj git push && git push --tags"
} else {
print " - Review changes: git show"
print " - Push to remote: git push && git push --tags"
}
}
def changelog [] {
log info "Generating changelog with new version..."
let changelog_exists = ("CHANGELOG.md" | path exists)
let changelog_before = if $changelog_exists {
(ls CHANGELOG.md | get modified | first)
}
let result = (pnpm generate-changelog | complete)
if ($result.stderr | str contains -i "error") or ($result.stderr | str contains -i "failed") or ($result.stderr | str contains -i "command not found") {
error make {msg: "Changelog generation failed"}
}
if not ("CHANGELOG.md" | path exists) {
error make {msg: "CHANGELOG.md was not created"}
}
let changelog_after = (ls CHANGELOG.md | get modified | first)
if $changelog_exists and ($changelog_after <= $changelog_before) {
error make {msg: "CHANGELOG.md was not updated"}
}
}

View File

@@ -1,124 +0,0 @@
#!/usr/bin/env bash
set -uo pipefail
VERSION_TYPE=${1:-minor}
# Stage Release
# Bumps version, generates changelog, and commits changes
echo "Staging Release"
echo "==============="
echo "Version type: $VERSION_TYPE"
echo ""
# Detect version control system
if command -v jj &>/dev/null; then
VCS="jj"
echo "Using jujutsu"
elif command -v git &>/dev/null; then
VCS="git"
echo "Using git"
# Check for uncommitted changes (git only)
if ! git diff-index --quiet HEAD --; then
echo "ERROR: You have uncommitted changes. Please commit or stash them first."
exit 1
fi
else
echo "ERROR: No version control system found (git or jujutsu required)"
exit 1
fi
echo ""
# Bump version in package.json WITHOUT committing or tagging
echo "[1/5] Bumping version in package.json..."
npm version $VERSION_TYPE --no-git-tag-version
# Get the new version
NEW_VERSION=$(node -p "require('./package.json').version")
echo " New version: $NEW_VERSION"
# Generate changelog
echo ""
echo "[2/5] Generating changelog with new version..."
if [ -f CHANGELOG.md ]; then
CHANGELOG_BEFORE=$(stat -c %Y CHANGELOG.md 2>/dev/null || stat -f %m CHANGELOG.md 2>/dev/null)
else
CHANGELOG_BEFORE=0
fi
TEMP_CHANGELOG=$(mktemp)
trap "rm -f $TEMP_CHANGELOG" EXIT
FORCE_COLOR=1 pnpm generate-changelog 2>&1 | tee "$TEMP_CHANGELOG"
if grep -qi "error\|failed\|command not found" "$TEMP_CHANGELOG"; then
echo ""
echo "ERROR: Changelog generation failed"
exit 1
fi
if [ -f CHANGELOG.md ]; then
CHANGELOG_AFTER=$(stat -c %Y CHANGELOG.md 2>/dev/null || stat -f %m CHANGELOG.md 2>/dev/null)
if [ "$CHANGELOG_AFTER" -le "$CHANGELOG_BEFORE" ]; then
echo ""
echo "ERROR: CHANGELOG.md was not updated"
exit 1
fi
else
echo ""
echo "ERROR: CHANGELOG.md was not created"
exit 1
fi
# Commit changes
echo ""
echo "[3/5] Committing changes..."
if [ "$VCS" = "jj" ]; then
jj commit -m "chore: release v$NEW_VERSION"
echo " Commit created"
else
git add package.json package-lock.json CHANGELOG.md
git commit -m "chore: release v$NEW_VERSION"
echo " Commit created"
fi
# Update main bookmark (jujutsu only)
if [ "$VCS" = "jj" ]; then
echo ""
echo "[4/5] Updating main bookmark..."
jj bookmark set main -r @
echo " Bookmark 'main' updated to current commit"
fi
# Create tag
echo ""
if [ "$VCS" = "jj" ]; then
echo "[5/5] Creating annotated tag via git..."
# Jujutsu doesn't support annotated tags yet, so we use git
jj git export
git tag -a "v$NEW_VERSION" -m "Release v$NEW_VERSION"
jj git import
echo " Annotated tag 'v$NEW_VERSION' created via git"
else
echo "[5/5] Creating annotated tag..."
git tag -a "v$NEW_VERSION" -m "Release v$NEW_VERSION"
echo " Annotated tag 'v$NEW_VERSION' created"
fi
echo ""
echo "Release v$NEW_VERSION staged successfully!"
echo ""
echo "Next steps:"
if [ "$VCS" = "jj" ]; then
echo " - Review changes: jj show @-"
echo " - Push to remote: jj git push && git push --tags"
else
echo " - Review changes: git show"
echo " - Push to remote: git push && git push --tags"
fi
echo " - Publish release: ./publish-release.sh"

View File

@@ -1,10 +0,0 @@
(import (
let
rev = "v1.1.0";
sha256 = "sha256:19d2z6xsvpxm184m41qrpi1bplilwipgnzv9jy17fgw421785q1m";
in
fetchTarball {
inherit sha256;
url = "https://github.com/NixOS/flake-compat/archive/${rev}.tar.gz";
}
) { src = ./.; }).shellNix

View File

@@ -1,8 +0,0 @@
# chrome-extension-toolkit
Repo: https://github.com/sghsri/chrome-extension-toolkit
Author: sghsri
License: MIT
Version: 0.0.96
This library has been inlined into UTRP due to the package being removed from npm.

View File

@@ -1,62 +0,0 @@
import React, { useState } from 'react';
const containerStyle: React.CSSProperties = {
position: 'fixed',
bottom: 0,
left: 0,
right: 0,
padding: '8px',
fontSize: '20px',
textAlign: 'center',
borderTopLeftRadius: '20px',
borderTopRightRadius: '20px',
zIndex: 999999999999,
cursor: 'pointer',
};
const closeButtonStyle: React.CSSProperties = {
position: 'absolute',
top: 0,
right: 0,
padding: '8px',
paddingRight: '20px',
fontSize: '20px',
cursor: 'pointer',
};
interface Props {
className?: string;
onClick?: () => void;
}
/**
* A component that displays a message onto a content script when the context extension is invalidated.
*/
export function ContextInvalidated(props: Props): JSX.Element | null {
const [isShowing, setIsShowing] = useState(true);
const hide = (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
e.stopPropagation();
setIsShowing(false);
};
const reload = () => {
window.location.reload();
};
return isShowing ? (
<div
style={{
...containerStyle,
}}
id='extension-context-invalidated'
className={props.className}
onClick={props.onClick ?? reload}
>
Context Extension Context invalidated. Click to reload
<div style={closeButtonStyle} onClick={hide}>
</div>
</div>
) : null;
}

View File

@@ -1,2 +0,0 @@
export * from './ContextInvalidated';
export * from './onContextInvalidated';

View File

@@ -1,14 +0,0 @@
/**
* A content script can be invalidated if a chrome extension is reloaded / updated.
* This function is used to detect when the extension's context has been invalidated, and to call a callback.
* @param callback A callback to be called when the extension's context has been invalidated
*/
export function onContextInvalidated(callback: () => void) {
const interval = setInterval(() => {
// this means the current tab's context has been invalidated
if (!chrome.runtime.id) {
clearInterval(interval);
callback();
}
}, 1 * 1000);
}

View File

@@ -1,55 +0,0 @@
/**
* An extension of HTMLDivElement that represents a shadow root for use within an Extension Content Script.
*/
interface HTMLShadowDOMElement extends HTMLDivElement {
shadowRoot: ShadowRoot & {
INJECTION_POINT: HTMLDivElement;
};
/**
* Adds a style sheet to the shadow root.
* @param path the path to the style sheet relative to the extension's root directory. uses chrome.runtime.getURL to get the absolute path.
*/
addStyle(path: string): Promise<void>;
}
/**
* In extension content scripts, often times the parent site's styles will override the styles of the extension.
* To get around this, we create a shadow DOM and isolate the extension's html and styles in the shadow DOM.
* from the parent site's styles to prevent conflicts.
* @param id the id of the shadow root.
* @param options the optional options for the shadow root.
* @param isolate whether or not to isolate the extension's document flow from the parent site's document flow.
* @returns A Div that represents the shadow root with some additional methods added to it.
*/
export function createShadowDOM(id: string, options?: ShadowRootInit, isolate = false): HTMLShadowDOMElement {
const html = document.querySelector('html');
if (!html) {
throw new Error('Could not find html element');
}
const div = document.createElement('div') as HTMLShadowDOMElement;
div.id = id;
div.style.all = 'initial';
div.attachShadow({
mode: 'open',
...(options || {}),
});
const INJECTION_POINT = document.createElement('div');
INJECTION_POINT.id = 'INJECTION_POINT';
div.shadowRoot.appendChild(INJECTION_POINT);
div.shadowRoot.INJECTION_POINT = INJECTION_POINT;
div.addStyle = async (path: string) => {
const style = await fetch(chrome.runtime.getURL(path));
const styleNode = document.createElement('style');
const parsedStyle = await style.text();
styleNode.textContent = parsedStyle;
div.shadowRoot.appendChild(styleNode);
};
html.appendChild(div);
if (isolate) document.body.style.isolation = 'isolate';
return div as HTMLShadowDOMElement;
}

View File

@@ -1 +0,0 @@
export * from './createShadowRoot';

View File

@@ -1,70 +0,0 @@
/**
* Possible contexts in which a chrome extension can run.
*/
export enum ScriptType {
CONTENT_SCRIPT = 'content_script',
BACKGROUND_SCRIPT = 'background_script',
EXTENSION_POPUP = 'extension_popup',
EXTENSION_PAGE = 'extension_page',
}
/**
* Chrome extension code can run in different contexts.
* These different contexts have different capabilities and access to certain parts of the chrome extensions API.
* For example, the chrome.tabs api is not readily available in the content scripts.
* This function is used to identify the context in which the code is running.
* @returns The context in which the code is running, or null if the code is not running in a chrome extension.
*/
export default function getScriptType(): ScriptType | null {
if (!chrome?.runtime?.id) {
// we are not in a chrome extension
return null;
}
const manifest = chrome.runtime.getManifest();
if (globalThis.window === undefined) {
return ScriptType.BACKGROUND_SCRIPT;
}
if (window.location.href.startsWith(`chrome-extension://${chrome.runtime.id}`)) {
if (manifest.action?.default_popup && window.location.href.includes(manifest.action.default_popup)) {
return ScriptType.EXTENSION_POPUP;
}
return ScriptType.EXTENSION_PAGE;
}
return ScriptType.CONTENT_SCRIPT;
}
/**
* A helper function to check if the code is running in a content script.
* @returns true if the code is running in a content script, false otherwise.
*/
export function isContentScript(): boolean {
return getScriptType() === ScriptType.CONTENT_SCRIPT;
}
/**
* A helper function to check if the code is running in the background script.
* @returns true if the code is running in the background script, false otherwise.
*/
export function isBackgroundScript(): boolean {
return getScriptType() === ScriptType.BACKGROUND_SCRIPT;
}
/**
* A helper function to check if the code is running in the extension popup.
* @returns true if the code is running in the extension popup, false otherwise.
*/
export function isExtensionPopup(): boolean {
return getScriptType() === ScriptType.EXTENSION_POPUP;
}
/**
* A helper function to check if the code is running in an extension page (popup, options, etc.).
* @returns true if the code is running in an extension page (popup, options, etc.), false otherwise.
* @param pageName The name of the page to check for. ex: 'options.html'
*/
export function isExtensionPage(pageName?: string): boolean {
const isPage = getScriptType() === ScriptType.EXTENSION_PAGE;
return isPage && pageName ? window.location.href.includes(pageName) : isPage;
}

View File

@@ -1,6 +0,0 @@
export * from './context';
export * from './dom';
export * from './getScriptType';
export * from './messaging';
export * from './storage';
export * from './types';

View File

@@ -1,127 +0,0 @@
import getScriptType, { ScriptType } from '../getScriptType';
import type { IMessageListener, Message, MessageHandler, Serializable } from '../types';
import { MessageEndpoint } from '../types';
/**
* Options for configuring a message listener.
*/
export interface MessageListenerOptions {
/**
* A callback function that will be called when an error occurs.
* Useful if you want to log errors to a service like Sentry or Bugsnag.
* @param error The error that occurred.
*/
onError?: (error: Error) => void;
/**
* A flag indicating whether verbose logging should be enabled.
*/
verbose?: boolean;
}
/**
* An object that can be used to listen for and handle messages coming from another extension context.
*/
export class MessageListener<M> implements IMessageListener<M> {
private handlers: MessageHandler<M>;
private scriptType: ScriptType;
private myEndpoint: MessageEndpoint;
private listeningFor: MessageEndpoint;
private onError?: (error: Error) => void;
private isVerbose: boolean = false;
/**
* An object that can be used to listen for and handle messages coming from another extension context.
* @param handlers the message handlers for the messages that this listener will handle. When a message is received, the corresponding message handler is called.
*/
constructor(handlers: MessageHandler<M>) {
this.handlers = handlers;
// we want to know what type of script we are running in so we can determine what endpoint we are (background or foreground)
const scriptType = getScriptType();
if (!scriptType) {
throw new Error('[crx-kit]: Unable to determine extension script type.');
}
this.scriptType = scriptType;
if (this.scriptType === ScriptType.BACKGROUND_SCRIPT) {
this.myEndpoint = MessageEndpoint.BACKGROUND;
this.listeningFor = MessageEndpoint.FOREGROUND;
} else {
this.myEndpoint = MessageEndpoint.FOREGROUND;
this.listeningFor = MessageEndpoint.BACKGROUND;
}
}
private handleMessage = (
message: Message<M>,
sender: chrome.runtime.MessageSender,
sendResponse: (response: any) => void
): boolean => {
if (message.to !== this.myEndpoint && message.from !== this.listeningFor) {
// this message is not for my current context, so ignore it
return true;
}
const messageName = message.name as string;
// @ts-expect-error
const handler = this.handlers[messageName];
if (!handler) {
// this message is for my current context, but I don't have a handler for it, so ignore it
return true;
}
try {
if (this.isVerbose) {
console.log(`[crx-kit]: message received: ${messageName}`, {
name: messageName,
data: message.data,
sender,
});
}
// this message is for my current context, and I have a handler for it, so handle it
handler({
data: message.data as Serializable<typeof message.data>,
sendResponse,
sender,
});
} catch (error) {
console.error(`[crx-kit]: Error handling message ${messageName}`, {
name: messageName,
error,
message,
sender,
});
if (this.onError) {
// @ts-expect-error
this.onError(error);
}
}
return true;
};
/**
* Listens for messages from the specified source.
* @param options - The options for the message listener.
*/
public listen(options: MessageListenerOptions = { verbose: false }) {
this.isVerbose = options.verbose ?? false;
this.onError = options.onError;
console.log(`[crx-kit]: ${this.toString()} listening for messages from ${this.listeningFor}`);
chrome.runtime.onMessage.addListener(this.handleMessage);
}
/**
* Stops listening for messages
*/
public unlisten() {
console.log(`[crx-kit]: ${this.toString()} no longer listening for messages from ${this.listeningFor}`);
chrome.runtime.onMessage.removeListener(this.handleMessage);
}
private toString() {
return `MessageListener(${this.myEndpoint})`;
}
}

View File

@@ -1,94 +0,0 @@
import type { Message, MessageData, MessageResponse } from '../types';
import { MessageEndpoint } from '../types';
/**
* An object that can be used to send messages to the background script.
*/ export type BackgroundMessenger<M> = {
[K in keyof M]: MessageData<M, K> extends undefined
? () => Promise<MessageResponse<M, K>>
: (data: MessageData<M, K>) => Promise<MessageResponse<M, K>>;
};
/**
* Where the foreground message is being sent to specifically (which tab or frame)
*/
type ForegroundMessageOptions =
| {
tabId: number;
frameId?: number;
}
| {
tabId: 'ALL' | 'ACTIVE_TAB';
};
/**
* an object that can be used to send messages to the foreground (tabs OR extension pages (popup, options, etc.))
*/
export type ForegroundMessenger<M> = {
[K in keyof M]: MessageData<M, K> extends undefined
? (options: ForegroundMessageOptions) => Promise<MessageResponse<M, K>>
: (data: MessageData<M, K>, options: ForegroundMessageOptions) => Promise<MessageResponse<M, K>>;
};
/**
* A wrapper for chrome extension messaging with a type-safe API.
* @type To which context the messages are sent.
* @returns A proxy object that can be used to send messages to the foreground (tabs or extension pages (popup, options, etc.))
*/
export function createMessenger<M>(destination: 'foreground'): ForegroundMessenger<M>;
/**
* A wrapper for chrome extension messaging with a type-safe API.
* @param type To which context the messages are sent.
* @returns A proxy object that can be used to send messages to the background script.
*/
export function createMessenger<M>(destination: 'background'): BackgroundMessenger<M>;
/**
* A wrapper for chrome extension messaging with a type-safe API.
* @param destination To which context the messages are sent.
* @returns A proxy object that can be used to send messages to the background script.
*/
export function createMessenger<M>(destination: 'background' | 'foreground') {
let to: MessageEndpoint = MessageEndpoint.BACKGROUND;
let from: MessageEndpoint = MessageEndpoint.FOREGROUND;
if (destination === 'foreground') {
to = MessageEndpoint.FOREGROUND;
from = MessageEndpoint.BACKGROUND;
}
const sender = new Proxy({} as any, {
get(target, prop) {
const name = prop as keyof M;
return async (data: MessageData<M, any>, options?: ForegroundMessageOptions) => {
const message: Message<M> = {
name,
data,
from,
to,
};
if (to === MessageEndpoint.FOREGROUND && options) {
// for messages sent to the tabs, we want to send to the tabs using chrome.tabs.sendMessage,
const { tabId } = options;
if (typeof tabId === 'number') {
return chrome.tabs.sendMessage(tabId, message, { frameId: options.frameId });
}
if (tabId === 'ACTIVE_TAB') {
const tab = (await chrome.tabs.query({ active: true, currentWindow: true }))[0];
if (tab && tab.id) {
return chrome.tabs.sendMessage(tab.id, message);
}
}
if (tabId === 'ALL') {
const tabs = (await chrome.tabs.query({})).filter(tab => tab.id !== undefined && tab.url);
return Promise.any([
...tabs.map(tab => chrome.tabs.sendMessage(tab.id!, message)),
chrome.runtime.sendMessage(message),
]);
}
}
return chrome.runtime.sendMessage(message);
};
},
});
return sender;
}

View File

@@ -1,30 +0,0 @@
import { useEffect } from 'react';
import type { Message, MessageData } from '../types';
/**
* A helper function to create a hook that can listen for messages coming through chrome.runtime.onMessage
* with e2e type safety
* @returns a hook that can be used to listen for messages from the background script.
*/
export function createUseMessage<M>() {
return function useMessage<N extends keyof M, D extends MessageData<M, N>>(
name: N,
callback: (data: D) => void
): void {
useEffect(() => {
const onMessage = (message: Message<M>) => {
if (message.name === name) {
callback(message.data);
}
return true;
};
chrome.runtime.onMessage.addListener(onMessage);
return () => {
chrome.runtime.onMessage.removeListener(onMessage);
};
}, [name, callback]);
};
}

View File

@@ -1,3 +0,0 @@
export * from './createMessenger';
export * from './createUseMessage';
export * from './MessageListener';

View File

@@ -1,15 +0,0 @@
declare global {
namespace NodeJS {
interface ProcessEnv {
NODE_ENV: 'development' | 'production' | 'test';
CI?: string;
EXTENSION_STORAGE_PASSWORD?: string;
}
}
type Environment = typeof process.env.NODE_ENV;
}
// If this file has no import/export statements (i.e. is a script)
// convert it into a module by adding an empty export statement.
export {};

View File

@@ -1,214 +0,0 @@
/* eslint-disable max-classes-per-file */
const { crypto } = globalThis;
/** the number of times the key_algo will be run on the password */
const ITERATIONS = 470_000;
/** the algorithm used to derive the password key from the password */
const KEY_ALGO = 'PBKDF2';
/** the algorithm used to derive the cipher key from the password key */
const HASH_ALGO = 'SHA-256';
/** the algorithm used to encrypt the data */
const CIPHER_MODE = 'AES-GCM';
/** the size of the cipher key */
const CIPHER_SIZE = 256;
/**
* A class that provides encryption and decryption methods for use when storing data in the Stores provided by this library.
*/
export class Security {
private encoder = new TextEncoder();
private decoder = new TextDecoder();
private cachedPasswordKey?: CryptoKey;
public static MISSING_PASSWORD_ERROR_MESSAGE =
'You must set the EXTENSION_STORAGE_PASSWORD environment variable to use encrypted storage.';
/**
* @returns the password key, either from the cache or by generating a new one from the password environment variable
*/
private async getPasswordKey(): Promise<CryptoKey> {
if (this.cachedPasswordKey) return this.cachedPasswordKey;
if (!process.env.EXTENSION_STORAGE_PASSWORD) {
throw new Error(Security.MISSING_PASSWORD_ERROR_MESSAGE);
}
const passwordBuffer = this.encoder.encode(process.env.EXTENSION_STORAGE_PASSWORD);
this.cachedPasswordKey = await crypto.subtle.importKey(
'raw',
passwordBuffer,
{ name: KEY_ALGO },
false, // Not exportable
['deriveKey']
);
return this.cachedPasswordKey;
}
/**
* Derives a cipher key from the password key and salt
* @param salt the salt to use when deriving the cipher key
* @param passKey the password key to use when deriving the cipher key
* @param KeyUsage the key usage for the cipher key (encrypt or decrypt)
* @returns the cipher key which can be used to encrypt or decrypt data
*/
private async deriveCipherKey(salt: Uint8Array, passKey: CryptoKey, KeyUsage: KeyUsage[]): Promise<CryptoKey> {
return crypto.subtle.deriveKey(
{
name: KEY_ALGO,
hash: HASH_ALGO,
salt,
iterations: ITERATIONS,
},
passKey,
{
name: CIPHER_MODE,
length: CIPHER_SIZE,
},
false,
KeyUsage
);
}
/**
* @returns a random salt buffer for use in encryption
*/
private deriveSalt(): Uint8Array {
return crypto.getRandomValues(new Uint8Array(BoxBuffer.SALT_SIZE));
}
/**
* @returns a random IV buffer for use in encryption
*/
private deriveIv(): Uint8Array {
return crypto.getRandomValues(new Uint8Array(BoxBuffer.IV_SIZE));
}
/**
* Decrypts a value that has been encrypted using the encrypt method
* @param value the encrypted value to decrypt
* @returns the decrypted value
*/
async decrypt(value: any) {
if (!value) return value;
if (!isString(value)) return value;
const passKey = await this.getPasswordKey();
// read in the string into a boxBuffer, and separate the salt, iv and encrypted data from it
const boxBuffer = BoxBuffer.fromBase64String(value);
const salt = boxBuffer.getSalt();
const iv = boxBuffer.getIv();
const encryptedData = boxBuffer.getEncryptedData();
// generate the decryption key
const decryptionKey = await this.deriveCipherKey(salt, passKey, ['decrypt']);
// decrypt the data using the decryption key
const decryptedDataBuffer = await crypto.subtle.decrypt(
{
name: CIPHER_MODE,
iv,
},
decryptionKey,
encryptedData
);
// parse the decrypted data into a JSON object and return it
return decryptedDataBuffer.byteLength === 0 ? undefined : JSON.parse(this.decoder.decode(decryptedDataBuffer));
}
/**
* Encrypts a value using the password key derived from the EXTENSION_STORAGE_PASSWORD environment variable
* @param value the value to encrypt
* @returns the encrypted value as a base64 string
*/
async encrypt(value: any): Promise<string> {
let valueString = JSON.stringify(value);
const passKey = await this.getPasswordKey();
const salt = this.deriveSalt();
const iv = this.deriveIv();
const encryptionKey = await this.deriveCipherKey(salt, passKey, ['encrypt']);
const encryptedData = new Uint8Array(
await crypto.subtle.encrypt(
{
name: CIPHER_MODE,
iv,
},
encryptionKey,
this.encoder.encode(valueString)
)
);
// create a boxBuffer to store the salt, iv and encrypted data together in a single buffer
const bufferSize = BoxBuffer.PREFIX_SIZE + encryptedData.byteLength;
const boxBuffer = new BoxBuffer(new Uint8Array(bufferSize));
boxBuffer.setSalt(salt);
boxBuffer.setIv(iv);
boxBuffer.setEncryptedData(encryptedData);
// return the boxBuffer as a base64 string (to make it easier to store)
return boxBuffer.toBase64String();
}
}
/**
* A class representation of a buffer box in memory of the form:
* [salt][iv][encrypted data]
*/
class BoxBuffer {
private buffer: Uint8Array;
static SALT_SIZE = 16;
static IV_SIZE = 32;
static get PREFIX_SIZE() {
return BoxBuffer.SALT_SIZE + BoxBuffer.IV_SIZE;
}
constructor(buffer: Uint8Array) {
this.buffer = buffer;
}
setSalt(salt: Uint8Array) {
this.buffer.set(salt, 0);
}
setIv(iv: Uint8Array) {
this.buffer.set(iv, BoxBuffer.SALT_SIZE);
}
setEncryptedData(encryptedData: Uint8Array) {
this.buffer.set(encryptedData, BoxBuffer.PREFIX_SIZE);
}
getSalt(): Uint8Array {
return this.buffer.slice(0, BoxBuffer.SALT_SIZE);
}
getIv(): Uint8Array {
return this.buffer.slice(BoxBuffer.SALT_SIZE, BoxBuffer.PREFIX_SIZE);
}
getEncryptedData(): Uint8Array {
return this.buffer.slice(BoxBuffer.PREFIX_SIZE);
}
toBase64String() {
return globalThis.btoa(String.fromCharCode.apply(null, this.buffer as any));
}
static fromBase64String(base64String: string): BoxBuffer {
const rawBuffer = Uint8Array.from(globalThis.atob(base64String), c => c.charCodeAt(0));
return new BoxBuffer(rawBuffer);
}
}
function isString(value: any): value is string {
return typeof value === 'string' || value instanceof String;
}

View File

@@ -1,447 +0,0 @@
/* eslint-disable no-await-in-loop */
import { useEffect, useState } from 'react';
import type { Serializable } from '../types';
import { Security } from './Security';
/** A utility type that forces you to declare all the values specified in the type interface for a module. */
export type StoreDefaults<T> = {
[P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>> ? T[P] : T[P] | undefined;
};
/**
* Represents a change in data within the store.
*/
export type DataChange<T> = {
key: string;
/**
* The old value of the data. This will be undefined if the data was just initialized.
*/
oldValue?: Serializable<T>;
/**
* The new value of the data.
*/
newValue: Serializable<T>;
};
/**
* A function that is called when the data in the store changes.
*/
export type OnChangedFunction<T> = (changes: DataChange<T>) => void;
/**
* A virtual wrapper around the chrome.storage API that allows you to segment and compartmentalize your data.
* The data is all stored at the top level of the storage area, so you should namespace your keys to avoid collisions.
*/
export type Store<T = {}> = {
/**
* A unique identifier for the store. This will be prepended to all keys in the store to avoid collisions.
*/
readonly storeId: string;
/**
* The options that were passed to the createStore function
*/
readonly options: StoreOptions;
/**
* The default values for the store. These were passed to the createStore function and will be used to initialize the store if the key is not already set.
*/
readonly defaults: StoreDefaults<T>;
/**
* Initializes the store by setting any keys that are not already set to their default values. This will be called automatically when you first access a getter or setter.
*/
initialize(): Promise<void>;
/**
* Gets the value of the specified key from the store.
* @param key the key to get the value of
* @returns a promise that resolves to the value of the specified key (wrapped in a Serialized type)
*/
get<K extends keyof T>(key: K): Promise<Serializable<T[K]>>;
/**
* Sets the value of the specified key in the store.
* @param key the key to set the value of
* @param value the value to set the key to
*/
set<K extends keyof T>(key: K, value: Serializable<T[K]>): Promise<void>;
/**
* Sets the store with the values in the object passed in.
* @param values an object containing the keys and values to set in the store
*/
set(values: Partial<Serializable<T>>): Promise<void>;
/**
* Removes a specific key from the store.
* @param key the key to remove from the store
*/
remove<K extends keyof T>(key: K): Promise<void>;
/**
* Returns a promise that resolves to the entire contents of the store.
*/
all(): Promise<Serializable<T>>;
/**
* Returns an array of all the keys in the store.
*/
keys(): (keyof T & string)[];
/**
* A react hook that allows you to get and set the value of the specified key in the store from a functional component.
* @param key the key to get the value of or null to get the entire store
* @returns a tuple containing the value of the specified key, and a function to set the value
*/
use<K extends keyof T | null>(
key: K
): [
K extends keyof T ? Serializable<T[K]> : Serializable<T>,
(value: K extends keyof T ? Serializable<T[K]> : Partial<Serializable<T>>) => Promise<void>,
];
/**
* A react hook that allows you to get and set the value of the specified key in the store from a functional component.
* @param key the key to get the value of or null to get the entire store
* @param defaultValue the default value to use if the key is not already set
*/
use<K extends keyof T | null>(
key: K,
defaultValue: K extends keyof T ? Serializable<T[K]> : Serializable<T>
): [
K extends keyof T ? Serializable<T[K]> : Serializable<T>,
(value: K extends keyof T ? Serializable<T[K]> : Partial<Serializable<T>>) => Promise<void>,
];
/**
* Subscribes to changes in the specified key in the store, and calls the specified function when the key changes.
* @param key the key to subscribe to
* @param callback the function to call when the key changes
*/
// @ts-expect-error
subscribe<K extends keyof T>(key: K, callback: OnChangedFunction<T[K]>): (changes, area) => void;
// @ts-expect-error
subscribe<K extends keyof T>(key: K[], callback: OnChangedFunction<T[K]>): (changes, area) => void;
/**
* Removes a subscription that was added with the subscribe function.
* @param sub the subscription function that was added
*/
// @ts-expect-error
unsubscribe(sub: (changes, area) => void): void;
};
/**
* Options that modify the behavior of the store
*/
type StoreOptions = {
/**
* Whether or not to encrypt the data before storing it, and decrypt it when retrieving it. Defaults to false.
*/
isEncrypted?: boolean;
};
const security = new Security();
/**
* A function that creates a virtual storage bucket within the chrome.storage API.
*
* @param defaults the default values for the store (these will be used to initialize the store if the key is not already set, and will be used as the type for the getters and setters)
* @param area the storage area to use. Defaults to 'local'
* @returns an object which contains getters/setters for the keys in the defaults object, as well as an initialize function and an onChanged functions
*/
function createStore<T>(
storeId: string,
defaults: StoreDefaults<T>,
area: 'sync' | 'local' | 'session' | 'managed',
options?: StoreOptions
): Store<T> {
const keys = Object.keys(defaults) as string[];
const actualKeys = keys.map(key => `${storeId}:${key}`);
let isEncrypted = options?.isEncrypted || false;
if (isEncrypted && !process.env.EXTENSION_STORAGE_PASSWORD) {
throw new Error(Security.MISSING_PASSWORD_ERROR_MESSAGE);
}
const store = {
defaults,
storeId,
options,
} as Store<T>;
let hasInitialized = false;
store.initialize = async () => {
const data = await chrome.storage[area].get(actualKeys);
const missingKeys = actualKeys.filter(key => data[key] === undefined);
if (missingKeys.length) {
const defaultsToSet = {};
for (const key of missingKeys) {
// @ts-expect-error
const value = defaults[key.replace(`${storeId}:`, '')];
// @ts-expect-error
defaultsToSet[key] = isEncrypted ? await security.encrypt(value) : value;
}
await chrome.storage[area].set(defaultsToSet);
}
hasInitialized = true;
};
store.get = async (key: any) => {
if (!hasInitialized) {
await store.initialize();
}
const actualKey = `${storeId}:${key}`;
const value = (await chrome.storage[area].get(actualKey))[actualKey];
return isEncrypted ? await security.decrypt(value) : value;
};
store.set = async (key: any, value?: any) => {
if (!hasInitialized) {
await store.initialize();
}
// Handle the case where key is an object
if (typeof key === 'object' && value === undefined) {
const entriesToRemove: string[] = [];
const entriesToSet = {};
for (const [k, v] of Object.entries(key)) {
const actualKey = `${storeId}:${k}`;
if (v === undefined) {
// Prepare to remove this key
entriesToRemove.push(actualKey);
} else {
// @ts-expect-error
entriesToSet[actualKey] = isEncrypted ? await security.encrypt(v) : v;
}
}
// Remove keys with undefined values
if (entriesToRemove.length > 0) {
await chrome.storage[area].remove(entriesToRemove);
}
// Set keys with defined values
if (Object.keys(entriesToSet).length > 0) {
await chrome.storage[area].set(entriesToSet);
}
return;
}
// now we know key is a string, so lets either set or remove it directly
const actualKey = `${storeId}:${key}`;
if (value === undefined) {
// Remove if value is explicitly undefined
return await chrome.storage[area].remove(actualKey);
}
// Set the value, applying encryption if necessary
await chrome.storage[area].set({
[actualKey]: isEncrypted ? await security.encrypt(value) : value,
});
};
store.remove = async (key: any) => {
if (!hasInitialized) {
await store.initialize();
}
const actualKey = `${storeId}:${key}`;
await chrome.storage[area].remove(actualKey);
};
store.all = async () => {
if (!hasInitialized) {
await store.initialize();
}
const fullStore = await chrome.storage[area].get(actualKeys);
if (isEncrypted) {
await Promise.all(
keys.map(async key => {
const actualKey = `${storeId}:${key}`;
fullStore[key] = await security.decrypt(fullStore[actualKey]);
})
);
}
// now we need to remove the storeId from the keys
Object.keys(fullStore).forEach(actualKey => {
const newKey = actualKey.replace(`${storeId}:`, '');
fullStore[newKey] = fullStore[actualKey];
delete fullStore[actualKey];
});
return fullStore as Serializable<T>;
};
store.keys = () => keys as (keyof T & string)[];
store.subscribe = (key: string | string[], callback) => {
// @ts-expect-error
const sub = async (changes, areaName) => {
const keys = Array.isArray(key) ? key : [key];
const actualKeys = keys.map(k => `${storeId}:${k}`);
if (areaName !== area) return;
// make sure that there are keys is in the changes object
const subKeys = Object.keys(changes).filter(k => actualKeys.includes(k));
if (!subKeys.length) return;
subKeys.forEach(async actualKey => {
const key = actualKey.replace(`${storeId}:`, '');
const [oldValue, newValue] = await Promise.all([
isEncrypted ? security.decrypt(changes[actualKey].oldValue) : changes[actualKey].oldValue,
isEncrypted ? security.decrypt(changes[actualKey].newValue) : changes[actualKey].newValue,
]);
callback({
key,
oldValue,
newValue,
});
});
};
chrome.storage.onChanged.addListener(sub);
return sub;
};
store.unsubscribe = sub => {
chrome.storage.onChanged.removeListener(sub);
};
// @ts-ignore
store.use = (key: keyof T | null, defaultValue?: key extends null ? T : T[typeof key]) => {
const initialValue: any = (() => {
// an explicit default value was passed, use it
if (arguments.length === 2) {
return defaultValue;
}
// a key was passed, but no default value was passed, use the default value from the defaults object
if (key === null) {
return defaults;
}
// no key was passed, use the default value from the defaults object
return defaults[key];
})();
const [value, setValue] = useState(initialValue);
const onChange = ({ key: k, newValue }: DataChange<T>) => {
if (key === null) {
// @ts-expect-error
setValue(prev => ({ ...prev, [k]: newValue }) as any);
} else {
setValue(newValue as any);
}
};
useEffect(() => {
if (key === null) {
store
.all()
.then(setValue)
.then(() => {
store.subscribe(store.keys(), onChange as any);
});
} else {
store
.get(key)
.then(setValue)
.then(() => {
store.subscribe(key, onChange as any);
});
}
return () => {
store.unsubscribe(onChange as any);
};
}, []);
// @ts-expect-error
const set = async newValue => {
if (key === null) {
await store.set(newValue as any);
} else {
await store.set(key, newValue as any);
}
};
return [value, set] as any;
};
return store;
}
/**
* A function that creates a virtual storage bucket within the chrome.storage.local API.
* This store will persist across browser sessions and be stored on the user's computer.
*
* @param storeId A unique key to use for this store. This will be prepended to all keys in the store to avoid collisions. ex: 'my-store' -> 'my-store:myKey'
* @param defaults the default values for the store (these will be used to initialize the store if the key is not already set, and will be used as the type for the getters and setters)
* @param computed an optional function that allows you to override the generated getters and setters with your own. Provides a reference to the store itself so you can access this store's getters and setters.
* @param area the storage area to use. Defaults to 'local'
* @returns an object which contains getters/setters for the keys in the defaults object, as well as an initialize function and an onChanged functions
*/
export function createLocalStore<T>(storeId: string, defaults: StoreDefaults<T>, options?: StoreOptions): Store<T> {
return createStore(storeId, defaults, 'local', options);
}
/**
* A function that creates a virtual storage bucket within the chrome.storage.sync API.
* This store will persist across browser sessions and be stored on the user's Google account (if they are logged in).
* This means that the data will be synced across all of the user's devices.
*
* @param storeId A unique key to use for this store. This will be prepended to all keys in the store to avoid collisions. ex: 'my-store' -> 'my-store:myKey'
* @param defaults the default values for the store (these will be used to initialize the store if the key is not already set, and will be used as the type for the getters and setters)
* @param options options that modify the behavior of the store
* @returns an object which contains getters/setters for the keys in the defaults object, as well as an initialize function and an onChanged functions
*/
export function createSyncStore<T>(storeId: string, defaults: StoreDefaults<T>, options?: StoreOptions): Store<T> {
return createStore(storeId, defaults, 'sync', options);
}
/**
* A function that creates a virtual storage bucket within the chrome.storage.managed API.
* This store will persist across browser sessions and managed by the administrator of the user's computer.
*
* @param storeId A unique key to use for this store. This will be prepended to all keys in the store to avoid collisions. ex: 'my-store' -> 'my-store:myKey'
* @param defaults the default values for the store (these will be used to initialize the store if the key is not already set, and will be used as the type for the getters and setters)
* @param options options that modify the behavior of the store
* @returns an object which contains getters/setters for the keys in the defaults object, as well as an initialize function and an onChanged functions
* @see https://developer.chrome.com/docs/extensions/reference/storage/#type-ManagedStorageArea
*
*/
export function createManagedStore<T>(storeId: string, defaults: StoreDefaults<T>, options?: StoreOptions): Store<T> {
return createStore(storeId, defaults, 'managed', options);
}
/**
* A function that creates a virtual storage bucket within the chrome.storage.session API.
* This store will NOT persist across browser sessions and will be stored in memory. This will reset when the browser is closed.
*
* @param storeId A unique key to use for this store. This will be prepended to all keys in the store to avoid collisions. ex: 'my-store' -> 'my-store:myKey'
* @param defaults the default values for the store (these will be used to initialize the store if the key is not already set, and will be used as the type for the getters and setters)
* @param options options that modify the behavior of the store
* @returns an object which contains getters/setters for the keys in the defaults object, as well as an initialize function and an onChanged functions
*/
export function createSessionStore<T>(storeId: string, defaults: StoreDefaults<T>, options?: StoreOptions): Store<T> {
return createStore(storeId, defaults, 'session', options);
}
// interface MyStore {
// name: string;
// age: number;
// isCool?: boolean;
// }
// const store = createLocalStore<MyStore>('my-store', {
// age: 0,
// isCool: false,
// name: 'John Doe',
// });

View File

@@ -1,2 +0,0 @@
export * from './createStore';
export * from './Security';

View File

@@ -1,70 +0,0 @@
import type { Serializable } from './Serialization';
/**
* MessageDefinition is a record of message names and their data types.
* The data type is the type of the first argument of the message handler.
* The return type of the message handler is the resolved type of the promise returned by the message sender.
*/
export type MessageDefinition<T extends Record<string, (data: Record<string, any> | undefined) => any>> = T;
/**
* A helper type to extract the data type of a message handler.
*/
export type MessageData<M, K extends keyof M> = Serializable<
Parameters<M[K] extends (...args: any) => any ? M[K] : never>[0]
>;
/**
* A helper type to extract the resolved type of a message handler.
*/
export type MessageResponse<M, K extends keyof M> = Serializable<
ReturnType<M[K] extends (...args: any) => any ? M[K] : never>
>;
/**
* The internal object representing a message sent between chrome extension contexts.
*/
export type Message<M> = {
name: keyof M;
data: MessageData<M, keyof M>;
from: MessageEndpoint;
to: MessageEndpoint;
};
/**
* Represents the extension context in which a message is either sent or received.
* The context is either the background script/service worker or a tab.
*/
export enum MessageEndpoint {
/** The background script or service worker. */
BACKGROUND = 'BACKGROUND',
/** A foreground or extension page (popup, options, etc) */
FOREGROUND = 'FOREGROUND',
}
/**
* An object that implements the message handlers for each of the messages in the message definition.
*/
export type MessageHandler<M> = {
[K in keyof M]: (context: {
/** The data sent with the message. */
data: MessageData<M, K>;
/** The tab or page or background service worker that sent the message. */
sender: chrome.runtime.MessageSender;
/** A function that can be used to send a response asynchronously to the sender. */
sendResponse: (response: MessageResponse<M, K>) => void;
}) => Promise<void> | void;
};
/**
* An object that can be used to handle messages coming from another extension context.
*/
export interface IMessageListener<M> {
/**
* Starts listening for messages. When a message is received, the corresponding message handler is called.
*/
listen: (handler: MessageHandler<M>) => void;
/**
* Stops listening for messages.
*/
unlisten: () => void;
}

View File

@@ -1,69 +0,0 @@
type Primitive = string | number | boolean | null | undefined;
/**
* A type that represents a serialized object. This is a recursive type that will serialize all properties of an object, except for functions which are ignored (and thus not serialized)
*/
export type Serialized<T> = {
[K in keyof T as T[K] extends Function ? never : K]: Serializable<T[K]>;
};
/**
* Represents a type that can be serialized to JSON. This could either be a primitive type, an array of serializable types, or a complex object
* Recursively serializes an object to a JSON-compatible object.
*/
export type Serializable<T> = T extends Primitive
? T
: T extends Array<infer U>
? Array<Serializable<U>>
: T extends object
? Serialized<T>
: T;
/**
* Serializes a value to a JSON-compatible object (i.e. a Serializable<T>)
* @returns A JSON-compatible object that represents the value passed in with all functions removed and all objects recursively serialized
*/
export function serialize<T>(value: T): Serializable<T> {
return JSON.parse(JSON.stringify(value)) as Serializable<T>;
}
// THIS IS FOR TESTINWG THE TYPING
// type Test2 = {
// test: string;
// openNewTab: (url: string) => void;
// url?: URL;
// };
// type Test1 = {
// openNewTab: (url: string) => void;
// count: number;
// url: URL;
// urls?: URL[];
// foo: Test2;
// bar?: Test2;
// };
// let x: Serialized<Test1>;
// // ^?
// type SerializedData = Serializable<Data>;
// let data: SerializedData = {} as any;
// data.url = undefined;
// data = {
// a: 'test',
// b: 1,
// c: true,
// d: {
// e: 'test',
// t: undefined,
// },
// urls: [],
// };
// data.d = {
// e: 'test',
// };

View File

@@ -1,47 +0,0 @@
type Primitive = string | number | boolean | null | undefined;
type Serialized<T> = {
[K in keyof T as T[K] extends Function ? never : K]: Serializable<T[K]>;
};
type Serializable<T> = T extends Primitive
? T
: T extends Array<infer U>
? Array<Serializable<U>>
: T extends object
? Serialized<T>
: T;
type Data = {
a: string;
b: number;
c: boolean;
url?: URL;
d: {
e: string;
t?: URL;
};
get: () => void;
urls: URL[];
};
type SerializedData = Serializable<Data>;
let x: SerializedData = {} as any;
x.url = undefined;
x = {
a: 'test',
b: 1,
c: true,
d: {
e: 'test',
t: undefined,
},
urls: [],
};
x.d = {
e: 'test',
};

View File

@@ -1,6 +0,0 @@
export * from './Messaging';
export * from './Serialization';
export type AddParameters<TFunction extends (...args: any) => any, TParameters extends [...args: any]> = (
...args: [...Parameters<TFunction>, ...TParameters]
) => ReturnType<TFunction>;

View File

@@ -1,48 +0,0 @@
const LOG_BACKGROUND_COLOR = '#2196F3';
const LOG_TEXT_COLOR = '#fff';
const SUCCESS_BACKGROUND_COLOR = '#4CAF50';
const SUCCESS_TEXT_COLOR = '#fff';
const ERROR_BACKGROUND_COLOR = '#F44336';
const ERROR_TEXT_COLOR = '#fff';
const WARNING_BACKGROUND_COLOR = '#FFC107';
const WARNING_TEXT_COLOR = '#fff';
/**
* Utility class for logging messages with different styles.
*/
export class Console {
static log(...args: any[]) {
console.log(
`%c ${args[0]} `,
`background: ${LOG_BACKGROUND_COLOR}; color: ${LOG_TEXT_COLOR}`,
...args.slice(1)
);
}
static success(...args: any[]) {
console.log(
`%c ${args[0]} `,
`background: ${SUCCESS_BACKGROUND_COLOR}; color: ${SUCCESS_TEXT_COLOR}`,
...args.slice(1)
);
}
static error(...args: any[]) {
console.error(
`%c ${args[0]} `,
`background: ${ERROR_BACKGROUND_COLOR}; color: ${ERROR_TEXT_COLOR}`,
...args.slice(1)
);
}
static warn(...args: any[]) {
console.warn(
`%c ${args[0]} `,
`background: ${WARNING_BACKGROUND_COLOR}; color: ${WARNING_TEXT_COLOR}`,
...args.slice(1)
);
}
}

View File

@@ -1,8 +0,0 @@
/**
* Capitalizes the first letter of a string
* @param str the string to capitalize
* @returns the capitalized string
*/
export function capitalize(str: string): string {
return str.charAt(0).toUpperCase() + str.slice(1);
}

View File

@@ -271,12 +271,12 @@ export default function Page404(): JSX.Element {
} }
function _0x5629d1() { function _0x5629d1() {
let _0x13c635 = _0xdd3699; let _0x13c635 = _0xdd3699;
(_0x5b7f43(), _0x5b7f43(),
_0x16f39e[_0x13c635(0x81)]( _0x16f39e[_0x13c635(0x81)](
_0x228047, _0x228047,
0x9c + -0x1 * 0x23ab + 0x230f * 0x1, 0x9c + -0x1 * 0x23ab + 0x230f * 0x1,
-0x1c26 + 0x7bf + -0x6cd * -0x3 -0x1c26 + 0x7bf + -0x6cd * -0x3
)); );
} }
let _0x93f360 = 0x64 * 0x49 + 0x1e1e + -0x3aa2; let _0x93f360 = 0x64 * 0x49 + 0x1e1e + -0x3aa2;
function _0x5b7f43() { function _0x5b7f43() {
@@ -373,12 +373,12 @@ export default function Page404(): JSX.Element {
(-0x2469 + 0x156a * -0x1 + 0x39e2)) + (-0x2469 + 0x156a * -0x1 + 0x39e2)) +
(-0x1 * 0x13f8 + 0x6df + -0x1 * -0xd29); (-0x1 * 0x13f8 + 0x6df + -0x1 * -0xd29);
if (_0x3e178a == 0x1 * -0x1a87 + 0x1fdd + -0x555 * 0x1) { if (_0x3e178a == 0x1 * -0x1a87 + 0x1fdd + -0x555 * 0x1) {
((_0x546fb5 = (_0x546fb5 =
(_0x227002 * (-0x10d7 + 0x1 * 0x15ad + -0x2 * 0x263)) & (_0x227002 * (-0x10d7 + 0x1 * 0x15ad + -0x2 * 0x263)) &
(-0x25ca * 0x1 + 0x8 * 0x278 + -0x1 * -0x1219)), (-0x25ca * 0x1 + 0x8 * 0x278 + -0x1 * -0x1219)),
(_0x1667c5 = (_0x1667c5 =
(_0x32116b * (0x4d3 + 0x1c09 * -0x1 + 0x3 * 0x7c2)) & (_0x32116b * (0x4d3 + 0x1c09 * -0x1 + 0x3 * 0x7c2)) &
(-0xf06 * 0x2 + -0x144f * -0x1 + -0x344 * -0x3))); (-0xf06 * 0x2 + -0x144f * -0x1 + -0x344 * -0x3));
if (_0x5b3085 < -0xa * 0xed + -0xd19 + 0x1 * 0x165b) if (_0x5b3085 < -0xa * 0xed + -0xd19 + 0x1 * 0x165b)
_0x1667c5 += -0xd48 + 0xf6c + 0xc * -0x2b; _0x1667c5 += -0xd48 + 0xf6c + 0xc * -0x2b;
} }
@@ -410,10 +410,10 @@ export default function Page404(): JSX.Element {
(-0x2709 + -0x6 * -0x312 + -0x39a * -0x6)), (-0x2709 + -0x6 * -0x312 + -0x39a * -0x6)),
(_0x267dd3 = _0x38c463)); (_0x267dd3 = _0x38c463));
} }
((_0x227002 += _0x4b089b), (_0x227002 += _0x4b089b),
(_0x2aec99 += _0x5b3085), (_0x2aec99 += _0x5b3085),
(_0x32116b += _0x1eaaad), (_0x32116b += _0x1eaaad),
(_0x38c463 += _0x57383c)); (_0x38c463 += _0x57383c);
} }
} }
let _0x5cba48 = let _0x5cba48 =
@@ -430,7 +430,7 @@ export default function Page404(): JSX.Element {
let _0xdf8389 = let _0xdf8389 =
((_0x13f1b0 & (-0x247a + -0x4 * -0x9c2 + -0x39 * 0x7)) * _0x2062a9 * _0x5c387a) / ((_0x13f1b0 & (-0x247a + -0x4 * -0x9c2 + -0x39 * 0x7)) * _0x2062a9 * _0x5c387a) /
((0x1d5 * 0xa + -0x250a + -0x31 * -0x67) * (-0x7 * 0x25f + -0xae7 + 0x1c7f * 0x1)); ((0x1d5 * 0xa + -0x250a + -0x31 * -0x67) * (-0x7 * 0x25f + -0xae7 + 0x1c7f * 0x1));
((_0x228047[_0x4626de(0x8e)][ (_0x228047[_0x4626de(0x8e)][
(_0x132623 + _0x1a573d * _0x124180) * (0x29 * -0xa9 + -0x94 * -0x2b + -0x239 * -0x1) + (_0x132623 + _0x1a573d * _0x124180) * (0x29 * -0xa9 + -0x94 * -0x2b + -0x239 * -0x1) +
(0x55d * 0x2 + 0xeed * 0x1 + -0xc7 * 0x21) (0x55d * 0x2 + 0xeed * 0x1 + -0xc7 * 0x21)
] = _0x5cba48), ] = _0x5cba48),
@@ -441,7 +441,7 @@ export default function Page404(): JSX.Element {
(_0x228047[_0x4626de(0x8e)][ (_0x228047[_0x4626de(0x8e)][
(_0x132623 + _0x1a573d * _0x124180) * (0x1e2a + -0x21df + -0x1 * -0x3b9) + (_0x132623 + _0x1a573d * _0x124180) * (0x1e2a + -0x21df + -0x1 * -0x3b9) +
(0x1e79 + 0x860 * -0x2 + 0x1 * -0xdb7) (0x1e79 + 0x860 * -0x2 + 0x1 * -0xdb7)
] = _0xdf8389)); ] = _0xdf8389);
} }
} }
} }

View File

@@ -1,7 +1,7 @@
import { MessageListener } from '@chrome-extension-toolkit';
import type { BACKGROUND_MESSAGES } from '@shared/messages'; import type { BACKGROUND_MESSAGES } from '@shared/messages';
import { UserScheduleStore } from '@shared/storage/UserScheduleStore'; import { UserScheduleStore } from '@shared/storage/UserScheduleStore';
import updateBadgeText from '@shared/util/updateBadgeText'; import updateBadgeText from '@shared/util/updateBadgeText';
import { MessageListener } from 'chrome-extension-toolkit';
import onInstall from './events/onInstall'; import onInstall from './events/onInstall';
import onServiceWorkerAlive from './events/onServiceWorkerAlive'; import onServiceWorkerAlive from './events/onServiceWorkerAlive';
@@ -9,7 +9,6 @@ import onUpdate from './events/onUpdate';
import browserActionHandler from './handler/browserActionHandler'; import browserActionHandler from './handler/browserActionHandler';
import calendarBackgroundHandler from './handler/calendarBackgroundHandler'; import calendarBackgroundHandler from './handler/calendarBackgroundHandler';
import CESHandler from './handler/CESHandler'; import CESHandler from './handler/CESHandler';
import gitHubStatsHandler from './handler/gitHubStatsHandler';
import tabManagementHandler from './handler/tabManagementHandler'; import tabManagementHandler from './handler/tabManagementHandler';
import userScheduleHandler from './handler/userScheduleHandler'; import userScheduleHandler from './handler/userScheduleHandler';
@@ -53,18 +52,17 @@ const messageListener = new MessageListener<BACKGROUND_MESSAGES>({
...userScheduleHandler, ...userScheduleHandler,
...CESHandler, ...CESHandler,
...calendarBackgroundHandler, ...calendarBackgroundHandler,
...gitHubStatsHandler,
}); });
messageListener.listen(); messageListener.listen();
UserScheduleStore.subscribe('schedules', async schedules => { UserScheduleStore.listen('schedules', async schedules => {
const index = await UserScheduleStore.get('activeIndex'); const index = await UserScheduleStore.get('activeIndex');
const numCourses = schedules.newValue[index]?.courses?.length; const numCourses = schedules.newValue[index]?.courses?.length;
updateBadgeText(numCourses || 0); updateBadgeText(numCourses || 0);
}); });
UserScheduleStore.subscribe('activeIndex', async ({ newValue }) => { UserScheduleStore.listen('activeIndex', async ({ newValue }) => {
const schedules = await UserScheduleStore.get('schedules'); const schedules = await UserScheduleStore.get('schedules');
const numCourses = schedules[newValue]?.courses?.length; const numCourses = schedules[newValue]?.courses?.length;
updateBadgeText(numCourses || 0); updateBadgeText(numCourses || 0);

View File

@@ -1,6 +1,6 @@
import openNewTab from '@background/util/openNewTab'; import openNewTab from '@background/util/openNewTab';
import type { MessageHandler } from '@chrome-extension-toolkit';
import type CESMessage from '@shared/messages/CESMessage'; import type CESMessage from '@shared/messages/CESMessage';
import type { MessageHandler } from 'chrome-extension-toolkit';
const CESFall2023Url = 'https://utexas.bluera.com/utexas/rpvl.aspx?rid=d3db767b-049f-46c5-9a67-29c21c29c580&regl=en-US'; const CESFall2023Url = 'https://utexas.bluera.com/utexas/rpvl.aspx?rid=d3db767b-049f-46c5-9a67-29c21c29c580&regl=en-US';

View File

@@ -1,5 +1,5 @@
import type { MessageHandler } from '@chrome-extension-toolkit';
import type BrowserActionMessages from '@shared/messages/BrowserActionMessages'; import type BrowserActionMessages from '@shared/messages/BrowserActionMessages';
import type { MessageHandler } from 'chrome-extension-toolkit';
const browserActionHandler: MessageHandler<BrowserActionMessages> = { const browserActionHandler: MessageHandler<BrowserActionMessages> = {
disableBrowserAction({ sender, sendResponse }) { disableBrowserAction({ sender, sendResponse }) {

View File

@@ -1,14 +1,14 @@
import type { TabWithId } from '@background/util/openNewTab'; import type { TabWithId } from '@background/util/openNewTab';
import openNewTab from '@background/util/openNewTab'; import openNewTab from '@background/util/openNewTab';
import type { MessageHandler } from '@chrome-extension-toolkit';
import { tabs } from '@shared/messages'; import { tabs } from '@shared/messages';
import type { CalendarBackgroundMessages } from '@shared/messages/CalendarMessages'; import type { CalendarBackgroundMessages } from '@shared/messages/CalendarMessages';
import { OptionsStore } from '@shared/storage/OptionsStore'; import { OptionsStore } from '@shared/storage/OptionsStore';
import { CRX_PAGES } from '@shared/types/CRXPages'; import { CRX_PAGES } from '@shared/types/CRXPages';
import type { MessageHandler } from 'chrome-extension-toolkit';
const getAllTabInfos = async () => { const getAllTabInfos = async () => {
const openTabs = (await chrome.tabs.query({})).filter((tab): tab is TabWithId => tab.id !== undefined); const openTabs = (await chrome.tabs.query({})).filter((tab): tab is TabWithId => tab.id !== undefined);
const results = await Promise.allSettled(openTabs.map(tab => tabs.getTabInfo({ tabId: tab.id }))); const results = await Promise.allSettled(openTabs.map(tab => tabs.getTabInfo(undefined, tab.id)));
type TabInfo = PromiseFulfilledResult<Awaited<ReturnType<typeof tabs.getTabInfo>>>; type TabInfo = PromiseFulfilledResult<Awaited<ReturnType<typeof tabs.getTabInfo>>>;
return results return results
@@ -34,7 +34,7 @@ const calendarBackgroundHandler: MessageHandler<CalendarBackgroundMessages> = {
await chrome.tabs.update(tabid, { active: true }); await chrome.tabs.update(tabid, { active: true });
await chrome.windows.update(openCalendarTabInfo.tab.windowId, { focused: true, drawAttention: true }); await chrome.windows.update(openCalendarTabInfo.tab.windowId, { focused: true, drawAttention: true });
if (uniqueId !== undefined) await tabs.openCoursePopup({ uniqueId }, { tabId: tabid }); if (uniqueId !== undefined) await tabs.openCoursePopup({ uniqueId }, tabid);
sendResponse(openCalendarTabInfo.tab); sendResponse(openCalendarTabInfo.tab);
} else { } else {

View File

@@ -1,31 +0,0 @@
import type { MessageHandler } from '@chrome-extension-toolkit';
import type GitHubStatsMessages from '@shared/messages/GitHubStatsMessages';
import { GitHubStatsService } from '@views/lib/getGitHubStats';
const gitHubStatsService = new GitHubStatsService();
/**
* Handler for GitHub stats related messages
*/
const gitHubStatsHandler: MessageHandler<GitHubStatsMessages> = {
async fetchGitHubStats({ data, sendResponse }) {
try {
const includeMergedPRs = data ?? false;
const stats = await gitHubStatsService.fetchGitHubStats({ includeMergedPRs });
sendResponse(stats);
} catch (error) {
console.error('Error fetching GitHub stats in background:', error);
sendResponse({
adminGitHubStats: {},
userGitHubStats: {},
contributors: [],
names: {},
dataFetched: new Date(),
lastUpdated: new Date(),
isCached: false,
});
}
},
};
export default gitHubStatsHandler;

View File

@@ -1,6 +1,6 @@
import type { MessageHandler } from '@chrome-extension-toolkit';
import openNewTab from '@pages/background/util/openNewTab'; import openNewTab from '@pages/background/util/openNewTab';
import type TabManagementMessages from '@shared/messages/TabManagementMessages'; import type TabManagementMessages from '@shared/messages/TabManagementMessages';
import type { MessageHandler } from 'chrome-extension-toolkit';
const tabManagementHandler: MessageHandler<TabManagementMessages> = { const tabManagementHandler: MessageHandler<TabManagementMessages> = {
getTabId({ sendResponse, sender }) { getTabId({ sendResponse, sender }) {

View File

@@ -1,4 +1,3 @@
import type { MessageHandler } from '@chrome-extension-toolkit';
import addCourse from '@pages/background/lib/addCourse'; import addCourse from '@pages/background/lib/addCourse';
import clearCourses from '@pages/background/lib/clearCourses'; import clearCourses from '@pages/background/lib/clearCourses';
import createSchedule from '@pages/background/lib/createSchedule'; import createSchedule from '@pages/background/lib/createSchedule';
@@ -10,6 +9,7 @@ import switchSchedule from '@pages/background/lib/switchSchedule';
import type { UserScheduleMessages } from '@shared/messages/UserScheduleMessages'; import type { UserScheduleMessages } from '@shared/messages/UserScheduleMessages';
import { Course } from '@shared/types/Course'; import { Course } from '@shared/types/Course';
import { validateLoginStatus } from '@shared/util/checkLoginStatus'; import { validateLoginStatus } from '@shared/util/checkLoginStatus';
import type { MessageHandler } from 'chrome-extension-toolkit';
const userScheduleHandler: MessageHandler<UserScheduleMessages> = { const userScheduleHandler: MessageHandler<UserScheduleMessages> = {
addCourse({ data, sendResponse }) { addCourse({ data, sendResponse }) {

View File

@@ -1,7 +1,7 @@
import type { Serialized } from '@chrome-extension-toolkit';
import { UserScheduleStore } from '@shared/storage/UserScheduleStore'; import { UserScheduleStore } from '@shared/storage/UserScheduleStore';
import type { UserSchedule } from '@shared/types/UserSchedule'; import type { UserSchedule } from '@shared/types/UserSchedule';
import { generateRandomId } from '@shared/util/random'; import { generateRandomId } from '@shared/util/random';
import type { Serialized } from 'chrome-extension-toolkit';
/** /**
* Creates a new schedule with the given name * Creates a new schedule with the given name

View File

@@ -1,6 +1,6 @@
import type { Serialized } from '@chrome-extension-toolkit';
import { Course } from '@shared/types/Course'; import { Course } from '@shared/types/Course';
import type { UserSchedule } from '@shared/types/UserSchedule'; import type { UserSchedule } from '@shared/types/UserSchedule';
import type { Serialized } from 'chrome-extension-toolkit';
import addCourse from './addCourse'; import addCourse from './addCourse';
import createSchedule from './createSchedule'; import createSchedule from './createSchedule';

View File

@@ -1,4 +1,3 @@
import { MessageListener } from '@chrome-extension-toolkit';
import type TabInfoMessages from '@shared/messages/TabInfoMessages'; import type TabInfoMessages from '@shared/messages/TabInfoMessages';
import Calendar from '@views/components/calendar/Calendar'; import Calendar from '@views/components/calendar/Calendar';
import DialogProvider from '@views/components/common/DialogProvider/DialogProvider'; import DialogProvider from '@views/components/common/DialogProvider/DialogProvider';
@@ -6,6 +5,7 @@ import ExtensionRoot from '@views/components/common/ExtensionRoot/ExtensionRoot'
import { MigrationDialog } from '@views/components/common/MigrationDialog'; import { MigrationDialog } from '@views/components/common/MigrationDialog';
import { WhatsNewDialog } from '@views/components/common/WhatsNewPopup'; import { WhatsNewDialog } from '@views/components/common/WhatsNewPopup';
import SentryProvider from '@views/contexts/SentryContext'; import SentryProvider from '@views/contexts/SentryContext';
import { MessageListener } from 'chrome-extension-toolkit';
import useKC_DABR_WASM from 'kc-dabr-wasm'; import useKC_DABR_WASM from 'kc-dabr-wasm';
import React, { useEffect } from 'react'; import React, { useEffect } from 'react';

View File

@@ -1,12 +0,0 @@
import type { GitHubStatsResult } from '@shared/types/GitHubStats';
/* eslint-disable jsdoc/require-jsdoc */
export default interface GitHubStatsMessages {
/**
* Fetch GitHub statistics for all contributors
* @param includeMergedPRs - Whether to include merged PR counts (optional, default: false)
* @returns GitHub stats including commits, lines added/deleted, and optionally merged PRs
*/
fetchGitHubStats: (includeMergedPRs?: boolean) => GitHubStatsResult;
}

View File

@@ -1,9 +1,8 @@
import { createMessenger } from '@chrome-extension-toolkit'; import { createMessenger } from 'chrome-extension-toolkit';
import type BrowserActionMessages from './BrowserActionMessages'; import type BrowserActionMessages from './BrowserActionMessages';
import type { CalendarBackgroundMessages, CalendarTabMessages } from './CalendarMessages'; import type { CalendarBackgroundMessages, CalendarTabMessages } from './CalendarMessages';
import type CESMessage from './CESMessage'; import type CESMessage from './CESMessage';
import type GitHubStatsMessages from './GitHubStatsMessages';
import type TabInfoMessages from './TabInfoMessages'; import type TabInfoMessages from './TabInfoMessages';
import type TabManagementMessages from './TabManagementMessages'; import type TabManagementMessages from './TabManagementMessages';
import type { UserScheduleMessages } from './UserScheduleMessages'; import type { UserScheduleMessages } from './UserScheduleMessages';
@@ -15,8 +14,7 @@ export type BACKGROUND_MESSAGES = BrowserActionMessages &
TabManagementMessages & TabManagementMessages &
UserScheduleMessages & UserScheduleMessages &
CESMessage & CESMessage &
CalendarBackgroundMessages & CalendarBackgroundMessages;
GitHubStatsMessages;
/** /**
* This is a type with all the message definitions that can be sent TO specific tabs * This is a type with all the message definitions that can be sent TO specific tabs

View File

@@ -1,5 +1,5 @@
import { createLocalStore } from '@chrome-extension-toolkit';
import type { CachedData } from '@shared/types/CachedData'; import type { CachedData } from '@shared/types/CachedData';
import { createLocalStore, debugStore } from 'chrome-extension-toolkit';
interface ICacheStore { interface ICacheStore {
github: Record<string, CachedData<unknown>>; github: Record<string, CachedData<unknown>>;
@@ -8,8 +8,8 @@ interface ICacheStore {
/** /**
* A store that is used for storing cached data such as GitHub contributors * A store that is used for storing cached data such as GitHub contributors
*/ */
export const CacheStore = createLocalStore<ICacheStore>('CacheStore', { export const CacheStore = createLocalStore<ICacheStore>({
github: {}, github: {},
}); });
// debugStore({ cacheStore: CacheStore }); debugStore({ cacheStore: CacheStore });

View File

@@ -1,4 +1,4 @@
import { createLocalStore } from '@chrome-extension-toolkit'; import { createLocalStore, debugStore } from 'chrome-extension-toolkit';
/** /**
* A store that is used to store data that is only relevant during development * A store that is used to store data that is only relevant during development
@@ -18,7 +18,7 @@ interface IDevStore {
reloadTabId?: number; reloadTabId?: number;
} }
export const DevStore = createLocalStore<IDevStore>('DevStore', { export const DevStore = createLocalStore<IDevStore>({
isDeveloper: false, isDeveloper: false,
debugTabId: undefined, debugTabId: undefined,
isTabReloading: true, isTabReloading: true,
@@ -27,4 +27,4 @@ export const DevStore = createLocalStore<IDevStore>('DevStore', {
reloadTabId: undefined, reloadTabId: undefined,
}); });
// debugStore({ devStore: DevStore }); debugStore({ devStore: DevStore });

View File

@@ -1,4 +1,4 @@
import { createLocalStore } from '@chrome-extension-toolkit'; import { createLocalStore, debugStore } from 'chrome-extension-toolkit';
/** /**
* A store that is used for storing user options * A store that is used for storing user options
@@ -12,10 +12,10 @@ interface IExtensionStore {
lastWhatsNewPopupVersion: number; lastWhatsNewPopupVersion: number;
} }
export const ExtensionStore = createLocalStore<IExtensionStore>('ExtensionStore', { export const ExtensionStore = createLocalStore<IExtensionStore>({
version: chrome.runtime.getManifest().version, version: chrome.runtime.getManifest().version,
lastUpdate: Date.now(), lastUpdate: Date.now(),
lastWhatsNewPopupVersion: 0, lastWhatsNewPopupVersion: 0,
}); });
// debugStore({ ExtensionStore }); debugStore({ ExtensionStore });

View File

@@ -1,4 +1,4 @@
import { createSyncStore } from '@chrome-extension-toolkit'; import { createSyncStore, debugStore } from 'chrome-extension-toolkit';
/** /**
* A store that is used for storing user options * A store that is used for storing user options
@@ -24,11 +24,9 @@ export interface IOptionsStore {
/** whether the promo should be shown */ /** whether the promo should be shown */
showUTDiningPromo: boolean; showUTDiningPromo: boolean;
/** whether users are allowed to bypass the 10 schedule limit */
allowMoreSchedules: boolean;
} }
export const OptionsStore = createSyncStore<IOptionsStore>('OptionsStore', { export const OptionsStore = createSyncStore<IOptionsStore>({
enableCourseStatusChips: false, enableCourseStatusChips: false,
enableHighlightConflicts: true, enableHighlightConflicts: true,
enableScrollToLoad: true, enableScrollToLoad: true,
@@ -36,7 +34,6 @@ export const OptionsStore = createSyncStore<IOptionsStore>('OptionsStore', {
alwaysOpenCalendarInNewTab: false, alwaysOpenCalendarInNewTab: false,
showCalendarSidebar: true, showCalendarSidebar: true,
showUTDiningPromo: true, showUTDiningPromo: true,
allowMoreSchedules: false,
}); });
/** /**
@@ -53,9 +50,8 @@ export const initSettings = async () =>
alwaysOpenCalendarInNewTab: await OptionsStore.get('alwaysOpenCalendarInNewTab'), alwaysOpenCalendarInNewTab: await OptionsStore.get('alwaysOpenCalendarInNewTab'),
showCalendarSidebar: await OptionsStore.get('showCalendarSidebar'), showCalendarSidebar: await OptionsStore.get('showCalendarSidebar'),
showUTDiningPromo: await OptionsStore.get('showUTDiningPromo'), showUTDiningPromo: await OptionsStore.get('showUTDiningPromo'),
allowMoreSchedules: await OptionsStore.get('allowMoreSchedules'),
}) satisfies IOptionsStore; }) satisfies IOptionsStore;
// Clothing retailer right // Clothing retailer right
// debugStore({ OptionsStore }); debugStore({ OptionsStore });

View File

@@ -1,5 +1,5 @@
import { createLocalStore } from '@chrome-extension-toolkit';
import { UserSchedule } from '@shared/types/UserSchedule'; import { UserSchedule } from '@shared/types/UserSchedule';
import { createLocalStore, debugStore } from 'chrome-extension-toolkit';
import { generateRandomId } from '../util/random'; import { generateRandomId } from '../util/random';
@@ -11,7 +11,7 @@ interface IUserScheduleStore {
/** /**
* A store that is used for storing user schedules (and the active schedule) * A store that is used for storing user schedules (and the active schedule)
*/ */
export const UserScheduleStore = createLocalStore<IUserScheduleStore>('UserScheduleStore', { export const UserScheduleStore = createLocalStore<IUserScheduleStore>({
schedules: [ schedules: [
new UserSchedule({ new UserSchedule({
courses: [], courses: [],
@@ -24,4 +24,4 @@ export const UserScheduleStore = createLocalStore<IUserScheduleStore>('UserSched
activeIndex: 0, activeIndex: 0,
}); });
// debugStore({ userScheduleStore: UserScheduleStore }); debugStore({ userScheduleStore: UserScheduleStore });

View File

@@ -1,5 +1,5 @@
import type { Serialized } from '@chrome-extension-toolkit';
import { getCourseColors } from '@shared/util/colors'; import { getCourseColors } from '@shared/util/colors';
import type { Serialized } from 'chrome-extension-toolkit';
import type { CourseMeeting } from './CourseMeeting'; import type { CourseMeeting } from './CourseMeeting';
import { CourseSchedule } from './CourseSchedule'; import { CourseSchedule } from './CourseSchedule';

View File

@@ -1,4 +1,4 @@
import type { Serialized } from '@chrome-extension-toolkit'; import type { Serialized } from 'chrome-extension-toolkit';
/** /**
* a map of the days of the week that a class is taught, and the corresponding abbreviation * a map of the days of the week that a class is taught, and the corresponding abbreviation

View File

@@ -1,4 +1,4 @@
import type { Serialized } from '@chrome-extension-toolkit'; import type { Serialized } from 'chrome-extension-toolkit';
import type { Day } from './CourseMeeting'; import type { Day } from './CourseMeeting';
import { CourseMeeting, DAY_MAP } from './CourseMeeting'; import { CourseMeeting, DAY_MAP } from './CourseMeeting';

View File

@@ -1,40 +0,0 @@
/* eslint-disable jsdoc/require-jsdoc */
export type TeamMember = {
name: string;
role: string[];
githubUsername: string;
};
export type GitHubStats = {
commits: number;
linesAdded: number;
linesDeleted: number;
mergedPRs?: number;
};
export type GitHubStatsResult = {
adminGitHubStats: Record<string, GitHubStats>;
userGitHubStats: Record<string, GitHubStats>;
contributors: string[];
names: Record<string, string>;
dataFetched: Date;
lastUpdated: Date;
isCached: boolean;
};
export type ContributorStats = {
total: number;
weeks: { w: number; a: number; d: number; c: number }[];
author: { login: string };
};
export type ContributorUser = {
name: string | undefined;
};
export type FetchResult<T> = {
data: T;
dataFetched: Date;
lastUpdated: Date;
isCached: boolean;
};

View File

@@ -1,5 +1,5 @@
import type { Serialized } from '@chrome-extension-toolkit';
import { capitalize } from '@shared/util/string'; import { capitalize } from '@shared/util/string';
import type { Serialized } from 'chrome-extension-toolkit';
/** /**
* A type representing an instructor for a course (who teaches it) * A type representing an instructor for a course (who teaches it)

View File

@@ -1,4 +1,4 @@
import type { Serialized } from '@chrome-extension-toolkit'; import type { Serialized } from 'chrome-extension-toolkit';
import { generateRandomId } from '../util/random'; import { generateRandomId } from '../util/random';
import { Course } from './Course'; import { Course } from './Course';

View File

@@ -1,4 +1,4 @@
import type { Serialized } from '@chrome-extension-toolkit'; import type { Serialized } from 'chrome-extension-toolkit';
import { theme } from 'unocss/preset-mini'; import { theme } from 'unocss/preset-mini';
import type { HexColor, HSL, Lab, RGB, sRGB } from '../types/Color'; import type { HexColor, HSL, Lab, RGB, sRGB } from '../types/Color';

View File

@@ -1,19 +0,0 @@
import type { Meta, StoryObj } from '@storybook/react';
import CalendarFooter from '@views/components/calendar/CalendarFooter';
import React from 'react';
const meta = {
title: 'Components/Calendar/CalendarFooter',
component: CalendarFooter,
parameters: {
layout: 'centered',
},
tags: ['autodocs'],
} satisfies Meta<typeof CalendarFooter>;
export default meta;
type Story = StoryObj<typeof meta>;
export const Default: Story = {
args: {},
};

View File

@@ -1,4 +1,3 @@
import type { Serialized } from '@chrome-extension-toolkit';
import { UserScheduleStore } from '@shared/storage/UserScheduleStore'; import { UserScheduleStore } from '@shared/storage/UserScheduleStore';
import { UserSchedule } from '@shared/types/UserSchedule'; import { UserSchedule } from '@shared/types/UserSchedule';
import { generateRandomId } from '@shared/util/random'; import { generateRandomId } from '@shared/util/random';
@@ -8,6 +7,7 @@ import ScheduleDropdown from '@views/components/common/ScheduleDropdown';
import ScheduleListItem from '@views/components/common/ScheduleListItem'; import ScheduleListItem from '@views/components/common/ScheduleListItem';
import { SortableList } from '@views/components/common/SortableList'; import { SortableList } from '@views/components/common/SortableList';
import useSchedules, { getActiveSchedule, switchSchedule } from '@views/hooks/useSchedules'; import useSchedules, { getActiveSchedule, switchSchedule } from '@views/hooks/useSchedules';
import type { Serialized } from 'chrome-extension-toolkit';
import React, { useEffect } from 'react'; import React, { useEffect } from 'react';
import { exampleSchedule } from '../injected/mocked'; import { exampleSchedule } from '../injected/mocked';

View File

@@ -37,7 +37,7 @@ export default function PopupMain(): JSX.Element {
initAllSettings(); initAllSettings();
const l1 = OptionsStore.subscribe('enableCourseStatusChips', async ({ newValue }) => { const l1 = OptionsStore.listen('enableCourseStatusChips', async ({ newValue }) => {
setEnableCourseStatusChips(newValue); setEnableCourseStatusChips(newValue);
// console.log('enableCourseStatusChips', newValue); // console.log('enableCourseStatusChips', newValue);
}); });
@@ -48,7 +48,7 @@ export default function PopupMain(): JSX.Element {
// }); // });
return () => { return () => {
OptionsStore.unsubscribe(l1); OptionsStore.removeListener(l1);
// OptionsStore.removeListener(l2); // OptionsStore.removeListener(l2);
}; };
}, []); }, []);

View File

@@ -1,4 +1,3 @@
import { MessageListener } from '@chrome-extension-toolkit';
import { Sidebar } from '@phosphor-icons/react'; import { Sidebar } from '@phosphor-icons/react';
import type { CalendarTabMessages } from '@shared/messages/CalendarMessages'; import type { CalendarTabMessages } from '@shared/messages/CalendarMessages';
import { OptionsStore } from '@shared/storage/OptionsStore'; import { OptionsStore } from '@shared/storage/OptionsStore';
@@ -17,6 +16,7 @@ import { CalendarContext } from '@views/contexts/CalendarContext';
import useCourseFromUrl from '@views/hooks/useCourseFromUrl'; import useCourseFromUrl from '@views/hooks/useCourseFromUrl';
import { useFlattenedCourseSchedule } from '@views/hooks/useFlattenedCourseSchedule'; import { useFlattenedCourseSchedule } from '@views/hooks/useFlattenedCourseSchedule';
import useWhatsNewPopUp from '@views/hooks/useWhatsNew'; import useWhatsNewPopUp from '@views/hooks/useWhatsNew';
import { MessageListener } from 'chrome-extension-toolkit';
import clsx from 'clsx'; import clsx from 'clsx';
import type { ReactNode } from 'react'; import type { ReactNode } from 'react';
import React, { useEffect, useState } from 'react'; import React, { useEffect, useState } from 'react';
@@ -114,12 +114,11 @@ export default function Calendar(): ReactNode {
<LargeLogo /> <LargeLogo />
<Button <Button
variant='minimal' variant='minimal'
size='small'
color='theme-black' color='theme-black'
onClick={() => { onClick={() => {
setShowSidebar(!showSidebar); setShowSidebar(!showSidebar);
}} }}
className='screenshot:hidden' className='h-fit screenshot:hidden !p-0'
icon={Sidebar} icon={Sidebar}
/> />
</div> </div>

View File

@@ -61,13 +61,13 @@ export default function CalendarCourseCell({
useEffect(() => { useEffect(() => {
initSettings().then(({ enableCourseStatusChips }) => setEnableCourseStatusChips(enableCourseStatusChips)); initSettings().then(({ enableCourseStatusChips }) => setEnableCourseStatusChips(enableCourseStatusChips));
const l1 = OptionsStore.subscribe('enableCourseStatusChips', async ({ newValue }) => { const l1 = OptionsStore.listen('enableCourseStatusChips', async ({ newValue }) => {
setEnableCourseStatusChips(newValue); setEnableCourseStatusChips(newValue);
// console.log('enableCourseStatusChips', newValue); // console.log('enableCourseStatusChips', newValue);
}); });
return () => { return () => {
OptionsStore.unsubscribe(l1); OptionsStore.removeListener(l1);
}; };
}, []); }, []);

View File

@@ -124,7 +124,9 @@ export default function CourseCellColorPicker({ defaultColor }: CourseCellColorP
<> <>
<Divider orientation='horizontal' size='100%' className='my-1' /> <Divider orientation='horizontal' size='100%' className='my-1' />
<div className='grid grid-cols-6 gap-1'> <div className='grid grid-cols-6 gap-1'>
{colorPatchColors.get(selectedBaseColor)?.map(shadeColor => ( {colorPatchColors
.get(selectedBaseColor)
?.map(shadeColor => (
<ColorPatch <ColorPatch
key={shadeColor} key={shadeColor}
color={shadeColor} color={shadeColor}

Some files were not shown because too many files have changed in this diff Show More