@azure-tools/typespec-apiview/dist/src/schemas.d.ts

Library for emitting APIView token files from TypeSpec

import { AliasStatementNode, EnumStatementNode, InterfaceStatementNode, IntersectionExpressionNode, ModelExpressionNode, ModelStatementNode, ObjectLiteralNode, OperationStatementNode, ScalarStatementNode, UnionExpressionNode, UnionStatementNode } from "@typespec/compiler/ast";
import { NamespaceModel } from "./namespace-model.js";
import { NamespaceStack } from "./util.js";
export declare enum TokenKind {
    Text = 0,
    Punctuation = 1,
    Keyword = 2,
    TypeName = 3,
    MemberName = 4,
    StringLiteral = 5,
    Literal = 6,
    Comment = 7
}
/** ReviewFile represents entire API review object. This will be processed to render review lines. */
export interface CodeFile {
    Name: string;
    PackageName: string;
    PackageVersion: string;
    /** version of the APIview language parser used to create token file*/
    ParserVersion: string;
    Language: string;
    /** Language variant is applicable only for java variants*/
    LanguageVariant: string | undefined;
    CrossLanguagePackageId: string | undefined;
    ReviewLines: ReviewLine[];
    /** Add any system generated comments. Each comment is linked to review line ID */
    Diagnostics: CodeDiagnostic[] | undefined;
    /** Navigation items are used to create a tree view in the navigation panel. Each navigation item is linked to a review line ID. This is optional.
    * If navigation items are not provided then navigation panel will be automatically generated using the review lines. Navigation items should be provided only if you want to customize the navigation panel.
    */
    Navigation: NavigationItem[] | undefined;
}
export interface ReviewLineOptions {
    /** Set current line as hidden code line by default. .NET has hidden APIs and architects don't want to see them by default. */
    IsHidden?: boolean;
    /** Set current line as context end line. For e.g. line with token } or empty line after the class to mark end of context. */
    IsContextEndLine?: boolean;
    /** Set ID of related line to ensure current line is not visible when a related line is hidden.
     * One e.g. is a code line for class attribute should set class line's Line ID as related line ID.
    */
    RelatedToLine?: string;
}
/** ReviewLine object corresponds to each line displayed on API review. If an empty line is required then add a code line object without any token. */
export interface ReviewLine extends ReviewLineOptions {
    /** lineId is only required if we need to support commenting on a line that contains this token.
     *  Usually code line for documentation or just punctuation is not required to have lineId. lineId should be a unique value within
     *  the review token file to use it assign to review comments as well as navigation Id within the review page.
     *  for e.g Azure.Core.HttpHeader.Common, azure.template.template_main
     */
    LineId: string | undefined;
    CrossLanguageId: string | undefined;
    /** list of tokens that constructs a line in API review */
    Tokens: ReviewToken[];
    /** Add any child lines as children. For e.g. all classes and namespace level methods are added as a children of namespace(module) level code line.
     *  Similarly all method level code lines are added as children of it's class code line.*/
    Children: ReviewLine[];
}
export interface ReviewTokenOptions {
    /** NavigationDisplayName is used to create a tree node in the navigation panel. Navigation nodes will be created only if token contains navigation display name.*/
    NavigationDisplayName?: string;
    /** navigateToId should be set if the underlying token is required to be displayed as HREF to another type within the review.
     * For e.g. a param type which is class name in the same package
     */
    NavigateToId?: string;
    /** set skipDiff to true if underlying token needs to be ignored from diff calculation. For e.g. package metadata or dependency versions
     *  are usually excluded when comparing two revisions to avoid reporting them as API changes*/
    SkipDiff?: boolean;
    /** This is set if API is marked as deprecated */
    IsDeprecated?: boolean;
    /** Set this to true if a prefix space is required before the next value. */
    HasPrefixSpace?: boolean;
    /** Set this to true if a suffix space required before next token. For e.g, punctuation right after method name */
    HasSuffixSpace?: boolean;
    /** Set isDocumentation to true if current token is part of documentation */
    IsDocumentation?: boolean;
    /** Language specific style css class names */
    RenderClasses?: Array<string>;
}
/** Token corresponds to each component within a code line. A separate token is required for keyword, punctuation, type name, text etc. */
export interface ReviewToken extends ReviewTokenOptions {
    Kind: TokenKind;
    Value: string;
}
export declare enum CodeDiagnosticLevel {
    Info = 1,
    Warning = 2,
    Error = 3,
    /** Fatal level diagnostic will block API review approval and it will show an error message to the user. Approver will have to
    * override fatal level system comments before approving a review.*/
    Fatal = 4
}
/** System comment object is to add system generated comment. It can be one of the 4 different types of system comments. */
export interface CodeDiagnostic {
    /** Auto generated system comment to be displayed under targeted line. */
    Text: string;
    /** Diagnostic ID is auto generated ID by CSharp analyzer. */
    DiagnosticId?: string;
    /** Id of ReviewLine object where this diagnostic needs to be displayed */
    TargetId: string;
    Level: CodeDiagnosticLevel;
    HelpLinkUri?: string;
}
export declare class NavigationItem {
    Text: string;
    NavigationId: string | undefined;
    ChildItems: NavigationItem[];
    Tags: ApiViewNavigationTag;
    constructor(objNode: AliasStatementNode | NamespaceModel | ModelStatementNode | OperationStatementNode | InterfaceStatementNode | EnumStatementNode | ModelExpressionNode | IntersectionExpressionNode | ScalarStatementNode | UnionStatementNode | UnionExpressionNode | ObjectLiteralNode, stack: NamespaceStack);
}
export interface ApiViewNavigationTag {
    TypeKind: ApiViewNavigationKind;
}
export declare const enum ApiViewNavigationKind {
    Class = "class",
    Enum = "enum",
    Method = "method",
    Module = "namespace",
    Package = "assembly"
}
//# sourceMappingURL=schemas.d.ts.map