@microsoft/api-extractor-model 7.32.2 → 7.33.1

package/lib-esm/model/ApiPackage.js

@@ -0,0 +1,148 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { JsonFile, PackageJsonLookup } from '@rushstack/node-core-library';
+import { TSDocConfiguration } from '@microsoft/tsdoc';
+import { TSDocConfigFile } from '@microsoft/tsdoc-config';
+import { ApiItem, ApiItemKind } from '../items/ApiItem';
+import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
+import { ApiDocumentedItem } from '../items/ApiDocumentedItem';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { DeserializerContext, ApiJsonSchemaVersion } from './DeserializerContext';
+/**
+ * Represents an NPM package containing API declarations.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * @public
+ */
+export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumentedItem)) {
+    constructor(options) {
+        super(options);
+        this._tsdocConfiguration = options.tsdocConfiguration;
+        this._projectFolderUrl = options.projectFolderUrl;
+    }
+    /** @override */
+    static onDeserializeInto(options, context, jsonObject) {
+        super.onDeserializeInto(options, context, jsonObject);
+        options.projectFolderUrl = jsonObject.projectFolderUrl;
+    }
+    static loadFromJsonFile(apiJsonFilename) {
+        const jsonObject = JsonFile.load(apiJsonFilename);
+        if (!jsonObject || !jsonObject.metadata || typeof jsonObject.metadata.schemaVersion !== 'number') {
+            throw new Error(`Error loading ${apiJsonFilename}:` +
+                `\nThe file format is not recognized; the "metadata.schemaVersion" field is missing or invalid`);
+        }
+        const schemaVersion = jsonObject.metadata.schemaVersion;
+        if (schemaVersion < ApiJsonSchemaVersion.OLDEST_SUPPORTED) {
+            throw new Error(`Error loading ${apiJsonFilename}:` +
+                `\nThe file format is version ${schemaVersion},` +
+                ` whereas ${ApiJsonSchemaVersion.OLDEST_SUPPORTED} is the oldest version supported by this tool`);
+        }
+        let oldestForwardsCompatibleVersion = schemaVersion;
+        if (jsonObject.metadata.oldestForwardsCompatibleVersion) {
+            // Sanity check
+            if (jsonObject.metadata.oldestForwardsCompatibleVersion > schemaVersion) {
+                throw new Error(`Error loading ${apiJsonFilename}:` +
+                    `\nInvalid file format; "oldestForwardsCompatibleVersion" cannot be newer than "schemaVersion"`);
+            }
+            oldestForwardsCompatibleVersion = jsonObject.metadata.oldestForwardsCompatibleVersion;
+        }
+        let versionToDeserialize = schemaVersion;
+        if (versionToDeserialize > ApiJsonSchemaVersion.LATEST) {
+            // If the file format is too new, can we treat it as some earlier compatible version
+            // as indicated by oldestForwardsCompatibleVersion?
+            versionToDeserialize = Math.max(oldestForwardsCompatibleVersion, ApiJsonSchemaVersion.LATEST);
+            if (versionToDeserialize > ApiJsonSchemaVersion.LATEST) {
+                // Nope, still too new
+                throw new Error(`Error loading ${apiJsonFilename}:` +
+                    `\nThe file format version ${schemaVersion} was written by a newer release of` +
+                    ` the api-extractor-model library; you may need to upgrade your software`);
+            }
+        }
+        const tsdocConfiguration = new TSDocConfiguration();
+        if (versionToDeserialize >= ApiJsonSchemaVersion.V_1004) {
+            const tsdocConfigFile = TSDocConfigFile.loadFromObject(jsonObject.metadata.tsdocConfig);
+            if (tsdocConfigFile.hasErrors) {
+                throw new Error(`Error loading ${apiJsonFilename}:\n` + tsdocConfigFile.getErrorSummary());
+            }
+            tsdocConfigFile.configureParser(tsdocConfiguration);
+        }
+        const context = new DeserializerContext({
+            apiJsonFilename,
+            toolPackage: jsonObject.metadata.toolPackage,
+            toolVersion: jsonObject.metadata.toolVersion,
+            versionToDeserialize: versionToDeserialize,
+            tsdocConfiguration
+        });
+        return ApiItem.deserialize(jsonObject, context);
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Package;
+    }
+    /** @override */
+    get containerKey() {
+        // No prefix needed, because ApiPackage is the only possible member of an ApiModel
+        return this.name;
+    }
+    get entryPoints() {
+        return this.members;
+    }
+    /**
+     * The TSDoc configuration that was used when analyzing the API for this package.
+     *
+     * @remarks
+     *
+     * Normally this configuration is loaded from the project's tsdoc.json file.  It is stored
+     * in the .api.json file so that doc comments can be parsed accurately when loading the file.
+     */
+    get tsdocConfiguration() {
+        return this._tsdocConfiguration;
+    }
+    get projectFolderUrl() {
+        return this._projectFolderUrl;
+    }
+    /** @override */
+    addMember(member) {
+        if (member.kind !== ApiItemKind.EntryPoint) {
+            throw new Error('Only items of type ApiEntryPoint may be added to an ApiPackage');
+        }
+        super.addMember(member);
+    }
+    findEntryPointsByPath(importPath) {
+        return this.findMembersByName(importPath);
+    }
+    saveToJsonFile(apiJsonFilename, options) {
+        if (!options) {
+            options = {};
+        }
+        const packageJson = PackageJsonLookup.loadOwnPackageJson(__dirname);
+        const tsdocConfigFile = TSDocConfigFile.loadFromParser(this.tsdocConfiguration);
+        const tsdocConfig = tsdocConfigFile.saveToObject();
+        const jsonObject = {
+            metadata: {
+                toolPackage: options.toolPackage || packageJson.name,
+                // In test mode, we don't write the real version, since that would cause spurious diffs whenever
+                // the version is bumped.  Instead we write a placeholder string.
+                toolVersion: options.testMode ? '[test mode]' : options.toolVersion || packageJson.version,
+                schemaVersion: ApiJsonSchemaVersion.LATEST,
+                oldestForwardsCompatibleVersion: ApiJsonSchemaVersion.OLDEST_FORWARDS_COMPATIBLE,
+                tsdocConfig
+            }
+        };
+        if (this.projectFolderUrl) {
+            jsonObject.projectFolderUrl = this.projectFolderUrl;
+        }
+        this.serializeInto(jsonObject);
+        JsonFile.save(jsonObject, apiJsonFilename, options);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        return DeclarationReference.package(this.name);
+    }
+}
+//# sourceMappingURL=ApiPackage.js.map

