npm - @zerwiz/ymir - Versions diffs - 0.1.34 → 0.1.35 - Mend

@zerwiz/ymir 0.1.34 → 0.1.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (929) hide show

package/apps/sessrumnir/CONTRIBUTING.md ADDED Viewed

@@ -0,0 +1,233 @@
+# Contributing to Sessrúmnir
+This guide covers bug reports, feature requests, and the pull request workflow.
+## Architecture reference: `AGENTS.md`
+[`AGENTS.md`](AGENTS.md) is the canonical reference for the project's architecture, module layout, data-storage locations, distribution model, and delivery standards. Read it before making non-trivial changes; it is kept more current and more detailed than the summary in this guide.
+### For AI coding agents
+If you use an AI coding agent (Claude Code, Codex, Kilo, Cursor, etc.) to work on this repository, the agent must read and follow [`AGENTS.md`](AGENTS.md), in particular its Final Delivery Checklist, before proposing or committing changes. Most agents load a file named `AGENTS.md` automatically; if yours does not, point it at the file explicitly at the start of a session.
+At minimum, an agent's work must:
+- Reuse existing patterns and utilities instead of duplicating logic
+- Ship complete implementations (no placeholders, dead code, or deferred work)
+- Add or update the colocated `*.test.ts` tests for any changed module
+- Pass `npm run typecheck`, `npm run lint`, `npm run build`, and `npx tsx --test`
+- Preserve the Electron security posture (see Electron security below)
+## Contributor License Agreement
+**Before your first contribution can be merged, you must agree to the [Contributor License Agreement (CLA)](CLA.md).**
+The CLA confirms you have the right to contribute the code, grants the project a license to use your contribution, protects against patent claims, and defines trademark boundaries.
+By submitting a pull request, you acknowledge that you have read and agree to the CLA.
+## How to contribute
+### Reporting bugs
+1. Check [existing issues](https://github.com/FaqFirebase/pi-desktop/issues) first
+2. Open a new issue with:
+   - Clear title and description
+   - Steps to reproduce
+   - Expected vs actual behavior
+   - Environment (OS, Electron version, Pi version)
+   - Screenshots if applicable
+### Suggesting features
+1. Open a [feature request](https://github.com/FaqFirebase/pi-desktop/issues/new?template=feature_request.yml)
+2. Describe the use case and expected behavior
+3. Explain why this would be useful to other users
+### Submitting code
+This repository uses two long-lived branches:
+- `master` holds public-facing docs only (`README.md`, `AGENTS.md`, `LICENSE`, `CLA.md`, `CONTRIBUTING.md`, `.gitignore`). Do not target PRs here.
+- `Dev` holds all application source and is where active development happens. **Target your pull requests against `Dev`.**
+Steps:
+1. Fork the repository
+2. Check out and branch from `Dev`:
+   ```bash
+   git checkout Dev
+   git pull
+   git checkout -b feature/my-feature
+   ```
+3. Make your changes following the coding standards below
+4. Test your changes thoroughly
+5. Commit with a clear message:
+   ```bash
+   git commit -m "feat: add my feature"
+   ```
+6. Push to your fork:
+   ```bash
+   git push origin feature/my-feature
+   ```
+7. Open a pull request against `Dev` (not `master`)
+### Commit message format
+We use [Conventional Commits](https://www.conventionalcommits.org/):
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+Types:
+- `feat`: new feature
+- `fix`: bug fix
+- `docs`: documentation
+- `style`: formatting (no code change)
+- `refactor`: code restructuring (no behavior change)
+- `test`: adding or updating tests
+- `chore`: build process, dependencies, tooling
+- `perf`: performance improvement
+Examples:
+```
+feat(chat): add file attachment support
+fix(pi-rpc): handle EPIPE errors gracefully
+docs(readme): update installation instructions
+```
+## Coding standards
+### TypeScript
+- Full strict mode enabled
+- No `any` types; use proper typing
+- Named constants instead of magic numbers
+- Async/await over callbacks
+- Proper error handling (no empty catch blocks)
+### React
+- Functional components with hooks
+- Zustand for state management
+- Tailwind CSS for styling
+- No class components
+### Electron security
+- `contextIsolation: true`
+- `nodeIntegration: false`
+- All IPC through preload bridge
+- Validate all IPC payloads
+- No arbitrary command execution from renderer
+### Code style
+Conventions, not enforced by ESLint (the lint step checks the recommended rule sets, React hooks, unused vars, and semantic colors):
+- 2-space indentation
+- Single quotes for strings
+- Semicolons only when required
+- Trailing commas in multi-line
+- Max line length: 120 characters
+## Translations
+Interface text lives in `resources/locales/<code>/translation.json`. English (`en`) is the source.
+To add a language:
+1. Copy `resources/locales/en/translation.json` to `resources/locales/<code>/translation.json`. Use a BCP 47 code such as `de`, `pt-BR`, or `zh-Hans`.
+2. Translate the values. Do not change keys, `{{placeholders}}`, `<tags>`, or the product names Sessrúmnir, Pi, and OMP. Leave a value empty if you are not sure; the app shows English for it.
+3. Set `language.nativeName` to the language's own name, for example `Deutsch`.
+4. Add the file to `src/shared/i18n/resources.ts` (one import and one entry).
+5. Run `npm run lint` and the unit tests, then open a pull request. The CLA applies to translations.
+To try a language, pick it in Settings > Appearance > Language.
+When you add interface text in code, use a key with `t()` and run `npx i18next-cli extract` to add the key to every language file. Then write the English text in `resources/locales/en/translation.json`.
+To find text that is not translated, start the app with the test language enabled:
+```bash
+PI_DESKTOP_PSEUDO_LANGUAGE=1 npm run dev
+```
+Pick the bracketed entry (`[Éñĝļîšĥ ~~~]`) in Settings > Appearance > Language and save. Every translated string then shows accented letters inside brackets, longer than English. Plain English text on screen was not translated, unless it is data such as file names, model names, or chat content.
+## Testing
+Before submitting a pull request:
+1. Type check passes:
+   ```bash
+   npm run typecheck
+   ```
+2. Lint passes:
+   ```bash
+   npm run lint
+   ```
+3. Unit tests pass:
+   ```bash
+   npx tsx --test
+   ```
+4. Build succeeds:
+   ```bash
+   npm run build
+   ```
+5. App launches and works:
+   ```bash
+   npm run dev
+   ```
+6. No regressions in existing functionality
+## Project structure
+```
+src/
+├── shared/ipc-contracts.ts    # IPC channel definitions
+├── main/                      # Electron main process
+│   ├── index.ts               # App lifecycle
+│   ├── ipc-handlers.ts        # Registers the handlers in ipc/
+│   ├── ipc/                   # One module per handler group, plus payload validation
+│   ├── pi-rpc-manager.ts      # Agent subprocess management (Pi and OMP)
+│   ├── pi-binary-resolution.ts # Locating and identifying the agent executable
+│   ├── pi-paths.ts            # Session stores per engine, and which engine owns a session
+│   ├── workspace-manager.ts   # Workspaces and per-session runtimes
+│   ├── file-service.ts        # File tree, search, git, file write
+│   ├── git-worktree.ts        # Isolated worktrees for tasks
+│   ├── git-conveyor.ts        # Validated commit, push, and PR commands
+│   ├── terminal-service.ts    # node-pty PTY management
+│   ├── session-tags.ts        # Tag persistence
+│   └── archived-sessions.ts   # Archived session persistence
+├── preload/index.ts           # Secure contextBridge API
+└── renderer/                  # React UI
+    └── src/
+        ├── store.ts           # Zustand state management
+        ├── hooks.ts           # Event subscriptions
+        └── components/        # React components
+```
+This is a guide, not a full listing. `AGENTS.md` carries the complete module map.
+## Getting help
+Report problems on [GitHub Issues](https://github.com/FaqFirebase/pi-desktop/issues) and ask questions in [GitHub Discussions](https://github.com/FaqFirebase/pi-desktop/discussions). For documentation, read [README.md](README.md) for an overview and the source under `src/` for implementation details.
+## License
+By contributing to this project, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE).

package/apps/sessrumnir/LICENSE ADDED Viewed

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   1. Definitions.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+   END OF TERMS AND CONDITIONS
+   APPENDIX: How to apply the Apache License to your work.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an
+      "Applicability of Apache License" file from the Apache Software
+      Foundation at http://www.apache.org/foundation/license-faq.html.
+   Copyright 2026 HighlandJewls, PikkonMG, FaqFirebase
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/apps/sessrumnir/NOTICE ADDED Viewed

@@ -0,0 +1,33 @@
+Sessrúmnir
+Copyright 2026 zerwiz
+This project is a vendored, re-themed fork of **pi-desktop**, an Electron
+desktop GUI for the Pi and OMP coding agents, distributed under the Apache
+License, Version 2.0. The vendored source is kept in this directory; the
+upstream repository is https://github.com/FaqFirebase/pi-desktop (v0.1.7-alpha,
+commit 4a5601b).
+The following copyright notice applies to the portions derived from pi-desktop:
+  Copyright 2026 Sessrúmnir GUI Contributors.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this work except in compliance with the License. You may obtain a copy of
+the License at
+  http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations under
+the License.
+Changes made by Ymir beyond the upstream source:
+  - Rebranded the GUI to Sessrúmnir (window titles, launcher, package identity,
+    tray/autostart strings, data-dir name).
+  - Added the Sessrúmnir built-in theme (Ymir way-of palette: sky #38bdf8 on
+    deep navy) and made it the default.
+  - Replaced the Pi logo asset with the Sessrúmnir Sowilo rune mark.
+  - Added bin/sessrumnir.sh and bin/sessrumnir-ensure.sh and wired the app into
+    bin/ymir-install.sh.