@molecule/api-deploy-rollout-default 0.0.0-stage → 1.1.0

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/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,385 @@
1
- # Temporary Holding Version
1
+ <!--
2
+ AUTO-GENERATED — DO NOT EDIT THIS FILE.
3
+ Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
4
+ Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
5
+ To change this document, edit the module-level JSDoc in src/index.ts.
6
+ Generated: 2026-10-19T18:03:28.057Z
7
+ -->
2
8
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
9
+ # @molecule/api-deploy-rollout-default
10
+
11
+ Default deploy-rollout provider for molecule.dev.
12
+
13
+ Implements the two real deployment topologies over any instance provider:
14
+ grow-then-shrink (create the new set, gate it ready, join it, then retire the old
15
+ one at a time) and in-place (change the same instances one at a time, with a
16
+ reverse restore on failure). No I/O of its own, no clock other than an injected
17
+ one, no knowledge of where the instances live.
18
+
19
+ > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
20
+ > It is written to be read by coding agents as much as by people, and is generated from this
21
+ > package's source — edit `src/index.ts` JSDoc, not this file.
22
+
23
+ ## Quick Start
24
+
25
+ ```typescript
26
+ import { setProvider, runRollout } from '@molecule/api-deploy-rollout'
27
+ import { provider } from '@molecule/api-deploy-rollout-default'
28
+
29
+ setProvider(provider)
30
+
31
+ const outcome = await runRollout({
32
+ provider: myInstanceProvider,
33
+ current: oldInstances,
34
+ policy: { replicas: 2, soakMs: 30_000 },
35
+ })
36
+ ```
37
+
38
+ ## Type
39
+
40
+ `provider`
41
+
42
+ ## Installation
43
+
44
+ ```bash
45
+ npm install @molecule/api-deploy-rollout-default @molecule/api-deploy-rollout
46
+ ```
47
+
48
+ ## API
49
+
50
+ ### Interfaces
51
+
52
+ #### `ResolvedRolloutPolicy`
53
+
54
+ The resolved policy the state machine runs with.
55
+
56
+ ```typescript
57
+ interface ResolvedRolloutPolicy {
58
+ /** Target size of the new set (grow-then-shrink only). */
59
+ replicas: number
60
+ /** Floor of healthy instances. */
61
+ minHealthy: number
62
+ /** Continuous healthy time required after a change. */
63
+ soakMs: number
64
+ /** Probe cadence during the soak. */
65
+ soakProbeMs: number
66
+ /** Give-up bound for the soak. */
67
+ soakGraceMs: number
68
+ /** Bounded wait for a retiring instance. */
69
+ drainMs: number
70
+ /** Readiness budget handed to the provider. */
71
+ readinessTimeoutMs: number
72
+ /** What an abort does to instances already changed. */
73
+ rollback: 'reverse' | 'none'
74
+ /** Whether to reconcile against the provider's current instances. */
75
+ resume: boolean
76
+ }
77
+ ```
78
+
79
+ #### `InstanceProvider`
80
+
81
+ What a grow-then-shrink rollout needs from whatever hosts the instances.
82
+
83
+ The caller implements this over its hosting provider; the `-sandbox` bond does it
84
+ over `@molecule/api-code-sandbox`, and tests drive it with a fake that records the
85
+ order and can fail any step.
86
+
87
+ ```typescript
88
+ interface InstanceProvider<I extends RolloutInstance = RolloutInstance> {
89
+ /** A human-readable provider name, for progress lines. */
90
+ readonly name?: string
91
+ /**
92
+ * Every instance the deployment currently owns, when the provider can enumerate
93
+ * them. Used to resume an interrupted rollout idempotently: an instance already
94
+ * ready and joined is not created twice.
95
+ */
96
+ list?(): Promise<I[]>
97
+ /**
98
+ * Create the instance at `index` (0-based, above any primary the caller created
99
+ * itself). It must not be routable until {@link InstanceProvider.join}.
100
+ *
101
+ * @param index - Which instance this is.
102
+ * @returns The created instance.
103
+ */
104
+ create(index: number): Promise<I>
105
+ /**
106
+ * Resolve once the instance may take traffic.
107
+ *
108
+ * @param instance - The instance to gate.
109
+ * @param timeoutMs - The policy's readiness budget, for providers whose probe
110
+ * accepts one.
111
+ * @returns `false` when it never became ready (the rollout aborts).
112
+ */
113
+ waitReady(instance: I, timeoutMs?: number): Promise<boolean>
114
+ /**
115
+ * A single, fast readiness probe, for the soak window. Optional: a caller that
116
+ * sets `soakMs` must provide it, because a blocking readiness wait cannot tell a
117
+ * warm instance from a recovering one.
118
+ *
119
+ * @param instance - The instance to probe.
120
+ * @returns Whether it is serving right now.
121
+ */
122
+ isServing?(instance: I): Promise<boolean>
123
+ /**
124
+ * Add the instance to the routable set, so the edge may send it new requests.
125
+ *
126
+ * @param instance - A ready instance.
127
+ */
128
+ join(instance: I): Promise<void>
129
+ /**
130
+ * Remove the instance from the routable set, so no NEW request is routed to it.
131
+ * Requests already in flight are untouched.
132
+ *
133
+ * @param instance - The instance being retired.
134
+ */
135
+ leave(instance: I): Promise<void>
136
+ /**
137
+ * Tell the instance to drain: finish in-flight work and stop accepting new
138
+ * connections. Resolve when it may be destroyed, and never later than `drainMs`.
139
+ *
140
+ * @param instance - The retired instance.
141
+ * @param drainMs - The bounded wait.
142
+ */
143
+ drain(instance: I, drainMs: number): Promise<void>
144
+ /**
145
+ * Destroy the instance, releasing whatever it costs.
146
+ *
147
+ * @param instance - The instance to remove.
148
+ */
149
+ destroy(instance: I): Promise<void>
150
+ }
151
+ ```
152
+
153
+ ### Types
154
+
155
+ #### `RolloutCancelProbe`
156
+
157
+ A cancellation probe: `true` means stop.
158
+
159
+ ```typescript
160
+ type RolloutCancelProbe = () => Promise<boolean> | boolean
161
+ ```
162
+
163
+ ### Classes
164
+
165
+ #### `RolloutAbortedError`
166
+
167
+ A rollout that could not finish, carrying what it did so the caller can report
168
+ it (and, where the topology allows, undo the rest itself).
169
+
170
+ The same class serves both topologies: grow-then-shrink fills `role`, `created`
171
+ and `outcome`; in-place fills `failed`, `rolledBack` and `rollbackFailures`.
172
+
173
+ ```typescript
174
+ class RolloutAbortedError extends Error {
175
+ /** The API layer's key for this abort. */
176
+ readonly errorKey = 'deploy-rollout.error.aborted'
177
+
178
+ /** The step that failed. */
179
+ readonly role: RolloutStep | null
180
+
181
+ /** The instance whose step failed, when one did. */
182
+ readonly failed: string | null
183
+
184
+ /** Instances restored to the old build, newest first. */
185
+ readonly rolledBack: string[]
186
+
187
+ /** Restores that themselves failed. */
188
+ readonly rollbackFailures: RolloutFailure[]
189
+
190
+ /** The grow-then-shrink outcome, when the abort happened there. */
191
+ readonly outcome: RolloutOutcome | null
192
+
193
+ /**
194
+ * Build the abort with what the caller must report.
195
+ *
196
+ * @param message - What happened, in plain words.
197
+ * @param details - The role, the failed instance, what was undone and the outcome.
198
+ * @param cause - The underlying error, when there was one.
199
+ */
200
+ constructor(
201
+ message: string,
202
+ details: {
203
+ role?: RolloutStep | null
204
+ failed?: string | null
205
+ rolledBack?: string[]
206
+ rollbackFailures?: RolloutFailure[]
207
+ outcome?: RolloutOutcome | null
208
+ } = {},
209
+ cause?: unknown,
210
+ ) {
211
+ super(message, cause === undefined ? undefined : { cause })
212
+ this.name = 'RolloutAbortedError'
213
+ this.role = details.role ?? null
214
+ this.failed = details.failed ?? null
215
+ this.rolledBack = details.rolledBack ?? []
216
+ this.rollbackFailures = details.rollbackFailures ?? []
217
+ this.outcome = details.outcome ?? null
218
+ }
219
+ }
220
+ ```
221
+
222
+ ### Functions
223
+
224
+ #### `resolveRolloutPolicy(policy, instanceCount)`
225
+
226
+ Fill the policy defaults.
227
+
228
+ `maxUnavailable` derives `minHealthy` only when it is set; without it the floor
229
+ is one healthy instance, which is exactly the rule every existing rolling path
230
+ has today.
231
+
232
+ ```typescript
233
+ function resolveRolloutPolicy(
234
+ policy: RolloutPolicy | undefined,
235
+ instanceCount: number,
236
+ ): ResolvedRolloutPolicy
237
+ ```
238
+
239
+ - `policy` — The caller's policy, if any.
240
+ - `instanceCount` — How many instances the topology has, for `maxUnavailable`.
241
+
242
+ **Returns:** The resolved policy.
243
+
244
+ #### `runGrowThenShrink(options)`
245
+
246
+ Run a grow-then-shrink replacement.
247
+
248
+ The caller has already created, gated and joined the PRIMARY instance of the new
249
+ version when `primaryServing` is set; `replicas` is the size of the new set
250
+ including that one, and this function creates the remaining `replicas - 1`.
251
+
252
+ ```typescript
253
+ function runGrowThenShrink(options: RolloutOptions<I>): Promise<RolloutOutcome<I>>
254
+ ```
255
+
256
+ - `options` — The set to build, the old set, and the provider.
257
+
258
+ **Returns:** The new set, the retired instances and non-fatal failures.
259
+
260
+ #### `runInPlace(options)`
261
+
262
+ Run an in-place replacement: the same instances changed one at a time.
263
+
264
+ The instance list comes from `machines`, or from the provider's own `list()`.
265
+ The operations come from `apply`/`rollback`/`probeServing`, or from the provider's
266
+ `replace`/`restore`/`isServing`. Before an instance is taken out of rotation,
267
+ every OTHER instance must answer its probe, and the resulting healthy count must
268
+ stay at or above the policy floor.
269
+
270
+ ```typescript
271
+ function runInPlace(options: InPlaceRolloutOptions<I>): Promise<InPlaceRolloutOutcome<I>>
272
+ ```
273
+
274
+ - `options` — The instances to roll and the provider or callbacks.
275
+
276
+ **Returns:** The instances changed, in roll order.
277
+
278
+ #### `createProvider()`
279
+
280
+ Create a fresh provider object (the same algorithm; a distinct identity for
281
+ tests and for apps that register more than one).
282
+
283
+ ```typescript
284
+ function createProvider(): DeployRolloutProvider
285
+ ```
286
+
287
+ **Returns:** A deploy-rollout provider.
288
+
289
+ #### `describeRolloutResult(outcome, replicas)`
290
+
291
+ One plain sentence about what a finished rollout did.
292
+
293
+ ```typescript
294
+ function describeRolloutResult(
295
+ outcome: Pick<RolloutOutcome<I>, 'retired'>,
296
+ replicas: number,
297
+ ): string | null
298
+ ```
299
+
300
+ - `outcome` — What the rollout returned.
301
+ - `replicas` — The set size, for the sentence.
302
+
303
+ **Returns:** The line, or `null` when there was nothing to retire or the set is one.
304
+
305
+ ### Constants
306
+
307
+ #### `DEFAULT_ROLLOUT_DRAIN_MS`
308
+
309
+ The default bounded drain wait — matches the lifecycle bond's own budget.
310
+
311
+ ```typescript
312
+ const DEFAULT_ROLLOUT_DRAIN_MS: 25000
313
+ ```
314
+
315
+ #### `DEFAULT_ROLLOUT_READINESS_TIMEOUT_MS`
316
+
317
+ The default readiness budget handed to a provider.
318
+
319
+ ```typescript
320
+ const DEFAULT_ROLLOUT_READINESS_TIMEOUT_MS: 120000
321
+ ```
322
+
323
+ #### `DEFAULT_SOAK_PROBE_MS`
324
+
325
+ The default cadence of the soak probe.
326
+
327
+ ```typescript
328
+ const DEFAULT_SOAK_PROBE_MS: 2000
329
+ ```
330
+
331
+ #### `DEFAULT_MIN_HEALTHY`
332
+
333
+ The default floor of healthy instances: never blank the deployment.
334
+
335
+ ```typescript
336
+ const DEFAULT_MIN_HEALTHY: 1
337
+ ```
338
+
339
+ #### `provider`
340
+
341
+ The provider implementation registered under `deploy-rollout`.
342
+
343
+ ```typescript
344
+ const provider: DeployRolloutProvider
345
+ ```
346
+
347
+ ## Core Interface
348
+
349
+ Implements `@molecule/api-deploy-rollout` interface.
350
+
351
+ ## Bond Wiring
352
+
353
+ Setup function to register this provider with the core interface:
354
+
355
+ ```typescript
356
+ import { setProvider } from '@molecule/api-deploy-rollout'
357
+ import { provider } from '@molecule/api-deploy-rollout-default'
358
+
359
+ export function setupDeployRolloutDefault(): void {
360
+ setProvider(provider)
361
+ }
362
+ ```
363
+
364
+ ## Injection Notes
365
+
366
+ ### Requirements
367
+
368
+ Peer dependencies:
369
+
370
+ - `@molecule/api-deploy-rollout` ^1.0.0
371
+
372
+ ### Runtime Dependencies
373
+
374
+ - `@molecule/api-deploy-rollout`
375
+
376
+ - **Capacity floor first.** `policy.minHealthy` (default 1) is checked before
377
+ every retirement; a step that would go below it aborts instead of running.
378
+ - **Soak is continuous.** With `soakMs > 0` the instance must keep answering
379
+ `isServing`; a gap restarts the window (a fresh process can pass one probe while
380
+ its event loop is still warming).
381
+ - **Rollback is reverse.** Instances this run changed are restored newest first; a
382
+ restore failure does not stop the remaining restores.
383
+ - **Resume is a no-op when complete.** A re-run reconciles against the provider's
384
+ own `list()` where it has one, so an interrupted rollout does not create a
385
+ duplicate set.
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=browser-guard.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"browser-guard.d.ts","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,CAAA"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Browser guard — `@molecule/api-deploy-rollout-default` is SERVER-ONLY.
3
+ *
4
+ * Generated by scripts/gen-browser-guards.mjs (workspace root) — edit THAT, not this.
5
+ * Evaluating a server package in a browser bundle is always an import-graph mistake
6
+ * (node APIs, secrets); without this guard it surfaces as a cryptic downstream crash
7
+ * ("Buffer is not defined") far from the culprit. Throwing here names the package and
8
+ * the fix at the exact moment the client bundle evaluates it. jsdom tests and SSR are
9
+ * unaffected: the throw requires browser globals AND the absence of a node runtime.
10
+ */
11
+ const g = globalThis;
12
+ if (g.window !== undefined && g.document !== undefined && !g.process?.versions?.node) {
13
+ throw new Error('@molecule/api-deploy-rollout-default is SERVER-ONLY: it was bundled into browser/client code. Import it only ' +
14
+ 'from server code (a server route/function or your API), or dynamic-import it inside ' +
15
+ 'the server handler — never from components or shared client modules, and never ' +
16
+ 'polyfill Buffer/process to silence this.');
17
+ }
18
+ export {};
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Default deploy-rollout provider for molecule.dev.
3
+ *
4
+ * Implements the two real deployment topologies over any instance provider:
5
+ * grow-then-shrink (create the new set, gate it ready, join it, then retire the old
6
+ * one at a time) and in-place (change the same instances one at a time, with a
7
+ * reverse restore on failure). No I/O of its own, no clock other than an injected
8
+ * one, no knowledge of where the instances live.
9
+ *
10
+ * @example
11
+ * ```typescript
12
+ * import { setProvider, runRollout } from '@molecule/api-deploy-rollout'
13
+ * import { provider } from '@molecule/api-deploy-rollout-default'
14
+ *
15
+ * setProvider(provider)
16
+ *
17
+ * const outcome = await runRollout({
18
+ * provider: myInstanceProvider,
19
+ * current: oldInstances,
20
+ * policy: { replicas: 2, soakMs: 30_000 },
21
+ * })
22
+ * ```
23
+ *
24
+ * @remarks
25
+ * - **Capacity floor first.** `policy.minHealthy` (default 1) is checked before
26
+ * every retirement; a step that would go below it aborts instead of running.
27
+ * - **Soak is continuous.** With `soakMs > 0` the instance must keep answering
28
+ * `isServing`; a gap restarts the window (a fresh process can pass one probe while
29
+ * its event loop is still warming).
30
+ * - **Rollback is reverse.** Instances this run changed are restored newest first; a
31
+ * restore failure does not stop the remaining restores.
32
+ * - **Resume is a no-op when complete.** A re-run reconciles against the provider's
33
+ * own `list()` where it has one, so an interrupted rollout does not create a
34
+ * duplicate set.
35
+ *
36
+ * @module
37
+ */
38
+ export * from './browser-guard.js';
39
+ export * from './provider.js';
40
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA"}