@alloy-js/core 0.1.0

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2024 Microsoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/api-extractor.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "../../api-extractor.base.json",
+  "messages": {
+    "extractorMessageReporting": {
+      "ae-wrong-input-file-type": {
+        "logLevel": "none"
+      }
+    }
+  }
+}

package/babel.config.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  sourceMaps: true,
+  presets: ["@babel/preset-typescript", "@alloy-js/babel-preset"],
+};

package/dist/src/binder.d.ts

@@ -0,0 +1,333 @@
+import { Ref } from "@vue/reactivity";
+import { Refkey } from "./refkey.js";
+export type Metadata = object;
+/**
+ * Flags that describe an output symbol.
+ */
+export declare enum OutputSymbolFlags {
+    None = 0,
+    /**
+     * The symbol is an instance member container. Symbols with this flag will have a
+     * instanceMemberScope property that contains symbols for instance members.
+     */
+    InstanceMemberContainer = 1,
+    /**
+     * The symbol is a static member container. Symbols with this flag will have a
+     * staticMemberScope property that contains symbols for static members.
+     */
+    StaticMemberContainer = 2,
+    /**
+     * Whether this symbol contains members of any kind.
+     */
+    MemberContainer = 3,
+    /**
+     * Whether this symbol is an instance member of another symbol (i.e that it is
+     * stored in an instance member scope).
+     */
+    InstanceMember = 4,
+    /**
+     * Whether this symbol is a static member of another symbol (i.e that it is
+     * stored in a static member scope).
+     */
+    StaticMember = 8,
+    /**
+     * Whether this is an instance member or static member of another symbol.
+     */
+    Member = 12
+}
+/**
+ * An output symbol is a named entity that can be referenced in your output
+ * code. Referencing symbols is generally accomplished by using a
+ * {@link Refkey}.
+ *
+ * @remarks
+ *
+ * This interface is the base implementation of symbol. Generally, most
+ * languages will have subtypes of this interface that provide additional,
+ * language-specific metadata about declared symbols. For example, symbols in
+ * TypeScript need to track whether they are exported or what kind of symbol
+ * they are (e.g. type, value, parameter, etc.)
+ *
+ * Symbols are reactive values, which allows you to observe changes to the symbol
+ * information. For example, a symbol's name may change if it becomes conflicted
+ * with a symbol that is added later.
+ */
+export interface OutputSymbol {
+    /**
+     * The original name of the symbol, before any conflicts were resolved.
+     */
+    originalName: string;
+    /**
+     * The name of the symbol.
+     */
+    name: string;
+    /**
+     * The symbol's flags.
+     */
+    flags: OutputSymbolFlags;
+    /**
+     * The scope in which the symbol is defined.
+     */
+    scope: OutputScope;
+    /**
+     * The binder instance that created this symbol.
+     */
+    binder: Binder;
+    /**
+     * A unique value that references this symbol.
+     */
+    refkey: Refkey;
+    /**
+     * The instance members available on this symbol.
+     *
+     * @remarks
+     *
+     * Instance members are members that are available when this symbol is
+     * instantiated. Instantiation is language-specific. For example, in
+     * TypeScript, instance members of symbols for classes are available when the
+     * class is instantiated with a new expression.
+     *
+     * When a symbol cannot have instance members, this is undefined.
+     */
+    instanceMemberScope?: OutputScope;
+    /**
+     * The static members available on this symbol.
+     *
+     * @remarks
+     *
+     * Static members are members that are available on the symbol itself. These symbols
+     * can be accessed off the parent symbol directly with a refkey. There is only ever
+     * one static member symbol in the output (i.e., the symbol is unique).
+     */
+    staticMemberScope?: OutputScope;
+}
+/**
+ * Flags that describe an output scope.
+ */
+export declare enum OutputScopeFlags {
+    None = 0,
+    /**
+     * This scope is a static member scope.
+     */
+    StaticMemberScope = 1,
+    /**
+     * This scope is an instance member scope.
+     */
+    InstanceMemberScope = 2,
+    /**
+     * This scope is a member scope. Scopes with this flag will have an `owner`
+     * property that points to the symbol whose member this scope holds.
+     */
+    MemberScope = 3
+}
+/**
+ * A container of symbols accessible within some scope in your output code.
+ *
+ * @remarks
+ *
+ * Scopes form a tree. All scopes except the global scope have a parent scope
+ * identified by `parent`. Scopes can have nested scopes which can be accessed
+ * using the `children` property. Whether a child scope can be accessed from
+ * the parent scope is determined by each language's scoping rules.
+ *
+ * This interface is the base implementation of scope. Generally, most languages
+ * will have subtypes of this interface that provide additional metadata about
+ * the scope. For example, TypeScript scopes need to track whether the scope
+ * represents a package, module, class, function, etc.
+ *
+ * Scopes are reactive values, which allows you to observe changes to the scope
+ * within a reactive context.
+ */
+export interface OutputScope {
+    /**
+     * The kind of scope. Subtypes will likely provide a set of known scope kinds.
+     * The kind is not used by the binder itself.
+     */
+    kind: string;
+    /**
+     * The name of the scope.
+     */
+    name: string;
+    /**
+     * The flags that describe this scope.
+     */
+    flags: OutputScopeFlags;
+    /**
+     * The symbols defined within this scope.
+     */
+    symbols: Set<OutputSymbol>;
+    /**
+     * The symbols defined within this scope, indexed by refkey.
+     */
+    symbolsByRefkey: Map<Refkey, OutputSymbol>;
+    /**
+     * The scopes nested within this scope.
+     */
+    children: Set<OutputScope>;
+    /**
+     * The container of this scope.
+     */
+    parent: OutputScope | undefined;
+    /**
+     * The symbol that owns this scope. This is only defined for scopes that have
+     * the {@link OutputScopeFlags.StaticMemberScope} flag.
+     */
+    owner?: OutputSymbol;
+    /**
+     * The binder that created this scope.
+     */
+    binder: Binder;
+    /**
+     * Get the names of all symbols in this scope.
+     */
+    getSymbolNames(): Set<string>;
+}
+/**
+ * The binder tracks all output scopes and symbols. Scopes are nested containers
+ * for symbols.
+ *
+ * @remarks
+ *
+ * Symbol information is reactive because in certain situations this data may
+ * change. For example, when a symbol becomes conflicted with another symbol,
+ * one of the symbol names may change. Ensure that you interact with binder
+ * values in a reactive context (i.e. within JSX/code template, or within
+ * memo/computed/etc).
+ *
+ */
+export interface Binder {
+    /**
+     * Create a new scope. The scope will be added to the parent scope's children.
+     * The returned scope object is reactive.
+     */
+    createScope<T extends OutputScope>(args: {
+        kind: T["kind"];
+        name: string;
+        parent?: OutputScope | undefined;
+        flags?: OutputScopeFlags;
+        owner?: OutputSymbol;
+    } & Omit<T, keyof OutputScope>): T;
+    /**
+     * Create a new symbol. The symbol will be added to the parent scope's symbols.
+     * The returned symbol object is reactive.
+     */
+    createSymbol<T extends OutputSymbol>(args: {
+        name: string;
+        scope?: OutputScope;
+        refkey?: unknown;
+        flags?: OutputSymbolFlags;
+    } & Omit<T, keyof OutputSymbol>): T;
+    /**
+     * Instantiate the static members of a symbol into the instance members of
+     * another symbol.
+     *
+     * @param sourceSym - The symbol to add instance members to.
+     * @param targetSym - The symbol with the static members to instantiate.
+     */
+    instantiateSymbolInto(sourceSym: OutputSymbol, targetSym: OutputSymbol): void;
+    /**
+     * Add static members to an existing symbol.
+     *
+     * @param symbol - The symbol to add static members to.
+     */
+    addStaticMembersToSymbol(symbol: OutputSymbol): void;
+    /**
+     * Add instance members to an existing symbol.
+     *
+     * @param symbol - The symbol to add instance members to.
+     */
+    addInstanceMembersToSymbol(symbol: OutputSymbol): void;
+    /**
+     * Resolve the given refkey in the current scope.
+     *
+     * @returns a ref for the resolution result.
+     * @see {@link resolve} a convenience function that uses the current scope and
+     * binder.
+     */
+    resolveDeclarationByKey<TScope extends OutputScope = OutputScope, TSymbol extends OutputSymbol = OutputSymbol>(currentScope: TScope | undefined, currentMemberScope: TScope | undefined, key: Refkey): Ref<ResolutionResult<TScope, TSymbol> | undefined>;
+    globalScope: OutputScope;
+}
+/**
+ * A successful resolution of a refkey.
+ *
+ * @example
+ *
+ * Let's say we have the following scopes and symbols:
+ *
+ * ```
+ * scope: global scope
+ * ├── scope: namespace scope 1
+ * │   └── symbol: foo
+ * │       └── static member scope
+ * │           └── symbol: bar
+ * └── scope: namespace scope 2
+ *    └── (resolve bar from here)
+ * ```
+ *
+ * When we resolve the refkey for `bar` from within `namespace scope 2`, we will get the following
+ * resolution result:
+ *
+ * * **targetDeclaration**: symbol bar, the symbol we resolved.
+ * * **commonScope**: global scope, because this is the most specific scope that contains both the declaration and the reference.
+ * * **pathUp**: [namespace scope 2], because this is the scope between the reference and the common scope.
+ * * **pathDown**: [namespace scope 1], because this is the scope between the common scope and the declaration
+ * * **memberPath**: [foo, bar], because we resolved a member symbol and these are the symbols that lead from the base declaration to the member symbol.
+ */
+export interface ResolutionResult<TScope extends OutputScope, TSymbol extends OutputSymbol> {
+    /**
+     * The symbol for the resolved declaration.
+     */
+    targetDeclaration: TSymbol;
+    /**
+     * The scopes between the common scope and the reference
+     */
+    pathUp: TScope[];
+    /**
+     * The scopes between the common scope and the declaration.
+     */
+    pathDown: TScope[];
+    /**
+     * The scope which contains both the reference and the declaration.
+     */
+    commonScope: TScope | undefined;
+    /**
+     * When resolving a member symbol, this is the path of symbols that lead from
+     * the base declaration to the member symbol.
+     */
+    memberPath?: TSymbol[];
+}
+export interface NameConflictResolver {
+    (name: string, symbols: OutputSymbol[]): void;
+}
+export interface BinderOptions {
+    nameConflictResolver?: NameConflictResolver;
+}
+export declare function createOutputBinder(options?: BinderOptions): Binder;
+/**
+ * Resolve a refkey in the current scope. Returns a Ref for the resolution result.
+ * The value of the ref will be undefined if the identifier hasn't been resolved yet.
+ *
+ * @remarks
+ *
+ * This API may return a ref for undefined, but that does not mean that the symbol is
+ * not found. The symbol you're looking for may not have been declared yet. When the symbol
+ * is declared, the ref will be updated with the resolution result.
+ */
+export declare function resolve<TScope extends OutputScope, TSymbol extends OutputSymbol>(refkey: Refkey): Ref<ResolutionResult<TScope, TSymbol>>;
+declare const createSymbolsSymbol: unique symbol;
+export declare function getSymbolCreator(creator: SymbolCreator): SymbolCreator[typeof createSymbolsSymbol];
+export declare function getSymbolCreatorSymbol(): typeof createSymbolsSymbol;
+export interface SymbolCreator {
+    [createSymbolsSymbol](binder: Binder): void;
+}
+/**
+ * Use symbol flags to determine the scope in which a symbol with those flags
+ * should be declared given the current context.
+ *
+ * @param flags - The symbol flags to use to determine the default scope.
+ * @returns an {@link OutputScope} that is the default scope for the given
+ * flags.
+ */
+export declare function useDefaultScope(flags?: OutputSymbolFlags): OutputScope | undefined;
+export {};
+//# sourceMappingURL=binder.d.ts.map

