@skmtc/core 0.0.797 → 0.0.799

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 (119) hide show
  1. package/esm/context/CoreContext.d.ts +10 -1
  2. package/esm/context/CoreContext.d.ts.map +1 -1
  3. package/esm/context/GenerateContext.d.ts +185 -0
  4. package/esm/context/GenerateContext.d.ts.map +1 -1
  5. package/esm/context/GenerateContext.js +30 -0
  6. package/esm/context/ParseContext.d.ts +6 -0
  7. package/esm/context/ParseContext.d.ts.map +1 -1
  8. package/esm/context/ParseContext.js +6 -0
  9. package/esm/oas/array/array-types.d.ts +23 -0
  10. package/esm/oas/array/array-types.d.ts.map +1 -1
  11. package/esm/oas/array/array-types.js +7 -0
  12. package/esm/oas/boolean/boolean-types.d.ts +25 -1
  13. package/esm/oas/boolean/boolean-types.d.ts.map +1 -1
  14. package/esm/oas/boolean/boolean-types.js +6 -0
  15. package/esm/oas/discriminator/discriminator-types.d.ts +17 -0
  16. package/esm/oas/discriminator/discriminator-types.d.ts.map +1 -1
  17. package/esm/oas/discriminator/discriminator-types.js +7 -0
  18. package/esm/oas/example/toExamplesV3.d.ts +39 -0
  19. package/esm/oas/example/toExamplesV3.d.ts.map +1 -1
  20. package/esm/oas/example/toExamplesV3.js +29 -0
  21. package/esm/oas/integer/integer-types.d.ts +18 -0
  22. package/esm/oas/integer/integer-types.d.ts.map +1 -1
  23. package/esm/oas/integer/integer-types.js +18 -0
  24. package/esm/oas/mediaType/mediaType-types.d.ts +17 -0
  25. package/esm/oas/mediaType/mediaType-types.d.ts.map +1 -1
  26. package/esm/oas/mediaType/mediaType-types.js +6 -0
  27. package/esm/oas/number/number-types.d.ts +12 -0
  28. package/esm/oas/number/number-types.d.ts.map +1 -1
  29. package/esm/oas/number/number-types.js +12 -0
  30. package/esm/oas/object/Object.d.ts +6 -0
  31. package/esm/oas/object/Object.d.ts.map +1 -1
  32. package/esm/oas/object/Object.js +6 -0
  33. package/esm/oas/operation/Operation.d.ts +34 -0
  34. package/esm/oas/operation/Operation.d.ts.map +1 -1
  35. package/esm/oas/operation/Operation.js +14 -0
  36. package/esm/oas/parameter/Parameter.d.ts +3 -0
  37. package/esm/oas/parameter/Parameter.d.ts.map +1 -1
  38. package/esm/oas/parameter/Parameter.js +3 -0
  39. package/esm/oas/ref/ref-types.d.ts +42 -0
  40. package/esm/oas/ref/ref-types.d.ts.map +1 -1
  41. package/esm/oas/ref/ref-types.js +9 -0
  42. package/esm/oas/securitySchemes/security-scheme-types.d.ts +63 -0
  43. package/esm/oas/securitySchemes/security-scheme-types.d.ts.map +1 -1
  44. package/esm/oas/securitySchemes/security-scheme-types.js +15 -0
  45. package/esm/oas/serverVariable/ServerVariable.d.ts +34 -0
  46. package/esm/oas/serverVariable/ServerVariable.d.ts.map +1 -1
  47. package/esm/oas/serverVariable/ServerVariable.js +24 -0
  48. package/esm/oas/string/string-types.d.ts +38 -1
  49. package/esm/oas/string/string-types.d.ts.map +1 -1
  50. package/esm/oas/string/string-types.js +12 -0
  51. package/esm/oas/union/union-types.d.ts +20 -0
  52. package/esm/oas/union/union-types.d.ts.map +1 -1
  53. package/esm/oas/union/union-types.js +7 -0
  54. package/esm/oas/unknown/unknown-types.d.ts +18 -0
  55. package/esm/oas/unknown/unknown-types.d.ts.map +1 -1
  56. package/esm/oas/unknown/unknown-types.js +6 -0
  57. package/esm/types/Results.d.ts +32 -0
  58. package/esm/types/Results.d.ts.map +1 -1
  59. package/esm/types/Results.js +12 -0
  60. package/package.json +1 -1
  61. package/script/context/CoreContext.d.ts +10 -1
  62. package/script/context/CoreContext.d.ts.map +1 -1
  63. package/script/context/GenerateContext.d.ts +185 -0
  64. package/script/context/GenerateContext.d.ts.map +1 -1
  65. package/script/context/GenerateContext.js +30 -0
  66. package/script/context/ParseContext.d.ts +6 -0
  67. package/script/context/ParseContext.d.ts.map +1 -1
  68. package/script/context/ParseContext.js +6 -0
  69. package/script/oas/array/array-types.d.ts +23 -0
  70. package/script/oas/array/array-types.d.ts.map +1 -1
  71. package/script/oas/array/array-types.js +7 -0
  72. package/script/oas/boolean/boolean-types.d.ts +25 -1
  73. package/script/oas/boolean/boolean-types.d.ts.map +1 -1
  74. package/script/oas/boolean/boolean-types.js +6 -0
  75. package/script/oas/discriminator/discriminator-types.d.ts +17 -0
  76. package/script/oas/discriminator/discriminator-types.d.ts.map +1 -1
  77. package/script/oas/discriminator/discriminator-types.js +7 -0
  78. package/script/oas/example/toExamplesV3.d.ts +39 -0
  79. package/script/oas/example/toExamplesV3.d.ts.map +1 -1
  80. package/script/oas/example/toExamplesV3.js +29 -0
  81. package/script/oas/integer/integer-types.d.ts +18 -0
  82. package/script/oas/integer/integer-types.d.ts.map +1 -1
  83. package/script/oas/integer/integer-types.js +18 -0
  84. package/script/oas/mediaType/mediaType-types.d.ts +17 -0
  85. package/script/oas/mediaType/mediaType-types.d.ts.map +1 -1
  86. package/script/oas/mediaType/mediaType-types.js +6 -0
  87. package/script/oas/number/number-types.d.ts +12 -0
  88. package/script/oas/number/number-types.d.ts.map +1 -1
  89. package/script/oas/number/number-types.js +12 -0
  90. package/script/oas/object/Object.d.ts +6 -0
  91. package/script/oas/object/Object.d.ts.map +1 -1
  92. package/script/oas/object/Object.js +6 -0
  93. package/script/oas/operation/Operation.d.ts +34 -0
  94. package/script/oas/operation/Operation.d.ts.map +1 -1
  95. package/script/oas/operation/Operation.js +14 -0
  96. package/script/oas/parameter/Parameter.d.ts +3 -0
  97. package/script/oas/parameter/Parameter.d.ts.map +1 -1
  98. package/script/oas/parameter/Parameter.js +3 -0
  99. package/script/oas/ref/ref-types.d.ts +42 -0
  100. package/script/oas/ref/ref-types.d.ts.map +1 -1
  101. package/script/oas/ref/ref-types.js +9 -0
  102. package/script/oas/securitySchemes/security-scheme-types.d.ts +63 -0
  103. package/script/oas/securitySchemes/security-scheme-types.d.ts.map +1 -1
  104. package/script/oas/securitySchemes/security-scheme-types.js +15 -0
  105. package/script/oas/serverVariable/ServerVariable.d.ts +34 -0
  106. package/script/oas/serverVariable/ServerVariable.d.ts.map +1 -1
  107. package/script/oas/serverVariable/ServerVariable.js +24 -0
  108. package/script/oas/string/string-types.d.ts +38 -1
  109. package/script/oas/string/string-types.d.ts.map +1 -1
  110. package/script/oas/string/string-types.js +12 -0
  111. package/script/oas/union/union-types.d.ts +20 -0
  112. package/script/oas/union/union-types.d.ts.map +1 -1
  113. package/script/oas/union/union-types.js +7 -0
  114. package/script/oas/unknown/unknown-types.d.ts +18 -0
  115. package/script/oas/unknown/unknown-types.d.ts.map +1 -1
  116. package/script/oas/unknown/unknown-types.js +6 -0
  117. package/script/types/Results.d.ts +32 -0
  118. package/script/types/Results.d.ts.map +1 -1
  119. package/script/types/Results.js +12 -0
