@sdk-it/core 0.46.11 → 0.47.0

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.
Files changed (46) hide show
  1. package/README.md +22 -12
  2. package/dist/index.d.ts +2 -2
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +2 -2
  5. package/dist/index.js.map +1 -1
  6. package/dist/lib/derived-type.d.ts +3 -0
  7. package/dist/lib/derived-type.d.ts.map +1 -0
  8. package/dist/lib/derived-type.js +7 -0
  9. package/dist/lib/derived-type.js.map +7 -0
  10. package/dist/lib/deriver.d.ts +13 -9
  11. package/dist/lib/deriver.d.ts.map +1 -1
  12. package/dist/lib/deriver.js +193 -243
  13. package/dist/lib/deriver.js.map +3 -3
  14. package/dist/lib/file-system.d.ts +0 -8
  15. package/dist/lib/file-system.d.ts.map +1 -1
  16. package/dist/lib/file-system.js +8 -39
  17. package/dist/lib/file-system.js.map +2 -2
  18. package/dist/lib/json-pointer.d.ts +13 -0
  19. package/dist/lib/json-pointer.d.ts.map +1 -0
  20. package/dist/lib/json-pointer.js +20 -0
  21. package/dist/lib/json-pointer.js.map +7 -0
  22. package/dist/lib/paths.d.ts +27 -8
  23. package/dist/lib/paths.d.ts.map +1 -1
  24. package/dist/lib/paths.js +165 -96
  25. package/dist/lib/paths.js.map +3 -3
  26. package/dist/lib/program.d.ts +19 -6
  27. package/dist/lib/program.d.ts.map +1 -1
  28. package/dist/lib/program.js +61 -62
  29. package/dist/lib/program.js.map +2 -2
  30. package/dist/lib/ref.d.ts +5 -5
  31. package/dist/lib/ref.d.ts.map +1 -1
  32. package/dist/lib/ref.js +28 -8
  33. package/dist/lib/ref.js.map +2 -2
  34. package/dist/lib/security.d.ts.map +1 -1
  35. package/dist/lib/utils.d.ts +9 -6
  36. package/dist/lib/utils.d.ts.map +1 -1
  37. package/dist/lib/utils.js +1 -1
  38. package/dist/lib/utils.js.map +2 -2
  39. package/dist/lib/zod-jsonschema.d.ts.map +1 -1
  40. package/dist/lib/zod-jsonschema.js +111 -93
  41. package/dist/lib/zod-jsonschema.js.map +2 -2
  42. package/package.json +17 -12
  43. package/dist/lib/spec-json.d.ts +0 -23
  44. package/dist/lib/spec-json.d.ts.map +0 -1
  45. package/dist/lib/spec-json.js +0 -11
  46. package/dist/lib/spec-json.js.map +0 -7
package/README.md CHANGED
@@ -11,28 +11,36 @@ the generation pipeline.
11
11
  ## Install
12
12
 
13
13
  ```bash
14
- npm install @sdk-it/core zod@^4.3.0 typescript openapi3-ts
14
+ npm install @sdk-it/core zod@^4.6.7 openapi3-ts
15
+ ```
16
+
17
+ The `@sdk-it/core/program.js` and `@sdk-it/core/deriver.js` subpaths use the
18
+ TypeScript 7.1 compiler. To use them, also install it under the
19
+ `@typescript/native` name:
20
+
21
+ ```bash
22
+ npm install @typescript/native@npm:typescript@7.1.0-beta
15
23
  ```
16
24
 
17
25
  Schema analysis requires Zod 4.3 or later within major version 4. Imported schemas
18
26
  must also use Zod 4, including nested schemas. Separate compatible Zod 4 package
19
27
  instances are supported; Zod 3 runtimes and schemas receive a migration error.
20
28
 
21
- ## Create a TypeScript program
29
+ ## Open a TypeScript project
22
30
 
23
31
  ```typescript
24
- import { getProgram } from '@sdk-it/core';
32
+ import { openAnalysisProject, sourceFiles } from '@sdk-it/core/program.js';
25
33
 
26
- const program = getProgram('./tsconfig.json');
27
- const checker = program.getTypeChecker();
34
+ using project = openAnalysisProject('./tsconfig.json');
28
35
 
29
- for (const sourceFile of program.getSourceFiles()) {
30
- if (!sourceFile.isDeclarationFile) {
31
- console.log(sourceFile.fileName);
32
- }
36
+ for (const sourceFile of sourceFiles(project.program)) {
37
+ console.log(sourceFile.fileName);
33
38
  }
34
39
  ```