package/dist/src/binder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binder.d.ts","sourceRoot":"","sources":["../../src/binder.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,GAAG,EAGJ,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAU,MAAM,EAAE,MAAM,aAAa,CAAC;AAC7C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,IAAI,IAAI;IAER;;;OAGG;IACH,uBAAuB,IAAS;IAEhC;;;OAGG;IACH,qBAAqB,IAAS;IAE9B;;OAEG;IACH,eAAe,IAAkD;IAEjE;;;OAGG;IACH,cAAc,IAAS;IAEvB;;;OAGG;IACH,YAAY,IAAS;IAErB;;OAEG;IACH,MAAM,KAAgC;CACvC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,iBAAiB,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,WAAW,CAAC;IAElC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;CACjC;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IAER;;OAEG;IACH,iBAAiB,IAAS;IAE1B;;OAEG;IACH,mBAAmB,IAAS;IAE5B;;;OAGG;IACH,WAAW,IAA0C;CACtD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAE3B;;OAEG;IACH,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,MAAM;IACrB;;;OAGG;IACH,WAAW,CAAC,CAAC,SAAS,WAAW,EAC/B,IAAI,EAAE;QACJ,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;QACjC,KAAK,CAAC,EAAE,gBAAgB,CAAC;QACzB,KAAK,CAAC,EAAE,YAAY,CAAC;KACtB,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,WAAW,CAAC,GAC7B,CAAC,CAAC;IAEL;;;OAGG;IACH,YAAY,CAAC,CAAC,SAAS,YAAY,EACjC,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,WAAW,CAAC;QACpB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,KAAK,CAAC,EAAE,iBAAiB,CAAC;KAC3B,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,YAAY,CAAC,GAC9B,CAAC,CAAC;IAEL;;;;;;OAMG;IACH,qBAAqB,CAAC,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,GAAG,IAAI,CAAC;IAE9E;;;;OAIG;IACH,wBAAwB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAErD;;;;OAIG;IACH,0BAA0B,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAEvD;;;;;;OAMG;IACH,uBAAuB,CACrB,MAAM,SAAS,WAAW,GAAG,WAAW,EACxC,OAAO,SAAS,YAAY,GAAG,YAAY,EAE3C,YAAY,EAAE,MAAM,GAAG,SAAS,EAChC,kBAAkB,EAAE,MAAM,GAAG,SAAS,EACtC,GAAG,EAAE,MAAM,GACV,GAAG,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;IAEtD,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,gBAAgB,CAC/B,MAAM,SAAS,WAAW,EAC1B,OAAO,SAAS,YAAY;IAE5B;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,aAAa;IAC5B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAC7C;AAED,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,aAAkB,GAAG,MAAM,CAqYtE;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CACrB,MAAM,SAAS,WAAW,EAC1B,OAAO,SAAS,YAAY,EAC5B,MAAM,EAAE,MAAM,GAAG,GAAG,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAUxD;AAED,QAAA,MAAM,mBAAmB,EAAE,OAAO,MAAiB,CAAC;AACpD,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,aAAa,GACrB,aAAa,CAAC,OAAO,mBAAmB,CAAC,CAE3C;AAED,wBAAgB,sBAAsB,IAAI,OAAO,mBAAmB,CAEnE;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7C;AAaD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,KAAK,GAAE,iBAA0C,2BAelD"}