@jigx/core-sdk 1.2.0-next.6 → 1.2.0-next.7
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
CHANGED
|
@@ -1,89 +1,13 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @jigx/core-sdk
|
|
2
2
|
|
|
3
|
-
TypeScript
|
|
3
|
+
Fluent TypeScript builders that compile to Jigx YAML application config. CLI workflow (`jigx build`, `jigx deploy`): [`@jigx/sdk-tools`](../sdk-tools/README.md).
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
See [DESIGN.md](./DESIGN.md) for architecture details.
|
|
8
|
-
|
|
9
|
-
## Features
|
|
10
|
-
|
|
11
|
-
- **ApplicationBuilder**: Main orchestrator for app construction
|
|
12
|
-
- **Screen Types**: List, default, grid, calendar, document, tabs, wizard
|
|
13
|
-
- **Component Library**: 50+ mobile-optimized UI components
|
|
14
|
-
- **Action System**: Navigation, state management, entity operations
|
|
15
|
-
- **Data Providers**: SQLite, static, system datasources
|
|
16
|
-
- **Function Builders**: REST, SQL, SOAP integrations
|
|
17
|
-
|
|
18
|
-
## Directory Structure
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
src/
|
|
22
|
-
├── abstract/ # Base classes, factory helpers, expression types
|
|
23
|
-
├── jsonata/ # JSONata parsing, context policy, AST utilities, builder base
|
|
24
|
-
├── application/ # ApplicationBuilder, CTX utilities
|
|
25
|
-
├── screen/ # Screen builders (list, default, grid, etc.)
|
|
26
|
-
├── component/ # UI components (74 exports)
|
|
27
|
-
├── action/ # Action builders (52 exports)
|
|
28
|
-
├── datasource/ # Data source builders
|
|
29
|
-
├── function/ # REST, SQL, SOAP function builders
|
|
30
|
-
├── database/ # SQLite database configuration
|
|
31
|
-
├── widget/ # Home hub widgets
|
|
32
|
-
├── builder/ # Build orchestration and validation
|
|
33
|
-
├── utils/ # Type guards, converters
|
|
34
|
-
├── runtime/ # Auth, System state interfaces
|
|
35
|
-
└── __tests__/ # Test suite
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## Quick Start
|
|
39
|
-
|
|
40
|
-
```typescript
|
|
41
|
-
import { application, CTX } from '@jigx/core-sdk'
|
|
5
|
+
```ts
|
|
6
|
+
import { application } from '@jigx/core-sdk'
|
|
42
7
|
|
|
43
8
|
const app = application('my-app', 'My App')
|
|
44
|
-
|
|
45
|
-
// Add datasource
|
|
46
|
-
app.addDatasource.sqlite('customers', 'dynamic')
|
|
47
|
-
.entity('default/customers')
|
|
48
|
-
.query('SELECT id, data FROM [default/customers]')
|
|
49
|
-
|
|
50
|
-
// Create screen with list
|
|
51
|
-
const screen = app.addScreen.list({ screenId: 'customers', title: 'Customers' })
|
|
52
|
-
.data('=@ctx.datasources.customers')
|
|
53
|
-
|
|
54
|
-
// Add list item template
|
|
55
|
-
screen.addControl.listItem({ instanceId: 'item' })
|
|
56
|
-
.title('=@ctx.current.item.name')
|
|
57
|
-
.onPress.goto({ linkTo: 'detail', parameters: { $id: '=@ctx.current.item.id' } })
|
|
58
|
-
|
|
59
|
-
// Build
|
|
9
|
+
app.addScreen.list({ screenId: 'customers', title: 'Customers' })
|
|
60
10
|
const result = app.build()
|
|
61
11
|
```
|
|
62
12
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
- `application(name, title?, description?)` - Creates ApplicationBuilder
|
|
66
|
-
- `ApplicationBuilder` - Main orchestrator with `addScreen`, `addDatasource`, `addFunction`, `addDatabase` factories
|
|
67
|
-
- `CTX` - Context utilities for building JSONata expressions (`CTX.datasources`, `CTX.screen.inputs`, `CTX.current.item`, etc.)
|
|
68
|
-
- Screen builders - `ListScreenBuilder`, `DefaultScreenBuilder`, `GridScreenBuilder`, etc.
|
|
69
|
-
- Component builders - 70+ builders for forms, layouts, charts, and display
|
|
70
|
-
- Action builders - Navigation (`JaGoToBuilder`), state management, entity operations
|
|
71
|
-
- Datasource builders - `SqliteDatasourceBuilder`, `StaticDatasourceBuilder`, `SystemDatasourceBuilder`
|
|
72
|
-
|
|
73
|
-
## Build Scripts
|
|
74
|
-
|
|
75
|
-
```bash
|
|
76
|
-
yarn build # Full build: SDK + types + examples
|
|
77
|
-
yarn build:sdk # TypeScript compilation only
|
|
78
|
-
yarn test # Run test suite
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Package Exports
|
|
82
|
-
|
|
83
|
-
- `"."` → Main SDK API (builders, factories, utils)
|
|
84
|
-
- `"./testing/assert"` → Test helpers
|
|
85
|
-
- `"./loaders/types"` → Runtime type loader for MCP
|
|
86
|
-
|
|
87
|
-
## Assets
|
|
88
|
-
|
|
89
|
-
Build generates `assets/types-index.json` for runtime type loading. Copied to `dist/assets/` during build.
|
|
13
|
+
Consumer guides: [docs/](./docs/).
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": "2.0.0",
|
|
3
|
-
"sourceHash": "
|
|
4
|
-
"timestamp":
|
|
3
|
+
"sourceHash": "8e10e93065664af0ed592488d5110e64",
|
|
4
|
+
"timestamp": 1791362830571,
|
|
5
5
|
"stats": {
|
|
6
6
|
"inputFiles": 427,
|
|
7
|
-
"extractionTimeMs":
|
|
7
|
+
"extractionTimeMs": 302
|
|
8
8
|
}
|
|
9
9
|
}
|