package/lib-esm/model/ApiPackage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPackage.js","sourceRoot":"","sources":["../../src/model/ApiPackage.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yDAAyD,CAAC;AAC/F,OAAO,EACL,QAAQ,EAER,iBAAiB,EAGlB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,WAAW,EAAqB,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,qBAAqB,EAAsC,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAkC,MAAM,4BAA4B,CAAC;AAE/F,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAsGlF;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAW,SAAQ,qBAAqB,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAIpF,YAAmB,OAA2B;QAC5C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;QACtD,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACpD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAoC,EACpC,OAA4B,EAC5B,UAA2B;QAE3B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;IACzD,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,eAAuB;QACpD,MAAM,UAAU,GAAoB,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEnE,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,OAAO,UAAU,CAAC,QAAQ,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;YACjG,MAAM,IAAI,KAAK,CACb,iBAAiB,eAAe,GAAG;gBACjC,+FAA+F,CAClG,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAW,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC;QAEhE,IAAI,aAAa,GAAG,oBAAoB,CAAC,gBAAgB,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CACb,iBAAiB,eAAe,GAAG;gBACjC,gCAAgC,aAAa,GAAG;gBAChD,YAAY,oBAAoB,CAAC,gBAAgB,+CAA+C,CACnG,CAAC;QACJ,CAAC;QAED,IAAI,+BAA+B,GAAW,aAAa,CAAC;QAC5D,IAAI,UAAU,CAAC,QAAQ,CAAC,+BAA+B,EAAE,CAAC;YACxD,eAAe;YACf,IAAI,UAAU,CAAC,QAAQ,CAAC,+BAA+B,GAAG,aAAa,EAAE,CAAC;gBACxE,MAAM,IAAI,KAAK,CACb,iBAAiB,eAAe,GAAG;oBACjC,+FAA+F,CAClG,CAAC;YACJ,CAAC;YACD,+BAA+B,GAAG,UAAU,CAAC,QAAQ,CAAC,+BAA+B,CAAC;QACxF,CAAC;QAED,IAAI,oBAAoB,GAAW,aAAa,CAAC;QACjD,IAAI,oBAAoB,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC;YACvD,oFAAoF;YACpF,mDAAmD;YACnD,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAE9F,IAAI,oBAAoB,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC;gBACvD,sBAAsB;gBACtB,MAAM,IAAI,KAAK,CACb,iBAAiB,eAAe,GAAG;oBACjC,6BAA6B,aAAa,oCAAoC;oBAC9E,yEAAyE,CAC5E,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,kBAAkB,GAAuB,IAAI,kBAAkB,EAAE,CAAC;QAExE,IAAI,oBAAoB,IAAI,oBAAoB,CAAC,MAAM,EAAE,CAAC;YACxD,MAAM,eAAe,GAAoB,eAAe,CAAC,cAAc,CACrE,UAAU,CAAC,QAAQ,CAAC,WAAW,CAChC,CAAC;YACF,IAAI,eAAe,CAAC,SAAS,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,iBAAiB,eAAe,KAAK,GAAG,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;YAC7F,CAAC;YAED,eAAe,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,OAAO,GAAwB,IAAI,mBAAmB,CAAC;YAC3D,eAAe;YACf,WAAW,EAAE,UAAU,CAAC,QAAQ,CAAC,WAAW;YAC5C,WAAW,EAAE,UAAU,CAAC,QAAQ,CAAC,WAAW;YAC5C,oBAAoB,EAAE,oBAAoB;YAC1C,kBAAkB;SACnB,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,CAAe,CAAC;IAChE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,kFAAkF;QAClF,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAuC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAED,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAED,gBAAgB;IACT,SAAS,CAAC,MAAqB;QACpC,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAEM,qBAAqB,CAAC,UAAkB;QAC7C,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAiC,CAAC;IAC5E,CAAC;IAEM,cAAc,CAAC,eAAuB,EAAE,OAAgC;QAC7E,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,MAAM,WAAW,GAAiB,iBAAiB,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAElF,MAAM,eAAe,GAAoB,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACjG,MAAM,WAAW,GAAe,eAAe,CAAC,YAAY,EAAE,CAAC;QAE/D,MAAM,UAAU,GAAoB;YAClC,QAAQ,EAAE;gBACR,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI;gBACpD,gGAAgG;gBAChG,iEAAiE;gBACjE,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,IAAI,WAAW,CAAC,OAAO;gBAC1F,aAAa,EAAE,oBAAoB,CAAC,MAAM;gBAC1C,+BAA+B,EAAE,oBAAoB,CAAC,0BAA0B;gBAChF,WAAW;aACZ;SACiB,CAAC;QAErB,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,UAAU,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/B,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,OAAO,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\nimport {\n  JsonFile,\n  type IJsonFileSaveOptions,\n  PackageJsonLookup,\n  type IPackageJson,\n  type JsonObject\n} from '@rushstack/node-core-library';\nimport { TSDocConfiguration } from '@microsoft/tsdoc';\nimport { TSDocConfigFile } from '@microsoft/tsdoc-config';\n\nimport { ApiItem, ApiItemKind, type IApiItemJson } from '../items/ApiItem';\nimport { ApiItemContainerMixin, type IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\nimport { ApiDocumentedItem, type IApiDocumentedItemOptions } from '../items/ApiDocumentedItem';\nimport type { ApiEntryPoint } from './ApiEntryPoint';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport { DeserializerContext, ApiJsonSchemaVersion } from './DeserializerContext';\n\n/**\n * Constructor options for {@link ApiPackage}.\n * @public\n */\nexport interface IApiPackageOptions\n  extends IApiItemContainerMixinOptions,\n    IApiNameMixinOptions,\n    IApiDocumentedItemOptions {\n  tsdocConfiguration: TSDocConfiguration;\n  projectFolderUrl?: string;\n}\n\nexport interface IApiPackageMetadataJson {\n  /**\n   * The NPM package name for the tool that wrote the *.api.json file.\n   * For informational purposes only.\n   */\n  toolPackage: string;\n\n  /**\n   * The NPM package version for the tool that wrote the *.api.json file.\n   * For informational purposes only.\n   */\n  toolVersion: string;\n\n  /**\n   * The schema version for the .api.json file format.  Used for determining whether the file format is\n   * supported, and for backwards compatibility.\n   */\n  schemaVersion: ApiJsonSchemaVersion;\n\n  /**\n   * To support forwards compatibility, the `oldestForwardsCompatibleVersion` field tracks the oldest schema version\n   * whose corresponding deserializer could safely load this file.\n   *\n   * @remarks\n   * Normally api-extractor-model should refuse to load a schema version that is newer than the latest version\n   * that its deserializer understands.  However, sometimes a schema change may merely introduce some new fields\n   * without modifying or removing any existing fields.  In this case, an older api-extractor-model library can\n   * safely deserialize the newer version (by ignoring the extra fields that it doesn't recognize).  The newer\n   * serializer can use this field to communicate that.\n   *\n   * If present, the `oldestForwardsCompatibleVersion` must be less than or equal to\n   * `IApiPackageMetadataJson.schemaVersion`.\n   */\n  oldestForwardsCompatibleVersion?: ApiJsonSchemaVersion;\n\n  /**\n   * The TSDoc configuration that was used when analyzing the API for this package.\n   *\n   * @remarks\n   *\n   * The structure of this objet is defined by the `@microsoft/tsdoc-config` library.\n   * Normally this configuration is loaded from the project's tsdoc.json file.  It is stored\n   * in the .api.json file so that doc comments can be parsed accurately when loading the file.\n   */\n  tsdocConfig: JsonObject;\n}\n\nexport interface IApiPackageJson extends IApiItemJson {\n  /**\n   * A file header that stores metadata about the tool that wrote the *.api.json file.\n   */\n  metadata: IApiPackageMetadataJson;\n\n  /**\n   * The base URL where the project's source code can be viewed on a website such as GitHub or\n   * Azure DevOps. This URL path corresponds to the `<projectFolder>` path on disk. Provided via the\n   * `api-extractor.json` config.\n   */\n  projectFolderUrl?: string;\n}\n\n/**\n * Options for {@link ApiPackage.saveToJsonFile}.\n * @public\n */\nexport interface IApiPackageSaveOptions extends IJsonFileSaveOptions {\n  /**\n   * Optionally specifies a value for the \"toolPackage\" field in the output .api.json data file;\n   * otherwise, the value will be \"api-extractor-model\".\n   */\n  toolPackage?: string;\n\n  /**\n   * Optionally specifies a value for the \"toolVersion\" field in the output .api.json data file;\n   * otherwise, the value will be the current version of the api-extractor-model package.\n   */\n  toolVersion?: string;\n\n  /**\n   * Set to true only when invoking API Extractor's test harness.\n   *\n   * @remarks\n   * When `testMode` is true, the `toolVersion` field in the .api.json file is assigned an empty string\n   * to prevent spurious diffs in output files tracked for tests.\n   */\n  testMode?: boolean;\n}\n\n/**\n * Represents an NPM package containing API declarations.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * @public\n */\nexport class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumentedItem)) {\n  private readonly _tsdocConfiguration: TSDocConfiguration;\n  private readonly _projectFolderUrl?: string;\n\n  public constructor(options: IApiPackageOptions) {\n    super(options);\n\n    this._tsdocConfiguration = options.tsdocConfiguration;\n    this._projectFolderUrl = options.projectFolderUrl;\n  }\n\n  /** @override */\n  public static onDeserializeInto(\n    options: Partial<IApiPackageOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiPackageJson\n  ): void {\n    super.onDeserializeInto(options, context, jsonObject);\n\n    options.projectFolderUrl = jsonObject.projectFolderUrl;\n  }\n\n  public static loadFromJsonFile(apiJsonFilename: string): ApiPackage {\n    const jsonObject: IApiPackageJson = JsonFile.load(apiJsonFilename);\n\n    if (!jsonObject || !jsonObject.metadata || typeof jsonObject.metadata.schemaVersion !== 'number') {\n      throw new Error(\n        `Error loading ${apiJsonFilename}:` +\n          `\\nThe file format is not recognized; the \"metadata.schemaVersion\" field is missing or invalid`\n      );\n    }\n\n    const schemaVersion: number = jsonObject.metadata.schemaVersion;\n\n    if (schemaVersion < ApiJsonSchemaVersion.OLDEST_SUPPORTED) {\n      throw new Error(\n        `Error loading ${apiJsonFilename}:` +\n          `\\nThe file format is version ${schemaVersion},` +\n          ` whereas ${ApiJsonSchemaVersion.OLDEST_SUPPORTED} is the oldest version supported by this tool`\n      );\n    }\n\n    let oldestForwardsCompatibleVersion: number = schemaVersion;\n    if (jsonObject.metadata.oldestForwardsCompatibleVersion) {\n      // Sanity check\n      if (jsonObject.metadata.oldestForwardsCompatibleVersion > schemaVersion) {\n        throw new Error(\n          `Error loading ${apiJsonFilename}:` +\n            `\\nInvalid file format; \"oldestForwardsCompatibleVersion\" cannot be newer than \"schemaVersion\"`\n        );\n      }\n      oldestForwardsCompatibleVersion = jsonObject.metadata.oldestForwardsCompatibleVersion;\n    }\n\n    let versionToDeserialize: number = schemaVersion;\n    if (versionToDeserialize > ApiJsonSchemaVersion.LATEST) {\n      // If the file format is too new, can we treat it as some earlier compatible version\n      // as indicated by oldestForwardsCompatibleVersion?\n      versionToDeserialize = Math.max(oldestForwardsCompatibleVersion, ApiJsonSchemaVersion.LATEST);\n\n      if (versionToDeserialize > ApiJsonSchemaVersion.LATEST) {\n        // Nope, still too new\n        throw new Error(\n          `Error loading ${apiJsonFilename}:` +\n            `\\nThe file format version ${schemaVersion} was written by a newer release of` +\n            ` the api-extractor-model library; you may need to upgrade your software`\n        );\n      }\n    }\n\n    const tsdocConfiguration: TSDocConfiguration = new TSDocConfiguration();\n\n    if (versionToDeserialize >= ApiJsonSchemaVersion.V_1004) {\n      const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromObject(\n        jsonObject.metadata.tsdocConfig\n      );\n      if (tsdocConfigFile.hasErrors) {\n        throw new Error(`Error loading ${apiJsonFilename}:\\n` + tsdocConfigFile.getErrorSummary());\n      }\n\n      tsdocConfigFile.configureParser(tsdocConfiguration);\n    }\n\n    const context: DeserializerContext = new DeserializerContext({\n      apiJsonFilename,\n      toolPackage: jsonObject.metadata.toolPackage,\n      toolVersion: jsonObject.metadata.toolVersion,\n      versionToDeserialize: versionToDeserialize,\n      tsdocConfiguration\n    });\n\n    return ApiItem.deserialize(jsonObject, context) as ApiPackage;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Package;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    // No prefix needed, because ApiPackage is the only possible member of an ApiModel\n    return this.name;\n  }\n\n  public get entryPoints(): ReadonlyArray<ApiEntryPoint> {\n    return this.members as ReadonlyArray<ApiEntryPoint>;\n  }\n\n  /**\n   * The TSDoc configuration that was used when analyzing the API for this package.\n   *\n   * @remarks\n   *\n   * Normally this configuration is loaded from the project's tsdoc.json file.  It is stored\n   * in the .api.json file so that doc comments can be parsed accurately when loading the file.\n   */\n  public get tsdocConfiguration(): TSDocConfiguration {\n    return this._tsdocConfiguration;\n  }\n\n  public get projectFolderUrl(): string | undefined {\n    return this._projectFolderUrl;\n  }\n\n  /** @override */\n  public addMember(member: ApiEntryPoint): void {\n    if (member.kind !== ApiItemKind.EntryPoint) {\n      throw new Error('Only items of type ApiEntryPoint may be added to an ApiPackage');\n    }\n    super.addMember(member);\n  }\n\n  public findEntryPointsByPath(importPath: string): ReadonlyArray<ApiEntryPoint> {\n    return this.findMembersByName(importPath) as ReadonlyArray<ApiEntryPoint>;\n  }\n\n  public saveToJsonFile(apiJsonFilename: string, options?: IApiPackageSaveOptions): void {\n    if (!options) {\n      options = {};\n    }\n\n    const packageJson: IPackageJson = PackageJsonLookup.loadOwnPackageJson(__dirname);\n\n    const tsdocConfigFile: TSDocConfigFile = TSDocConfigFile.loadFromParser(this.tsdocConfiguration);\n    const tsdocConfig: JsonObject = tsdocConfigFile.saveToObject();\n\n    const jsonObject: IApiPackageJson = {\n      metadata: {\n        toolPackage: options.toolPackage || packageJson.name,\n        // In test mode, we don't write the real version, since that would cause spurious diffs whenever\n        // the version is bumped.  Instead we write a placeholder string.\n        toolVersion: options.testMode ? '[test mode]' : options.toolVersion || packageJson.version,\n        schemaVersion: ApiJsonSchemaVersion.LATEST,\n        oldestForwardsCompatibleVersion: ApiJsonSchemaVersion.OLDEST_FORWARDS_COMPATIBLE,\n        tsdocConfig\n      }\n    } as IApiPackageJson;\n\n    if (this.projectFolderUrl) {\n      jsonObject.projectFolderUrl = this.projectFolderUrl;\n    }\n\n    this.serializeInto(jsonObject);\n    JsonFile.save(jsonObject, apiJsonFilename, options);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    return DeclarationReference.package(this.name);\n  }\n}\n"]}

package/lib-esm/model/ApiProperty.js

@@ -0,0 +1,72 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiAbstractMixin } from '../mixins/ApiAbstractMixin';
+import { ApiProtectedMixin } from '../mixins/ApiProtectedMixin';
+import { ApiStaticMixin } from '../mixins/ApiStaticMixin';
+import { ApiInitializerMixin } from '../mixins/ApiInitializerMixin';
+import { ApiPropertyItem } from '../items/ApiPropertyItem';
+/**
+ * Represents a TypeScript property declaration that belongs to an `ApiClass`.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiProperty` represents a TypeScript declaration such as the `width` and `height` members in this example:
+ *
+ * ```ts
+ * export class Widget {
+ *   public width: number = 100;
+ *
+ *   public get height(): number {
+ *     if (this.isSquashed()) {
+ *       return 0;
+ *     } else {
+ *       return this.clientArea.height;
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * Note that member variables are also considered to be properties.
+ *
+ * If the property has both a getter function and setter function, they will be represented by a single `ApiProperty`
+ * and must have a single documentation comment.
+ *
+ * Compare with {@link ApiPropertySignature}, which represents a property belonging to an interface.
+ * For example, a class property can be `static` but an interface property cannot.
+ *
+ * @public
+ */
+export class ApiProperty extends ApiAbstractMixin(ApiProtectedMixin(ApiStaticMixin(ApiInitializerMixin(ApiPropertyItem)))) {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name, isStatic) {
+        if (isStatic) {
+            return `${name}|${ApiItemKind.Property}|static`;
+        }
+        else {
+            return `${name}|${ApiItemKind.Property}|instance`;
+        }
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Property;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiProperty.getContainerKey(this.name, this.isStatic);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent)
+            .withMeaning(Meaning.Member);
+    }
+}
+//# sourceMappingURL=ApiProperty.js.map

