Add shared GovOPlaN gitignore

.gitignore

@@ -0,0 +1,348 @@
+# ---> Node
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# Local WebUI test/build scratch directories
+.component-test-build/
+.module-test-build/
+.policy-test-build/
+.template-preview-test-build/
+.import-test-build/
+webui/.component-test-build/
+webui/.module-test-build/
+webui/.policy-test-build/
+webui/.template-preview-test-build/
+webui/.import-test-build/
+
+# ---> Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# ---> VisualStudioCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+*.db
+
+# GovOPlaN local runtime state
+runtime/
+
+# GovOPlaN WebUI test output
+webui/.module-test-build/
+webui/.component-test-build/

README.md

@@ -0,0 +1,11 @@
+# govoplan-cases
+
+`govoplan-cases` will own formal administrative case records for GovOPlaN.
+
+The module should stay focused on case identity, lifecycle state, assignments,
+deadlines, participants, evidence links, and case-level audit context. It should
+not own forms, files, workflow execution, task queues, templates, payments, or
+mail delivery; those are integrated through GovOPlaN capabilities, events,
+commands, and DTOs.
+
+See [docs/CONCEPT.md](docs/CONCEPT.md) for the current module concept.

docs/CONCEPT.md

@@ -0,0 +1,143 @@
+# govoplan-cases Concept
+
+## Purpose
+
+`govoplan-cases` is the formal administrative case module. It creates a durable
+container for a procedure such as a permit application, inspection, complaint,
+grant request, or internal administrative matter.
+
+The case is not the workflow engine and not the file store. It is the stable
+record that ties together participants, status, assignments, deadlines,
+evidence, decisions, communications, audit events, and retention references.
+
+## Ownership
+
+The module owns:
+
+- case identifiers, references, titles, types, and status
+- case parties and role labels such as applicant, assignee, reviewer, and owner
+- case metadata and tags
+- due dates, service-level targets, and milestone dates
+- links to evidence provided by other modules
+- case comments and internal notes once the collaboration boundary is decided
+- case-level access checks and resource ACL contributions
+- case event emission for lifecycle changes
+- case summary APIs and WebUI route contributions
+
+The module does not own:
+
+- form submissions and validation, owned by forms/forms-runtime
+- binary file storage, owned by files or DMS
+- workflow state machines and transition execution, owned by workflow
+- work queues and task assignment semantics, owned by tasks
+- generated documents, owned by templates/DMS
+- appointments, mail, notifications, postbox, payments, or ledger postings
+
+## Core Contracts
+
+The module should integrate through:
+
+- module manifest metadata, route factories, permissions, and migrations
+- a `cases.access` or similar case access capability for resource checks
+- a `cases.summary` capability for dashboards and cross-module previews
+- events such as `case.created`, `case.updated`, `case.status_changed`,
+  `case.assigned`, and `case.closed`
+- commands such as `cases.open`, `cases.update_status`, `cases.link_evidence`,
+  and `cases.assign`
+- DTOs with stable IDs and labels, not ORM objects
+
+Other modules should link to a case by stable references:
+
+```json
+{
+  "case_id": "case-uuid",
+  "tenant_id": "tenant-uuid",
+  "relation": "submission"
+}
+```
+
+## Reference Journey
+
+Permit-to-payment MVP:
+
+1. Portal/forms runtime receives a public application.
+2. Workflow asks cases to create a case record.
+3. Files/DMS links uploaded evidence to the case.
+4. Tasks assigns an internal review task.
+5. Workflow moves the case from intake to review to appointment to decision.
+6. Templates generates the permit or decision document and links it to the case.
+7. Payments links payment evidence.
+8. Audit and records retain the case history.
+
+## MVP Slice
+
+The first implementation should provide:
+
+- case type registry with a minimal tenant-local configuration
+- create/list/read/update case APIs
+- status values with a simple configurable catalog
+- parties and assignments stored as access subject references
+- evidence links as module/resource references
+- case timeline from local events plus linked audit event IDs
+- basic WebUI list/detail route
+- resource ACL provider for case read/update
+- tenant summary provider for dashboard counts
+
+## Permissions
+
+Candidate scopes:
+
+- `cases:case:read`
+- `cases:case:create`
+- `cases:case:update`
+- `cases:case:assign`
+- `cases:case:close`
+- `cases:case:admin`
+
+Access decisions should combine tenant permissions, case ownership/assignment,
+and explicit case shares when those are introduced.
+
+## Data Model Sketch
+
+Candidate tables:
+
+- `cases`
+- `case_parties`
+- `case_assignments`
+- `case_evidence_links`
+- `case_timeline_entries`
+- `case_type_definitions`
+- `case_status_definitions`
+
+Evidence links should store only stable module/resource references and display
+metadata snapshots. The owning module remains responsible for the real object.
+
+## WebUI
+
+Initial route contributions:
+
+- `/cases`
+- `/cases/:caseId`
+
+The case detail view should expose extension points for linked forms, files,
+tasks, workflow state, appointments, documents, communication, payment evidence,
+and audit timeline. Extension points must be declarative; no direct UI imports
+from sibling modules.
+
+## Tests
+
+Minimum tests:
+
+- core can start with cases present and sibling modules absent
+- creating a case emits a case event and audit event
+- case ACL blocks unauthorized read/update
+- evidence links accept only module/resource references
+- optional modules can contribute detail panels without direct imports
+- migration metadata registers through the module manifest
+
+## Open Decisions
+
+- Whether comments belong in cases, tasks, or a collaboration module.
+- Whether case type/status catalogs are fully configurable in MVP or seeded.
+- How records/legal-hold integration should own retention of closed cases.
+- Whether case shares are local to cases or use a generic resource ACL module.