@alloy-js/core 0.20.0-dev.4 → 0.20.0-dev.7

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

@@ -1,15 +1,65 @@
-import { ReactiveFlags } from "@vue/reactivity";
+import { ReactiveFlags, Ref } from "@vue/reactivity";
 import type { Binder } from "../binder.js";
-import { type Refkey } from "../refkey.js";
-import { OutputScopeFlags, OutputSymbolFlags } from "./flags.js";
-import { OutputScope } from "./output-scope.js";
+import { inspect } from "../inspect.js";
+import { NamePolicyGetter } from "../name-policy.js";
+import { Namekey, type Refkey } from "../refkey.js";
+import { OutputMemberSpace, OutputSpace } from "./output-space.js";
 export interface OutputSymbolOptions {
+    /**
+     * The binder instance associated with this symbol. Symbol updates and changes
+     * will be reported to this binder. This binder will be able to find this
+     * symbol via its refkey and other means. Without a binder, this symbol will
+     * be unbound, which means it cannot be referenced by refkey.
+     */
     binder?: Binder;
-    scope?: OutputScope;
-    flags?: OutputSymbolFlags;
+    /**
+     * The refkey or refkeys associated with this symbol.
+     */
     refkeys?: Refkey | Refkey[];
+    /**
+     * Arbitrary metadata about this symbol.
+     */
     metadata?: Record<string, unknown>;
+    /**
+     * The symbol this symbol is an alias for.
+     */
     aliasTarget?: OutputSymbol;
+    /**
+     * Whether this symbol is transient.
+     */
+    transient?: boolean;
+    /**
+     * The symbol that provides type information for this symbol. When present,
+     * this symbol will not contain its own members, and instead members will be
+     * provided by the type. This can be provided a Ref, in which case the type
+     * will be the value of that ref.
+     */
+    type?: OutputSymbol | Ref<OutputSymbol | undefined>;
+    /**
+     * When provided, this symbol will be named according to the provided name
+     * policy.
+     *
+     * @example
+     *
+     * ```ts
+     * const classNamer = useNamePolicy().for("class");
+     * const symbol = new BasicSymbol("my-class", { namePolicy: classNamer });
+     * console.log(symbol.name); // "MyClass" (assuming a PascalCase class naming policy)
+     * ```
+     */
+    namePolicy?: NamePolicyGetter;
+    /**
+     * Whether the name of this symbol should bypass the active name policy. When true,
+     * the name of this symbol will be fixed, though it may conflict with other symbols which are
+     * also ignoring the name policy.
+     */
+    ignoreNamePolicy?: boolean;
+    /**
+     * Whether the name of this symbol should bypass the active name conflict resolution.
+     * When true, the name of this symbol will be fixed, though it may conflict with other symbols which are
+     * also ignoring name conflict resolution.
+     */
+    ignoreNameConflict?: boolean;
 }
 /**
  * An output symbol is a named entity that can be referenced in your output
@@ -21,56 +71,174 @@ export interface OutputSymbolOptions {
  * subtypes that provide additional metadata. Symbols are reactive values, so
  * you can observe changes to their properties in a reactive context.
  */