@@ -1,27 +1,69 @@
1
1
  import * as v from 'valibot';
2
+ /**
3
+ * Data type for OpenAPI schema reference objects.
4
+ *
5
+ * Represents $ref references to schema objects in OpenAPI documents,
6
+ * allowing for component reuse and circular reference handling.
7
+ */
2
8
  export type OasSchemaRefData = {
9
+ /** Type identifier for OAS reference objects */
3
10
  oasType: 'ref';
11
+ /** The type of object being referenced */
4
12
  refType: 'schema';
13
+ /** The reference path (e.g., '#/components/schemas/User') */
5
14
  $ref: string;
15
+ /** Optional summary for the reference */
6
16
  summary?: string;
17
+ /** Optional description for the reference */
7
18
  description?: string;
8
19
  };
20
+ /**
21
+ * Valibot schema for validating schema reference data.
22
+ */
9
23
  export declare const oasSchemaRefData: v.GenericSchema<OasSchemaRefData>;
24
+ /**
25
+ * Data type for OpenAPI response reference objects.
26
+ *
27
+ * Represents $ref references to response objects in OpenAPI documents,
28
+ * enabling response definition reuse across multiple operations.
29
+ */
10
30
  export type OasResponseRefData = {
31
+ /** Type identifier for OAS reference objects */
11
32
  oasType: 'ref';
33
+ /** The type of object being referenced */
12
34
  refType: 'response';
35
+ /** The reference path (e.g., '#/components/responses/NotFound') */
13
36
  $ref: string;
37
+ /** Optional summary for the reference */
14
38
  summary?: string;
39
+ /** Optional description for the reference */
15
40
  description?: string;
16
41
  };
