@alloy-js/core 0.21.0-dev.3 → 0.21.0-dev.8

package/temp/api.json

@@ -1499,8 +1499,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "Refkey",
-                  "canonicalReference": "@alloy-js/core!Refkey:type"
+                  "text": "Refkeyable",
+                  "canonicalReference": "@alloy-js/core!Refkeyable:type"
                 },
                 {
                   "kind": "Content",
@@ -2238,6 +2238,15 @@
               "text": "RenderableObject",
               "canonicalReference": "@alloy-js/core!RenderableObject:interface"
             },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "RefkeyableObject",
+              "canonicalReference": "@alloy-js/core!RefkeyableObject:type"
+            },
             {
               "kind": "Content",
               "text": " | string | boolean | number | undefined | null | void | (() => "
@@ -2293,7 +2302,7 @@
           "name": "Child",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 12
+            "endIndex": 14
           }
         },
         {
@@ -9104,6 +9113,61 @@
           ],
           "name": "isKeyedChild"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!isLibrarySymbolReference:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function isLibrarySymbolReference(value: "
+            },
+            {
+              "kind": "Content",
+              "text": "unknown"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "value",
+              "canonicalReference": "@alloy-js/core!~value"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "LibrarySymbolReference",
+              "canonicalReference": "@alloy-js/core!LibrarySymbolReference:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/library-symbol-reference.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "value",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "isLibrarySymbolReference"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/core!isMemberRefkey:function(1)",
@@ -9324,6 +9388,61 @@
           ],
           "name": "isRefkey"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!isRefkeyable:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function isRefkeyable(value: "
+            },
+            {
+              "kind": "Content",
+              "text": "unknown"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "value",
+              "canonicalReference": "@alloy-js/core!~value"
+            },
+            {
+              "kind": "Content",
+              "text": " is "
+            },
+            {
+              "kind": "Reference",
+              "text": "RefkeyableObject",
+              "canonicalReference": "@alloy-js/core!RefkeyableObject:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/refkey.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "value",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "isRefkeyable"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/core!isRenderableObject:function(1)",
@@ -9660,6 +9779,76 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@alloy-js/core!LibrarySymbolReference:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface LibrarySymbolReference extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "RefkeyableObject",
+              "canonicalReference": "@alloy-js/core!RefkeyableObject:type"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/library-symbol-reference.ts",
+          "releaseTag": "Public",
+          "name": "LibrarySymbolReference",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@alloy-js/core!LibrarySymbolReference#[TO_SYMBOL]:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TO_SYMBOL",
+                  "canonicalReference": "@alloy-js/core!TO_SYMBOL:var"
+                },
+                {
+                  "kind": "Content",
+                  "text": "](): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "OutputSymbol",
+                  "canonicalReference": "@alloy-js/core!OutputSymbol:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "[TO_SYMBOL]"
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@alloy-js/core!LineIntrinsicElement:type",
@@ -11019,8 +11208,8 @@
             },
             {
               "kind": "Reference",
-              "text": "Refkey",
-              "canonicalReference": "@alloy-js/core!Refkey:type"
+              "text": "Refkeyable",
+              "canonicalReference": "@alloy-js/core!Refkeyable:type"
             },
             {
               "kind": "Content",
@@ -11032,21 +11221,21 @@
             },
             {
               "kind": "Reference",
-              "text": "Refkey",
-              "canonicalReference": "@alloy-js/core!Refkey:type"
+              "text": "Refkeyable",
+              "canonicalReference": "@alloy-js/core!Refkeyable:type"
             },
             {
               "kind": "Content",
-              "text": ", ..."
+              "text": " | string, ...("
             },
             {
               "kind": "Reference",
-              "text": "Refkey",
-              "canonicalReference": "@alloy-js/core!Refkey:type"
+              "text": "Refkeyable",
+              "canonicalReference": "@alloy-js/core!Refkeyable:type"
             },
             {
               "kind": "Content",
-              "text": "[]]"
+              "text": " | string)[]]"
             },
             {
               "kind": "Content",
@@ -11100,8 +11289,8 @@
             },
             {
               "kind": "Reference",
-              "text": "RefkeyBase",
-              "canonicalReference": "@alloy-js/core!RefkeyBase:type"
+              "text": "RefkeyableObject",
+              "canonicalReference": "@alloy-js/core!RefkeyableObject:type"
             },
             {
               "kind": "Content",
@@ -11155,6 +11344,10 @@
                   "text": "Refkey",
                   "canonicalReference": "@alloy-js/core!Refkey:type"
                 },
+                {
+                  "kind": "Content",
+                  "text": " | string"
+                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -11166,7 +11359,7 @@
               "name": "member",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
               }
             }
           ],