-export declare class OutputSymbol {
+export declare abstract class OutputSymbol {
     #private;
+    static readonly memberSpaces: Readonly<string[]>;
+    /**
+     * Read only. The requested name of this symbol. The symbol's actual name may
+     * be different depending on naming policy or conflicts with other symbols.
+     *
+     * @readonly
+     */
     get originalName(): string;
+    /**
+     * The name of this symbol.
+     *
+     * @reactive
+     */
     get name(): string;
     set name(name: string);
+    /**
+     * The unique id of this symbol.
+     *
+     * @readonly
+     */
     get id(): number;
-    get flags(): OutputSymbolFlags;
-    set flags(flags: OutputSymbolFlags);
-    get scope(): OutputScope;
-    set scope(scope: OutputScope);
+    /**
+     * Whether the name of this symbol bypasses the active name policy. When true,
+     * the name of this symbol will be fixed, though it may conflict with other
+     * symbols which are also ignoring the name policy.
+     *
+     * @readonly
+     */
+    get ignoreNamePolicy(): boolean;
+    /**
+     * Whether the name of this symbol bypasses the active name conflict
+     * resolution. When true, the name of this symbol will be fixed, though it may
+     * conflict with other symbols which are also ignoring name conflict
+     * resolution.
+     */
+    get ignoreNameConflict(): boolean;
+    /**
+     * The member spaces of this symbol.
+     *
+     * @readonly
+     */
+    get memberSpaces(): OutputMemberSpace[];
+    /**
+     * Get the member space for the given key.
+     */
+    memberSpaceFor(spaceKey: string): OutputMemberSpace | undefined;
+    /**
+     * The scope this symbol is in. When this symbol is a member symbol, this will
+     * return undefined.
+     *
+     * @readonly
+     */
+    get scope(): import("./output-scope.js").OutputScope | undefined;
+    /**
+     * The declaration or member spaces this symbol belongs to.
+     *
+     * @reactive
+     */
+    get spaces(): OutputSpace[];
+    set spaces(spaces: OutputSpace[] | OutputSpace | undefined);
+    /**
+     * The binder that is tracking this symbol.
+     *
+     * @readonly
+     */
     get binder(): Binder | undefined;
+    /**
+     * The refkeys for this symbol.
+     *
+     * @reactive
+     */
     get refkeys(): Refkey[];
     set refkeys(refkeys: Refkey[]);
-    get instanceMemberScope(): OutputScope | undefined;
+    /**
+     * The symbol that this symbol is an alias for.
+     *
+     * @readonly
+     */
     get aliasTarget(): OutputSymbol | undefined;
     /**
-     * Create an output scope to hold member symbols. By default this just creates
-     * an OutputScope, but can be subclassed to build scope subtypes when needed.
+     * If this symbol is an alias for another symbol, return the the aliased symbol. Otherwise, return this symbol.
+     */
+    dealias(): OutputSymbol;
+    /**
+     * Whether this symbol is an alias for another symbol.
+     *
+     * @readonly
+     */
+    get isAlias(): boolean;
+    /**
+     * An arbitrary bag of metadata for this symbol. This property is read only,
+     * but the metadata is a reactive object.
+     *
+     * @readonly
      */
-    protected createMemberScope(name: string, options: {
-        owner?: OutputSymbol;
-        flags?: OutputScopeFlags;
-    }): OutputScope;
-    get staticMemberScope(): OutputScope | undefined;
     get metadata(): Record<string, unknown>;
+    copyToSpace(space: OutputSpace): OutputSymbol;
     /**
-     * Tell \@vue/reactivity that this symbol should never be wrapped in a reactive
-     * proxy.
+     * Whether this symbol is a member of another symbol.
+     *
+     * @readonly
      */
-    [ReactiveFlags.SKIP]: boolean;
-    constructor(name: string, options?: OutputSymbolOptions);
-    delete(): void;
+    get isMemberSymbol(): boolean;
+    /**
+     * When this is a member symbol, this returns the symbol that this is symbol
+     * is a member of.
+     */
+    get ownerSymbol(): OutputSymbol | undefined;
+    /**
+     * Whether this symbol is a transient symbol. Transient symbols cannot be
+     * referenced and are meant to be combined with other symbols.
+     *
+     * @readonly
+     */
+    get isTransient(): boolean;
+    /**
+     * The symbol that this symbol's members have been moved to.
+     *
+     * @readonly
+     * @reactive
+     */
+    get movedTo(): OutputSymbol | undefined;
+    /**
+     * Whether this symbol's members have been moved to another symbol.
+     *
+     * @reactive
+     */
+    get isMoved(): boolean;
+    /**
+     * The symbol which defines the type of this symbol. The type symbol provides
+     * information about the value this symbol contains, such as what members it
+     * has.
+     *
+     * @reactive
+     */
+    get type(): OutputSymbol | undefined;
+    set type(value: OutputSymbol | Ref<OutputSymbol | undefined> | undefined);
     /**
-     * Takes the instance members or static members on this symbol and creates
-     * corresponding static members on the target symbol. Instance or static
-     * members of instantiated symbols are copied. The refkey of any instantiated
-     * symbols are set to a composite refkey of the target symbol's refkey and the
-     * instantiated symbol's refkey.
+     * Whether this symbol has its symbol representing its type available.
+     *
+     * @readonly
+     * @reactive
+     */
+    get hasTypeSymbol(): boolean;
+    /**
+     * Whether this symbol's members are provided by a type symbol. The
+     * `typeSymbol` property is this symbol. It may not be available yet, so check
+     * `hasTypeSymbol`.
      */
-    instantiateTo(targetSymbol: OutputSymbol): void;
+    get isTyped(): boolean;
+    get namePolicy(): NamePolicyGetter | undefined;
+    [ReactiveFlags.SKIP]: boolean;
+    constructor(name: string | Namekey, spaces: OutputSpace[] | OutputSpace | undefined, options?: OutputSymbolOptions);
+    delete(): void;
     /**
-     * Copy member symbols from the target symbol into the target symbol. The
-     * copied symbols have their refkey set to
-     * `refkey(targetSymbol.refkey, this.refkey)`.
+     * Move member symbols from this transient symbol to the target symbol. This is reactive -
+     * whenever a member is added to this symbol, it will be moved to the target
+     * symbol.
      */
-    copyTo(targetSymbol: OutputSymbol): void;
+    moveMembersTo(targetSymbol: OutputSymbol): void;
     /**
-     * Move member symbols from this transient symbol to the target symbol.
+     * Copy the members of this symbol to the target symbol. This is reactive -
+     * whenever a member is added to this symbol, it will be copied to the target
+     * symbol.
      */
-    moveTo(targetSymbol: OutputSymbol): void;
+    copyMembersTo(targetSymbol: OutputSymbol): void;
     /**
      * Makes a copy of this symbol which will update the name and flags
      * of the clone when the original symbol is updated.
@@ -84,6 +252,14 @@ export declare class OutputSymbol {
      *
      * @param newScope - The scope to use for the copy.
      */
-    copyToScope(newScope: OutputScope, baseSymbol?: OutputSymbol): OutputSymbol;
+    abstract copy(): OutputSymbol;
+    protected getCopyOptions(): {
+        binder: Binder | undefined;
+        aliasTarget: OutputSymbol | undefined;
+        metadata: Record<string, unknown>;
+        transient: boolean;
+    };
+    protected initializeCopy(copy: OutputSymbol): void;
+    [inspect.custom](): string;
 }
 //# sourceMappingURL=output-symbol.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"output-symbol.d.ts","sourceRoot":"","sources":["../../../src/symbols/output-symbol.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EAOd,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAI3C,OAAO,EAAoB,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAS7D,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,YAAY,CAAC;CAC5B;AAID;;;;;;;;;GASG;AACH,qBAAa,YAAY;;IAEvB,IAAI,YAAY,WAEf;IAGD,IAAI,IAAI,IAIO,MAAM,CADpB;IACD,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,EASpB;IAGD,IAAI,EAAE,WAEL;IAGD,IAAI,KAAK,IAIQ,iBAAiB,CADjC;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAYjC;IAGD,IAAI,KAAK,IAKQ,WAAW,CAF3B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,WAAW,EAY3B;IAwBD,IAAI,MAAM,uBAET;IAGD,IAAI,OAAO,IAKU,MAAM,EAAE,CAF5B;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAW5B;IAGD,IAAI,mBAAmB,4BAGtB;IAGD,IAAI,WAAW,6BAEd;IA2BD;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CACzB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QACP,KAAK,CAAC,EAAE,YAAY,CAAC;QACrB,KAAK,CAAC,EAAE,gBAAgB,CAAC;KAC1B;IAUH,IAAI,iBAAiB,4BAGpB;IAyBD,IAAI,QAAQ,4BAEX;IAED;;;OAGG;IACH,CAAC,aAAa,CAAC,IAAI,CAAC,UAAQ;gBAEhB,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;IA+B3D,MAAM;IASN;;;;;;OAMG;IACH,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAuC/C;;;;OAIG;IACH,MAAM,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAiBxC;;OAEG;IACH,MAAM,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAqBxC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,YAAY,GAAG,YAAY;CA8D5E"}
+{"version":3,"file":"output-symbol.d.ts","sourceRoot":"","sources":["../../../src/symbols/output-symbol.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EACb,GAAG,EAOJ,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAQpD,OAAO,EAEL,iBAAiB,EACjB,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAG3B,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,GAAG,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAEpD;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAE9B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAID;;;;;;;;;GASG;AACH,8BAAsB,YAAY;;IAChC,gBAAuB,YAAY,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAM;IAG7D;;;;;OAKG;IACH,IAAI,YAAY,WAEf;IAID;;;;OAIG;IACH,IAAI,IAAI,IAKO,MAAM,CAFpB;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,EAYpB;IAGD;;;;OAIG;IACH,IAAI,EAAE,WAEL;IAGD;;;;;;OAMG;IACH,IAAI,gBAAgB,YAEnB;IAID;;;;;OAKG;IACH,IAAI,kBAAkB,YAErB;IAGD;;;;OAIG;IACH,IAAI,YAAY,wBAEf;IAED;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAI/D;;;;;OAKG;IACH,IAAI,KAAK,wDAUR;IAGD;;;;OAIG;IACH,IAAI,MAAM,IAAI,WAAW,EAAE,CAG1B;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,GAAG,SAAS,EAgBzD;IAcD;;;;OAIG;IACH,IAAI,MAAM,uBAET;IAID;;;;OAIG;IACH,IAAI,OAAO,IAKU,MAAM,EAAE,CAF5B;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAW5B;IAGD;;;;OAIG;IACH,IAAI,WAAW,6BAEd;IAED;;OAEG;IACH,OAAO,IAAI,YAAY;IAOvB;;;;OAIG;IACH,IAAI,OAAO,YAEV;IAGD;;;;;OAKG;IACH,IAAI,QAAQ,4BAEX;IAED,WAAW,CAAC,KAAK,EAAE,WAAW;IAM9B;;;;OAIG;IACH,IAAI,cAAc,YAEjB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,YAAY,GAAG,SAAS,CAM1C;IAID;;;;;OAKG;IACH,IAAI,WAAW,IAAI,OAAO,CAUzB;IAGD;;;;;OAKG;IACH,IAAI,OAAO,6BAGV;IAOD;;;;OAIG;IACH,IAAI,OAAO,YAEV;IAID;;;;;;OAMG;IACH,IAAI,IAAI,IAAI,YAAY,GAAG,SAAS,CAGnC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,GAAG,CAAC,YAAY,GAAG,SAAS,CAAC,GAAG,SAAS,EAYvE;IAED;;;;;OAKG;IACH,IAAI,aAAa,YAEhB;IAID;;;;OAIG;IACH,IAAI,OAAO,YAEV;IAGD,IAAI,UAAU,iCAEb;IAID,CAAC,aAAa,CAAC,IAAI,CAAC,UAAQ;gBAG1B,IAAI,EAAE,MAAM,GAAG,OAAO,EACtB,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,GAAG,SAAS,EAC/C,OAAO,GAAE,mBAAwB;IA+DnC,MAAM;IASN;;;;OAIG;IACH,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAuB/C;;;;OAIG;IACH,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAiB/C;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,IAAI,IAAI,YAAY;IAE7B,SAAS,CAAC,cAAc;;;;;;IASxB,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY;IAiB3C,CAAC,OAAO,CAAC,MAAM,CAAC;CAGjB"}