42
+ /**
43
+ * Valibot schema for validating response reference data.
44
+ */
17
45
  export declare const oasResponseRefData: v.GenericSchema<OasResponseRefData>;
46
+ /**
47
+ * Data type for OpenAPI parameter reference objects.
48
+ *
49
+ * Represents $ref references to parameter objects in OpenAPI documents,
50
+ * allowing parameter definitions to be reused across operations.
51
+ */
18
52
  export type OasParameterRefData = {
53
+ /** Type identifier for OAS reference objects */
19
54
  oasType: 'ref';
55
+ /** The type of object being referenced */
20
56
  refType: 'parameter';
57
+ /** The reference path (e.g., '#/components/parameters/PageSize') */
21
58
  $ref: string;
59
+ /** Optional summary for the reference */
22
60
  summary?: string;
61
+ /** Optional description for the reference */
23
62
  description?: string;
24
63
  };
64
+ /**
65
+ * Valibot schema for validating parameter reference data.
66
+ */
25
67
  export declare const oasParameterRefData: v.GenericSchema<OasParameterRefData>;
26
68
  export type OasExampleRefData = {
27
69
  oasType: 'ref';
@@ -1 +1 @@
1
- {"version":3,"file":"ref-types.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/ref-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,UAAU,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAMjE,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,WAAW,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAMnE,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,SAAS,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAM/D,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAMvE,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB,CAI7E,CAAA;AAUF,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAA;AAG5B,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CASjD,CAAA"}
1
+ {"version":3,"file":"ref-types.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/ref-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAA;IACjB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,UAAU,CAAA;IACnB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAMjE,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,WAAW,CAAA;IACpB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAMnE,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,SAAS,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAM/D,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAMvE,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB,CAI7E,CAAA;AAUF,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAA;AAG5B,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CASjD,CAAA"}
@@ -1,5 +1,8 @@
1
1
  import { markdown } from '../markdown/markdown-types.js';
2
2
  import * as v from 'valibot';
3
+ /**
4
+ * Valibot schema for validating schema reference data.
5
+ */
3
6
  export const oasSchemaRefData = v.object({
4
7
  oasType: v.literal('ref'),
5
8
  refType: v.literal('schema'),
@@ -7,6 +10,9 @@ export const oasSchemaRefData = v.object({
7
10
  summary: v.optional(v.string()),
8
11
  description: v.optional(markdown)
9
12
  });
13
+ /**
14
+ * Valibot schema for validating response reference data.
15
+ */
10
16
  export const oasResponseRefData = v.object({
11
17
  oasType: v.literal('ref'),
12
18
  refType: v.literal('response'),
@@ -14,6 +20,9 @@ export const oasResponseRefData = v.object({
14
20
  summary: v.optional(v.string()),
15
21
  description: v.optional(markdown)
16
22
  });
23
+ /**
24
+ * Valibot schema for validating parameter reference data.
25
+ */
17
26
  export const oasParameterRefData = v.object({
18
27
  oasType: v.literal('ref'),
19
28
  refType: v.literal('parameter'),
@@ -1,55 +1,118 @@
1
1
  import * as v from 'valibot';
2
+ /**
3
+ * Data type for HTTP authentication security schemes.
4
+ *
5
+ * Represents HTTP authentication mechanisms like Basic, Bearer,
6
+ * and other HTTP authentication schemes as defined in RFC 7235.
7
+ */
2
8
  export type OasHttpSecuritySchemeData = {
9
+ /** Security scheme type identifier */
3
10
  type: 'http';
11
+ /** Human-readable description of the security scheme */
4
12
  description?: string;
13
+ /** HTTP authorization scheme (e.g., 'basic', 'bearer') */
5
14
  scheme: string;
15
+ /** Format hint for bearer tokens (e.g., 'JWT') */
6
16
  bearerFormat?: string;
7
17
  };
18
+ /**
19
+ * Valibot schema for validating HTTP security scheme data.
20
+ */
8
21
  export declare const oasHttpSecuritySchemeData: v.ObjectSchema<{
9
22
  readonly type: v.LiteralSchema<"http", undefined>;
10
23
  readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
11
24
  readonly scheme: v.StringSchema<undefined>;
12
25
  readonly bearerFormat: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
13
26
  }, undefined>;
27
+ /**
28
+ * Data type for API key authentication security schemes.
29
+ *
30
+ * Represents API key authentication where the key is passed
31
+ * via header, query parameter, or cookie.
32
+ */
14
33
  export type OasApiKeySecuritySchemeData = {
34
+ /** Security scheme type identifier */
15
35
  type: 'apiKey';
36
+ /** Human-readable description of the security scheme */
16
37
  description?: string;
38
+ /** Name of the header, query parameter, or cookie */
17
39
  name: string;
40
+ /** Location where the API key should be sent */
18
41
  in: 'header' | 'query' | 'cookie';
19
42
  };
43
+ /**
44
+ * Valibot schema for validating API key security scheme data.
45
+ */
20
46
  export declare const oasApiKeySecuritySchemeData: v.ObjectSchema<{
21
47
  readonly type: v.LiteralSchema<"apiKey", undefined>;
22
48
  readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
23
49
  readonly name: v.StringSchema<undefined>;
24
50
  readonly in: v.UnionSchema<[v.LiteralSchema<"header", undefined>, v.LiteralSchema<"query", undefined>, v.LiteralSchema<"cookie", undefined>], undefined>;
25
51
  }, undefined>;
52
+ /**
53
+ * Data type for OAuth2 implicit flow configuration.
54
+ *
55
+ * Represents the implicit OAuth2 flow where tokens are obtained
56
+ * directly from the authorization endpoint without client authentication.
57
+ */
26
58
  export type OasImplicitOAuth2FlowData = {
59
+ /** URL for the OAuth2 authorization endpoint */
27
60
  authorizationUrl: string;
61
+ /** Optional URL for token refresh */
28
62
  refreshUrl: string | undefined;
63
+ /** Available scopes mapped to their descriptions */
29
64
  scopes: Record<string, string>;
30
65
  };
66
+ /**
67
+ * Valibot schema for validating OAuth2 implicit flow data.
68
+ */
31
69
  export declare const oasImplicitOAuth2FlowData: v.ObjectSchema<{
32
70
  readonly authorizationUrl: v.StringSchema<undefined>;
33
71
  readonly refreshUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
34
72
  readonly scopes: v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
35
73
  }, undefined>;
74
+ /**
75
+ * Data type for OAuth2 authorization code flow configuration.
76
+ *
77
+ * Represents the authorization code OAuth2 flow, the most secure
78
+ * flow suitable for server-side applications with client authentication.
79
+ */
36
80
  export type OasAuthorizationCodeOAuth2FlowData = {
81
+ /** URL for the OAuth2 authorization endpoint */
37
82
  authorizationUrl: string;
83
+ /** URL for the OAuth2 token endpoint */
38
84
  tokenUrl: string;
85
+ /** Optional URL for token refresh */
39
86
  refreshUrl: string | undefined;
87
+ /** Available scopes mapped to their descriptions */
40
88
  scopes: Record<string, string>;
41
89
  };
90
+ /**
91
+ * Valibot schema for validating OAuth2 authorization code flow data.
92
+ */
42
93
  export declare const oasAuthorizationCodeOAuth2FlowData: v.ObjectSchema<{
43
94
  readonly authorizationUrl: v.StringSchema<undefined>;
44
95
  readonly tokenUrl: v.StringSchema<undefined>;
45
96
  readonly refreshUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
46
97
  readonly scopes: v.RecordSchema<v.StringSchema<undefined>, v.StringSchema<undefined>, undefined>;
47
98
  }, undefined>;
99
+ /**
100
+ * Data type for OAuth2 client credentials flow configuration.
101
+ *
102
+ * Represents the client credentials OAuth2 flow used for
103
+ * server-to-server authentication without user involvement.
104
+ */
48
105
  export type OasClientCredentialsOAuth2FlowData = {
106
+ /** URL for the OAuth2 token endpoint */
49
107
  tokenUrl: string;
108
+ /** Optional URL for token refresh */
50
109
  refreshUrl: string | undefined;
110
+ /** Available scopes mapped to their descriptions */
51
111
  scopes: Record<string, string>;
52
112
  };
113
+ /**
114
+ * Valibot schema for validating OAuth2 client credentials flow data.
115
+ */
53
116
  export declare const oasClientCredentialsOAuth2FlowData: v.ObjectSchema<{
54
117
  readonly tokenUrl: v.StringSchema<undefined>;
55
118
  readonly refreshUrl: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
@@ -1 +1 @@
1
- {"version":3,"file":"security-scheme-types.d.ts","sourceRoot":"","sources":["../../../src/oas/securitySchemes/security-scheme-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;;aAKpC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;CAClC,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;aAKtC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,gBAAgB,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;aAK7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;aAI7C,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,QAAQ,CAAC,EAAE,yBAAyB,CAAA;IACpC,QAAQ,CAAC,EAAE,yBAAyB,CAAA;CACrC,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;aAK7B,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,kBAAkB,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;aAItC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,eAAe,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;aAItC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,2BAA2B,GAC3B,2BAA2B,CAAA;AAE/B,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAKhC,CAAA"}
1
+ {"version":3,"file":"security-scheme-types.d.ts","sourceRoot":"","sources":["../../../src/oas/securitySchemes/security-scheme-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;aAKpC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,sCAAsC;IACtC,IAAI,EAAE,QAAQ,CAAA;IACd,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;CAClC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;aAKtC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,CAAA;IACxB,qCAAqC;IACrC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,CAAA;IACxB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,qCAAqC;IACrC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;aAK7C,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,qCAAqC;IACrC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;aAI7C,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;aAIpC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,iBAAiB,CAAC,EAAE,kCAAkC,CAAA;IACtD,QAAQ,CAAC,EAAE,yBAAyB,CAAA;IACpC,QAAQ,CAAC,EAAE,yBAAyB,CAAA;CACrC,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;aAK7B,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,kBAAkB,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;aAItC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,eAAe,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;aAItC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,2BAA2B,GAC3B,2BAA2B,CAAA;AAE/B,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAKhC,CAAA"}
@@ -1,27 +1,42 @@
1
1
  import * as v from 'valibot';
2
+ /**
3
+ * Valibot schema for validating HTTP security scheme data.
4
+ */
2
5
  export const oasHttpSecuritySchemeData = v.object({
3
6
  type: v.literal('http'),
4
7
  description: v.optional(v.string()),
5
8
  scheme: v.string(),
6
9
  bearerFormat: v.optional(v.string())
7
10
  });
11
+ /**
12
+ * Valibot schema for validating API key security scheme data.
13
+ */
8
14
  export const oasApiKeySecuritySchemeData = v.object({
9
15
  type: v.literal('apiKey'),
10
16
  description: v.optional(v.string()),
11
17
  name: v.string(),
12
18
  in: v.union([v.literal('header'), v.literal('query'), v.literal('cookie')])
13
19
  });
20
+ /**
21
+ * Valibot schema for validating OAuth2 implicit flow data.
22
+ */
14
23
  export const oasImplicitOAuth2FlowData = v.object({
15
24
  authorizationUrl: v.string(),
16
25
  refreshUrl: v.optional(v.string()),
17
26
  scopes: v.record(v.string(), v.string())
18
27
  });
28
+ /**
29
+ * Valibot schema for validating OAuth2 authorization code flow data.
30
+ */
19
31
  export const oasAuthorizationCodeOAuth2FlowData = v.object({
20
32
  authorizationUrl: v.string(),
21
33
  tokenUrl: v.string(),
22
34
  refreshUrl: v.optional(v.string()),
23
35
  scopes: v.record(v.string(), v.string())
24
36
  });
37
+ /**
38
+ * Valibot schema for validating OAuth2 client credentials flow data.
39
+ */
25
40
  export const oasClientCredentialsOAuth2FlowData = v.object({
26
41
  tokenUrl: v.string(),
27
42
  refreshUrl: v.optional(v.string()),
@@ -1,16 +1,50 @@
1
1
  import type { ToJsonSchemaOptions } from '../schema/Schema.js';
2
2
  import type { OpenAPIV3 } from 'openapi-types';
3
+ /**
4
+ * Fields for configuring an OpenAPI server variable object.
5
+ *
6
+ * Represents the configuration data needed to create a server variable,
7
+ * including default values, enumeration constraints, and extensions.
8
+ */
3
9
  export type ServerVariableFields = {
10
+ /** Human-readable description of the server variable */
4
11
  description?: string | undefined;
12
+ /** Default value for the server variable */
5
13
  default: string;
14
+ /** Array of allowed values for the server variable */
6
15
  enums?: string[] | undefined;
16
+ /** OpenAPI specification extensions */
7
17
  extensionFields?: Record<string, unknown>;
8
18
  };
19
+ /**
20
+ * Represents an OpenAPI server variable object.
21
+ *
22
+ * Server variables provide parameterization for server URLs,
23
+ * allowing dynamic server configuration with default values
24
+ * and enumeration constraints.
25
+ *
26
+ * @example Basic server variable
27
+ * ```typescript
28
+ * const serverVar = new OasServerVariable({
29
+ * default: 'api',
30
+ * description: 'API version subdomain',
31
+ * enums: ['api', 'api-staging', 'api-dev']
32
+ * });
33
+ *
34
+ * console.log(serverVar.default); // 'api'
35
+ * console.log(serverVar.enums); // ['api', 'api-staging', 'api-dev']
36
+ * ```
37
+ */
9
38
  export declare class OasServerVariable {
39
+ /** Type identifier for OAS server variable objects */
10
40
  oasType: 'serverVariable';
41
+ /** Human-readable description of the server variable */
11
42
  description: string | undefined;
43
+ /** Default value for the server variable */
12
44
  default: string;
45
+ /** Array of allowed values for the server variable */
13
46
  enums?: string[] | undefined;
47
+ /** OpenAPI specification extensions */
14
48
  extensionFields: Record<string, unknown> | undefined;
15
49
  constructor(fields: ServerVariableFields);
16
50
  isRef(): boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"ServerVariable.d.ts","sourceRoot":"","sources":["../../../src/oas/serverVariable/ServerVariable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,iBAAiB;IAC5B,OAAO,EAAE,gBAAgB,CAAmB;IAC5C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,oBAAoB;IAOxC,KAAK,IAAI,OAAO;IAIhB,OAAO,IAAI,iBAAiB;IAI5B,WAAW,IAAI,iBAAiB;IAIhC,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAO5E"}
1
+ {"version":3,"file":"ServerVariable.d.ts","sourceRoot":"","sources":["../../../src/oas/serverVariable/ServerVariable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,iBAAiB;IAC5B,sDAAsD;IACtD,OAAO,EAAE,gBAAgB,CAAmB;IAC5C,wDAAwD;IACxD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC5B,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,oBAAoB;IAOxC,KAAK,IAAI,OAAO;IAIhB,OAAO,IAAI,iBAAiB;IAI5B,WAAW,IAAI,iBAAiB;IAIhC,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAO5E"}
@@ -1,29 +1,53 @@
1
+ /**
2
+ * Represents an OpenAPI server variable object.
3
+ *
4
+ * Server variables provide parameterization for server URLs,
5
+ * allowing dynamic server configuration with default values
6
+ * and enumeration constraints.
7
+ *
8
+ * @example Basic server variable
9
+ * ```typescript
10
+ * const serverVar = new OasServerVariable({
11
+ * default: 'api',
12
+ * description: 'API version subdomain',
13
+ * enums: ['api', 'api-staging', 'api-dev']
14
+ * });
15
+ *
16
+ * console.log(serverVar.default); // 'api'
17
+ * console.log(serverVar.enums); // ['api', 'api-staging', 'api-dev']
18
+ * ```
19
+ */
1
20
  export class OasServerVariable {
2
21
  constructor(fields) {
22
+ /** Type identifier for OAS server variable objects */
3
23
  Object.defineProperty(this, "oasType", {
4
24
  enumerable: true,
5
25
  configurable: true,
6
26
  writable: true,
7
27
  value: 'serverVariable'
8
28
  });
29
+ /** Human-readable description of the server variable */
9
30
  Object.defineProperty(this, "description", {
10
31
  enumerable: true,
11
32
  configurable: true,
12
33
  writable: true,
13
34
  value: void 0
14
35
  });
36
+ /** Default value for the server variable */
15
37
  Object.defineProperty(this, "default", {
16
38
  enumerable: true,
17
39
  configurable: true,
18
40
  writable: true,
19
41
  value: void 0
20
42
  });
43
+ /** Array of allowed values for the server variable */
21
44
  Object.defineProperty(this, "enums", {
22
45
  enumerable: true,
23
46
  configurable: true,
24
47
  writable: true,
25
48
  value: void 0
26
49
  });
50
+ /** OpenAPI specification extensions */
27
51
  Object.defineProperty(this, "extensionFields", {
28
52
  enumerable: true,
29
53
  configurable: true,
@@ -1,4 +1,18 @@
1
1
  import * as v from 'valibot';
2
+ /**
3
+ * Union type for OpenAPI string format specifiers.
4
+ *
5
+ * Represents the standard string formats defined in OpenAPI v3,
6
+ * providing semantic meaning for string validation and processing.
7
+ * Used for generating appropriate validation rules in target languages.
8
+ */
9
+ export type StringFormat = 'date-time' | 'time' | 'date' | 'duration' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'uuid' | 'uri' | 'regex' | 'password' | 'byte' | 'binary';
10
+ /**
11
+ * Valibot enum schema for valid OpenAPI string format values.
12
+ *
13
+ * Defines the standard string formats supported by OpenAPI v3,
14
+ * including date/time formats, network formats, and encoding formats.
15
+ */
2
16
  export declare const stringFormat: v.EnumSchema<{
3
17
  readonly 'date-time': "date-time";
4
18
  readonly time: "time";
@@ -15,6 +29,12 @@ export declare const stringFormat: v.EnumSchema<{
15
29
  readonly byte: "byte";
16
30
  readonly binary: "binary";
17
31
  }, undefined>;
32
+ /**
33
+ * Valibot schema for validating OpenAPI string data objects.
34
+ *
35
+ * Validates string schema objects including length constraints,
36
+ * pattern validation, format specifiers, and enumeration values.
37
+ */
18
38
  export declare const oasStringData: v.ObjectSchema<{
19
39
  readonly type: v.LiteralSchema<"string", undefined>;
20
40
  readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
@@ -28,18 +48,35 @@ export declare const oasStringData: v.ObjectSchema<{
28
48
  readonly nullable: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
29
49
  readonly example: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
30
50
  }, undefined>;
31
- export type StringFormat = 'date-time' | 'time' | 'date' | 'duration' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'uuid' | 'uri' | 'regex' | 'password' | 'byte' | 'binary';
51
+ /**
52
+ * Data type for OpenAPI string schema objects.
53
+ *
54
+ * Represents string schemas with validation constraints,
55
+ * format specifiers, and metadata. Used throughout the
56
+ * SKMTC pipeline for string type processing and code generation.
57
+ */
32
58
  export type OasStringData = {
59
+ /** Human-readable title for the string */
33
60
  title?: string;
61
+ /** Detailed description of the string's purpose */
34
62
  description?: string;
63
+ /** Default value for the string */
35
64
  default?: string;
65
+ /** Type identifier (always 'string') */
36
66
  type: 'string';
67
+ /** Maximum allowed length */
37
68
  maxLength?: number;
69
+ /** Minimum required length */
38
70
  minLength?: number;
71
+ /** Regular expression pattern for validation */
39
72
  pattern?: string;
73
+ /** Array of valid enumeration values */
40
74
  enum?: string[];
75
+ /** Format specifier (date-time, email, etc.) */
41
76
  format?: string;
77
+ /** Whether null values are allowed */
42
78
  nullable?: boolean;
79
+ /** Example value for documentation */
43
80
  example?: string;
44
81
  };
45
82
  //# sourceMappingURL=string-types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"string-types.d.ts","sourceRoot":"","sources":["../../../src/oas/string/string-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;aAevB,CAAA;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;aAYxB,CAAA;AAEF,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,MAAM,GACN,MAAM,GACN,UAAU,GACV,OAAO,GACP,UAAU,GACV,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,UAAU,GACV,MAAM,GACN,QAAQ,CAAA;AAEZ,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,QAAQ,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA"}
1
+ {"version":3,"file":"string-types.d.ts","sourceRoot":"","sources":["../../../src/oas/string/string-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,MAAM,GACN,MAAM,GACN,UAAU,GACV,OAAO,GACP,UAAU,GACV,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,UAAU,GACV,MAAM,GACN,QAAQ,CAAA;AAEZ;;;;;GAKG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;aAevB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;aAYxB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,IAAI,EAAE,QAAQ,CAAA;IACd,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sCAAsC;IACtC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA"}
@@ -1,4 +1,10 @@
1
1
  import * as v from 'valibot';
2
+ /**
3
+ * Valibot enum schema for valid OpenAPI string format values.
4
+ *
5
+ * Defines the standard string formats supported by OpenAPI v3,
6
+ * including date/time formats, network formats, and encoding formats.
7
+ */
2
8
  export const stringFormat = v.enum({
3
9
  'date-time': 'date-time',
4
10
  time: 'time',
@@ -15,6 +21,12 @@ export const stringFormat = v.enum({
15
21
  byte: 'byte',
16
22
  binary: 'binary'
17
23
  });
24
+ /**
25
+ * Valibot schema for validating OpenAPI string data objects.
26
+ *
27
+ * Validates string schema objects including length constraints,
28
+ * pattern validation, format specifiers, and enumeration values.
29
+ */
18
30
  export const oasStringData = v.object({
19
31
  type: v.literal('string'),
20
32
  title: v.optional(v.string()),
@@ -2,14 +2,34 @@ import * as v from 'valibot';
2
2
  import { type OasSchemaData } from '../schema/schema-types.js';
3
3
  import { type OasSchemaRefData } from '../ref/ref-types.js';
4
4
  import { type OasDiscriminatorData } from '../discriminator/discriminator-types.js';
5
+ /**
6
+ * Data type for OpenAPI union schema objects.
7
+ *
8
+ * Represents union types (oneOf/anyOf) that allow values to match
9
+ * one or more of several possible schemas. Includes support for
10
+ * discriminator properties for efficient type resolution.
11
+ */
5
12
  export type OasUnionData = {
13
+ /** Type category identifier for schema objects */
6
14
  oasType: 'schema';
15
+ /** Type identifier (always 'union') */
7
16
  type: 'union';
17
+ /** Human-readable title for the union */
8
18
  title?: string;
19
+ /** Detailed description of the union's purpose */
9
20
  description?: string;
21
+ /** Array of schemas that comprise the union */
10
22
  members: (OasSchemaData | OasSchemaRefData)[];
23
+ /** Optional discriminator for efficient type resolution */
11
24
  discriminator?: OasDiscriminatorData;
12
25
  };
26
+ /**
27
+ * Valibot schema for validating OpenAPI union data objects.
28
+ *
29
+ * Validates union schemas including member schema arrays and optional
30
+ * discriminator properties. Uses lazy evaluation to handle recursive
31
+ * schema references in union members.
32
+ */
13
33
  export declare const oasUnionData: v.ObjectSchema<{
14
34
  readonly oasType: v.LiteralSchema<"schema", undefined>;
15
35
  readonly type: v.LiteralSchema<"union", undefined>;
@@ -1 +1 @@
1
- {"version":3,"file":"union-types.d.ts","sourceRoot":"","sources":["../../../src/oas/union/union-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,qBAAqB,CAAA;AAC7E,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,yCAAyC,CAAA;AAEhD,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAA;IAC7C,aAAa,CAAC,EAAE,oBAAoB,CAAA;CACrC,CAAA;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;aAOvB,CAAA"}
1
+ {"version":3,"file":"union-types.d.ts","sourceRoot":"","sources":["../../../src/oas/union/union-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,qBAAqB,CAAA;AAC7E,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,yCAAyC,CAAA;AAEhD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,kDAAkD;IAClD,OAAO,EAAE,QAAQ,CAAA;IACjB,uCAAuC;IACvC,IAAI,EAAE,OAAO,CAAA;IACb,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+CAA+C;IAC/C,OAAO,EAAE,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAA;IAC7C,2DAA2D;IAC3D,aAAa,CAAC,EAAE,oBAAoB,CAAA;CACrC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;aAOvB,CAAA"}
@@ -2,6 +2,13 @@ import * as v from 'valibot';
2
2
  import { oasSchemaData } from '../schema/schema-types.js';
3
3
  import { oasSchemaRefData } from '../ref/ref-types.js';
4
4
  import { oasDiscriminatorData } from '../discriminator/discriminator-types.js';
5
+ /**
6
+ * Valibot schema for validating OpenAPI union data objects.
7
+ *
8
+ * Validates union schemas including member schema arrays and optional
9
+ * discriminator properties. Uses lazy evaluation to handle recursive
10
+ * schema references in union members.
11
+ */
5
12
  export const oasUnionData = v.object({
6
13
  oasType: v.literal('schema'),
7
14
  type: v.literal('union'),
@@ -1,4 +1,10 @@
1
1
  import * as v from 'valibot';
2
+ /**
3
+ * Valibot schema for validating OpenAPI unknown data objects.
4
+ *
5
+ * Validates unknown/unspecified schemas used as fallbacks when
6
+ * schema types cannot be determined or for flexible data handling.
7
+ */
2
8
  export declare const oasUnknownData: v.ObjectSchema<{
3
9
  readonly oasType: v.LiteralSchema<"schema", undefined>;
4
10
  readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
@@ -6,11 +12,23 @@ export declare const oasUnknownData: v.ObjectSchema<{
6
12
  readonly default: v.OptionalSchema<v.UnknownSchema, undefined>;
7
13
  readonly type: v.LiteralSchema<"unknown", undefined>;
8
14
  }, undefined>;
15
+ /**
16
+ * Data type for OpenAPI unknown schema objects.
17
+ *
18
+ * Represents schemas with unspecified or flexible types, used as
19
+ * fallbacks when schema types cannot be determined or when maximum
20
+ * flexibility is required in the API specification.
21
+ */
9
22
  export type OasUnknownData = {
23
+ /** Type category identifier for schema objects */
10
24
  oasType: 'schema';
25
+ /** Human-readable title for the unknown schema */
11
26
  title?: string;
27
+ /** Detailed description of the schema's purpose */
12
28
  description?: string;
29
+ /** Default value of any type */
13
30
  default?: unknown;
31
+ /** Type identifier (always 'unknown') */
14
32
  type: 'unknown';
15
33
  };
16
34
  //# sourceMappingURL=unknown-types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"unknown-types.d.ts","sourceRoot":"","sources":["../../../src/oas/unknown/unknown-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,eAAO,MAAM,cAAc;;;;;;aAMzB,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,QAAQ,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA"}
1
+ {"version":3,"file":"unknown-types.d.ts","sourceRoot":"","sources":["../../../src/oas/unknown/unknown-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;aAMzB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,kDAAkD;IAClD,OAAO,EAAE,QAAQ,CAAA;IACjB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yCAAyC;IACzC,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA"}
@@ -1,4 +1,10 @@
1
1
  import * as v from 'valibot';
2
+ /**
3
+ * Valibot schema for validating OpenAPI unknown data objects.
4
+ *
5
+ * Validates unknown/unspecified schemas used as fallbacks when
6
+ * schema types cannot be determined or for flexible data handling.
7
+ */
2
8
  export const oasUnknownData = v.object({
3
9
  oasType: v.literal('schema'),
4
10
  title: v.optional(v.string()),
@@ -1,10 +1,42 @@
1
1
  import "../_dnt.polyfills.js";
2
2
  import * as v from 'valibot';
3
+ /**
4
+ * Type representing the possible outcomes of SKMTC processing operations.
5
+ *
6
+ * Used throughout the SKMTC pipeline to track and categorize the results
7
+ * of parsing, generation, and rendering operations.
8
+ */
3
9
  export type ResultType = 'success' | 'warning' | 'error' | 'skipped' | 'notSupported';
10
+ /**
11
+ * Type representing result types that indicate issues or problems.
12
+ *
13
+ * Used for filtering and handling results that require attention,
14
+ * excluding successful, skipped, or unsupported operations.
15
+ */
4
16
  export type WarningError = 'warning' | 'error';
17
+ /**
18
+ * Valibot schema for validating ResultType values.
19
+ *
20
+ * Used for runtime validation of result type values throughout
21
+ * the SKMTC pipeline to ensure type safety and data integrity.
22
+ */
5
23
  export declare const resultType: v.GenericSchema<ResultType>;
24
+ /**
25
+ * Interface representing a hierarchical results structure.
26
+ *
27
+ * Allows for nested result tracking where each key can contain
28
+ * a result type, another results item (for nesting), or an array
29
+ * of results items for collections.
30
+ */
6
31
  export interface ResultsItem {
32
+ /** Dynamic key-value pairs for hierarchical result tracking */
7
33
  [key: string]: ResultType | ResultsItem | Array<ResultsItem | null>;
8
34
  }
35
+ /**
36
+ * Valibot schema for validating ResultsItem structures.
37
+ *
38
+ * Uses lazy evaluation to handle recursive result item validation,
39
+ * supporting nested hierarchical result structures.
40
+ */
9
41
  export declare const resultsItem: v.GenericSchema<ResultsItem>;
10
42
  //# sourceMappingURL=Results.d.ts.map