Skip to content

Commit 767a5d3

Browse files
terrxoclaude
andauthored
chore: keep private (in-house) + standard bunfig.toml @grunt-it auth (#3)
Per Nik: fiscalize is an internal grunt-it tool, not a public OSS release. - Scrub "open-source/public" wording from README; license → UNLICENSED; remove MIT LICENSE file (no private:true — GH Packages publish still works). - Ship a committed bunfig.toml ($REGISTRY_TOKEN env ref, no secret in-file) matching app-template/utility-belt; CI sets REGISTRY_TOKEN from secrets so @grunt-it installs resolve. Drop bunfig.example.toml; untrack bunfig.toml. - README install uses the bunfig.toml standard, not a hardcoded gh-auth token. Tests 29/29, tsc clean (no code change). Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 6d75516 commit 767a5d3

8 files changed

Lines changed: 38 additions & 44 deletions

File tree

.github/workflows/publish.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ jobs:
1414
test:
1515
name: Test
1616
runs-on: ubuntu-latest
17+
env:
18+
# Lets `bun install` resolve @grunt-it packages from GitHub Packages via bunfig.toml.
19+
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
1720
steps:
1821
- name: Checkout code
1922
uses: actions/checkout@v4
@@ -40,6 +43,8 @@ jobs:
4043
permissions:
4144
contents: read
4245
packages: write
46+
env:
47+
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
4348
steps:
4449
- name: Checkout code
4550
uses: actions/checkout@v4

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,3 @@ logs
2828

2929
# macOS
3030
.DS_Store
31-
32-
# Bun config with tokens
33-
bunfig.toml

LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# @grunt-it/fiscalize
22

3-
Open-source Slovenian **fiscalization + e-invoicing** toolkit on the grunt-it
3+
Private, in-house **fiscalization + e-invoicing** toolkit for grunt-it, on the
44
TS/Effect stack — the compliance-hard sliver of what Minimax does, as a reusable,
5-
**framework-agnostic** engine (not a full accounting suite).
5+
**framework-agnostic** engine (not a full accounting suite). Internal grunt-it
6+
tool, distributed via GitHub Packages — not a public release.
67

78
It knows nothing about Medusa, HTTP frameworks, or any host: build an invoice,
89
get conformant XML out. Consumers (e.g. a Medusa fiscalization plugin) wrap it as
@@ -29,15 +30,19 @@ fork away from them. Rule-change monitoring is tracked via `upkeep`.
2930

3031
## Install
3132

32-
Published to GitHub Packages. Create a `bunfig.toml`:
33+
Published to **GitHub Packages** under the `@grunt-it` scope. Auth follows the
34+
house standard: a committed `bunfig.toml` that reads the token from the
35+
`REGISTRY_TOKEN` env var (the same config app-template / utility-belt use; CI
36+
provides `REGISTRY_TOKEN` as a secret). In the consuming repo:
3337

3438
```toml
39+
# bunfig.toml — no secret in the file, safe to commit
3540
[install.scopes]
3641
"@grunt-it" = { token = "$REGISTRY_TOKEN", url = "https://npm.pkg.github.com" }
3742
```
3843

3944
```bash
40-
export REGISTRY_TOKEN="ghp_…" # a PAT with read:packages
45+
export REGISTRY_TOKEN="ghp_…" # locally: a PAT with read:packages
4146
bun add @grunt-it/fiscalize
4247
```
4348

@@ -142,4 +147,6 @@ bunx tsc --noEmit
142147

143148
## License
144149

145-
MIT — see [`LICENSE`](./LICENSE).
150+
UNLICENSED — private/internal grunt-it tool. Not for public distribution.
151+
(Bundled third-party schema files keep their own terms — see
152+
[`src/lib/eslog/schema/PROVENANCE.md`](./src/lib/eslog/schema/PROVENANCE.md).)

bunfig.example.toml

Lines changed: 0 additions & 10 deletions
This file was deleted.

bunfig.toml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Bun configuration file
2+
# See https://bun.sh/docs/runtime/bunfig
3+
#
4+
# @grunt-it scoped packages resolve from GitHub Packages. The token is read from
5+
# the REGISTRY_TOKEN env var (a PAT with read:packages) — no secret lives in this
6+
# file, so it is safe to commit. CI provides REGISTRY_TOKEN as a secret.
7+
8+
[install]
9+
[install.scopes]
10+
"@grunt-it" = { token = "$REGISTRY_TOKEN", url = "https://npm.pkg.github.com" }
11+
12+
# Optional: Configure cache directory
13+
# cache = "node_modules/.cache/bun"
14+
15+
# Optional: Set default registry (uncomment if needed)
16+
# registry = "https://registry.npmjs.org"

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
{
22
"name": "@grunt-it/fiscalize",
33
"version": "0.1.0",
4-
"description": "Open-source Slovenian fiscalization + e-invoicing toolkit (TS/Effect). P1: EN16931 → e-SLOG 2.0 / UBL e-invoice generation + validation, deriving from E-Invoice-EU. Framework-agnostic engine.",
4+
"description": "Private/internal grunt-it Slovenian fiscalization + e-invoicing toolkit (TS/Effect). P1: EN16931 → e-SLOG 2.0 / UBL e-invoice generation + validation, deriving from E-Invoice-EU. Framework-agnostic engine.",
55
"type": "module",
6+
"license": "UNLICENSED",
67
"module": "src/index.ts",
78
"exports": {
89
".": "./src/index.ts",
@@ -14,8 +15,7 @@
1415
"files": [
1516
"src",
1617
"README.md",
17-
"ROADMAP.md",
18-
"LICENSE"
18+
"ROADMAP.md"
1919
],
2020
"repository": {
2121
"type": "git",

src/lib/eslog/schema/PROVENANCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ fixture) at `src/test/sample-eslog20-with-bt.xml`, and the 1.6↔2.0 mapping
1515
tables ship in the package as `.xlsx` (not vendored here).
1616

1717
e-SLOG is an open standard for Slovenian electronic business documents; these
18-
schema files are redistributed for interoperability. They are not covered by
19-
this project's MIT license — refer to ePOS/GZS for their terms.
18+
schema files are bundled for interoperability and keep their own terms — refer
19+
to ePOS/GZS. They are not part of this project's own (UNLICENSED, internal) code.

0 commit comments

Comments
 (0)