@twin.org/tools-core 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/classes/Enum.md

@@ -0,0 +1,93 @@
+# Class: Enum
+
+Utility methods for extracting enum values from TypeScript AST nodes.
+
+Handles three distinct patterns used to define enumerable sets of values:
+- Native enum declarations: `enum Color { Red = "red" }`
+- Const-object-with-matching-type patterns: `const Foo = { A: "a" } as const` paired with a type alias named identically to the const
+
+## Constructors
+
+### Constructor
+
+> **new Enum**(): `Enum`
+
+#### Returns
+
+`Enum`
+
+## Methods
+
+### extractEnumValuesFromConstAndType() {#extractenumvaluesfromconstandtype}
+
+> `static` **extractEnumValuesFromConstAndType**(`name`, `sourceFile`): `object`[] \| `undefined`
+
+Extract enum values from a const-and-type pair where a const object and a type alias share the
+same name.  The const object is located first because its members may carry JSDoc descriptions
+that would be lost if the type alias were processed in isolation.
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name to search for.
+
+##### sourceFile
+
+`SourceFile`
+
+The source file to search.
+
+#### Returns
+
+`object`[] \| `undefined`
+
+The extracted enum entries or undefined when the pattern is not present.
+
+***
+
+### extractEnumEntriesFromConstObject() {#extractenumentriesfromconstobject}
+
+> `static` **extractEnumEntriesFromConstObject**(`objLiteral`): `object`[]
+
+Extract enum entries from a const object literal.
+Only properties whose initializer is a string or numeric literal are included.
+
+#### Parameters
+
+##### objLiteral
+
+`ObjectLiteralExpression`
+
+The object literal expression.
+
+#### Returns
+
+`object`[]
+
+The extracted enum entries.
+
+***
+
+### extractEnumValuesFromEnumDeclaration() {#extractenumvaluesfromenumdeclaration}
+
+> `static` **extractEnumValuesFromEnumDeclaration**(`declaration`): `object`[]
+
+Extract enum values from a native TypeScript enum declaration.
+Numeric members without an explicit initializer are auto-incremented from the previous value.
+
+#### Parameters
+
+##### declaration
+
+`EnumDeclaration`
+
+The enum declaration.
+
+#### Returns
+
+`object`[]
+
+The extracted enum entries.

package/docs/reference/classes/FileUtils.md

@@ -0,0 +1,237 @@
+# Class: FileUtils
+
+Utility helpers for TypeScript file and directory paths.
+
+## Constructors
+
+### Constructor
+
+> **new FileUtils**(): `FileUtils`
+
+#### Returns
+
+`FileUtils`
+
+## Methods
+
+### fileExists() {#fileexists}
+
+> `static` **fileExists**(`filePath`): `boolean`
+
+Does the file exist.
+
+#### Parameters
+
+##### filePath
+
+`string`
+
+The file path.
+
+#### Returns
+
+`boolean`
+
+True if the file exists.
+
+***
+
+### readFile() {#readfile}
+
+> `static` **readFile**(`filePath`): `string`
+
+Read the file.
+
+#### Parameters
+
+##### filePath
+
+`string`
+
+The file path.
+
+#### Returns
+
+`string`
+
+The file contents.
+
+***
+
+### resolvePath() {#resolvepath}
+
+> `static` **resolvePath**(`filePath`): `string`
+
+Resolve a path.
+
+#### Parameters
+
+##### filePath
+
+`string`
+
+The file path.
+
+#### Returns
+
+`string`
+
+The resolved path.
+
+***
+
+### getCurrentWorkingDirectory() {#getcurrentworkingdirectory}
+
+> `static` **getCurrentWorkingDirectory**(): `string`
+
+Get the current working directory.
+
+#### Returns
+
+`string`
+
+The current working directory.
+
+***
+
+### normalizeFilePath() {#normalizefilepath}
+
+> `static` **normalizeFilePath**(`filePath`): `string`
+
+Normalize path separators for consistent comparisons.
+
+#### Parameters
+
+##### filePath
+
+`string`
+
+The file path.
+
+#### Returns
+
+`string`
+
+The normalized file path.
+
+***
+
+### getDirectoryPath() {#getdirectorypath}
+
+> `static` **getDirectoryPath**(`filePath`): `string`
+
+Get the directory portion of a file path.
+
+#### Parameters
+
+##### filePath
+
+`string`
+
+The file path.
+
+#### Returns
+
+`string`
+
+The directory path.
+
+***
+
+### resolveRelativePath() {#resolverelativepath}
+
+> `static` **resolveRelativePath**(`baseDirectory`, `relativePath`): `string`
+
+Resolve a relative path against a base directory.
+
+#### Parameters
+
+##### baseDirectory
+
+`string`
+
+The base directory.
+
+##### relativePath
+
+`string`
+
+The relative path.
+
+#### Returns
+
+`string`
+
+The resolved path.
+
+***
+
+### resolveImportSourceFilePath() {#resolveimportsourcefilepath}
+
+> `static` **resolveImportSourceFilePath**(`sourceFilePath`, `importPath`): `string` \| `undefined`
+
+Resolve a local import specifier to a TypeScript source file path.
+
+#### Parameters
+
+##### sourceFilePath
+
+`string`
+
+The importing source file path.
+
+##### importPath
+
+`string`
+
+The import specifier.
+
+#### Returns
+
+`string` \| `undefined`
+
+The resolved source file path.
+
+***
+
+### isGlobPattern() {#isglobpattern}
+
+> `static` **isGlobPattern**(`sourceFileOrGlob`): `boolean`
+
+Determine if the provided path includes glob pattern tokens.
+
+#### Parameters
+
+##### sourceFileOrGlob
+
+`string`
+
+The direct source file path or glob pattern.
+
+#### Returns
+
+`boolean`
+
+True if the value is a glob pattern.
+
+***
+
+### resolveSourceFiles() {#resolvesourcefiles}
+
+> `static` **resolveSourceFiles**(`sourceFileOrGlob`): `string`[]
+
+Resolve source files from a direct path or a glob pattern.
+
+#### Parameters
+
+##### sourceFileOrGlob
+
+`string`
+
+The direct source file path or glob pattern.
+
+#### Returns
+
+`string`[]
+
+The resolved source file paths.

