@forgezero/vault 0.1.18 → 0.1.19

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 CHANGED
@@ -11,7 +11,7 @@ One scoped contract over platform-direct, managed-agent and external API-key tru
11
11
 
12
12
  ## Package overview
13
13
 
14
- The scoped vault facade. A tenant application uses its local agent or an API key; trusted platform code injects a direct realm backend instead of calling itself. The one package that ends up in somebody else's production dependency tree, which is why it stays alone and stays small. Supported runtimes: bun, node, workers, deno. Package root: @forgezero/vault. The sections below show the actual named imports emitted by each declaration entry point; wildcard imports are intentionally not used in the documentation.
14
+ The scoped vault facade. A tenant application uses its local agent or an API key; trusted platform code injects a direct realm backend instead of calling itself. The one package that ends up in somebody else's production dependency tree, which is why it stays alone and stays small. Supported runtimes: bun, node, workers, deno. Package root: @forgezero/vault. Consumer documentation is curated with each module's explicit public flag; the complete internal/export inventory remains in the typed SSOT and declaration files.
15
15
 
16
16
  ```text
17
17
  bun add @forgezero/vault
@@ -29,9 +29,9 @@ The five packages are installation boundaries. Choose a package by who installs
29
29
  | @forgezero/runtime | Portable runtime primitives for queries, jobs, events, schemas and finance. | bun, node | [Open](https://www.forgezero.net/docs/runtime) |
30
30
  | @forgezero/agent | Operator CLI and managed-node agent for bootstrap, deploy and lifecycle. | bun, node | [Open](https://www.forgezero.net/docs/agent) |
31
31
 
32
- ## @forgezero/vault public imports and commands
32
+ ## @forgezero/vault supported imports and commands
33
33
 
34
- Every row links to the detailed explanation and named-import/example area below. This table and those details are generated from the package inventory and emitted declarations.
34
+ These are supported consumer entry points, not every internal module shipped for ForgeZero managed installation. Each row links to its task-oriented usage.
35
35
 
36
36
  | public entry | short description | runtime | details |
37
37
  |---|---|---|---|
@@ -53,38 +53,11 @@ 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. 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.
56
+ One scoped contract over an explicitly injected platform backend, a managed tenant socket or an automatically derived external API-key signer. This is a supported entry point. Import only the named values used by the adjacent task example; the declaration file remains the complete API reference.
57
57
 
58
58
  ```text
59
59
  import {
60
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
61
  } from '@forgezero/vault';
89
62
  ```
90
63
 
@@ -104,18 +77,11 @@ const token = await vault.get('STRIPE_KEY');
104
77
  <a id="forgezero-vault-schema"></a>
105
78
  ## @forgezero/vault/schema
106
79
 
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.
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. This is a supported entry point. Import only the named values used by the adjacent task example; the declaration file remains the complete API reference.
108
81
 
109
82
  ```text
110
83
  import {
111
84
  localSchemas,
112
- managedSchemas,
113
- preferManaged,
114
- } from '@forgezero/vault/schema';
115
-
116
- import type {
117
- SchemaRef,
118
- SchemaSource,
119
85
  } from '@forgezero/vault/schema';
120
86
  ```
121
87
 
@@ -150,24 +116,11 @@ const { schema, version } = await schemas.get('postmark');
150
116
  <a id="forgezero-vault-config"></a>
151
117
  ## @forgezero/vault/config
152
118
 
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.
119
+ Read `.fz/config.json` — which project, which environment, which secrets, and what to call them. This is a supported entry point. Import only the named values used by the adjacent task example; the declaration file remains the complete API reference.
154
120
 
155
121
  ```text
156
122
  import {
157
123
  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
124
  } from '@forgezero/vault/config';
