Chris Farhood
ebbdb42c05
Set up TypeDoc to auto-generate comprehensive API reference documentation from TypeScript source code. Changes: - Installed typedoc and typedoc-plugin-markdown (v0.2.0 plugins) - Created typedoc.json configuration with 9 entry points - Added docs:api and docs:watch npm scripts - Fixed test file imports (validateNamespace → isValidNamespace) - Updated tsconfig.json to exclude test files from compilation - Generated markdown API documentation in docs/api-reference/generated/ Generated API documentation: - 9 modules documented (lib/, hooks/, types/) - lib/crypto - 14 encryption/certificate functions - lib/controller - 5 Kubernetes API functions - lib/validators - 6 validation functions - lib/retry - Exponential backoff utilities - lib/rbac - RBAC permission checking - types - Result types, branded types, interfaces - hooks/useSealedSecretEncryption - Encryption React hook - hooks/usePermissions - RBAC React hooks - hooks/useControllerHealth - Health monitoring hook Benefits: - Auto-generated from TypeScript source (stays in sync) - Markdown format for easy integration - Type signatures and JSDoc included - Function parameters and return types documented - Links between related types and functions Phase 2 deliverables (2-3 days estimated, completed in 1 session): ✅ TypeDoc installed and configured ✅ Entry points identified for all core modules ✅ API documentation generated (9 modules, 40+ functions) ✅ npm scripts added for docs generation ✅ Test files excluded from documentation Next: Phase 3 - User tutorials and guides Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
1.3 KiB
1.3 KiB
Headlamp Sealed Secrets API v0.2.0
Headlamp Sealed Secrets API / lib/crypto / encryptValue
Function: encryptValue()
encryptValue(
publicKey,value,namespace,name,key,scope):Result<Base64String,string>
Defined in: src/lib/crypto.ts:55
Encrypt a secret value using the kubeseal format
Parameters
publicKey
PublicKey
RSA public key from the controller's certificate
value
The plaintext secret value to encrypt (branded type)
namespace
string
The namespace (for strict/namespace-wide scoping)
name
string
The secret name (for strict scoping)
key
string
The key name within the secret
scope
The encryption scope
Returns
Result<Base64String, string>
Result containing base64-encoded encrypted value or error message