Skip to content

Commit db2ecd0

Browse files
NathanFlurryNathanFlurry
committed
chore: engine npm package
1 parent 3720030 commit db2ecd0

File tree

38 files changed

+860
-612
lines changed

38 files changed

+860
-612
lines changed

‎engine/package.json‎

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

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
},
3434
"resolutions": {
3535
"rivetkit": "workspace:*",
36+
"@rivetkit/engine": "workspace:*",
3637
"@rivetkit/react": "workspace:*",
3738
"@rivetkit/next-js": "workspace:*",
3839
"@rivetkit/db": "workspace:*",

‎pnpm-lock.yaml‎

Lines changed: 28 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pnpm-workspace.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ packages:
1616
- frontend/packages/icons/
1717
- frontend/packages/shared-data/
1818
- rivetkit-typescript/packages/*
19+
- rivetkit-typescript/packages/engine/npm/*
1920
- rivetkit-swift/examples/*/server
2021
- scripts/release
2122
- scripts/tests

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

Lines changed: 97 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@
1010
},
1111
"additionalProperties": {}
1212
},
13+
"sqlitePool": {
14+
"description": "Configuration for the SQLite VFS pool that shares WASM instances across actors.",
15+
"type": "object",
16+
"properties": {
17+
"actorsPerInstance": {
18+
"description": "Number of actors per WASM SQLite instance. Default: 50",
19+
"type": "number"
20+
},
21+
"idleDestroyMs": {
22+
"description": "Milliseconds before an idle WASM instance is destroyed. Default: 30000",
23+
"type": "number"
24+
}
25+
},
26+
"additionalProperties": false
27+
},
1328
"maxIncomingMessageSize": {
1429
"description": "Maximum size of incoming WebSocket messages in bytes. Default: 65536",
1530
"type": "number"
@@ -64,18 +79,22 @@
6479
"type": "string"
6580
}
6681
},
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"
82+
"staticDir": {
83+
"description": "Directory to serve static files from. When set, registry.start() serves static files alongside the actor API.",
84+
"type": "string"
7085
},
71-
"managerBasePath": {
86+
"httpBasePath": {
7287
"description": "Base path for the local RivetKit API. Default: '/'",
7388
"type": "string"
7489
},
75-
"managerPort": {
76-
"description": "Port to run the manager on. Default: 6420",
90+
"httpPort": {
91+
"description": "Port to run the local HTTP server on. Default: 6421",
7792
"type": "number"
7893
},
94+
"httpHost": {
95+
"description": "Host to bind the local HTTP server to.",
96+
"type": "string"
97+
},
7998
"inspector": {
8099
"description": "Inspector configuration for debugging and development.",
81100
"type": "object",
@@ -95,74 +114,78 @@
95114
},
96115
"additionalProperties": false
97116
},
98-
"serverless": {
99-
"description": "Configuration for serverless deployment mode.",
117+
"startEngine": {
118+
"description": "Starts the full Rust engine process locally. Default: false",
119+
"type": "boolean"
120+
},
121+
"engineVersion": {
122+
"description": "Version of the local engine package to use. Defaults to the current RivetKit version.",
123+
"type": "string"
124+
},
125+
"configurePool": {
126+
"description": "Automatically configure serverless runners in the engine.",
100127
"type": "object",
101128
"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"
129+
"name": {
130+
"description": "Name of the runner pool.",
131+
"type": "string"
105132
},
106-
"engineVersion": {
107-
"description": "Version of the engine to download. Defaults to the current RivetKit version.",
133+
"url": {
134+
"description": "URL of the serverless platform to configure runners.",
108135
"type": "string"
109136
},
110-
"configureRunnerPool": {
111-
"description": "Automatically configure serverless runners in the engine.",
137+
"headers": {
138+
"description": "Headers to include in requests to the serverless platform.",
112139
"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-
}
140+
"propertyNames": {
141+
"type": "string"
160142
},
161-
"required": [
162-
"url"
163-
],
164-
"additionalProperties": false
143+
"additionalProperties": {
144+
"type": "string"
145+
}
165146
},
147+
"maxRunners": {
148+
"description": "Maximum number of runners in the pool.",
149+
"type": "number"
150+
},
151+
"minRunners": {
152+
"description": "Minimum number of runners to keep warm.",
153+
"type": "number"
154+
},
155+
"requestLifespan": {
156+
"description": "Maximum lifespan of a request in milliseconds.",
157+
"type": "number"
158+
},
159+
"runnersMargin": {
160+
"description": "Buffer margin for scaling runners.",
161+
"type": "number"
162+
},
163+
"slotsPerRunner": {
164+
"description": "Number of actor slots per runner.",
165+
"type": "number"
166+
},
167+
"metadata": {
168+
"description": "Additional metadata to pass to the serverless platform.",
169+
"type": "object",
170+
"propertyNames": {
171+
"type": "string"
172+
},
173+
"additionalProperties": {}
174+
},
175+
"metadataPollInterval": {
176+
"description": "Interval in milliseconds between metadata polls from the engine. Defaults to 10000 milliseconds (10 seconds).",
177+
"type": "number"
178+
}
179+
},
180+
"required": [
181+
"url"
182+
],
183+
"additionalProperties": false
184+
},
185+
"serverless": {
186+
"description": "Configuration for serverless deployment mode.",
187+
"type": "object",
188+
"properties": {
166189
"basePath": {
167190
"description": "Base path for serverless API routes. Default: '/api/rivet'",
168191
"type": "string"
@@ -178,24 +201,24 @@
178201
},
179202
"additionalProperties": false
180203
},
181-
"runner": {
182-
"description": "Configuration for runner mode.",
204+
"envoy": {
205+
"description": "Configuration for envoy mode.",
183206
"type": "object",
184207
"properties": {
185208
"totalSlots": {
186209
"description": "Total number of actor slots available. Default: 100000",
187210
"type": "number"
188211
},
189-
"runnerName": {
190-
"description": "Name of this runner. Default: 'default'",
212+
"poolName": {
213+
"description": "Name of this envoy pool. Default: 'default'",
191214
"type": "string"
192215
},
193-
"runnerKey": {
194-
"description": "Authentication key for the runner.",
216+
"envoyKey": {
217+
"description": "Deprecated. Authentication key for the envoy.",
195218
"type": "string"
196219
},
197220
"version": {
198-
"description": "Version number of this runner. Default: 1",
221+
"description": "Version number of this envoy. Default: 1",
199222
"type": "number"
200223
}
201224
},
@@ -207,4 +230,4 @@
207230
],
208231
"additionalProperties": false,
209232
"title": "RivetKit Registry Configuration"
210-
}
233+
}

0 commit comments

Comments
 (0)