Skip to content

DX-2984: bundle Box source and docs #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ytkimirti wants to merge 4 commits into
base: main
Choose a base branch
from
Open

DX-2984: bundle Box source and docs #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3632ca5
chore: bundle source and docs
ytkimirti Sep 18, 2026
72cfc22
docs: point JSDoc at bundled docs pages
ytkimirti Sep 25, 2026
8595dec
Merge branch 'main' into DX-2984-bundle-docs
ytkimirti Sep 25, 2026
cdd6a04
docs: add @see to exec.streamCode
ytkimirti Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/easy-experts-peel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@upstash/box": patch
---

Include TypeScript source and documentation in the npm package.
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,6 @@ temp/

# pnpm's local content-addressable store, when one is configured in-repo
.pnpm-store/

# Documentation fetched during packing
/packages/sdk/docs/
1 change: 1 addition & 0 deletions packages/sdk/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
dist
examples
docs/
4 changes: 4 additions & 0 deletions packages/sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ console.log(run.result);
await box.delete();
```

## Docs

The npm package includes TypeScript source in `node_modules/@upstash/box/src/` and documentation in `node_modules/@upstash/box/docs/`. Start with `src/index.ts` to explore the source.

## Authentication

Pass `apiKey` in the config or set the `UPSTASH_BOX_API_KEY` environment variable.
Expand Down
17 changes: 15 additions & 2 deletions packages/sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"format:check": "prettier --check .",
"lint": "prettier --check . --write",
"ci:lint": "prettier --check .",
"prepublishOnly": "node scripts/gen-version.mjs && npm run build"
"prepublishOnly": "node scripts/gen-version.mjs && npm run build",
"prepack": "giget gh:upstash/docs/box docs --force-clean 1>&2"
},
"keywords": [
"upstash",
Expand All @@ -43,6 +44,7 @@
"devDependencies": {
"@types/node": "^20.10.0",
"@types/ws": "^8.18.1",
"giget": "3.3.1",
"prettier": "^3.8.1",
"tsx": "^4.7.0",
"typescript": "^5.3.0"
Expand All @@ -51,7 +53,15 @@
"access": "public"
},
"files": [
"dist"
"dist",
"src",
"docs",
"!src/**/*.test.*",
"!src/**/*.test-d.*",
"!src/**/*.spec.*",
"!src/**/test-utils.*",
"!src/**/__tests__/**",
"!src/**/__snapshots__/**"
],
"engines": {
"node": ">=18.0.0"
Expand All @@ -63,5 +73,8 @@
},
"peerDependencies": {
"zod": "^3.25.0 || ^4.0.0"
},
"directories": {
"doc": "./docs"
}
}
Loading
Loading