35
40
 
41
+ `project.checker` is the type checker of the program. The project owns a native
42
+ TypeScript process. `using` disposes the project when the scope ends.
43
+
36
44
  ## Resolve an OpenAPI reference
37
45
 
38
46
  ```typescript
@@ -41,7 +49,9 @@ import { resolveRef } from '@sdk-it/core';
41
49
  const schema = resolveRef(openapi, openapi.components!.schemas!.User!);
42
50
  ```
43
51
 
44
- The root export includes TypeScript program helpers, type derivation, route
45
- analysis, OpenAPI reference helpers, and Zod schema evaluation. Lower-level
46
- modules are also available through subpaths such as
52
+ The root export includes route analysis, OpenAPI reference helpers, and Zod
53
+ schema evaluation, and it never loads the TypeScript compiler. The helpers that
54
+ need the compiler live in subpaths: `@sdk-it/core/program.js` (analysis projects
55
+ and programs) and `@sdk-it/core/deriver.js` (type derivation). Other
56
+ lower-level modules are available the same way, such as
47
57
  `@sdk-it/core/file-system.js` and `@sdk-it/core/paths.js`.
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
- export * from './lib/deriver.js';
1
+ export * from './lib/derived-type.js';
2
+ export * from './lib/json-pointer.js';
2
3
  export * from './lib/paths.js';
3
- export * from './lib/program.js';
4
4
  export * from './lib/ref.js';
5
5
  export * from './lib/security.js';
6
6
  export * from './lib/utils.js';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
- export * from "./lib/deriver.js";
1
+ export * from "./lib/derived-type.js";
2
+ export * from "./lib/json-pointer.js";
2
3
  export * from "./lib/paths.js";
3
- export * from "./lib/program.js";
4
4
  export * from "./lib/ref.js";
5
5
  export * from "./lib/security.js";
6
6
  export * from "./lib/utils.js";
package/dist/index.js.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../src/index.ts"],
4
- "sourcesContent": ["export * from './lib/deriver.js';\nexport * from './lib/paths.js';\nexport * from './lib/program.js';\nexport * from './lib/ref.js';\nexport * from './lib/security.js';\nexport * from './lib/utils.js';\nexport * from './lib/zod-jsonschema.js';\n"],
4
+ "sourcesContent": ["export * from './lib/derived-type.js';\nexport * from './lib/json-pointer.js';\nexport * from './lib/paths.js';\nexport * from './lib/ref.js';\nexport * from './lib/security.js';\nexport * from './lib/utils.js';\nexport * from './lib/zod-jsonschema.js';\n"],
5
5
  "mappings": "AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
6
6
  "names": []
7
7
  }
@@ -0,0 +1,3 @@
1
+ export declare const deriveSymbol: unique symbol;
2
+ export declare const $types: unique symbol;
3
+ //# sourceMappingURL=derived-type.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"derived-type.d.ts","sources":["../../src/lib/derived-type.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,YAAY,eAA0B,CAAC;AACpD,eAAO,MAAM,MAAM,eAAsB,CAAC"}
@@ -0,0 +1,7 @@
1
+ const deriveSymbol = /* @__PURE__ */ Symbol.for("serialize");
2
+ const $types = /* @__PURE__ */ Symbol.for("types");
3
+ export {
4
+ $types,
5
+ deriveSymbol
6
+ };
7
+ //# sourceMappingURL=derived-type.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../src/lib/derived-type.ts"],
4
+ "sourcesContent": ["// Kept apart from deriver.ts so reading derived types never loads the TypeScript compiler.\nexport const deriveSymbol = Symbol.for('serialize');\nexport const $types = Symbol.for('types');\n"],
5
+ "mappings": "AACO,MAAM,eAAe,uBAAO,IAAI,WAAW;AAC3C,MAAM,SAAS,uBAAO,IAAI,OAAO;",
6
+ "names": []
7
+ }
@@ -1,23 +1,27 @@
1
- import ts from 'typescript';
1
+ import { type Node } from '@typescript/native/ast';
2
+ import { type Checker, type Type } from '@typescript/native/sync';
2
3
  type Collector = Record<string, any>;
