@vasp-framework/core 0.1.0 → 0.1.1
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/README.md +49 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# @vasp-framework/core
|
|
2
|
+
|
|
3
|
+
Shared types, AST node definitions, error classes, and constants for the Vasp framework.
|
|
4
|
+
|
|
5
|
+
This package is an internal dependency used by `@vasp-framework/parser`, `@vasp-framework/generator`, and `vasp-cli`. You don't need to install it directly unless you're building Vasp tooling.
|
|
6
|
+
|
|
7
|
+
## Contents
|
|
8
|
+
|
|
9
|
+
### AST Types
|
|
10
|
+
|
|
11
|
+
The `VaspAST` interface is the source of truth for what a parsed `.vasp` file looks like:
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
interface VaspAST {
|
|
15
|
+
app: AppNode
|
|
16
|
+
auth?: AuthNode
|
|
17
|
+
routes: RouteNode[]
|
|
18
|
+
pages: PageNode[]
|
|
19
|
+
queries: QueryNode[]
|
|
20
|
+
actions: ActionNode[]
|
|
21
|
+
cruds: CrudNode[]
|
|
22
|
+
realtimes: RealtimeNode[]
|
|
23
|
+
jobs: JobNode[]
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Error Classes
|
|
28
|
+
|
|
29
|
+
| Class | Description |
|
|
30
|
+
|---|---|
|
|
31
|
+
| `VaspError` | Base error class |
|
|
32
|
+
| `ParseError` | Thrown by the parser with structured diagnostics |
|
|
33
|
+
| `GeneratorError` | Thrown by the code generator |
|
|
34
|
+
|
|
35
|
+
### Constants
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
VASP_VERSION // '0.1.0'
|
|
39
|
+
DEFAULT_BACKEND_PORT // 3001
|
|
40
|
+
DEFAULT_SPA_PORT // 5173
|
|
41
|
+
DEFAULT_SSR_PORT // 3000
|
|
42
|
+
SUPPORTED_AUTH_METHODS // ['usernameAndPassword', 'google', 'github']
|
|
43
|
+
SUPPORTED_CRUD_OPERATIONS // ['list', 'create', 'update', 'delete']
|
|
44
|
+
SUPPORTED_REALTIME_EVENTS // ['created', 'updated', 'deleted']
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
[Apache 2.0](../../LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vasp-framework/core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Shared types, AST definitions, and error classes for the Vasp framework",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
}
|
|
19
19
|
},
|
|
20
20
|
"files": [
|
|
21
|
-
"dist"
|
|
21
|
+
"dist",
|
|
22
|
+
"README.md"
|
|
22
23
|
],
|
|
23
24
|
"scripts": {
|
|
24
25
|
"build": "tsc -p tsconfig.json",
|