sp2react 0.1.3__tar.gz → 0.1.4__tar.gz
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.
- {sp2react-0.1.3 → sp2react-0.1.4}/CHANGELOG.md +26 -1
- sp2react-0.1.4/CODE_OF_CONDUCT.md +39 -0
- sp2react-0.1.4/CONTRIBUTING.md +122 -0
- sp2react-0.1.4/GOVERNANCE.md +56 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/MANIFEST.in +2 -0
- {sp2react-0.1.3/src/sp2react.egg-info → sp2react-0.1.4}/PKG-INFO +31 -23
- {sp2react-0.1.3 → sp2react-0.1.4}/README.md +30 -22
- sp2react-0.1.4/ROADMAP.md +40 -0
- sp2react-0.1.4/SECURITY.md +105 -0
- sp2react-0.1.4/THIRD_PARTY_NOTICES.md +23 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/pyproject.toml +23 -6
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/__init__.py +4 -2
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/core.py +5 -10
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/tasks.py +19 -20
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/analysis/aspx.py +9 -9
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/analysis/behaviors.py +13 -13
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/analysis/fields.py +9 -9
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/analysis/inventory.py +24 -16
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/analysis/jsscan.py +3 -3
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/checks.py +16 -18
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/cli.py +13 -9
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/config.py +15 -6
- sp2react-0.1.4/src/sp2react/container/Dockerfile +21 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/dbmap.py +9 -8
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/llm/providers.py +22 -17
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/migrate.py +50 -30
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/model.py +30 -26
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/net.py +3 -3
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/ntlm.py +9 -8
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/pipeline.py +53 -33
- sp2react-0.1.4/src/sp2react/sandbox.py +220 -0
- sp2react-0.1.4/src/sp2react/sandbox_guard.py +201 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/generate.py +4 -4
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/released_templates.json +6 -3
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/odata.py +9 -2
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/sp_repo.py +18 -3
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/sql_repo.py +9 -5
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/sharepoint/client.py +43 -32
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/sharepoint/extract.py +56 -25
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/spec/base.py +5 -4
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/spec/coverage.py +3 -3
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/spec/model.py +13 -2
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/transport.py +13 -9
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/yamlish.py +9 -9
- {sp2react-0.1.3 → sp2react-0.1.4/src/sp2react.egg-info}/PKG-INFO +31 -23
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react.egg-info/SOURCES.txt +11 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/conftest.py +5 -4
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fuzz/fuzz_config_yaml.py +1 -1
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fuzz/fuzz_legacy_code.py +1 -1
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fuzz/fuzz_spec.py +1 -1
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fuzz/fuzz_wire.py +1 -1
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/test_network.py +4 -1
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/test_pipeline.py +8 -1
- sp2react-0.1.4/tests/test_sandbox.py +392 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/test_stdlib.py +3 -3
- sp2react-0.1.4/tests/test_threat_model.py +224 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/ui_walkthrough.py +1 -1
- sp2react-0.1.4/vex.openvex.json +10 -0
- sp2react-0.1.3/SECURITY.md +0 -47
- {sp2react-0.1.3 → sp2react-0.1.4}/LICENSE +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/setup.cfg +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/setup.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/prompts/dbmap.md +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/prompts/fix.md +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/prompts/handler.md +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/prompts/page.md +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/prompts/review.md +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/agents/prompts/spec.md +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/analysis/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/llm/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/py.typed +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/rule_vectors.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/api.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/auth.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/custom/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/main.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/rules.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/app/store.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/requirements.txt +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/tests/conftest.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/backend/tests/test_rule_vectors.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/index.html +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/package.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/scripts/check-rules.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/api.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/Banner.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/DataTable.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/Form.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/GenericPage.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/Layout.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/LegacyHtml.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/ListView.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/Tiles.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/components/sp/fields.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/custom/types.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/main.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/caml.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/format.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/rules.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/sanitize.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/spec.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/user.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/values.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/runtime/views.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/screens/LegacyRedirect.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/screens/ListFormScreen.tsx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/styles/sp.css +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/src/vite-env.d.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/tsconfig.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/scaffold/templates/frontend/vite.config.ts +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/sharepoint/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react/spec/__init__.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react.egg-info/dependency_links.txt +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react.egg-info/entry_points.txt +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react.egg-info/requires.txt +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/src/sp2react.egg-info/top_level.txt +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/agent_responses/dbmap/mapping.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/agent_responses/page/Dashboard.txt +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/agent_responses/spec/Dashboard.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/agent_responses/spec/VendorRequests-form.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/Lists/VendorRequests/Attachments/2/customs-bond.pdf +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/SiteAssets/css/dashboard.css +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/SiteAssets/css/vendor-request.css +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/SiteAssets/html/review-instructions.html +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/SiteAssets/js/dashboard.js +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/SiteAssets/js/jquery-1.12.4.min.js +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/SiteAssets/js/jquery.SPServices-2014.02.min.js +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/files/SiteAssets/js/vendor-request-form.js +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/ComplianceAlerts/fields.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/ComplianceAlerts/items.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/CostCenters/fields.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/CostCenters/items.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/Countries/fields.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/Countries/items.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/Departments/fields.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/Departments/items.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/VendorRequests/fields.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/lists/VendorRequests/items.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/pages/Lists/VendorRequests/DispForm.aspx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/pages/Lists/VendorRequests/EditForm.aspx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/pages/Lists/VendorRequests/NewForm.aspx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/pages/SitePages/Dashboard.aspx +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/pages/SitePages/Dashboard.aspx.webparts.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/rendered/SitePages/Dashboard.html +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/site.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/fixtures/legacy-site/siteusers.json +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/migrated_db.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/mock_sharepoint.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/scripted_agents.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/test_agents.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/test_extract_inventory.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/test_fidelity.py +0 -0
- {sp2react-0.1.3 → sp2react-0.1.4}/tests/test_hardening.py +0 -0
|
@@ -2,6 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to `sp2react` are documented here.
|
|
4
4
|
|
|
5
|
+
## [0.1.4] - 2026-11-19
|
|
6
|
+
|
|
7
|
+
OpenSSF Best Practices silver and baseline groundwork, as in lodestream and mssql-ocp-migrate, and the fixes its threat model found. Each fix has a test in `tests/test_threat_model.py` that fails on 0.1.3.
|
|
8
|
+
|
|
9
|
+
### Security
|
|
10
|
+
- `extract`: a page or asset URL from the site with `..` segments (for example `<script src="/sites/x/../../../y.js">` in a page) was written relative to the workspace, so a page editor could make sp2react write files outside it. Every file the extract writes (page source, web part, wiki and rendered sidecars, assets, list folders) is now checked (`..`, absolute and drive paths, symlinks) and a refused one is listed as an extraction error, before it is downloaded
|
|
11
|
+
- `migrate`: attachment names and item ids from the server are checked the same way before the attachment is downloaded and written to the export folder
|
|
12
|
+
- The generated app's builds and tests (which run agent-written handlers) no longer receive sp2react's own credentials: the variables named in `sharepoint.*_env`, `llm.api_key_env` and `database.url_env` are removed from their environment
|
|
13
|
+
- Spec screen ids must be plain names (letters, digits, `_`, `-`, `.`, at most 128 characters), since they become folder and file names; generated ids longer than 100 characters are shortened and keep a hash of the full name
|
|
14
|
+
- **The generated app's back-end tests and loader run in a sandbox** (`pipeline.sandbox`, default `auto`). They import custom handlers written by agents, which until now ran as ordinary processes with the user's file and network access. `container` runs them in a throwaway Docker or Podman container with no network (or only the database host), a read-only file system except the folder the step writes, no capabilities, a non-root user and none of the host's environment; `guard` (used by `auto` when no container runtime answers) runs them under an audit hook that refuses writes outside that folder, new processes, other network hosts and `ctypes`; `off` keeps plain processes. Set `pipeline.sandbox_image` to use a check image from your registry
|
|
15
|
+
- **NTLM is an explicit, TLS-only choice.** `sharepoint.auth` has no default any more (NTLMv2 needs MD4 and HMAC-MD5 by protocol), and NTLM is never answered over plain HTTP (the site URL or any later request, so a redirect cannot downgrade it) unless `sharepoint.allow_ntlm_over_http: true`. The generated app's SharePoint data source does the same (`SP_AUTH` required, `SP_ALLOW_NTLM_OVER_HTTP=1`). **Upgrade note:** a config without `sharepoint.auth` now fails with "Field required"; add `auth: ntlm` (or `cookie`, `bearer`, `none`). Configs written by `sp2react init` already have it
|
|
16
|
+
|
|
17
|
+
### Fixed
|
|
18
|
+
- Generated app: `startswith`, `endswith` and `substringof` in `$filter` with a number instead of quoted text (`endswith(Title,0)`) failed with a server error; they now answer 400 like any other bad filter (found by ClusterFuzzLite). With `DATA_SOURCE=database`, `%` and `_` in their text are matched literally, as SharePoint and the other data sources do, instead of acting as SQL wildcards. Regenerating an existing app picks this up (`odata.py`, `sql_repo.py`; files you changed are kept)
|
|
19
|
+
|
|
20
|
+
### Added
|
|
21
|
+
- `GOVERNANCE.md`, `CODE_OF_CONDUCT.md`, `ROADMAP.md`, a VEX document (`vex.openvex.json`), and in the documentation a security assurance case (threat model), a dependency and scanning policy, testing and releasing pages
|
|
22
|
+
- Pull requests: a DCO check (every commit signed off) and GitHub dependency review
|
|
23
|
+
- CI: statement coverage must stay at 80% or more (about 86% now); a job builds the package twice and checks the files are identical, and releases are built the same way (`SOURCE_DATE_EPOCH`, `ci/reproducible_sdist.py`); the vulnerability audit also checks versions pinned only for other Python versions (`ci/all_pins.py`); Dependabot watches the fuzzing image
|
|
24
|
+
|
|
25
|
+
### Changed
|
|
26
|
+
- `mypy --strict` and `ruff` with the Bandit security rules (`S`), comprehensions, `PIE` and `RUF` are clean and required
|
|
27
|
+
- CI tool locks are compiled for the Python versions their jobs run (build 3.11, e2e 3.12)
|
|
28
|
+
- Documentation reorganised into Getting started, User guide, Reference, Development and Release notes; installation covers offline installs and verifying a download's signature, and the JFrog Curation notes no longer list the dependencies removed in 0.1.3
|
|
29
|
+
|
|
5
30
|
## [0.1.3] - 2026-11-19
|
|
6
31
|
|
|
7
32
|
Fixes found in a review of 0.1.2, no runtime dependencies, and the release standards of mssql-ocp-migrate and lodestream. Each fix has a test (`tests/test_hardening.py`, `tests/test_fidelity.py`, `tests/test_stdlib.py`) that fails on 0.1.2.
|
|
@@ -36,7 +61,7 @@ Fixes found in a review of 0.1.2, no runtime dependencies, and the release stand
|
|
|
36
61
|
|
|
37
62
|
### Changed
|
|
38
63
|
- **No runtime dependencies.** `requests`, `requests-ntlm`, `pydantic` and `PyYAML` are replaced by standard-library code in the package: an HTTP client (`transport.py`: TLS verification or a CA bundle, proxies from `HTTPS_PROXY`/`NO_PROXY`, redirects checked hop by hop by the network policy), NTLMv2 Windows sign-in with channel binding on HTTPS (`ntlm.py`, checked against the MS-NLMP test vectors), validated records (`model.py`) and a YAML reader for the config file (`yamlish.py`, which refuses anchors, tags, tabs and duplicate keys with a line number). `pip install sp2react` installs one wheel. The `ntlm` extra remains, empty
|
|
39
|
-
- Docs: workflows, event receivers, InfoPath and Power Apps are listed as not detected (they were described as reported); remaining known gaps are listed in [
|
|
64
|
+
- Docs: workflows, event receivers, InfoPath and Power Apps are listed as not detected (they were described as reported); remaining known gaps are listed in [Coverage and limitations](https://sp2react.readthedocs.io/en/latest/user_guide/limitations.html)
|
|
40
65
|
|
|
41
66
|
## [0.1.2] - 2026-10-29
|
|
42
67
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
We want sp2react to be a project where anyone can ask a question, report a problem or contribute
|
|
4
|
+
without being made to feel unwelcome.
|
|
5
|
+
|
|
6
|
+
## Expected behaviour
|
|
7
|
+
|
|
8
|
+
- Be respectful and patient, including with people who are new to the project or to the technologies it
|
|
9
|
+
touches (SharePoint, React, FastAPI, the model provider).
|
|
10
|
+
- Discuss ideas and code, not people. Critique is welcome when it is specific and constructive.
|
|
11
|
+
- Assume good intent, and ask before concluding otherwise.
|
|
12
|
+
- Respect people's time and privacy: don't share someone else's private information, and remove
|
|
13
|
+
confidential data (host names, credentials, list data, page content) from logs before posting them.
|
|
14
|
+
|
|
15
|
+
## Unacceptable behaviour
|
|
16
|
+
|
|
17
|
+
- Harassment, insults, intimidation or personal attacks of any kind.
|
|
18
|
+
- Discriminatory language or conduct based on any personal characteristic.
|
|
19
|
+
- Sexual language or imagery, and unwelcome attention.
|
|
20
|
+
- Publishing others' private information without their permission.
|
|
21
|
+
- Sustained disruption of discussions, or encouraging any of the above.
|
|
22
|
+
|
|
23
|
+
## Scope
|
|
24
|
+
|
|
25
|
+
This applies in all project spaces (issues, pull requests, discussions, reviews) and when someone
|
|
26
|
+
represents the project elsewhere.
|
|
27
|
+
|
|
28
|
+
## Reporting and enforcement
|
|
29
|
+
|
|
30
|
+
Report a problem privately to the maintainer, Karthikeyan Balasundaram ([@karthikbd](https://github.com/karthikbd)),
|
|
31
|
+
using the contact details on that GitHub profile. If the report is sensitive you can also use the
|
|
32
|
+
repository's private reporting form (Security → Report a vulnerability); say in the title that it is a
|
|
33
|
+
conduct report. Reports are kept confidential.
|
|
34
|
+
|
|
35
|
+
The maintainer will review every report, may ask for more information, and will respond within 7 days.
|
|
36
|
+
Possible actions, depending on severity: a private warning, removal of the offending content, a
|
|
37
|
+
temporary or permanent ban from project spaces. If a report concerns the maintainer, it will be handled
|
|
38
|
+
by another maintainer once there is one; until then you may raise it with GitHub through its
|
|
39
|
+
[reporting tools](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam).
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Contributing to sp2react
|
|
2
|
+
|
|
3
|
+
Thanks for helping. Bug reports, documentation fixes, new SharePoint patterns the analysis should recognise and better generated code are all welcome.
|
|
4
|
+
|
|
5
|
+
## Reporting bugs and asking questions
|
|
6
|
+
|
|
7
|
+
- **Bugs and feature requests:** open a [GitHub issue](https://github.com/karthikbd/sp2react/issues).
|
|
8
|
+
Include the sp2react version (`sp2react --version`), Python version, SharePoint version, the
|
|
9
|
+
command you ran, and the output of `sp2react doctor` if it is relevant. Remove host names,
|
|
10
|
+
credentials, list data and page content you can't share.
|
|
11
|
+
- **Security vulnerabilities:** do **not** open a public issue. Report them privately as described in
|
|
12
|
+
[SECURITY.md](SECURITY.md).
|
|
13
|
+
|
|
14
|
+
The maintainer aims to respond to new issues within 7 days.
|
|
15
|
+
|
|
16
|
+
## Making a change
|
|
17
|
+
|
|
18
|
+
1. Open an issue first for anything larger than a small fix, so the approach can be agreed.
|
|
19
|
+
2. Fork the repository and create a branch from `main`. `main` only accepts pull requests whose
|
|
20
|
+
required checks pass; nobody, including the maintainer, pushes to it directly.
|
|
21
|
+
3. Set up a development environment:
|
|
22
|
+
|
|
23
|
+
```console
|
|
24
|
+
$ python -m venv .venv && . .venv/bin/activate
|
|
25
|
+
$ pip install --require-hashes -r ci/requirements-test.txt
|
|
26
|
+
$ pip install --no-deps -e .
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
4. Make the change, **with tests** (see below), and update the documentation in `docs/` and
|
|
30
|
+
`CHANGELOG.md` when behaviour changes. Sign off every commit (`git commit -s`, see
|
|
31
|
+
*Developer Certificate of Origin* below).
|
|
32
|
+
5. Run the checks CI runs:
|
|
33
|
+
|
|
34
|
+
```console
|
|
35
|
+
$ ruff check src tests # lint: must be clean
|
|
36
|
+
$ mypy src # types: must be clean
|
|
37
|
+
$ python -m coverage run -m pytest -q # unit, pipeline, generated-app and over-the-wire HTTP tests (Node 22 for the TypeScript ones)
|
|
38
|
+
$ python -m coverage report # statement coverage must stay at 80% or more
|
|
39
|
+
$ python -m sphinx -W -b html docs docs/_build/html # docs: warnings are errors
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
6. Open a pull request against `main`. CI runs the tests on Python 3.10–3.13, the end-to-end suite
|
|
43
|
+
against MySQL 8.4 and SQL Server 2022, a reproducible-build check, CodeQL, dependency review, the
|
|
44
|
+
DCO check, a vulnerability audit and ClusterFuzzLite fuzzing. All of them must pass.
|
|
45
|
+
|
|
46
|
+
## Code review
|
|
47
|
+
|
|
48
|
+
Every change is reviewed before it is merged:
|
|
49
|
+
|
|
50
|
+
- the reviewer checks that the change does what the pull request says, has tests that would fail
|
|
51
|
+
without it, keeps the documentation and changelog current, introduces no new runtime dependency or
|
|
52
|
+
network access, and does not weaken the security properties in the documentation's
|
|
53
|
+
*Security assurance case* (new inputs, files written, connections or generated-app endpoints are added to it);
|
|
54
|
+
- a change to `scaffold/templates` says whether existing generated apps must be regenerated, and keeps
|
|
55
|
+
the browser and API rule engines in agreement (`scaffold/rule_vectors.json`);
|
|
56
|
+
- all required checks must pass: tests, lint, types, coverage, docs, reproducible build, CodeQL,
|
|
57
|
+
dependency review and the DCO check;
|
|
58
|
+
- review comments are resolved before merging. While the project has one maintainer, the maintainer's
|
|
59
|
+
own pull requests are checked against the same list; a second reviewer is a goal (see
|
|
60
|
+
[ROADMAP.md](ROADMAP.md)).
|
|
61
|
+
|
|
62
|
+
Good first contributions are labelled
|
|
63
|
+
[`good first issue`](https://github.com/karthikbd/sp2react/labels/good%20first%20issue).
|
|
64
|
+
|
|
65
|
+
## Coding standards
|
|
66
|
+
|
|
67
|
+
- Python code follows [PEP 8](https://peps.python.org/pep-0008/) as enforced by `ruff` with the rule sets
|
|
68
|
+
in `pyproject.toml` (pycodestyle, pyflakes, bugbear, simplify, Bandit security rules, comprehensions,
|
|
69
|
+
ruff-specific rules), and is fully typed: `mypy` runs in **strict** mode.
|
|
70
|
+
- The generated app's TypeScript is type-checked (`tsc --noEmit`) and built in the tests.
|
|
71
|
+
- Both run in CI on every push and pull request and must be clean.
|
|
72
|
+
|
|
73
|
+
## Rules for code
|
|
74
|
+
|
|
75
|
+
- **No runtime dependencies.** sp2react must install and run with the Python standard library only.
|
|
76
|
+
The database extras (SQLAlchemy and a driver) are imported inside the functions that need them.
|
|
77
|
+
The `zero-deps` CI job installs the package alone and runs it.
|
|
78
|
+
- **No network access except to configured systems.** Only `src/sp2react/transport.py` opens
|
|
79
|
+
connections, every request passes `net.NetworkPolicy`, and SharePoint is read with GET only.
|
|
80
|
+
`tests/test_network.py` enforces this.
|
|
81
|
+
- **Agents never write unchecked output.** Anything an agent returns is validated in
|
|
82
|
+
`agents/tasks.py` before it is accepted, and file paths must stay inside their screen's folder.
|
|
83
|
+
- **Tests are required.** New functionality needs tests that would fail without it; bug fixes need a
|
|
84
|
+
regression test. Code that talks to SharePoint needs a test against the mock site
|
|
85
|
+
(`tests/mock_sharepoint.py`); database code runs in the end-to-end job against real servers.
|
|
86
|
+
The browser and API rule engines must agree on `scaffold/rule_vectors.json`.
|
|
87
|
+
- **Legacy pages, agent output and configs are untrusted.** Parsing code should have a fuzz target in
|
|
88
|
+
`tests/fuzz` (Atheris).
|
|
89
|
+
- **Style:** `ruff` and `mypy --strict` clean.
|
|
90
|
+
- **CI tooling is hash-locked.** To change a tool version, edit `ci/requirements-*.in` and regenerate
|
|
91
|
+
the `.txt` file with `uv pip compile --universal --generate-hashes --python-version 3.X ci/requirements-X.in -o ci/requirements-X.txt`,
|
|
92
|
+
using the lowest Python version of the jobs that install it (see the header of each `.txt` file).
|
|
93
|
+
GitHub Actions are pinned by commit SHA.
|
|
94
|
+
|
|
95
|
+
## Developer Certificate of Origin (DCO)
|
|
96
|
+
|
|
97
|
+
By contributing you certify the [Developer Certificate of Origin 1.1](https://developercertificate.org/):
|
|
98
|
+
that you wrote the change or otherwise have the right to submit it under the project's license. Show this
|
|
99
|
+
by adding a `Signed-off-by` line with your real name and e-mail to every commit (`git commit -s`). The
|
|
100
|
+
`DCO` check fails a pull request that has an unsigned commit; fix it with
|
|
101
|
+
`git rebase --signoff main` and a force-push to your branch.
|
|
102
|
+
|
|
103
|
+
## Licensing of contributions
|
|
104
|
+
|
|
105
|
+
sp2react is MIT-licensed. By submitting a pull request you agree that your contribution is licensed
|
|
106
|
+
under the same [MIT License](LICENSE), and you confirm you have the right to submit it. Code copied
|
|
107
|
+
from other projects must have a compatible license and be recorded in `THIRD_PARTY_NOTICES.md`.
|
|
108
|
+
|
|
109
|
+
## Releases
|
|
110
|
+
|
|
111
|
+
Releases follow [semantic versioning](https://semver.org/) and are described in `CHANGELOG.md`. To release:
|
|
112
|
+
bump the version in `pyproject.toml` and `src/sp2react/__init__.py`, date the CHANGELOG entry, add the release's
|
|
113
|
+
template hashes to `src/sp2react/scaffold/released_templates.json`, merge to `main`, then publish a GitHub release
|
|
114
|
+
`vX.Y.Z`. `python-publish.yml` tests, builds, publishes with Trusted Publishing and signs the assets;
|
|
115
|
+
`verify-release.yml` then checks the signatures and the files on PyPI. The full checklist is in the
|
|
116
|
+
documentation's *Releasing* page.
|
|
117
|
+
|
|
118
|
+
## Project
|
|
119
|
+
|
|
120
|
+
- [Governance](GOVERNANCE.md): roles, decisions, who holds which keys, continuity.
|
|
121
|
+
- [Roadmap](ROADMAP.md): plans for the next 12 months.
|
|
122
|
+
- [Code of Conduct](CODE_OF_CONDUCT.md): applies in every project space.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Governance
|
|
2
|
+
|
|
3
|
+
sp2react is a small project with a single maintainer. This document says who decides what, who holds
|
|
4
|
+
which keys, and what happens if the maintainer becomes unavailable. It changes through a pull request
|
|
5
|
+
like any other file.
|
|
6
|
+
|
|
7
|
+
## Roles
|
|
8
|
+
|
|
9
|
+
| Role | Who | Responsibilities |
|
|
10
|
+
|---|---|---|
|
|
11
|
+
| **Maintainer** | Karthikeyan Balasundaram ([@karthikbd](https://github.com/karthikbd)) | Sets direction (see [ROADMAP.md](ROADMAP.md)); reviews and merges pull requests; cuts releases; answers security reports (see [SECURITY.md](SECURITY.md)); keeps CI, dependencies and documentation current; enforces the [Code of Conduct](CODE_OF_CONDUCT.md). |
|
|
12
|
+
| **Contributor** | Anyone who opens an issue or pull request | Follows [CONTRIBUTING.md](CONTRIBUTING.md), signs off commits (DCO), keeps changes tested and documented. |
|
|
13
|
+
| **Security reporter** | Anyone | Reports vulnerabilities privately as described in [SECURITY.md](SECURITY.md); is credited unless they ask not to be. |
|
|
14
|
+
|
|
15
|
+
## Decisions
|
|
16
|
+
|
|
17
|
+
- Day-to-day decisions (accepting a pull request, scheduling a release) are made by the maintainer, in
|
|
18
|
+
the open: in the pull request or issue concerned.
|
|
19
|
+
- Larger changes (a new stage or agent, a change to the generated app's layout or API, a breaking
|
|
20
|
+
change to `sp2react.yaml`, a new runtime dependency, which is normally refused) start as an issue so they can be discussed before code is written.
|
|
21
|
+
- Disagreements are settled by discussion on the issue; if that doesn't settle them, the maintainer
|
|
22
|
+
decides and records the reasoning there.
|
|
23
|
+
|
|
24
|
+
## Access to sensitive resources
|
|
25
|
+
|
|
26
|
+
Everyone with access is listed here; there is no other access.
|
|
27
|
+
|
|
28
|
+
| Resource | Who has access | Notes |
|
|
29
|
+
|---|---|---|
|
|
30
|
+
| GitHub repository (admin) | Maintainer | Two-factor authentication required. `main` accepts changes only through pull requests with passing checks. |
|
|
31
|
+
| PyPI project `sp2react` | No person publishes | Releases are uploaded only by the `python-publish.yml` workflow through PyPI Trusted Publishing (OIDC), from the protected `release` environment. No API token exists. |
|
|
32
|
+
| Model provider credentials | None held by the project | Tests use a scripted model; no API key or Copilot token is stored in the repository or its CI. |
|
|
33
|
+
| Release signing | No long-lived key | Sigstore keyless signing in the release workflow, tied to the workflow's identity. |
|
|
34
|
+
| Read the Docs project | Maintainer | Builds from the GitHub repository through the Read the Docs GitHub App. |
|
|
35
|
+
| OpenSSF Best Practices entry | Maintainer | sp2react's entry on bestpractices.dev (linked from the README badge). |
|
|
36
|
+
|
|
37
|
+
## New maintainers and changes to permissions
|
|
38
|
+
|
|
39
|
+
- Someone becomes a maintainer after a sustained record of reviewed contributions, by agreement of the
|
|
40
|
+
existing maintainer(s), recorded in a pull request that updates this file.
|
|
41
|
+
- New collaborators start with the lowest GitHub role that lets them do their task (triage, then
|
|
42
|
+
write); admin rights and the PyPI/Read the Docs roles are granted only to maintainers.
|
|
43
|
+
- Any request to raise someone's permissions is reviewed by an existing maintainer before it is
|
|
44
|
+
granted, and the change is recorded in this file.
|
|
45
|
+
- Access is removed when it is no longer used, and at the latest after 12 months of inactivity.
|
|
46
|
+
|
|
47
|
+
## Continuity
|
|
48
|
+
|
|
49
|
+
The project currently has one maintainer (a "bus factor" of 1), which we would like to change; see
|
|
50
|
+
[ROADMAP.md](ROADMAP.md). Until then:
|
|
51
|
+
|
|
52
|
+
- everything needed to build, test and release is in the repository and runs in GitHub Actions; no
|
|
53
|
+
secret or personal machine is involved, so anyone with admin rights can release;
|
|
54
|
+
- the maintainer's GitHub account has a designated successor, so the repository (and through Trusted
|
|
55
|
+
Publishing, the ability to release) can be handed over if the maintainer is unable to continue;
|
|
56
|
+
- the project is MIT-licensed, so anyone may fork and continue it.
|
|
@@ -2,7 +2,9 @@ include README.md
|
|
|
2
2
|
include LICENSE
|
|
3
3
|
include CHANGELOG.md
|
|
4
4
|
include SECURITY.md
|
|
5
|
+
include GOVERNANCE.md CODE_OF_CONDUCT.md ROADMAP.md CONTRIBUTING.md THIRD_PARTY_NOTICES.md vex.openvex.json
|
|
5
6
|
recursive-include src/sp2react/agents/prompts *.md
|
|
7
|
+
include src/sp2react/container/Dockerfile
|
|
6
8
|
recursive-include src/sp2react/scaffold *
|
|
7
9
|
recursive-include tests *
|
|
8
10
|
prune examples
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sp2react
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.4
|
|
4
4
|
Summary: AI-agent pipeline that converts classic SharePoint ASPX/jQuery list forms and pages into a React + FastAPI app on your existing database. Zero runtime dependencies.
|
|
5
5
|
Author: Karthikeyan Balasundaram
|
|
6
6
|
License-Expression: MIT
|
|
@@ -53,6 +53,7 @@ Dynamic: license-file
|
|
|
53
53
|
[](LICENSE)
|
|
54
54
|
[](https://github.com/karthikbd/sp2react/actions/workflows/cflite_batch.yml)
|
|
55
55
|
[](https://securityscorecards.dev/viewer/?uri=github.com/karthikbd/sp2react)
|
|
56
|
+
[](https://www.bestpractices.dev/projects/16934)
|
|
56
57
|
|
|
57
58
|
Convert classic SharePoint (2013 / 2016 / 2019 / Subscription Edition) list forms and pages built with **ASPX, jQuery and SPServices** into a **React + FastAPI** app that runs on **your existing database**.
|
|
58
59
|
|
|
@@ -87,18 +88,18 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
|
|
|
87
88
|
|
|
88
89
|
| Guide | |
|
|
89
90
|
|---|---|
|
|
90
|
-
| [How it works](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
91
|
-
| [Installation](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
92
|
-
| [Configuration reference](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
93
|
-
| [Model provider and Bridger](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
94
|
-
| [Your database](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
95
|
-
| [End-to-end walkthrough](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
96
|
-
| [Command reference](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
97
|
-
| [The generated app](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
98
|
-
| [Security](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
99
|
-
| [Troubleshooting](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
100
|
-
| [Python API](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
101
|
-
| [Coverage and limitations](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
91
|
+
| [How it works](https://github.com/karthikbd/sp2react/blob/main/docs/getting_started/how-it-works.md) | stages, agents, data sources |
|
|
92
|
+
| [Installation](https://github.com/karthikbd/sp2react/blob/main/docs/getting_started/install.md) | Windows, corporate networks (JFrog), drivers, Node.js |
|
|
93
|
+
| [Configuration reference](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/configuration.md) | every `sp2react.yaml` key and environment variable |
|
|
94
|
+
| [Model provider and Bridger](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/model-provider.md) | Claude through Copilot Bridger, Anthropic, Azure OpenAI |
|
|
95
|
+
| [Your database](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/database.md) | SQL Server, MySQL, PostgreSQL; `map-db`; the mapping file; reconcile |
|
|
96
|
+
| [End-to-end walkthrough](https://github.com/karthikbd/sp2react/blob/main/docs/getting_started/walkthrough.md) | a site from start to deployed app |
|
|
97
|
+
| [Command reference](https://github.com/karthikbd/sp2react/blob/main/docs/reference/cli.md) | every command and option, every file written |
|
|
98
|
+
| [The generated app](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/generated-app.md) | layout, settings, roles, API, tests, deployment |
|
|
99
|
+
| [Security](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/security.md) | what is read, sent and written |
|
|
100
|
+
| [Troubleshooting](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/troubleshooting.md) | errors and fixes |
|
|
101
|
+
| [Python API](https://github.com/karthikbd/sp2react/blob/main/docs/reference/api.md) | drive sp2react from your own tool |
|
|
102
|
+
| [Coverage and limitations](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/limitations.md) | what converts and what does not |
|
|
102
103
|
|
|
103
104
|
## Installation
|
|
104
105
|
|
|
@@ -117,10 +118,14 @@ Python 3.10+. Node.js 20+ is needed to build the generated React app.
|
|
|
117
118
|
## Security and supply chain
|
|
118
119
|
|
|
119
120
|
No runtime dependencies, no telemetry; connections go only to the SharePoint site and the model endpoint in your
|
|
120
|
-
config.
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
121
|
+
config. Code the agents write runs only in a sandbox (a Docker/Podman container, or a guard that blocks
|
|
122
|
+
writes, processes and network) while sp2react tests it; NTLM sign-in is an explicit, https-only choice. Releases are published with PyPI Trusted Publishing and carry provenance attestations, plus
|
|
123
|
+
Sigstore-signed assets and a CycloneDX SBOM on GitHub, and builds are reproducible. CI is hash-locked, runs a weekly
|
|
124
|
+
`pip-audit` (and `npm audit` of the generated app's front end), CodeQL, `mypy --strict` with Bandit security lint,
|
|
125
|
+
a coverage floor, OpenSSF Scorecard and ClusterFuzzLite fuzzing of the parsers; pull requests need signed-off commits
|
|
126
|
+
and pass dependency review. See [SECURITY.md](SECURITY.md), the
|
|
127
|
+
[security assurance case](https://sp2react.readthedocs.io/en/latest/development/security-assurance.html),
|
|
128
|
+
[GOVERNANCE.md](GOVERNANCE.md) and [ROADMAP.md](ROADMAP.md).
|
|
124
129
|
|
|
125
130
|
## Quick Start
|
|
126
131
|
|
|
@@ -144,7 +149,7 @@ sp2react status
|
|
|
144
149
|
```yaml
|
|
145
150
|
sharepoint:
|
|
146
151
|
site_url: https://sharepoint.example.com/sites/SEA
|
|
147
|
-
auth: ntlm # ntlm | cookie | bearer | none ; secrets come from environment variables
|
|
152
|
+
auth: ntlm # required: ntlm (https only) | cookie | bearer | none ; secrets come from environment variables
|
|
148
153
|
llm:
|
|
149
154
|
provider: bridger # bridger | anthropic | openai | azure_openai
|
|
150
155
|
api_format: anthropic # how Bridger serves Claude: anthropic (/v1/messages) or openai (/v1/chat/completions)
|
|
@@ -237,8 +242,8 @@ Run the inventory on your site first. It shows which pages and scripts were foun
|
|
|
237
242
|
## Running Tests
|
|
238
243
|
|
|
239
244
|
```bash
|
|
240
|
-
pip install -e
|
|
241
|
-
python -m pytest tests/ -
|
|
245
|
+
pip install --require-hashes -r ci/requirements-test.txt && pip install --no-deps -e .
|
|
246
|
+
python -m coverage run -m pytest tests/ -q && python -m coverage report
|
|
242
247
|
```
|
|
243
248
|
|
|
244
249
|
The suite runs against `tests/fixtures/legacy-site`, a fictional Contoso procurement site with jQuery 1.12 / SPServices list forms and a REST-driven dashboard. It covers:
|
|
@@ -251,9 +256,12 @@ The suite runs against `tests/fixtures/legacy-site`, a fictional Contoso procure
|
|
|
251
256
|
|
|
252
257
|
## CI / CD
|
|
253
258
|
|
|
254
|
-
- `tests.yml`:
|
|
255
|
-
- `
|
|
256
|
-
- `
|
|
259
|
+
- `tests.yml`: the test suite with coverage on Python 3.10–3.13 (ruff, `mypy --strict`), a zero-dependency install, a reproducible-build check and a warnings-as-errors docs build, on every push and pull request.
|
|
260
|
+
- `e2e.yml`: `data_source: database` against MySQL 8.4 and SQL Server 2022.
|
|
261
|
+
- `codeql.yml`, `vulnerability-audit.yml`, `cflite_pr.yml` / `cflite_batch.yml`, `scorecard.yml`; on pull requests `dependency-review.yml` and `dco.yml`.
|
|
262
|
+
- `python-publish.yml`: on a published GitHub release, tests, builds and publishes to PyPI through **Trusted Publishing** (OIDC, no stored token) and signs the assets; `verify-release.yml` re-checks them.
|
|
263
|
+
|
|
264
|
+
`main` accepts changes only through pull requests whose required checks pass.
|
|
257
265
|
|
|
258
266
|
## Security
|
|
259
267
|
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
[](LICENSE)
|
|
9
9
|
[](https://github.com/karthikbd/sp2react/actions/workflows/cflite_batch.yml)
|
|
10
10
|
[](https://securityscorecards.dev/viewer/?uri=github.com/karthikbd/sp2react)
|
|
11
|
+
[](https://www.bestpractices.dev/projects/16934)
|
|
11
12
|
|
|
12
13
|
Convert classic SharePoint (2013 / 2016 / 2019 / Subscription Edition) list forms and pages built with **ASPX, jQuery and SPServices** into a **React + FastAPI** app that runs on **your existing database**.
|
|
13
14
|
|
|
@@ -42,18 +43,18 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
|
|
|
42
43
|
|
|
43
44
|
| Guide | |
|
|
44
45
|
|---|---|
|
|
45
|
-
| [How it works](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
46
|
-
| [Installation](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
47
|
-
| [Configuration reference](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
48
|
-
| [Model provider and Bridger](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
49
|
-
| [Your database](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
50
|
-
| [End-to-end walkthrough](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
51
|
-
| [Command reference](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
52
|
-
| [The generated app](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
53
|
-
| [Security](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
54
|
-
| [Troubleshooting](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
55
|
-
| [Python API](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
56
|
-
| [Coverage and limitations](https://github.com/karthikbd/sp2react/blob/main/docs/
|
|
46
|
+
| [How it works](https://github.com/karthikbd/sp2react/blob/main/docs/getting_started/how-it-works.md) | stages, agents, data sources |
|
|
47
|
+
| [Installation](https://github.com/karthikbd/sp2react/blob/main/docs/getting_started/install.md) | Windows, corporate networks (JFrog), drivers, Node.js |
|
|
48
|
+
| [Configuration reference](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/configuration.md) | every `sp2react.yaml` key and environment variable |
|
|
49
|
+
| [Model provider and Bridger](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/model-provider.md) | Claude through Copilot Bridger, Anthropic, Azure OpenAI |
|
|
50
|
+
| [Your database](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/database.md) | SQL Server, MySQL, PostgreSQL; `map-db`; the mapping file; reconcile |
|
|
51
|
+
| [End-to-end walkthrough](https://github.com/karthikbd/sp2react/blob/main/docs/getting_started/walkthrough.md) | a site from start to deployed app |
|
|
52
|
+
| [Command reference](https://github.com/karthikbd/sp2react/blob/main/docs/reference/cli.md) | every command and option, every file written |
|
|
53
|
+
| [The generated app](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/generated-app.md) | layout, settings, roles, API, tests, deployment |
|
|
54
|
+
| [Security](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/security.md) | what is read, sent and written |
|
|
55
|
+
| [Troubleshooting](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/troubleshooting.md) | errors and fixes |
|
|
56
|
+
| [Python API](https://github.com/karthikbd/sp2react/blob/main/docs/reference/api.md) | drive sp2react from your own tool |
|
|
57
|
+
| [Coverage and limitations](https://github.com/karthikbd/sp2react/blob/main/docs/user_guide/limitations.md) | what converts and what does not |
|
|
57
58
|
|
|
58
59
|
## Installation
|
|
59
60
|
|
|
@@ -72,10 +73,14 @@ Python 3.10+. Node.js 20+ is needed to build the generated React app.
|
|
|
72
73
|
## Security and supply chain
|
|
73
74
|
|
|
74
75
|
No runtime dependencies, no telemetry; connections go only to the SharePoint site and the model endpoint in your
|
|
75
|
-
config.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
76
|
+
config. Code the agents write runs only in a sandbox (a Docker/Podman container, or a guard that blocks
|
|
77
|
+
writes, processes and network) while sp2react tests it; NTLM sign-in is an explicit, https-only choice. Releases are published with PyPI Trusted Publishing and carry provenance attestations, plus
|
|
78
|
+
Sigstore-signed assets and a CycloneDX SBOM on GitHub, and builds are reproducible. CI is hash-locked, runs a weekly
|
|
79
|
+
`pip-audit` (and `npm audit` of the generated app's front end), CodeQL, `mypy --strict` with Bandit security lint,
|
|
80
|
+
a coverage floor, OpenSSF Scorecard and ClusterFuzzLite fuzzing of the parsers; pull requests need signed-off commits
|
|
81
|
+
and pass dependency review. See [SECURITY.md](SECURITY.md), the
|
|
82
|
+
[security assurance case](https://sp2react.readthedocs.io/en/latest/development/security-assurance.html),
|
|
83
|
+
[GOVERNANCE.md](GOVERNANCE.md) and [ROADMAP.md](ROADMAP.md).
|
|
79
84
|
|
|
80
85
|
## Quick Start
|
|
81
86
|
|
|
@@ -99,7 +104,7 @@ sp2react status
|
|
|
99
104
|
```yaml
|
|
100
105
|
sharepoint:
|
|
101
106
|
site_url: https://sharepoint.example.com/sites/SEA
|
|
102
|
-
auth: ntlm # ntlm | cookie | bearer | none ; secrets come from environment variables
|
|
107
|
+
auth: ntlm # required: ntlm (https only) | cookie | bearer | none ; secrets come from environment variables
|
|
103
108
|
llm:
|
|
104
109
|
provider: bridger # bridger | anthropic | openai | azure_openai
|
|
105
110
|
api_format: anthropic # how Bridger serves Claude: anthropic (/v1/messages) or openai (/v1/chat/completions)
|
|
@@ -192,8 +197,8 @@ Run the inventory on your site first. It shows which pages and scripts were foun
|
|
|
192
197
|
## Running Tests
|
|
193
198
|
|
|
194
199
|
```bash
|
|
195
|
-
pip install -e
|
|
196
|
-
python -m pytest tests/ -
|
|
200
|
+
pip install --require-hashes -r ci/requirements-test.txt && pip install --no-deps -e .
|
|
201
|
+
python -m coverage run -m pytest tests/ -q && python -m coverage report
|
|
197
202
|
```
|
|
198
203
|
|
|
199
204
|
The suite runs against `tests/fixtures/legacy-site`, a fictional Contoso procurement site with jQuery 1.12 / SPServices list forms and a REST-driven dashboard. It covers:
|
|
@@ -206,9 +211,12 @@ The suite runs against `tests/fixtures/legacy-site`, a fictional Contoso procure
|
|
|
206
211
|
|
|
207
212
|
## CI / CD
|
|
208
213
|
|
|
209
|
-
- `tests.yml`:
|
|
210
|
-
- `
|
|
211
|
-
- `
|
|
214
|
+
- `tests.yml`: the test suite with coverage on Python 3.10–3.13 (ruff, `mypy --strict`), a zero-dependency install, a reproducible-build check and a warnings-as-errors docs build, on every push and pull request.
|
|
215
|
+
- `e2e.yml`: `data_source: database` against MySQL 8.4 and SQL Server 2022.
|
|
216
|
+
- `codeql.yml`, `vulnerability-audit.yml`, `cflite_pr.yml` / `cflite_batch.yml`, `scorecard.yml`; on pull requests `dependency-review.yml` and `dco.yml`.
|
|
217
|
+
- `python-publish.yml`: on a published GitHub release, tests, builds and publishes to PyPI through **Trusted Publishing** (OIDC, no stored token) and signs the assets; `verify-release.yml` re-checks them.
|
|
218
|
+
|
|
219
|
+
`main` accepts changes only through pull requests whose required checks pass.
|
|
212
220
|
|
|
213
221
|
## Security
|
|
214
222
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Roadmap
|
|
2
|
+
|
|
3
|
+
What we plan for the next 12 months (December 2026 to November 2027). Plans change; issues and pull
|
|
4
|
+
requests that move these forward are welcome, and each item will get its own issue when work starts.
|
|
5
|
+
|
|
6
|
+
## Project health
|
|
7
|
+
|
|
8
|
+
- **A second maintainer** (ideally from another organization), so changes get a second reviewer, releases
|
|
9
|
+
don't depend on one person, and the project can reach the OpenSSF Best Practices **gold** level and
|
|
10
|
+
**baseline level 3** (non-author approval on every merge).
|
|
11
|
+
- **Coverage**: raise statement coverage from about 85% to 90% and branch coverage from about 76% to
|
|
12
|
+
80% (gold levels); the command-line module and the model providers are the least covered today.
|
|
13
|
+
- **Copyright and SPDX license lines** in every source file.
|
|
14
|
+
- Mark issues suitable for new contributors with the `good first issue` label.
|
|
15
|
+
|
|
16
|
+
## Conversion
|
|
17
|
+
|
|
18
|
+
- **Site-wide assessment**: one command that walks Site Contents (subsites, lists and libraries, content
|
|
19
|
+
types, workflows, event receivers, InfoPath forms) and writes a per-page conversion readiness report.
|
|
20
|
+
- **Buttons and commands**: inventory of ribbon actions, custom buttons and `onclick` handlers, mapped to
|
|
21
|
+
spec actions.
|
|
22
|
+
- **Views**: filters and grouping, and a richer grid (sort, search, select, export).
|
|
23
|
+
- **Dialogs**: `SP.UI.ModalDialog` pages to React dialogs.
|
|
24
|
+
- **Branding**: capture of master-page branding into the generated app's theme.
|
|
25
|
+
- **Document libraries** as screens.
|
|
26
|
+
- **Compare view**: SharePoint and the generated screen side by side.
|
|
27
|
+
|
|
28
|
+
## Generated application
|
|
29
|
+
|
|
30
|
+
- **GraphQL API** as an option next to the REST (FastAPI) API, chosen per project.
|
|
31
|
+
- **Material UI** components as an option for the generated front end.
|
|
32
|
+
- **Reusable conversion skills**: a library of written conversion patterns the agents follow, so common
|
|
33
|
+
SharePoint idioms convert the same way every time.
|
|
34
|
+
- **Agents through a coding CLI**: drive the convert and fix stages through a coding agent's command line
|
|
35
|
+
(one long-lived session, renewed only when it slows down) as well as through model APIs.
|
|
36
|
+
|
|
37
|
+
## Releases
|
|
38
|
+
|
|
39
|
+
About one minor release per quarter, patch releases as needed (see [SECURITY.md](SECURITY.md) for which
|
|
40
|
+
versions receive fixes). Every release is signed, reproducible and listed in [CHANGELOG.md](CHANGELOG.md).
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported versions and end of support
|
|
4
|
+
|
|
5
|
+
| Version | Security fixes |
|
|
6
|
+
|---------|----------------|
|
|
7
|
+
| 0.1.x | ✅ yes: the latest release line |
|
|
8
|
+
| older | ❌ no: upgrade to the latest release |
|
|
9
|
+
|
|
10
|
+
Only the latest minor release line receives fixes. When a new minor version is released, the previous
|
|
11
|
+
one stops receiving security updates **on that day**; this is announced in [CHANGELOG.md](CHANGELOG.md).
|
|
12
|
+
Upgrading within 0.x keeps `sp2react.yaml`, the workspace and generated apps working unless the changelog
|
|
13
|
+
says otherwise (regeneration keeps files you changed; see the documentation's *The generated app* page),
|
|
14
|
+
so the upgrade path is always "install the latest release". Before 1.0, minor versions may change
|
|
15
|
+
behaviour; each change is listed in the changelog.
|
|
16
|
+
|
|
17
|
+
## Reporting a Vulnerability
|
|
18
|
+
|
|
19
|
+
**Please do not open a public GitHub issue for security vulnerabilities.**
|
|
20
|
+
|
|
21
|
+
Report vulnerabilities privately via GitHub's [Security Advisories](https://github.com/karthikbd/sp2react/security/advisories/new).
|
|
22
|
+
|
|
23
|
+
You can expect:
|
|
24
|
+
- **Acknowledgement** within 48 hours
|
|
25
|
+
- **Status update** within 7 days
|
|
26
|
+
- **Fix or mitigation** as soon as reasonably possible, coordinated with a disclosure date
|
|
27
|
+
|
|
28
|
+
## How reports are handled
|
|
29
|
+
|
|
30
|
+
1. **Acknowledge** within 48 hours and agree on a way to keep in touch.
|
|
31
|
+
2. **Triage** within 7 days: reproduce, assess severity (CVSS v4), and decide whether the report is a
|
|
32
|
+
vulnerability in sp2react, in the application it generates, or in something it uses.
|
|
33
|
+
3. **Fix** on a private fork (GitHub Security Advisory), with a regression test. Target: 30 days for
|
|
34
|
+
high and critical issues, 60 days for medium; low-severity issues may be fixed in the next release.
|
|
35
|
+
4. **Release** a patched version, then **publish** the advisory with a CVE (requested through GitHub)
|
|
36
|
+
and list the fix under *Security* in the changelog. A fix in the generated app's templates says
|
|
37
|
+
whether existing apps must be regenerated.
|
|
38
|
+
5. **Credit** the reporter by name in the advisory and the release notes, unless they prefer otherwise.
|
|
39
|
+
|
|
40
|
+
Known vulnerabilities, fixed or not, are published as GitHub Security Advisories for this repository.
|
|
41
|
+
Vulnerabilities in dependencies that do **not** affect sp2react or the apps it generates are recorded in
|
|
42
|
+
the VEX document [`vex.openvex.json`](vex.openvex.json) (OpenVEX), so scanners can tell users they need
|
|
43
|
+
not act.
|
|
44
|
+
|
|
45
|
+
## Network access
|
|
46
|
+
|
|
47
|
+
`sp2react` has no telemetry, no update check and no third-party calls. It opens HTTP connections to exactly two kinds of host, both named in your `sp2react.yaml`:
|
|
48
|
+
|
|
49
|
+
| Host | Why | What is sent / received |
|
|
50
|
+
|------|-----|-------------------------|
|
|
51
|
+
| `sharepoint.site_url` | Read the site being converted | GET requests only (the client refuses any other verb). Page source, web part definitions, custom scripts/CSS, list schemas, views, group names, navigation |
|
|
52
|
+
| `llm.base_url` (Bridger, or the provider you chose) | AI agent calls | Page source, scripts, list schemas and the draft spec or code under review |
|
|
53
|
+
|
|
54
|
+
Every request, and every redirect hop, is checked against that allowlist before it is sent (`sp2react/net.py`); anything else raises `NetworkPolicyError`. Extra hosts must be added explicitly under `security.allowed_hosts`.
|
|
55
|
+
|
|
56
|
+
## Business data
|
|
57
|
+
|
|
58
|
+
With `pipeline.data_source: database` (the default):
|
|
59
|
+
- list items, attachments, site users and rendered pages are **never read** from SharePoint; the client raises `ItemReadBlocked` if anything tries
|
|
60
|
+
- group membership is not read (group names only)
|
|
61
|
+
- no business data is sent to the model; prompts contain code and schema only
|
|
62
|
+
- `sp2react map-db` reads your database **schema** (tables, columns, types, keys) over the database driver; it does not read rows
|
|
63
|
+
|
|
64
|
+
Item reads over HTTP happen only when you set `data_source: sqlite` (sp2react migrates the data itself) or explicitly enable `security.sharepoint_item_reads: true` to reconcile the lists with your tables.
|
|
65
|
+
|
|
66
|
+
## Secrets
|
|
67
|
+
|
|
68
|
+
Credentials are read from environment variables named in the config (`SP_USERNAME`/`SP_PASSWORD`, `SP_COOKIE`, `SP_TOKEN`, the model token, the database URL). They are never written to the workspace, the generated app or agent transcripts. Page source and scripts are sent to the model and kept in the agent transcripts (`sp2react-work/agents/`); if your pages embed secrets in script, remove them before extraction or treat the workspace as secret.
|
|
69
|
+
|
|
70
|
+
## Generated application
|
|
71
|
+
|
|
72
|
+
While sp2react tests it, the generated app's own code (which includes handlers written by AI agents) runs in a sandbox: a Docker or Podman container with no network (or only the database), a read-only file system and no secrets, or, without a container runtime, under a guard that refuses writes outside the app, new processes and other network hosts (`pipeline.sandbox`).
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
The generated FastAPI app defaults to `AUTH_MODE=header`: it trusts the identity header set by an authenticating gateway in front of it and refuses requests without one. `AUTH_MODE=dev` (any user name in an `X-User` header) is for local testing and accepts requests from the same machine only. Before deployment, put the app behind your gateway, or replace `app/auth.py` with Entra ID token validation. The front end shows legacy Content Editor markup only after rebuilding it from an allow-list, and attachment names and the static-file route are checked so no request can read or write outside their folders.
|
|
76
|
+
|
|
77
|
+
## Supply chain
|
|
78
|
+
|
|
79
|
+
- Every CI `pip install` is hash-locked (`ci/requirements-*.txt`); every GitHub Action is pinned to a commit SHA.
|
|
80
|
+
- `vulnerability-audit.yml`: `pip-audit` of all CI tooling (every pinned version, whatever Python it is
|
|
81
|
+
pinned for) and of the generated app's back end, and `npm audit` of its front end, weekly and on every change.
|
|
82
|
+
- On pull requests: dependency review blocks dependencies with known vulnerabilities, and every commit
|
|
83
|
+
must be signed off (DCO).
|
|
84
|
+
- CodeQL and OpenSSF Scorecard on every push to `main` and weekly; Dependabot for actions, CI tooling and
|
|
85
|
+
the generated app's templates.
|
|
86
|
+
- ClusterFuzzLite fuzzing (Atheris) of the config reader, spec validation, ASPX/JavaScript analysis, NTLM
|
|
87
|
+
and the generated API's `$filter` parser on every pull request, push and daily.
|
|
88
|
+
- Releases: PyPI Trusted Publishing with provenance attestations; reproducible builds (checked in CI);
|
|
89
|
+
Sigstore-signed wheel, sdist and a CycloneDX SBOM attached to each GitHub release, re-verified by
|
|
90
|
+
`verify-release.yml`.
|
|
91
|
+
|
|
92
|
+
The documentation's [security assurance case](https://sp2react.readthedocs.io/en/latest/development/security-assurance.html)
|
|
93
|
+
lists the threats considered and what stops each one.
|
|
94
|
+
|
|
95
|
+
## Secrets and credentials used by the project
|
|
96
|
+
|
|
97
|
+
- **None are stored.** PyPI uploads use Trusted Publishing (short-lived OIDC tokens); release signing is
|
|
98
|
+
keyless (Sigstore). The repository has no Actions secrets except GitHub's own `GITHUB_TOKEN`; tests use a
|
|
99
|
+
scripted model, so no model API key or Copilot token is needed in CI.
|
|
100
|
+
- `GITHUB_TOKEN` is read-only by default in every workflow (`permissions: read-all`); jobs ask for write
|
|
101
|
+
access only for what they do (for example `id-token: write` in the publish job).
|
|
102
|
+
- Secret scanning with push protection is enabled; a leaked credential would be revoked at the issuer
|
|
103
|
+
first, then removed from history.
|
|
104
|
+
- If a secret is ever needed, it is stored as a GitHub environment secret limited to the job that uses
|
|
105
|
+
it, reviewed when a maintainer changes and rotated at least yearly.
|