@optique/config 1.0.0-dev.1826 → 1.0.0-dev.1828

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/dist/index.cjs CHANGED
@@ -94,11 +94,14 @@ function validateWithSchema(schema, rawData) {
94
94
  *
95
95
  * The config context implements the `SourceContext` interface and can be used
96
96
  * with `runWith()` from *@optique/core* or `run()`/`runAsync()` from
97
- * *@optique/run* to provide configuration file support.
97
+ * *@optique/run* to provide configuration file support. Each runner call
98
+ * receives its own annotation snapshot, so the same `ConfigContext`
99
+ * instance can be reused safely across independent or concurrent runs.
98
100
  * When calling `context.getAnnotations()` manually, pass the returned
99
101
  * annotations to low-level APIs such as `parse()`, `parseAsync()`,
100
102
  * `parser.complete()`, `suggest()`, or `getDocPage()`. Calling
101
- * `getAnnotations()` by itself does not affect later parses.
103
+ * `getAnnotations()` by itself does not affect later parses unless those
104
+ * returned annotations are explicitly threaded into a low-level API call.
102
105
  *
103
106
  * @template T The output type of the config schema.
104
107
  * @template TConfigMeta The metadata type for config sources.
package/dist/index.d.cts CHANGED
@@ -126,11 +126,14 @@ interface ConfigContext<T, TConfigMeta = ConfigMeta> extends SourceContext<Confi
126
126
  *
127
127
  * The config context implements the `SourceContext` interface and can be used
128
128
  * with `runWith()` from *@optique/core* or `run()`/`runAsync()` from
129
- * *@optique/run* to provide configuration file support.
129
+ * *@optique/run* to provide configuration file support. Each runner call
130
+ * receives its own annotation snapshot, so the same `ConfigContext`
131
+ * instance can be reused safely across independent or concurrent runs.
130
132
  * When calling `context.getAnnotations()` manually, pass the returned
131
133
  * annotations to low-level APIs such as `parse()`, `parseAsync()`,
132
134
  * `parser.complete()`, `suggest()`, or `getDocPage()`. Calling
133
- * `getAnnotations()` by itself does not affect later parses.
135
+ * `getAnnotations()` by itself does not affect later parses unless those
136
+ * returned annotations are explicitly threaded into a low-level API call.
134
137
  *
135
138
  * @template T The output type of the config schema.
136
139
  * @template TConfigMeta The metadata type for config sources.
package/dist/index.d.ts CHANGED
@@ -126,11 +126,14 @@ interface ConfigContext<T, TConfigMeta = ConfigMeta> extends SourceContext<Confi
126
126
  *
127
127
  * The config context implements the `SourceContext` interface and can be used
128
128
  * with `runWith()` from *@optique/core* or `run()`/`runAsync()` from
129
- * *@optique/run* to provide configuration file support.
129
+ * *@optique/run* to provide configuration file support. Each runner call
130
+ * receives its own annotation snapshot, so the same `ConfigContext`
131
+ * instance can be reused safely across independent or concurrent runs.
130
132
  * When calling `context.getAnnotations()` manually, pass the returned
131
133
  * annotations to low-level APIs such as `parse()`, `parseAsync()`,
132
134
  * `parser.complete()`, `suggest()`, or `getDocPage()`. Calling
133
- * `getAnnotations()` by itself does not affect later parses.
135
+ * `getAnnotations()` by itself does not affect later parses unless those
136
+ * returned annotations are explicitly threaded into a low-level API call.
134
137
  *
135
138
  * @template T The output type of the config schema.
136
139
  * @template TConfigMeta The metadata type for config sources.
package/dist/index.js CHANGED
@@ -71,11 +71,14 @@ function validateWithSchema(schema, rawData) {
71
71
  *
72
72
  * The config context implements the `SourceContext` interface and can be used
73
73
  * with `runWith()` from *@optique/core* or `run()`/`runAsync()` from
74
- * *@optique/run* to provide configuration file support.
74
+ * *@optique/run* to provide configuration file support. Each runner call
75
+ * receives its own annotation snapshot, so the same `ConfigContext`
76
+ * instance can be reused safely across independent or concurrent runs.
75
77
  * When calling `context.getAnnotations()` manually, pass the returned
76
78
  * annotations to low-level APIs such as `parse()`, `parseAsync()`,
77
79
  * `parser.complete()`, `suggest()`, or `getDocPage()`. Calling
78
- * `getAnnotations()` by itself does not affect later parses.
80
+ * `getAnnotations()` by itself does not affect later parses unless those
81
+ * returned annotations are explicitly threaded into a low-level API call.
79
82
  *
80
83
  * @template T The output type of the config schema.
81
84
  * @template TConfigMeta The metadata type for config sources.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@optique/config",
3
- "version": "1.0.0-dev.1826+dae48c84",
3
+ "version": "1.0.0-dev.1828+b245a686",
4
4
  "description": "Configuration file support for Optique with Standard Schema validation",
5
5
  "keywords": [
6
6
  "CLI",
@@ -59,7 +59,7 @@
59
59
  "@standard-schema/spec": "^1.1.0"
60
60
  },
61
61
  "dependencies": {
62
- "@optique/core": "1.0.0-dev.1826+dae48c84"
62
+ "@optique/core": "1.0.0-dev.1828+b245a686"
63
63
  },
64
64
  "devDependencies": {
65
65
  "@standard-schema/spec": "^1.1.0",
@@ -67,7 +67,7 @@
67
67
  "tsdown": "^0.13.0",
68
68
  "typescript": "^5.8.3",
69
69
  "zod": "^3.25.0 || ^4.0.0",
70
- "@optique/env": "1.0.0-dev.1826+dae48c84"
70
+ "@optique/env": "1.0.0-dev.1828+b245a686"
71
71
  },
72
72
  "scripts": {
73
73
  "build": "tsdown",