@@ -15719,6 +15912,59 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@alloy-js/core!OutputSymbol#resolveMemberByName:member(1)",
+              "docComment": "/**\n * Get a member symbol by name from this symbol's member spaces. Checks member\n * spaces in order until it finds a member with that name.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resolveMemberByName(name: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "OutputSymbol",
+                  "canonicalReference": "@alloy-js/core!OutputSymbol:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "name",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "resolveMemberByName"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@alloy-js/core!OutputSymbol#scope:member",
@@ -16032,6 +16278,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@alloy-js/core!OutputSymbolOptions#lazyMemberInitializer:member",
+              "docComment": "/**\n * Provide a function which lazy-initializes members when an enumeration of members are needed.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "lazyMemberInitializer?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "lazyMemberInitializer",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@alloy-js/core!OutputSymbolOptions#metadata:member",
@@ -17749,43 +18022,34 @@
             },
             {
               "kind": "Content",
-              "text": " | (() => "
+              "text": " | import(\"../refkey.js\")."
             },
             {
               "kind": "Reference",
-              "text": "Children",
-              "canonicalReference": "@alloy-js/core!Children:type"
+              "text": "RefkeyableObject",
+              "canonicalReference": "@alloy-js/core!RefkeyableObject:type"
             },
             {
               "kind": "Content",
-              "text": ") | import(\"@vue/reactivity\")."
-            },
-            {
-              "kind": "Reference",
-              "text": "Ref",
-              "canonicalReference": "@vue/reactivity!Ref:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "<any, any> | import(\"../refkey.js\")."
+              "text": " | (() => "
             },
             {
               "kind": "Reference",
-              "text": "SymbolRefkey",
-              "canonicalReference": "@alloy-js/core!SymbolRefkey:interface"
+              "text": "Children",
+              "canonicalReference": "@alloy-js/core!Children:type"
             },
             {
               "kind": "Content",
-              "text": " | import(\"../refkey.js\")."
+              "text": ") | import(\"@vue/reactivity\")."
             },
             {
               "kind": "Reference",
-              "text": "MemberRefkey",
-              "canonicalReference": "@alloy-js/core!MemberRefkey:interface"
+              "text": "Ref",
+              "canonicalReference": "@vue/reactivity!Ref:interface"
             },
             {
               "kind": "Content",
-              "text": " | import(\"../reactivity.js\")."
+              "text": "<any, any> | import(\"../reactivity.js\")."
             },
             {
               "kind": "Reference",
@@ -17993,7 +18257,7 @@
           "fileUrlPath": "src/components/ReferenceOrContent.tsx",
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 60
+            "endIndex": 58
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -18176,12 +18440,71 @@
         },
         {
           "kind": "TypeAlias",
-          "canonicalReference": "@alloy-js/core!RefkeyBase:type",
+          "canonicalReference": "@alloy-js/core!Refkeyable:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type Refkeyable = "
+            },
+            {
+              "kind": "Reference",
+              "text": "RefkeyableObject",
+              "canonicalReference": "@alloy-js/core!RefkeyableObject:type"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "Refkey",
+              "canonicalReference": "@alloy-js/core!Refkey:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/refkey.ts",
+          "releaseTag": "Public",
+          "name": "Refkeyable",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@alloy-js/core!REFKEYABLE:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "REFKEYABLE: "
+            },
+            {
+              "kind": "Content",
+              "text": "unique symbol"
+            }
+          ],
+          "fileUrlPath": "src/refkey.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "REFKEYABLE",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@alloy-js/core!RefkeyableObject:type",
           "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type RefkeyBase = "
+              "text": "export type RefkeyableObject = "
             },
             {
               "kind": "Content",
@@ -18189,12 +18512,21 @@
             },
             {
               "kind": "Reference",
-              "text": "RefkeySym",
-              "canonicalReference": "@alloy-js/core!~RefkeySym:var"
+              "text": "REFKEYABLE",
+              "canonicalReference": "@alloy-js/core!REFKEYABLE:var"
             },
             {
               "kind": "Content",
-              "text": "]: true;\n}"
+              "text": "](): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Refkey",
+              "canonicalReference": "@alloy-js/core!Refkey:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
             },
             {
               "kind": "Content",
@@ -18203,10 +18535,10 @@
           ],
           "fileUrlPath": "src/refkey.ts",
           "releaseTag": "Public",
-          "name": "RefkeyBase",
+          "name": "RefkeyableObject",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 6
           }
         },
         {
@@ -21613,8 +21945,8 @@
             },
             {
               "kind": "Reference",
-              "text": "Refkey",
-              "canonicalReference": "@alloy-js/core!Refkey:type"
+              "text": "Refkeyable",
+              "canonicalReference": "@alloy-js/core!Refkeyable:type"
             },
             {
               "kind": "Content",
@@ -21682,8 +22014,8 @@
             },
             {
               "kind": "Reference",
-              "text": "RefkeyBase",
-              "canonicalReference": "@alloy-js/core!RefkeyBase:type"
+              "text": "RefkeyableObject",
+              "canonicalReference": "@alloy-js/core!RefkeyableObject:type"
             },
             {
               "kind": "Content",
@@ -23359,6 +23691,76 @@
           ],
           "name": "text"
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@alloy-js/core!TO_SYMBOL:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "TO_SYMBOL: "
+            },
+            {
+              "kind": "Content",
+              "text": "unique symbol"
+            }
+          ],
+          "fileUrlPath": "src/library-symbol-reference.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "TO_SYMBOL",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@alloy-js/core!toRefkey:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function toRefkey(refkey: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Refkeyable",
+              "canonicalReference": "@alloy-js/core!Refkeyable:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Refkey",
+              "canonicalReference": "@alloy-js/core!Refkey:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/refkey.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "refkey",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "toRefkey"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@alloy-js/core!traverseOutput:function(1)",

package/test/refkey.test.ts

@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { refkey } from "../src/refkey.js";
+import { refkey, REFKEYABLE, Refkeyable } from "../src/refkey.js";
 
 it("is stable when called with same values", () => {
   const obj = {};
@@ -30,3 +30,14 @@ it("can be called with no args and returns a fresh key", () => {
   const key2 = refkey();
   expect(key1).not.toBe(key2);
 });
+
+it("unwraps refkeyables", () => {
+  const obj = {};
+  const rk1 = refkey(obj);
+  const refkeyable: Refkeyable = {
+    [REFKEYABLE]() {
+      return rk1;
+    },
+  };
+  expect(refkey(refkeyable)).toBe(rk1);
+});