@shing.wong/sure-factor 0.2.1 → 0.3.2
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 +11 -0
- package/catalog/components/auth-login.yaml +0 -2
- package/catalog/components/crud-resource.yaml +0 -2
- package/catalog/components/data-table.yaml +3 -2
- package/catalog/components/dialog.yaml +0 -2
- package/catalog/components/form-modal.yaml +0 -2
- package/catalog/components/form.yaml +5 -2
- package/catalog/components/markdown.yaml +0 -2
- package/catalog/components/search-filter.yaml +0 -2
- package/catalog/components/session-list.yaml +0 -2
- package/dist/generate-client.d.ts +55 -0
- package/dist/generate-client.d.ts.map +1 -0
- package/dist/generate-client.js +565 -0
- package/dist/generate-client.js.map +1 -0
- package/dist/generate-internal.d.ts +33 -0
- package/dist/generate-internal.d.ts.map +1 -0
- package/dist/generate-internal.js +65 -0
- package/dist/generate-internal.js.map +1 -0
- package/dist/generate.d.ts +15 -0
- package/dist/generate.d.ts.map +1 -1
- package/dist/generate.js +136 -31
- package/dist/generate.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/match.d.ts.map +1 -1
- package/dist/match.js +6 -1
- package/dist/match.js.map +1 -1
- package/dist/parse-yaml.d.ts.map +1 -1
- package/dist/parse-yaml.js +114 -4
- package/dist/parse-yaml.js.map +1 -1
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -79,6 +79,17 @@ const output = generateForTier(schema, { tier: 'production', component: 'form' }
|
|
|
79
79
|
2. **Match** — Match each column to catalog type definitions using name patterns + data type rules → `TypeMatchResult` with confidence scoring
|
|
80
80
|
3. **Generate** — Produce tier-aware output: routes, templates, i18n, sanitization pipeline, validation rules, theme CSS, and sure-state stores
|
|
81
81
|
|
|
82
|
+
## Installation
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npm install @shing.wong/sure-factor
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
No peer dependencies. `pg` and `prettier` are regular dependencies, so live
|
|
89
|
+
schema introspection and code formatting work without extra setup.
|
|
90
|
+
|
|
91
|
+
Requires Node >= 20.
|
|
92
|
+
|
|
82
93
|
## Quick Start
|
|
83
94
|
|
|
84
95
|
```ts
|
|
@@ -40,9 +40,7 @@ behavior:
|
|
|
40
40
|
autoFocus: false
|
|
41
41
|
confirmBeforeCancel: false
|
|
42
42
|
scripts:
|
|
43
|
-
- audio-feedback.js
|
|
44
43
|
- voice-help.js
|
|
45
|
-
- notification-handler.js
|
|
46
44
|
cssClasses:
|
|
47
45
|
form: sure-table
|
|
48
46
|
field: sure-table__cell
|
|
@@ -50,5 +48,8 @@ cssClasses:
|
|
|
50
48
|
error: sure-table__error
|
|
51
49
|
help: sure-table__help
|
|
52
50
|
label: sure-table__header
|
|
51
|
+
row: sure-table__row
|
|
52
|
+
cell: sure-table__cell
|
|
53
|
+
header: sure-table__header
|
|
53
54
|
example:
|
|
54
55
|
usage: Generate a sortable patient list table with columns for name, DOB, last visit, status, and assigned provider
|
|
@@ -33,9 +33,8 @@ behavior:
|
|
|
33
33
|
autoFocus: true
|
|
34
34
|
confirmBeforeCancel: false
|
|
35
35
|
scripts:
|
|
36
|
-
-
|
|
36
|
+
- error-bell.js
|
|
37
37
|
- voice-help.js
|
|
38
|
-
- notification-handler.js
|
|
39
38
|
cssClasses:
|
|
40
39
|
form: sure-form
|
|
41
40
|
field: sure-form__field
|
|
@@ -43,5 +42,9 @@ cssClasses:
|
|
|
43
42
|
error: sure-form__error
|
|
44
43
|
help: sure-form__help
|
|
45
44
|
label: sure-form__label
|
|
45
|
+
title: sure-form__title
|
|
46
|
+
actions: sure-form__actions
|
|
47
|
+
submit: btn-primary
|
|
48
|
+
cancel: btn-secondary
|
|
46
49
|
example:
|
|
47
50
|
usage: Generate a patient intake form with name, email, diagnosis, and ZIP code fields
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { SchemaInfo } from './introspect.js';
|
|
2
|
+
import type { CatalogComponent } from './types.js';
|
|
3
|
+
import type { GenerationTier } from './generate.js';
|
|
4
|
+
export interface ClientGenerateOptions {
|
|
5
|
+
tier: GenerationTier;
|
|
6
|
+
component: string;
|
|
7
|
+
/** Component export name, e.g. `UserCreateForm`. */
|
|
8
|
+
exportName: string;
|
|
9
|
+
}
|
|
10
|
+
export interface ClientFieldSpec {
|
|
11
|
+
name: string;
|
|
12
|
+
label: string;
|
|
13
|
+
help: string;
|
|
14
|
+
required: boolean;
|
|
15
|
+
control: 'text' | 'password' | 'select' | 'textarea';
|
|
16
|
+
type: string;
|
|
17
|
+
readOnly: boolean;
|
|
18
|
+
secret: boolean;
|
|
19
|
+
json: boolean;
|
|
20
|
+
validation: {
|
|
21
|
+
regex: string | null;
|
|
22
|
+
minLength: number | null;
|
|
23
|
+
maxLength: number | null;
|
|
24
|
+
};
|
|
25
|
+
hints: {
|
|
26
|
+
placeholder?: string;
|
|
27
|
+
help?: string;
|
|
28
|
+
error?: {
|
|
29
|
+
required?: string;
|
|
30
|
+
format?: string;
|
|
31
|
+
tooShort?: string;
|
|
32
|
+
tooLong?: string;
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
sanitize: string[];
|
|
36
|
+
source: {
|
|
37
|
+
table: string;
|
|
38
|
+
column: string;
|
|
39
|
+
} | null;
|
|
40
|
+
}
|
|
41
|
+
export interface ClientComponentOutput {
|
|
42
|
+
/** The ES module source. Parses and runs with no dependencies. */
|
|
43
|
+
module: string;
|
|
44
|
+
/** The field specs, so a server can serialise them straight to the client. */
|
|
45
|
+
fields: ClientFieldSpec[];
|
|
46
|
+
cssClasses: Record<string, string>;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Derive the field specs the client renderer consumes. Keyed by table+column
|
|
50
|
+
* for the same reason as the server target: a bare column name collides across
|
|
51
|
+
* tables and silently drops validation.
|
|
52
|
+
*/
|
|
53
|
+
export declare function buildClientFields(schema: SchemaInfo, options: ClientGenerateOptions, component: CatalogComponent): ClientFieldSpec[];
|
|
54
|
+
export declare function generateClientComponent(schema: SchemaInfo, options: ClientGenerateOptions): ClientComponentOutput;
|
|
55
|
+
//# sourceMappingURL=generate-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate-client.d.ts","sourceRoot":"","sources":["../src/generate-client.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,UAAU,EAAc,MAAM,iBAAiB,CAAA;AAC7D,OAAO,KAAK,EAAe,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAI/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAEnD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,cAAc,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAA;IACpD,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAA;IACxF,KAAK,EAAE;QACL,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,KAAK,CAAC,EAAE;YAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KACpF,CAAA;IACD,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;CACjD;AAED,MAAM,WAAW,qBAAqB;IACpC,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAA;IACd,8EAA8E;IAC9E,MAAM,EAAE,eAAe,EAAE,CAAA;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnC;AA2BD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,qBAAqB,EAC9B,SAAS,EAAE,gBAAgB,GAC1B,eAAe,EAAE,CAgDnB;AAidD,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,qBAAqB,GAC7B,qBAAqB,CAcvB"}
|