Skip to content

Commit c43281b

Browse files
NathanFlurryNathanFlurry
committed
chore: engine npm package
1 parent b3763f1 commit c43281b

21 files changed

Lines changed: 368 additions & 459 deletions

File tree

‎engine/package.json‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎rivetkit-json-schema/registry-config.json‎

Lines changed: 70 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,22 @@
6464
"type": "string"
6565
}
6666
},
67-
"serveManager": {
68-
"description": "Whether to start the local RivetKit server. Auto-determined based on endpoint and NODE_ENV if not specified.",
69-
"type": "boolean"
67+
"staticDir": {
68+
"description": "Directory to serve static files from. When set, registry.start() serves static files alongside the actor API.",
69+
"type": "string"
7070
},
71-
"managerBasePath": {
71+
"httpBasePath": {
7272
"description": "Base path for the local RivetKit API. Default: '/'",
7373
"type": "string"
7474
},
75-
"managerPort": {
76-
"description": "Port to run the manager on. Default: 6420",
75+
"httpPort": {
76+
"description": "Port to run the local HTTP server on. Default: 6421",
7777
"type": "number"
7878
},
79+
"httpHost": {
80+
"description": "Host to bind the local HTTP server to.",
81+
"type": "string"
82+
},
7983
"inspector": {
8084
"description": "Inspector configuration for debugging and development.",
8185
"type": "object",
@@ -95,74 +99,66 @@
9599
},
96100
"additionalProperties": false
97101
},
98-
"serverless": {
99-
"description": "Configuration for serverless deployment mode.",
102+
"startEngine": {
103+
"description": "Starts the full Rust engine process locally. Default: false",
104+
"type": "boolean"
105+
},
106+
"engineVersion": {
107+
"description": "Version of the local engine package to use. Defaults to the current RivetKit version.",
108+
"type": "string"
109+
},
110+
"configurePool": {
111+
"description": "Automatically configure serverless runners in the engine.",
100112
"type": "object",
101113
"properties": {
102-
"spawnEngine": {
103-
"description": "Downloads and starts the full Rust engine process. Auto-enabled in development mode when no endpoint is provided. Default: false",
104-
"type": "boolean"
114+
"name": {
115+
"description": "Name of the runner pool.",
116+
"type": "string"
105117
},
106-
"engineVersion": {
107-
"description": "Version of the engine to download. Defaults to the current RivetKit version.",
118+
"url": {
119+
"description": "URL of the serverless platform to configure runners.",
108120
"type": "string"
109121
},
110-
"configureRunnerPool": {
111-
"description": "Automatically configure serverless runners in the engine.",
122+
"headers": {
123+
"description": "Headers to include in requests to the serverless platform.",
124+
"type": "object",
125+
"propertyNames": {
126+
"type": "string"
127+
},
128+
"additionalProperties": {
129+
"type": "string"
130+
}
131+
},
132+
"requestLifespan": {
133+
"description": "Maximum lifespan of a request in seconds.",
134+
"type": "number"
135+
},
136+
"metadata": {
137+
"description": "Additional metadata to pass to the serverless platform.",
112138
"type": "object",
113-
"properties": {
114-
"name": {
115-
"description": "Name of the runner pool.",
116-
"type": "string"
117-
},
118-
"url": {
119-
"description": "URL of the serverless platform to configure runners.",
120-
"type": "string"
121-
},
122-
"headers": {
123-
"description": "Headers to include in requests to the serverless platform.",
124-
"type": "object",
125-
"propertyNames": {
126-
"type": "string"
127-
},
128-
"additionalProperties": {
129-
"type": "string"
130-
}
131-
},
132-
"maxRunners": {
133-
"description": "Maximum number of runners in the pool.",
134-
"type": "number"
135-
},
136-
"minRunners": {
137-
"description": "Minimum number of runners to keep warm.",
138-
"type": "number"
139-
},
140-
"requestLifespan": {
141-
"description": "Maximum lifespan of a request in milliseconds.",
142-
"type": "number"
143-
},
144-
"runnersMargin": {
145-
"description": "Buffer margin for scaling runners.",
146-
"type": "number"
147-
},
148-
"slotsPerRunner": {
149-
"description": "Number of actor slots per runner.",
150-
"type": "number"
151-
},
152-
"metadata": {
153-
"description": "Additional metadata to pass to the serverless platform.",
154-
"type": "object",
155-
"propertyNames": {
156-
"type": "string"
157-
},
158-
"additionalProperties": {}
159-
}
139+
"propertyNames": {
140+
"type": "string"
160141
},
161-
"required": [
162-
"url"
163-
],
164-
"additionalProperties": false
142+
"additionalProperties": {}
165143
},
144+
"metadataPollInterval": {
145+
"description": "Interval in milliseconds between metadata polls from the engine. Defaults to 10000 milliseconds (10 seconds).",
146+
"type": "number"
147+
},
148+
"drainOnVersionUpgrade": {
149+
"description": "Drain runners when a new version is deployed. Defaults to true.",
150+
"type": "boolean"
151+
}
152+
},
153+
"required": [
154+
"url"
155+
],
156+
"additionalProperties": false
157+
},
158+
"serverless": {
159+
"description": "Configuration for serverless deployment mode.",
160+
"type": "object",
161+
"properties": {
166162
"basePath": {
167163
"description": "Base path for serverless API routes. Default: '/api/rivet'",
168164
"type": "string"
@@ -178,24 +174,24 @@
178174
},
179175
"additionalProperties": false
180176
},
181-
"runner": {
182-
"description": "Configuration for runner mode.",
177+
"envoy": {
178+
"description": "Configuration for envoy mode.",
183179
"type": "object",
184180
"properties": {
185181
"totalSlots": {
186182
"description": "Total number of actor slots available. Default: 100000",
187183
"type": "number"
188184
},
189-
"runnerName": {
190-
"description": "Name of this runner. Default: 'default'",
185+
"poolName": {
186+
"description": "Name of this envoy pool. Default: 'default'",
191187
"type": "string"
192188
},
193-
"runnerKey": {
194-
"description": "Authentication key for the runner.",
189+
"envoyKey": {
190+
"description": "Deprecated. Authentication key for the envoy.",
195191
"type": "string"
196192
},
197193
"version": {
198-
"description": "Version number of this runner. Default: 1",
194+
"description": "Version number of this envoy. Default: 1",
199195
"type": "number"
200196
}
201197
},
@@ -207,4 +203,4 @@
207203
],
208204
"additionalProperties": false,
209205
"title": "RivetKit Registry Configuration"
210-
}
206+
}

‎rivetkit-typescript/artifacts/registry-config.json‎

Lines changed: 70 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,22 @@
6464
"type": "string"
6565
}
6666
},
67-
"serveManager": {
68-
"description": "Whether to start the local RivetKit server. Auto-determined based on endpoint and NODE_ENV if not specified.",
69-
"type": "boolean"
67+
"staticDir": {
68+
"description": "Directory to serve static files from. When set, registry.start() serves static files alongside the actor API.",
69+
"type": "string"
7070
},
71-
"managerBasePath": {
71+
"httpBasePath": {
7272
"description": "Base path for the local RivetKit API. Default: '/'",
7373
"type": "string"
7474
},
75-
"managerPort": {
76-
"description": "Port to run the manager on. Default: 6420",
75+
"httpPort": {
76+
"description": "Port to run the local HTTP server on. Default: 6421",
7777
"type": "number"
7878
},
79+
"httpHost": {
80+
"description": "Host to bind the local HTTP server to.",
81+
"type": "string"
82+
},
7983
"inspector": {
8084
"description": "Inspector configuration for debugging and development.",
8185
"type": "object",
@@ -95,74 +99,66 @@
9599
},
96100
"additionalProperties": false
97101
},
98-
"serverless": {
99-
"description": "Configuration for serverless deployment mode.",
102+
"startEngine": {
103+
"description": "Starts the full Rust engine process locally. Default: false",
104+
"type": "boolean"
105+
},
106+
"engineVersion": {
107+
"description": "Version of the local engine package to use. Defaults to the current RivetKit version.",
108+
"type": "string"
109+
},
110+
"configurePool": {
111+
"description": "Automatically configure serverless runners in the engine.",
100112
"type": "object",
101113
"properties": {
102-
"spawnEngine": {
103-
"description": "Downloads and starts the full Rust engine process. Auto-enabled in development mode when no endpoint is provided. Default: false",
104-
"type": "boolean"
114+
"name": {
115+
"description": "Name of the runner pool.",
116+
"type": "string"
105117
},
106-
"engineVersion": {
107-
"description": "Version of the engine to download. Defaults to the current RivetKit version.",
118+
"url": {
119+
"description": "URL of the serverless platform to configure runners.",
108120
"type": "string"
109121
},
110-
"configureRunnerPool": {
111-
"description": "Automatically configure serverless runners in the engine.",
122+
"headers": {
123+
"description": "Headers to include in requests to the serverless platform.",
124+
"type": "object",
125+
"propertyNames": {
126+
"type": "string"
127+
},
128+
"additionalProperties": {
129+
"type": "string"
130+
}
131+
},
132+
"requestLifespan": {
133+
"description": "Maximum lifespan of a request in seconds.",
134+
"type": "number"
135+
},
136+
"metadata": {
137+
"description": "Additional metadata to pass to the serverless platform.",
112138
"type": "object",
113-
"properties": {
114-
"name": {
115-
"description": "Name of the runner pool.",
116-
"type": "string"
117-
},
118-
"url": {
119-
"description": "URL of the serverless platform to configure runners.",
120-
"type": "string"
121-
},
122-
"headers": {
123-
"description": "Headers to include in requests to the serverless platform.",
124-
"type": "object",
125-
"propertyNames": {
126-
"type": "string"
127-
},
128-
"additionalProperties": {
129-
"type": "string"
130-
}
131-
},
132-
"maxRunners": {
133-
"description": "Maximum number of runners in the pool.",
134-
"type": "number"
135-
},
136-
"minRunners": {
137-
"description": "Minimum number of runners to keep warm.",
138-
"type": "number"
139-
},
140-
"requestLifespan": {
141-
"description": "Maximum lifespan of a request in milliseconds.",
142-
"type": "number"
143-
},
144-
"runnersMargin": {
145-
"description": "Buffer margin for scaling runners.",
146-
"type": "number"
147-
},
148-
"slotsPerRunner": {
149-
"description": "Number of actor slots per runner.",
150-
"type": "number"
151-
},
152-
"metadata": {
153-
"description": "Additional metadata to pass to the serverless platform.",
154-
"type": "object",
155-
"propertyNames": {
156-
"type": "string"
157-
},
158-
"additionalProperties": {}
159-
}
139+
"propertyNames": {
140+
"type": "string"
160141
},
161-
"required": [
162-
"url"
163-
],
164-
"additionalProperties": false
142+
"additionalProperties": {}
165143
},
144+
"metadataPollInterval": {
145+
"description": "Interval in milliseconds between metadata polls from the engine. Defaults to 10000 milliseconds (10 seconds).",
146+
"type": "number"
147+
},
148+
"drainOnVersionUpgrade": {
149+
"description": "Drain runners when a new version is deployed. Defaults to true.",
150+
"type": "boolean"
151+
}
152+
},
153+
"required": [
154+
"url"
155+
],
156+
"additionalProperties": false
157+
},
158+
"serverless": {
159+
"description": "Configuration for serverless deployment mode.",
160+
"type": "object",
161+
"properties": {
166162
"basePath": {
167163
"description": "Base path for serverless API routes. Default: '/api/rivet'",
168164
"type": "string"
@@ -178,24 +174,24 @@
178174
},
179175
"additionalProperties": false
180176
},
181-
"runner": {
182-
"description": "Configuration for runner mode.",
177+
"envoy": {
178+
"description": "Configuration for envoy mode.",
183179
"type": "object",
184180
"properties": {
185181
"totalSlots": {
186182
"description": "Total number of actor slots available. Default: 100000",
187183
"type": "number"
188184
},
189-
"runnerName": {
190-
"description": "Name of this runner. Default: 'default'",
185+
"poolName": {
186+
"description": "Name of this envoy pool. Default: 'default'",
191187
"type": "string"
192188
},
193-
"runnerKey": {
194-
"description": "Authentication key for the runner.",
189+
"envoyKey": {
190+
"description": "Deprecated. Authentication key for the envoy.",
195191
"type": "string"
196192
},
197193
"version": {
198-
"description": "Version number of this runner. Default: 1",
194+
"description": "Version number of this envoy. Default: 1",
199195
"type": "number"
200196
}
201197
},
@@ -207,4 +203,4 @@
207203
],
208204
"additionalProperties": false,
209205
"title": "RivetKit Registry Configuration"
210-
}
206+
}

0 commit comments

Comments
 (0)