@concavejs/runtime-node 0.0.1-alpha.4
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.
Potentially problematic release.
This version of @concavejs/runtime-node might be problematic. Click here for more details.
- package/README.md +85 -0
- package/dist/factory.d.ts +54 -0
- package/dist/factory.js +47381 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +49169 -0
- package/dist/module-loader/fs-module-loader.d.ts +15 -0
- package/dist/server/dev.d.ts +7 -0
- package/dist/server/http-handler.d.ts +12 -0
- package/dist/server/index.d.ts +88 -0
- package/dist/server/index.js +47366 -0
- package/dist/server/sync-handler.d.ts +17 -0
- package/package.json +46 -0
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# @concavejs/runtime-node
|
|
2
|
+
|
|
3
|
+
Library-first Node.js runtime for Concave.
|
|
4
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
- Node.js >= 22.5
|
|
8
|
+
- Run with `--experimental-sqlite`
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install @concavejs/runtime-node @concavejs/docstore-node-sqlite @concavejs/blobstore-node-fs
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quick start
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
import { createConcave } from "@concavejs/runtime-node";
|
|
20
|
+
|
|
21
|
+
const server = createConcave({
|
|
22
|
+
convexDir: "./convex",
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
await server.listen({ port: 3000, hostname: "127.0.0.1" });
|
|
26
|
+
console.log(server.url);
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Custom adapters
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import { createConcave, SqliteDocStore, FsBlobStore } from "@concavejs/runtime-node";
|
|
33
|
+
|
|
34
|
+
const server = createConcave({
|
|
35
|
+
convexDir: "./convex",
|
|
36
|
+
docstore: new SqliteDocStore("./data/db.sqlite"),
|
|
37
|
+
blobstore: new FsBlobStore("./data/storage"),
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
await server.listen({ port: 3000 });
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
You can also pass builders:
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
const server = createConcave({
|
|
47
|
+
convexDir: "./convex",
|
|
48
|
+
docstore: ({ runtime }) => {
|
|
49
|
+
if (runtime !== "node") throw new Error("Unexpected runtime");
|
|
50
|
+
return new SqliteDocStore("./data/db.sqlite");
|
|
51
|
+
},
|
|
52
|
+
blobstore: () => new FsBlobStore("./data/storage"),
|
|
53
|
+
});
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Module loading
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
const server = createConcave({
|
|
60
|
+
modules: {
|
|
61
|
+
"messages.ts": () => import("./convex/messages.ts"),
|
|
62
|
+
},
|
|
63
|
+
});
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
`modules` also accepts a single loader function or an array of loader sources.
|
|
67
|
+
|
|
68
|
+
## API
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
type ConcaveOptions = {
|
|
72
|
+
convexDir?: string;
|
|
73
|
+
docstore?: DocStore | ((context: { runtime: "node"; options: Readonly<ConcaveOptions> }) => DocStore);
|
|
74
|
+
blobstore?: BlobStore | ((context: { runtime: "node"; options: Readonly<ConcaveOptions> }) => BlobStore);
|
|
75
|
+
schema?: "auto" | "skip";
|
|
76
|
+
modules?: ModuleLoader | Record<string, ModuleRegistryEntry> | Array<ModuleLoader | Record<string, ModuleRegistryEntry>>;
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
type Server = {
|
|
80
|
+
listen(options?: { port?: number; hostname?: string }): Promise<void>;
|
|
81
|
+
close(): Promise<void>;
|
|
82
|
+
readonly url: string;
|
|
83
|
+
readonly port: number;
|
|
84
|
+
};
|
|
85
|
+
```
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Library-first factory API for Concave Node runtime.
|
|
3
|
+
*/
|
|
4
|
+
import type { DocStore } from "@concavejs/core/docstore";
|
|
5
|
+
import type { BlobStore } from "@concavejs/core/abstractions";
|
|
6
|
+
import { NodeServer, type NodeBlobStoreFactory, type NodeDocStoreFactory, type NodeModuleSources, type SchemaBootstrapMode } from "./server";
|
|
7
|
+
/**
|
|
8
|
+
* Options for createConcave().
|
|
9
|
+
*/
|
|
10
|
+
export interface ConcaveOptions {
|
|
11
|
+
/**
|
|
12
|
+
* Document storage provider.
|
|
13
|
+
* Defaults to SqliteDocStore at ./.concave/local/db.sqlite.
|
|
14
|
+
*/
|
|
15
|
+
docstore?: DocStore | NodeDocStoreFactory;
|
|
16
|
+
/**
|
|
17
|
+
* Blob storage provider.
|
|
18
|
+
* Defaults to FsBlobStore at ./.concave/local/storage.
|
|
19
|
+
*/
|
|
20
|
+
blobstore?: BlobStore | NodeBlobStoreFactory;
|
|
21
|
+
/**
|
|
22
|
+
* Module sources for loading UDF files.
|
|
23
|
+
* Accepts a loader function, a loader list, or a module map.
|
|
24
|
+
*/
|
|
25
|
+
modules?: NodeModuleSources;
|
|
26
|
+
/**
|
|
27
|
+
* Path to convex/ directory with UDF modules.
|
|
28
|
+
*/
|
|
29
|
+
convexDir?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Path to the directory containing root UDF modules (defaults to convexDir).
|
|
32
|
+
*/
|
|
33
|
+
functionsDir?: string;
|
|
34
|
+
/**
|
|
35
|
+
* Schema bootstrap mode.
|
|
36
|
+
* "auto" (default) loads schema indexes when available, "skip" disables schema loading.
|
|
37
|
+
*/
|
|
38
|
+
schema?: SchemaBootstrapMode;
|
|
39
|
+
/**
|
|
40
|
+
* Pre-rendered dashboard HTML for /_dashboard responses.
|
|
41
|
+
*/
|
|
42
|
+
dashboardHtml?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Whether this server is running in dev mode.
|
|
45
|
+
* Controls whether logLines are sent on the wire. Defaults to true.
|
|
46
|
+
*/
|
|
47
|
+
isDev?: boolean;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Create a configured Node server instance.
|
|
51
|
+
*
|
|
52
|
+
* Use `await server.listen({ port, hostname })` to start serving.
|
|
53
|
+
*/
|
|
54
|
+
export declare function createConcave(options?: ConcaveOptions): NodeServer;
|