@continuous-labs/sdk 0.0.5 → 0.0.6

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.
Files changed (111) hide show
  1. package/README.md +1 -1
  2. package/esm/funcs/simulations-create-simulation.d.ts +1 -1
  3. package/esm/funcs/simulations-create-simulation.js +1 -1
  4. package/esm/funcs/simulations-fork-simulation.d.ts +1 -1
  5. package/esm/funcs/simulations-fork-simulation.js +1 -1
  6. package/esm/funcs/simulations-get-simulation.d.ts +1 -1
  7. package/esm/funcs/simulations-get-simulation.js +1 -1
  8. package/esm/funcs/simulations-list-simulation-steps.d.ts +1 -1
  9. package/esm/funcs/simulations-list-simulation-steps.js +1 -1
  10. package/esm/funcs/simulations-mint-simulation-token.d.ts +1 -1
  11. package/esm/funcs/simulations-mint-simulation-token.js +1 -1
  12. package/esm/funcs/simulations-start-simulation.d.ts +1 -1
  13. package/esm/funcs/simulations-start-simulation.js +1 -1
  14. package/esm/funcs/simulations-stop-simulation.d.ts +1 -1
  15. package/esm/funcs/simulations-stop-simulation.js +1 -1
  16. package/esm/funcs/simulators-build-simulator.d.ts +1 -1
  17. package/esm/funcs/simulators-build-simulator.js +1 -1
  18. package/esm/funcs/worlds-build-world.d.ts +1 -1
  19. package/esm/funcs/worlds-build-world.js +1 -1
  20. package/esm/funcs/worlds-start-world.d.ts +1 -1
  21. package/esm/funcs/worlds-start-world.js +1 -1
  22. package/esm/lib/config.d.ts +2 -2
  23. package/esm/lib/config.js +2 -2
  24. package/esm/models/build-simulator-request.d.ts +6 -6
  25. package/esm/models/build-simulator-request.js +1 -1
  26. package/esm/models/build-world-request.d.ts +2 -2
  27. package/esm/models/create-simulation-request.d.ts +1 -1
  28. package/esm/models/created-simulation.d.ts +8 -8
  29. package/esm/models/created-simulation.js +1 -1
  30. package/esm/models/list-worlds-response.d.ts +1 -1
  31. package/esm/models/operations/build-simulator.d.ts +1 -1
  32. package/esm/models/operations/cancel-simulator-build.d.ts +1 -1
  33. package/esm/models/operations/cancel-world-build.d.ts +1 -1
  34. package/esm/models/operations/delete-simulation.d.ts +1 -1
  35. package/esm/models/operations/delete-simulator.d.ts +1 -1
  36. package/esm/models/operations/delete-world.d.ts +1 -1
  37. package/esm/models/operations/fork-simulation.d.ts +1 -1
  38. package/esm/models/operations/get-simulation.d.ts +1 -1
  39. package/esm/models/operations/get-simulator.d.ts +1 -1
  40. package/esm/models/operations/get-world.d.ts +1 -1
  41. package/esm/models/operations/list-simulation-steps.d.ts +1 -1
  42. package/esm/models/operations/list-simulations.d.ts +4 -4
  43. package/esm/models/operations/list-simulations.js +1 -1
  44. package/esm/models/operations/list-simulators.d.ts +1 -1
  45. package/esm/models/operations/list-worlds.d.ts +1 -1
  46. package/esm/models/operations/mint-simulation-token.d.ts +1 -1
  47. package/esm/models/operations/start-simulation.d.ts +1 -1
  48. package/esm/models/operations/start-world.d.ts +1 -1
  49. package/esm/models/operations/stop-simulation.d.ts +1 -1
  50. package/esm/models/operations/stop-world.d.ts +1 -1
  51. package/esm/models/simulation-token.d.ts +1 -1
  52. package/esm/models/simulation.d.ts +7 -7
  53. package/esm/models/simulation.js +1 -1
  54. package/esm/models/simulator.d.ts +8 -8
  55. package/esm/models/simulator.js +2 -2
  56. package/esm/models/step.d.ts +2 -2
  57. package/esm/models/world-simulation.d.ts +2 -2
  58. package/esm/models/world.d.ts +7 -7
  59. package/esm/models/world.js +1 -1
  60. package/esm/sdk/simulations.d.ts +7 -7
  61. package/esm/sdk/simulations.js +7 -7
  62. package/esm/sdk/simulators.d.ts +1 -1
  63. package/esm/sdk/simulators.js +1 -1
  64. package/esm/sdk/worlds.d.ts +2 -2
  65. package/esm/sdk/worlds.js +2 -2
  66. package/jsr.json +1 -1
  67. package/package.json +1 -1
  68. package/src/funcs/simulations-create-simulation.ts +1 -1
  69. package/src/funcs/simulations-fork-simulation.ts +1 -1
  70. package/src/funcs/simulations-get-simulation.ts +1 -1
  71. package/src/funcs/simulations-list-simulation-steps.ts +1 -1
  72. package/src/funcs/simulations-mint-simulation-token.ts +1 -1
  73. package/src/funcs/simulations-start-simulation.ts +1 -1
  74. package/src/funcs/simulations-stop-simulation.ts +1 -1
  75. package/src/funcs/simulators-build-simulator.ts +1 -1
  76. package/src/funcs/worlds-build-world.ts +1 -1
  77. package/src/funcs/worlds-start-world.ts +1 -1
  78. package/src/lib/config.ts +2 -2
  79. package/src/models/build-simulator-request.ts +6 -6
  80. package/src/models/build-world-request.ts +2 -2
  81. package/src/models/create-simulation-request.ts +1 -1
  82. package/src/models/created-simulation.ts +8 -8
  83. package/src/models/list-worlds-response.ts +1 -1
  84. package/src/models/operations/build-simulator.ts +1 -1
  85. package/src/models/operations/cancel-simulator-build.ts +1 -1
  86. package/src/models/operations/cancel-world-build.ts +1 -1
  87. package/src/models/operations/delete-simulation.ts +1 -1
  88. package/src/models/operations/delete-simulator.ts +1 -1
  89. package/src/models/operations/delete-world.ts +1 -1
  90. package/src/models/operations/fork-simulation.ts +1 -1
  91. package/src/models/operations/get-simulation.ts +1 -1
  92. package/src/models/operations/get-simulator.ts +1 -1
  93. package/src/models/operations/get-world.ts +1 -1
  94. package/src/models/operations/list-simulation-steps.ts +1 -1
  95. package/src/models/operations/list-simulations.ts +4 -4
  96. package/src/models/operations/list-simulators.ts +1 -1
  97. package/src/models/operations/list-worlds.ts +1 -1
  98. package/src/models/operations/mint-simulation-token.ts +1 -1
  99. package/src/models/operations/start-simulation.ts +1 -1
  100. package/src/models/operations/start-world.ts +1 -1
  101. package/src/models/operations/stop-simulation.ts +1 -1
  102. package/src/models/operations/stop-world.ts +1 -1
  103. package/src/models/simulation-token.ts +1 -1
  104. package/src/models/simulation.ts +7 -7
  105. package/src/models/simulator.ts +8 -8
  106. package/src/models/step.ts +2 -2
  107. package/src/models/world-simulation.ts +2 -2
  108. package/src/models/world.ts +7 -7
  109. package/src/sdk/simulations.ts +7 -7
  110. package/src/sdk/simulators.ts +1 -1
  111. package/src/sdk/worlds.ts +2 -2
