@formspec/build 0.1.0-alpha.4 → 0.1.0-alpha.41
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/LICENSE +21 -0
- package/README.md +238 -93
- package/dist/analyzer/class-analyzer.d.ts +135 -0
- package/dist/analyzer/class-analyzer.d.ts.map +1 -0
- package/dist/analyzer/jsdoc-constraints.d.ts +53 -0
- package/dist/analyzer/jsdoc-constraints.d.ts.map +1 -0
- package/dist/analyzer/program.d.ts +94 -0
- package/dist/analyzer/program.d.ts.map +1 -0
- package/dist/analyzer/tsdoc-parser.d.ts +126 -0
- package/dist/analyzer/tsdoc-parser.d.ts.map +1 -0
- package/dist/browser.cjs +2113 -0
- package/dist/browser.cjs.map +1 -0
- package/dist/browser.d.ts +74 -0
- package/dist/browser.d.ts.map +1 -0
- package/dist/browser.js +2070 -0
- package/dist/browser.js.map +1 -0
- package/dist/build-alpha.d.ts +1501 -0
- package/dist/build-beta.d.ts +1501 -0
- package/dist/build-internal.d.ts +1501 -0
- package/dist/build.d.ts +1194 -43
- package/dist/canonicalize/chain-dsl-canonicalizer.d.ts +22 -0
- package/dist/canonicalize/chain-dsl-canonicalizer.d.ts.map +1 -0
- package/dist/canonicalize/index.d.ts +8 -0
- package/dist/canonicalize/index.d.ts.map +1 -0
- package/dist/canonicalize/tsdoc-canonicalizer.d.ts +38 -0
- package/dist/canonicalize/tsdoc-canonicalizer.d.ts.map +1 -0
- package/dist/cli.cjs +6715 -0
- package/dist/cli.cjs.map +1 -0
- package/dist/cli.js +6687 -103
- package/dist/cli.js.map +1 -1
- package/dist/extensions/index.d.ts +8 -0
- package/dist/extensions/index.d.ts.map +1 -0
- package/dist/extensions/registry.d.ts +83 -0
- package/dist/extensions/registry.d.ts.map +1 -0
- package/dist/generators/class-schema.d.ts +347 -0
- package/dist/generators/class-schema.d.ts.map +1 -0
- package/dist/generators/discovered-schema.d.ts +152 -0
- package/dist/generators/discovered-schema.d.ts.map +1 -0
- package/dist/generators/method-schema.d.ts +72 -0
- package/dist/generators/method-schema.d.ts.map +1 -0
- package/dist/generators/mixed-authoring.d.ts +52 -0
- package/dist/generators/mixed-authoring.d.ts.map +1 -0
- package/dist/index.cjs +6412 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +50 -8
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6387 -107
- package/dist/index.js.map +1 -1
- package/dist/internals.cjs +5573 -0
- package/dist/internals.cjs.map +1 -0
- package/dist/internals.d.ts +32 -0
- package/dist/internals.d.ts.map +1 -0
- package/dist/internals.js +5554 -0
- package/dist/internals.js.map +1 -0
- package/dist/json-schema/generator.d.ts +32 -6
- package/dist/json-schema/generator.d.ts.map +1 -1
- package/dist/json-schema/ir-generator.d.ts +149 -0
- package/dist/json-schema/ir-generator.d.ts.map +1 -0
- package/dist/json-schema/schema.d.ts +23 -0
- package/dist/json-schema/schema.d.ts.map +1 -0
- package/dist/json-schema/types.d.ts +76 -2
- package/dist/json-schema/types.d.ts.map +1 -1
- package/dist/metadata/collision-guards.d.ts +3 -0
- package/dist/metadata/collision-guards.d.ts.map +1 -0
- package/dist/metadata/index.d.ts +7 -0
- package/dist/metadata/index.d.ts.map +1 -0
- package/dist/metadata/policy.d.ts +12 -0
- package/dist/metadata/policy.d.ts.map +1 -0
- package/dist/metadata/resolve.d.ts +21 -0
- package/dist/metadata/resolve.d.ts.map +1 -0
- package/dist/static-build.d.ts +61 -0
- package/dist/static-build.d.ts.map +1 -0
- package/dist/ui-schema/generator.d.ts +18 -2
- package/dist/ui-schema/generator.d.ts.map +1 -1
- package/dist/ui-schema/ir-generator.d.ts +54 -0
- package/dist/ui-schema/ir-generator.d.ts.map +1 -0
- package/dist/ui-schema/schema.d.ts +429 -0
- package/dist/ui-schema/schema.d.ts.map +1 -0
- package/dist/ui-schema/types.d.ts +179 -35
- package/dist/ui-schema/types.d.ts.map +1 -1
- package/dist/validate/constraint-validator.d.ts +85 -0
- package/dist/validate/constraint-validator.d.ts.map +1 -0
- package/dist/validate/index.d.ts +9 -0
- package/dist/validate/index.d.ts.map +1 -0
- package/package.json +31 -11
- package/dist/__tests__/cli.test.d.ts +0 -2
- package/dist/__tests__/cli.test.d.ts.map +0 -1
- package/dist/__tests__/cli.test.js +0 -178
- package/dist/__tests__/cli.test.js.map +0 -1
- package/dist/__tests__/edge-cases.test.d.ts +0 -7
- package/dist/__tests__/edge-cases.test.d.ts.map +0 -1
- package/dist/__tests__/edge-cases.test.js +0 -217
- package/dist/__tests__/edge-cases.test.js.map +0 -1
- package/dist/__tests__/generator.test.d.ts +0 -2
- package/dist/__tests__/generator.test.d.ts.map +0 -1
- package/dist/__tests__/generator.test.js +0 -225
- package/dist/__tests__/generator.test.js.map +0 -1
- package/dist/__tests__/integration.test.d.ts +0 -8
- package/dist/__tests__/integration.test.d.ts.map +0 -1
- package/dist/__tests__/integration.test.js +0 -163
- package/dist/__tests__/integration.test.js.map +0 -1
- package/dist/__tests__/write-schemas.test.d.ts +0 -2
- package/dist/__tests__/write-schemas.test.d.ts.map +0 -1
- package/dist/__tests__/write-schemas.test.js +0 -196
- package/dist/__tests__/write-schemas.test.js.map +0 -1
- package/dist/json-schema/generator.js +0 -161
- package/dist/json-schema/generator.js.map +0 -1
- package/dist/json-schema/types.js +0 -7
- package/dist/json-schema/types.js.map +0 -1
- package/dist/ui-schema/generator.js +0 -150
- package/dist/ui-schema/generator.js.map +0 -1
- package/dist/ui-schema/types.js +0 -8
- package/dist/ui-schema/types.js.map +0 -1
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method schema generator.
|
|
3
|
+
*
|
|
4
|
+
* Generates schemas for method parameters and return types, routing through
|
|
5
|
+
* the canonical IR pipeline (TypeScript type → TypeNode → JSON Schema 2020-12).
|
|
6
|
+
*/
|
|
7
|
+
import type * as ts from "typescript";
|
|
8
|
+
import type { MethodInfo } from "../analyzer/class-analyzer.js";
|
|
9
|
+
import { type GenerateJsonSchemaFromIROptions, type JsonSchema2020 } from "../json-schema/ir-generator.js";
|
|
10
|
+
/**
|
|
11
|
+
* Runtime-loaded FormSpec schemas, compatible with the CLI's FormSpecSchemas type.
|
|
12
|
+
*/
|
|
13
|
+
export interface LoadedFormSpecSchemas {
|
|
14
|
+
/** The FormSpec export name */
|
|
15
|
+
name: string;
|
|
16
|
+
/** Generated JSON Schema */
|
|
17
|
+
jsonSchema: unknown;
|
|
18
|
+
/** Generated UI Schema (FormSpec/JSON Forms) */
|
|
19
|
+
uiSchema: unknown;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Generated schemas for a method.
|
|
23
|
+
*/
|
|
24
|
+
export interface MethodSchemas {
|
|
25
|
+
/** Method name */
|
|
26
|
+
name: string;
|
|
27
|
+
/** Parameter schemas (from FormSpec or static analysis) */
|
|
28
|
+
params: MethodParamsSchemas | null;
|
|
29
|
+
/** Return type schema */
|
|
30
|
+
returnType: JsonSchema2020;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Parameter schemas for a method.
|
|
34
|
+
*/
|
|
35
|
+
export interface MethodParamsSchemas {
|
|
36
|
+
/** JSON Schema for parameters */
|
|
37
|
+
jsonSchema: JsonSchema2020;
|
|
38
|
+
/** UI Schema / FormSpec for parameters (if available) */
|
|
39
|
+
uiSchema: object | null;
|
|
40
|
+
/** Name of the FormSpec export used (if any) */
|
|
41
|
+
formSpecExport: string | null;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Options for generating method schemas.
|
|
45
|
+
*/
|
|
46
|
+
export interface GenerateMethodSchemasOptions {
|
|
47
|
+
/** JSON Schema representation to use for static enums. */
|
|
48
|
+
readonly enumSerialization?: GenerateJsonSchemaFromIROptions["enumSerialization"] | undefined;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Generates schemas for a method's parameters and return type.
|
|
52
|
+
*
|
|
53
|
+
* If a parameter references a FormSpec via `InferSchema<typeof X>`,
|
|
54
|
+
* the schemas are taken from the loaded FormSpec at runtime.
|
|
55
|
+
* Otherwise, schemas are generated from static type analysis via the IR.
|
|
56
|
+
*
|
|
57
|
+
* @param method - The method information from static analysis
|
|
58
|
+
* @param checker - TypeScript type checker
|
|
59
|
+
* @param loadedFormSpecs - Map of FormSpec export names to their schemas
|
|
60
|
+
* @returns Generated method schemas
|
|
61
|
+
*/
|
|
62
|
+
export declare function generateMethodSchemas(method: MethodInfo, checker: ts.TypeChecker, loadedFormSpecs: Map<string, LoadedFormSpecSchemas>, options?: GenerateMethodSchemasOptions): MethodSchemas;
|
|
63
|
+
/**
|
|
64
|
+
* Collects all FormSpec export names referenced by methods.
|
|
65
|
+
*
|
|
66
|
+
* Use this to determine which exports to load at runtime.
|
|
67
|
+
*
|
|
68
|
+
* @param methods - Array of method infos
|
|
69
|
+
* @returns Set of FormSpec export names
|
|
70
|
+
*/
|
|
71
|
+
export declare function collectFormSpecReferences(methods: MethodInfo[]): Set<string>;
|
|
72
|
+
//# sourceMappingURL=method-schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"method-schema.d.ts","sourceRoot":"","sources":["../../src/generators/method-schema.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAiB,MAAM,+BAA+B,CAAC;AAG/E,OAAO,EAEL,KAAK,+BAA+B,EACpC,KAAK,cAAc,EACpB,MAAM,gCAAgC,CAAC;AAGxC;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,gDAAgD;IAChD,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACnC,yBAAyB;IACzB,UAAU,EAAE,cAAc,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iCAAiC;IACjC,UAAU,EAAE,cAAc,CAAC;IAC3B,yDAAyD;IACzD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,gDAAgD;IAChD,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,0DAA0D;IAC1D,QAAQ,CAAC,iBAAiB,CAAC,EAAE,+BAA+B,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;CAC/F;AAyED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,EACnD,OAAO,CAAC,EAAE,4BAA4B,GACrC,aAAa,CAYf;AAoED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,CAY5E"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Mixed-authoring schema generator.
|
|
3
|
+
*
|
|
4
|
+
* Composes a statically analyzed TSDoc/class/interface/type-alias model with
|
|
5
|
+
* ChainDSL-authored field overlays. The static model remains authoritative for
|
|
6
|
+
* structure and constraints; overlays may add runtime field behavior such as
|
|
7
|
+
* dynamic enum or dynamic schema metadata.
|
|
8
|
+
*/
|
|
9
|
+
import type { FormElement, FormSpec } from "@formspec/core";
|
|
10
|
+
import type { JsonSchema2020 } from "../json-schema/ir-generator.js";
|
|
11
|
+
import type { UISchema } from "../ui-schema/types.js";
|
|
12
|
+
import type { StaticSchemaGenerationOptions } from "./class-schema.js";
|
|
13
|
+
/**
|
|
14
|
+
* Result of generating schemas from a mixed-authoring composition.
|
|
15
|
+
*
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
export interface MixedAuthoringSchemas {
|
|
19
|
+
/** JSON Schema 2020-12 for validation. */
|
|
20
|
+
readonly jsonSchema: JsonSchema2020;
|
|
21
|
+
/** JSON Forms UI Schema for rendering. */
|
|
22
|
+
readonly uiSchema: UISchema;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Options for generating mixed-authoring schemas.
|
|
26
|
+
*
|
|
27
|
+
* The `typeName` can resolve to a class, interface, or object type alias, just
|
|
28
|
+
* like `generateSchemas()`.
|
|
29
|
+
*
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
export interface BuildMixedAuthoringSchemasOptions extends StaticSchemaGenerationOptions {
|
|
33
|
+
/** Path to the TypeScript source file. */
|
|
34
|
+
readonly filePath: string;
|
|
35
|
+
/** Name of the class, interface, or type alias to analyze. */
|
|
36
|
+
readonly typeName: string;
|
|
37
|
+
/** ChainDSL overlays to apply to the static model. Groups and conditionals are flattened by field name. */
|
|
38
|
+
readonly overlays: FormSpec<readonly FormElement[]>;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Builds JSON Schema and UI Schema from a TSDoc-derived model with ChainDSL
|
|
42
|
+
* field overlays.
|
|
43
|
+
*
|
|
44
|
+
* Overlays are matched by field name. The static model wins for structure,
|
|
45
|
+
* ordering, and constraints; ChainDSL overlays may contribute dynamic runtime
|
|
46
|
+
* field metadata such as dynamic enum or dynamic schema keywords, and may fill
|
|
47
|
+
* in missing annotations.
|
|
48
|
+
*
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
export declare function buildMixedAuthoringSchemas(options: BuildMixedAuthoringSchemasOptions): MixedAuthoringSchemas;
|
|
52
|
+
//# sourceMappingURL=mixed-authoring.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mixed-authoring.d.ts","sourceRoot":"","sources":["../../src/generators/mixed-authoring.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAGrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAItD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAGvE;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iCAAkC,SAAQ,6BAA6B;IACtF,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,8DAA8D;IAC9D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2GAA2G;IAC3G,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,SAAS,WAAW,EAAE,CAAC,CAAC;CACrD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,iCAAiC,GACzC,qBAAqB,CAoBvB"}
|