44r0n7/privacy.sexy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: 44r0n7:0.12.9
Branches Tags
44r0n7:master 44r0n7:defender 44r0n7:panel 44r0n7:macosintel 44r0n7:anims 44r0n7:buildx 44r0n7:dead-urls-1 44r0n7:nvidia-308 44r0n7:services 44r0n7:unrec 44r0n7:capability 44r0n7:moremacos 44r0n7:disableservices
44r0n7:0.13.6 44r0n7:0.13.5 44r0n7:0.13.4 44r0n7:0.13.3 44r0n7:0.13.2 44r0n7:0.13.1 44r0n7:0.13.0 44r0n7:0.12.10 44r0n7:0.12.9 44r0n7:0.12.8 44r0n7:0.12.7 44r0n7:0.12.6 44r0n7:0.12.5 44r0n7:0.12.4 44r0n7:0.12.3 44r0n7:0.12.2 44r0n7:0.12.1 44r0n7:0.12.0 44r0n7:0.11.4 44r0n7:0.11.3 44r0n7:0.11.2 44r0n7:0.11.1 44r0n7:0.11.0 44r0n7:0.10.3 44r0n7:0.10.2 44r0n7:0.10.1 44r0n7:0.10.0 44r0n7:0.9.2 44r0n7:0.9.1 44r0n7:0.9.0 44r0n7:0.8.2 44r0n7:0.8.1 44r0n7:0.8.0 44r0n7:0.7.6 44r0n7:0.7.5 44r0n7:0.7.4 44r0n7:0.7.3 44r0n7:0.7.2 44r0n7:0.7.1 44r0n7:0.7.0 44r0n7:0.6.2 44r0n7:0.6.1 44r0n7:0.6.0 44r0n7:0.5.0 44r0n7:0.4.10 44r0n7:0.4.9 44r0n7:0.4.8 44r0n7:0.4.7 44r0n7:0.4.6 44r0n7:0.4.5 44r0n7:0.4.4 44r0n7:0.4.3 44r0n7:0.4.2 44r0n7:0.4.1 44r0n7:0.4.0 44r0n7:0.3.0 44r0n7:0.2.0 44r0n7:0.1.0
...
compare: 44r0n7:anims
Branches Tags
44r0n7:master 44r0n7:defender 44r0n7:panel 44r0n7:macosintel 44r0n7:anims 44r0n7:buildx 44r0n7:dead-urls-1 44r0n7:nvidia-308 44r0n7:services 44r0n7:unrec 44r0n7:capability 44r0n7:moremacos 44r0n7:disableservices
44r0n7:0.13.6 44r0n7:0.13.5 44r0n7:0.13.4 44r0n7:0.13.3 44r0n7:0.13.2 44r0n7:0.13.1 44r0n7:0.13.0 44r0n7:0.12.10 44r0n7:0.12.9 44r0n7:0.12.8 44r0n7:0.12.7 44r0n7:0.12.6 44r0n7:0.12.5 44r0n7:0.12.4 44r0n7:0.12.3 44r0n7:0.12.2 44r0n7:0.12.1 44r0n7:0.12.0 44r0n7:0.11.4 44r0n7:0.11.3 44r0n7:0.11.2 44r0n7:0.11.1 44r0n7:0.11.0 44r0n7:0.10.3 44r0n7:0.10.2 44r0n7:0.10.1 44r0n7:0.10.0 44r0n7:0.9.2 44r0n7:0.9.1 44r0n7:0.9.0 44r0n7:0.8.2 44r0n7:0.8.1 44r0n7:0.8.0 44r0n7:0.7.6 44r0n7:0.7.5 44r0n7:0.7.4 44r0n7:0.7.3 44r0n7:0.7.2 44r0n7:0.7.1 44r0n7:0.7.0 44r0n7:0.6.2 44r0n7:0.6.1 44r0n7:0.6.0 44r0n7:0.5.0 44r0n7:0.4.10 44r0n7:0.4.9 44r0n7:0.4.8 44r0n7:0.4.7 44r0n7:0.4.6 44r0n7:0.4.5 44r0n7:0.4.4 44r0n7:0.4.3 44r0n7:0.4.2 44r0n7:0.4.1 44r0n7:0.4.0 44r0n7:0.3.0 44r0n7:0.2.0 44r0n7:0.1.0

57 Commits
0.12.9 ... anims

Author SHA1 Message Date
undergroundwires
b042b36aea Add expansion/collapse animations for cards 
Key changes:

- Add animation for card opening/collapse.

Other supporting changes:

- Remove card expansion panel to its own component for easier
  maintainability and better separation of concerns.
- Use real DOM element instead of &:before pseudo class for showing
  expansion arrow. This increases by maintainability by separating its
  code and concerns.

- TODO: When one card is expanded and others is also expanded then the
  transition sucks.
 2024-03-31 20:07:09 +02:00
undergroundwires
be7a886225 Improve URL checks to reduce false-negatives 
This commit improves the URL health checking mechanism to reduce false
negatives.

- Treat all 2XX status codes as successful, addressing issues with codes
  like `204`.
- Exclude URLs within Markdown inline code blocks.
- Send the Host header for improved handling of webpages behind proxies.
- Improve formatting and context for output messages.
- Fix the defaulting options for redirects and cookie handling.
- Add URL exclusion support for non-responsive URLs.
- Update the user agent pool to modern browsers and platforms.
- Improve CI/CD workflow to respond to modifications in the
  `test/checks/external-urls` directory, offering immediate feedback on
  potential impacts to the external URL test.
- Add support for randomizing TLS fingerprint to mimic various clients
  better, improving the effectiveness of checks. However, this is not
  fully supported by Node.js's HTTP client; see nodejs/undici#1983 for
  more details.
- Use `AbortSignal` instead of `AbortController` as more modern and
  simpler way to handle timeouts.
 2024-03-13 18:26:16 +01:00
undergroundwires
4ac1425f76 Migrate to Vite 5 and adjust configurations 
This commit updates the `vite` dependency to the latest version (5.1.X)
and makes necessary adjustments to accommodate deprecations and new
features introduced in Vite 5.1.X.

Changes include:

- Modify the import statement for SVG files to use `query: '?raw'` syntax
  due to the deprecation of the `as: raw` option.
- Update `moduleResolution` setting to `Bundler` in `tsconfig.json` to
  support the new TypeScript 5 option, aligning with Vite 5's migration
  guide for Rollup 4 compatibility without requiring file extensions on
  relative imports.

Plugin migrations for Vite 5 support:

- Bump `@modyfi/vite-plugin-yaml`, see @modyfi/vite-plugin-yaml#22.
- Bump `electron-vite`, see alex8088/electron-vite#335.
- Bump `vitejs/plugin-legacy`.
- Bump `vitejs/vite-plugin-vue`, see vitejs/vite-plugin-vue#290.
 2024-03-13 09:49:26 +01:00