package/lib-esm/model/ApiProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiProperty.js","sourceRoot":"","sources":["../../src/model/ApiProperty.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAiC,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAAE,iBAAiB,EAAkC,MAAM,6BAA6B,CAAC;AAChG,OAAO,EAAE,cAAc,EAA+B,MAAM,0BAA0B,CAAC;AACvF,OAAO,EAAE,mBAAmB,EAAoC,MAAM,+BAA+B,CAAC;AACtG,OAAO,EAAE,eAAe,EAAgC,MAAM,0BAA0B,CAAC;AAazF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,OAAO,WAAY,SAAQ,gBAAgB,CAC/C,iBAAiB,CAAC,cAAc,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC,CACxE;IACC,YAAmB,OAA4B;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,QAAiB;QAC3D,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,QAAQ,SAAS,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,QAAQ,WAAW,CAAC;QACpD,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC;aACzF,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport { ApiAbstractMixin, type IApiAbstractMixinOptions } from '../mixins/ApiAbstractMixin';\nimport { ApiProtectedMixin, type IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin';\nimport { ApiStaticMixin, type IApiStaticMixinOptions } from '../mixins/ApiStaticMixin';\nimport { ApiInitializerMixin, type IApiInitializerMixinOptions } from '../mixins/ApiInitializerMixin';\nimport { ApiPropertyItem, type IApiPropertyItemOptions } from '../items/ApiPropertyItem';\n\n/**\n * Constructor options for {@link ApiProperty}.\n * @public\n */\nexport interface IApiPropertyOptions\n  extends IApiPropertyItemOptions,\n    IApiAbstractMixinOptions,\n    IApiProtectedMixinOptions,\n    IApiStaticMixinOptions,\n    IApiInitializerMixinOptions {}\n\n/**\n * Represents a TypeScript property declaration that belongs to an `ApiClass`.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiProperty` represents a TypeScript declaration such as the `width` and `height` members in this example:\n *\n * ```ts\n * export class Widget {\n *   public width: number = 100;\n *\n *   public get height(): number {\n *     if (this.isSquashed()) {\n *       return 0;\n *     } else {\n *       return this.clientArea.height;\n *     }\n *   }\n * }\n * ```\n *\n * Note that member variables are also considered to be properties.\n *\n * If the property has both a getter function and setter function, they will be represented by a single `ApiProperty`\n * and must have a single documentation comment.\n *\n * Compare with {@link ApiPropertySignature}, which represents a property belonging to an interface.\n * For example, a class property can be `static` but an interface property cannot.\n *\n * @public\n */\nexport class ApiProperty extends ApiAbstractMixin(\n  ApiProtectedMixin(ApiStaticMixin(ApiInitializerMixin(ApiPropertyItem)))\n) {\n  public constructor(options: IApiPropertyOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string, isStatic: boolean): string {\n    if (isStatic) {\n      return `${name}|${ApiItemKind.Property}|static`;\n    } else {\n      return `${name}|${ApiItemKind.Property}|instance`;\n    }\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Property;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiProperty.getContainerKey(this.name, this.isStatic);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent)\n      .withMeaning(Meaning.Member);\n  }\n}\n"]}

package/lib-esm/model/ApiPropertySignature.js

@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiPropertyItem } from '../items/ApiPropertyItem';
+/**
+ * Represents a TypeScript property declaration that belongs to an `ApiInterface`.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiPropertySignature` represents a TypeScript declaration such as the `width` and `height` members in this example:
+ *
+ * ```ts
+ * export interface IWidget {
+ *   readonly width: number;
+ *   height: number;
+ * }
+ * ```
+ *
+ * Compare with {@link ApiProperty}, which represents a property belonging to a class.
+ * For example, a class property can be `static` but an interface property cannot.
+ *
+ * @public
+ */
+export class ApiPropertySignature extends ApiPropertyItem {
+    constructor(options) {
+        super(options);
+    }
+    static getContainerKey(name) {
+        return `${name}|${ApiItemKind.PropertySignature}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.PropertySignature;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiPropertySignature.getContainerKey(this.name);
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(Navigation.Members, nameComponent)
+            .withMeaning(Meaning.Member);
+    }
+}
+//# sourceMappingURL=ApiPropertySignature.js.map

package/lib-esm/model/ApiPropertySignature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPropertySignature.js","sourceRoot":"","sources":["../../src/model/ApiPropertySignature.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAgC,MAAM,0BAA0B,CAAC;AAQzF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IACvD,YAAmB,OAAqC;QACtD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,iBAAiB,EAAE,CAAC;IACpD,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,iBAAiB,CAAC;IACvC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC;aACpD,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport { ApiPropertyItem, type IApiPropertyItemOptions } from '../items/ApiPropertyItem';\n\n/**\n * Constructor options for {@link ApiPropertySignature}.\n * @public\n */\nexport interface IApiPropertySignatureOptions extends IApiPropertyItemOptions {}\n\n/**\n * Represents a TypeScript property declaration that belongs to an `ApiInterface`.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiPropertySignature` represents a TypeScript declaration such as the `width` and `height` members in this example:\n *\n * ```ts\n * export interface IWidget {\n *   readonly width: number;\n *   height: number;\n * }\n * ```\n *\n * Compare with {@link ApiProperty}, which represents a property belonging to a class.\n * For example, a class property can be `static` but an interface property cannot.\n *\n * @public\n */\nexport class ApiPropertySignature extends ApiPropertyItem {\n  public constructor(options: IApiPropertySignatureOptions) {\n    super(options);\n  }\n\n  public static getContainerKey(name: string): string {\n    return `${name}|${ApiItemKind.PropertySignature}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.PropertySignature;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiPropertySignature.getContainerKey(this.name);\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(Navigation.Members, nameComponent)\n      .withMeaning(Meaning.Member);\n  }\n}\n"]}

package/lib-esm/model/ApiTypeAlias.js

@@ -0,0 +1,71 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiTypeParameterListMixin } from '../mixins/ApiTypeParameterListMixin';
+import { ApiExportedMixin } from '../mixins/ApiExportedMixin';
+/**
+ * Represents a TypeScript type alias declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiTypeAlias` represents a definition such as one of these examples:
+ *
+ * ```ts
+ * // A union type:
+ * export type Shape = Square | Triangle | Circle;
+ *
+ * // A generic type alias:
+ * export type BoxedValue<T> = { value: T };
+ *
+ * export type BoxedArray<T> = { array: T[] };
+ *
+ * // A conditional type alias:
+ * export type Boxed<T> = T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;
+ *
+ * ```
+ *
+ * @public
+ */
+export class ApiTypeAlias extends ApiTypeParameterListMixin(ApiNameMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))) {
+    constructor(options) {
+        super(options);
+        this.typeExcerpt = this.buildExcerpt(options.typeTokenRange);
+    }
+    /** @override */
+    static onDeserializeInto(options, context, jsonObject) {
+        super.onDeserializeInto(options, context, jsonObject);
+        options.typeTokenRange = jsonObject.typeTokenRange;
+    }
+    static getContainerKey(name) {
+        return `${name}|${ApiItemKind.TypeAlias}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.TypeAlias;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiTypeAlias.getContainerKey(this.name);
+    }
+    /** @override */
+    serializeInto(jsonObject) {
+        super.serializeInto(jsonObject);
+        jsonObject.typeTokenRange = this.typeExcerpt.tokenRange;
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        const navigation = this.isExported ? Navigation.Exports : Navigation.Locals;
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(navigation, nameComponent)
+            .withMeaning(Meaning.TypeAlias);
+    }
+}
+//# sourceMappingURL=ApiTypeAlias.js.map

package/lib-esm/model/ApiTypeAlias.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiTypeAlias.js","sourceRoot":"","sources":["../../src/model/ApiTypeAlias.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAGjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACL,eAAe,EAGhB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EACL,yBAAyB,EAG1B,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAGL,gBAAgB,EACjB,MAAM,4BAA4B,CAAC;AAsBpC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,YAAa,SAAQ,yBAAyB,CACzD,YAAY,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CACpE;IAcC,YAAmB,OAA6B;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAsC,EACtC,OAA4B,EAC5B,UAA6B;QAE7B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACrD,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;IAC5C,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAsC;QACzD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;IAC1D,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,UAAU,GAAe,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;QACxF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC;aAC5C,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport type { Excerpt, IExcerptTokenRange } from '../mixins/Excerpt';\nimport { ApiItemKind } from '../items/ApiItem';\nimport {\n  ApiDeclaredItem,\n  type IApiDeclaredItemOptions,\n  type IApiDeclaredItemJson\n} from '../items/ApiDeclaredItem';\nimport { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport {\n  ApiTypeParameterListMixin,\n  type IApiTypeParameterListMixinOptions,\n  type IApiTypeParameterListMixinJson\n} from '../mixins/ApiTypeParameterListMixin';\nimport type { DeserializerContext } from './DeserializerContext';\nimport {\n  type IApiExportedMixinJson,\n  type IApiExportedMixinOptions,\n  ApiExportedMixin\n} from '../mixins/ApiExportedMixin';\n\n/**\n * Constructor options for {@link ApiTypeAlias}.\n * @public\n */\nexport interface IApiTypeAliasOptions\n  extends IApiNameMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiTypeParameterListMixinOptions,\n    IApiExportedMixinOptions {\n  typeTokenRange: IExcerptTokenRange;\n}\n\nexport interface IApiTypeAliasJson\n  extends IApiDeclaredItemJson,\n    IApiTypeParameterListMixinJson,\n    IApiExportedMixinJson {\n  typeTokenRange: IExcerptTokenRange;\n}\n\n/**\n * Represents a TypeScript type alias declaration.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiTypeAlias` represents a definition such as one of these examples:\n *\n * ```ts\n * // A union type:\n * export type Shape = Square | Triangle | Circle;\n *\n * // A generic type alias:\n * export type BoxedValue<T> = { value: T };\n *\n * export type BoxedArray<T> = { array: T[] };\n *\n * // A conditional type alias:\n * export type Boxed<T> = T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;\n *\n * ```\n *\n * @public\n */\nexport class ApiTypeAlias extends ApiTypeParameterListMixin(\n  ApiNameMixin(ApiReleaseTagMixin(ApiExportedMixin(ApiDeclaredItem)))\n) {\n  /**\n   * An {@link Excerpt} that describes the type of the alias.\n   *\n   * @remarks\n   * In the example below, the `typeExcerpt` would correspond to the subexpression\n   * `T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;`:\n   *\n   * ```ts\n   * export type Boxed<T> = T extends any[] ? BoxedArray<T[number]> : BoxedValue<T>;\n   * ```\n   */\n  public readonly typeExcerpt: Excerpt;\n\n  public constructor(options: IApiTypeAliasOptions) {\n    super(options);\n\n    this.typeExcerpt = this.buildExcerpt(options.typeTokenRange);\n  }\n\n  /** @override */\n  public static onDeserializeInto(\n    options: Partial<IApiTypeAliasOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiTypeAliasJson\n  ): void {\n    super.onDeserializeInto(options, context, jsonObject);\n\n    options.typeTokenRange = jsonObject.typeTokenRange;\n  }\n\n  public static getContainerKey(name: string): string {\n    return `${name}|${ApiItemKind.TypeAlias}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.TypeAlias;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiTypeAlias.getContainerKey(this.name);\n  }\n\n  /** @override */\n  public serializeInto(jsonObject: Partial<IApiTypeAliasJson>): void {\n    super.serializeInto(jsonObject);\n\n    jsonObject.typeTokenRange = this.typeExcerpt.tokenRange;\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    const navigation: Navigation = this.isExported ? Navigation.Exports : Navigation.Locals;\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(navigation, nameComponent)\n      .withMeaning(Meaning.TypeAlias);\n  }\n}\n"]}

package/lib-esm/model/ApiVariable.js

@@ -0,0 +1,66 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiDeclaredItem } from '../items/ApiDeclaredItem';
+import { ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
+import { ApiReadonlyMixin } from '../mixins/ApiReadonlyMixin';
+import { ApiNameMixin } from '../mixins/ApiNameMixin';
+import { ApiInitializerMixin } from '../mixins/ApiInitializerMixin';
+import { ApiExportedMixin } from '../mixins/ApiExportedMixin';
+/**
+ * Represents a TypeScript variable declaration.
+ *
+ * @remarks
+ *
+ * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
+ * API declarations.
+ *
+ * `ApiVariable` represents an exported `const` or `let` object such as these examples:
+ *
+ * ```ts
+ * // A variable declaration
+ * export let verboseLogging: boolean;
+ *
+ * // A constant variable declaration with an initializer
+ * export const canvas: IWidget = createCanvas();
+ * ```
+ *
+ * @public
+ */
+export class ApiVariable extends ApiNameMixin(ApiReleaseTagMixin(ApiReadonlyMixin(ApiInitializerMixin(ApiExportedMixin(ApiDeclaredItem))))) {
+    constructor(options) {
+        super(options);
+        this.variableTypeExcerpt = this.buildExcerpt(options.variableTypeTokenRange);
+    }
+    /** @override */
+    static onDeserializeInto(options, context, jsonObject) {
+        super.onDeserializeInto(options, context, jsonObject);
+        options.variableTypeTokenRange = jsonObject.variableTypeTokenRange;
+    }
+    static getContainerKey(name) {
+        return `${name}|${ApiItemKind.Variable}`;
+    }
+    /** @override */
+    get kind() {
+        return ApiItemKind.Variable;
+    }
+    /** @override */
+    get containerKey() {
+        return ApiVariable.getContainerKey(this.name);
+    }
+    /** @override */
+    serializeInto(jsonObject) {
+        super.serializeInto(jsonObject);
+        jsonObject.variableTypeTokenRange = this.variableTypeExcerpt.tokenRange;
+    }
+    /** @beta @override */
+    buildCanonicalReference() {
+        const nameComponent = DeclarationReference.parseComponent(this.name);
+        const navigation = this.isExported ? Navigation.Exports : Navigation.Locals;
+        return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())
+            .addNavigationStep(navigation, nameComponent)
+            .withMeaning(Meaning.Variable);
+    }
+}
+//# sourceMappingURL=ApiVariable.js.map

package/lib-esm/model/ApiVariable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiVariable.js","sourceRoot":"","sources":["../../src/model/ApiVariable.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EACL,oBAAoB,EACpB,OAAO,EACP,UAAU,EAEX,MAAM,yDAAyD,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACL,eAAe,EAGhB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAmC,MAAM,8BAA8B,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAiC,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAA6B,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAoC,MAAM,+BAA+B,CAAC;AAGtG,OAAO,EAGL,gBAAgB,EACjB,MAAM,4BAA4B,CAAC;AAoBpC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY,CAC3C,kBAAkB,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAC7F;IAMC,YAAmB,OAA4B;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC/E,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAqC,EACrC,OAA4B,EAC5B,UAA4B;QAE5B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,sBAAsB,GAAG,UAAU,CAAC,sBAAsB,CAAC;IACrE,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;IAC3C,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,OAAO,WAAW,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAqC;QACxD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,UAAU,CAAC,sBAAsB,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC;IAC1E,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,UAAU,GAAe,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC;QACxF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC;aAC5C,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport {\n  DeclarationReference,\n  Meaning,\n  Navigation,\n  type Component\n} from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';\n\nimport { ApiItemKind } from '../items/ApiItem';\nimport {\n  ApiDeclaredItem,\n  type IApiDeclaredItemOptions,\n  type IApiDeclaredItemJson\n} from '../items/ApiDeclaredItem';\nimport { ApiReleaseTagMixin, type IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\nimport { ApiReadonlyMixin, type IApiReadonlyMixinOptions } from '../mixins/ApiReadonlyMixin';\nimport { type IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\nimport { ApiInitializerMixin, type IApiInitializerMixinOptions } from '../mixins/ApiInitializerMixin';\nimport type { IExcerptTokenRange, Excerpt } from '../mixins/Excerpt';\nimport type { DeserializerContext } from './DeserializerContext';\nimport {\n  type IApiExportedMixinJson,\n  type IApiExportedMixinOptions,\n  ApiExportedMixin\n} from '../mixins/ApiExportedMixin';\n\n/**\n * Constructor options for {@link ApiVariable}.\n * @public\n */\nexport interface IApiVariableOptions\n  extends IApiNameMixinOptions,\n    IApiReleaseTagMixinOptions,\n    IApiReadonlyMixinOptions,\n    IApiDeclaredItemOptions,\n    IApiInitializerMixinOptions,\n    IApiExportedMixinOptions {\n  variableTypeTokenRange: IExcerptTokenRange;\n}\n\nexport interface IApiVariableJson extends IApiDeclaredItemJson, IApiExportedMixinJson {\n  variableTypeTokenRange: IExcerptTokenRange;\n}\n\n/**\n * Represents a TypeScript variable declaration.\n *\n * @remarks\n *\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\n * API declarations.\n *\n * `ApiVariable` represents an exported `const` or `let` object such as these examples:\n *\n * ```ts\n * // A variable declaration\n * export let verboseLogging: boolean;\n *\n * // A constant variable declaration with an initializer\n * export const canvas: IWidget = createCanvas();\n * ```\n *\n * @public\n */\nexport class ApiVariable extends ApiNameMixin(\n  ApiReleaseTagMixin(ApiReadonlyMixin(ApiInitializerMixin(ApiExportedMixin(ApiDeclaredItem))))\n) {\n  /**\n   * An {@link Excerpt} that describes the type of the variable.\n   */\n  public readonly variableTypeExcerpt: Excerpt;\n\n  public constructor(options: IApiVariableOptions) {\n    super(options);\n\n    this.variableTypeExcerpt = this.buildExcerpt(options.variableTypeTokenRange);\n  }\n\n  /** @override */\n  public static onDeserializeInto(\n    options: Partial<IApiVariableOptions>,\n    context: DeserializerContext,\n    jsonObject: IApiVariableJson\n  ): void {\n    super.onDeserializeInto(options, context, jsonObject);\n\n    options.variableTypeTokenRange = jsonObject.variableTypeTokenRange;\n  }\n\n  public static getContainerKey(name: string): string {\n    return `${name}|${ApiItemKind.Variable}`;\n  }\n\n  /** @override */\n  public get kind(): ApiItemKind {\n    return ApiItemKind.Variable;\n  }\n\n  /** @override */\n  public get containerKey(): string {\n    return ApiVariable.getContainerKey(this.name);\n  }\n\n  /** @override */\n  public serializeInto(jsonObject: Partial<IApiVariableJson>): void {\n    super.serializeInto(jsonObject);\n\n    jsonObject.variableTypeTokenRange = this.variableTypeExcerpt.tokenRange;\n  }\n\n  /** @beta @override */\n  public buildCanonicalReference(): DeclarationReference {\n    const nameComponent: Component = DeclarationReference.parseComponent(this.name);\n    const navigation: Navigation = this.isExported ? Navigation.Exports : Navigation.Locals;\n    return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\n      .addNavigationStep(navigation, nameComponent)\n      .withMeaning(Meaning.Variable);\n  }\n}\n"]}

package/lib-esm/model/Deserializer.js

@@ -0,0 +1,88 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { ApiItemKind } from '../items/ApiItem';
+import { ApiClass } from './ApiClass';
+import { ApiEntryPoint } from './ApiEntryPoint';
+import { ApiMethod } from './ApiMethod';
+import { ApiModel } from './ApiModel';
+import { ApiNamespace } from './ApiNamespace';
+import { ApiPackage } from './ApiPackage';
+import { ApiInterface } from './ApiInterface';
+import { ApiPropertySignature } from './ApiPropertySignature';
+import { ApiMethodSignature } from './ApiMethodSignature';
+import { ApiProperty } from './ApiProperty';
+import { ApiEnumMember } from './ApiEnumMember';
+import { ApiEnum } from './ApiEnum';
+import { ApiConstructor } from './ApiConstructor';
+import { ApiConstructSignature } from './ApiConstructSignature';
+import { ApiFunction } from './ApiFunction';
+import { ApiCallSignature } from './ApiCallSignature';
+import { ApiIndexSignature } from './ApiIndexSignature';
+import { ApiTypeAlias } from './ApiTypeAlias';
+import { ApiVariable } from './ApiVariable';
+export class Deserializer {
+    static deserialize(context, jsonObject) {
+        const options = {};
+        switch (jsonObject.kind) {
+            case ApiItemKind.Class:
+                ApiClass.onDeserializeInto(options, context, jsonObject);
+                return new ApiClass(options);
+            case ApiItemKind.CallSignature:
+                ApiCallSignature.onDeserializeInto(options, context, jsonObject);
+                return new ApiCallSignature(options);
+            case ApiItemKind.Constructor:
+                ApiConstructor.onDeserializeInto(options, context, jsonObject);
+                return new ApiConstructor(options);
+            case ApiItemKind.ConstructSignature:
+                ApiConstructSignature.onDeserializeInto(options, context, jsonObject);
+                return new ApiConstructSignature(options);
+            case ApiItemKind.EntryPoint:
+                ApiEntryPoint.onDeserializeInto(options, context, jsonObject);
+                return new ApiEntryPoint(options);
+            case ApiItemKind.Enum:
+                ApiEnum.onDeserializeInto(options, context, jsonObject);
+                return new ApiEnum(options);
+            case ApiItemKind.EnumMember:
+                ApiEnumMember.onDeserializeInto(options, context, jsonObject);
+                return new ApiEnumMember(options);
+            case ApiItemKind.Function:
+                ApiFunction.onDeserializeInto(options, context, jsonObject);
+                return new ApiFunction(options);
+            case ApiItemKind.IndexSignature:
+                ApiIndexSignature.onDeserializeInto(options, context, jsonObject);
+                return new ApiIndexSignature(options);
+            case ApiItemKind.Interface:
+                ApiInterface.onDeserializeInto(options, context, jsonObject);
+                return new ApiInterface(options);
+            case ApiItemKind.Method:
+                ApiMethod.onDeserializeInto(options, context, jsonObject);
+                return new ApiMethod(options);
+            case ApiItemKind.MethodSignature:
+                ApiMethodSignature.onDeserializeInto(options, context, jsonObject);
+                return new ApiMethodSignature(options);
+            case ApiItemKind.Model:
+                return new ApiModel();
+            case ApiItemKind.Namespace:
+                ApiNamespace.onDeserializeInto(options, context, jsonObject);
+                return new ApiNamespace(options);
+            case ApiItemKind.Package:
+                ApiPackage.onDeserializeInto(options, context, jsonObject);
+                return new ApiPackage(options);
+            case ApiItemKind.Property:
+                ApiProperty.onDeserializeInto(options, context, jsonObject);
+                return new ApiProperty(options);
+            case ApiItemKind.PropertySignature:
+                ApiPropertySignature.onDeserializeInto(options, context, jsonObject);
+                return new ApiPropertySignature(options);
+            case ApiItemKind.TypeAlias:
+                ApiTypeAlias.onDeserializeInto(options, context, jsonObject);
+                return new ApiTypeAlias(options);
+            case ApiItemKind.Variable:
+                ApiVariable.onDeserializeInto(options, context, jsonObject);
+                return new ApiVariable(options);
+            default:
+                throw new Error(`Failed to deserialize unsupported API item type ${JSON.stringify(jsonObject.kind)}`);
+        }
+    }
+}
+//# sourceMappingURL=Deserializer.js.map

package/lib-esm/model/Deserializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Deserializer.js","sourceRoot":"","sources":["../../src/model/Deserializer.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAyD,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACtG,OAAO,EAAE,QAAQ,EAA6C,MAAM,YAAY,CAAC;AACjF,OAAO,EAAE,aAAa,EAA8B,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,SAAS,EAA0B,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAA6B,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAE,UAAU,EAAiD,MAAM,cAAc,CAAC;AACzF,OAAO,EAAE,YAAY,EAAqD,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,oBAAoB,EAAqC,MAAM,wBAAwB,CAAC;AACjG,OAAO,EAAE,kBAAkB,EAAmC,MAAM,sBAAsB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAA4B,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,aAAa,EAA8B,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,OAAO,EAAwB,MAAM,WAAW,CAAC;AAE1D,OAAO,EAAE,cAAc,EAA+B,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,qBAAqB,EAAsC,MAAM,yBAAyB,CAAC;AACpG,OAAO,EAAE,WAAW,EAA4B,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAiC,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,iBAAiB,EAAkC,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAqD,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,WAAW,EAAmD,MAAM,eAAe,CAAC;AAI7F,MAAM,OAAO,YAAY;IAChB,MAAM,CAAC,WAAW,CAAC,OAA4B,EAAE,UAAwB;QAC9E,MAAM,OAAO,GAA6B,EAAE,CAAC;QAE7C,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACxB,KAAK,WAAW,CAAC,KAAK;gBACpB,QAAQ,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAA2B,CAAC,CAAC;gBAC1E,OAAO,IAAI,QAAQ,CAAC,OAA2B,CAAC,CAAC;YACnD,KAAK,WAAW,CAAC,aAAa;gBAC5B,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBACzF,OAAO,IAAI,gBAAgB,CAAC,OAAmC,CAAC,CAAC;YACnE,KAAK,WAAW,CAAC,WAAW;gBAC1B,cAAc,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBACvF,OAAO,IAAI,cAAc,CAAC,OAAiC,CAAC,CAAC;YAC/D,KAAK,WAAW,CAAC,kBAAkB;gBACjC,qBAAqB,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBAC9F,OAAO,IAAI,qBAAqB,CAAC,OAAwC,CAAC,CAAC;YAC7E,KAAK,WAAW,CAAC,UAAU;gBACzB,aAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;gBAC9D,OAAO,IAAI,aAAa,CAAC,OAAgC,CAAC,CAAC;YAC7D,KAAK,WAAW,CAAC,IAAI;gBACnB,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBAChF,OAAO,IAAI,OAAO,CAAC,OAA0B,CAAC,CAAC;YACjD,KAAK,WAAW,CAAC,UAAU;gBACzB,aAAa,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBACtF,OAAO,IAAI,aAAa,CAAC,OAAgC,CAAC,CAAC;YAC7D,KAAK,WAAW,CAAC,QAAQ;gBACvB,WAAW,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBACpF,OAAO,IAAI,WAAW,CAAC,OAA8B,CAAC,CAAC;YACzD,KAAK,WAAW,CAAC,cAAc;gBAC7B,iBAAiB,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBAC1F,OAAO,IAAI,iBAAiB,CAAC,OAAoC,CAAC,CAAC;YACrE,KAAK,WAAW,CAAC,SAAS;gBACxB,YAAY,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAA+B,CAAC,CAAC;gBAClF,OAAO,IAAI,YAAY,CAAC,OAA+B,CAAC,CAAC;YAC3D,KAAK,WAAW,CAAC,MAAM;gBACrB,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBAClF,OAAO,IAAI,SAAS,CAAC,OAA4B,CAAC,CAAC;YACrD,KAAK,WAAW,CAAC,eAAe;gBAC9B,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBAC3F,OAAO,IAAI,kBAAkB,CAAC,OAAqC,CAAC,CAAC;YACvE,KAAK,WAAW,CAAC,KAAK;gBACpB,OAAO,IAAI,QAAQ,EAAE,CAAC;YACxB,KAAK,WAAW,CAAC,SAAS;gBACxB,YAAY,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBACrF,OAAO,IAAI,YAAY,CAAC,OAA+B,CAAC,CAAC;YAC3D,KAAK,WAAW,CAAC,OAAO;gBACtB,UAAU,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAA6B,CAAC,CAAC;gBAC9E,OAAO,IAAI,UAAU,CAAC,OAA6B,CAAC,CAAC;YACvD,KAAK,WAAW,CAAC,QAAQ;gBACvB,WAAW,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBACpF,OAAO,IAAI,WAAW,CAAC,OAA8B,CAAC,CAAC;YACzD,KAAK,WAAW,CAAC,iBAAiB;gBAChC,oBAAoB,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAkC,CAAC,CAAC;gBAC7F,OAAO,IAAI,oBAAoB,CAAC,OAAuC,CAAC,CAAC;YAC3E,KAAK,WAAW,CAAC,SAAS;gBACxB,YAAY,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAA+B,CAAC,CAAC;gBAClF,OAAO,IAAI,YAAY,CAAC,OAA+B,CAAC,CAAC;YAC3D,KAAK,WAAW,CAAC,QAAQ;gBACvB,WAAW,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAA8B,CAAC,CAAC;gBAChF,OAAO,IAAI,WAAW,CAAC,OAA8B,CAAC,CAAC;YACzD;gBACE,MAAM,IAAI,KAAK,CAAC,mDAAmD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1G,CAAC;IACH,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { type IApiItemJson, type IApiItemOptions, type ApiItem, ApiItemKind } from '../items/ApiItem';\nimport { ApiClass, type IApiClassOptions, type IApiClassJson } from './ApiClass';\nimport { ApiEntryPoint, type IApiEntryPointOptions } from './ApiEntryPoint';\nimport { ApiMethod, type IApiMethodOptions } from './ApiMethod';\nimport { ApiModel } from './ApiModel';\nimport { ApiNamespace, type IApiNamespaceOptions } from './ApiNamespace';\nimport { ApiPackage, type IApiPackageOptions, type IApiPackageJson } from './ApiPackage';\nimport { ApiInterface, type IApiInterfaceOptions, type IApiInterfaceJson } from './ApiInterface';\nimport { ApiPropertySignature, type IApiPropertySignatureOptions } from './ApiPropertySignature';\nimport { ApiMethodSignature, type IApiMethodSignatureOptions } from './ApiMethodSignature';\nimport { ApiProperty, type IApiPropertyOptions } from './ApiProperty';\nimport { ApiEnumMember, type IApiEnumMemberOptions } from './ApiEnumMember';\nimport { ApiEnum, type IApiEnumOptions } from './ApiEnum';\nimport type { IApiPropertyItemJson } from '../items/ApiPropertyItem';\nimport { ApiConstructor, type IApiConstructorOptions } from './ApiConstructor';\nimport { ApiConstructSignature, type IApiConstructSignatureOptions } from './ApiConstructSignature';\nimport { ApiFunction, type IApiFunctionOptions } from './ApiFunction';\nimport { ApiCallSignature, type IApiCallSignatureOptions } from './ApiCallSignature';\nimport { ApiIndexSignature, type IApiIndexSignatureOptions } from './ApiIndexSignature';\nimport { ApiTypeAlias, type IApiTypeAliasOptions, type IApiTypeAliasJson } from './ApiTypeAlias';\nimport { ApiVariable, type IApiVariableOptions, type IApiVariableJson } from './ApiVariable';\nimport type { IApiDeclaredItemJson } from '../items/ApiDeclaredItem';\nimport type { DeserializerContext } from './DeserializerContext';\n\nexport class Deserializer {\n  public static deserialize(context: DeserializerContext, jsonObject: IApiItemJson): ApiItem {\n    const options: Partial<IApiItemOptions> = {};\n\n    switch (jsonObject.kind) {\n      case ApiItemKind.Class:\n        ApiClass.onDeserializeInto(options, context, jsonObject as IApiClassJson);\n        return new ApiClass(options as IApiClassOptions);\n      case ApiItemKind.CallSignature:\n        ApiCallSignature.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiCallSignature(options as IApiCallSignatureOptions);\n      case ApiItemKind.Constructor:\n        ApiConstructor.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiConstructor(options as IApiConstructorOptions);\n      case ApiItemKind.ConstructSignature:\n        ApiConstructSignature.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiConstructSignature(options as IApiConstructSignatureOptions);\n      case ApiItemKind.EntryPoint:\n        ApiEntryPoint.onDeserializeInto(options, context, jsonObject);\n        return new ApiEntryPoint(options as IApiEntryPointOptions);\n      case ApiItemKind.Enum:\n        ApiEnum.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiEnum(options as IApiEnumOptions);\n      case ApiItemKind.EnumMember:\n        ApiEnumMember.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiEnumMember(options as IApiEnumMemberOptions);\n      case ApiItemKind.Function:\n        ApiFunction.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiFunction(options as IApiFunctionOptions);\n      case ApiItemKind.IndexSignature:\n        ApiIndexSignature.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiIndexSignature(options as IApiIndexSignatureOptions);\n      case ApiItemKind.Interface:\n        ApiInterface.onDeserializeInto(options, context, jsonObject as IApiInterfaceJson);\n        return new ApiInterface(options as IApiInterfaceOptions);\n      case ApiItemKind.Method:\n        ApiMethod.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiMethod(options as IApiMethodOptions);\n      case ApiItemKind.MethodSignature:\n        ApiMethodSignature.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiMethodSignature(options as IApiMethodSignatureOptions);\n      case ApiItemKind.Model:\n        return new ApiModel();\n      case ApiItemKind.Namespace:\n        ApiNamespace.onDeserializeInto(options, context, jsonObject as IApiDeclaredItemJson);\n        return new ApiNamespace(options as IApiNamespaceOptions);\n      case ApiItemKind.Package:\n        ApiPackage.onDeserializeInto(options, context, jsonObject as IApiPackageJson);\n        return new ApiPackage(options as IApiPackageOptions);\n      case ApiItemKind.Property:\n        ApiProperty.onDeserializeInto(options, context, jsonObject as IApiPropertyItemJson);\n        return new ApiProperty(options as IApiPropertyOptions);\n      case ApiItemKind.PropertySignature:\n        ApiPropertySignature.onDeserializeInto(options, context, jsonObject as IApiPropertyItemJson);\n        return new ApiPropertySignature(options as IApiPropertySignatureOptions);\n      case ApiItemKind.TypeAlias:\n        ApiTypeAlias.onDeserializeInto(options, context, jsonObject as IApiTypeAliasJson);\n        return new ApiTypeAlias(options as IApiTypeAliasOptions);\n      case ApiItemKind.Variable:\n        ApiVariable.onDeserializeInto(options, context, jsonObject as IApiVariableJson);\n        return new ApiVariable(options as IApiVariableOptions);\n      default:\n        throw new Error(`Failed to deserialize unsupported API item type ${JSON.stringify(jsonObject.kind)}`);\n    }\n  }\n}\n"]}