@@ -1,7 +1,7 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  export type StopSimulationRequest = {
3
3
  /**
4
- * Stable Simulation ID.
4
+ * Simulation ID.
5
5
  */
6
6
  id: string;
7
7
  };
@@ -1,7 +1,7 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  export type StopWorldRequest = {
3
3
  /**
4
- * Stable World ID.
4
+ * World ID.
5
5
  */
6
6
  id: string;
7
7
  };
@@ -7,7 +7,7 @@ export type SimulationToken = {
7
7
  */
8
8
  expiresAt: Date;
9
9
  /**
10
- * New data-plane token.
10
+ * New token for requests to the Simulation endpoint. Send it in the X-Continuous-Simulation-Token header.
11
11
  */
12
12
  token: string;
13
13
  };
@@ -3,7 +3,7 @@ import { OpenEnum } from "../types/enums.js";
3
3
  import { Result as SafeParseResult } from "../types/fp.js";
4
4
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
5
5
  /**
6
- * Current Simulation status.
6
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
7
7
  */
8
8
  export declare const SimulationStatus: {
9
9
  readonly Running: "running";
@@ -11,7 +11,7 @@ export declare const SimulationStatus: {
11
11
  readonly Stopped: "stopped";
12
12
  };
13
13
  /**
14
- * Current Simulation status.
14
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
15
15
  */
16
16
  export type SimulationStatus = OpenEnum<typeof SimulationStatus>;
17
17
  export type Simulation = {
@@ -20,11 +20,11 @@ export type Simulation = {
20
20
  */
21
21
  createdAt: Date;
22
22
  /**
23
- * Data-plane endpoint for the Simulation.
23
+ * Base URL for requests to the Simulation.
24
24
  */
25
25
  endpoint: string;
26
26
  /**
27
- * Stable Simulation ID.
27
+ * Simulation ID.
28
28
  */
29
29
  id: string;
30
30
  /**
@@ -32,15 +32,15 @@ export type Simulation = {
32
32
  */
33
33
  name: string;
34
34
  /**
35
- * Stable source Simulation ID for a fork, or null.
35
+ * Source Simulation ID for a fork, or null.
36
36
  */
37
37
  parentId: string | null;
38
38
  /**
39
- * Stable ID of the Simulator.
39
+ * ID of the Simulator.
40
40
  */
41
41
  simulatorId: string;
42
42
  /**
43
- * Current Simulation status.
43
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
44
44
  */
45
45
  status: SimulationStatus;
46
46
  };
@@ -7,7 +7,7 @@ import { safeParse } from "../lib/schemas.js";
7
7
  import * as openEnums from "../types/enums.js";
8
8
  import * as types from "../types/primitives.js";
9
9
  /**
10
- * Current Simulation status.
10
+ * Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.
11
11
  */
12
12
  export const SimulationStatus = {
13
13
  Running: "running",
@@ -4,18 +4,18 @@ import { Result as SafeParseResult } from "../types/fp.js";
4
4
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
5
5
  import { ResourceError } from "./resource-error.js";
6
6
  /**
7
- * Simulator source.
7
+ * workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
8
8
  */
9
9
  export declare const Source: {
10
10
  readonly Workspace: "workspace";
11
11
  readonly Catalog: "catalog";
12
12
  };
13
13
  /**
14
- * Simulator source.
14
+ * workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
15
15
  */
16
16
  export type Source = OpenEnum<typeof Source>;
17
17
  /**
18
- * Current build status.
18
+ * building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
19
19
  */
20
20
  export declare const SimulatorStatus: {
21
21
  readonly Building: "building";
@@ -24,7 +24,7 @@ export declare const SimulatorStatus: {
24
24
  readonly Canceled: "canceled";
25
25
  };
26
26
  /**
27
- * Current build status.
27
+ * building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
28
28
  */
29
29
  export type SimulatorStatus = OpenEnum<typeof SimulatorStatus>;
30
30
  export type Simulator = {
@@ -34,7 +34,7 @@ export type Simulator = {
34
34
  createdAt: Date;
35
35
  error: ResourceError | null;
36
36
  /**
37
- * Stable Simulator ID.
37
+ * Simulator ID.
38
38
  */
39
39
  id: string;
40
40
  /**
@@ -42,15 +42,15 @@ export type Simulator = {
42
42
  */
43
43
  name: string;
44
44
  /**
45
- * Stable parent Simulator ID, or null.
45
+ * Parent Simulator ID, or null.
46
46
  */
47
47
  parentId: string | null;
48
48
  /**
49
- * Simulator source.
49
+ * workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
50
50
  */
51
51
  source: Source;
52
52
  /**
53
- * Current build status.
53
+ * building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
54
54
  */
55
55
  status: SimulatorStatus;
56
56
  };
@@ -8,14 +8,14 @@ import * as openEnums from "../types/enums.js";
8
8
  import * as types from "../types/primitives.js";
9
9
  import { ResourceError$inboundSchema, } from "./resource-error.js";
10
10
  /**
11
- * Simulator source.
11
+ * workspace for a Simulator your workspace built; catalog for a read-only Simulator that Continuous publishes.
12
12
  */
13
13
  export const Source = {
14
14
  Workspace: "workspace",
15
15
  Catalog: "catalog",
16
16
  };
17
17
  /**
18
- * Current build status.
18
+ * building while the build runs; ready when Simulations, Worlds, and incremental builds can use it; failed when the build failed; canceled when a cancel request took effect.
19
19
  */
20
20
  export const SimulatorStatus = {
21
21
  Building: "building",
@@ -3,11 +3,11 @@ import { Result as SafeParseResult } from "../types/fp.js";
3
3
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
4
4
  export type Step = {
5
5
  /**
6
- * Request label. It usually contains the HTTP method and path.
6
+ * HTTP method and path of the request that produced this step, without the query string, for example POST /v1/widgets.
7
7
  */
8
8
  label: string;
9
9
  /**
10
- * Completed request number. Use this value as at_step when you fork the Simulation.
10
+ * Step number. Use it as at_step when you fork.
11
11
  */
12
12
  step: number;
13
13
  };
@@ -3,11 +3,11 @@ import { Result as SafeParseResult } from "../types/fp.js";
3
3
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
4
4
  export type WorldSimulation = {
5
5
  /**
6
- * Stable ID of the created Simulation.
6
+ * ID of the created Simulation.
7
7
  */
8
8
  id: string;
9
9
  /**
10
- * Stable ID of the Simulator that this Simulation runs.
10
+ * ID of the Simulator that this Simulation runs.
11
11
  */
12
12
  simulatorId: string;
13
13
  };
@@ -5,7 +5,7 @@ import { SDKValidationError } from "./errors/sdk-validation-error.js";
5
5
  import { ResourceError } from "./resource-error.js";
6
6
  import { WorldSimulation } from "./world-simulation.js";
7
7
  /**
8
- * Current World lifecycle status.
8
+ * building while the build runs; ready when the World can be started; running or stopped once its Simulations exist; failed when the first start could not create its Simulations; canceled when the build was canceled.
9
9
  */
10
10
  export declare const WorldStatus: {
11
11
  readonly Building: "building";
@@ -16,17 +16,17 @@ export declare const WorldStatus: {
16
16
  readonly Canceled: "canceled";
17
17
  };
18
18
  /**
19
- * Current World lifecycle status.
19
+ * building while the build runs; ready when the World can be started; running or stopped once its Simulations exist; failed when the first start could not create its Simulations; canceled when the build was canceled.
20
20
  */
21
21
  export type WorldStatus = OpenEnum<typeof WorldStatus>;
22
22
  export type World = {
23
23
  /**
24
- * Time when the World build started.
24
+ * World creation time.
25
25
  */
26
26
  createdAt: Date;
27
27
  error: ResourceError | null;
28
28
  /**
29
- * Stable World ID.
29
+ * World ID.
30
30
  */
31
31
  id: string;
32
32
  /**
@@ -34,15 +34,15 @@ export type World = {
34
34
  */
35
35
  instructions: string;
36
36
  /**
37
- * Created member Simulations. This list is empty before first start.
37
+ * Simulations in the World. Empty unless the World is running or stopped.
38
38
  */
39
39
  simulations: Array<WorldSimulation>;
40
40
  /**
41
- * Stable Simulator IDs in member order.
41
+ * Simulator IDs in member order.
42
42
  */
43
43
  simulators: Array<string>;
44
44
  /**
45
- * Current World lifecycle status.
45
+ * building while the build runs; ready when the World can be started; running or stopped once its Simulations exist; failed when the first start could not create its Simulations; canceled when the build was canceled.
46
46
  */
47
47
  status: WorldStatus;
48
48
  };
@@ -9,7 +9,7 @@ import * as types from "../types/primitives.js";
9
9
  import { ResourceError$inboundSchema, } from "./resource-error.js";
10
10
  import { WorldSimulation$inboundSchema, } from "./world-simulation.js";
11
11
  /**
12
- * Current World lifecycle status.
12
+ * building while the build runs; ready when the World can be started; running or stopped once its Simulations exist; failed when the first start could not create its Simulations; canceled when the build was canceled.
13
13
  */
14
14
  export const WorldStatus = {
15
15
  Building: "building",
@@ -13,7 +13,7 @@ export declare class Simulations extends ClientSDK {
13
13
  * Create Simulation
14
14
  *
15
15
  * @remarks
16
- * Creates an isolated runtime from a ready Simulator. The response includes its endpoint and a 1-hour token.
16
+ * Creates a Simulation from a ready Simulator and starts it. The response includes the Simulation endpoint and a token that expires in 1 hour. List and get do not return the token.
17
17
  */
18
18
  createSimulation(request: models.CreateSimulationRequest, options?: RequestOptions): Promise<models.CreatedSimulation>;
19
19
  /**
@@ -27,42 +27,42 @@ export declare class Simulations extends ClientSDK {
27
27
  * Get Simulation
28
28
  *
29
29
  * @remarks
30
- * Returns a Simulation and its current runtime status. The response does not include data-plane tokens.
30
+ * Returns a Simulation and its current status. The response does not include tokens.
31
31
  */
32
32
  getSimulation(request: operations.GetSimulationRequest, options?: RequestOptions): Promise<models.Simulation>;
33
33
  /**
34
34
  * Fork Simulation
35
35
  *
36
36
  * @remarks
37
- * Creates a Simulation with a 1-hour token. The source Simulation continues to run.
37
+ * Creates a new Simulation from the source Simulation's current state, or from an earlier recorded step when you set at_step. The source must be running or paused; a stopped source returns 409 simulation_stopped. Forking does not change the source. The response includes the new endpoint and a token that expires in 1 hour.
38
38
  */
39
39
  forkSimulation(request: operations.ForkSimulationRequest, options?: RequestOptions): Promise<models.CreatedSimulation>;
40
40
  /**
41
41
  * Start Simulation
42
42
  *
43
43
  * @remarks
44
- * Starts a stopped Simulation from its saved runtime state. Its endpoint becomes available after the runtime starts.
44
+ * Starts a stopped Simulation from its saved state. The endpoint serves requests once the response returns. A Simulation that is already running or paused is returned unchanged.
45
45
  */
46
46
  startSimulation(request: operations.StartSimulationRequest, options?: RequestOptions): Promise<models.Simulation>;
47
47
  /**
48
48
  * List Simulation Steps
49
49
  *
50
50
  * @remarks
51
- * Returns recorded steps for a running or paused Simulation. Use any step to create a deterministic fork.
51
+ * Lists the Simulation's steps in order. Each request that changed state is one step; a request that only reads registers none. Pass a step number as at_step when you fork to start the child from the state after that step. A stopped Simulation returns 409 simulation_stopped; start it first.
52
52
  */
53
53
  listSimulationSteps(request: operations.ListSimulationStepsRequest, options?: RequestOptions): Promise<models.ListSimulationStepsResponse>;
54
54
  /**
55
55
  * Stop Simulation
56
56
  *
57
57
  * @remarks
58
- * Stops a Simulation and saves its runtime state. You can start it later from the saved state.
58
+ * Stops a Simulation and saves its state. Requests to its endpoint return 409 simulation_stopped until you start it again. A stopped Simulation is returned unchanged.
59
59
  */
60
60
  stopSimulation(request: operations.StopSimulationRequest, options?: RequestOptions): Promise<models.Simulation>;
61
61
  /**
62
62
  * Mint Simulation Token
63
63
  *
64
64
  * @remarks
65
- * Mints an expiring data-plane token. Send it in X-Continuous-Simulation-Token. Other unexpired tokens remain valid.
65
+ * Creates another token for requests to the Simulation endpoint. Send it in the X-Continuous-Simulation-Token header. Earlier tokens stay valid until they expire.
66
66
  */
67
67
  mintSimulationToken(request: operations.MintSimulationTokenRequest, options?: RequestOptions): Promise<models.SimulationToken>;
68
68
  }
@@ -26,7 +26,7 @@ export class Simulations extends ClientSDK {
26
26
  * Create Simulation
27
27
  *
28
28
  * @remarks
29
- * Creates an isolated runtime from a ready Simulator. The response includes its endpoint and a 1-hour token.
29
+ * Creates a Simulation from a ready Simulator and starts it. The response includes the Simulation endpoint and a token that expires in 1 hour. List and get do not return the token.
30
30
  */
31
31
  async createSimulation(request, options) {
32
32
  return unwrapAsync(simulationsCreateSimulation(this, request, options));
@@ -44,7 +44,7 @@ export class Simulations extends ClientSDK {
44
44
  * Get Simulation
45
45
  *
46
46
  * @remarks
47
- * Returns a Simulation and its current runtime status. The response does not include data-plane tokens.
47
+ * Returns a Simulation and its current status. The response does not include tokens.
48
48
  */
49
49
  async getSimulation(request, options) {
50
50
  return unwrapAsync(simulationsGetSimulation(this, request, options));
@@ -53,7 +53,7 @@ export class Simulations extends ClientSDK {
53
53
  * Fork Simulation
54
54
  *
55
55
  * @remarks
56
- * Creates a Simulation with a 1-hour token. The source Simulation continues to run.
56
+ * Creates a new Simulation from the source Simulation's current state, or from an earlier recorded step when you set at_step. The source must be running or paused; a stopped source returns 409 simulation_stopped. Forking does not change the source. The response includes the new endpoint and a token that expires in 1 hour.
57
57
  */
58
58
  async forkSimulation(request, options) {
59
59
  return unwrapAsync(simulationsForkSimulation(this, request, options));
@@ -62,7 +62,7 @@ export class Simulations extends ClientSDK {
62
62
  * Start Simulation
63
63
  *
64
64
  * @remarks
65
- * Starts a stopped Simulation from its saved runtime state. Its endpoint becomes available after the runtime starts.
65
+ * Starts a stopped Simulation from its saved state. The endpoint serves requests once the response returns. A Simulation that is already running or paused is returned unchanged.
66
66
  */
67
67
  async startSimulation(request, options) {
68
68
  return unwrapAsync(simulationsStartSimulation(this, request, options));
@@ -71,7 +71,7 @@ export class Simulations extends ClientSDK {
71
71
  * List Simulation Steps
72
72
  *
73
73
  * @remarks
74
- * Returns recorded steps for a running or paused Simulation. Use any step to create a deterministic fork.
74
+ * Lists the Simulation's steps in order. Each request that changed state is one step; a request that only reads registers none. Pass a step number as at_step when you fork to start the child from the state after that step. A stopped Simulation returns 409 simulation_stopped; start it first.
75
75
  */
76
76
  async listSimulationSteps(request, options) {
77
77
  return unwrapAsync(simulationsListSimulationSteps(this, request, options));
@@ -80,7 +80,7 @@ export class Simulations extends ClientSDK {
80
80
  * Stop Simulation
81
81
  *
82
82
  * @remarks
83
- * Stops a Simulation and saves its runtime state. You can start it later from the saved state.
83
+ * Stops a Simulation and saves its state. Requests to its endpoint return 409 simulation_stopped until you start it again. A stopped Simulation is returned unchanged.
84
84
  */
85
85
  async stopSimulation(request, options) {
86
86
  return unwrapAsync(simulationsStopSimulation(this, request, options));
@@ -89,7 +89,7 @@ export class Simulations extends ClientSDK {
89
89
  * Mint Simulation Token
90
90
  *
91
91
  * @remarks
92
- * Mints an expiring data-plane token. Send it in X-Continuous-Simulation-Token. Other unexpired tokens remain valid.
92
+ * Creates another token for requests to the Simulation endpoint. Send it in the X-Continuous-Simulation-Token header. Earlier tokens stay valid until they expire.
93
93
  */
94
94
  async mintSimulationToken(request, options) {
95
95
  return unwrapAsync(simulationsMintSimulationToken(this, request, options));
@@ -13,7 +13,7 @@ export declare class Simulators extends ClientSDK {
13
13
  * Build Simulator
14
14
  *
15
15
  * @remarks
16
- * Creates a Simulator from an OpenAPI or WSDL source. The build runs asynchronously. Send multipart/form-data with one JSON request part, and one spec file part for a spec build.
16
+ * Starts an asynchronous Simulator build and returns the Simulator with status building. Send multipart/form-data with a JSON part named request. To build from a document, add a file part named spec with the OpenAPI or WSDL document. For an incremental build, omit spec and set parent_id and instructions.
17
17
  */
18
18
  buildSimulator(request: operations.BuildSimulatorRequest, options?: RequestOptions): Promise<models.Simulator>;
19
19
  /**
@@ -22,7 +22,7 @@ export class Simulators extends ClientSDK {
22
22
  * Build Simulator
23
23
  *
24
24
  * @remarks
25
- * Creates a Simulator from an OpenAPI or WSDL source. The build runs asynchronously. Send multipart/form-data with one JSON request part, and one spec file part for a spec build.
25
+ * Starts an asynchronous Simulator build and returns the Simulator with status building. Send multipart/form-data with a JSON part named request. To build from a document, add a file part named spec with the OpenAPI or WSDL document. For an incremental build, omit spec and set parent_id and instructions.
26
26
  */
27
27
  async buildSimulator(request, options) {
28
28
  return unwrapAsync(simulatorsBuildSimulator(this, request, options));
@@ -13,7 +13,7 @@ export declare class Worlds extends ClientSDK {
13
13
  * Build World
14
14
  *
15
15
  * @remarks
16
- * Builds a World definition from stable Simulator IDs. Start the World to create its Simulations.
16
+ * Starts an asynchronous World build from one or more ready Simulators and returns the World in the building state. Start the World once it is ready to create its Simulations.
17
17
  */
18
18
  buildWorld(request: models.BuildWorldRequest, options?: RequestOptions): Promise<models.World>;
19
19
  /**
@@ -41,7 +41,7 @@ export declare class Worlds extends ClientSDK {
41
41
  * Start World
42
42
  *
43
43
  * @remarks
44
- * Creates member Simulations on first start. Later starts restore stopped Simulations from saved state.
44
+ * Starts every Simulation in the World. The first start creates the Simulations; later starts restore them from saved state. The World must be ready or stopped, and the workspace must have room for all members under its active-Simulation limit. A running World is returned unchanged.
45
45
  */
46
46
  startWorld(request: operations.StartWorldRequest, options?: RequestOptions): Promise<models.World>;
47
47
  /**
package/esm/sdk/worlds.js CHANGED
@@ -24,7 +24,7 @@ export class Worlds extends ClientSDK {
24
24
  * Build World
25
25
  *
26
26
  * @remarks
27
- * Builds a World definition from stable Simulator IDs. Start the World to create its Simulations.
27
+ * Starts an asynchronous World build from one or more ready Simulators and returns the World in the building state. Start the World once it is ready to create its Simulations.
28
28
  */
29
29
  async buildWorld(request, options) {
30
30
  return unwrapAsync(worldsBuildWorld(this, request, options));
@@ -60,7 +60,7 @@ export class Worlds extends ClientSDK {
60
60
  * Start World
61
61
  *
62
62
  * @remarks
63
- * Creates member Simulations on first start. Later starts restore stopped Simulations from saved state.
63
+ * Starts every Simulation in the World. The first start creates the Simulations; later starts restore them from saved state. The World must be ready or stopped, and the workspace must have room for all members under its active-Simulation limit. A running World is returned unchanged.
64
64
  */
65
65
  async startWorld(request, options) {
66
66
  return unwrapAsync(worldsStartWorld(this, request, options));
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@continuous-labs/sdk",
5
- "version": "0.0.5",
5
+ "version": "0.0.6",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@continuous-labs/sdk",
3
- "version": "0.0.5",
3
+ "version": "0.0.6",
4
4
  "author": "Continuous Labs",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
31
31
  * Create Simulation
32
32
  *
33
33
  * @remarks
34
- * Creates an isolated runtime from a ready Simulator. The response includes its endpoint and a 1-hour token.
34
+ * Creates a Simulation from a ready Simulator and starts it. The response includes the Simulation endpoint and a token that expires in 1 hour. List and get do not return the token.
35
35
  */
36
36
  export function simulationsCreateSimulation(
37
37
  client: ContinuousCore,
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
32
32
  * Fork Simulation
33
33
  *
34
34
  * @remarks
35
- * Creates a Simulation with a 1-hour token. The source Simulation continues to run.
35
+ * Creates a new Simulation from the source Simulation's current state, or from an earlier recorded step when you set at_step. The source must be running or paused; a stopped source returns 409 simulation_stopped. Forking does not change the source. The response includes the new endpoint and a token that expires in 1 hour.
36
36
  */
37
37
  export function simulationsForkSimulation(
38
38
  client: ContinuousCore,
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
32
32
  * Get Simulation
33
33
  *
34
34
  * @remarks
35
- * Returns a Simulation and its current runtime status. The response does not include data-plane tokens.
35
+ * Returns a Simulation and its current status. The response does not include tokens.
36
36
  */
37
37
  export function simulationsGetSimulation(
38
38
  client: ContinuousCore,
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
32
32
  * List Simulation Steps
33
33
  *
34
34
  * @remarks
35
- * Returns recorded steps for a running or paused Simulation. Use any step to create a deterministic fork.
35
+ * Lists the Simulation's steps in order. Each request that changed state is one step; a request that only reads registers none. Pass a step number as at_step when you fork to start the child from the state after that step. A stopped Simulation returns 409 simulation_stopped; start it first.
36
36
  */
37
37
  export function simulationsListSimulationSteps(
38
38
  client: ContinuousCore,
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
32
32
  * Mint Simulation Token
33
33
  *
34
34
  * @remarks
35
- * Mints an expiring data-plane token. Send it in X-Continuous-Simulation-Token. Other unexpired tokens remain valid.
35
+ * Creates another token for requests to the Simulation endpoint. Send it in the X-Continuous-Simulation-Token header. Earlier tokens stay valid until they expire.
36
36
  */
37
37
  export function simulationsMintSimulationToken(
38
38
  client: ContinuousCore,
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
32
32
  * Start Simulation
33
33
  *
34
34
  * @remarks
35
- * Starts a stopped Simulation from its saved runtime state. Its endpoint becomes available after the runtime starts.
35
+ * Starts a stopped Simulation from its saved state. The endpoint serves requests once the response returns. A Simulation that is already running or paused is returned unchanged.
36
36
  */
37
37
  export function simulationsStartSimulation(
38
38
  client: ContinuousCore,
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
32
32
  * Stop Simulation
33
33
  *
34
34
  * @remarks
35
- * Stops a Simulation and saves its runtime state. You can start it later from the saved state.
35
+ * Stops a Simulation and saves its state. Requests to its endpoint return 409 simulation_stopped until you start it again. A stopped Simulation is returned unchanged.
36
36
  */
37
37
  export function simulationsStopSimulation(
38
38
  client: ContinuousCore,
@@ -39,7 +39,7 @@ import { isReadableStream } from "../types/streams.js";
39
39
  * Build Simulator
40
40
  *
41
41
  * @remarks
42
- * Creates a Simulator from an OpenAPI or WSDL source. The build runs asynchronously. Send multipart/form-data with one JSON request part, and one spec file part for a spec build.
42
+ * Starts an asynchronous Simulator build and returns the Simulator with status building. Send multipart/form-data with a JSON part named request. To build from a document, add a file part named spec with the OpenAPI or WSDL document. For an incremental build, omit spec and set parent_id and instructions.
43
43
  */
44
44
  export function simulatorsBuildSimulator(
45
45
  client: ContinuousCore,
@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
31
31
  * Build World
32
32
  *
33
33
  * @remarks
34
- * Builds a World definition from stable Simulator IDs. Start the World to create its Simulations.
34
+ * Starts an asynchronous World build from one or more ready Simulators and returns the World in the building state. Start the World once it is ready to create its Simulations.
35
35
  */
36
36
  export function worldsBuildWorld(
37
37
  client: ContinuousCore,
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
32
32
  * Start World
33
33
  *
34
34
  * @remarks
35
- * Creates member Simulations on first start. Later starts restore stopped Simulations from saved state.
35
+ * Starts every Simulation in the World. The first start creates the Simulations; later starts restore them from saved state. The World must be ready or stopped, and the workspace must have room for all members under its active-Simulation limit. A running World is returned unchanged.
36
36
  */
37
37
  export function worldsStartWorld(
38
38
  client: ContinuousCore,
package/src/lib/config.ts CHANGED
@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
61
61
  export const SDK_METADATA = {
62
62
  language: "typescript",
63
63
  openapiDocVersion: "v1",
64
- sdkVersion: "0.0.5",
64
+ sdkVersion: "0.0.6",
65
65
  genVersion: "2.935.1",
66
- userAgent: "speakeasy-sdk/typescript 0.0.5 2.935.1 v1 @continuous-labs/sdk",
66
+ userAgent: "speakeasy-sdk/typescript 0.0.6 2.935.1 v1 @continuous-labs/sdk",
67
67
  } as const;
@@ -7,14 +7,14 @@ import { remap as remap$ } from "../lib/primitives.js";
7
7
  import { ClosedEnum } from "../types/enums.js";
8
8
 
9
9
  /**
10
- * Builder provider. The default is claude.
10
+ * Model provider that builds the Simulator. Defaults to claude.
11
11
  */
12
12
  export const Builder = {
13
13
  Openai: "openai",
14
14
  Claude: "claude",
15
15
  } as const;
16
16
  /**
17
- * Builder provider. The default is claude.
17
+ * Model provider that builds the Simulator. Defaults to claude.
18
18
  */
19
19
  export type Builder = ClosedEnum<typeof Builder>;
20
20
 
@@ -32,15 +32,15 @@ export type SpecKind = ClosedEnum<typeof SpecKind>;
32
32
 
33
33
  export type BuildSimulatorRequest = {
34
34
  /**
35
- * Builder provider. The default is claude.
35
+ * Model provider that builds the Simulator. Defaults to claude.
36
36
  */
37
37
  builder?: Builder | undefined;
38
38
  /**
39
- * Optional operation filter regular expressions. Supply at most 64 expressions, with 1,024 characters in each expression. An empty list keeps all operations.
39
+ * Regular expressions (RE2 syntax) that select the operations to implement. Each is matched against the OpenAPI operationId or the WSDL operation name; an operation is kept when any expression matches, and an OpenAPI operation without an operationId is dropped. At most 64 expressions of at most 1,024 characters each. Omit or send an empty list to keep every operation. Not allowed for an incremental build.
40
40
  */
41
41
  filter?: Array<string> | undefined;
42
42
  /**
43
- * Build guidance. At most 16,384 characters and 65,536 UTF-8 bytes. U+0000 is not permitted.
43
+ * Instructions for the builder. Required for an incremental build. At most 16,384 characters and 65,536 UTF-8 bytes; must not be blank or contain U+0000.
44
44
  */
45
45
  instructions?: string | undefined;
46
46
  /**
@@ -48,7 +48,7 @@ export type BuildSimulatorRequest = {
48
48
  */
49
49
  name?: string | undefined;
50
50
  /**
51
- * Stable parent Simulator ID for an incremental build.
51
+ * Parent Simulator ID. With instructions and no spec this starts an incremental build: the parent must be ready, and the request takes no filter or spec_kind.
52
52
  */
53
53
  parentId?: string | undefined;
54
54
  /**