@alloy-js/core 0.23.0-dev.12 → 0.23.0-dev.15

package/temp/api-testing.json

@@ -0,0 +1,673 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.52.9",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@reactive",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@default",
+          "syntaxKind": "block"
+        }
+      ],
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@alloy-js/core!",
+  "docComment": "",
+  "name": "@alloy-js/core",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@alloy-js/core!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!createTestWrapper:function(1)",
+          "docComment": "/**\n * Create a reusable test harness for a language package. Returns a `Wrapper`\n * component (wraps content in `<Output>` + `<SourceFile>`) and a `defkey`\n * helper that creates stable namekeys for pre-declaring symbols.\n *\n * @remarks\n *\n *\n *\n * Downstream consumers import and call this from the language package's\n * `testing/` entrypoint. The `Wrapper` automatically declares symbols\n * created by `defkey` before rendering children, so tests can reference\n * symbols without explicit `<Declaration>` boilerplate.\n *\n * @example\n * ```ts\n * // In your language package's testing/ entrypoint:\n * import { FileComponent } from \"./components/index.js\"; // your language package's top-level file component\n * import { createTestWrapper, type TestWrapper } from \"@alloy-js/core/testing\";\n *\n * export function createMyLangTestWrapper(): TestWrapper {\n *   return createTestWrapper({\n *     filePath: \"test.ext\",\n *     useScope: useMyLangScope,\n *     makeSymbol: (nk, scope) => new MyOutputSymbol(nk, scope),\n *     SourceFile: FileComponent,\n *   });\n * }\n * ```\n *\n * @example\n * ```ts\n * // Extend your language test factory to accept and forward namePolicy:\n * export function createMyLangTestWrapper(namePolicy?: NamePolicy<string>): TestWrapper {\n *   return createTestWrapper({ ...langOpts, namePolicy });\n * }\n *\n * // In a name-policy test:\n * const { Wrapper } = createMyLangTestWrapper(myNamePolicy);\n * const fooKey = namekey(\"foo\"); // namekey(), not defkey — name policy applies\n * // namekey() schedules no pre-declaration; the test body must declare the symbol.\n * expect(\n *   <Wrapper>\n *     <MyDeclaration refkey={fooKey} name=\"foo\" />\n *   </Wrapper>\n * ).toRenderTo(\"FOO\");\n * ```\n *\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function createTestWrapper<SymbolT extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "OutputSymbol",
+              "canonicalReference": "@alloy-js/core!~OutputSymbol:class"
+            },
+            {
+              "kind": "Content",
+              "text": ", ScopeT extends "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    spaces: any;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ">(opts: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    filePath: string;\n    useScope: () => ScopeT | undefined;\n    makeSymbol: (nk: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Namekey",
+              "canonicalReference": "@alloy-js/core!~Namekey:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", scope: ScopeT) => SymbolT;\n    SourceFile: (props: {\n        path: string;\n        children: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Children",
+              "canonicalReference": "@alloy-js/core!~Children:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    }) => any;\n    namePolicy?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "NamePolicy",
+              "canonicalReference": "@alloy-js/core!~NamePolicy:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<string>;\n    nameConflictResolver?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "NameConflictResolver",
+              "canonicalReference": "@alloy-js/core!~NameConflictResolver:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "TestWrapper",
+              "canonicalReference": "@alloy-js/core!TestWrapper:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "testing/create-test-wrapper.tsx",
+          "returnTypeTokenRange": {
+            "startIndex": 15,
+            "endIndex": 16
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "opts",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 14
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "SymbolT",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            },
+            {
+              "typeParameterName": "ScopeT",
+              "constraintTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "createTestWrapper"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!d:function(1)",
+          "docComment": "/**\n * Dedented template literal tag. Strips leading/trailing blank lines and\n * removes the common leading whitespace from all lines — useful for\n * multi-line expected output in tests.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function d(strings: "
+            },
+            {
+              "kind": "Reference",
+              "text": "TemplateStringsArray",
+              "canonicalReference": "!TemplateStringsArray:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", ...values: "
+            },
+            {
+              "kind": "Content",
+              "text": "any[]"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "testing/render.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "strings",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "values",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "d"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!dedent:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function dedent(str: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "testing/render.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "str",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "dedent"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!printTree:function(1)",
+          "docComment": "/**\n * Convert a rendered text tree to a string. Will ensure that the scheduler is\n * empty before printing.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function printTree(tree: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RenderedTextTree",
+              "canonicalReference": "@alloy-js/core!~RenderedTextTree:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PrintTreeOptions",
+              "canonicalReference": "@alloy-js/core!~PrintTreeOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/render.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "tree",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "options",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "printTree"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!renderToString:function(1)",
+          "docComment": "/**\n * Render a JSX element tree to a string. Convenience wrapper combining\n * `renderTree` and `printTree`.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function renderToString(element: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Children",
+              "canonicalReference": "@alloy-js/core!~Children:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "testing/render.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "element",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "renderToString"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/core!TestWrapper:interface",
+          "docComment": "/**\n * Test harness returned by {@link createTestWrapper}.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface TestWrapper "
+            }
+          ],
+          "fileUrlPath": "testing/create-test-wrapper.tsx",
+          "releaseTag": "Public",
+          "name": "TestWrapper",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!TestWrapper#defkey:member",
+              "docComment": "/**\n * Creates a stable `Namekey` and schedules a pre-declaration inside\n * {@link TestWrapper.Wrapper}.\n *\n * @remarks\n *\n *\n * Call `defkey(name)` before rendering. `Wrapper` renders\n * `<Declaration symbol={...} />` for this name so `<Reference>` to the\n * returned namekey resolves without requiring an explicit `<Declaration>`\n * in the test body.\n *\n * @example\n * ```tsx\n * const { Wrapper, defkey } = createTestWrapper(...);\n * const fooKey = defkey(\"foo\");\n * expect(\n *   <Wrapper><MyComponent refkey={fooKey} /></Wrapper>\n * ).toRenderTo(`foo`);\n * ```\n *\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "defkey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(name: string) => "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Namekey",
+                  "canonicalReference": "@alloy-js/core!~Namekey:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "defkey",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!TestWrapper#Wrapper:member",
+              "docComment": "/**\n * JSX wrapper providing Output + a file-level component + language scope context.\n * Name policy is applied only when `namePolicy`/`nameConflictResolver` are\n * passed to {@link createTestWrapper}. Pre-declares all namekeys created by\n * {@link TestWrapper.defkey} before rendering children.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Wrapper: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(props: {\n        children: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!~Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    }) => "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Children",
+                  "canonicalReference": "@alloy-js/core!~Children:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "Wrapper",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/core!ToRenderToOptions:interface",
+          "docComment": "/**\n * Print options passed to `toRenderTo` / `toRenderToAsync`. These override\n * the per-`SourceFile` print settings for the duration of the assertion,\n * which is useful when forcing line-breaking with a narrow `printWidth` in\n * tests without needing extremely long inputs.\n *\n * @example\n * ```ts\n * expect(<MyList items={[\"a\", \"b\", \"c\"]} />).toRenderTo(\n *   `\n *   a,\n *   b,\n *   c\n *   `,\n *   { printWidth: 10 }\n * );\n * ```\n *\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface ToRenderToOptions "
+            }
+          ],
+          "fileUrlPath": "testing/extend-expect.ts",
+          "releaseTag": "Public",
+          "name": "ToRenderToOptions",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!ToRenderToOptions#printWidth:member",
+              "docComment": "/**\n * Maximum line width before the formatter wraps output.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "printWidth?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "printWidth",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!ToRenderToOptions#tabWidth:member",
+              "docComment": "/**\n * Number of spaces per indentation level.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "tabWidth?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "tabWidth",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!ToRenderToOptions#useTabs:member",
+              "docComment": "/**\n * Use tab characters instead of spaces.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "useTabs?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "useTabs",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        }
+      ]
+    }
+  ]
+}