172
125
  ```
173
126
 
@@ -186,21 +139,11 @@ export const selectedCapability = CONFIG_PATHS;
186
139
  <a id="forgezero-vault-env"></a>
187
140
  ## @forgezero/vault/env
188
141
 
189
- 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.
142
+ Envless: fill `process.env` from the vault at boot, refusing to run during a build. This is a supported entry point. Import only the named values used by the adjacent task example; the declaration file remains the complete API reference.
190
143
 
191
144
  ```text
192
145
  import {
193
146
  EnvError,
194
- clearEnv,
195
- describeReport,
196
- hydrateEnv,
197
- isBuildTime,
198
- } from '@forgezero/vault/env';
199
-
200
- import type {
201
- HydrateOptions,
202
- HydrateReport,
203
- SecretReader,
204
147
  } from '@forgezero/vault/env';
205
148
  ```
206
149
 
@@ -219,21 +162,11 @@ export const selectedCapability = EnvError;
219
162
  <a id="forgezero-vault-frameworks"></a>
220
163
  ## @forgezero/vault/frameworks
221
164
 
222
- 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.
165
+ SvelteKit and Next.js wiring, attached at the one place that runs once, on the server, before any request. This is a supported entry point. Import only the named values used by the adjacent task example; the declaration file remains the complete API reference.
223
166
 
224
167
  ```text
225
168
  import {
226
169
  bootstrapEnv,
227
- forgeZeroHandle,
228
- forgeZeroInit,
229
- forgeZeroRegister,
230
- resetHydration,
231
- setupEnv,
232
- } from '@forgezero/vault/frameworks';
233
-
234
- import type {
235
- SetupOptions,
236
- SvelteKitHandleEvent,
237
170
  } from '@forgezero/vault/frameworks';
238
171
  ```
239
172
 
@@ -252,18 +185,11 @@ export const selectedCapability = bootstrapEnv;
252
185
  <a id="forgezero-vault-providers"></a>
253
186
  ## @forgezero/vault/providers
254
187
 
255
- 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.
188
+ Adapters that make Vault a provider-configuration and credential source without coupling the providers package to ForgeZero. This is a supported entry point. Import only the named values used by the adjacent task example; the declaration file remains the complete API reference.
256
189
 
257
190
  ```text
258
191
  import {
259
192
  vaultConfig,
260
- vaultCredentials,
261
- } from '@forgezero/vault/providers';
262
-
263
- import type {
264
- StoredProviderInstance,
265
- StoredServiceMethodAttachment,
266
- VaultConfigOptions,
267
193
  } from '@forgezero/vault/providers';
268
194
  ```
269
195
 
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.18";
285
+ export declare const VERSION = "0.1.19";
package/dist/index.js CHANGED
@@ -382,7 +382,7 @@ function systemdCredentials(options = {}) {
382
382
  }
383
383
  };
384
384
  }
385
- var VERSION = "0.1.18";
385
+ var VERSION = "0.1.19";
386
386
  export {
387
387
  vaultCredentials,
388
388
  systemdCredentials,
package/dist/providers.js CHANGED
@@ -382,7 +382,7 @@ function systemdCredentials(options = {}) {
382
382
  }
383
383
  };
384
384
  }
385
- var VERSION = "0.1.18";
385
+ var VERSION = "0.1.19";
386
386
 
387
387
  // src/providers.ts
388
388
  var MISSING = new Set(["ENTRY_NOT_FOUND", "VERSION_NOT_FOUND"]);
package/dist/schema.js CHANGED
@@ -382,7 +382,7 @@ function systemdCredentials(options = {}) {
382
382
  }
383
383
  };
384
384
  }
385
- var VERSION = "0.1.18";
385
+ var VERSION = "0.1.19";
386
386
 
387
387
  // src/schema.ts
388
388
  function managedSchemas(vault, options = {}) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forgezero/vault",
3
- "version": "0.1.18",
3
+ "version": "0.1.19",
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.13"
45
+ "@forgezero/runtime": "^0.1.14"
46
46
  },
47
47
  "peerDependencies": {
48
48
  "@noble/curves": "^2.2.0",