@kubb/ast 5.0.0-beta.56 → 5.0.0-beta.58

package/README.md

@@ -28,10 +28,12 @@ Defines the node tree, visitor pattern, factory functions, and type guards used
 
 ## Imports
 
-| Path              | Contents                                                            |
-| ----------------- | ------------------------------------------------------------------- |
-| `@kubb/ast`       | Runtime: factory functions, guards, visitor, ref helpers, constants |
-| `@kubb/ast/types` | Types only: all node interfaces, type aliases, visitor types        |
+| Path                | Contents                                                                                 |
+| ------------------- | ---------------------------------------------------------------------------------------- |
+| `@kubb/ast`         | Runtime: node definitions, guards, visitor, transformers, constants                      |
+| `@kubb/ast/factory` | Node constructors (`createSchema`, `createFile`, and friends), the `ts.factory` analogue |
+| `@kubb/ast/types`   | Types only: all node interfaces, type aliases, visitor types                             |
+| `@kubb/ast/utils`   | Spec-agnostic string and identifier helpers, ref helpers                                 |
 
 ## Node tree
 
@@ -56,10 +58,12 @@ SchemaNode (discriminated union)
 
 ### Factory
 
+Constructors live on the `@kubb/ast/factory` subpath, mirroring `ts.factory.createX`. Through `@kubb/core` the same set is reachable as `ast.factory.createSchema(...)`.
+
 ```ts
-import { createRoot, createOperation, createSchema, createProperty } from '@kubb/ast'
+import { createInput, createSchema, createProperty } from '@kubb/ast/factory'
 
-const root = createRoot({
+const root = createInput({
   schemas: [
     createSchema({
       name: 'Pet',
@@ -111,11 +115,11 @@ const types = collect<string>(root, {
 ### Guards
 
 ```ts
-import { isSchemaNode, narrowSchema } from '@kubb/ast'
+import { narrowSchema, schemaDef } from '@kubb/ast'
 import type { Node } from '@kubb/ast/types'
 
 function process(node: Node) {
-  if (isSchemaNode(node)) {
+  if (schemaDef.is(node)) {
     const obj = narrowSchema(node, 'object')
     obj?.properties?.forEach((p) => console.log(p.name))
   }
@@ -125,7 +129,7 @@ function process(node: Node) {
 ### Refs
 
 ```ts
-import { extractRefName } from '@kubb/ast'
+import { extractRefName } from '@kubb/ast/utils'
 
 extractRefName('#/components/schemas/Pet') // 'Pet'
 ```