package/docs/reference/classes/ImportTypeQuerySchemaResolver.md

@@ -0,0 +1,87 @@
+# Class: ImportTypeQuerySchemaResolver
+
+Static helpers for import type and type query schema resolution.
+
+## Constructors
+
+### Constructor
+
+> **new ImportTypeQuerySchemaResolver**(): `ImportTypeQuerySchemaResolver`
+
+#### Returns
+
+`ImportTypeQuerySchemaResolver`
+
+## Methods
+
+### mapImportTypeNodeToSchema() {#mapimporttypenodetoschema}
+
+> `static` **mapImportTypeNodeToSchema**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
+
+Map import type nodes (e.g. import("pkg").Type) to schema references.
+
+#### Parameters
+
+##### context
+
+[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
+
+##### typeNode
+
+`ImportTypeNode`
+
+#### Returns
+
+`IJsonSchema` \| `undefined`
+
+***
+
+### mapTypeQueryNodeToSchema() {#maptypequerynodetoschema}
+
+> `static` **mapTypeQueryNodeToSchema**(`context`, `typeNode`): `IJsonSchema`
+
+Map a type query node (typeof expr) to schema by resolving the referenced variable.
+
+#### Parameters
+
+##### context
+
+[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
+
+##### typeNode
+
+`TypeQueryNode`
+
+#### Returns
+
+`IJsonSchema`
+
+***
+
+### resolveImportTypeReferenceSchemaId() {#resolveimporttypereferenceschemaid}
+
+> `static` **resolveImportTypeReferenceSchemaId**(`context`, `moduleSpecifier`, `typeName`, `title`): `string` \| `undefined`
+
+Resolve import-type references to local or external schema ids.
+
+#### Parameters
+
+##### context
+
+[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
+
+##### moduleSpecifier
+
+`string`
+
+##### typeName
+
+`string`
+
+##### title
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`

package/docs/reference/classes/IndexSignaturePatternResolver.md

@@ -0,0 +1,69 @@
+# Class: IndexSignaturePatternResolver
+
+Resolves regex patterns for index signature key types.
+
+## Constructors
+
+### Constructor
+
+> **new IndexSignaturePatternResolver**(): `IndexSignaturePatternResolver`
+
+#### Returns
+
+`IndexSignaturePatternResolver`
+
+## Methods
+
+### isSupportedIndexSignature() {#issupportedindexsignature}
+
+> `static` **isSupportedIndexSignature**(`member`): `boolean`
+
+Determine whether an index signature can be represented as JSON object additionalProperties.
+
+#### Parameters
+
+##### member
+
+`IndexSignatureDeclaration`
+
+The index signature declaration.
+
+#### Returns
+
+`boolean`
+
+True if supported.
+
+***
+
+### extractIndexSignaturePattern() {#extractindexsignaturepattern}
+
+> `static` **extractIndexSignaturePattern**(`context`, `member`, `getTypeParameterBinding`): `string` \| `undefined`
+
+Extract a regex pattern for an index signature key type when representable.
+
+#### Parameters
+
+##### context
+
+[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
+
+The generation context.
+
+##### member
+
+`IndexSignatureDeclaration`
+
+The index signature declaration.
+
+##### getTypeParameterBinding
+
+(`context`, `typeName`) => `TypeNode` \| `null` \| `undefined`
+
+Callback for resolving generic bindings.
+
+#### Returns
+
+`string` \| `undefined`
+
+The property-name pattern, if derivable.

package/docs/reference/classes/IntersectionSchemaMerger.md

@@ -0,0 +1,48 @@
+# Class: IntersectionSchemaMerger
+
+Merges compatible object intersections into a single JSON schema object.
+
+## Constructors
+
+### Constructor
+
+> **new IntersectionSchemaMerger**(): `IntersectionSchemaMerger`
+
+#### Returns
+
+`IntersectionSchemaMerger`
+
+## Methods
+
+### mergeIntersectionObjectSchemas() {#mergeintersectionobjectschemas}
+
+> `static` **mergeIntersectionObjectSchemas**(`context`, `schemas`, `toInlineUtilityObjectSchema`): `IJsonSchema` \| `undefined`
+
+Merge simple object intersection parts into a single object schema.
+Supports local/known object refs by expanding them before merge.
+
+#### Parameters
+
+##### context
+
+[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
+
+The generation context.
+
+##### schemas
+
+`IJsonSchema`[]
+
+The mapped intersection schemas.
+
+##### toInlineUtilityObjectSchema
+
+(`schema`) => `IJsonSchema`
+
+Callback for converting referenced schemas to inline forms.
+
+#### Returns
+
+`IJsonSchema` \| `undefined`
+
+The merged schema, or undefined when merge is not safe.

package/docs/reference/classes/JsDoc.md

@@ -0,0 +1,141 @@
+# Class: JsDoc
+
+General-purpose utility methods for working with JsDoc.
+
+## Constructors
+
+### Constructor
+
+> **new JsDoc**(): `JsDoc`
+
+#### Returns
+
+`JsDoc`
+
+## Methods
+
+### getNodeJsDocDescription() {#getnodejsdocdescription}
+
+> `static` **getNodeJsDocDescription**(`node`): `string` \| `undefined`
+
+Extract the JSDoc description comment for an AST node.
+Only top-level JSDoc block comments are considered; inline tags are ignored.
+
+#### Parameters
+
+##### node
+
+`Node`
+
+The node to inspect.
+
+#### Returns
+
+`string` \| `undefined`
+
+The trimmed description text, or undefined when absent.
+
+***
+
+### getJSDocTagCommentText() {#getjsdoctagcommenttext}
+
+> `static` **getJSDocTagCommentText**(`jsDocTag`): `string` \| `undefined`
+
+Convert a JSDoc tag's comment portion to a plain text string.
+JSDoc tag comments may be plain strings or arrays of link/text parts.
+
+#### Parameters
+
+##### jsDocTag
+
+`JSDocTag`
+
+The JSDoc tag.
+
+#### Returns
+
+`string` \| `undefined`
+
+The comment text, or undefined when absent.
+
+***
+
+### getNodeTags() {#getnodetags}
+
+> `static` **getNodeTags**(`node`, `tagName`): `object`
+
+Read all custom JSDoc tags matching a tag name from a node and convert them to key/value pairs.
+Each matching tag's comment must be in the form "key: value"; entries that do not follow this
+convention are silently skipped.
+
+#### Parameters
+
+##### node
+
+`Node`
+
+The node to inspect.
+
+##### tagName
+
+`string`
+
+The tag name to filter by (e.g., 'json-schema').
+
+#### Returns
+
+`object`
+
+The extracted key/value pairs.
+
+***
+
+### getNodeTagComment() {#getnodetagcomment}
+
+> `static` **getNodeTagComment**(`node`, `tagName`): `string` \| `undefined`
+
+Read the plain comment text for the first matching JSDoc tag on a node.
+
+#### Parameters
+
+##### node
+
+`Node`
+
+The node to inspect.
+
+##### tagName
+
+`string`
+
+The tag name to filter by (e.g., 'default').
+
+#### Returns
+
+`string` \| `undefined`
+
+The trimmed comment text, or undefined when absent.
+
+***
+
+### parseTagValue() {#parsetagvalue}
+
+> `static` **parseTagValue**(`value`): `unknown`
+
+Parse a custom JSDoc tag value into JSON-compatible data.
+Values that begin with a JSON token character ({, [, ", true, false, null) or look like a
+number are parsed with JSON.parse.  All other values are returned as plain strings.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The raw value text.
+
+#### Returns
+
+`unknown`
+
+The parsed value.