@forgezero/vault 0.1.12 → 0.1.13
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.
- package/README.md +112 -26
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/providers.js +1 -1
- package/dist/schema.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -53,14 +53,39 @@ bun add @forgezero/vault
|
|
|
53
53
|
<a id="forgezero-vault"></a>
|
|
54
54
|
## @forgezero/vault
|
|
55
55
|
|
|
56
|
-
One scoped contract over an explicitly injected platform backend, a managed tenant socket or an automatically derived external API-key signer.
|
|
56
|
+
One scoped contract over an explicitly injected platform backend, a managed tenant socket or an automatically derived external API-key signer. This entry exposes 13 named value exports and 12 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
|
|
57
57
|
|
|
58
58
|
```text
|
|
59
|
-
import {
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
59
|
+
import {
|
|
60
|
+
DEFAULT_API_URL,
|
|
61
|
+
DEFAULT_REQUEST_TIMEOUT_MS,
|
|
62
|
+
DEFAULT_SOCKET,
|
|
63
|
+
ForgeZero,
|
|
64
|
+
VERSION,
|
|
65
|
+
VaultError,
|
|
66
|
+
createVault,
|
|
67
|
+
directCredentials,
|
|
68
|
+
discover,
|
|
69
|
+
managedAgentTransport,
|
|
70
|
+
signerFromApiKey,
|
|
71
|
+
systemdCredentials,
|
|
72
|
+
vaultCredentials,
|
|
73
|
+
} from '@forgezero/vault';
|
|
74
|
+
|
|
75
|
+
import type {
|
|
76
|
+
AgentRequest,
|
|
77
|
+
AgentResponse,
|
|
78
|
+
AgentTransport,
|
|
79
|
+
Change,
|
|
80
|
+
Credential,
|
|
81
|
+
CredentialMode,
|
|
82
|
+
DiscoveryEnvironment,
|
|
83
|
+
EntryMeta,
|
|
84
|
+
SignRequest,
|
|
85
|
+
Signer,
|
|
86
|
+
SystemdCredentialOptions,
|
|
87
|
+
VaultOptions,
|
|
88
|
+
} from '@forgezero/vault';
|
|
64
89
|
```
|
|
65
90
|
|
|
66
91
|
## @forgezero/vault — Read a scoped secret
|
|
@@ -68,7 +93,9 @@ import type { DiscoveryEnvironment, EntryMeta, SignRequest, Signer, SystemdCrede
|
|
|
68
93
|
The same client discovers the managed Agent socket or uses an external API-key signer. Project and environment remain explicit.
|
|
69
94
|
|
|
70
95
|
```text
|
|
71
|
-
import {
|
|
96
|
+
import {
|
|
97
|
+
createVault,
|
|
98
|
+
} from '@forgezero/vault';
|
|
72
99
|
|
|
73
100
|
const vault = createVault({ project: 'payments', environment: 'production' });
|
|
74
101
|
const token = await vault.get('STRIPE_KEY');
|
|
@@ -77,11 +104,19 @@ const token = await vault.get('STRIPE_KEY');
|
|
|
77
104
|
<a id="forgezero-vault-schema"></a>
|
|
78
105
|
## @forgezero/vault/schema
|
|
79
106
|
|
|
80
|
-
Where an entry’s shape comes from: pulled from the platform when ForgeZero has to render it, declared locally when only the tenant needs it.
|
|
107
|
+
Where an entry’s shape comes from: pulled from the platform when ForgeZero has to render it, declared locally when only the tenant needs it. This entry exposes 3 named value exports and 2 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
|
|
81
108
|
|
|
82
109
|
```text
|
|
83
|
-
import {
|
|
84
|
-
|
|
110
|
+
import {
|
|
111
|
+
localSchemas,
|
|
112
|
+
managedSchemas,
|
|
113
|
+
preferManaged,
|
|
114
|
+
} from '@forgezero/vault/schema';
|
|
115
|
+
|
|
116
|
+
import type {
|
|
117
|
+
SchemaRef,
|
|
118
|
+
SchemaSource,
|
|
119
|
+
} from '@forgezero/vault/schema';
|
|
85
120
|
```
|
|
86
121
|
|
|
87
122
|
## @forgezero/vault/schema — Managed schema with a local fallback
|
|
@@ -89,8 +124,14 @@ import type { SchemaRef, SchemaSource } from '@forgezero/vault/schema';
|
|
|
89
124
|
Managed schemas let ForgeZero render and validate a provider form. Local schemas keep tenant-owned extensions independent. Managed wins when both define the same name; the version travels with the shape and no credential value is stored in the schema.
|
|
90
125
|
|
|
91
126
|
```text
|
|
92
|
-
import {
|
|
93
|
-
|
|
127
|
+
import {
|
|
128
|
+
managedSchemas,
|
|
129
|
+
localSchemas,
|
|
130
|
+
preferManaged,
|
|
131
|
+
} from '@forgezero/vault/schema';
|
|
132
|
+
import {
|
|
133
|
+
createVault,
|
|
134
|
+
} from '@forgezero/vault';
|
|
94
135
|
|
|
95
136
|
const vault = createVault({ project: 'payments', environment: 'production' });
|
|
96
137
|
const schemas = preferManaged(
|
|
@@ -109,42 +150,85 @@ const { schema, version } = await schemas.get('postmark');
|
|
|
109
150
|
<a id="forgezero-vault-config"></a>
|
|
110
151
|
## @forgezero/vault/config
|
|
111
152
|
|
|
112
|
-
Read `.fz/config.json` — which project, which environment, which secrets, and what to call them.
|
|
153
|
+
Read `.fz/config.json` — which project, which environment, which secrets, and what to call them. This entry exposes 8 named value exports and 3 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
|
|
113
154
|
|
|
114
155
|
```text
|
|
115
|
-
import {
|
|
116
|
-
|
|
117
|
-
|
|
156
|
+
import {
|
|
157
|
+
CONFIG_PATHS,
|
|
158
|
+
ConfigError,
|
|
159
|
+
assertNoSecrets,
|
|
160
|
+
bindingsOf,
|
|
161
|
+
exampleConfig,
|
|
162
|
+
loadConfig,
|
|
163
|
+
parseConfig,
|
|
164
|
+
resolveConfig,
|
|
165
|
+
} from '@forgezero/vault/config';
|
|
166
|
+
|
|
167
|
+
import type {
|
|
168
|
+
FzConfig,
|
|
169
|
+
LoadOptions,
|
|
170
|
+
SecretBinding,
|
|
171
|
+
} from '@forgezero/vault/config';
|
|
118
172
|
```
|
|
119
173
|
|
|
120
174
|
<a id="forgezero-vault-env"></a>
|
|
121
175
|
## @forgezero/vault/env
|
|
122
176
|
|
|
123
|
-
Envless: fill `process.env` from the vault at boot, refusing to run during a build.
|
|
177
|
+
Envless: fill `process.env` from the vault at boot, refusing to run during a build. This entry exposes 5 named value exports and 3 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
|
|
124
178
|
|
|
125
179
|
```text
|
|
126
|
-
import {
|
|
127
|
-
|
|
180
|
+
import {
|
|
181
|
+
EnvError,
|
|
182
|
+
clearEnv,
|
|
183
|
+
describeReport,
|
|
184
|
+
hydrateEnv,
|
|
185
|
+
isBuildTime,
|
|
186
|
+
} from '@forgezero/vault/env';
|
|
187
|
+
|
|
188
|
+
import type {
|
|
189
|
+
HydrateOptions,
|
|
190
|
+
HydrateReport,
|
|
191
|
+
SecretReader,
|
|
192
|
+
} from '@forgezero/vault/env';
|
|
128
193
|
```
|
|
129
194
|
|
|
130
195
|
<a id="forgezero-vault-frameworks"></a>
|
|
131
196
|
## @forgezero/vault/frameworks
|
|
132
197
|
|
|
133
|
-
SvelteKit and Next.js wiring, attached at the one place that runs once, on the server, before any request.
|
|
198
|
+
SvelteKit and Next.js wiring, attached at the one place that runs once, on the server, before any request. This entry exposes 6 named value exports and 2 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
|
|
134
199
|
|
|
135
200
|
```text
|
|
136
|
-
import {
|
|
137
|
-
|
|
201
|
+
import {
|
|
202
|
+
bootstrapEnv,
|
|
203
|
+
forgeZeroHandle,
|
|
204
|
+
forgeZeroInit,
|
|
205
|
+
forgeZeroRegister,
|
|
206
|
+
resetHydration,
|
|
207
|
+
setupEnv,
|
|
208
|
+
} from '@forgezero/vault/frameworks';
|
|
209
|
+
|
|
210
|
+
import type {
|
|
211
|
+
SetupOptions,
|
|
212
|
+
SvelteKitHandleEvent,
|
|
213
|
+
} from '@forgezero/vault/frameworks';
|
|
138
214
|
```
|
|
139
215
|
|
|
140
216
|
<a id="forgezero-vault-providers"></a>
|
|
141
217
|
## @forgezero/vault/providers
|
|
142
218
|
|
|
143
|
-
Adapters that make Vault a provider-configuration and credential source without coupling the providers package to ForgeZero.
|
|
219
|
+
Adapters that make Vault a provider-configuration and credential source without coupling the providers package to ForgeZero. This entry exposes 2 named value exports and 3 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
|
|
144
220
|
|
|
145
221
|
```text
|
|
146
|
-
import {
|
|
147
|
-
|
|
222
|
+
import {
|
|
223
|
+
vaultConfig,
|
|
224
|
+
vaultCredentials,
|
|
225
|
+
} from '@forgezero/vault/providers';
|
|
226
|
+
|
|
227
|
+
import type {
|
|
228
|
+
StoredProviderInstance,
|
|
229
|
+
StoredServiceMethodAttachment,
|
|
230
|
+
VaultConfigOptions,
|
|
231
|
+
} from '@forgezero/vault/providers';
|
|
148
232
|
```
|
|
149
233
|
|
|
150
234
|
## Three paths, and why they stay explicit
|
|
@@ -174,7 +258,9 @@ bun add @forgezero/vault
|
|
|
174
258
|
The project and environment are explicit application scope. Managed compute uses the local Agent socket; external runtimes use the stable API origin and their scoped key.
|
|
175
259
|
|
|
176
260
|
```text
|
|
177
|
-
import {
|
|
261
|
+
import {
|
|
262
|
+
ForgeZero,
|
|
263
|
+
} from '@forgezero/vault';
|
|
178
264
|
|
|
179
265
|
const fz = new ForgeZero({ project: 'altpilot', environment: 'production' });
|
|
180
266
|
|
package/dist/index.d.ts
CHANGED
|
@@ -282,4 +282,4 @@ export declare function systemdCredentials(options?: SystemdCredentialOptions):
|
|
|
282
282
|
readonly name: 'systemd';
|
|
283
283
|
get(reference: string, field: string): Promise<string>;
|
|
284
284
|
};
|
|
285
|
-
export declare const VERSION = "0.1.
|
|
285
|
+
export declare const VERSION = "0.1.13";
|
package/dist/index.js
CHANGED
package/dist/providers.js
CHANGED
package/dist/schema.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forgezero/vault",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.13",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"@types/bun": "latest"
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@forgezero/runtime": "^0.1.
|
|
45
|
+
"@forgezero/runtime": "^0.1.9"
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {
|
|
48
48
|
"@noble/curves": "^2.2.0",
|