3
- export declare const deriveSymbol: unique symbol;
4
- export declare const $types: unique symbol;
5
4
  export declare const defaultTypesMap: Record<string, string>;
6
- export declare function nodeLocation(node: ts.Node): string | undefined;
5
+ export declare function nodeLocation(node: Node): string | undefined;
7
6
  export declare class TypeDeriver {
8
7
  readonly collector: Collector;
9
- readonly checker: ts.TypeChecker;
8
+ readonly checker: Checker;
10
9
  readonly typesMap: Record<string, string>;
11
10
  private trace;
12
- private currentNode?;
13
11
  private readonly activeAliases;
14
- constructor(checker: ts.TypeChecker, typeMappings?: Record<string, string>);
12
+ constructor(checker: Checker, typeMappings?: Record<string, string>);
15
13
  setTrace(ctx: {
16
14
  file?: string;
17
15
  operation?: string;
18
16
  }): void;
17
+ /**
18
+ * A function or class value: JSON.stringify drops it as a member and writes
19
+ * nothing for it alone. An optional one (`fn?: () => void`) is a union with
20
+ * undefined and is dropped the same way.
21
+ */
22
+ private hasNoJsonForm;
19
23
  private warn;
20
- serializeType(type: ts.Type): any;
24
+ serializeType(type: Type): any;
21
25
  private serialize;
22
26
  private serializeResolved;
23
27
  private serializeValue;
@@ -29,7 +33,7 @@ export declare class TypeDeriver {
29
33
  private isConstAsserted;
30
34
  private emptyArraySatisfies;
31
35
  private typeOfShorthand;
32
- serializeNode(node: ts.Node): any;
36
+ serializeNode(node: Node): any;
33
37
  }
34
38
  export {};
35
39
  //# sourceMappingURL=deriver.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"deriver.d.ts","sourceRoot":"","sources":["../../src/lib/deriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,MAAM,YAAY,CAAC;AAIvD,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAYrC,eAAO,MAAM,YAAY,eAA0B,CAAC;AACpD,eAAO,MAAM,MAAM,eAAsB,CAAC;AAC1C,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAQlD,CAAC;AAOF,wBAAgB,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS,CAW9D;AAUD,qBAAa,WAAW;IACtB,SAAgB,SAAS,EAAE,SAAS,CAAM;IAC1C,SAAgB,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC;IACxC,SAAgB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjD,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,WAAW,CAAC,CAAU;IAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA+B;gBAE3D,OAAO,EAAE,EAAE,CAAC,WAAW,EACvB,YAAY,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAmB;IAMxD,QAAQ,CAAC,GAAG,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE;IAInD,OAAO,CAAC,IAAI;IAeZ,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG;IAIjC,OAAO,CAAC,SAAS;IA0BjB,OAAO,CAAC,iBAAiB;IA+RzB,OAAO,CAAC,cAAc;IAStB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IA8CxB,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,eAAe;IAiBvB,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG;CAsRlC"}
1
+ {"version":3,"file":"deriver.d.ts","sources":["../../src/lib/deriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,IAAI,EAMV,MAAM,wBAAwB,CAAC;AA+BhC,OAAO,EACL,KAAK,OAAO,EAKZ,KAAK,IAAI,EAGV,MAAM,yBAAyB,CAAC;AAKjC,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAYrC,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAQlD,CAAC;AAWF,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CAW3D;AAmBD,qBAAa,WAAW;IACtB,SAAgB,SAAS,EAAE,SAAS,CAAM;IAC1C,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,SAAgB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjD,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA4B;IAC1D,YACE,OAAO,EAAE,OAAO,EAChB,YAAY,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAmB,EAIvD;IAED,QAAQ,CAAC,GAAG,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,QAElD;IAED;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,IAAI;IAcZ,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAE7B;IAED,OAAO,CAAC,SAAS;IA0BjB,OAAO,CAAC,iBAAiB;IAuSzB,OAAO,CAAC,cAAc;IAOtB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IA6CxB,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,mBAAmB;IAe3B,OAAO,CAAC,eAAe;IAiBvB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CA+K7B;CACF"}