undergroundwires
a721e82a4f Bump TypeScript to 5.3 with verbatimModuleSyntax 
This commit upgrades TypeScript to the latest version 5.3 and introduces
`verbatimModuleSyntax` in line with the official Vue guide
recommendatinos (vuejs/docs#2592).

By enforcing `import type` for type-only imports, this commit improves
code clarity and supports tooling optimization, ensuring imports are
only bundled when necessary for runtime.

Changes:

- Bump TypeScript to 5.3.3 across the project.
- Adjust import statements to utilize `import type` where applicable,
  promoting cleaner and more efficient code.
 2024-02-27 04:20:22 +01:00
undergroundwires
98845e6cae Improve VSCode detection in configure_vscode.py 
This commit improves the reliability of the `configure_vscode.py` script
on macOS by improving the detection mechanism for the Visual Studio Code
CLI command (`code`). It introduces a fallback mechanism to locate the
`code` executable in common installation path for macOS, addressing the
issue where the VSCode CLI might not be found in PATH variable.

Additionally, the commit refines error handling by providing clearer error
messages for unknown exceptions during the extension installation process.
This ensures that users are better informed about the nature of the error,
facilitating easier troubleshooting.
 2024-02-24 07:53:19 +01:00
undergroundwires
19645248ab Fix tooltip falling behind elements on fade out 
This commit ensures that the tooltip maintains its `z-index` during both
visibility and invisibility transitions. This prevents the tooltip from
falling behind other elements during its fade-in and fade-out
animations, providing smoother and more visually consistent user
experience.
 2024-02-23 14:00:37 +01:00
undergroundwires
255c51c8a0 ci/cd: Fix cross-platform git command compability 
By explicitly setting the shell to bash in GitHub actions workflow, this
commit fixes the failure of automated releases on Windows. Previously,
the default PowerShell environment on Windows runners led to syntax
incompatibilities, causing the release process to fail with an error
when executing git checkout commands.

This changes allows successful application publishing on Windows by
avoiding syntax issues due to PowerShell interpreting commands
differently, fixing the following error encountered:

```
Run git checkout "$(git rev-list "0.13.0"..master | tail -1)"
  git checkout "$(git rev-list "0.13.0"..master | tail -1)"
  shell: C:\Program Files\PowerShell\7\pwsh.EXE -command ". '{0}'"
fatal: empty string is not a valid pathspec. please use . instead if you meant to match all paths
Error: Process completed with exit code 1.
```
 2024-02-22 21:08:16 +01:00
undergroundwires-bot
bbf3490e9c ⬆️ bump everywhere to 0.13.0 2024-02-21 13:41:49 +00:00
undergroundwires
c7fa4b6d02 Update meta title and description 
This commit changes outdated meta description which suggested
privacy.sexy is only for Windows.

It also changes title to use `Maximize your privacy` instead of using
the word "enforce".
 2024-02-21 00:34:39 +01:00
undergroundwires
17152c84dc win: add host blocking category #26 
- Introduce new category for host blocking.
- Add new scripts to block tracking hosts Windows connects to.
- Relocate Dropbox host blocking under new category.
- Update comments in `BlockViaHostsFile` function for clarity.
 2024-02-20 12:10:46 +01:00
undergroundwires
894687c0e0 win: relocate service disabling and improve docs 
This commit improves the organization of service disabling scripts by
relocating the "Disable OS services" section. It improves documentation
and script/category titles to enhance clarity and accessibility for the
divers user base of privacy.sexy, including those with non-technical
backgrounds.

Key changes:

- Move "Disable OS services" to "Remove bloatware" to simplify
  navigation and prepare for new categories (for #26).
- Rename "Disable OS services" to "Disable non-essential services"
  for better understanding.
- Relocate "Disable NetBios for all interfaces" to "Security
  improvements" due to its relevance to security rather than bloatware.
- Improve documentation.
- Simplify script names by removing technical jargon, making them more
  more accessible.
 2024-02-19 21:12:34 +01:00
undergroundwires
fb08f03765 Add UI animations for expand/collapse actions 
This commit improves the user experience by adding smooth transitions
for expanding and collapsing tree node items and documentation sections.
The introduction of these animations makes the interface feel more
dynamic and responsive to user interactions.

Key changes:

- Implement a new `ExpandCollapseTransition` component to wrap UI
  elements requiring expand/collapse animations.
- Utiliz the `ExpandCollapseTransition` in tree view nodes and
  documentation sections to animate visibility changes.
- Refactor CSS to remove obsolete transition mixins, leveraging Vue's
  transition system for consistency and maintainability.
 2024-02-18 22:38:32 +01:00
undergroundwires
faa7a38a7d Apply global styles for visual consistency 
This commit centralizes the styling of key UI elements across the
project to ensure:

- Consistent look and feel.
- Enhanced code reusability.
- Simpified maintenance, improving development speed.

It establishes a uniform foundation that can be leveraged across
different parts of the project, even enabling the styling to be shared
across different websites (supporting issue #49).

Key changes:

- Apply the following shared styles globally:
  * Styling of code, blockquotes, superscripts, horizontal rules and
    anchors.
  * Vertical and horizontal spacing.
- Segregate base styling into dedicated SCSS files for clearer structure
  and increased maintainability.
- Remove custom styling from affected components, enabling global style
  reuse for visual uniformity, reduced redundancy, and enhanced
  semantics.

Other supporting changes:

- Rename `globals.scss` to `base.scss` for better clarity.
- Add `.editorconfig` for `.scss` files to ensure consistent whitespace
  usage.
- Remove `2` file from the project root, that was included in the source
  code by mistake.
- Remove unused font-face imports
 2024-02-17 23:09:58 +01:00
undergroundwires
d5bbc321f9 Change fonts for improved readability 
Key changes:

- Change main font to Roboto Slab for enhanced readability.
- Change code font to 'Source Code Pro' for consistent monospace code
  rendering.
- Import and set code font explicitly for uniform appearance across
  platforms.
- Update Slabo 27px (logo font) version from v6 to v14.
- Update Yesteryear (cursive font) version from v8 to v18.
- Drop support for historic browser-specific formats, retaining only
  WOFF2 for modern and TTF for legacy browsers.
- Use `font-display: swap` to improve perceived load times and minimize
  layout shifts.

Supporting changes:

- Simplify font-weight usage to 'normal' and 'bold' for consistency.
- Adjust inline code padding for better scalability and prevent
  overflow.
- Introduce `$font-main` as main font variable.
- Remove specification of main font as it's best practice to rely on the
  default font defined on `body` style.
- Specify font in code area to ensure it uses the code font consistently
  as the rest of the application.
- Remove local font search through `local` to simplify the import logic
  and prioritize consistency over performance.
- Import bold font explicitly (`font-weight: 700`) for smooth and
  consistent rendering.
- Move `font-family` definitions to `_typography.scss` to better adhere
  to the common standards and conventions.
- Refactor font variables to have `font-family-` prefix instead of
  `font-` to improve clarity and differentiation between `font-size`
  variables.
- Rename 'artistic' font to 'cursive' for preciseness and clarity.
- Use smaller font sizes to match the new main font size, as Roboto Slab
  is relatively larger.
- Add missing fallbacks for serif fonts to improve fault tolerance.
- Change padding slightly on toggle switch for revert buttons to align
  well with new main font and its sizing.
 2024-02-16 11:27:31 +01:00
undergroundwires
ebd82853dd Remove 'preview' label from Linux options 
Since the 0.12.0 release, Linux support has undergone extensive testing
and all reported issues have been addressed. This change removes the
'preview' label from all UI elements related to Linux, signifying that
Linux support is mature and fully integrated.

- The 'preview' text next to Linux in the operating system selection
  and other related UI elements has been omitted.
- Users can now select Linux without the implication of it being an
  experimental feature, encouraging trust and wider adoption.
 2024-02-15 21:28:09 +01:00
undergroundwires
6142f3a297 Extend search by including documentation content 
This commit broadens the search functionality within privacy.sexy by
including documentation text in the search scope. Users can now find
scripts and categories not only by their names but also by content in
their documentation. This improvement aims to make the discovery of
relevant scripts and information more intuitive and comprehensive.

Key changes:

- Documentation text is now searchable, enhancing the ability to
  discover scripts and categories based on content details.

Other supporting changes:

- Remove interface prefixes (`I`) from related interfaces to adhere to
  naming conventions, enhancing code readability.
- Refactor filtering to separate actual filtering logic from filter
  state management, improving the structure for easier maintenance.
- Improve test coverage to ensure relability of existing and new search
  capabilities.
- Test coverage expanded to ensure the reliability of the new search
  capabilities.
 2024-02-14 12:10:49 +01:00
undergroundwires
63366a4ec2 win, mac, linux: add privacy.sexy cleanup scripts 
Introduce scripts across Windows, macOS and Linux to allow privacy.sexy
users to erase their script usage traces, improving privacy protection.

Key changes:

- Add category to clear privacy.sexy data.
- Add scripts for deleting privacy.sexy's script execution history and
  activity logs.

Supporting changes:

- Update documentation to highlight the new capability for users to
  clear privacy.sexy-generated data.
- Add shared functions for directory cleanup for Linux and macOS.
- Add code annotations to hint unified approach across all supported
  operating systems.
 2024-02-12 13:05:01 +01:00
undergroundwires
55fa7eae71 Add 'Revert All Selection' feature #68 
This commit introduces 'Revert: None - Selected' toggle, enabling users
to revert all reversible scripts with a single action, improving user
safety and control over script effects.

This feature addresses user-reported concerns about the ease of
reverting script changes. This feature should enhance the user experience
by streamlining the revert process along with providing essential
information about script reversibility.

Key changes:

- Add buttons to revert all selected scripts or setting all selected
  scripts to non-revert state.
- Add tooltips with detailed explanations about consequences of
  modifying revert states, includinginformation about irreversible
  script changes.

Supporting changes:

- Align items on top menu vertically for better visual consistency.
- Rename `SelectionType` to `RecommendationStatusType` for more clarity.
- Rename `IReverter` to `Reverter` to move away from `I` prefix
  convention.
- The `.script` CSS class was duplicated in `TheScriptsView.vue` and
  `TheScriptsArea.vue`, leading to style collisions in the development
  environment. The class has been renamed to component-specific classes
  to avoid such issues in the future.
 2024-02-11 22:47:34 +01:00
undergroundwires
a54e16488c Change slogan and refactor project info naming 
The project's slagon has been updated back to "Privacy is sexy" from
"Now you have the choice" for enhanced brand clarity and memorability.

This change also reflects the community's preference and aligns with the
project's established identity.

This commit also refactors naming and structure of project information
(metadata) struct to enhance clarity and maintainability in relation to
changing the slogan.

Key changes include:

- Update UI components to display the revised slogan.
- Remove period from project slogan in code area for consistency with a
  explanatory comment for future maintainability.
- Refactor header container and class names for clarity.
- Standardize project metadata usage in `TheCodeArea.vue` to ensure
  consistency.
- Improve code clarity by renaming `IProjectInformation` to
  `ProjectDetails` and `ProjectInformation` to `GitHubProjectDetails`.
- Organize `ProjectDetails` under a dedicated `Project` directory within
  the domain layer for better structure.

These changes are expected to improve the project's appeal and
streamline future maintenance and development efforts.
 2024-02-10 18:50:56 +01:00
undergroundwires
b9c89b701f Render bracket references as superscript text 
This commit improves markdown rendering to convert reference labels
(e.g., `[1]`) to superscripts, improving document readability without
cluttering the text. This improvement applies documentation of all
scripts and categories.

Changes:

- Implement superscript conversion for reference labels within markdown
  content, ensuring a cleaner presentation of textual references.
- Enable HTML content within markdown, necessary for inserting `<sup>`
  elements due to limitations in `markdown-it`, see
  markdown-it/markdown-it#999 for details.
- Refactor markdown rendering process for improved testability and
  adherence to the Single Responsibility Principle.
- Create `_typography.scss` with font size definitions, facilitating
  better control over text presentation.
- Adjust external URL indicator icon sizing for consistency, aligning
  images with the top of the text to maintain a uniform appearence.
- Use normal font-size explicitly for documentation text to ensure
  consistency.
- Remove text size specification in `markdown-styles` mixin, using `1em`
  for spacing to simplify styling.
- Rename font sizing variables for clarity, distinguishing between
  absolute and relative units.
- Change `font-size-relative-smaller` to be `80%`, browser default for
  `font-size: smaller;` CSS style and use it with `<sup>` elements.
- Improve the logic for converting plain URLs to hyperlinks, removing
  trailing whitespace for cleaner link generation.
- Fix plain URL to hyperlink (autolinking) logic removing trailing
  whitespace from the original markdown content. This was revealed by
  tests after separating its logic.
- Increase test coverage with more tests.
- Add types for `markdown-it` through `@types/markdown-it` package for
  better editor support and maintainability.
- Simplify implementation of adding custom anchor attributes in
  `markdown-it` using latest documentation.
 2024-02-09 16:25:05 +01:00
undergroundwires
311fcb1813 Improve UI code styling for all platforms 
This commit standardizes the visual styling of inline code and code
blocks, ensuring consistency across macOS, Android, Linux and Windows
platforms.

The discrepancies observed in font rendering on macOS, which caused the
inline code font to appear larger, have been addressed. This behavior
was only observed on macOS using different browsers such as Firefox,
Safari, Chromium-based browsers including Electron.

Key changes:

- Standardize font size relative to the parent element.
- Remove font-weight for uniformity, especially when the specific weight
  is not included with the application.
- Add a consistent background color to inline codes, aligning their look
  with code blocks.
- Refactor code styling into a separate SCSS file for improved
  modularity and maintainability.
- Update the documentation to reflect these visual design choices for
  privacy.sexy's UI.

These changes enhance the overall user experience by providing a
consistent look and feel for code elements within the UI, regardless of
the user's platform or browser.
 2024-02-06 12:35:51 +01:00
undergroundwires
aa4205ff7a Remove playful emojis (🍑🍆) 
Improve title, documentation and metadata readability by removing
emojis.

Rationale:

- Visual clutter.
- Inconsistent look across different browsers
- Informal tone.
 2024-02-02 15:38:17 +01:00
undergroundwires
937f4593d1 Change 'revert' button to title case 
- Switch 'revert' button text to title case for consistency and more
  formal and professional look.
- Update related styles to reflect the new case usage.
- Adjust tests to match the new button label casing.
- Remove reduntant visibility switch between to elements to simpify the
  DOM and style rules.
 2024-02-01 17:20:11 +01:00
undergroundwires
4da306b9f7 Normalize and improve font sizes 
This commit standardizes font sizes across components for a uniform
look. The icon sizes, font weights and line heights are also adjusted
accordingly for better standardization and simplicity.

- Introduce variables for standard font sizes, enhancing
  maintainability.
- Remove explicit pixel values, replaced with scalable units based on
  root size.
- Remove workaround for line-height adoptation of bigger font-size.
- Use consistent small font-size for the code area.
- Adjust checkbox tick to scale with font size.
 2024-01-31 19:54:11 +01:00
undergroundwires
a5ffed4cd6 Add markdown support for script/category names 
Add markdown rendering for script and category titles to improve the
presentation of textual content.

- Introduce reusable `MarkdownText` for markdown rendering.
- Incorporate markdown styling into dedicated SCSS file for clarity.
- Define explicit font sizes for consistent visual experience.
- Apply `MarkdownText` usage across UI for unified markdown rendering.
- Streamline related styles and layout for improved maintainability
- Set font sizes explicitly for better consistency and to avoid
  unexpected inheritence.

This enhancement enables richer text formatting and improves the user
interface's flexibility in displaying content.
 2024-01-30 16:36:55 +01:00
undergroundwires
6ab6dacd1b Limit tooltip width for improved readability 
Tooltip content now has a maximum width set to accommodate an optimal
character count per line, enhancing readability and interface
cleanliness.

This limit is grounded in typographic research suggesting that 50-75
characters per line is ideal for text readability, with tooltips being
targeted to the lower end of this spectrum to maintain brevity and
clarity.
 2024-01-29 15:46:54 +01:00
undergroundwires
d277139dd5 Expand script names to take full available width 
This commit improves consistency in the UI by ensuring that all nodes in
the tree component expand to take full available width. This approach
eliminates layout shifts that were previously observed when toggling
documentation.
 2024-01-28 09:08:37 +01:00
undergroundwires
7af8daa341 Improve selection type documentation 
- Refine tooltip documentation with clearer information.
- Introduce privacy ranking indicator for intuitive user guidance.
- Adopt a consistent format throughout documentation.
- Switch from emojis to icons to maintain visual uniformity.
 2024-01-26 15:40:20 +01:00
undergroundwires
d67100ad5e Update screenshot to v0.12.10 2024-01-25 12:51:51 +01:00
undergroundwires
10829d65aa win: add Dropbox telemetry blocking #125, #118 2024-01-24 19:07:55 +01:00
undergroundwires
cd425502ae win: add disabling Windows Copilot #263, #266 
This commit implements scripts to disable Windows Copilot (Copilot in
Windows), addressing issues #263 and #266.

Changes include:

- Add category and scripts to disable Windows copilot.
- Incorporate a restart explorer suggestion across all taskbar
  modification scripts to ensure consistency in user experience.
 2024-01-22 09:57:12 +01:00
undergroundwires
541f9aa5ee win: improve search privacy scripts #117 
- Add disabling bing search suggestions, resolving #117.
- Fix revert codes to align with default OS configurations.
- Implement message for recommended explorer.exe restart.
- Simplify script names for ease of understanding.
- Provide detailed documentation for each script change.
- Correct `BingSearchEnabled` registry path from HKLM to HKCU.
- Improve categorization of search privacy scripts.
 2024-01-21 16:33:04 +01:00
undergroundwires
c6ebba85fb win: add disabling clipboard features #251, #247 
This commit adds scripts to secure clipboard by disabling clipboard
synchronization and history. These changes aim to prevent sensitive data
like passwords and credit card details from being inadvertently stored
or shared via the cloud.
 2024-01-19 17:16:16 +01:00
undergroundwires-bot
f94a1ffe11 ⬆️ bump everywhere to 0.12.10 2024-01-18 11:23:59 +00:00
undergroundwires
6ada8d425c Improve script error dialogs #304 
- Include the script's directory path #304.
- Exclude Windows-specific instructions on non-Windows OS.
- Standardize language across dialogs for consistency.

Other supporting changes:

- Add script diagnostics data collection from main process.
- Document script file storage and execution tamper protection in
  SECURITY.md.
- Remove redundant comment in `NodeReadbackFileWriter`.
- Centralize error display for uniformity and simplicity.
- Simpify `WindowVariablesValidator` to omit checks when not on the
  renderer process.
- Improve and centralize Electron environment detection.
- Use more emphatic language (don't worry) in error messages.
 2024-01-17 23:59:05 +01:00
undergroundwires
f03fc24098 Add AD detection on desktop app #264, #304 
This commit addresses issues #264 and #304, where users were not
receiving error messages when script execution failed due to
antivirus intervention, particularly with Microsoft Defender.
Now, desktop app users will see a detailed error message with
guidance on next steps if script saving or execution fails due
to antivirus removal.

Key changes:

- Implement a check to detect failure in file writing,
  including reading the written file back. This method effectively
  detects antivirus interventions, as the read operation triggers
  an antivirus scan, leading to file deletion by the antivirus.
- Introduce a specific error message for scenarios where an
  antivirus intervention is detected.
 2024-01-16 22:26:28 +01:00
undergroundwires
756c736e21 Add Windows save instructions UI and fix URL #296 
- Add Windows instruction dialog when saving scripts for Windows.
- Fix incorrect macOS download URL given for Linux instructions.
- Refactor UI rendering, eleminating the use of `v-html` and JavaScript
  variables to hold HTML code.
 2024-01-15 22:38:39 +01:00
undergroundwires
e09db0f1bd Show save/execution error dialogs on desktop #264 
This commit introduces system-native error dialogs on desktop
application for code save or execution failures, addressing user confusion
described in issue #264.

This commit adds informative feedback when script execution or saving
fails.

Changes:

- Implement support for system-native error dialogs.
- Refactor `CodeRunner` and `Dialog` interfaces and their
  implementations to improve error handling and provide better type
  safety.
- Introduce structured error handling, allowing UI to display detailed
  error messages.
- Replace error throwing with an error object interface for controlled
  handling. This ensures that errors are propagated to the renderer
  process without being limited by Electron's error object
  serialization limitations as detailed in electron/electron#24427.
- Add logging for dialog actions to aid in troubleshooting.
- Rename `fileName` to `defaultFilename` in `saveFile` functions
  to clarify its purpose.
- Centralize message assertion in `LoggerStub` for consistency.
- Introduce `expectTrue` in tests for clearer boolean assertions.
- Standardize `filename` usage across the codebase.
- Enhance existing test names and organization for clarity.
- Update related documentation.
 2024-01-14 22:35:53 +01:00
undergroundwires
c546a33eff Show native save dialogs in desktop app #50, #264 
This commit introduces native operating system file dialogs in the
desktop application replacing the existing web-based dialogs.

It lays the foundation for future enhancements such as:

- Providing error messages when saving or executing files, addressing
  #264.
- Creating system restore points, addressing #50.

Documentation updates:

- Update `desktop-vs-web-features.md` with added functionality.
- Update `README.md` with security feature highlights.
- Update home page documentation to emphasize security features.

Other supporting changes include:

- Integrate IPC communication channels for secure Electron dialog API
  interactions.
- Refactor `IpcRegistration` for more type-safety and simplicity.
- Introduce a Vue hook to encapsulate dialog functionality.
- Improve errors during IPC registration for easier troubleshooting.
- Move `ClientLoggerFactory` for consistency in hooks organization and
  remove `LoggerFactory` interface for simplicity.
- Add tests for the save file dialog in the browser context.
- Add `Blob` polyfill in tests to compensate for the missing
  `blob.text()` function in `jsdom` (see jsdom/jsdom#2555).

Improve environment detection logic:

- Treat test environment as browser environments to correctly activate
  features based on the environment. This resolves issues where the
  environment is misidentified as desktop, but Electron preloader APIs
  are missing.
- Rename `isDesktop` environment identification variable to
  `isRunningAsDesktopApplication` for better clarity and to avoid
  confusion with desktop environments in web/browser/test environments.
- Simplify `BrowserRuntimeEnvironment` to consistently detect
  non-desktop application environments.
- Improve environment detection for Electron main process
  (electron/electron#2288).
 2024-01-13 18:04:23 +01:00
undergroundwires
da4be500da win: add missing extension apps, improve docs #279 
This commit adds missing extension apps seen since Windows 11 22H2 and
improves documentation scripts and category of extension app removal.

Addition of new extension apps found since Windows 11 22H2:

- HEVC Video Extensions (`Microsoft.HEVCVideoExtension`)
- Raw Image Extension (`Microsoft.RawImageExtension`)

Documentation improvements:

- Fix links that are not correctly archived.
- Add cautionary notes for all extension app removal scripts.
- Add security implications associated with these extensions.
 2024-01-10 21:59:55 +01:00
undergroundwires
b404a91ada Fix invisible script execution on Windows #264 
This commit addresses an issue in the privacy.sexy desktop application
where scripts executed as administrator on Windows were running in the
background. This was observed in environments like Windows Pro VMs on
Azure, where operations typically run with administrative privileges.

Previously, the application used the `"$path"` shell command to execute
scripts. This mechanism failed to activate the logic for requesting
admin privileges if the app itself was running as an administrator.
To resolve this, the script execution process has been modified to
explicitly ask for administrator privileges using the `VerbAs` method.
This ensures that the script always runs in a new `cmd.exe` window,
enhancing visibility and user interaction.

Other supporting changes:

- Rename the generated script file from `run-{timestamp}-{extension}` er
  to `{timestamp}-privacy-script-{extension}` for clearer identification
  and better file sorting.
- Refactor `ScriptFileCreator` to parameterize file extension and
  script name.
- Rename `OsTimestampedFilenameGenerator` to
  `TimestampedFilenameGenerator` to better reflect its new and more
  scoped functionality after refactoring mentioned abvoe.
- Remove `setAppName()` due to ineffective behavior in Windows.
- Update `SECURITY.md` to highlight that the app doesn't require admin
  rights for standard operations.
- Add `.editorconfig` settings for PowerShell scripts.
- Add a integration test for script execution logic. Improve environment
  detection for more reliable test execution.
- Disable application logging during unit/integration tests to keep test
  outputs clean and focused.
 2024-01-09 20:44:06 +01:00
undergroundwires
728584240c Fix touch, cursor and accessibility in slider 
This commit improves the horizontal slider between the generated code
area and the script list. It enhances interaction, accessibility and
performance. It provides missing touch responsiveness, improves
accessibility by using better HTML semantics, introduces throttling and
refactors cursor handling during drag operations with added tests.

These changes provides smoother user experience, better support for
touch devices, reduce load during interactions and ensure the
component's behavior is intuitive and accessible across different
devices and interactions.

- Fix horizontal slider not responding to touch events.
- Improve slider handle to be a `<button>` for improved accessibility
  and native browser support, improving user interaction and keyboard
  support.
- Add throttling in the slider for performance optimization, reducing
  processing load during actions.
- Fix losing dragging state cursor on hover over page elements such as
  input boxes and buttons during dragging.
- Separate dragging logic into its own compositional hook for clearer
  separation of concerns.
- Refactor global cursor mutation process.
- Increase robustness in global cursor changes by preserving and
  restoring previous cursor style to prevent potential side-effects.
- Use Vue 3.2 feature for defining cursor CSS style in `<style>`
  section.
- Expand unit test coverage for horizontal slider, use MouseEvent and
  type cast it to PointerEvent as MouseEvent is not yet supported by
  `jsdom` (see jsdom/jsdom#2527).
 2024-01-08 23:08:10 +01:00
undergroundwires
3b1a89ce86 Fix script execution for Linux VSCode development 
This commit improves the VSCode configuration script for Linux-based
development environments.

It fixes a script execution failure in the deskto version during
development when using VSCode installed via Snap or Flatpak. It resolves
the following error encountered during script execution in development
mode (`npm run electron:dev`):

`symbol lookup error: /snap/core20/current/lib/x86_64-linux-gnu/libpthread.so.0:
 undefined symbol: __libc_pthread_init, version GLIBC_PRIVATE`

Changes:

- Add a setting in VSCode configuration script to workaround script
  execution errors in sandboxed VSCode installations on Linux (see
  see microsoft/vscode#179274).
- Migrate the configuration script to Python for cross-platform
  compatibility and simplicity.
- Refactor the script for better extensibility.
- Automate installation of recommended VSCode extensions.
- Recommend VSCode Pylint extension for Python linting.
- Standardize Python development settings in `.editorconfig`.
 2024-01-07 14:02:40 +01:00
undergroundwires
c84a1bb74c Fix script deletion during execution on desktop 
This commit fixes an issue seen on certain Windows environments (Windows
10 22H2 and 11 23H2 Pro Azure VMs) where scripts were being deleted
during execution due to temporary directory usage. To resolve this,
scripts are now stored in a persistent directory, enhancing reliability
for long-running scripts and improving auditability along with
troubleshooting.

Key changes:

- Move script execution logic to the `main` process from `preloader` to
  utilize Electron's `app.getPath`.
- Improve runtime environment detection for non-browser environments to
  allow its usage in Electron main process.
- Introduce a secure module to expose IPC channels from the main process
  to the renderer via the preloader process.

Supporting refactorings include:

- Simplify `CodeRunner` interface by removing the `tempScriptFolderName`
  parameter.
- Rename `NodeSystemOperations` to `NodeElectronSystemOperations` as it
  now wraps electron APIs too, and convert it to class for simplicity.
- Rename `TemporaryFileCodeRunner` to `ScriptFileCodeRunner` to reflect
  its new functinoality.
- Rename `SystemOperations` folder to `System` for simplicity.
- Rename `HostRuntimeEnvironment` to `BrowserRuntimeEnvironment` for
  clarity.
- Refactor main Electron process configuration to align with latest
  Electron documentation/recommendations.
- Refactor unit tests `BrowserRuntimeEnvironment` to simplify singleton
  workaround.
- Use alias imports like `electron/main` and `electron/common` for
  better clarity.
 2024-01-06 18:47:58 +01:00
undergroundwires
bf7fb0732c Bump ESLint Typescript dependencies to latest 
- Bump all ESLint dependencies related to TypeScript to their latest
  version. This was made possible by the resolution of compatibility
  issues with `@vue/eslint-config-airbnb-with-typescript`.
  See vuejs/eslint-config-airbnb#58 for details.
- Refactor code to comply with the latest linting configuration.
- Improve documentation in the ESLint configuration file to better
  describe the functionality and limitations of
  `@vue/typescript/recommended`.
  See vuejs/eslint-config-typescript#67 for details.
- Document functionality and limitation of `@vue/typescript/recommended`
  more clearly in ESLint configuration file.
 2024-01-05 14:18:50 +01:00
undergroundwires
dc30825232 Fix macOS detection in desktop app and Chromium 
This commit addresses an issue where macOS was incorrectly identified as
iPadOS in Chromium-based browsers. The root cause was related to touch
support detection being inaccurately triggered on Chromium browsers,
leading to misidentification.

The bug caused two issues:

1. Desktop version: Script execution on macOS did not work as the
   desktop app wrongly assumed that it was running on iPadOS.
2. Web and desktop version: The UI didn't default to macOS, presuming an
   iPadOS environment.

This bug was exclusive to Chromium browsers on macOS. Firefox and Safari
didn't exhibit this behavior, as they handle touch event browser API
as differently and initially expected.

Key changes:

- Improve touch support detection to accurately differentiate between
  macOS and iPadOS by removing an identification method used that is not
  reliable for Chromium-based browsers.
- Update user agent detection to correctly identify Electron-based
  applications as macOS even without needing the information from the
  preloader context.
 2024-01-03 11:00:34 +01:00
undergroundwires
40f5eb8334 Fix handling special chars in script paths 
This commit improves the handling of paths with spaces or special
characters during script execution in the desktop application.

Key improvements:

- Paths are now quoted for macOS/Linux, addressing issues with
  whitespace or single quotes.
- Windows paths are enclosed in double quotes to handle special
  characters.

Other supporting changes:

- Add more documentation for terminal execution commands.
- Refactor terminal script file execution into a dedicated file for
  improved separation of concerns.
- Refactor naming of `RuntimeEnvironment` to align with naming
  conventions (no interface with I prefix) and for clarity.
- Refactor `TemporaryFileCodeRunner` to simplify it by removing the `os`
  parameter and handling OS-specific logic within the filename generator
  instead.
- Refactor `fileName` to `filename` for consistency.
 2024-01-02 16:16:31 +01:00
undergroundwires
fac72edd55 win: improve store app docs and add research #279 
This commit improves documentation for removal of Windows store apps
along with adding related research.

1. Improve Store app removal documentation:
   The documentation for scripts that remove Store apps has been
   enhanced. It now includes information on the default preinstallation
   status of these apps across various Windows versions. This update
   covers Windows 10 (from version 19H2 to 23H2) and Windows 11 (from
   version 21H2 to 23H2), enabling users to identify potentially
   preinstalled apps that might affect privacy.

2. Add research documentation:
   A detailed research documentation on Windows Store apps has been
   introduced for Windows 10 (versions 1909 to 22H2) and Windows 11
   (versions 21H2 to 23H2). This includes lists of preinstalled Store
   apps, complete with package information. This research aids in
   understanding which default apps are present in different Windows
   versions and their status regarding removal. The documentation also
   includes the PowerShell script used for this research, serving as a
   resource for future updates and expansion.
 2024-01-01 17:44:09 +01:00
undergroundwires
cdc32d1f12 Improve desktop script runs with timestamps & logs 
Improve script execution in the desktop app by introducing timestamped
filenames and detailed logging. These changes aim to facilitate easier
debugging, auditing and overall better user experience.

Key changes:

- Add timestamps in filenames for temporary files to aid in
  troubleshooting and auditing.
- Add application logging throughout the script execution process to
  enhance troubleshooting capabilities.

Other supporting changes:

- Refactor `TemporaryFileCodeRunner` with subfunctions for improved
  readability, maintenance, reusability and extensibility.
- Refactor unit tests for `TemporaryFileCodeRunner` for improved
  granularity and simplicity.
- Create centralized definition of supported operating systems by
  privacy.sexy to ensure robust and consistent test case creation.
- Simplify the `runCode` method by removing the file extension
  parameter; now handled internally by `FileNameGenerator`.
 2023-12-31 14:28:58 +01:00
undergroundwires
8f4b34f8f1 win: fix language dependent delete script #149 
This commit addresses the language dependency of the `takeown /d y`
command in non-English Windows versions by using the `choice` utility.
This utility dynamically determines the equivalent of 'yes' in the
current system language, resolving issues encountered in the delete
script.

Other solution options such as enumerating language equivalents,
adjusting script culture settings, using side-effects of the `copy`
command, and parsing `takeown` help documentation proved either
impractical or unreliable.

The `choice` command has been successfully tested in both English and
German environments, ensuring reliable execution across various locales.
This change replaces the previous `takeown` usage in the script,
its reliability across diverse Windows locales.
 2023-12-30 17:12:21 +01:00
undergroundwires
86fde6d7dc Fix button inconsistencies and macOS layout shifts 
This commit fixes layout shifts experienced in macOS Safari when
hovering over top menu items. Instead of making text bold — which was
causing layout shifts — the hover effect now changes the text color.
This ensures a consistent UI across different browsers and platforms.

Additionally, this commit fixes the styling of the privacy button
located in the bottom right corner. Previously styled as an `<a>`
element, it is now correctly represented as a `<button>`.

Furthermore, the commit enhances HTML conformity and accessibility by
correctly using `<button>` and `<a>` tags instead of relying on click
interactions on `<span>` elements.

This commit introduces `FlatButton` Vue component and a new
`flat-button` mixin. These centralize button usage and link styles,
aligning the hover/touch reactions of buttons across the application,
thereby creating a more consistent user interface.
 2023-12-29 17:26:40 +01:00
undergroundwires
2f06043559 Bump Node.js environment to 18.x 
- Bump Node.js to version 18. This change is necessary as Node.js v16
  will reach end-of-life on 2023-09-11. It also ensure compatibility
  with dependencies requiring minimum of Node.js v18, such as `vite`,
  `@vitejs`plugin-legacy` and `icon-gen`.
- Bump `setup-node` action to v4.
- Recommend using the `nvm` tool for managing Node.js versions in the
  documentation.
- Update documentation to point to code reference for required Node.js
  version. This removes duplication of information, and keeps the code
  as single source of truth for required Node.js version.
- Refactor code to adopt the `node:` protocol for Node API imports as
  per Node.js 18 standards. This change addresses ambiguities and aligns
  with Node.js best practices (nodejs/node#38343). Currently, there is
  no ESLint rule to enforce this protocol, as noted in
  import-js/eslint-plugin-import#2717.
- Replace `cross-fetch` dependency with the native Node.js fetch API
  introduced in Node.js 18. Adjust type casting for async iterable read
  streams to align with the latest Node.js APIs, based on discussions in
  DefinitelyTyped/DefinitelyTyped#65542.
 2023-12-28 11:57:38 +01:00
undergroundwires
fc9dd234e9 Improve documentation for contribution guidelines 
- Improve `CONTRIBUTING.md` with clearer, more structured guidelines.
- Introduce a centralized 'Script Guidelines' document for consistent
  reference.
- Remove repetitive information across documents, providing links to the
  primary source.
- Simplify language across related documentation for better
  accessibility and readability.
 2023-12-20 18:53:08 +01:00
undergroundwires
645c333787 Fix unresponsive circle icon in revert button 
This commit fixes a UI bug where the circle icon of the revertbutton was
unresponsive to clicks. The solution involves replacing the
pseudo-element (`:before`) with an actual HTML element, enabling direct
event binding.

Additional improvements include:

- Removal of redundant `z-index` properties to simplify click event
  handling and reduce complexity.
- Programmatic toggle of `isChecked` on click, providing more controlled
  and explicit behavior and avoiding issues with native checkbox
  behavior, especially when overlaid on a pseudo-element.
 2023-12-19 10:44:54 +01:00
undergroundwires
efa05f42bc Improve security by isolating code execution more 
This commit enhances application security against potential attacks by
isolating dependencies that access the host system (like file
operations) from the renderer process. It narrows the exposed
functionality to script execution only, adding an extra security layer.

The changes allow secure and scalable API exposure, preparing for future
functionalities such as desktop notifications for script errors (#264),
improved script execution handling (#296), and creating restore points
(#50) in a secure and repeatable way.

Changes include:

- Inject `CodeRunner` into Vue components via dependency injection.
- Move `CodeRunner` to the application layer as an abstraction for
  better domain-driven design alignment.
- Refactor `SystemOperations` and related interfaces, removing the `I`
  prefix.
- Update architecture documentation for clarity.
- Update return types in `NodeSystemOperations` to match the Node APIs.
- Improve `WindowVariablesProvider` integration tests for better error
  context.
- Centralize type checks with common functions like `isArray` and
  `isNumber`.
- Change `CodeRunner` to use `os` parameter, ensuring correct window
  variable injection.
- Streamline API exposure to the renderer process:
  - Automatically bind function contexts to prevent loss of original
    context.
  - Implement a way to create facades (wrapper/proxy objects) for
    increased security.
 2023-12-18 17:30:56 +01:00
undergroundwires
940febc3e8 Fix CSP for Vue, Ace, Vite, Safari compatibility 
Relax Content Security Policy (CSP) to ensure essential functionality
of Vue, Ace and Vite legacy along with functioning developer experience
with macOS Safari.
 2023-12-17 18:08:23 +01:00
undergroundwires-bot
3f62bb2d6e ⬆️ bump everywhere to 0.12.9 2023-12-16 03:56:16 +00:00
799 changed files with 25428 additions and 9682 deletions
Expand all files Collapse all files

26
.editorconfig
View File

@@ -1,7 +1,11 @@
[*.{js,jsx,ts,tsx,vue,sh}]
root = true # Top-most EditorConfig file
[*]
end_of_line = lf
[*.{js,jsx,ts,tsx,vue,sh,scss}]
indent_style = space
indent_size = 2
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 100
@@ -9,3 +13,21 @@ max_line_length = 100
[{Dockerfile}]
indent_style = space
indent_size = 4
[*.py]
indent_size = 4 # PEP 8 (the official Python style guide) recommends using 4 spaces per indentation level
indent_style = space
max_line_length = 100
[*.ps1]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
insert_final_newline = true
[*.{scss}] # SASS guidelines: https://archive.today/2024.02.16-232553/https://sass-guidelin.es/
indent_style = space
indent_size = 2 # Recommended by SASS guidelines
max_line_length = 100 # Recommended by SASS guidelines
trim_trailing_whitespace = true
insert_final_newline = true

9
.eslintrc.cjs
View File

@@ -9,14 +9,15 @@ module.exports = {
es2022: true, // add globals and sets parserOptions.ecmaVersion to 2022
},
extends: [
// Vue specific rules, eslint-plugin-vue
// Vue specific base rules, `eslint-plugin-vue`
'plugin:vue/vue3-recommended',
// Extends eslint-config-airbnb
// Extends `eslint-config-airbnb`
'@vue/eslint-config-airbnb-with-typescript',
// Extends @typescript-eslint/recommended
// Uses the recommended rules from the @typescript-eslint/eslint-plugin
// - Sets base parser and plugin options.
// - Includes `plugin:@typescript-eslint/recommended`. But incompatible with
// `strict-type-checked` and `stylistic-type-checked`, see https://github.com/vuejs/eslint-config-typescript/issues/67.
'@vue/typescript/recommended',
],
rules: {

59
.github/ISSUE_TEMPLATE/4-new-script-suggestion.md vendored
View File

@@ -5,71 +5,56 @@ labels: enhancement
---
<!--
Thank you for suggesting an script to make privacy better. 🤗
Please fill in as much of the template below as you're able.
You could alternatively send a PR directly (see CONTRIBUTING.md).
Thank you for contributing to privacy.sexy! 🌟
For guidance, see our script guidelines: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md.
Consider submitting a PR for faster implementation: https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md#extend-scripts.
-->
### OS
### Operating system
<!--
Which OS will the new script configure?
One of the supported OSes: "Windows", "macOS" or "Linux".
Specify the OS: Windows, macOS, or Linux.
-->
### Name
<!--
The name of the script.
It should start with an imperative noun such as "disable", "turn off" , "clear"...
E.g. "Disable webcam telemetry"
Suggest a name for the script.
Naming conventions: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#name.
-->
### Script code
### Code
<!--
Code that will be executed when script is selected.
Try to keep it as simple and backwards-compatible as possible.
Allowed languages:
- Windows: PowerShell (ps1) or batchfile
- 💡 Prioritize the one that's simpler, batchfile if similar.
- macOS: bash (sh)
- Linux: bash (sh) or Python 3
- 💡 Prioritize the one that's simpler, bash if similar.
Provide or explain the code to execute when the script runs.
Code guidelines: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#code.
-->
### Revert code
<!--
If applicable, add code that will revert the script code to its original (OS default) state.
It may require additional time, but it's much appreciated by the community.
Leave blank if the script is nonreversible (e.g. when clearing data without backup).
Include code to revert changes to the default state.
Leave blank for non-reversible scripts.
-->
### Suggested category
### Category
<!--
If applicable, suggest one more multiple suitable parent category of script.
A category is the item where the script will be presented under.
Most likely there already is a category for the script, so check the existing categories.
If you're unsure, leave blank and maintainer(s) will choose one.
Suggest a category for the script.
If unsure, leave blank for maintainers to decide.
-->
### Suggested recommendation level
### Recommendation level
<!--
If applicable, suggest recommending the script or not recommending at all.
A script should be only recommended if it'll be safe for your grandmother to run.
So you have three options here:
STANDARD: Non-breaking scripts that does not limit any functionality.
STRICT: Scripts that can break certain functionality but not intrusive to common daily OS usage.
NONE: Script is not recommended for newbies at all, only those who knows what's going on should select it.
If you're unsure, leave blank and maintainer(s) will choose one.
Suggest a recommendation level: STANDARD (non-breaking), STRICT (limits functionality), or NONE (for advanced users).
If unsure, leave blank for maintainers to decide.
-->
### Additional documentation/references
### Documentation/References
<!--
If applicable, refer to documentation that should show up on the script description.
Sources (URLs) should be as high quality as possible e.g. vendor documentation is favored over user forums.
Provide any relevant documentation or references.
Prefer high-quality sources such as vendor documentation.
Documentation guidelines: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#documentation.
-->

4
.github/actions/setup-node/action.yml vendored
View File

@@ -3,6 +3,6 @@ runs:
steps:
-
name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 18.x

3
.github/workflows/checks.external-urls.yaml vendored
View File

@@ -3,6 +3,9 @@ name: checks.external-urls
on:
schedule:
- cron: '0 0 * * 0' # at 00:00 on every Sunday
push:
paths:
- tests/checks/external-urls/**
jobs:
run-check:

1
.github/workflows/release.desktop.yaml vendored
View File

@@ -20,6 +20,7 @@ jobs:
fetch-depth: 0 # fetch all history
-
name: Checkout to bump commit
shell: bash
run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
-
name: Setup node

3
.vscode/extensions.json vendored
View File

@@ -16,7 +16,8 @@
// Scripting
"timonwong.shellcheck", // Lints bash files.
"ms-vscode.powershell", // Lints PowerShell files.
"ms-python.python", // Lints Python files.
"ms-python.python", // Python IntelliSense, debugging, and basic linting.
"ms-python.pylint", // Lints Python files
// Distribution
"ms-azuretools.vscode-docker" // Adds Docker support.
]

80
CHANGELOG.md
View File

@@ -1,5 +1,85 @@
# Changelog
## 0.13.0 (2024-02-11)
* win: add disabling clipboard features #251, #247 | [c6ebba8](https://github.com/undergroundwires/privacy.sexy/commit/c6ebba85fb1b362be0d81d3078f19db71e0528b2)
* win: improve search privacy scripts #117 | [541f9aa](https://github.com/undergroundwires/privacy.sexy/commit/541f9aa5ee1b5f4885063b65beaf6cd873f0d786)
* win: add disabling Windows Copilot #263, #266 | [cd42550](https://github.com/undergroundwires/privacy.sexy/commit/cd425502ae882bba9642dc2171c2b5771946b5a9)
* win: add Dropbox telemetry blocking #125, #118 | [10829d6](https://github.com/undergroundwires/privacy.sexy/commit/10829d65aa3fb0df937bb8829244e6290bb748c7)
* Improve selection type documentation | [7af8daa](https://github.com/undergroundwires/privacy.sexy/commit/7af8daa3411b24efb6385c7876a49bd372753f38)
* Expand script names to take full available width | [d277139](https://github.com/undergroundwires/privacy.sexy/commit/d277139dd50eeb4e4057b0a7d8fc4ac2d70785de)
* Limit tooltip width for improved readability | [6ab6dac](https://github.com/undergroundwires/privacy.sexy/commit/6ab6dacd1be2d7bf1863b07b121d86f2a379ac67)
* Add markdown support for script/category names | [a5ffed4](https://github.com/undergroundwires/privacy.sexy/commit/a5ffed4cd60d9d058d5374145c1176b10fad1660)
* Normalize and improve font sizes | [4da306b](https://github.com/undergroundwires/privacy.sexy/commit/4da306b9f79b0bb7a64bb197fb246258cf435b8d)
* Change 'revert' button to title case | [937f459](https://github.com/undergroundwires/privacy.sexy/commit/937f4593d1a91081ab6b1bcb8f85d03879d7cf07)
* Remove playful emojis (🍑🍆) | [aa4205f](https://github.com/undergroundwires/privacy.sexy/commit/aa4205ff7af7d05cfb5e82bf541b521d49bbd1c8)
* Improve UI code styling for all platforms | [311fcb1](https://github.com/undergroundwires/privacy.sexy/commit/311fcb18133d1343f6a9ae5bd7a25795a1d12c49)
* Render bracket references as superscript text | [b9c89b7](https://github.com/undergroundwires/privacy.sexy/commit/b9c89b701fc77d20dcc706419a8659ad156c4fc2)
* Change slogan and refactor project info naming | [a54e164](https://github.com/undergroundwires/privacy.sexy/commit/a54e16488ce32219bcf811b5da85f06584b293fb)
* Add 'Revert All Selection' feature #68 | [55fa7ea](https://github.com/undergroundwires/privacy.sexy/commit/55fa7eae71031357d6f03f0d349a09cd446270d3)
* win, mac, linux: add privacy.sexy cleanup scripts | [63366a4](https://github.com/undergroundwires/privacy.sexy/commit/63366a4ec2533a376849d692211e9972b56ab4a8)
* Extend search by including documentation content | [6142f3a](https://github.com/undergroundwires/privacy.sexy/commit/6142f3a2973d20493f784f323f3be57fa8deaeef)
* Remove 'preview' label from Linux options | [ebd8285](https://github.com/undergroundwires/privacy.sexy/commit/ebd82853ddc56f1cc2fc9be3fe0b3001b07f0186)
* Change fonts for improved readability | [d5bbc32](https://github.com/undergroundwires/privacy.sexy/commit/d5bbc321f902dc60618ffdfda0d583a4a433f7af)
* Apply global styles for visual consistency | [faa7a38](https://github.com/undergroundwires/privacy.sexy/commit/faa7a38a7d16390f27e4a3e51017b81665cf85ca)
* Add UI animations for expand/collapse actions | [fb08f03](https://github.com/undergroundwires/privacy.sexy/commit/fb08f037651e1a7d453b9a6af724cbccecc5b903)
* win: relocate service disabling and improve docs | [894687c](https://github.com/undergroundwires/privacy.sexy/commit/894687c0e0375a24f40bcd720ea69c9b2aa62a58)
* win: add host blocking category #26 | [17152c8](https://github.com/undergroundwires/privacy.sexy/commit/17152c84dc639e75560998a6feddfd46e0f713ce)
* Update meta title and description | [c7fa4b6](https://github.com/undergroundwires/privacy.sexy/commit/c7fa4b6d020ac6fd3bf72bb4e57022dffb1ba921)
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.10...0.13.0)
## 0.12.10 (2024-01-17)
* Fix CSP for Vue, Ace, Vite, Safari compatibility | [940febc](https://github.com/undergroundwires/privacy.sexy/commit/940febc3e80cfd0c01b5cc8282ebaab6b024d1b5)
* Improve security by isolating code execution more | [efa05f4](https://github.com/undergroundwires/privacy.sexy/commit/efa05f42bc53c44a352152b7c272bc0bda363070)
* Fix unresponsive circle icon in revert button | [645c333](https://github.com/undergroundwires/privacy.sexy/commit/645c33378769969c525a1552c65f8d0005e25fcf)
* Improve documentation for contribution guidelines | [fc9dd23](https://github.com/undergroundwires/privacy.sexy/commit/fc9dd234e9c749247f42289432ebb92dbe0a5f64)
* Bump Node.js environment to 18.x | [2f06043](https://github.com/undergroundwires/privacy.sexy/commit/2f0604355988a421690bb275375c3df280af7ee6)
* Fix button inconsistencies and macOS layout shifts | [86fde6d](https://github.com/undergroundwires/privacy.sexy/commit/86fde6d7dc61bbeeb3088cd24e37451181cc4e01)
* win: fix language dependent delete script #149 | [8f4b34f](https://github.com/undergroundwires/privacy.sexy/commit/8f4b34f8f156476f56fb7dde8e7c762f4455518b)
* Improve desktop script runs with timestamps & logs | [cdc32d1](https://github.com/undergroundwires/privacy.sexy/commit/cdc32d1f12c938966238c9569c91b64b23cd6f26)
* win: improve store app docs and add research #279 | [fac72ed](https://github.com/undergroundwires/privacy.sexy/commit/fac72edd551264320ed97194e7ecb3fcc34139f7)
* Fix handling special chars in script paths | [40f5eb8](https://github.com/undergroundwires/privacy.sexy/commit/40f5eb8334b27e958eee63e2141ded7d5861d960)
* Fix macOS detection in desktop app and Chromium | [dc30825](https://github.com/undergroundwires/privacy.sexy/commit/dc30825232a1355a325e364c8cd9fde78ffa3b1a)
* Bump ESLint Typescript dependencies to latest | [bf7fb07](https://github.com/undergroundwires/privacy.sexy/commit/bf7fb0732c52745521c1a89b963bdbf3394d9e63)
* Fix script deletion during execution on desktop | [c84a1bb](https://github.com/undergroundwires/privacy.sexy/commit/c84a1bb74ccb7a53bd493684b63a9e04f40e0b8b)
* Fix script execution for Linux VSCode development | [3b1a89c](https://github.com/undergroundwires/privacy.sexy/commit/3b1a89ce863c18c32be7d0b22dba566f692d81d1)
* Fix touch, cursor and accessibility in slider | [7285842](https://github.com/undergroundwires/privacy.sexy/commit/728584240cae6b3857abca4d3ddaaa7f6bb4a66e)
* Fix invisible script execution on Windows #264 | [b404a91](https://github.com/undergroundwires/privacy.sexy/commit/b404a91ada509e19a287d026d55db0035ff6233b)
* win: add missing extension apps, improve docs #279 | [da4be50](https://github.com/undergroundwires/privacy.sexy/commit/da4be500da7b0b5897a8b3e0525d9e50c9159fe0)
* Show native save dialogs in desktop app #50, #264 | [c546a33](https://github.com/undergroundwires/privacy.sexy/commit/c546a33eff7506550c7bcf03bb1f227a7c091816)
* Show save/execution error dialogs on desktop #264 | [e09db0f](https://github.com/undergroundwires/privacy.sexy/commit/e09db0f1bd73503204d8e5375a9cfe693f174a57)
* Add Windows save instructions UI and fix URL #296 | [756c736](https://github.com/undergroundwires/privacy.sexy/commit/756c736e21d713b8d2651cf2a9d7cf0678badde0)
* Add AD detection on desktop app #264, #304 | [f03fc24](https://github.com/undergroundwires/privacy.sexy/commit/f03fc2409832ddf904bc6bd4e19274a8d40745dc)
* Improve script error dialogs #304 | [6ada8d4](https://github.com/undergroundwires/privacy.sexy/commit/6ada8d425c4a7df88490756187c84b5c57ed1dcc)
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.9...0.12.10)
## 0.12.9 (2023-12-16)
* win: improve docs and category of jump lists #146 | [40ae8a8](https://github.com/undergroundwires/privacy.sexy/commit/40ae8a8addaeb834ee26eabd330fda5cbb495324)
* mac: improve clearing privacy permissions | [5a7d7d8](https://github.com/undergroundwires/privacy.sexy/commit/5a7d7d88ff2f3e8862b18c94d062f692ee4b690b)
* win: fix logic for terminating processes | [807ae6a](https://github.com/undergroundwires/privacy.sexy/commit/807ae6a8f8ca724d781169f3ecb40f43ccd3fe10)
* win: improve documentation for "Get Help" app #280 | [8f5d7ed](https://github.com/undergroundwires/privacy.sexy/commit/8f5d7ed3cfa57f66dded9b72374006c9b6df2ce9)
* Centralize log file and refactor desktop logging | [08dbfea](https://github.com/undergroundwires/privacy.sexy/commit/08dbfead7ca7b55fe85f7dded01f2d4b88906c72)
* win: fix revert and improve docs for SAM enum #255 | [25e23c8](https://github.com/undergroundwires/privacy.sexy/commit/25e23c89c3f86897d5661a24a774997c924d3b2d)
* Improve security and reliability of macOS updates | [4765752](https://github.com/undergroundwires/privacy.sexy/commit/4765752ee3a36301b3d97317c570432424de8460)
* win: fix Win 11 Windows Security app removal #195 | [daa6230](https://github.com/undergroundwires/privacy.sexy/commit/daa6230fc96f2cf7210bc8c165106c0d5544e5fb)
* Improve security and privacy with strict meta tags | [ba5b29a](https://github.com/undergroundwires/privacy.sexy/commit/ba5b29a35dd7665aeea430aec4aaa8ff5ca811de)
* win: document and discourage admin shares #249 | [e747ee5](https://github.com/undergroundwires/privacy.sexy/commit/e747ee5cbc7cf5f0fe28a87fe7d02457d777373e)
* win: discourage XboxIdentityProvider #64, #79 #181 | [c72f9f5](https://github.com/undergroundwires/privacy.sexy/commit/c72f9f501680c1d880a0b560d02451a9e31063b4)
* win: improve disabling update healing #272 | [47b4823](https://github.com/undergroundwires/privacy.sexy/commit/47b4823bc5e487188b12cbea67db2525260af497)
* Fix tooltip overflow on smaller screens | [916c9d6](https://github.com/undergroundwires/privacy.sexy/commit/916c9d62d9fce27c3cd3feaf90c66df584d4f04a)
* Fix touch state not being activated in iOS Safari | [a985127](https://github.com/undergroundwires/privacy.sexy/commit/a9851272ae14eb1b374767b0eed3eb68e6dd1560)
* Fix tree view alignment and padding issues | [15134ea](https://github.com/undergroundwires/privacy.sexy/commit/15134ea04bc46e8cb13977d75b788f5ff71c800e)
* win: improve disabling of Application Experience | [fe3de49](https://github.com/undergroundwires/privacy.sexy/commit/fe3de498c8a1394efd6517d436797a08f938bb57)
* Fix OS switching not working on tree view UI | [3457fe1](https://github.com/undergroundwires/privacy.sexy/commit/3457fe18cf8193883f45b50ecbc9638c91ace2fb)
* Fix touch-enabled Chromium highlight on tree nodes | [2063397](https://github.com/undergroundwires/privacy.sexy/commit/20633972e9b56bdc102357129e74df30a95cefa9)
* win: add scripts to postpone auto-updates #272 | [e95b2ba](https://github.com/undergroundwires/privacy.sexy/commit/e95b2ba2179e40c0033a51b0087871dbfdc32d78)
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.8...0.12.9)
## 0.12.8 (2023-11-27)
* Remove duplicated `index.html` file | [aab0f7e](https://github.com/undergroundwires/privacy.sexy/commit/aab0f7ea4680f377c610066bd0e99011eed8b506)

48
CONTRIBUTING.md
View File

@@ -1,6 +1,6 @@
# Contributing
Love your input! Contributing to this project should be as easy and transparent as possible, whether it's:
Love your input ❤️! Contributing to this project should be as easy and transparent as possible, whether it's:
- reporting a bug,
- discussing the current state of the code,
@@ -16,7 +16,7 @@ Your pull requests are actively welcomed. We collaborate using [GitHub flow](htt
The steps:
1. Fork the repo and create your branch from master.
1. Fork the repository and create your branch from `master`.
2. If you've added code that requires testing, add tests. See [tests.md](./docs/tests.md).
3. If you've done a major change, update the documentation. See [docs/](./docs/).
4. Ensure the test suite passes. See [development.md | Testing](./docs/development.md#testing) for commands.
@@ -37,16 +37,44 @@ Automated pipelines will run to control your PR and they will publish your code
## Extend scripts
Here's quick information for you who want to add more scripts.
If you're interested in adding new scripts to privacy.sexy:
You have two alternatives:
1. Read [guidelines for a good script](./docs/script-guidelines.md)
2. Choose one of two ways to contribute:
1. [Create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) requesting the addition of a new script. This allows other contributors to develop and add it for you. This will take longer time.
2. Submit a pull request with your script. This is the faster route to seeing your script included in the project. Add your scripts to the appropriate OS directory in the [collections](src/application/collections/) (for syntax guidance, see [collection-files.md](docs/collection-files.md)) folder, and follow the [pull request process](#pull-request-process).
1. [Create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) and ask for someone else to add the script for you.
2. Or send a PR yourself. This would make it faster to get your code into the project. You need to add scripts to related OS in [collections](src/application/collections/) folder. Then you'd sent a pull request, see [pull request process](#pull-request-process).
- 💡 You should use existing shared functions for most of the operations, like `DisableService` for disabling services, to maintain code consistency and efficiency.
- 📖 If you're unsure about the syntax, check [collection-files.md](docs/collection-files.md).
- 📖 If you wish to use templates, use [templating.md](./docs/templating.md).
## Commit conventions
- Adhere to the 50/72 rule:
- Commit titles should not exceed 50 characters.
- Limit description lines to 72 characters, except for code blocks or inline codes.
- Avoid including delta (such as `git diff` information) or a list of changed files in the commit message. This information is redundant as it's already part of the commit.
- Focus on explaining the WHY and HOW of the changes, rather than WHAT changes are.
- Begin the commit message with a concise summary of what the commit accomplishes.
- Use imperative language in the commit title. For example, use "add" instead of "added".
- Commit prefixes:
- Prefix bug fixes with `fix:` or `Fix ...`.
- For commits affecting scripts of specific operating systems:
- Prefix the commit title with an OS-specific tag such as `win:` for Windows scripts, `mac:` for macOS scripts, and `linux:` for Linux scripts.
- Combine prefixes for commits affecting more than one operating system, e.g., `win, mac: ...`.
## Versioning
We base versioning on the release's content rather than strictly following semantic versioning.
There are two main types of releases:
1. **Patch Releases:** These focus on minor UI improvements, bug fixes, refactorings, dependency updates, and documentation updates. For scripts, they involve adjusting recommendation levels, enhancing functionality, and dividing scripts for more precise control. Patch releases may ship minor feature additions if they are essential for fixing a bug. For these updates, we increment the patch number in the `MAJOR.MINOR.PATCH`.
2. **Feature Releases:** These releases bring significant updates that change how users interact with privacy.sexy. They include major UI enhancements, the introduction of new scripts, and features. For these updates, we increment the minor number in the `MAJOR.MINOR.PATCH`.
Maintainers tag specific commits with a version number to trigger a release, and [bump-everywhere](https://github.com/undergroundwires/bump-everywhere) automates the release process including updating version numbers throughout the project.
## Refactoring
Opportunistic refactoring is welcome. If you're adding a feature or fixing a bug, feel free to also clean up and optimize the related code. Your contributions should leave the code in a better state than when you found it.
## License
By contributing, you agree that your [GNU General Public License v3.0](./LICENSE) will be the license for your contributions.
By contributing to this project, you agree that your contributions are licensed under the [GNU Affero General Public License](./LICENSE) as currently specified. Additionally, you expressly consent to the project maintainers having full authority to modify the licensing terms or relicense your contributions under different terms in the future.

7
README.md
View File

@@ -1,6 +1,6 @@
# privacy.sexy — Now you have the choice
# privacy.sexy — Privacy is sexy
> Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆
> Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy.
<!-- markdownlint-disable MD033 -->
<p align="center">
@@ -122,7 +122,7 @@
## Get started
- 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.8/privacy.sexy-Setup-0.12.8.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.8/privacy.sexy-0.12.8.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.8/privacy.sexy-0.12.8.AppImage). For more options, see [here](#additional-install-options).
- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.0/privacy.sexy-Setup-0.13.0.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.0/privacy.sexy-0.13.0.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.0/privacy.sexy-0.13.0.AppImage). For more options, see [here](#additional-install-options).
For a detailed comparison of features between the desktop and web versions of privacy.sexy, see [Desktop vs. Web Features](./docs/desktop-vs-web-features.md).
@@ -137,6 +137,7 @@ For a detailed comparison of features between the desktop and web versions of pr
- **Transparent**. Have full visibility into what the tweaks do as you enable them.
- **Reversible**. Revert if something feels wrong.
- **Accessible**. No need to run any compiled software on your computer with web version.
- **Secure**: Security is a top priority at privacy.sexy with [comprehensive safeguards](./SECURITY.md#security-practices) in place.
- **Open**. What you see as code in this repository is what you get. The application itself, its infrastructure and deployments are open-source and automated thanks to [bump-everywhere](https://github.com/undergroundwires/bump-everywhere).
- **Tested**. A lot of tests. Automated and manual. Community-testing and verification. Stability improvements comes before new features.
- **Extensible**. Effortlessly [extend scripts](./CONTRIBUTING.md#extend-scripts) with a custom designed [templating language](./docs/templating.md).

19
SECURITY.md
View File

@@ -31,9 +31,22 @@ privacy.sexy adopts a defense in depth strategy to protect users on multiple lay
- **Content Security Policies (CSP):**
privacy.sexy actively follows security guidelines from the Open Web Application Security Project (OWASP) at strictest level.
This approach protects against attacks like Cross Site Scripting (XSS) and data injection.
- **Context Isolation:**
The desktop application isolates different code sections based on their access level.
This separation prevents attackers from introducing harmful code into the app, known as injection attacks.
- **Host System Access Control:**
The desktop application segregates and isolates code sections based on their access levels through sandboxing.
This provides a critical defense mechanism, prevents attackers from introducing harmful code into the app, known as injection attacks.
- **Auditing and Transparency:**
The desktop application improves security and transparency by logging application activities and retaining files of executed scripts
This facilitates detailed auditability and effective troubleshooting, contributing to the integrity and reliability of the application.
Recognizing that some users prefer not to keep these records, privacy.sexy provides specialized scripts for deletion of these logs.
- **Privilege Management:**
The desktop application operates without persistent administrative or `sudo` privileges, reinforcing its security posture. It requests
elevation of privileges for system modifications with explicit user consent and logs every action taken with high privileges. This
approach actively minimizes potential security risks by limiting privileged operations and aligning with the principle of least privilege.
- **Secure Script Execution/Storage:**
Before executing any script, the desktop application stores a copy to allow antivirus software to perform scans. This safeguards against
any unwanted modifications. Furthermore, the application incorporates integrity checks for tamper protection. If the script file differs from
the user's selected script, the application will not execute or save the script, ensuring the processing of authentic scripts.
Recognizing that some users prefer not to keep these records, privacy.sexy provides specialized scripts for deletion of these scripts.
### Update Security and Integrity

7
docs/architecture.md
View File

@@ -27,13 +27,14 @@ Application uses highly decoupled models & services in different DDD layers:
**Domain layer**:
- Serves as the system's core and central truth.
- Facilitates communication between the application and presentation layers through the domain model.
- It should be independent of other layers and encapsulate the core business concepts.
**Infrastructure layer**:
- Manages technical implementations without dependencies on other layers or domain knowledge.
- Provides technical implementations.
- Depends on the application and domain layers in terms of interfaces and contracts but should not include business logic.
![DDD + vue.js](./../img/architecture/app-ddd.png)
![DDD + vue.js](./../img/architecture/app-ddd.drawio.png)
### Application state

232
docs/collection-files.md
View File

@@ -1,192 +1,164 @@
# Collection files
- privacy.sexy is a data-driven application where it reads the necessary OS-specific logic from yaml files in [`application/collections`](./../src/application/collections/)
- 💡 Best practices
- If you repeat yourself, try to utilize [YAML-defined functions](#function)
- Always try to add documentation and a way to revert a tweak in [scripts](#script)
- 📖 Types in code: [`collection.yaml.d.ts`](./../src/application/collections/collection.yaml.d.ts)
privacy.sexy is a data-driven application that reads YAML files.
This document details the structure and syntax of the YAML files located in [`application/collections`](./../src/application/collections/), which form the backbone of the application's data model.
Related documentation:
- 📖 [`collection.yaml.d.ts`](./../src/application/collections/collection.yaml.d.ts) outlines code types.
- 📖 [Script Guidelines](./script-guidelines.md) provide guidance on script creation including best-practices.
## Objects
### `Collection`
- A collection simply defines:
- different categories and their scripts in a tree structure
- OS specific details
- Also allows defining common [function](#function)s to be used throughout the collection if you'd like different scripts to share same code.
- Defines categories, scripts, and OS-specific details in a tree structure.
- Allows defining common [functions](#function) for code reuse.
#### `Collection` syntax
- `os:` *`string`* (**required**)
- Operating system that the [Collection](#collection) is written for.
- 📖 See [OperatingSystem.ts](./../src/domain/OperatingSystem.ts) enumeration for allowed values.
- `os:` *`string`* **(required)**
- Operating system for the collection.
- 📖 See [`OperatingSystem.ts`](./../src/domain/OperatingSystem.ts) for possible values.
- `actions: [` ***[`Category`](#category)*** `, ... ]` **(required)**
- Each [category](#category) is rendered as different cards in card presentation.
- Renders each parent category as cards in the user interface.
- ❗ A [Collection](#collection) must consist of at least one category.
- `functions: [` ***[`Function`](#function)*** `, ... ]`
- Functions are optionally defined to re-use the same code throughout different scripts.
- Optional for code reuse.
- `scripting:` ***[`ScriptingDefinition`](#scriptingdefinition)*** **(required)**
- Defines the scripting language that the code of other action uses.
- Sets the scripting language for all inline code used within the collection.
### `Category`
- Category has a parent that has tree-like structure where it can have subcategories or subscripts.
- It's a logical grouping of different scripts and other categories.
Represents a logical group of scripts and subcategories.
#### `Category` syntax
- `category:` *`string`* (**required**)
- Name of the category
- ❗ Must be unique throughout the [Collection](#collection)
- `children: [` ***[`Category`](#category)*** `|` [***`Script`***](#script) `, ... ]` (**required**)
- `category:` *`string`* **(required)**
- Name of the category.
- ❗ Must be unique throughout the [collection](#collection).
- `children: [` ***[`Category`](#category)*** `|` [***`Script`***](#script) `, ... ]` **(required)**
- ❗ Category must consist of at least one subcategory or script.
- Children can be combination of scripts and subcategories.
- `docs`: *`string`* | `[`*`string`*`, ... ]`
- Documentation pieces related to the category.
- Rendered as markdown.
- Markdown-formatted documentation related to the category.
### `Script`
- Script represents a single tweak.
- A script can be of two different types (just like [functions](#function)):
1. Inline script; a script with an inline code
- Must define `code` property and optionally `revertCode` but not `call`
2. Caller script; a script that calls other functions
- Must define `call` property but not `code` or `revertCode`
- 🙏 For any new script, please add `revertCode` and `docs` values if possible.
Represents an individual tweak.
Types (like [functions](#function)):
1. Inline script:
- Direct code.
- ❗ Requires `code` and optional `revertCode`.
2. Caller script:
- Calls other [functions](#function).
- ❗ Requires `call`, but not `code` or `revertCode`.
📖 For detailed guidelines, see [Script Guidelines](./script-guidelines.md).
#### `Script` syntax
- `name`: *`string`* (**required**)
- Name of the script
- ❗ Must be unique throughout the [Collection](#collection)
- E.g. `Disable targeted ads`
- `code`: *`string`* (may be **required**)
- Batch file commands that will be executed
- 💡 If defined, best practice to also define `revertCode`
- ❗ If not defined `call` must be defined, do not define if `call` is defined.
- `revertCode`: `string`
- Code that'll undo the change done by `code` property.
- E.g. let's say `code` sets an environment variable as `setx POWERSHELL_TELEMETRY_OPTOUT 1`
- then `revertCode` should be doing `setx POWERSHELL_TELEMETRY_OPTOUT 0`
- ❗ Do not define if `call` is defined.
- `call`: ***[`FunctionCall`](#functioncall)*** | `[` ***[`FunctionCall`](#functioncall)*** `, ... ]` (may be **required**)
- A shared function or sequence of functions to call (called in order)
- ❗ If not defined `code` must be defined
- `name`: *`string`* **(required)**
- Script name.
- ❗ Must be unique throughout the [Collection](#collection).
- `code`: *`string`* **(conditionally required)**
- Code to execute when the user selects the script.
- 💡 If defined, it's best practice to also define `revertCode`.
- ❗ Cannot co-exist with `call`, define either `code` with optional `revertCode` or `call`.
- `revertCode`: *`string`*
- Reverts changes made by `code`.
- ❗ Cannot co-exist with `call`, define `revertCode` with `code` or `call`.
- `call`: ***[`FunctionCall`](#functioncall)*** | `[` ***[`FunctionCall`](#functioncall)*** `, ... ]` **(conditionally required)**
- A shared function or sequence of functions to call (called in order).
- ❗ Cannot co-exist with `code` or `revertCode`, define `code` with optional `revertCode` or `call`.
- `docs`: *`string`* | `[`*`string`*`, ... ]`
- Documentation pieces related to the script.
- Rendered as markdown.
- `recommend`: `"standard"` | `"strict"` | `undefined` (default)
- If not defined then the script will not be recommended
- If defined it can be either
- `standard`: Only non-breaking scripts without limiting OS functionality
- `strict`: Scripts that can break certain functionality in favor of privacy and security
- Markdown-formatted documentation related to the script.
- `recommend`: *`"standard"`* | *`"strict"`* | *`undefined`* (default: `undefined`)
- Sets recommendation level.
- Application will not recommend the script if `undefined`.
📖 For detailed guidelines, see [Script Guidelines](./script-guidelines.md).
### `FunctionCall`
- Describes a single call to a function by optionally providing values to its parameters.
- 👀 See [parameter substitution](./templating.md#parameter-substitution) for an example usage
Specifies a function call. It may require providing argument values to its parameters.
#### `FunctionCall` syntax
- `function`: *`string`* (**required**)
- `function`: *`string`* **(required)**
- Name of the function to call.
- ❗ Function with same name must defined in `functions` property of [Collection](#collection)
- `parameters`: `[ parameterName:` *`parameterValue`*`, ... ]`
- Defines key value dictionary for each parameter and its value
- E.g.
```yaml
parameters:
userDefinedParameterName: parameterValue
# ...
appName: Microsoft.WindowsFeedbackHub
```
- 💡 [Expressions (templating)](./templating.md#expressions) can be used as parameter value
- ❗ Function with same name must defined in `functions` property of [Collection](#collection).
- `parameters`: `[` *`parameterName: parameterValue`* `, ... ]`
- Key-value pairs representing function parameters and their corresponding argument values.
- 📖 See [parameter substitution](./templating.md#parameter-substitution) for an example usage.
- 💡 You can use [expressions (templating)](./templating.md#expressions) when providing argument values for parameters.
### `Function`
- Functions allow re-usable code throughout the defined scripts.
- Enables reusable code in scripts.
- Functions are templates compiled by privacy.sexy and uses special expression expressions.
- A function can be of two different types (just like [scripts](#script)):
- A function can be of two different types (like [scripts](#script)):
1. Inline function: a function with an inline code.
- Must define `code` property and optionally `revertCode` but not `call`.
- ❗ Requires `code` and optionally `revertCode`, but not `call`.
2. Caller function: a function that calls other functions.
- Must define `call` property but not `code` or `revertCode`.
- 👀 Read more on [Templating](./templating.md) for function expressions and [example usages](./templating.md#parameter-substitution).
- ❗ Requires `call`, but not `code` or `revertCode`.
- 📖 Read about function expressions in [Templating](./templating.md) with [example usages](./templating.md#parameter-substitution).
#### `Function` syntax
- `name`: *`string`* (**required**)
- `name`: *`string`* **(required)**
- Name of the function that scripts will use.
- Convention is to use camelCase, and be verbs.
- E.g. `uninstallStoreApp`
- ❗ Function names must be unique
- `parameters`: `[` ***[`FunctionParameter`](#functionparameter)*** `, ... ]`
- List of parameters that function code refers to.
- ❗ Must be defined to be able use in [`FunctionCall`](#functioncall) or [expressions (templating)](./templating.md#expressions)
`code`: *`string`* (**required** if `call` is undefined)
- Batch file commands that will be executed
- 💡 [Expressions (templating)](./templating.md#expressions) can be used in its value
- 💡 If defined, best practice to also define `revertCode`
- ❗ If not defined `call` must be defined
- ❗ Function names must be unique.
- ❗ Function names must follow camelCase and start with verbs (e.g., `uninstallStoreApp`).
- `parameters`: `[` ***[`FunctionParameter`](#functionparameter)*** `, ... ]` **(conditionally required)**
- Lists parameters used.
- ❗ Required to be able use in [`FunctionCall`](#functioncall) or [expressions (templating)](./templating.md#expressions).
- `code`: *`string`* **(conditionally required)**
- Code to execute when the user selects the script.
- 💡 You can use [expressions (templating)](./templating.md#expressions) in its value.
- 💡 If defined, it's best practice to also define `revertCode`.
- ❗ Cannot co-exist with `call`, define either `code` with optional `revertCode` or `call`.
- `revertCode`: *`string`*
- Code that'll undo the change done by `code` property.
- E.g. let's say `code` sets an environment variable as `setx POWERSHELL_TELEMETRY_OPTOUT 1`
- then `revertCode` should be doing `setx POWERSHELL_TELEMETRY_OPTOUT 0`
- 💡 [Expressions (templating)](./templating.md#expressions) can be used in code
- `call`: ***[`FunctionCall`](#functioncall)*** | `[` ***[`FunctionCall`](#functioncall)*** `, ... ]` (may be **required**)
- A shared function or sequence of functions to call (called in order)
- The parameter values that are sent can use [expressions (templating)](./templating.md#expressions)
- ❗ If not defined `code` must be defined
- Reverts changes made by `code`.
- 💡 You can use [expressions (templating)](./templating.md#expressions) in its value.
- ❗ Cannot co-exist with `call`, define `revertCode` with `code` or `call`.
- `call`: ***[`FunctionCall`](#functioncall)*** | `[` ***[`FunctionCall`](#functioncall)*** `, ... ]` **(conditionally required)**
- A shared function or sequence of functions to call (called in order).
- 💡 You can use [expressions (templating)](./templating.md#expressions) in argument values provided for parameters.
- ❗ Cannot co-exist with `code` or `revertCode`, define `code` with optional `revertCode` or `call`.
### `FunctionParameter`
- Defines a parameter that function requires optionally or mandatory.
- Its arguments are provided by a [Script](#script) through a [FunctionCall](#functioncall).
- Defines a single parameter that may require an argument value optionally or mandatory.
- A [`FunctionCall`](#functioncall) provides argument values by a caller.
- A caller can be a [Script](#script) or [Function](#function).
#### `FunctionParameter` syntax
- `name`: *`string`* (**required**)
- Name of the parameters that the function has.
- Parameter names must be defined to be used in [expressions (templating)](./templating.md#expressions).
- ❗ Parameter names must be unique and include alphanumeric characters only.
- `name`: *`string`* **(required)**
- Name of the parameter that the function has.
- ❗ Required for [expressions (templating)](./templating.md#expressions).
- ❗ Must be unique and consists of alphanumeric characters.
- `optional`: *`boolean`* (default: `false`)
- Specifies whether the caller [Script](#script) must provide any value for the parameter.
- If set to `false` i.e. an argument value is not optional then it expects a non-empty value for the variable;
- Otherwise it throws.
- 💡 Set it to `true` if a parameter is used conditionally;
- Indicates the caller must provide and argument value for the parameter.
- 💡 If set to `false` i.e. an argument value is not optional then it expects a non-empty value for the variable.
- E.g., in a [`with` expression](./templating.md#with).
- 💡 Set it to `true` if you will use its argument value conditionally;
- Or else set it to `false` for verbosity or do not define it as default value is `false` anyway.
- 💡 Can be used in conjunction with [`with` expression](./templating.md#with).
### `ScriptingDefinition`
- Defines global properties for scripting that's used throughout its parent [Collection](#collection).
Sets global scripting properties for a [Collection](#collection).
#### `ScriptingDefinition` syntax
- `language:` *`string`* (**required**)
- 📖 See [ScriptingLanguage.ts](./../src/domain/ScriptingLanguage.ts) enumeration for allowed values.
- `startCode:` *`string`* (**required**)
- Code that'll be inserted on top of user created script.
- Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
- `endCode:` *`string`* (**required**)
- Code that'll be inserted at the end of user created script.
- Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
## Naming guidelines
- Prioritize consistency throughout all names.
- Use an instruction format like "do this, do that" for clear, direct guidance. This approach reduces potential confusion and offers easy-to-follow steps. It provides specific, unambiguous instructions.
- Ensure brand names adhere to their official casing.
- Choose clear and uncomplicated language.
- Favor the terms:
- "Disable" over "Turn off"
- "Configure" over "Set up"
- "Clear" over "Erase" or "Clean"
- "Minimize" over "Limit" or "Reduce" (when it enhances clarity)
- "Remove" over "Uninstall"
- Structure your phrases for clarity.
- For instance, "Disable XX telemetry" or "Clear XX data" are preferred over "Clear data from XX", "Disable telemetry in XX", or "Clear data of XX".
- Use sentence case rather than Title Case.
- `language:` *`string`* **(required)**
- 📖 See [`ScriptingLanguage.ts`](./../src/domain/ScriptingLanguage.ts) enumeration for allowed values.
- `startCode:` *`string`* **(required)**
- Prepends the given code to the generated script file.
- 💡 You can use global variables such as `$homepage`, `$version`, `$date` via [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`.
- `endCode:` *`string`* **(required)**
- Appends to the given code to the generated script file.
- 💡 You can use global variables such as `$homepage`, `$version`, `$date` via [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`.

49
docs/desktop-vs-web-features.md
View File

@@ -9,6 +9,9 @@ This table highlights differences between the desktop and web versions of `priva
| [Auto-updates](#auto-updates) | 🟢 Available | 🟢 Available |
| [Logging](#logging) | 🟢 Available | 🔴 Not available |
| [Script execution](#script-execution) | 🟢 Available | 🔴 Not available |
| [Error handling](#error-handling) | 🟢 Advanced | 🟡 Limited |
| [Native dialogs](#native-dialogs) | 🟢 Available | 🔴 Not available |
| [Secure script execution/storage](#secure-script-executionstorage) | 🟢 Available | 🔴 Not available |
## Feature descriptions
@@ -48,7 +51,49 @@ Log file locations vary by operating system:
- Linux: `$HOME/.config/privacy.sexy/logs`
- Windows: `%APPDATA%\privacy.sexy\logs`
> 💡 privacy.sexy provides scripts to securely erase these logs.
### Script execution
Direct execution of scripts is possible in the desktop version, offering a more integrated experience.
This functionality is not present in the web version due to browser limitations.
The desktop version of privacy.sexy enables direct script execution, providing a seamless and integrated experience.
This direct execution capability isn't available in the web version due to inherent browser restrictions.
**Script execution history:**
For enhanced auditability and easier troubleshooting, the desktop version keeps a record of executed scripts in designated directories.
These locations vary based on the operating system:
- macOS: `$HOME/Library/Application Support/privacy.sexy/runs`
- Linux: `$HOME/.config/privacy.sexy/runs`
- Windows: `%APPDATA%\privacy.sexy\runs`
> 💡 privacy.sexy provides scripts to securely erase your script execution history.
### Error handling
The desktop version of privacy.sexy features advanced error handling capabilities.
It employs robust and reliable execution strategies, including self-healing mechanisms, and provides guidance and troubleshooting information to resolve issues effectively.
In contrast, the web version has more basic error handling due to browser limitations and the nature of web applications.
### Native dialogs
The desktop version uses native dialogs, offering more features and reliability compared to the browser's file system dialogs.
These native dialogs provide a more integrated and user-friendly experience, aligning with the operating system's standard interface and functionalities.
### Secure script execution/storage
**Integrity checks:**
The desktop version of privacy.sexy implements robust integrity checks for both script execution and storage.
Featuring tamper protection, the application actively verifies the integrity of script files before executing or saving them.
If the actual contents of a script file do not align with the expected contents, the application refuses to execute or save the script.
This proactive approach ensures only unaltered and verified scripts undergo processing, thereby enhancing both security and reliability.
Due to browser constraints, this feature is absent in the web version.
**Error handling:**
In scenarios where script execution or storage encounters failure, the desktop application initiates automated troubleshooting and self-healing processes.
It also guides users through potential issues with filesystem or third-party software, such as antivirus interventions.
Specifically, the application is capable of identifying when antivirus software blocks or removes a script, providing users with tailored error messages
and detailed resolution steps. This level of proactive error handling and user guidance enhances the application's security and reliability,
offering a feature not achievable in the web version due to browser limitations.

10
docs/development.md
View File

@@ -13,8 +13,11 @@ See [ci-cd.md](./ci-cd.md) for more information.
### Prerequisites
- Install Node >16.x.
- Install Node.js:
- Refer to [action.yml](./../.github/actions/setup-node/action.yml) for the minimum required version compatible with the automated workflows.
- 💡 Recommended: Use [`nvm`](https://github.com/nvm-sh/nvm) CLI to install and switch between Node.js versions.
- Install dependencies using `npm install` (or [`npm run install-deps`](#utility-scripts) for more options).
- For Visual Studio Code users, running the configuration script is recommended to optimize the IDE settings, as detailed in [utility scripts](#utility-scripts).
### Testing
@@ -77,8 +80,8 @@ See [ci-cd.md](./ci-cd.md) for more information.
- [**`npm run install-deps [-- <options>]`**](../scripts/npm-install.js):
- Manages NPM dependency installation, it offers capabilities like doing a fresh install, retries on network errors, and other features.
- For example, you can run `npm run install-deps -- --fresh` to do clean installation of dependencies.
- [**`./scripts/configure-vscode.sh`**](../scripts/configure-vscode.sh):
- This script checks and sets the necessary configurations for VSCode in `settings.json` file.
- [**`python ./scripts/configure_vscode.py`**](../scripts/configure_vscode.py):
- Optimizes Visual Studio Code settings and installs essential extensions, enhancing the development environment.
#### Automation scripts
@@ -94,3 +97,4 @@ See [ci-cd.md](./ci-cd.md) for more information.
You should use EditorConfig to follow project style.
For Visual Studio Code, [`.vscode/extensions.json`](./../.vscode/extensions.json) includes list of recommended extensions.
You can use [VSCode configuration script](#utility-scripts) to automatically install those.

18
docs/presentation.md
View File

@@ -32,7 +32,12 @@ The presentation layer uses an event-driven architecture for bidirectional react
## Visual design best-practices
Add visual clues for clickable items. It should be as clear as possible that they're interactable at first look without hovering. They should also have different visual state when hovering/touching on them that indicates that they are being clicked, which helps with accessibility.
- **Clickables**:
Add visual clues for clickable items.
It should be as clear as possible that they're interactable at first look without hovering.
They should also have different visual state when hovering/touching on them that indicates that they are being clicked, which helps with accessibility.
- **Borders**:
privacy.sexy prefers sharper edges in its design language.
## Application data
@@ -79,19 +84,22 @@ To add a new dependency:
## Shared UI components
Shared UI components promote consistency and simplifies the creation of the front-end.
Shared UI components ensure consistency and streamline front-end development.
In order to maintain portability and easy maintainability, the preference is towards using homegrown components over third-party ones or comprehensive UI frameworks like Quasar.
We use homegrown components over third-party solutions or comprehensive UI frameworks like Quasar to maintain portability and easy maintenance.
Shared components include:
- [ModalDialog.vue](./../src/presentation/components/Shared/Modal/ModalDialog.vue) is utilized for rendering modal windows.
- [TooltipWrapper.vue](./../src/presentation/components/Shared/TooltipWrapper.vue) acts as a wrapper for rendering tooltips.
- [ModalDialog.vue](./../src/presentation/components/Shared/Modal/ModalDialog.vue): Renders modal windows.
- [TooltipWrapper.vue](./../src/presentation/components/Shared/TooltipWrapper.vue): Provides tooltip functionality for improved information accessibility.
- [FlatButton.vue](./../src/presentation/components/Shared/FlatButton.vue): Creates flat-style buttons for a unified and consistent user interface.
## Desktop builds
Desktop builds uses `electron-vite` to bundle the code, and `electron-builder` to build and publish the packages.
Host system access is strictly controlled. The [`preloader`](./../src/presentation/electron/preload/) isolates logic that interacts with the host system. These functionalities are then securely exposed to the renderer process (Vue application) using context-bridging. [`ApiContextBridge.ts`](./../src/presentation/electron/preload/ContextBridging/ApiContextBridge.ts) handles the configuration of the exposed APIs, ensuring a secure bridge between the Electron and Vue layers.
## Styles
### Style location

24
docs/research/README.md Normal file
View File

@@ -0,0 +1,24 @@
# Research Documentation
Welcome to the research section of privacy.sexy.
This area houses in-depth technical research and analyses, serving as a resource for developers, contributors, and technology enthusiasts.
**Structure:**
This folder organizes research into topic-specific subdirectories like `windows`, `linux`, etc.
Each contains materials relevant to its subject.
**Contents:**
These documents offer comprehensive insights into the respective topics, supporting development and contributions.
**Contributing:**
Contributions to our research documentation are welcome.
If your research aligns with privacy.sexy goals, please consider adding it here.
See [`CONTRIBUTING.md`](./../../CONTRIBUTING.md) on more information about how to contribute.
**Usage:**
This information is available for educational and research purposes.
We support knowledge sharing and aim to enhance understanding of privacy and security technologies.

84
docs/research/windows/01-windows-10-1909-apps.txt Normal file
View File

@@ -0,0 +1,84 @@
Name PublisherId Category NonRemovable
---- ----------- -------- ------------
1527c705-839a-4832-9118-54d4Bd6a0c89 cw5n1h2txyewy System True
c5e2524a-ea46-4f67-841f-6a9465d9d515 cw5n1h2txyewy System True
E2A4F912-2574-4A75-9BB0-0D023378592B cw5n1h2txyewy System True
F46D4000-FD22-4DB4-AC8E-4E1DDDE828FE cw5n1h2txyewy System True
InputApp cw5n1h2txyewy System True
Microsoft.AAD.BrokerPlugin cw5n1h2txyewy System True
Microsoft.AccountsControl cw5n1h2txyewy System True
Microsoft.AsyncTextService 8wekyb3d8bbwe System True
Microsoft.BingWeather 8wekyb3d8bbwe Provisioned False
Microsoft.BioEnrollment cw5n1h2txyewy System True
Microsoft.CredDialogHost cw5n1h2txyewy System True
Microsoft.DesktopAppInstaller 8wekyb3d8bbwe Provisioned False
Microsoft.ECApp 8wekyb3d8bbwe System True
Microsoft.GetHelp 8wekyb3d8bbwe Provisioned False
Microsoft.Getstarted 8wekyb3d8bbwe Provisioned False
Microsoft.HEIFImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.LockApp cw5n1h2txyewy System True
Microsoft.Messaging 8wekyb3d8bbwe Provisioned False
Microsoft.Microsoft3DViewer 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdge 8wekyb3d8bbwe System True
Microsoft.MicrosoftEdgeDevToolsClient 8wekyb3d8bbwe System True
Microsoft.MicrosoftOfficeHub 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftSolitaireCollection 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftStickyNotes 8wekyb3d8bbwe Provisioned False
Microsoft.MixedReality.Portal 8wekyb3d8bbwe Provisioned False
Microsoft.MSPaint 8wekyb3d8bbwe Provisioned False
Microsoft.Office.OneNote 8wekyb3d8bbwe Provisioned False
Microsoft.OneConnect 8wekyb3d8bbwe Provisioned False
Microsoft.People 8wekyb3d8bbwe Provisioned False
Microsoft.PPIProjection cw5n1h2txyewy System True
Microsoft.Print3D 8wekyb3d8bbwe Provisioned False
Microsoft.ScreenSketch 8wekyb3d8bbwe Provisioned False
Microsoft.SkypeApp kzf8qxf38zg5c Provisioned False
Microsoft.StorePurchaseApp 8wekyb3d8bbwe Provisioned False
Microsoft.VP9VideoExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.Wallet 8wekyb3d8bbwe Provisioned False
Microsoft.WebMediaExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebpImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.Win32WebViewHost cw5n1h2txyewy System True
Microsoft.Windows.Apprep.ChxApp cw5n1h2txyewy System True
Microsoft.Windows.AssignedAccessLockApp cw5n1h2txyewy System True
Microsoft.Windows.CallingShellApp cw5n1h2txyewy System True
Microsoft.Windows.CapturePicker cw5n1h2txyewy System True
Microsoft.Windows.CloudExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.ContentDeliveryManager cw5n1h2txyewy System True
Microsoft.Windows.Cortana cw5n1h2txyewy System True
Microsoft.Windows.NarratorQuickStart 8wekyb3d8bbwe System True
Microsoft.Windows.OOBENetworkCaptivePortal cw5n1h2txyewy System True
Microsoft.Windows.OOBENetworkConnectionFlow cw5n1h2txyewy System True
Microsoft.Windows.ParentalControls cw5n1h2txyewy System True
Microsoft.Windows.PeopleExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.Photos 8wekyb3d8bbwe Provisioned False
Microsoft.Windows.PinningConfirmationDialog cw5n1h2txyewy System True
Microsoft.Windows.SecHealthUI cw5n1h2txyewy System True
Microsoft.Windows.SecureAssessmentBrowser cw5n1h2txyewy System True
Microsoft.Windows.ShellExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.StartMenuExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.XGpuEjectDialog cw5n1h2txyewy System True
Microsoft.WindowsAlarms 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCalculator 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCamera 8wekyb3d8bbwe Provisioned False
microsoft.windowscommunicationsapps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsFeedbackHub 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsMaps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsSoundRecorder 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsStore 8wekyb3d8bbwe Provisioned False
Microsoft.Xbox.TCUI 8wekyb3d8bbwe Provisioned False
Microsoft.XboxApp 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGameCallableUI cw5n1h2txyewy System True
Microsoft.XboxGameOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGamingOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxIdentityProvider 8wekyb3d8bbwe Provisioned False
Microsoft.XboxSpeechToTextOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.YourPhone 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneMusic 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneVideo 8wekyb3d8bbwe Provisioned False
Windows.CBSPreview cw5n1h2txyewy System True
windows.immersivecontrolpanel cw5n1h2txyewy System True
Windows.PrintDialog cw5n1h2txyewy System True

85
docs/research/windows/02-windows-10-20H2-apps.txt Normal file
View File

@@ -0,0 +1,85 @@
Name PublisherId Category NonRemovable
---- ----------- -------- ------------
1527c705-839a-4832-9118-54d4Bd6a0c89 cw5n1h2txyewy System True
c5e2524a-ea46-4f67-841f-6a9465d9d515 cw5n1h2txyewy System True
E2A4F912-2574-4A75-9BB0-0D023378592B cw5n1h2txyewy System True
F46D4000-FD22-4DB4-AC8E-4E1DDDE828FE cw5n1h2txyewy System True
Microsoft.549981C3F5F10 8wekyb3d8bbwe Provisioned False
Microsoft.AAD.BrokerPlugin cw5n1h2txyewy System True
Microsoft.AccountsControl cw5n1h2txyewy System True
Microsoft.AsyncTextService 8wekyb3d8bbwe System True
Microsoft.BingWeather 8wekyb3d8bbwe Provisioned False
Microsoft.BioEnrollment cw5n1h2txyewy System True
Microsoft.CredDialogHost cw5n1h2txyewy System True
Microsoft.DesktopAppInstaller 8wekyb3d8bbwe Provisioned False
Microsoft.ECApp 8wekyb3d8bbwe System True
Microsoft.GetHelp 8wekyb3d8bbwe Provisioned False
Microsoft.Getstarted 8wekyb3d8bbwe Provisioned False
Microsoft.HEIFImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.LockApp cw5n1h2txyewy System True
Microsoft.Microsoft3DViewer 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdge 8wekyb3d8bbwe System True
Microsoft.MicrosoftEdge.Stable 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdgeDevToolsClient 8wekyb3d8bbwe System True
Microsoft.MicrosoftOfficeHub 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftSolitaireCollection 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftStickyNotes 8wekyb3d8bbwe Provisioned False
Microsoft.MixedReality.Portal 8wekyb3d8bbwe Provisioned False
Microsoft.MSPaint 8wekyb3d8bbwe Provisioned False
Microsoft.Office.OneNote 8wekyb3d8bbwe Provisioned False
Microsoft.People 8wekyb3d8bbwe Provisioned False
Microsoft.ScreenSketch 8wekyb3d8bbwe Provisioned False
Microsoft.SkypeApp kzf8qxf38zg5c Provisioned False
Microsoft.StorePurchaseApp 8wekyb3d8bbwe Provisioned False
Microsoft.VCLibs.140.00 8wekyb3d8bbwe Provisioned False
Microsoft.VP9VideoExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.Wallet 8wekyb3d8bbwe Provisioned False
Microsoft.WebMediaExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebpImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.Win32WebViewHost cw5n1h2txyewy System True
Microsoft.Windows.Apprep.ChxApp cw5n1h2txyewy System True
Microsoft.Windows.AssignedAccessLockApp cw5n1h2txyewy System True
Microsoft.Windows.CallingShellApp cw5n1h2txyewy System True
Microsoft.Windows.CapturePicker cw5n1h2txyewy System True
Microsoft.Windows.CloudExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.ContentDeliveryManager cw5n1h2txyewy System True
Microsoft.Windows.NarratorQuickStart 8wekyb3d8bbwe System True
Microsoft.Windows.OOBENetworkCaptivePortal cw5n1h2txyewy System True
Microsoft.Windows.OOBENetworkConnectionFlow cw5n1h2txyewy System True
Microsoft.Windows.ParentalControls cw5n1h2txyewy System True
Microsoft.Windows.PeopleExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.Photos 8wekyb3d8bbwe Provisioned False
Microsoft.Windows.PinningConfirmationDialog cw5n1h2txyewy System True
Microsoft.Windows.Search cw5n1h2txyewy System True
Microsoft.Windows.SecHealthUI cw5n1h2txyewy System True
Microsoft.Windows.SecureAssessmentBrowser cw5n1h2txyewy System True
Microsoft.Windows.ShellExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.StartMenuExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.XGpuEjectDialog cw5n1h2txyewy System True
Microsoft.WindowsAlarms 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCalculator 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCamera 8wekyb3d8bbwe Provisioned False
microsoft.windowscommunicationsapps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsFeedbackHub 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsMaps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsSoundRecorder 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsStore 8wekyb3d8bbwe Provisioned False
Microsoft.Xbox.TCUI 8wekyb3d8bbwe Provisioned False
Microsoft.XboxApp 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGameCallableUI cw5n1h2txyewy System True
Microsoft.XboxGameOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGamingOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxIdentityProvider 8wekyb3d8bbwe Provisioned False
Microsoft.XboxSpeechToTextOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.YourPhone 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneMusic 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneVideo 8wekyb3d8bbwe Provisioned False
MicrosoftWindows.Client.CBS cw5n1h2txyewy System True
MicrosoftWindows.UndockedDevKit cw5n1h2txyewy System True
NcsiUwpApp 8wekyb3d8bbwe System True
Windows.CBSPreview cw5n1h2txyewy System True
windows.immersivecontrolpanel cw5n1h2txyewy System True
Windows.PrintDialog cw5n1h2txyewy System True

85
docs/research/windows/03-windows-10-21H2-apps.txt Normal file
View File

@@ -0,0 +1,85 @@
Name PublisherId Category NonRemovable
---- ----------- -------- ------------
1527c705-839a-4832-9118-54d4Bd6a0c89 cw5n1h2txyewy System True
c5e2524a-ea46-4f67-841f-6a9465d9d515 cw5n1h2txyewy System True
E2A4F912-2574-4A75-9BB0-0D023378592B cw5n1h2txyewy System True
F46D4000-FD22-4DB4-AC8E-4E1DDDE828FE cw5n1h2txyewy System True
Microsoft.549981C3F5F10 8wekyb3d8bbwe Provisioned False
Microsoft.AAD.BrokerPlugin cw5n1h2txyewy System True
Microsoft.AccountsControl cw5n1h2txyewy System True
Microsoft.AsyncTextService 8wekyb3d8bbwe System True
Microsoft.BingWeather 8wekyb3d8bbwe Provisioned False
Microsoft.BioEnrollment cw5n1h2txyewy System True
Microsoft.CredDialogHost cw5n1h2txyewy System True
Microsoft.DesktopAppInstaller 8wekyb3d8bbwe Provisioned False
Microsoft.ECApp 8wekyb3d8bbwe System True
Microsoft.GetHelp 8wekyb3d8bbwe Provisioned False
Microsoft.Getstarted 8wekyb3d8bbwe Provisioned False
Microsoft.HEIFImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.LockApp cw5n1h2txyewy System True
Microsoft.Microsoft3DViewer 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdge 8wekyb3d8bbwe System True
Microsoft.MicrosoftEdge.Stable 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdgeDevToolsClient 8wekyb3d8bbwe System True
Microsoft.MicrosoftOfficeHub 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftSolitaireCollection 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftStickyNotes 8wekyb3d8bbwe Provisioned False
Microsoft.MixedReality.Portal 8wekyb3d8bbwe Provisioned False
Microsoft.MSPaint 8wekyb3d8bbwe Provisioned False
Microsoft.Office.OneNote 8wekyb3d8bbwe Provisioned False
Microsoft.People 8wekyb3d8bbwe Provisioned False
Microsoft.ScreenSketch 8wekyb3d8bbwe Provisioned False
Microsoft.SkypeApp kzf8qxf38zg5c Provisioned False
Microsoft.StorePurchaseApp 8wekyb3d8bbwe Provisioned False
Microsoft.VCLibs.140.00 8wekyb3d8bbwe Provisioned False
Microsoft.VP9VideoExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.Wallet 8wekyb3d8bbwe Provisioned False
Microsoft.WebMediaExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebpImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.Win32WebViewHost cw5n1h2txyewy System True
Microsoft.Windows.Apprep.ChxApp cw5n1h2txyewy System True
Microsoft.Windows.AssignedAccessLockApp cw5n1h2txyewy System True
Microsoft.Windows.CallingShellApp cw5n1h2txyewy System True
Microsoft.Windows.CapturePicker cw5n1h2txyewy System True
Microsoft.Windows.CloudExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.ContentDeliveryManager cw5n1h2txyewy System True
Microsoft.Windows.NarratorQuickStart 8wekyb3d8bbwe System True
Microsoft.Windows.OOBENetworkCaptivePortal cw5n1h2txyewy System True
Microsoft.Windows.OOBENetworkConnectionFlow cw5n1h2txyewy System True
Microsoft.Windows.ParentalControls cw5n1h2txyewy System True
Microsoft.Windows.PeopleExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.Photos 8wekyb3d8bbwe Provisioned False
Microsoft.Windows.PinningConfirmationDialog cw5n1h2txyewy System True
Microsoft.Windows.Search cw5n1h2txyewy System True
Microsoft.Windows.SecHealthUI cw5n1h2txyewy System True
Microsoft.Windows.SecureAssessmentBrowser cw5n1h2txyewy System True
Microsoft.Windows.ShellExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.StartMenuExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.XGpuEjectDialog cw5n1h2txyewy System True
Microsoft.WindowsAlarms 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCalculator 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCamera 8wekyb3d8bbwe Provisioned False
microsoft.windowscommunicationsapps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsFeedbackHub 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsMaps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsSoundRecorder 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsStore 8wekyb3d8bbwe Provisioned False
Microsoft.Xbox.TCUI 8wekyb3d8bbwe Provisioned False
Microsoft.XboxApp 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGameCallableUI cw5n1h2txyewy System True
Microsoft.XboxGameOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGamingOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxIdentityProvider 8wekyb3d8bbwe Provisioned False
Microsoft.XboxSpeechToTextOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.YourPhone 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneMusic 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneVideo 8wekyb3d8bbwe Provisioned False
MicrosoftWindows.Client.CBS cw5n1h2txyewy System True
MicrosoftWindows.UndockedDevKit cw5n1h2txyewy System True
NcsiUwpApp 8wekyb3d8bbwe System True
Windows.CBSPreview cw5n1h2txyewy System True
windows.immersivecontrolpanel cw5n1h2txyewy System True
Windows.PrintDialog cw5n1h2txyewy System True

85
docs/research/windows/04-windows-10-22H2-apps.txt Normal file
View File

@@ -0,0 +1,85 @@
Name PublisherId Category NonRemovable
---- ----------- -------- ------------
1527c705-839a-4832-9118-54d4Bd6a0c89 cw5n1h2txyewy System True
c5e2524a-ea46-4f67-841f-6a9465d9d515 cw5n1h2txyewy System True
E2A4F912-2574-4A75-9BB0-0D023378592B cw5n1h2txyewy System True
F46D4000-FD22-4DB4-AC8E-4E1DDDE828FE cw5n1h2txyewy System True
Microsoft.549981C3F5F10 8wekyb3d8bbwe Provisioned False
Microsoft.AAD.BrokerPlugin cw5n1h2txyewy System True
Microsoft.AccountsControl cw5n1h2txyewy System True
Microsoft.AsyncTextService 8wekyb3d8bbwe System True
Microsoft.BingWeather 8wekyb3d8bbwe Provisioned False
Microsoft.BioEnrollment cw5n1h2txyewy System True
Microsoft.CredDialogHost cw5n1h2txyewy System True
Microsoft.DesktopAppInstaller 8wekyb3d8bbwe Provisioned False
Microsoft.ECApp 8wekyb3d8bbwe System True
Microsoft.GetHelp 8wekyb3d8bbwe Provisioned False
Microsoft.Getstarted 8wekyb3d8bbwe Provisioned False
Microsoft.HEIFImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.LockApp cw5n1h2txyewy System True
Microsoft.Microsoft3DViewer 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdge 8wekyb3d8bbwe System True
Microsoft.MicrosoftEdge.Stable 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdgeDevToolsClient 8wekyb3d8bbwe System True
Microsoft.MicrosoftOfficeHub 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftSolitaireCollection 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftStickyNotes 8wekyb3d8bbwe Provisioned False
Microsoft.MixedReality.Portal 8wekyb3d8bbwe Provisioned False
Microsoft.MSPaint 8wekyb3d8bbwe Provisioned False
Microsoft.Office.OneNote 8wekyb3d8bbwe Provisioned False
Microsoft.People 8wekyb3d8bbwe Provisioned False
Microsoft.ScreenSketch 8wekyb3d8bbwe Provisioned False
Microsoft.SkypeApp kzf8qxf38zg5c Provisioned False
Microsoft.StorePurchaseApp 8wekyb3d8bbwe Provisioned False
Microsoft.VCLibs.140.00 8wekyb3d8bbwe Provisioned False
Microsoft.VP9VideoExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.Wallet 8wekyb3d8bbwe Provisioned False
Microsoft.WebMediaExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebpImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.Win32WebViewHost cw5n1h2txyewy System True
Microsoft.Windows.Apprep.ChxApp cw5n1h2txyewy System True
Microsoft.Windows.AssignedAccessLockApp cw5n1h2txyewy System True
Microsoft.Windows.CallingShellApp cw5n1h2txyewy System True
Microsoft.Windows.CapturePicker cw5n1h2txyewy System True
Microsoft.Windows.CloudExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.ContentDeliveryManager cw5n1h2txyewy System True
Microsoft.Windows.NarratorQuickStart 8wekyb3d8bbwe System True
Microsoft.Windows.OOBENetworkCaptivePortal cw5n1h2txyewy System True
Microsoft.Windows.OOBENetworkConnectionFlow cw5n1h2txyewy System True
Microsoft.Windows.ParentalControls cw5n1h2txyewy System True
Microsoft.Windows.PeopleExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.Photos 8wekyb3d8bbwe Provisioned False
Microsoft.Windows.PinningConfirmationDialog cw5n1h2txyewy System True
Microsoft.Windows.Search cw5n1h2txyewy System True
Microsoft.Windows.SecHealthUI cw5n1h2txyewy System True
Microsoft.Windows.SecureAssessmentBrowser cw5n1h2txyewy System True
Microsoft.Windows.ShellExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.StartMenuExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.XGpuEjectDialog cw5n1h2txyewy System True
Microsoft.WindowsAlarms 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCalculator 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCamera 8wekyb3d8bbwe Provisioned False
microsoft.windowscommunicationsapps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsFeedbackHub 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsMaps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsSoundRecorder 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsStore 8wekyb3d8bbwe Provisioned False
Microsoft.Xbox.TCUI 8wekyb3d8bbwe Provisioned False
Microsoft.XboxApp 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGameCallableUI cw5n1h2txyewy System True
Microsoft.XboxGameOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGamingOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxIdentityProvider 8wekyb3d8bbwe Provisioned False
Microsoft.XboxSpeechToTextOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.YourPhone 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneMusic 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneVideo 8wekyb3d8bbwe Provisioned False
MicrosoftWindows.Client.CBS cw5n1h2txyewy System True
MicrosoftWindows.UndockedDevKit cw5n1h2txyewy System True
NcsiUwpApp 8wekyb3d8bbwe System True
Windows.CBSPreview cw5n1h2txyewy System True
windows.immersivecontrolpanel cw5n1h2txyewy System True
Windows.PrintDialog cw5n1h2txyewy System True

88
docs/research/windows/05-windows-11-21H2-apps.txt Normal file
View File

@@ -0,0 +1,88 @@
Name PublisherId Category NonRemovable
---- ----------- -------- ------------
1527c705-839a-4832-9118-54d4Bd6a0c89 cw5n1h2txyewy System True
c5e2524a-ea46-4f67-841f-6a9465d9d515 cw5n1h2txyewy System True
E2A4F912-2574-4A75-9BB0-0D023378592B cw5n1h2txyewy System True
F46D4000-FD22-4DB4-AC8E-4E1DDDE828FE cw5n1h2txyewy System True
Microsoft.549981C3F5F10 8wekyb3d8bbwe Provisioned False
Microsoft.AAD.BrokerPlugin cw5n1h2txyewy System True
Microsoft.AccountsControl cw5n1h2txyewy System True
Microsoft.AsyncTextService 8wekyb3d8bbwe System True
Microsoft.BingNews 8wekyb3d8bbwe Provisioned False
Microsoft.BingWeather 8wekyb3d8bbwe Provisioned False
Microsoft.BioEnrollment cw5n1h2txyewy System True
Microsoft.CredDialogHost cw5n1h2txyewy System True
Microsoft.DesktopAppInstaller 8wekyb3d8bbwe Provisioned True
Microsoft.ECApp 8wekyb3d8bbwe System True
Microsoft.GamingApp 8wekyb3d8bbwe Provisioned False
Microsoft.GetHelp 8wekyb3d8bbwe Provisioned False
Microsoft.Getstarted 8wekyb3d8bbwe Provisioned False
Microsoft.HEIFImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.LockApp cw5n1h2txyewy System True
Microsoft.MicrosoftEdge 8wekyb3d8bbwe System True
Microsoft.MicrosoftEdge.Stable 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdgeDevToolsClient 8wekyb3d8bbwe System True
Microsoft.MicrosoftOfficeHub 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftSolitaireCollection 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftStickyNotes 8wekyb3d8bbwe Provisioned False
Microsoft.OneDriveSync 8wekyb3d8bbwe Installed False
Microsoft.Paint 8wekyb3d8bbwe Provisioned False
Microsoft.People 8wekyb3d8bbwe Provisioned False
Microsoft.PowerAutomateDesktop 8wekyb3d8bbwe Provisioned False
Microsoft.ScreenSketch 8wekyb3d8bbwe Provisioned False
Microsoft.SecHealthUI 8wekyb3d8bbwe Provisioned True
Microsoft.StorePurchaseApp 8wekyb3d8bbwe Provisioned False
Microsoft.Todos 8wekyb3d8bbwe Provisioned False
Microsoft.UI.Xaml.2.4 8wekyb3d8bbwe Provisioned False
Microsoft.VCLibs.140.00 8wekyb3d8bbwe Provisioned False
Microsoft.VP9VideoExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebMediaExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebpImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.Win32WebViewHost cw5n1h2txyewy System True
Microsoft.Windows.Apprep.ChxApp cw5n1h2txyewy System True
Microsoft.Windows.AssignedAccessLockApp cw5n1h2txyewy System True
Microsoft.Windows.CallingShellApp cw5n1h2txyewy System True
Microsoft.Windows.CapturePicker cw5n1h2txyewy System True
Microsoft.Windows.CloudExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.ContentDeliveryManager cw5n1h2txyewy System True
Microsoft.Windows.NarratorQuickStart 8wekyb3d8bbwe System True
Microsoft.Windows.OOBENetworkCaptivePortal cw5n1h2txyewy System True
Microsoft.Windows.OOBENetworkConnectionFlow cw5n1h2txyewy System True
Microsoft.Windows.ParentalControls cw5n1h2txyewy System True
Microsoft.Windows.PeopleExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.Photos 8wekyb3d8bbwe Provisioned False
Microsoft.Windows.PinningConfirmationDialog cw5n1h2txyewy System True
Microsoft.Windows.Search cw5n1h2txyewy System True
Microsoft.Windows.SecureAssessmentBrowser cw5n1h2txyewy System True
Microsoft.Windows.ShellExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.StartMenuExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.XGpuEjectDialog cw5n1h2txyewy System True
Microsoft.WindowsAlarms 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCalculator 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCamera 8wekyb3d8bbwe Provisioned False
microsoft.windowscommunicationsapps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsFeedbackHub 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsMaps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsNotepad 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsSoundRecorder 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsStore 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsTerminal 8wekyb3d8bbwe Provisioned False
Microsoft.Xbox.TCUI 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGameCallableUI cw5n1h2txyewy System True
Microsoft.XboxGameOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGamingOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxIdentityProvider 8wekyb3d8bbwe Provisioned False
Microsoft.XboxSpeechToTextOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.YourPhone 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneMusic 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneVideo 8wekyb3d8bbwe Provisioned False
MicrosoftWindows.Client.CBS cw5n1h2txyewy System True
MicrosoftWindows.Client.WebExperience cw5n1h2txyewy Provisioned False
MicrosoftWindows.UndockedDevKit cw5n1h2txyewy System True
NcsiUwpApp 8wekyb3d8bbwe System True
Windows.CBSPreview cw5n1h2txyewy System True
windows.immersivecontrolpanel cw5n1h2txyewy System True
Windows.PrintDialog cw5n1h2txyewy System True

91
docs/research/windows/06-windows-11-22H2-apps.txt Normal file
View File

@@ -0,0 +1,91 @@
Name PublisherId Category NonRemovable
---- ----------- -------- ------------
1527c705-839a-4832-9118-54d4Bd6a0c89 cw5n1h2txyewy System True
c5e2524a-ea46-4f67-841f-6a9465d9d515 cw5n1h2txyewy System True
Clipchamp.Clipchamp yxz26nhyzhsrt Provisioned False
E2A4F912-2574-4A75-9BB0-0D023378592B cw5n1h2txyewy System True
F46D4000-FD22-4DB4-AC8E-4E1DDDE828FE cw5n1h2txyewy System True
Microsoft.549981C3F5F10 8wekyb3d8bbwe Provisioned False
Microsoft.AAD.BrokerPlugin cw5n1h2txyewy System True
Microsoft.AccountsControl cw5n1h2txyewy System True
Microsoft.AsyncTextService 8wekyb3d8bbwe System True
Microsoft.BingNews 8wekyb3d8bbwe Provisioned False
Microsoft.BingWeather 8wekyb3d8bbwe Provisioned False
Microsoft.BioEnrollment cw5n1h2txyewy System True
Microsoft.CredDialogHost cw5n1h2txyewy System True
Microsoft.DesktopAppInstaller 8wekyb3d8bbwe Provisioned True
Microsoft.ECApp 8wekyb3d8bbwe System True
Microsoft.GamingApp 8wekyb3d8bbwe Provisioned False
Microsoft.GetHelp 8wekyb3d8bbwe Provisioned False
Microsoft.Getstarted 8wekyb3d8bbwe Provisioned False
Microsoft.HEIFImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.HEVCVideoExtension 8wekyb3d8bbwe Provisioned False
Microsoft.LockApp cw5n1h2txyewy System True
Microsoft.MicrosoftEdge 8wekyb3d8bbwe System True
Microsoft.MicrosoftEdge.Stable 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdgeDevToolsClient 8wekyb3d8bbwe System True
Microsoft.MicrosoftOfficeHub 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftSolitaireCollection 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftStickyNotes 8wekyb3d8bbwe Provisioned False
Microsoft.Paint 8wekyb3d8bbwe Provisioned False
Microsoft.People 8wekyb3d8bbwe Provisioned False
Microsoft.PowerAutomateDesktop 8wekyb3d8bbwe Provisioned False
Microsoft.RawImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.ScreenSketch 8wekyb3d8bbwe Provisioned False
Microsoft.SecHealthUI 8wekyb3d8bbwe Provisioned True
Microsoft.StorePurchaseApp 8wekyb3d8bbwe Provisioned False
Microsoft.Todos 8wekyb3d8bbwe Provisioned False
Microsoft.VCLibs.140.00 8wekyb3d8bbwe Provisioned False
Microsoft.VP9VideoExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebMediaExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebpImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.Win32WebViewHost cw5n1h2txyewy System True
Microsoft.Windows.Apprep.ChxApp cw5n1h2txyewy System True
Microsoft.Windows.AssignedAccessLockApp cw5n1h2txyewy System True
Microsoft.Windows.CallingShellApp cw5n1h2txyewy System True
Microsoft.Windows.CapturePicker cw5n1h2txyewy System True
Microsoft.Windows.CloudExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.ContentDeliveryManager cw5n1h2txyewy System True
Microsoft.Windows.NarratorQuickStart 8wekyb3d8bbwe System True
Microsoft.Windows.OOBENetworkCaptivePortal cw5n1h2txyewy System True
Microsoft.Windows.OOBENetworkConnectionFlow cw5n1h2txyewy System True
Microsoft.Windows.ParentalControls cw5n1h2txyewy System True
Microsoft.Windows.PeopleExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.Photos 8wekyb3d8bbwe Provisioned False
Microsoft.Windows.PinningConfirmationDialog cw5n1h2txyewy System True
Microsoft.Windows.PrintQueueActionCenter cw5n1h2txyewy System True
Microsoft.Windows.SecureAssessmentBrowser cw5n1h2txyewy System True
Microsoft.Windows.ShellExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.StartMenuExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.XGpuEjectDialog cw5n1h2txyewy System True
Microsoft.WindowsAlarms 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCalculator 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCamera 8wekyb3d8bbwe Provisioned False
microsoft.windowscommunicationsapps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsFeedbackHub 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsMaps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsNotepad 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsSoundRecorder 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsStore 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsTerminal 8wekyb3d8bbwe Provisioned False
Microsoft.Xbox.TCUI 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGameCallableUI cw5n1h2txyewy System True
Microsoft.XboxGameOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGamingOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxIdentityProvider 8wekyb3d8bbwe Provisioned False
Microsoft.XboxSpeechToTextOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.YourPhone 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneMusic 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneVideo 8wekyb3d8bbwe Provisioned False
MicrosoftCorporationII.QuickAssist 8wekyb3d8bbwe Provisioned False
MicrosoftWindows.Client.CBS cw5n1h2txyewy System True
MicrosoftWindows.Client.Core cw5n1h2txyewy System True
MicrosoftWindows.Client.WebExperience cw5n1h2txyewy Provisioned False
MicrosoftWindows.UndockedDevKit cw5n1h2txyewy System True
NcsiUwpApp 8wekyb3d8bbwe System True
Windows.CBSPreview cw5n1h2txyewy System True
windows.immersivecontrolpanel cw5n1h2txyewy System True
Windows.PrintDialog cw5n1h2txyewy System True

91
docs/research/windows/07-windows-11-23H2-apps.txt Normal file
View File

@@ -0,0 +1,91 @@
Name PublisherId Category NonRemovable
---- ----------- -------- ------------
1527c705-839a-4832-9118-54d4Bd6a0c89 cw5n1h2txyewy System True
c5e2524a-ea46-4f67-841f-6a9465d9d515 cw5n1h2txyewy System True
Clipchamp.Clipchamp yxz26nhyzhsrt Provisioned False
E2A4F912-2574-4A75-9BB0-0D023378592B cw5n1h2txyewy System True
F46D4000-FD22-4DB4-AC8E-4E1DDDE828FE cw5n1h2txyewy System True
Microsoft.549981C3F5F10 8wekyb3d8bbwe Provisioned False
Microsoft.AAD.BrokerPlugin cw5n1h2txyewy System True
Microsoft.AccountsControl cw5n1h2txyewy System True
Microsoft.AsyncTextService 8wekyb3d8bbwe System True
Microsoft.BingNews 8wekyb3d8bbwe Provisioned False
Microsoft.BingWeather 8wekyb3d8bbwe Provisioned False
Microsoft.BioEnrollment cw5n1h2txyewy System True
Microsoft.CredDialogHost cw5n1h2txyewy System True
Microsoft.DesktopAppInstaller 8wekyb3d8bbwe Provisioned True
Microsoft.ECApp 8wekyb3d8bbwe System True
Microsoft.GamingApp 8wekyb3d8bbwe Provisioned False
Microsoft.GetHelp 8wekyb3d8bbwe Provisioned False
Microsoft.Getstarted 8wekyb3d8bbwe Provisioned False
Microsoft.HEIFImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.HEVCVideoExtension 8wekyb3d8bbwe Provisioned False
Microsoft.LockApp cw5n1h2txyewy System True
Microsoft.MicrosoftEdge.Stable 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftEdgeDevToolsClient 8wekyb3d8bbwe System True
Microsoft.MicrosoftOfficeHub 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftSolitaireCollection 8wekyb3d8bbwe Provisioned False
Microsoft.MicrosoftStickyNotes 8wekyb3d8bbwe Provisioned False
Microsoft.Paint 8wekyb3d8bbwe Provisioned False
Microsoft.People 8wekyb3d8bbwe Provisioned False
Microsoft.PowerAutomateDesktop 8wekyb3d8bbwe Provisioned False
Microsoft.RawImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.ScreenSketch 8wekyb3d8bbwe Provisioned False
Microsoft.SecHealthUI 8wekyb3d8bbwe Provisioned True
Microsoft.StorePurchaseApp 8wekyb3d8bbwe Provisioned False
Microsoft.Todos 8wekyb3d8bbwe Provisioned False
Microsoft.VCLibs.140.00 8wekyb3d8bbwe Provisioned False
Microsoft.VP9VideoExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebMediaExtensions 8wekyb3d8bbwe Provisioned False
Microsoft.WebpImageExtension 8wekyb3d8bbwe Provisioned False
Microsoft.Win32WebViewHost cw5n1h2txyewy System True
Microsoft.Windows.Apprep.ChxApp cw5n1h2txyewy System True
Microsoft.Windows.AssignedAccessLockApp cw5n1h2txyewy System True
Microsoft.Windows.CallingShellApp cw5n1h2txyewy System True
Microsoft.Windows.CapturePicker cw5n1h2txyewy System True
Microsoft.Windows.CloudExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.ContentDeliveryManager cw5n1h2txyewy System True
Microsoft.Windows.NarratorQuickStart 8wekyb3d8bbwe System True
Microsoft.Windows.OOBENetworkCaptivePortal cw5n1h2txyewy System True
Microsoft.Windows.OOBENetworkConnectionFlow cw5n1h2txyewy System True
Microsoft.Windows.ParentalControls cw5n1h2txyewy System True
Microsoft.Windows.PeopleExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.Photos 8wekyb3d8bbwe Provisioned False
Microsoft.Windows.PinningConfirmationDialog cw5n1h2txyewy System True
Microsoft.Windows.PrintQueueActionCenter cw5n1h2txyewy System True
Microsoft.Windows.SecureAssessmentBrowser cw5n1h2txyewy System True
Microsoft.Windows.ShellExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.StartMenuExperienceHost cw5n1h2txyewy System True
Microsoft.Windows.XGpuEjectDialog cw5n1h2txyewy System True
Microsoft.WindowsAlarms 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCalculator 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsCamera 8wekyb3d8bbwe Provisioned False
microsoft.windowscommunicationsapps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsFeedbackHub 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsMaps 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsNotepad 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsSoundRecorder 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsStore 8wekyb3d8bbwe Provisioned False
Microsoft.WindowsTerminal 8wekyb3d8bbwe Provisioned False
Microsoft.Xbox.TCUI 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGameCallableUI cw5n1h2txyewy System True
Microsoft.XboxGameOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxGamingOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.XboxIdentityProvider 8wekyb3d8bbwe Provisioned False
Microsoft.XboxSpeechToTextOverlay 8wekyb3d8bbwe Provisioned False
Microsoft.YourPhone 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneMusic 8wekyb3d8bbwe Provisioned False
Microsoft.ZuneVideo 8wekyb3d8bbwe Provisioned False
MicrosoftCorporationII.QuickAssist 8wekyb3d8bbwe Provisioned False
MicrosoftWindows.Client.CBS cw5n1h2txyewy System True
MicrosoftWindows.Client.Core cw5n1h2txyewy System True
MicrosoftWindows.Client.FileExp cw5n1h2txyewy System True
MicrosoftWindows.Client.WebExperience cw5n1h2txyewy Provisioned False
MicrosoftWindows.UndockedDevKit cw5n1h2txyewy System True
NcsiUwpApp 8wekyb3d8bbwe System True
Windows.CBSPreview cw5n1h2txyewy System True
windows.immersivecontrolpanel cw5n1h2txyewy System True
Windows.PrintDialog cw5n1h2txyewy System True

46
docs/research/windows/README.md Normal file
View File

@@ -0,0 +1,46 @@
# Research on Windows
In this section, we maintain a structured approach to our research on Windows.
The use of `01` prefixed file names aids in organizing and retrieving search results effectively.
## Apps
The PowerShell script below serves as a method for gathering detailed information about Windows packages.
```ps1
$allPackages = @()
$provisionedPackages = Get-AppxProvisionedPackage -Online
foreach ($installedPackage in Get-AppxPackage -AllUsers) {
if ($installedPackage.IsFramework -eq $true) {
continue
}
$allPackages += [PSCustomObject]@{
Name = $installedPackage.Name
PublisherId = $installedPackage.PublisherId
Category = if ($installedPackage.SignatureKind -eq "System") {
'System'
} elseif ($provisionedPackages | Where-Object { $_.DisplayName -eq $installedPackage.Name }) {
'Provisioned'
} else {
'Installed'
}
NonRemovable = $installedPackage.NonRemovable
}
}
foreach ($provisionedPackage in $provisionedPackages) {
if ($allPackages | Where-Object { $_.Name -eq $provisionedPackage.DisplayName }) {
continue
}
$allPackages += [PSCustomObject]@{
Name = $provisionedPackage.DisplayName
PublisherId = $provisionedPackage.PackageName -split '_' | Select-Object -Last 1
Category = 'Provisioned'
NonRemovable = $false
}
}
$allPackages `
| Sort-Object Name `
| Select-Object Name, PublisherId, Category, NonRemovable `
| Format-Table `
| Out-File -FilePath "$([System.Environment]::GetFolderPath('Desktop'))\apps.txt"
```

57
docs/script-guidelines.md Normal file
View File

@@ -0,0 +1,57 @@
# privacy.sexy Script Guidelines
Create a script for privacy.sexy by submitting a PR or creating an issue (details in [Extend Scripts](./../CONTRIBUTING.md#extend-scripts)).
As scripts are central to privacy.sexy and reach a global audience, their design is critical.
Key attributes of a good script:
- ✅ Well-referenced [documentation](#documentation).
- ✅ Utilizes [shared functions](#shared-functions).
- ✅ Has a [simple name](#name).
## Name
- Choose a title that is easy to understand for all users, regardless of technical skill, yet remains technically accurate.
- Focus on privacy implications, avoiding complex or overly technical jargon.
- Maintain consistency in naming, avoiding linguistic variations.
- Use action-oriented language for clarity and directness. Use an instruction format like "do this, do that" for clear, direct guidance.
- Respect the official casing of brand names.
- Choose clear and uncomplicated language.
- It should start with an imperative noun.
- Start with action verbs like `Clear`, `Disable`, `Remove`, `Configure`, `Minimize`, `Maximize`. While exceptions exist, these prefixes help maintain naming consistency.
- The scripts that modify hosts file should start with `Block ..`.
- Favor the terms:
- `Disable` over `Turn off`, `Stop`, `Prevent`
- `Configure` over `Set up`
- `Clear` over `Erase`, `Clean`
- `Minimize` over `Limit`, `Reduce`
- `Maximize` over `Extend`, `Delay`, `Postpone`, `Prolong`
- `Remove` over `Uninstall`
- Structure your phrases for clarity, examples:
- Prefer `Disable XX telemetry` over `Disable telemetry in XX`
- Prefer `Clear XX data` over `Clear data from XX`, or `Clear data of XX`.
- Use sentence case rather than Title Case.
## Documentation
- Use credible and reputable sources for references.
- Use archived links by using [archive.org](https://archive.org) or [archive.today](https://archive.today).
- Format archive.today links fully, for example: `https://archive.today/YYYYMMDDhhmmss/https://privacy.sexy`.
- Explain the default behavior if the script is not executed.
## Shared functions
Use existing shared functions when possible, like `DisableService` for disabling services,.
- 📖 Learn about templates in [templating.md](./templating.md).
- 📖 For syntax, see [collection-files.md](collection-files.md).
## Code
- Prefer [shared functions](#shared-functions); avoid custom code unless necessary.
- Keep code simple and compatible with older systems.
- Focus on reliability, ensuring the script is error-resistant, works on different locales and handles unexpected situations.
- Language selection:
- Windows: Use batch when simpler, otherwise PowerShell.
- macOS/Linux: Use bash when simpler, otherwise Python.
- Provide revert code to restore original/default settings when applicable.

4
docs/tests.md
View File

@@ -29,7 +29,9 @@ There are different types of tests executed:
- Evaluate individual components in isolation.
- Located in [`./tests/unit`](./../tests/unit).
- Achieve isolation using [stubs](./../tests/unit/shared/Stubs).
- Achieve isolation using stubs where you place:
- Common stubs in [`./shared/Stubs`](./../tests/unit/shared/Stubs),
- Component-specific stubs in same folder as test file.
- Include Vue component tests, enabled by `@vue/test-utils`.
#### Unit tests naming

2
electron-builder.cjs
View File

@@ -1,6 +1,6 @@
/* eslint-disable no-template-curly-in-string */
const { join } = require('path');
const { join } = require('node:path');
const { electronBundled, electronUnbundled } = require('./dist-dirs.json');
module.exports = {

12
electron.vite.config.ts
View File

@@ -1,7 +1,7 @@
import { resolve } from 'path';
import { mergeConfig, UserConfig } from 'vite';
import { resolve } from 'node:path';
import { mergeConfig, type UserConfig } from 'vite';
import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
import { getAliasesFromTsConfig, getClientEnvironmentVariables } from './vite-config-helper';
import { getAliases, getClientEnvironmentVariables } from './vite-config-helper';
import { createVueConfig } from './vite.config';
import distDirs from './dist-dirs.json' assert { type: 'json' };
@@ -54,7 +54,9 @@ function getSharedElectronConfig(options: {
},
rollupOptions: {
output: {
entryFileNames: '[name].cjs', // This is needed so `type="module"` works
// Mark: electron-esm-support
// This is needed so `type="module"` works
entryFileNames: '[name].cjs',
},
},
},
@@ -64,7 +66,7 @@ function getSharedElectronConfig(options: {
},
resolve: {
alias: {
...getAliasesFromTsConfig(),
...getAliases(),
},
},
};

1
img/architecture/app-ddd.drawio
View File

@@ -1 +0,0 @@
<mxfile host="Electron" modified="2021-01-31T12:32:01.751Z" agent="5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.1.8 Chrome/87.0.4280.88 Electron/11.1.1 Safari/537.36" etag="OTbSPW1ZOLwiPL6mt-j9" version="14.1.8" type="device"><diagram id="rhL8jzEM8kVVyiS98U7u" name="Page-1">3VtZd6JKF/01/dhZjA6PREjCXRbGFpM2L70QCYIoLsUI/PpvnwKcMD3cazrJl6wEqfHU3vvsKoz5Infm6e3KWU5ZPPGiL5IwSb/I+hdJUsUmflNBVhQoDaEo8FfBpCgS9wWDIPfKwqrZJph466OGSRxHSbA8LnTjxcJzk6MyZ7WKt8fNnuPoeNal43u1goHrRPXSx2CSTIvSlirsy++8wJ9WM4tCWTN3qsZlwXrqTOLtQZFsfJE7qzhOilfztONFhF2FS9Hv5pXaXWArb5H8Tofr+9ZNO9J+6A+Ljvr89N2aP5tflSq4JKtW7E0AQHkbr5Jp7McLJzL2pdereLOYeDSsgLt9m24cL1EoojD0kiQr2XQ2SYyiaTKPylovDZLv1P1KLe9GBzV6Wo7Mb7LqZpGssoNOdDs6rNt343dVv3WyimdeJ47iFV+f3OZfqKkDWGK6jjcr1/sJapUQnZXvJT9pJxXtCNGDCUp6br147iFSNFh5kZMEL8eSc0rl+rt2e3LxouT3T7iW3oXrHW9HrO1J/IC8yZfmjXfVVisnO2iwjINFsj4Y+Z4K0KD0TrnMzdI51ZP0/nlrSVRPBFNMv5fPbh3/QVHyu7rHgXcIV5L6m/bxeWSofCj7KMd9caJNOdP9yltj8Zg7XtSEcEzzdhok3mDpcFy2OCkcU/ocRNEBxhPVa02Uc+i3pLHcaFCPeJFUOjuzFVbBeqvES38KXlnbaB6nT5lN2/2eL1c7+/Rgv69OMxdHW268Z2qJR6n1m5klHmeW9B6pJb1Xav07h28fm7YoH5n2L9tLzebbm7zc+ixHxPcU1MWPDP/JPaSaV2vLZRS4l7DqI+OtWfezSt/nyGjwr3KEg/Li62ck/b6Lq8cuvnsYO7Rx6YyNN9/MxtXPkjwf6flK/pQHJLmWdHo8d4LLHo3G4mTyfBZ3UWjKbe8Njkbtk6Rq15NKUs4klfpWSaXUgDYXzysHiGzcZLPyLgr4c8v1XPcc4OOWqqjCGwDePDmLNs4A3vqbLtaoAe69eOXJ5hWgxT8H+tlrnAd60myPBeEyO0TrBNtmHdvmGWilt4K2WYN25S3jdZDE5eCfGl75zAb8V+Ft1a3CWCRB8hmxPfWFdwe3XQM3ma48ZxIs/P8DeN/dGsT6KX5Of165rO2OBU/2GufAFbyW0GpdBlwcTo7BFZQ6uOqVeAZe6a3grZ/X8DKY/OoZ6aNCLKniVfvDgazWQF4nTvKzI9qf42vo9H0ZFE9MQKze/XhHCP/K6euSGJ6+mXoORPHcu6lvh2H9mOUcviEiRLEfuJ8HULG+Nf1dQHdr2AOazamXG0eR5xKqH1efHw/N+lZUA289dZb0MpjzTywcQkUrh5QjLQr8BcoSeptoV9p1xl50T48UJHVZH8dJEs/RIKKKa8ed+ZyYowMXfaEJn0xbL4tPVtBBy6lunoOUqLwu49GnSUIfydAICenGnSyUq8CNF88BKF9duZhRusHe6uBC5VDHDZIuXn91FpOv4xV+U5FKh54budH88bDxwvUPaoKDUOtqWZ0pL/pk3aa/UpxyryhXap38fenl6a9vkp+ffvmP6f/qTOKxtxOB1Gr9GDjr9QXpl9TWVVP9PQlI5zUgvZkI6tv85xeB+EsRjBdb/AbFKX7wCtsyFdNbausLsS7LyhHlcuOqVT+QSO0zht9+K7Lr55HPT7bwS7Kf45XvLb6uvZg+TXDTAC83y4C/Z7v+Gi+TYB7k/ER2wZzfvUtSsS/XqK/0cUh9VfZfqH/Y3Hrj5vegr7fv2awhLwLh8cyf5n7J/CWIPS+Z8+Qe8V/RzamUteJWulm/gJzrlM58nfs7S3rKrpXxY7pxcyFw7r4Jrh6/dOWJPMlUmWXqizt3X1iobVmnnU/mbmDeTZZPd9/i+4GZWfYoMG+nkfM4iSe6ELBwKJnBteQ8Psj9eVtBm62paz4v103RCkzMfX/r+k/zaD1Gj/G8vXkamMV9R8wmj2l0P/gnmswfNmPp28wMldZIirKRlEbm7dNyfLttmwHL+uE/N0wwMLtFs6Qs9Om1unt9Z7bN0Mh6HfPlPkwXB33Vb7OH62/hLCjLEnfxsH6yi1i8+UM2zniUd9fTya3vPyFK2zawfkVkuulbubGxwijs2qbUBS7WQBC6oZtbgSBYgSJaobthoZl27SGVSyzQUqujCMweJqhPcfWZrW0se5Z17f6G5SMZ2KDtKLcGGq6mYOpMxb1gzY0MV8nKtOoKPA2fdajdKMOcVC4yiSVWpsiWbSbMZhjbxNgzxDFCHKZIYzEepylYmZAjnhx1PuJRmO6jD9aUz1LiqBsaQq8jpKjLMJZv6RjH9uWubaTd0M+tx3MxaRTTpmcPJawb8/Zlby4kWBvKZqqpu2jLtpbEUo4jxwBz2kOxWLshW4GWsUDJe3bfZ/kM8ZBmGOZkSq+j5bQ+FjJoiWL1wYO76el+jv4y4tiygaaijYR+GBu42po0sk1wxfEtr4hzoG27wIjpmkj4WzraZVgvjU9zow/TXQXrABY+8Qeeh4SJivi2TGcJHz830MYgvMCvoIBrzkcP2Fq8DeFPPDDU9WX0zxnVvcqpkHfDmQAN4DpUvYArdzv6/i02b/ttcyakPYo3NGl9W8xHvFPcWyg+QY5izQblGcadIXcFgc+n+xwP8CsWmhymLBBIu+grEB8CcEW8Ptqwck0zWgv0CDz1IepGGLt/Hs8O8BwoWyuc+Wifs9wKGdeARtio4C4j3Vvh0IfuVHALfg1gPEOsBtbaV0x9RPFluE8pZ4ABrn3oxkQe+FuKE30zWgt+gP1MfY1bU+8Tf9Ay8kDvS6RDi17nlAsjhWvtkdY7pHFIY4h1poInmluxOhrmdIUe8gXYiozj7UNrTCy4nAms0KqAssQKSQt96Jj0MiIfkICpwmwXGoWOwdPrsRJOrgz8ZCt/CLkubZYjZ0n3AmLJMJZq6W5i0Rj5CJgMEYNJmMiESY+0w/EeIUcpTkMs8sYAf8CNuAk06Arj5CbnGXy/ih/4Jx3JRR4b4hkdKtxrMi3t6S7laT7KMa+tCUUu+6RB4lXqwc8QP7h3eU739D7mIe0apPuUUUz6kDREeKo9e5T0qL3OuEYseFGXvIzy5/bVvCFNy/C3jPN2W3ohjYs1kkd0aT2hKUKLaW+gKD3ySfJpvQ//MEhjyG3kAvyD8XgE0qxI8XA/DYeUx7S2DJiCY7STXo0HOsB6uIZd1ZKXCTiBRkzu9z19BLwoj42kyEsT+qdYfLHUYIo4Ea+m0N6CeAXue1inRdjkM65dC+OAb8xtSow8PSM9ukmP+1c/ezVXqd4eCZQnaC+McoPvNSzTuIfhWuwPpF/eZkQ5grWT12jEPfj0aayUv87dpPBt4piwYrTPUR5R/iiv40T+oEHPtA/McuSpCK1k2DtoPInZ/4RYM+FAuSgSLvBZeBe45X7F84G4zfg+m1VtuYbLMu20n1/1IzzIO7G/kW/tvL+o2/Xf9ava0rqrGE777eYF5zx/4Iamfj0lbjAW4uvnZZ7Bi4wyV3gcx/WYAzGU9dcN2+7THqLynON7Vz8d5aSZ4UE8/dN4hAMcgAnXu0px4QwjHuC2679fB28LXWrJHhPe73DMPaaFXgn7Au+BdgbvPTZFjgAdySjXDB/RWbVu0jr5vQLfOq2vtFPUL+Kgmyst9/ZGcDrXM5wcLcxH5wHSqkjnLkv/Fv4Rd3WshDpW7BQr9V9j1flbWGEs7rczn2so9zOce6CxmVLstxo8XeBeWJwrNRWemvL9Jx8mHMP8aQo/ynCu86trNU9RT35J50BXIo/r2eRptNe78B/yf9pvyZ/orGls6ZxSxK3RtYxBK2OqYtCKmIr85vtOEdNTwwxadFLvtBf34fblCUroyniiyRV6hrrMnz8l+Uo9fuNJlurPoY0zz6GNP34Oxe3+v8qKTwHv/zVPNv4H</diagram></mxfile>

BIN
img/architecture/app-ddd.drawio.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 63 KiB

BIN
img/architecture/app-ddd.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 29 KiB

BIN
img/screenshot.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 116 KiB

6176
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

41
package.json
View File

@@ -1,9 +1,9 @@
{
"name": "privacy.sexy",
"version": "0.12.8",
"version": "0.13.0",
"private": true,
"slogan": "Now you have the choice",
"description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆",
"slogan": "Privacy is sexy",
"description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy.",
"author": "undergroundwires",
"type": "module",
"scripts": {
@@ -35,8 +35,8 @@
"dependencies": {
"@floating-ui/vue": "^1.0.2",
"@juggle/resize-observer": "^3.4.0",
"@types/markdown-it": "^13.0.7",
"ace-builds": "^1.30.0",
"cross-fetch": "^4.0.0",
"electron-log": "^5.0.1",
"electron-progressbar": "^2.1.0",
"electron-updater": "^6.1.4",
@@ -45,16 +45,16 @@
"vue": "^3.3.7"
},
"devDependencies": {
"@modyfi/vite-plugin-yaml": "^1.0.4",
"@rushstack/eslint-patch": "^1.5.1",
"@modyfi/vite-plugin-yaml": "^1.1.0",
"@rushstack/eslint-patch": "^1.6.1",
"@types/ace": "^0.0.49",
"@types/file-saver": "^2.0.5",
"@typescript-eslint/eslint-plugin": "^5.62.0",
"@typescript-eslint/parser": "^5.62.0",
"@vitejs/plugin-legacy": "^4.1.1",
"@vitejs/plugin-vue": "^4.4.0",
"@vue/eslint-config-airbnb-with-typescript": "^7.0.0",
"@vue/eslint-config-typescript": "^11.0.3",
"@typescript-eslint/eslint-plugin": "^6.17.0",
"@typescript-eslint/parser": "^6.17.0",
"@vitejs/plugin-legacy": "^5.3.2",
"@vitejs/plugin-vue": "^5.0.4",
"@vue/eslint-config-airbnb-with-typescript": "^8.0.0",
"@vue/eslint-config-typescript": "^12.0.0",
"@vue/test-utils": "^2.4.1",
"autoprefixer": "^10.4.16",
"cypress": "^13.3.1",
@@ -62,10 +62,10 @@
"electron-builder": "^24.6.4",
"electron-devtools-installer": "^3.2.0",
"electron-icon-builder": "^2.0.1",
"electron-vite": "^1.0.28",
"eslint": "^8.51.0",
"electron-vite": "^2.1.0",
"eslint": "^8.56.0",
"eslint-plugin-cypress": "^2.15.1",
"eslint-plugin-vue": "^9.17.0",
"eslint-plugin-vue": "^9.19.2",
"eslint-plugin-vuejs-accessibility": "^2.2.0",
"icon-gen": "^4.0.0",
"jsdom": "^22.1.0",
@@ -80,18 +80,15 @@
"svgexport": "^0.4.2",
"terser": "^5.21.0",
"tslib": "^2.6.2",
"typescript": "^5.2.2",
"vite": "^4.4.11",
"typescript": "^5.3.3",
"vite": "^5.1.6",
"vitest": "^0.34.6",
"vue-tsc": "^1.8.19",
"yaml-lint": "^1.7.0"
},
"//devDependencies": {
"terser": "Used by @vitejs/plugin-legacy for minification",
"@rushstack/eslint-patch": "Needed by @vue/eslint-config-typescript",
"@vue/eslint-config-typescript": "Cannot upgrade to 12.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58",
"@typescript-eslint/eslint-plugin": "Cannot upgrade to 6.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58",
"@typescript-eslint/parser": "Cannot upgrade to 6.X.X due to @vue/eslint-config-airbnb-with-typescript, https://github.com/vuejs/eslint-config-airbnb/issues/58"
"terser": "Used by `@vitejs/plugin-legacy` for minification",
"@rushstack/eslint-patch": "Needed by `@vue/eslint-config-typescript` and `@vue/eslint-config-airbnb-with-typescript`"
},
"homepage": "https://privacy.sexy",
"repository": {

74
scripts/configure-vscode.sh
View File

@@ -1,74 +0,0 @@
#!/usr/bin/env bash
# This script ensures that the '.vscode/settings.json' file exists and is configured correctly for ESLint validation on Vue and JavaScript files.
# See https://web.archive.org/web/20230801024405/https://eslint.vuejs.org/user-guide/#visual-studio-code
declare -r SETTINGS_FILE='.vscode/settings.json'
declare -ra CONFIG_KEYS=('vue' 'javascript' 'typescript')
declare -r TEMP_FILE="tmp.$$.json"
main() {
ensure_vscode_directory_exists
create_or_update_settings
}
ensure_vscode_directory_exists() {
local dir_name
dir_name=$(dirname "${SETTINGS_FILE}")
if [[ ! -d ${dir_name} ]]; then
mkdir -p "${dir_name}"
echo "🎉 Created directory: ${dir_name}"
fi
}
create_or_update_settings() {
if [[ ! -f ${SETTINGS_FILE} ]]; then
create_default_settings
else
add_or_update_eslint_validate
fi
}
create_default_settings() {
local default_validate
default_validate=$(printf '%s' "${CONFIG_KEYS[*]}" | jq -R -s -c -M 'split(" ")')
echo "{ \"eslint.validate\": ${default_validate} }" | jq '.' > "${SETTINGS_FILE}"
echo "🎉 Created default ${SETTINGS_FILE}"
}
add_or_update_eslint_validate() {
if ! jq -e '.["eslint.validate"]' "${SETTINGS_FILE}" >/dev/null; then
add_default_eslint_validate
else
update_eslint_validate
fi
}
add_default_eslint_validate() {
jq --argjson keys "$(printf '%s' "${CONFIG_KEYS[*]}" \
| jq -R -s -c 'split(" ")')" '. += {"eslint.validate": $keys}' "${SETTINGS_FILE}" > "${TEMP_FILE}"
replace_and_confirm
echo "🎉 Added default 'eslint.validate' to ${SETTINGS_FILE}"
}
update_eslint_validate() {
local existing_keys
existing_keys=$(jq '.["eslint.validate"]' "${SETTINGS_FILE}")
for key in "${CONFIG_KEYS[@]}"; do
if ! echo "${existing_keys}" | jq 'index("'"${key}"'")' >/dev/null; then
jq '.["eslint.validate"] += ["'"${key}"'"]' "${SETTINGS_FILE}" > "${TEMP_FILE}"
mv "${TEMP_FILE}" "${SETTINGS_FILE}"
echo "🎉 Updated 'eslint.validate' in ${SETTINGS_FILE} for ${key}"
else
echo "⏩️ No updated needed for ${key} ${SETTINGS_FILE}."
fi
done
}
replace_and_confirm() {
if mv "${TEMP_FILE}" "${SETTINGS_FILE}"; then
echo "🎉 Updated ${SETTINGS_FILE}"
fi
}
main

181
scripts/configure_vscode.py Executable file
View File

@@ -0,0 +1,181 @@
"""
This script configures project-level VSCode settings in '.vscode/settings.json' for
development and installs recommended extensions from '.vscode/extensions.json'.
"""
# pylint: disable=missing-function-docstring
import os
import json
from pathlib import Path
import subprocess
import sys
import re
from typing import Any, Optional
from shutil import which
VSCODE_SETTINGS_JSON_FILE: str = '.vscode/settings.json'
VSCODE_EXTENSIONS_JSON_FILE: str = '.vscode/extensions.json'
def main() -> None:
ensure_vscode_directory_exists()
ensure_setting_file_exists()
add_or_update_settings()
install_recommended_extensions()
def ensure_vscode_directory_exists() -> None:
vscode_directory_path = os.path.dirname(VSCODE_SETTINGS_JSON_FILE)
try:
os.makedirs(vscode_directory_path, exist_ok=True)
print_success(f"Created or verified directory: {vscode_directory_path}")
except OSError as error:
print_error(f"Error handling directory {vscode_directory_path}: {error}")
def ensure_setting_file_exists() -> None:
try:
if os.path.isfile(VSCODE_SETTINGS_JSON_FILE):
print_success(f"VSCode settings file exists: {VSCODE_SETTINGS_JSON_FILE}")
return
with open(VSCODE_SETTINGS_JSON_FILE, 'w', encoding='utf-8') as file:
json.dump({}, file, indent=4)
print_success(f"Created empty {VSCODE_SETTINGS_JSON_FILE}")
except IOError as error:
print_error(f"Error creating file {VSCODE_SETTINGS_JSON_FILE}: {error}")
print(f"📄 Created empty {VSCODE_SETTINGS_JSON_FILE}")
def add_or_update_settings() -> None:
configure_setting_key('eslint.validate', ['vue', 'javascript', 'typescript'])
# Set ESLint validation for specific file types.
# Details: # pylint: disable-next=line-too-long
# - https://web.archive.org/web/20230801024405/https://eslint.vuejs.org/user-guide/#visual-studio-code
configure_setting_key('terminal.integrated.env.linux', {"GTK_PATH": ""})
# Unset GTK_PATH on Linux for Electron development in sandboxed environments
# like Snap or Flatpak VSCode installations, enabling script execution.
# Details: # pylint: disable-next=line-too-long
# - https://archive.ph/2024.01.06-003914/https://github.com/microsoft/vscode/issues/179274, https://web.archive.org/web/20240106003915/https://github.com/microsoft/vscode/issues/179274
def configure_setting_key(configuration_key: str, desired_value: Any) -> None:
try:
with open(VSCODE_SETTINGS_JSON_FILE, 'r+', encoding='utf-8') as file:
settings: dict = json.load(file)
if configuration_key in settings:
actual_value = settings[configuration_key]
if actual_value == desired_value:
print_skip(f"Already configured as desired: \"{configuration_key}\"")
return
settings[configuration_key] = desired_value
file.seek(0)
json.dump(settings, file, indent=4)
file.truncate()
print_success(f"Added or updated configuration: {configuration_key}")
except json.JSONDecodeError:
print_error(f"Failed to update JSON for key {configuration_key}.")
def install_recommended_extensions() -> None:
if not os.path.isfile(VSCODE_EXTENSIONS_JSON_FILE):
print_error(
f"The extensions.json file does not exist in the path: {VSCODE_EXTENSIONS_JSON_FILE}."
)
return
with open(VSCODE_EXTENSIONS_JSON_FILE, 'r', encoding='utf-8') as file:
json_content: str = remove_json_comments(file.read())
try:
data: dict = json.loads(json_content)
extensions: list[str] = data.get("recommendations", [])
if not extensions:
print_skip(f"No recommendations found in the {VSCODE_EXTENSIONS_JSON_FILE} file.")
return
vscode_cli_path = locate_vscode_cli()
if vscode_cli_path is None:
print_error('Visual Studio Code CLI (`code`) tool not found.')
return
install_vscode_extensions(vscode_cli_path, extensions)
except json.JSONDecodeError:
print_error(f"Invalid JSON in {VSCODE_EXTENSIONS_JSON_FILE}")
def locate_vscode_cli() -> Optional[str]:
vscode_alias = which('code') # More reliable than using `code`, especially on Windows.
if vscode_alias:
return vscode_alias
potential_vscode_cli_paths = [
'/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code' # macOS VS Code may not register 'code' command in PATH
]
for vscode_cli_candidate_path in potential_vscode_cli_paths:
if Path(vscode_cli_candidate_path).is_file():
return vscode_cli_candidate_path
return None
def remove_json_comments(json_like: str) -> str:
pattern: str = r'(?:"(?:\\.|[^"\\])*"|/\*[\s\S]*?\*/|//.*)|([^:]//.*$)'
return re.sub(
pattern,
lambda m: '' if m.group(1) else m.agroup(0), json_like, flags=re.MULTILINE,
)
def install_vscode_extensions(vscode_cli_path: str, extensions: list[str]) -> None:
successful_installations = 0
for ext in extensions:
try:
result = subprocess.run(
[vscode_cli_path, "--install-extension", ext],
check=True,
capture_output=True,
text=True,
)
if "already installed" in result.stdout:
print_skip(f"Created or verified directory: {ext}")
else:
print_success(f"Installed extension: {ext}")
successful_installations += 1
print_subprocess_output(result)
except subprocess.CalledProcessError as e:
print_subprocess_output(e)
print_error(f"Failed to install extension: {ext}")
except FileNotFoundError:
print_error(' '.join([
f"Visual Studio Code CLI tool not found: {vscode_cli_path}."
f"Could not install extension: {ext}",
]))
except Exception as e: # pylint: disable=broad-except
print_error(' '.join([
f"Failed to install extension '{ext}'.",
f"Attempted using Visual Studio Code CLI at: '{vscode_cli_path}'.",
f"Encountered error: {e}",
]))
total_extensions = len(extensions)
print_installation_results(successful_installations, total_extensions)
def print_subprocess_output(result: subprocess.CompletedProcess[str]) -> None:
output = '\n'.join([text.strip() for text in [result.stdout, result.stderr] if text])
if not output:
return
formatted_output = '\t' + output.strip().replace('\n', '\n\t')
print(formatted_output)
def print_installation_results(successful_installations: int, total_extensions: int) -> None:
if successful_installations == total_extensions:
print_success(
f"Successfully installed or verified all {total_extensions} recommended extensions."
)
elif successful_installations > 0:
print_warning(
f"Partially successful: Installed or verified {successful_installations} "
f"out of {total_extensions} recommended extensions."
)
else:
print_error("Failed to install any of the recommended extensions.")
def print_error(message: str) -> None:
print(f"💀 Error: {message}", file=sys.stderr)
def print_success(message: str) -> None:
print(f"✅ Success: {message}")
def print_skip(message: str) -> None:
print(f"⏩ Skipped: {message}")
def print_warning(message: str) -> None:
print(f"⚠️ Warning: {message}", file=sys.stderr)
if __name__ == "__main__":
main()

8
scripts/logo-update.js
View File

@@ -1,8 +1,8 @@
#!/usr/bin/env bash
import { resolve, join } from 'path';
import { rm, mkdtemp, stat } from 'fs/promises';
import { spawn } from 'child_process';
import { URL, fileURLToPath } from 'url';
import { resolve, join } from 'node:path';
import { rm, mkdtemp, stat } from 'node:fs/promises';
import { spawn } from 'node:child_process';
import { URL, fileURLToPath } from 'node:url';
class Paths {
constructor(selfDirectory) {

8
scripts/npm-install.js
View File

@@ -35,10 +35,10 @@ Note:
Example: npm run install-deps -- --fresh --non-deterministic
*/
import { exec } from 'child_process';
import { resolve } from 'path';
import { access, rm, unlink } from 'fs/promises';
import { constants } from 'fs';
import { exec } from 'node:child_process';
import { resolve } from 'node:path';
import { access, rm, unlink } from 'node:fs/promises';
import { constants } from 'node:fs';
const MAX_RETRIES = 5;
const RETRY_DELAY_IN_MS = 5 /* seconds */ * 1000;

4
scripts/print-dist-dir.js
View File

@@ -12,8 +12,8 @@
* --web Path for the web application
*/
import { resolve } from 'path';
import { readFile } from 'fs/promises';
import { resolve } from 'node:path';
import { readFile } from 'node:fs/promises';
const DIST_DIRS_JSON_FILE_PATH = resolve(process.cwd(), 'dist-dirs.json'); // cannot statically import because ESLint does not support it https://github.com/eslint/eslint/discussions/15305
const CLI_ARGUMENTS = process.argv.slice(2);

6
scripts/verify-build-artifacts.js
View File

@@ -13,9 +13,9 @@
* --web Verify artifacts for the web application.
*/
import { access, readdir } from 'fs/promises';
import { exec } from 'child_process';
import { resolve } from 'path';
import { access, readdir } from 'node:fs/promises';
import { exec } from 'node:child_process';
import { resolve } from 'node:path';
const PROCESS_ARGUMENTS = process.argv.slice(2);
const PRINT_DIST_DIR_SCRIPT_BASE_COMMAND = 'node scripts/print-dist-dir';

32
src/TypeHelpers.ts
View File

@@ -14,3 +14,35 @@ export type ConstructorArguments<T> =
export type FunctionKeys<T> = {
[K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? K : never;
}[keyof T];
export function isString(value: unknown): value is string {
return typeof value === 'string';
}
export function isNumber(value: unknown): value is number {
return typeof value === 'number';
}
export function isBoolean(value: unknown): value is boolean {
return typeof value === 'boolean';
}
export function isFunction(value: unknown): value is (...args: unknown[]) => unknown {
return typeof value === 'function';
}
export function isArray(value: unknown): value is Array<unknown> {
return Array.isArray(value);
}
export function isPlainObject(
variable: unknown,
): variable is object & Record<string, unknown> {
return Boolean(variable) // the data type of null is an object
&& typeof variable === 'object'
&& !Array.isArray(variable);
}
export function isNullOrUndefined(value: unknown): value is (null | undefined) {
return typeof value === 'undefined' || value === null;
}

4
src/application/ApplicationFactory.ts
View File

@@ -1,7 +1,7 @@
import { IApplication } from '@/domain/IApplication';
import type { IApplication } from '@/domain/IApplication';
import { AsyncLazy } from '@/infrastructure/Threading/AsyncLazy';
import { IApplicationFactory } from './IApplicationFactory';
import { parseApplication } from './Parser/ApplicationParser';
import type { IApplicationFactory } from './IApplicationFactory';
export type ApplicationGetterType = () => IApplication;
const ApplicationGetter: ApplicationGetterType = parseApplication;

37
src/application/CodeRunner/CodeRunner.ts Normal file
View File

@@ -0,0 +1,37 @@
export interface CodeRunner {
runCode(
code: string,
fileExtension: string,
): Promise<CodeRunOutcome>;
}
export type CodeRunOutcome = SuccessfulCodeRun | FailedCodeRun;
export type CodeRunErrorType =
| 'FileWriteError'
| 'FileReadbackVerificationError'
| 'FilePathGenerationError'
| 'UnsupportedOperatingSystem'
| 'FileExecutionError'
| 'DirectoryCreationError'
| 'UnexpectedError';
interface CodeRunStatus {
readonly success: boolean;
readonly error?: CodeRunError;
}
interface SuccessfulCodeRun extends CodeRunStatus {
readonly success: true;
readonly error?: undefined;
}
export interface FailedCodeRun extends CodeRunStatus {
readonly success: false;
readonly error: CodeRunError;
}
export interface CodeRunError {
readonly type: CodeRunErrorType;
readonly message: string;
}

1
src/application/CodeRunner/ScriptFilename.ts Normal file
View File

@@ -0,0 +1 @@
export const ScriptFilename = 'privacy-script' as const;

7
src/application/Common/CustomError.ts
View File

@@ -1,3 +1,5 @@
import { isFunction } from '@/TypeHelpers';
/*
Provides a unified and resilient way to extend errors across platforms.
@@ -50,8 +52,3 @@ function ensureStackTrace(target: Error) {
}
captureStackTrace(target, target.constructor);
}
// eslint-disable-next-line @typescript-eslint/ban-types
function isFunction(func: unknown): func is Function {
return typeof func === 'function';
}

6
src/application/Common/Enum.ts
View File

@@ -1,3 +1,5 @@
import { isString } from '@/TypeHelpers';
// Because we cannot do "T extends enum" 😞 https://github.com/microsoft/TypeScript/issues/30611
export type EnumType = number | string;
export type EnumVariable<T extends EnumType, TEnumValue extends EnumType>
@@ -23,7 +25,7 @@ function parseEnumValue<T extends EnumType, TEnumValue extends EnumType>(
if (!value) {
throw new Error(`missing ${enumName}`);
}
if (typeof value !== 'string') {
if (!isString(value)) {
throw new Error(`unexpected type of ${enumName}: "${typeof value}"`);
}
const casedValue = getEnumNames(enumVariable)
@@ -40,7 +42,7 @@ export function getEnumNames
): string[] {
return Object
.values(enumVariable)
.filter((enumMember) => typeof enumMember === 'string') as string[];
.filter((enumMember): enumMember is string => isString(enumMember));
}
export function getEnumValues<T extends EnumType, TEnumValue extends EnumType>(

2
src/application/Common/ScriptingLanguage/ScriptingLanguageFactory.ts
View File

@@ -1,6 +1,6 @@
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
import { assertInRange } from '@/application/Common/Enum';
import { IScriptingLanguageFactory } from './IScriptingLanguageFactory';
import type { IScriptingLanguageFactory } from './IScriptingLanguageFactory';
type Getter<T> = () => T;

2
src/application/Common/Timing/BatchedDebounce.ts
View File

@@ -1,5 +1,5 @@
import { PlatformTimer } from './PlatformTimer';
import { TimeoutType, Timer } from './Timer';
import type { TimeoutType, Timer } from './Timer';
export function batchedDebounce<T>(
callback: (batches: readonly T[]) => void,

2
src/application/Common/Timing/PlatformTimer.ts
View File

@@ -1,4 +1,4 @@
import { Timer } from './Timer';
import type { Timer } from './Timer';
export const PlatformTimer: Timer = {
setTimeout: (callback, ms) => setTimeout(callback, ms),

4
src/application/Common/Timing/Throttle.ts
View File

@@ -1,7 +1,7 @@
import { Timer, TimeoutType } from './Timer';
import { PlatformTimer } from './PlatformTimer';
import type { Timer, TimeoutType } from './Timer';
export type CallbackType = (..._: unknown[]) => void;
export type CallbackType = (..._: readonly unknown[]) => void;
export function throttle(
callback: CallbackType,

8
src/application/Context/ApplicationContext.ts
View File

@@ -1,11 +1,11 @@
import { IApplication } from '@/domain/IApplication';
import type { IApplication } from '@/domain/IApplication';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { EventSource } from '@/infrastructure/Events/EventSource';
import { assertInRange } from '@/application/Common/Enum';
import { CategoryCollectionState } from './State/CategoryCollectionState';
import { ICategoryCollectionState } from './State/ICategoryCollectionState';
import { IApplicationContext, IApplicationContextChangedEvent } from './IApplicationContext';
import type { IApplicationContext, IApplicationContextChangedEvent } from './IApplicationContext';
import type { ICategoryCollectionState } from './State/ICategoryCollectionState';
type StateMachine = Map<OperatingSystem, ICategoryCollectionState>;

10
src/application/Context/ApplicationContextFactory.ts
View File

@@ -1,14 +1,14 @@
import { IApplicationContext } from '@/application/Context/IApplicationContext';
import type { IApplicationContext } from '@/application/Context/IApplicationContext';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { IApplication } from '@/domain/IApplication';
import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
import { IApplicationFactory } from '../IApplicationFactory';
import type { IApplication } from '@/domain/IApplication';
import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
import { ApplicationFactory } from '../ApplicationFactory';
import { ApplicationContext } from './ApplicationContext';
import type { IApplicationFactory } from '../IApplicationFactory';
export async function buildContext(
factory: IApplicationFactory = ApplicationFactory.Current,
environment = RuntimeEnvironment.CurrentEnvironment,
environment = CurrentEnvironment,
): Promise<IApplicationContext> {
const app = await factory.getApp();
const os = getInitialOs(app, environment.os);

6
src/application/Context/IApplicationContext.ts
View File

@@ -1,7 +1,7 @@
import { OperatingSystem } from '@/domain/OperatingSystem';
import { IEventSource } from '@/infrastructure/Events/IEventSource';
import { IApplication } from '@/domain/IApplication';
import { ICategoryCollectionState, IReadOnlyCategoryCollectionState } from './State/ICategoryCollectionState';
import type { IEventSource } from '@/infrastructure/Events/IEventSource';
import type { IApplication } from '@/domain/IApplication';
import type { ICategoryCollectionState, IReadOnlyCategoryCollectionState } from './State/ICategoryCollectionState';
export interface IReadOnlyApplicationContext {
readonly app: IApplication;

20
src/application/Context/State/CategoryCollectionState.ts
View File

@@ -1,12 +1,12 @@
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { UserFilter } from './Filter/UserFilter';
import { IUserFilter } from './Filter/IUserFilter';
import { AdaptiveFilterContext } from './Filter/AdaptiveFilterContext';
import { ApplicationCode } from './Code/ApplicationCode';
import { UserSelection } from './Selection/UserSelection';
import { ICategoryCollectionState } from './ICategoryCollectionState';
import { IApplicationCode } from './Code/IApplicationCode';
import { UserSelectionFacade } from './Selection/UserSelectionFacade';
import type { FilterContext } from './Filter/FilterContext';
import type { UserSelection } from './Selection/UserSelection';
import type { ICategoryCollectionState } from './ICategoryCollectionState';
import type { IApplicationCode } from './Code/IApplicationCode';
export class CategoryCollectionState implements ICategoryCollectionState {
public readonly os: OperatingSystem;
@@ -15,7 +15,7 @@ export class CategoryCollectionState implements ICategoryCollectionState {
public readonly selection: UserSelection;
public readonly filter: IUserFilter;
public readonly filter: FilterContext;
public constructor(
public readonly collection: ICategoryCollection,
@@ -45,7 +45,7 @@ const DefaultSelectionFactory: SelectionFactory = (
) => new UserSelectionFacade(...params);
export type FilterFactory = (
...params: ConstructorParameters<typeof UserFilter>
) => IUserFilter;
...params: ConstructorParameters<typeof AdaptiveFilterContext>
) => FilterContext;
const DefaultFilterFactory: FilterFactory = (...params) => new UserFilter(...params);
const DefaultFilterFactory: FilterFactory = (...params) => new AdaptiveFilterContext(...params);

12
src/application/Context/State/Code/ApplicationCode.ts
View File

@@ -1,13 +1,13 @@
import { EventSource } from '@/infrastructure/Events/EventSource';
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import { ReadonlyScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
import type { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import type { ReadonlyScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
import { CodeChangedEvent } from './Event/CodeChangedEvent';
import { CodePosition } from './Position/CodePosition';
import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
import { UserScriptGenerator } from './Generation/UserScriptGenerator';
import { IApplicationCode } from './IApplicationCode';
import { IUserScriptGenerator } from './Generation/IUserScriptGenerator';
import type { IUserScriptGenerator } from './Generation/IUserScriptGenerator';
import type { ICodeChangedEvent } from './Event/ICodeChangedEvent';
import type { IApplicationCode } from './IApplicationCode';
export class ApplicationCode implements IApplicationCode {
public readonly changed = new EventSource<ICodeChangedEvent>();

8
src/application/Context/State/Code/Event/CodeChangedEvent.ts
View File

@@ -1,7 +1,7 @@
import { IScript } from '@/domain/IScript';
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import { ICodeChangedEvent } from './ICodeChangedEvent';
import type { IScript } from '@/domain/IScript';
import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import type { ICodeChangedEvent } from './ICodeChangedEvent';
export class CodeChangedEvent implements ICodeChangedEvent {
public readonly code: string;

4
src/application/Context/State/Code/Event/ICodeChangedEvent.ts
View File

@@ -1,5 +1,5 @@
import { IScript } from '@/domain/IScript';
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
import type { IScript } from '@/domain/IScript';
import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
export interface ICodeChangedEvent {
readonly code: string;

2
src/application/Context/State/Code/Generation/CodeBuilder.ts
View File

@@ -1,4 +1,4 @@
import { ICodeBuilder } from './ICodeBuilder';
import type { ICodeBuilder } from './ICodeBuilder';
const TotalFunctionSeparatorChars = 58;

4
src/application/Context/State/Code/Generation/CodeBuilderFactory.ts
View File

@@ -1,9 +1,9 @@
import { ScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/ScriptingLanguageFactory';
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
import { ICodeBuilder } from './ICodeBuilder';
import { BatchBuilder } from './Languages/BatchBuilder';
import { ShellBuilder } from './Languages/ShellBuilder';
import { ICodeBuilderFactory } from './ICodeBuilderFactory';
import type { ICodeBuilder } from './ICodeBuilder';
import type { ICodeBuilderFactory } from './ICodeBuilderFactory';
export class CodeBuilderFactory
extends ScriptingLanguageFactory<ICodeBuilder>

4
src/application/Context/State/Code/Generation/ICodeBuilderFactory.ts
View File

@@ -1,4 +1,4 @@
import { IScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/IScriptingLanguageFactory';
import { ICodeBuilder } from './ICodeBuilder';
import type { IScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/IScriptingLanguageFactory';
import type { ICodeBuilder } from './ICodeBuilder';
export type ICodeBuilderFactory = IScriptingLanguageFactory<ICodeBuilder>;

4
src/application/Context/State/Code/Generation/IUserScript.ts
View File

@@ -1,5 +1,5 @@
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
export interface IUserScript {
readonly code: string;

6
src/application/Context/State/Code/Generation/IUserScriptGenerator.ts
View File

@@ -1,6 +1,6 @@
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import { IUserScript } from './IUserScript';
import type { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import type { IUserScript } from './IUserScript';
export interface IUserScriptGenerator {
buildCode(

14
src/application/Context/State/Code/Generation/UserScriptGenerator.ts
View File

@@ -1,12 +1,12 @@
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
import type { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
import { CodePosition } from '../Position/CodePosition';
import { IUserScriptGenerator } from './IUserScriptGenerator';
import { IUserScript } from './IUserScript';
import { ICodeBuilder } from './ICodeBuilder';
import { ICodeBuilderFactory } from './ICodeBuilderFactory';
import { CodeBuilderFactory } from './CodeBuilderFactory';
import type { IUserScriptGenerator } from './IUserScriptGenerator';
import type { IUserScript } from './IUserScript';
import type { ICodeBuilder } from './ICodeBuilder';
import type { ICodeBuilderFactory } from './ICodeBuilderFactory';
export class UserScriptGenerator implements IUserScriptGenerator {
constructor(private readonly codeBuilderFactory: ICodeBuilderFactory = new CodeBuilderFactory()) {

4
src/application/Context/State/Code/IApplicationCode.ts
View File

@@ -1,5 +1,5 @@
import { IEventSource } from '@/infrastructure/Events/IEventSource';
import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
import type { IEventSource } from '@/infrastructure/Events/IEventSource';
import type { ICodeChangedEvent } from './Event/ICodeChangedEvent';
export interface IApplicationCode {
readonly changed: IEventSource<ICodeChangedEvent>;

2
src/application/Context/State/Code/Position/CodePosition.ts
View File

@@ -1,4 +1,4 @@
import { ICodePosition } from './ICodePosition';
import type { ICodePosition } from './ICodePosition';
export class CodePosition implements ICodePosition {
public get totalLines(): number {

35
src/application/Context/State/Filter/AdaptiveFilterContext.ts Normal file
View File

@@ -0,0 +1,35 @@
import { EventSource } from '@/infrastructure/Events/EventSource';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { FilterChange } from './Event/FilterChange';
import { LinearFilterStrategy } from './Strategy/LinearFilterStrategy';
import type { FilterResult } from './Result/FilterResult';
import type { FilterContext } from './FilterContext';
import type { FilterChangeDetails } from './Event/FilterChangeDetails';
import type { FilterStrategy } from './Strategy/FilterStrategy';
export class AdaptiveFilterContext implements FilterContext {
public readonly filterChanged = new EventSource<FilterChangeDetails>();
public currentFilter: FilterResult | undefined;
constructor(
private readonly collection: ICategoryCollection,
private readonly filterStrategy: FilterStrategy = new LinearFilterStrategy(),
) {
}
public applyFilter(filter: string): void {
if (!filter) {
throw new Error('Filter must be defined and not empty. Use clearFilter() to remove the filter');
}
const result = this.filterStrategy.applyFilter(filter, this.collection);
this.currentFilter = result;
this.filterChanged.notify(FilterChange.forApply(this.currentFilter));
}
public clearFilter(): void {
this.currentFilter = undefined;
this.filterChanged.notify(FilterChange.forClear());
}
}

18
src/application/Context/State/Filter/Event/FilterChange.ts
View File

@@ -1,24 +1,24 @@
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
import { FilterActionType } from './FilterActionType';
import {
IFilterChangeDetails, IFilterChangeDetailsVisitor,
import type {
FilterChangeDetails, FilterChangeDetailsVisitor,
ApplyFilterAction, ClearFilterAction,
} from './IFilterChangeDetails';
} from './FilterChangeDetails';
export class FilterChange implements IFilterChangeDetails {
export class FilterChange implements FilterChangeDetails {
public static forApply(
filter: IFilterResult,
): IFilterChangeDetails {
filter: FilterResult,
): FilterChangeDetails {
return new FilterChange({ type: FilterActionType.Apply, filter });
}
public static forClear(): IFilterChangeDetails {
public static forClear(): FilterChangeDetails {
return new FilterChange({ type: FilterActionType.Clear });
}
private constructor(public readonly action: ApplyFilterAction | ClearFilterAction) { }
public visit(visitor: IFilterChangeDetailsVisitor): void {
public visit(visitor: FilterChangeDetailsVisitor): void {
switch (this.action.type) {
case FilterActionType.Apply:
if (visitor.onApply) {

23
src/application/Context/State/Filter/Event/FilterChangeDetails.ts Normal file
View File

@@ -0,0 +1,23 @@
import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
import type { FilterActionType } from './FilterActionType';
export interface FilterChangeDetails {
readonly action: FilterAction;
visit(visitor: FilterChangeDetailsVisitor): void;
}
export interface FilterChangeDetailsVisitor {
readonly onClear?: () => void;
readonly onApply?: (filter: FilterResult) => void;
}
export type ApplyFilterAction = {
readonly type: FilterActionType.Apply,
readonly filter: FilterResult;
};
export type ClearFilterAction = {
readonly type: FilterActionType.Clear,
};
export type FilterAction = ApplyFilterAction | ClearFilterAction;

23
src/application/Context/State/Filter/Event/IFilterChangeDetails.ts
View File

@@ -1,23 +0,0 @@
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
import { FilterActionType } from './FilterActionType';
export interface IFilterChangeDetails {
readonly action: FilterAction;
visit(visitor: IFilterChangeDetailsVisitor): void;
}
export interface IFilterChangeDetailsVisitor {
readonly onClear?: () => void;
readonly onApply?: (filter: IFilterResult) => void;
}
export type ApplyFilterAction = {
readonly type: FilterActionType.Apply,
readonly filter: IFilterResult;
};
export type ClearFilterAction = {
readonly type: FilterActionType.Clear,
};
export type FilterAction = ApplyFilterAction | ClearFilterAction;

13
src/application/Context/State/Filter/FilterContext.ts Normal file
View File

@@ -0,0 +1,13 @@
import type { IEventSource } from '@/infrastructure/Events/IEventSource';
import type { FilterResult } from './Result/FilterResult';
import type { FilterChangeDetails } from './Event/FilterChangeDetails';
export interface ReadonlyFilterContext {
readonly currentFilter: FilterResult | undefined;
readonly filterChanged: IEventSource<FilterChangeDetails>;
}
export interface FilterContext extends ReadonlyFilterContext {
applyFilter(filter: string): void;
clearFilter(): void;
}

13
src/application/Context/State/Filter/IUserFilter.ts
View File

@@ -1,13 +0,0 @@
import { IEventSource } from '@/infrastructure/Events/IEventSource';
import { IFilterResult } from './IFilterResult';
import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
export interface IReadOnlyUserFilter {
readonly currentFilter: IFilterResult | undefined;
readonly filterChanged: IEventSource<IFilterChangeDetails>;
}
export interface IUserFilter extends IReadOnlyUserFilter {
applyFilter(filter: string): void;
clearFilter(): void;
}

8
src/application/Context/State/Filter/FilterResult.ts → src/application/Context/State/Filter/Result/AppliedFilterResult.ts
View File

@@ -1,8 +1,8 @@
import { IScript } from '@/domain/IScript';
import { ICategory } from '@/domain/ICategory';
import { IFilterResult } from './IFilterResult';
import type { IScript } from '@/domain/IScript';
import type { ICategory } from '@/domain/ICategory';
import type { FilterResult } from './FilterResult';
export class FilterResult implements IFilterResult {
export class AppliedFilterResult implements FilterResult {
constructor(
public readonly scriptMatches: ReadonlyArray<IScript>,
public readonly categoryMatches: ReadonlyArray<ICategory>,

4
src/application/Context/State/Filter/IFilterResult.ts → src/application/Context/State/Filter/Result/FilterResult.ts
View File

@@ -1,6 +1,6 @@
import { IScript, ICategory } from '@/domain/ICategory';
import type { IScript, ICategory } from '@/domain/ICategory';
export interface IFilterResult {
export interface FilterResult {
readonly categoryMatches: ReadonlyArray<ICategory>;
readonly scriptMatches: ReadonlyArray<IScript>;
readonly query: string;

9
src/application/Context/State/Filter/Strategy/FilterStrategy.ts Normal file
View File

@@ -0,0 +1,9 @@
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { FilterResult } from '../Result/FilterResult';
export interface FilterStrategy {
applyFilter(
filter: string,
collection: ICategoryCollection,
): FilterResult;
}

80
src/application/Context/State/Filter/Strategy/LinearFilterStrategy.ts Normal file
View File

@@ -0,0 +1,80 @@
import type { ICategory, IScript } from '@/domain/ICategory';
import type { IScriptCode } from '@/domain/IScriptCode';
import type { IDocumentable } from '@/domain/IDocumentable';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { AppliedFilterResult } from '../Result/AppliedFilterResult';
import type { FilterStrategy } from './FilterStrategy';
import type { FilterResult } from '../Result/FilterResult';
export class LinearFilterStrategy implements FilterStrategy {
applyFilter(filter: string, collection: ICategoryCollection): FilterResult {
const filterLowercase = filter.toLocaleLowerCase();
const filteredScripts = collection.getAllScripts().filter(
(script) => matchesScript(script, filterLowercase),
);
const filteredCategories = collection.getAllCategories().filter(
(category) => matchesCategory(category, filterLowercase),
);
return new AppliedFilterResult(
filteredScripts,
filteredCategories,
filter,
);
}
}
function matchesCategory(
category: ICategory,
filterLowercase: string,
): boolean {
return matchesAny(
() => matchName(category.name, filterLowercase),
() => matchDocumentation(category, filterLowercase),
);
}
function matchesScript(
script: IScript,
filterLowercase: string,
): boolean {
return matchesAny(
() => matchName(script.name, filterLowercase),
() => matchCode(script.code, filterLowercase),
() => matchDocumentation(script, filterLowercase),
);
}
function matchesAny(
...predicates: ReadonlyArray<() => boolean>
): boolean {
return predicates.some((predicate) => predicate());
}
function matchName(
name: string,
filterLowercase: string,
): boolean {
return name.toLowerCase().includes(filterLowercase);
}
function matchCode(
code: IScriptCode,
filterLowercase: string,
): boolean {
if (code.execute.toLowerCase().includes(filterLowercase)) {
return true;
}
if (code.revert?.toLowerCase().includes(filterLowercase)) {
return true;
}
return false;
}
function matchDocumentation(
documentable: IDocumentable,
filterLowercase: string,
): boolean {
return documentable.docs.some(
(doc) => doc.toLocaleLowerCase().includes(filterLowercase),
);
}

56
src/application/Context/State/Filter/UserFilter.ts
View File

@@ -1,56 +0,0 @@
import { IScript } from '@/domain/IScript';
import { EventSource } from '@/infrastructure/Events/EventSource';
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import { FilterResult } from './FilterResult';
import { IFilterResult } from './IFilterResult';
import { IUserFilter } from './IUserFilter';
import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
import { FilterChange } from './Event/FilterChange';
export class UserFilter implements IUserFilter {
public readonly filterChanged = new EventSource<IFilterChangeDetails>();
public currentFilter: IFilterResult | undefined;
constructor(private collection: ICategoryCollection) {
}
public applyFilter(filter: string): void {
if (!filter) {
throw new Error('Filter must be defined and not empty. Use clearFilter() to remove the filter');
}
const filterLowercase = filter.toLocaleLowerCase();
const filteredScripts = this.collection.getAllScripts().filter(
(script) => isScriptAMatch(script, filterLowercase),
);
const filteredCategories = this.collection.getAllCategories().filter(
(category) => category.name.toLowerCase().includes(filterLowercase),
);
const matches = new FilterResult(
filteredScripts,
filteredCategories,
filter,
);
this.currentFilter = matches;
this.filterChanged.notify(FilterChange.forApply(this.currentFilter));
}
public clearFilter(): void {
this.currentFilter = undefined;
this.filterChanged.notify(FilterChange.forClear());
}
}
function isScriptAMatch(script: IScript, filterLowercase: string) {
if (script.name.toLowerCase().includes(filterLowercase)) {
return true;
}
if (script.code.execute.toLowerCase().includes(filterLowercase)) {
return true;
}
if (script.code.revert) {
return script.code.revert.toLowerCase().includes(filterLowercase);
}
return false;
}

12
src/application/Context/State/ICategoryCollectionState.ts
View File

@@ -1,18 +1,18 @@
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { IReadOnlyUserFilter, IUserFilter } from './Filter/IUserFilter';
import { ReadonlyUserSelection, UserSelection } from './Selection/UserSelection';
import { IApplicationCode } from './Code/IApplicationCode';
import type { IApplicationCode } from './Code/IApplicationCode';
import type { ReadonlyFilterContext, FilterContext } from './Filter/FilterContext';
import type { ReadonlyUserSelection, UserSelection } from './Selection/UserSelection';
export interface IReadOnlyCategoryCollectionState {
readonly code: IApplicationCode;
readonly os: OperatingSystem;
readonly filter: IReadOnlyUserFilter;
readonly filter: ReadonlyFilterContext;
readonly selection: ReadonlyUserSelection;
readonly collection: ICategoryCollection;
}
export interface ICategoryCollectionState extends IReadOnlyCategoryCollectionState {
readonly filter: IUserFilter;
readonly filter: FilterContext;
readonly selection: UserSelection;
}

4
src/application/Context/State/Selection/Category/CategorySelection.ts
View File

@@ -1,5 +1,5 @@
import { ICategory } from '@/domain/ICategory';
import { CategorySelectionChangeCommand } from './CategorySelectionChange';
import type { ICategory } from '@/domain/ICategory';
import type { CategorySelectionChangeCommand } from './CategorySelectionChange';
export interface ReadonlyCategorySelection {
areAllScriptsSelected(category: ICategory): boolean;

12
src/application/Context/State/Selection/Category/ScriptToCategorySelectionMapper.ts
View File

@@ -1,9 +1,9 @@
import { ICategory } from '@/domain/ICategory';
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import { ScriptSelection } from '../Script/ScriptSelection';
import { ScriptSelectionChange } from '../Script/ScriptSelectionChange';
import { CategorySelection } from './CategorySelection';
import { CategorySelectionChange, CategorySelectionChangeCommand } from './CategorySelectionChange';
import type { ICategory } from '@/domain/ICategory';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { CategorySelectionChange, CategorySelectionChangeCommand } from './CategorySelectionChange';
import type { CategorySelection } from './CategorySelection';
import type { ScriptSelection } from '../Script/ScriptSelection';
import type { ScriptSelectionChange } from '../Script/ScriptSelectionChange';
export class ScriptToCategorySelectionMapper implements CategorySelection {
constructor(

22
src/application/Context/State/Selection/Script/DebouncedScriptSelection.ts
View File

@@ -1,13 +1,13 @@
import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
import { IScript } from '@/domain/IScript';
import type { IScript } from '@/domain/IScript';
import { EventSource } from '@/infrastructure/Events/EventSource';
import { ReadonlyRepository, Repository } from '@/application/Repository/Repository';
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { ReadonlyRepository, Repository } from '@/application/Repository/Repository';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { batchedDebounce } from '@/application/Common/Timing/BatchedDebounce';
import { ScriptSelection } from './ScriptSelection';
import { ScriptSelectionChange, ScriptSelectionChangeCommand } from './ScriptSelectionChange';
import { SelectedScript } from './SelectedScript';
import { UserSelectedScript } from './UserSelectedScript';
import type { ScriptSelection } from './ScriptSelection';
import type { ScriptSelectionChange, ScriptSelectionChangeCommand } from './ScriptSelectionChange';
import type { SelectedScript } from './SelectedScript';
const DEBOUNCE_DELAY_IN_MS = 100;
@@ -81,9 +81,7 @@ export class DebouncedScriptSelection implements ScriptSelection {
}
public selectOnly(scripts: readonly IScript[]): void {
if (scripts.length === 0) {
throw new Error('Provided script array is empty. To deselect all scripts, please use the deselectAll() method instead.');
}
assertNonEmptyScriptSelection(scripts);
this.processChanges({
changes: [
...getScriptIdsToBeDeselected(this.scripts, scripts)
@@ -147,6 +145,12 @@ export class DebouncedScriptSelection implements ScriptSelection {
}
}
function assertNonEmptyScriptSelection(selectedItems: readonly IScript[]) {
if (selectedItems.length === 0) {
throw new Error('Provided script array is empty. To deselect all scripts, please use the deselectAll() method instead.');
}
}
function getScriptIdsToBeSelected(
existingItems: ReadonlyRepository<string, SelectedScript>,
desiredScripts: readonly IScript[],

8
src/application/Context/State/Selection/Script/ScriptSelection.ts
View File

@@ -1,7 +1,7 @@
import { IEventSource } from '@/infrastructure/Events/IEventSource';
import { IScript } from '@/domain/IScript';
import { SelectedScript } from './SelectedScript';
import { ScriptSelectionChangeCommand } from './ScriptSelectionChange';
import type { IEventSource } from '@/infrastructure/Events/IEventSource';
import type { IScript } from '@/domain/IScript';
import type { SelectedScript } from './SelectedScript';
import type { ScriptSelectionChangeCommand } from './ScriptSelectionChange';
export interface ReadonlyScriptSelection {
readonly changed: IEventSource<readonly SelectedScript[]>;

1
src/application/Context/State/Selection/Script/ScriptSelectionChange.ts
View File

@@ -3,6 +3,7 @@ export type ScriptSelectionStatus = {
readonly isReverted: boolean;
} | {
readonly isSelected: false;
readonly isReverted?: undefined;
};
export interface ScriptSelectionChange {

4
src/application/Context/State/Selection/Script/SelectedScript.ts
View File

@@ -1,5 +1,5 @@
import { IEntity } from '@/infrastructure/Entity/IEntity';
import { IScript } from '@/domain/IScript';
import type { IEntity } from '@/infrastructure/Entity/IEntity';
import type { IScript } from '@/domain/IScript';
type ScriptId = IScript['id'];

4
src/application/Context/State/Selection/Script/UserSelectedScript.ts
View File

@@ -1,6 +1,6 @@
import { BaseEntity } from '@/infrastructure/Entity/BaseEntity';
import { IScript } from '@/domain/IScript';
import { SelectedScript } from './SelectedScript';
import type { IScript } from '@/domain/IScript';
import type { SelectedScript } from './SelectedScript';
type SelectedScriptId = SelectedScript['id'];

4
src/application/Context/State/Selection/UserSelection.ts
View File

@@ -1,5 +1,5 @@
import { CategorySelection, ReadonlyCategorySelection } from './Category/CategorySelection';
import { ReadonlyScriptSelection, ScriptSelection } from './Script/ScriptSelection';
import type { CategorySelection, ReadonlyCategorySelection } from './Category/CategorySelection';
import type { ReadonlyScriptSelection, ScriptSelection } from './Script/ScriptSelection';
export interface ReadonlyUserSelection {
readonly categories: ReadonlyCategorySelection;

10
src/application/Context/State/Selection/UserSelectionFacade.ts
View File

@@ -1,10 +1,10 @@
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import { CategorySelection } from './Category/CategorySelection';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { ScriptToCategorySelectionMapper } from './Category/ScriptToCategorySelectionMapper';
import { DebouncedScriptSelection } from './Script/DebouncedScriptSelection';
import { ScriptSelection } from './Script/ScriptSelection';
import { UserSelection } from './UserSelection';
import { SelectedScript } from './Script/SelectedScript';
import type { CategorySelection } from './Category/CategorySelection';
import type { ScriptSelection } from './Script/ScriptSelection';
import type { UserSelection } from './UserSelection';
import type { SelectedScript } from './Script/SelectedScript';
export class UserSelectionFacade implements UserSelection {
public readonly categories: CategorySelection;

2
src/application/IApplicationFactory.ts
View File

@@ -1,4 +1,4 @@
import { IApplication } from '@/domain/IApplication';
import type { IApplication } from '@/domain/IApplication';
export interface IApplicationFactory {
getApp(): Promise<IApplication>;

22
src/application/Parser/ApplicationParser.ts
View File

@@ -1,31 +1,33 @@
import type { CollectionData } from '@/application/collections/';
import { IApplication } from '@/domain/IApplication';
import { IProjectInformation } from '@/domain/IProjectInformation';
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { IApplication } from '@/domain/IApplication';
import type { ProjectDetails } from '@/domain/Project/ProjectDetails';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import WindowsData from '@/application/collections/windows.yaml';
import MacOsData from '@/application/collections/macos.yaml';
import LinuxData from '@/application/collections/linux.yaml';
import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
import { parseProjectDetails } from '@/application/Parser/ProjectDetailsParser';
import { Application } from '@/domain/Application';
import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
import type { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
import { parseCategoryCollection } from './CategoryCollectionParser';
export function parseApplication(
categoryParser = parseCategoryCollection,
informationParser = parseProjectInformation,
projectDetailsParser = parseProjectDetails,
metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
collectionsData = PreParsedCollections,
): IApplication {
validateCollectionsData(collectionsData);
const information = informationParser(metadata);
const collections = collectionsData.map((collection) => categoryParser(collection, information));
const app = new Application(information, collections);
const projectDetails = projectDetailsParser(metadata);
const collections = collectionsData.map(
(collection) => categoryParser(collection, projectDetails),
);
const app = new Application(projectDetails, collections);
return app;
}
export type CategoryCollectionParserType
= (file: CollectionData, info: IProjectInformation) => ICategoryCollection;
= (file: CollectionData, projectDetails: ProjectDetails) => ICategoryCollection;
const PreParsedCollections: readonly CollectionData [] = [
WindowsData, MacOsData, LinuxData,

8
src/application/Parser/CategoryCollectionParser.ts
View File

@@ -1,8 +1,8 @@
import type { CollectionData } from '@/application/collections/';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import type { ICategoryCollection } from '@/domain/ICategoryCollection';
import { CategoryCollection } from '@/domain/CategoryCollection';
import { IProjectInformation } from '@/domain/IProjectInformation';
import type { ProjectDetails } from '@/domain/Project/ProjectDetails';
import { createEnumParser } from '../Common/Enum';
import { parseCategory } from './CategoryParser';
import { CategoryCollectionParseContext } from './Script/CategoryCollectionParseContext';
@@ -10,12 +10,12 @@ import { ScriptingDefinitionParser } from './ScriptingDefinition/ScriptingDefini
export function parseCategoryCollection(
content: CollectionData,
info: IProjectInformation,
projectDetails: ProjectDetails,
osParser = createEnumParser(OperatingSystem),
): ICategoryCollection {
validate(content);
const scripting = new ScriptingDefinitionParser()
.parse(content.scripting, info);
.parse(content.scripting, projectDetails);
const context = new CategoryCollectionParseContext(content.functions, scripting);
const categories = content.actions.map((action) => parseCategory(action, context));
const os = osParser.parseEnum(content.os, 'os');

2
src/application/Parser/CategoryParser.ts
View File

@@ -6,8 +6,8 @@ import { Category } from '@/domain/Category';
import { NodeValidator } from '@/application/Parser/NodeValidation/NodeValidator';
import { NodeType } from '@/application/Parser/NodeValidation/NodeType';
import { parseDocs } from './DocumentationParser';
import { ICategoryCollectionParseContext } from './Script/ICategoryCollectionParseContext';
import { parseScript } from './Script/ScriptParser';
import type { ICategoryCollectionParseContext } from './Script/ICategoryCollectionParseContext';
let categoryIdCounter = 0;

21
src/application/Parser/DocumentationParser.ts
View File

@@ -1,4 +1,5 @@
import type { DocumentableData, DocumentationData } from '@/application/collections/';
import { isString, isArray } from '@/TypeHelpers';
export function parseDocs(documentable: DocumentableData): readonly string[] {
const { docs } = documentable;
@@ -14,11 +15,9 @@ function addDocs(
docs: DocumentationData,
container: DocumentationContainer,
): DocumentationContainer {
if (docs instanceof Array) {
if (docs.length > 0) {
container.addParts(docs);
}
} else if (typeof docs === 'string') {
if (isArray(docs)) {
docs.forEach((doc) => container.addPart(doc));
} else if (isString(docs)) {
container.addPart(docs);
} else {
throwInvalidType();
@@ -29,27 +28,21 @@ function addDocs(
class DocumentationContainer {
private readonly parts = new Array<string>();
public addPart(documentation: string) {
public addPart(documentation: unknown): void {
if (!documentation) {
throw Error('missing documentation');
}
if (typeof documentation !== 'string') {
if (!isString(documentation)) {
throwInvalidType();
}
this.parts.push(documentation);
}
public addParts(parts: readonly string[]) {
for (const part of parts) {
this.addPart(part);
}
}
public getAll(): ReadonlyArray<string> {
return this.parts;
}
}
function throwInvalidType() {
function throwInvalidType(): never {
throw new Error('docs field (documentation) must be an array of strings');
}

2
src/application/Parser/NodeValidation/NodeDataError.ts
View File

@@ -1,6 +1,6 @@
import { CustomError } from '@/application/Common/CustomError';
import { NodeType } from './NodeType';
import { NodeData } from './NodeData';
import type { NodeData } from './NodeData';
export class NodeDataError extends CustomError {
constructor(message: string, public readonly context: INodeDataErrorContext) {

7
src/application/Parser/NodeValidation/NodeValidator.ts
View File

@@ -1,5 +1,6 @@
import { INodeDataErrorContext, NodeDataError } from './NodeDataError';
import { NodeData } from './NodeData';
import { isString } from '@/TypeHelpers';
import { type INodeDataErrorContext, NodeDataError } from './NodeDataError';
import type { NodeData } from './NodeData';
export class NodeValidator {
constructor(private readonly context: INodeDataErrorContext) {
@@ -13,7 +14,7 @@ export class NodeValidator {
'missing name',
)
.assert(
() => typeof nameValue === 'string',
() => isString(nameValue),
`Name (${JSON.stringify(nameValue)}) is not a string but ${typeof nameValue}.`,
);
}

29
src/application/Parser/ProjectDetailsParser.ts Normal file
View File

@@ -0,0 +1,29 @@
import type { ProjectDetails } from '@/domain/Project/ProjectDetails';
import { GitHubProjectDetails } from '@/domain/Project/GitHubProjectDetails';
import type { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
import { Version } from '@/domain/Version';
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
import type { ConstructorArguments } from '@/TypeHelpers';
export function
parseProjectDetails(
metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
createProjectDetails: ProjectDetailsFactory = (
...args
) => new GitHubProjectDetails(...args),
): ProjectDetails {
const version = new Version(
metadata.version,
);
return createProjectDetails(
metadata.name,
version,
metadata.slogan,
metadata.repositoryUrl,
metadata.homepageUrl,
);
}
export type ProjectDetailsFactory = (
...args: ConstructorArguments<typeof GitHubProjectDetails>
) => ProjectDetails;

29
src/application/Parser/ProjectInformationParser.ts
View File

@@ -1,29 +0,0 @@
import { IProjectInformation } from '@/domain/IProjectInformation';
import { ProjectInformation } from '@/domain/ProjectInformation';
import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
import { Version } from '@/domain/Version';
import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
import { ConstructorArguments } from '@/TypeHelpers';
export function
parseProjectInformation(
metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
createProjectInformation: ProjectInformationFactory = (
...args
) => new ProjectInformation(...args),
): IProjectInformation {
const version = new Version(
metadata.version,
);
return createProjectInformation(
metadata.name,
version,
metadata.slogan,
metadata.repositoryUrl,
metadata.homepageUrl,
);
}
export type ProjectInformationFactory = (
...args: ConstructorArguments<typeof ProjectInformation>
) => IProjectInformation;

10
src/application/Parser/Script/CategoryCollectionParseContext.ts
View File

@@ -1,11 +1,11 @@
import type { FunctionData } from '@/application/collections/';
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import { IScriptCompiler } from './Compiler/IScriptCompiler';
import type { IScriptingDefinition } from '@/domain/IScriptingDefinition';
import { ScriptCompiler } from './Compiler/ScriptCompiler';
import { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';
import { SyntaxFactory } from './Validation/Syntax/SyntaxFactory';
import { ISyntaxFactory } from './Validation/Syntax/ISyntaxFactory';
import { ILanguageSyntax } from './Validation/Syntax/ILanguageSyntax';
import type { ILanguageSyntax } from './Validation/Syntax/ILanguageSyntax';
import type { IScriptCompiler } from './Compiler/IScriptCompiler';
import type { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';
import type { ISyntaxFactory } from './Validation/Syntax/ISyntaxFactory';
export class CategoryCollectionParseContext implements ICategoryCollectionParseContext {
public readonly compiler: IScriptCompiler;

8
src/application/Parser/Script/Compiler/Expressions/Expression/Expression.ts
View File

@@ -1,10 +1,10 @@
import { FunctionParameterCollection } from '@/application/Parser/Script/Compiler/Function/Parameter/FunctionParameterCollection';
import { IReadOnlyFunctionCallArgumentCollection } from '../../Function/Call/Argument/IFunctionCallArgumentCollection';
import { IReadOnlyFunctionParameterCollection } from '../../Function/Parameter/IFunctionParameterCollection';
import { FunctionCallArgumentCollection } from '../../Function/Call/Argument/FunctionCallArgumentCollection';
import { IExpression } from './IExpression';
import { ExpressionEvaluationContext, type IExpressionEvaluationContext } from './ExpressionEvaluationContext';
import { ExpressionPosition } from './ExpressionPosition';
import { ExpressionEvaluationContext, IExpressionEvaluationContext } from './ExpressionEvaluationContext';
import type { IReadOnlyFunctionCallArgumentCollection } from '../../Function/Call/Argument/IFunctionCallArgumentCollection';
import type { IReadOnlyFunctionParameterCollection } from '../../Function/Parameter/IFunctionParameterCollection';
import type { IExpression } from './IExpression';
export type ExpressionEvaluator = (context: IExpressionEvaluationContext) => string;
export class Expression implements IExpression {

4
src/application/Parser/Script/Compiler/Expressions/Expression/ExpressionEvaluationContext.ts
View File

@@ -1,6 +1,6 @@
import { IReadOnlyFunctionCallArgumentCollection } from '../../Function/Call/Argument/IFunctionCallArgumentCollection';
import { IPipelineCompiler } from '../Pipes/IPipelineCompiler';
import { PipelineCompiler } from '../Pipes/PipelineCompiler';
import type { IReadOnlyFunctionCallArgumentCollection } from '../../Function/Call/Argument/IFunctionCallArgumentCollection';
import type { IPipelineCompiler } from '../Pipes/IPipelineCompiler';
export interface IExpressionEvaluationContext {
readonly args: IReadOnlyFunctionCallArgumentCollection;

4
src/application/Parser/Script/Compiler/Expressions/Expression/IExpression.ts
View File

@@ -1,6 +1,6 @@
import { IReadOnlyFunctionParameterCollection } from '../../Function/Parameter/IFunctionParameterCollection';
import { ExpressionPosition } from './ExpressionPosition';
import { IExpressionEvaluationContext } from './ExpressionEvaluationContext';
import type { IReadOnlyFunctionParameterCollection } from '../../Function/Parameter/IFunctionParameterCollection';
import type { IExpressionEvaluationContext } from './ExpressionEvaluationContext';
export interface IExpression {
readonly position: ExpressionPosition;

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