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

package/docs/reference/classes/JsonSchemaBuilder.md

@@ -1484,229 +1484,9 @@ The interface declaration.
 
 `void`
 
-***
-
-### mapPartialUtilityType() {#mappartialutilitytype}
-
-> `static` **mapPartialUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map Partial<T> to an object schema with no required properties.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The Partial type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapRequiredUtilityType() {#maprequiredutilitytype}
-
-> `static` **mapRequiredUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map Required<T> to an object schema with all properties required.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The Required type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapPickUtilityType() {#mappickutilitytype}
-
-> `static` **mapPickUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map Pick<T, K> to an object schema with selected keys preserved.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The Pick type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapOmitUtilityType() {#mapomitutilitytype}
-
-> `static` **mapOmitUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map Omit<T, K> to an object schema with selected keys removed.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The Omit type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapExcludeUtilityType() {#mapexcludeutilitytype}
-
-> `static` **mapExcludeUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map Exclude<T, U> to a schema that removes U members from T.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The Exclude type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapExtractUtilityType() {#mapextractutilitytype}
-
-> `static` **mapExtractUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map Extract<T, U> to a schema that keeps U members from T.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The Extract type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapNonNullableUtilityType() {#mapnonnullableutilitytype}
-
-> `static` **mapNonNullableUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map NonNullable<T> by removing null and undefined branches from T.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The NonNullable type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapRecordUtilityType() {#maprecordutilitytype}
-
-> `static` **mapRecordUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map Record<K, V> to an object schema with key constraints where possible.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The Record type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
+#### Throws
 
-The mapped schema.
+GeneralError when an extended type cannot be resolved to a schema.
 
 ***
 
@@ -1754,56 +1534,6 @@ The extracted literal keys.
 
 ***
 
-### mapJsonLdObjectUtilityType() {#mapjsonldobjectutilitytype}
-
-> `static` **mapJsonLdObjectUtilityType**(`context`, `typeNode`, `options`): `IJsonSchema` \| `undefined`
-
-Map JsonLdObject utility types using key-removal and optional key-addition rules.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The JsonLdObject utility type reference.
-
-##### options
-
-Mapping options.
-
-###### keysToRemove
-
-`string`[]
-
-Keys to remove from the base schema.
-
-###### keyToAdd?
-
-`"type"` \| `"id"` \| `"@id"` \| `"@type"` \| `"@context"`
-
-Optional key to add to the base schema.
-
-###### isAddedKeyRequired?
-
-`boolean`
-
-Whether the added key should be required.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
 ### mapJsonLdObjectDefaultSchemaByKey() {#mapjsonldobjectdefaultschemabykey}
 
 > `static` **mapJsonLdObjectDefaultSchemaByKey**(`baseSchema`, `keyToAdd`): `IJsonSchema`
@@ -1938,62 +1668,6 @@ The resolved schema.
 
 ***
 
-### mapObjectOrArrayUtilityType() {#mapobjectorarrayutilitytype}
-
-> `static` **mapObjectOrArrayUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map ObjectOrArray<T> to a schema accepting T or T[].
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The ObjectOrArray type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
-### mapSingleOccurrenceArrayUtilityType() {#mapsingleoccurrencearrayutilitytype}
-
-> `static` **mapSingleOccurrenceArrayUtilityType**(`context`, `typeNode`): `IJsonSchema` \| `undefined`
-
-Map SingleOccurrenceArray<T, U> to a non-empty array containing exactly one U.
-
-#### Parameters
-
-##### context
-
-[`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
-
-The generation context.
-
-##### typeNode
-
-`TypeReferenceNode`
-
-The SingleOccurrenceArray type reference.
-
-#### Returns
-
-`IJsonSchema` \| `undefined`
-
-The mapped schema.
-
-***
-
 ### annotateUtilityInlineSchema() {#annotateutilityinlineschema}
 
 > `static` **annotateUtilityInlineSchema**(`schema`, `baseTypeDescription`): `IJsonSchema`

package/docs/reference/classes/MappedTypeSchemaResolver.md

@@ -26,22 +26,32 @@ Resolve mapped type output keys, including remapped key names via `as`.
 
 [`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
 
+The generation context.
+
 ##### typeNode
 
 `MappedTypeNode`
 
+The mapped type node.
+
 ##### mappedKeys
 
 `string`[]
 
+The resolved source keys from the mapped type constraint.
+
 ##### mappedTypeParameterName
 
 `string`
 
+The mapped type parameter identifier.
+
 #### Returns
 
 `object`[] \| `undefined`
 
+The resolved source-to-output mapped key entries.
+
 ***
 
 ### resolveMappedTypeRemappedKey() {#resolvemappedtyperemappedkey}
@@ -56,22 +66,32 @@ Resolve a remapped mapped-type key expression for a concrete source key.
 
 [`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
 
+The generation context.
+
 ##### nameTypeNode
 
 `TypeNode`
 
+The mapped type name remapping expression node.
+
 ##### sourceKey
 
 `string`
 
+The concrete source key currently being evaluated.
+
 ##### mappedTypeParameterName
 
 `string`
 
+The mapped type parameter identifier.
+
 #### Returns
 
 `string` \| `null` \| `undefined`
 
+The remapped key, null when excluded via never, or undefined when unresolved.
+
 ***
 
 ### evaluateMappedKeyExtendsCondition() {#evaluatemappedkeyextendscondition}
@@ -86,18 +106,26 @@ Evaluate whether a concrete mapped key satisfies an `extends` condition.
 
 [`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
 
+The generation context.
+
 ##### sourceKey
 
 `string`
 
+The concrete source key being evaluated.
+
 ##### extendsTypeNode
 
 `TypeNode`
 
+The extends condition type node.
+
 #### Returns
 
 `boolean` \| `undefined`
 
+True when the key satisfies the condition, false when it does not, otherwise undefined.
+
 ***
 
 ### buildMappedTypeFallbackSchema() {#buildmappedtypefallbackschema}
@@ -112,26 +140,38 @@ Build a conservative fallback schema for mapped types whose key remapping cannot
 
 [`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
 
+The generation context.
+
 ##### typeNode
 
 `MappedTypeNode`
 
+The mapped type node.
+
 ##### mappedKeys
 
 `string`[]
 
+The resolved source keys from the mapped type constraint.
+
 ##### mappedTypeParameterName
 
 `string`
 
+The mapped type parameter identifier.
+
 ##### sourceObjectSchema?
 
 `IJsonSchema`
 
+The optional source object schema for property lookups.
+
 #### Returns
 
 `IJsonSchema`
 
+The fallback mapped type schema.
+
 ***
 
 ### buildMappedTypeFallbackAdditionalProperties() {#buildmappedtypefallbackadditionalproperties}
@@ -146,26 +186,38 @@ Build fallback additionalProperties for unresolved mapped key remapping.
 
 [`ITypeScriptToSchemaContext`](../interfaces/ITypeScriptToSchemaContext.md)
 
+The generation context.
+
 ##### typeNode
 
 `MappedTypeNode`
 
+The mapped type node.
+
 ##### mappedKeys
 
 `string`[]
 
+The resolved source keys from the mapped type constraint.
+
 ##### mappedTypeParameterName
 
 `string`
 
+The mapped type parameter identifier.
+
 ##### sourceObjectSchema?
 
 `IJsonSchema`
 
+The optional source object schema for property lookups.
+
 #### Returns
 
 `IJsonSchema` \| `undefined`
 
+The fallback additionalProperties schema.
+
 ***
 
 ### mergeMappedTypePropertySchemas() {#mergemappedtypepropertyschemas}
@@ -180,14 +232,20 @@ Merge mapped property schemas when multiple source keys remap to the same output
 
 `IJsonSchema`
 
+The existing schema already assigned to the mapped key.
+
 ##### nextSchema
 
 `IJsonSchema`
 
+The next schema to merge into the mapped key.
+
 #### Returns
 
 `IJsonSchema`
 
+The merged schema.
+
 ***
 
 ### resolveMappedTypeSourceRequiredPropertyKeys() {#resolvemappedtypesourcerequiredpropertykeys}
@@ -202,10 +260,16 @@ Resolve required remapped keys from the source object's required key set.
 
 `object`[]
 
+The source-to-output mapped key entries.
+
 ##### sourceObjectSchema
 
 `IJsonSchema`
 
+The source object schema containing required keys.
+
 #### Returns
 
 `string`[] \| `undefined`
+
+The required output keys.

package/docs/reference/classes/Resolver.md

@@ -16,7 +16,7 @@ Resolve TypeScript type declarations from package names.
 
 ### resolveTypeDeclarationAst() {#resolvetypedeclarationast}
 
-> `static` **resolveTypeDeclarationAst**(`packageName`, `typeName`): \{ `sourceFile`: `SourceFile`; `declaration`: `InterfaceDeclaration` \| `TypeAliasDeclaration`; \} \| `undefined`
+> `static` **resolveTypeDeclarationAst**(`packageName`, `typeName`, `containingFilePath?`): \{ `sourceFile`: `SourceFile`; `declaration`: `InterfaceDeclaration` \| `TypeAliasDeclaration`; \} \| `undefined`
 
 Resolve a type declaration AST from a package and type name.
 
@@ -34,6 +34,17 @@ The package to inspect.
 
 The type to resolve.
 
+##### containingFilePath?
+
+`string`
+
+An optional source file path to use as the starting point for
+package resolution. When provided, TypeScript module resolution walks up from that file's
+directory, which allows transitive dependencies installed alongside the source file (e.g.
+in a sub-directory node_modules) to be found even when they are not reachable from the
+current working directory. The path is normalised to absolute before use;
+falls back to process.cwd() when omitted.
+
 #### Returns
 
 \{ `sourceFile`: `SourceFile`; `declaration`: `InterfaceDeclaration` \| `TypeAliasDeclaration`; \} \| `undefined`