@alloy-js/core 0.20.0-dev.3 → 0.20.0-dev.6

package/dist/src/refkey.js

@@ -5,12 +5,12 @@ function getObjectKey(value) {
   if (objectIds.has(value)) {
     return objectIds.get(value);
   }
-  const key = createRefkey(`o${objId++}`);
+  const key = `o${objId++}`;
   objectIds.set(value, key);
   return key;
 }
 const RefkeySym = Symbol();
-function createRefkey(key) {
+function createSymbolRefkey(key) {
   const refkey = {
     key,
     [RefkeySym]: true
@@ -21,13 +21,28 @@ function createRefkey(key) {
 export function isRefkey(value) {
   return typeof value === "object" && value !== null && Object.hasOwn(value, RefkeySym);
 }
+export function isSymbolRefkey(value) {
+  return isRefkey(value) && Object.hasOwn(value, "key");
+}
+export function isMemberRefkey(value) {
+  return isRefkey(value) && Object.hasOwn(value, "base") && Object.hasOwn(value, "member");
+}
+export function isNamekey(value) {
+  return isRefkey(value) && Object.hasOwn(value, "name");
+}
+
+/**
+ * This gets the key for a symbol refkey based on the value provided. Refkey values
+ * return the key of that refkey, objects get a unique key for that specific object,
+ * and otherwise the key is based on the value.
+ */
 function getKey(value) {
-  if (isRefkey(value)) {
-    return value;
+  if (isSymbolRefkey(value)) {
+    return value.key;
   } else if (typeof value === "object" && value !== null) {
     return getObjectKey(value);
   } else {
-    return createRefkey(`s${String(value)}`);
+    return `s${String(value)}`;
   }
 }
 const knownRefkeys = new Map();
@@ -47,15 +62,40 @@ const knownRefkeys = new Map();
  */
 export function refkey(...args) {
   const keys = args.length === 0 ? [getKey({})] : args.map(v => getKey(v));
-  const compositeKey = keys.map(v => v.key).join("\u2063");
+  const compositeKey = keys.join("\u2063");
   if (knownRefkeys.has(compositeKey)) {
     return knownRefkeys.get(compositeKey);
   }
-  const key = createRefkey(compositeKey);
+  const key = createSymbolRefkey(compositeKey);
   knownRefkeys.set(compositeKey, key);
   return key;
 }
 
+/**
+ * Create a namekey with the given name. The namekey is a unique refkey that
+ * represents a single symbol with the given name and the provided
+ * naming-related options.
+ *
+ * @example
+ * ```tsx
+ * const myClass = namekey("MyClass");
+ *
+ * return <>
+ *   <ClassDeclaration name={myClass} />
+ *   {myClass}
+ * </>
+ * ```
+ *
+ * Renders a class and a reference to that class.
+ */
+export function namekey(name, options = {}) {
+  return {
+    key: getObjectKey({}),
+    name,
+    options,
+    [RefkeySym]: true
+  };
+}
 /**
  * Create a refkey for an instantiation of a symbol.
  *
@@ -79,5 +119,9 @@ export function refkey(...args) {
  * `refkey(rk1, rk3)`.
  */
 export function memberRefkey(base, member) {
-  return refkey(base, member);
+  return {
+    base,
+    member,
+    [RefkeySym]: true
+  };
 }

package/dist/src/symbols/basic-scope.d.ts

@@ -0,0 +1,14 @@
+import { OutputScope } from "./output-scope.js";
+/**
+ * BasicScope is a kind of OutputScope that has a single declaration space named
+ * `symbols`. It is suitable for use in simple language implementations where
+ * there isn't much in the way of unique scope semantics.
+ */
+export declare class BasicScope extends OutputScope {
+    static readonly defaultDeclarationSpace = "symbols";
+    static readonly declarationSpaces: readonly ["symbols"];
+    get symbols(): import("./output-space.js").OutputSpace;
+    get symbolNames(): ReadonlyMap<string, import("./output-symbol.js").OutputSymbol>;
+    get symbolsByRefkey(): ReadonlyMap<import("../refkey.js").Refkey, import("./output-symbol.js").OutputSymbol>;
+}
+//# sourceMappingURL=basic-scope.d.ts.map

package/dist/src/symbols/basic-scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic-scope.d.ts","sourceRoot":"","sources":["../../../src/symbols/basic-scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC,gBAAuB,uBAAuB,aAAa;IAC3D,gBAAuB,iBAAiB,uBAAwB;IAEhE,IAAI,OAAO,4CAEV;IAED,IAAI,WAAW,mEAEd;IAED,IAAI,eAAe,0FAElB;CACF"}

package/dist/src/symbols/basic-scope.js

@@ -0,0 +1,20 @@
+import { OutputScope } from "./output-scope.js";
+
+/**
+ * BasicScope is a kind of OutputScope that has a single declaration space named
+ * `symbols`. It is suitable for use in simple language implementations where
+ * there isn't much in the way of unique scope semantics.
+ */
+export class BasicScope extends OutputScope {
+  static defaultDeclarationSpace = "symbols";
+  static declarationSpaces = ["symbols"];
+  get symbols() {
+    return this.spaceFor("symbols");
+  }
+  get symbolNames() {
+    return this.spaceFor("symbols").symbolNames;
+  }
+  get symbolsByRefkey() {
+    return this.spaceFor("symbols").symbolsByRefkey;
+  }
+}

package/dist/src/symbols/basic-symbol.d.ts

@@ -0,0 +1,19 @@
+import { OutputSymbol } from "./output-symbol.js";
+/**
+ * BasicSymbol is a kind of OutputSymbol that has instance and static members.
+ * It is suitable for use in simple language implementations where there isn't
+ * much in the way of unique symbol semantics.
+ *
+ * @remarks
+ *
+ * Instantiation is done by copying symbols from instance members to static
+ * members of the instantiation target.
+ *
+ */
+export declare class BasicSymbol extends OutputSymbol {
+    static readonly memberSpaces: string[];
+    copy(): BasicSymbol;
+    get instanceMembers(): import("./output-space.js").OutputMemberSpace;
+    get staticMembers(): import("./output-space.js").OutputMemberSpace;
+}
+//# sourceMappingURL=basic-symbol.d.ts.map

package/dist/src/symbols/basic-symbol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic-symbol.d.ts","sourceRoot":"","sources":["../../../src/symbols/basic-symbol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;;;;;;;;GAUG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C,gBAAuB,YAAY,WAA0B;IAE7D,IAAI;IAQJ,IAAI,eAAe,kDAElB;IAED,IAAI,aAAa,kDAEhB;CACF"}

package/dist/src/symbols/basic-symbol.js

@@ -0,0 +1,28 @@
+import { OutputSymbol } from "./output-symbol.js";
+
+/**
+ * BasicSymbol is a kind of OutputSymbol that has instance and static members.
+ * It is suitable for use in simple language implementations where there isn't
+ * much in the way of unique symbol semantics.
+ *
+ * @remarks
+ *
+ * Instantiation is done by copying symbols from instance members to static
+ * members of the instantiation target.
+ *
+ */
+export class BasicSymbol extends OutputSymbol {
+  static memberSpaces = ["static", "instance"];
+  copy() {
+    const options = this.getCopyOptions();
+    const copiedSymbol = new BasicSymbol(this.name, undefined, options);
+    this.initializeCopy(copiedSymbol);
+    return copiedSymbol;
+  }
+  get instanceMembers() {
+    return this.memberSpaceFor("instance");
+  }
+  get staticMembers() {
+    return this.memberSpaceFor("static");
+  }
+}

package/dist/src/symbols/index.d.ts

@@ -1,5 +1,7 @@
-export * from "./flags.js";
+export * from "./basic-scope.js";
+export * from "./basic-symbol.js";
 export * from "./output-scope.js";
+export * from "./output-space.js";
 export * from "./output-symbol.js";
 export * from "./symbol-flow.js";
 export * from "./symbol-slot.js";

package/dist/src/symbols/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/symbols/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/symbols/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/dist/src/symbols/index.js

@@ -1,5 +1,7 @@
-export * from "./flags.js";
+export * from "./basic-scope.js";
+export * from "./basic-symbol.js";
 export * from "./output-scope.js";
+export * from "./output-space.js";
 export * from "./output-symbol.js";
 export * from "./symbol-flow.js";
 export * from "./symbol-slot.js";

package/dist/src/symbols/output-scope.d.ts

@@ -1,17 +1,24 @@
 import { ReactiveFlags } from "@vue/reactivity";
 import type { Binder } from "../binder.js";
-import type { ReactiveUnionSetOptions } from "../reactive-union-set.js";
-import type { Refkey } from "../refkey.js";
-import { OutputScopeFlags } from "./flags.js";
-import type { OutputSymbol } from "./output-symbol.js";
-import { SymbolTable } from "./symbol-table.js";
+import { inspect } from "../inspect.js";
+import { OutputDeclarationSpace, OutputSpace } from "./output-space.js";
+import { OutputSymbol } from "./output-symbol.js";
 export interface OutputScopeOptions {
-    flags?: OutputScopeFlags;
-    kind?: string;
+    /**
+     * Arbitrary metadata that is associated with this scope.
+     */
     metadata?: Record<string, unknown>;
-    parent?: OutputScope;
-    owner?: OutputSymbol;
+    /**
+     * The binder instance this scope belongs to. If not provided, it will
+     * attempt to find the current binder from context.
+     */
     binder?: Binder;
+    /**
+     * The owner symbol of this scope. When provided, this scope becomes a member
+     * scope, which exposes the symbols on its owner symbol instead of having its
+     * own declaration spaces.
+     */
+    ownerSymbol?: OutputSymbol;
 }
 /**
  * A container of symbols accessible within some scope in your output code.
@@ -31,64 +38,86 @@ export interface OutputScopeOptions {
  * Scopes are reactive values, which allows you to observe changes to the scope
  * within a reactive context.
  */
-export declare class OutputScope {
+export declare abstract class OutputScope {
     #private;
+    static readonly declarationSpaces: Readonly<string[]>;
     /**
      * The name of the scope.
+     *
+     * @reactive
      */
     get name(): string;
     set name(name: string);
     /**
      * The unique id of this scope.
+     *
+     * @readonly
      */
     get id(): number;
     /**
-     * The kind of scope. Subtypes will likely provide a set of known scope kinds.
-     * The kind is not used by the binder itself.
-     */
-    get kind(): string;
-    /**
-     * The flags that describe this scope.
+     * Arbitrary metadata associated with this scope. This property is not
+     * reactive but the metadata object is a reactive object.
+     *
+     * @readonly
      */
-    get flags(): OutputScopeFlags;
-    set flags(flags: OutputScopeFlags);
     get metadata(): Record<string, unknown>;
     /**
-     * The container of this scope. This is only defined for scopes which don't
-     * have the {@link OutputScopeFlags.StaticMemberScope} or
-     * {@link OutputScopeFlags.InstanceMemberScope} flag.
+     * The parent scope of this scope. Undefined if this is a root scope.
+     *
+     * @reactive
      */
     get parent(): OutputScope | undefined;
+    set parent(scope: OutputScope | undefined);
     /**
-     * The symbol that owns this scope. This is only defined for scopes that have
-     * the {@link OutputScopeFlags.StaticMemberScope} or
-     * {@link OutputScopeFlags.InstanceMemberScope} flag.
-     */
-    get owner(): OutputSymbol | undefined;
-    /**
-     * The symbols defined within this scope.
+     * Get the declaration space for the given key.
      */
-    get symbols(): SymbolTable;
-    /**
-     * The symbols defined within this scope, indexed by refkey.
-     */
-    get symbolsByRefkey(): ReadonlyMap<Refkey, OutputSymbol>;
-    get symbolNames(): ReadonlySet<string>;
+    spaceFor(key: string): OutputSpace | undefined;
     /**
      * The scopes nested within this scope.
+     *
+     * @readonly
      */
     get children(): Set<OutputScope>;
     /**
      * The binder that created this scope.
+     *
+     * @readonly
      */
     get binder(): Binder | undefined;
     [ReactiveFlags.SKIP]: this;
-    constructor(name: string, options?: OutputScopeOptions);
-    moveSymbolsFrom(source: OutputScope, options?: ReactiveUnionSetOptions<OutputSymbol>): void;
-    copySymbolsFrom(source: OutputScope, options?: ReactiveUnionSetOptions<OutputSymbol>): void;
-    clone(options?: {
-        parent?: OutputScope;
-        owner?: OutputSymbol;
-    }): OutputScope;
+    constructor(name: string, parentScope: OutputScope | undefined, options?: OutputScopeOptions);
+    /**
+     * Get all the declaration spaces in this scope.
+     *
+     * @readonly
+     */
+    get spaces(): OutputDeclarationSpace[];
+    /**
+     * The symbol whose members are in scope. When an owner symbol is present,
+     * this scope is considered a member scope, and does not provide its own
+     * declaration spaces.
+     *
+     * @readonly
+     * @reactive
+     */
+    get ownerSymbol(): OutputSymbol | undefined;
+    /**
+     * Whether this scope is a transient scope. Transient scopes are used for
+     * temporary values that are to be combined with other non-transient symbols.
+     * Scopes are transient when their owner symbol is transient.
+     *
+     * @readonly
+     */
+    get isTransient(): boolean;
+    /**
+     * Check if this is scope is a member scope. Member scopes have no member
+     * spaces of their own, but instead put members of their owner symbol in
+     * scope.
+     *
+     * @readonly
+     * @reactive
+     */
+    get isMemberScope(): boolean;
+    [inspect.custom](): string;
 }
 //# sourceMappingURL=output-scope.d.ts.map

package/dist/src/symbols/output-scope.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"output-scope.d.ts","sourceRoot":"","sources":["../../../src/symbols/output-scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EAOd,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAG3C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAQ3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIhD,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,WAAW;;IAGtB;;OAEG;IACH,IAAI,IAAI,IAIO,MAAM,CADpB;IACD,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,EAIpB;IAGD;;OAEG;IACH,IAAI,EAAE,WAEL;IAID;;;OAGG;IACH,IAAI,IAAI,WAEP;IAGD;;OAEG;IACH,IAAI,KAAK,IAIQ,gBAAgB,CADhC;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,gBAAgB,EAIhC;IAID,IAAI,QAAQ,4BAEX;IAGD;;;;OAIG;IACH,IAAI,MAAM,4BAET;IAGD;;;;OAIG;IACH,IAAI,KAAK,6BAER;IAGD;;OAEG;IACH,IAAI,OAAO,gBAEV;IAGD;;OAEG;IACH,IAAI,eAAe,sCAElB;IAGD,IAAI,WAAW,wBAEd;IAGD;;OAEG;IACH,IAAI,QAAQ,qBAEX;IAGD;;OAEG;IACH,IAAI,MAAM,uBAET;IAED,CAAC,aAAa,CAAC,IAAI,CAAC,OAAQ;gBAEhB,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB;IA6C1D,eAAe,CACb,MAAM,EAAE,WAAW,EACnB,OAAO,CAAC,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAuBjD,eAAe,CACb,MAAM,EAAE,WAAW,EACnB,OAAO,CAAC,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAsBjD,KAAK,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAC;QAAC,KAAK,CAAC,EAAE,YAAY,CAAA;KAAO;CAiCnE"}
+{"version":3,"file":"output-scope.d.ts","sourceRoot":"","sources":["../../../src/symbols/output-scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EAMd,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAIlD,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,WAAW;;IAC/B,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAe;IAGpE;;;;OAIG;IACH,IAAI,IAAI,IAKO,MAAM,CAFpB;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,EAIpB;IAGD;;;;OAIG;IACH,IAAI,EAAE,WAEL;IAID;;;;;OAKG;IACH,IAAI,QAAQ,4BAEX;IAID;;;;OAIG;IACH,IAAI,MAAM,IAKQ,WAAW,GAAG,SAAS,CAFxC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,EAaxC;IAID;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAK9C;;;;OAIG;IACH,IAAI,QAAQ,qBAEX;IAGD;;;;OAIG;IACH,IAAI,MAAM,uBAET;IAED,CAAC,aAAa,CAAC,IAAI,CAAC,OAAQ;gBAG1B,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,WAAW,GAAG,SAAS,EACpC,OAAO,GAAE,kBAAuB;IAiClC;;;;OAIG;IACH,IAAI,MAAM,6BAET;IAGD;;;;;;;OAOG;IACH,IAAI,WAAW,6BAGd;IAQD;;;;;;OAMG;IACH,IAAI,WAAW,YAMd;IACD;;;;;;;OAOG;IACH,IAAI,aAAa,YAEhB;IAED,CAAC,OAAO,CAAC,MAAM,CAAC;CAOjB"}