@microsoft/api-extractor - npm Package Compare versions

Comparing version 7.37.0 to 7.37.1

dist/rollup.d.ts

@@ -15,3 +15,3 @@ /**
 import { PackageJsonLookup } from '@rushstack/node-core-library';
-import * as tsdoc from '@microsoft/tsdoc';
+import type * as tsdoc from '@microsoft/tsdoc';
 import { TSDocConfigFile } from '@microsoft/tsdoc-config';
@@ -18,0 +18,0 @@ import { TSDocConfiguration } from '@microsoft/tsdoc';

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.35.3"
+      "packageVersion": "7.37.0"
     }
   ]
 }

lib/aedoc/PackageDocComment.d.ts

 import * as ts from 'typescript';
-import { Collector } from '../collector/Collector';
+import type { Collector } from '../collector/Collector';
 export declare class PackageDocComment {
@@ -4,0 +4,0 @@ /**

lib/analyzer/AstDeclaration.d.ts

 import * as ts from 'typescript';
-import { AstSymbol } from './AstSymbol';
-import { AstEntity } from './AstEntity';
+import type { AstSymbol } from './AstSymbol';
+import type { AstEntity } from './AstEntity';
 /**
@@ -5,0 +5,0 @@ * Constructor options for AstDeclaration

lib/analyzer/AstImport.d.ts

@@ -1,2 +0,2 @@
-import { AstSymbol } from './AstSymbol';
+import type { AstSymbol } from './AstSymbol';
 import { AstSyntheticEntity } from './AstEntity';
@@ -3,0 +3,0 @@ /**

lib/analyzer/AstModule.d.ts

@@ -1,3 +0,3 @@
-import * as ts from 'typescript';
-import { AstEntity } from './AstEntity';
+import type * as ts from 'typescript';
+import type { AstEntity } from './AstEntity';
 /**
@@ -4,0 +4,0 @@ * Represents information collected by {@link AstSymbolTable.fetchAstModuleExportInfo}

lib/analyzer/AstNamespaceImport.d.ts

@@ -1,5 +0,5 @@
-import * as ts from 'typescript';
-import { AstModule, AstModuleExportInfo } from './AstModule';
+import type * as ts from 'typescript';
+import type { AstModule, AstModuleExportInfo } from './AstModule';
 import { AstSyntheticEntity } from './AstEntity';
-import { Collector } from '../collector/Collector';
+import type { Collector } from '../collector/Collector';
 export interface IAstNamespaceImportOptions {
@@ -6,0 +6,0 @@ readonly astModule: AstModule;

lib/analyzer/AstReferenceResolver.d.ts

 import * as tsdoc from '@microsoft/tsdoc';
-import { AstDeclaration } from './AstDeclaration';
-import { Collector } from '../collector/Collector';
+import type { AstDeclaration } from './AstDeclaration';
+import type { Collector } from '../collector/Collector';
 /**
@@ -5,0 +5,0 @@ * Used by `AstReferenceResolver` to report a failed resolution.

lib/analyzer/AstReferenceResolver.js

@@ -187,3 +187,3 @@ "use strict";
     _selectUsingIndexSelector(astDeclarations, memberSelector, astSymbolName) {
-        const selectorOverloadIndex = parseInt(memberSelector.selector);
+        const selectorOverloadIndex = parseInt(memberSelector.selector, 10);
         const matches = [];
@@ -190,0 +190,0 @@ for (const astDeclaration of astDeclarations) {

lib/analyzer/AstSymbol.d.ts

@@ -1,3 +0,3 @@
-import * as ts from 'typescript';
-import { AstDeclaration } from './AstDeclaration';
+import type * as ts from 'typescript';
+import type { AstDeclaration } from './AstDeclaration';
 import { AstEntity } from './AstEntity';
@@ -4,0 +4,0 @@ /**

lib/analyzer/AstSymbolTable.d.ts

 import * as ts from 'typescript';
-import { PackageJsonLookup } from '@rushstack/node-core-library';
+import { type PackageJsonLookup } from '@rushstack/node-core-library';
 import { AstDeclaration } from './AstDeclaration';
-import { AstModule, AstModuleExportInfo } from './AstModule';
-import { AstEntity } from './AstEntity';
-import { MessageRouter } from '../collector/MessageRouter';
+import type { AstModule, AstModuleExportInfo } from './AstModule';
+import type { AstEntity } from './AstEntity';
+import type { MessageRouter } from '../collector/MessageRouter';
 /**
@@ -8,0 +8,0 @@ * Options for `AstSymbolTable._fetchAstSymbol()`

lib/analyzer/AstSymbolTable.js

@@ -481,3 +481,2 @@ "use strict";
                 // Is there a parent AstSymbol?  First we check to see if there is a parent declaration:
-                const arbitraryDeclaration = TypeScriptHelpers_1.TypeScriptHelpers.tryGetADeclaration(followedSymbol);
                 if (arbitraryDeclaration) {
@@ -484,0 +483,0 @@ const arbitraryParentDeclaration = this._tryFindFirstAstDeclarationParent(arbitraryDeclaration);

lib/analyzer/ExportAnalyzer.d.ts

 import * as ts from 'typescript';
 import { AstSymbol } from './AstSymbol';
 import { AstModule, AstModuleExportInfo } from './AstModule';
-import { IFetchAstSymbolOptions } from './AstSymbolTable';
-import { AstEntity } from './AstEntity';
+import type { IFetchAstSymbolOptions } from './AstSymbolTable';
+import type { AstEntity } from './AstEntity';
 /**
@@ -7,0 +7,0 @@ * Exposes the minimal APIs from AstSymbolTable that are needed by ExportAnalyzer.

lib/analyzer/PackageMetadataManager.d.ts

@@ -1,3 +0,3 @@
-import { PackageJsonLookup, NewlineKind, INodePackageJson } from '@rushstack/node-core-library';
-import { MessageRouter } from '../collector/MessageRouter';
+import { type PackageJsonLookup, type NewlineKind, type INodePackageJson } from '@rushstack/node-core-library';
+import type { MessageRouter } from '../collector/MessageRouter';
 /**
@@ -4,0 +4,0 @@ * Represents analyzed information for a package.json file.

lib/analyzer/SourceFileLocationFormatter.d.ts

@@ -1,2 +0,2 @@
-import * as ts from 'typescript';
+import type * as ts from 'typescript';
 export interface ISourceFileLocationFormatOptions {
@@ -3,0 +3,0 @@ sourceFileLine?: number;

lib/api/Extractor.d.ts

 import { ExtractorConfig } from './ExtractorConfig';
 import { CompilerState } from './CompilerState';
-import { ExtractorMessage } from './ExtractorMessage';
+import type { ExtractorMessage } from './ExtractorMessage';
 /**
@@ -5,0 +5,0 @@ * Runtime options for Extractor.

lib/api/ExtractorConfig.d.ts

@@ -1,4 +0,4 @@
-import { JsonSchema, PackageJsonLookup, INodePackageJson, NewlineKind } from '@rushstack/node-core-library';
+import { JsonSchema, PackageJsonLookup, type INodePackageJson, NewlineKind } from '@rushstack/node-core-library';
 import { type IRigConfig } from '@rushstack/rig-package';
-import { IConfigFile, IExtractorMessagesConfig } from './IConfigFile';
+import type { IConfigFile, IExtractorMessagesConfig } from './IConfigFile';
 import { EnumMemberOrder } from '@microsoft/api-extractor-model';
@@ -5,0 +5,0 @@ import { TSDocConfiguration } from '@microsoft/tsdoc';

lib/api/ExtractorConfig.js

@@ -27,2 +27,5 @@ "use strict";
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -40,2 +43,3 @@ exports.ExtractorConfig = void 0;
 const tsdoc_config_1 = require("@microsoft/tsdoc-config");
+const api_extractor_schema_json_1 = __importDefault(require("../schemas/api-extractor.schema.json"));
 /**
@@ -661,3 +665,3 @@ * The `ExtractorConfig` class loads, validates, interprets, and represents the api-extractor.json config file.
  */
-ExtractorConfig.jsonSchema = node_core_library_1.JsonSchema.fromFile(path.join(__dirname, '../schemas/api-extractor.schema.json'));
+ExtractorConfig.jsonSchema = node_core_library_1.JsonSchema.fromLoadedObject(api_extractor_schema_json_1.default);
 /**
@@ -664,0 +668,0 @@ * The config file name "api-extractor.json".

lib/api/ExtractorMessage.d.ts

@@ -1,5 +0,5 @@
-import * as tsdoc from '@microsoft/tsdoc';
-import { ExtractorMessageId } from './ExtractorMessageId';
+import type * as tsdoc from '@microsoft/tsdoc';
+import type { ExtractorMessageId } from './ExtractorMessageId';
 import { ExtractorLogLevel } from './ExtractorLogLevel';
-import { ConsoleMessageId } from './ConsoleMessageId';
+import type { ConsoleMessageId } from './ConsoleMessageId';
 /**
@@ -6,0 +6,0 @@ * Used by {@link ExtractorMessage.properties}.

lib/api/IConfigFile.d.ts

@@ -1,3 +0,3 @@
-import { EnumMemberOrder } from '@microsoft/api-extractor-model';
-import { ExtractorLogLevel } from './ExtractorLogLevel';
+import type { EnumMemberOrder } from '@microsoft/api-extractor-model';
+import type { ExtractorLogLevel } from './ExtractorLogLevel';
 /**
@@ -4,0 +4,0 @@ * Determines how the TypeScript compiler engine will be invoked by API Extractor.

lib/cli/InitAction.d.ts

 import { CommandLineAction } from '@rushstack/ts-command-line';
-import { ApiExtractorCommandLine } from './ApiExtractorCommandLine';
+import type { ApiExtractorCommandLine } from './ApiExtractorCommandLine';
 export declare class InitAction extends CommandLineAction {
@@ -4,0 +4,0 @@ constructor(parser: ApiExtractorCommandLine);

lib/cli/RunAction.d.ts

 import { CommandLineAction } from '@rushstack/ts-command-line';
-import { ApiExtractorCommandLine } from './ApiExtractorCommandLine';
+import type { ApiExtractorCommandLine } from './ApiExtractorCommandLine';
 export declare class RunAction extends CommandLineAction {
@@ -4,0 +4,0 @@ private readonly _configFileParameter;

lib/collector/ApiItemMetadata.d.ts

@@ -1,3 +0,3 @@
-import * as tsdoc from '@microsoft/tsdoc';
-import { ReleaseTag } from '@microsoft/api-extractor-model';
+import type * as tsdoc from '@microsoft/tsdoc';
+import type { ReleaseTag } from '@microsoft/api-extractor-model';
 import { VisitorState } from './VisitorState';
@@ -4,0 +4,0 @@ /**

lib/collector/Collector.d.ts

@@ -5,14 +5,14 @@ import * as ts from 'typescript';
 import { AstSymbolTable } from '../analyzer/AstSymbolTable';
-import { AstEntity } from '../analyzer/AstEntity';
+import type { AstEntity } from '../analyzer/AstEntity';
 import { AstSymbol } from '../analyzer/AstSymbol';
-import { AstDeclaration } from '../analyzer/AstDeclaration';
+import type { AstDeclaration } from '../analyzer/AstDeclaration';
 import { WorkingPackage } from './WorkingPackage';
-import { DeclarationMetadata } from './DeclarationMetadata';
+import { type DeclarationMetadata } from './DeclarationMetadata';
 import { ApiItemMetadata } from './ApiItemMetadata';
 import { SymbolMetadata } from './SymbolMetadata';
-import { IGlobalVariableAnalyzer } from '../analyzer/TypeScriptInternals';
-import { MessageRouter } from './MessageRouter';
+import { type IGlobalVariableAnalyzer } from '../analyzer/TypeScriptInternals';
+import type { MessageRouter } from './MessageRouter';
 import { AstReferenceResolver } from '../analyzer/AstReferenceResolver';
 import { ExtractorConfig } from '../api/ExtractorConfig';
-import { SourceMapper } from './SourceMapper';
+import type { SourceMapper } from './SourceMapper';
 /**
@@ -19,0 +19,0 @@ * Options for Collector constructor.

lib/collector/CollectorEntity.d.ts

@@ -1,2 +0,2 @@
-import { AstEntity } from '../analyzer/AstEntity';
+import type { AstEntity } from '../analyzer/AstEntity';
 /**
@@ -3,0 +3,0 @@ * This is a data structure used by the Collector to track an AstEntity that may be emitted in the *.d.ts file.

lib/collector/DeclarationMetadata.d.ts

@@ -1,3 +0,3 @@
-import * as tsdoc from '@microsoft/tsdoc';
-import { AstDeclaration } from '../analyzer/AstDeclaration';
+import type * as tsdoc from '@microsoft/tsdoc';
+import type { AstDeclaration } from '../analyzer/AstDeclaration';
 /**
@@ -4,0 +4,0 @@ * Stores the Collector's additional analysis for a specific `AstDeclaration` signature.  This object is assigned to

lib/collector/MessageRouter.d.ts

 import * as ts from 'typescript';
-import * as tsdoc from '@microsoft/tsdoc';
+import type * as tsdoc from '@microsoft/tsdoc';
 import { AstDeclaration } from '../analyzer/AstDeclaration';
-import { AstSymbol } from '../analyzer/AstSymbol';
-import { ExtractorMessage, IExtractorMessageProperties } from '../api/ExtractorMessage';
-import { ExtractorMessageId } from '../api/ExtractorMessageId';
-import { IExtractorMessagesConfig } from '../api/IConfigFile';
-import { SourceMapper } from './SourceMapper';
+import type { AstSymbol } from '../analyzer/AstSymbol';
+import { ExtractorMessage, type IExtractorMessageProperties } from '../api/ExtractorMessage';
+import { type ExtractorMessageId } from '../api/ExtractorMessageId';
+import type { IExtractorMessagesConfig } from '../api/IConfigFile';
+import type { SourceMapper } from './SourceMapper';
 import { ConsoleMessageId } from '../api/ConsoleMessageId';
@@ -10,0 +10,0 @@ export interface IMessageRouterOptions {

lib/collector/SourceMapper.d.ts

@@ -1,2 +0,2 @@
-import ts from 'typescript';
+import type ts from 'typescript';
 export interface ISourceLocation {
@@ -3,0 +3,0 @@ /**

lib/collector/SymbolMetadata.d.ts

@@ -1,2 +0,2 @@
-import { ReleaseTag } from '@microsoft/api-extractor-model';
+import type { ReleaseTag } from '@microsoft/api-extractor-model';
 /**
@@ -3,0 +3,0 @@ * Constructor parameters for `SymbolMetadata`.

lib/collector/WorkingPackage.d.ts

@@ -1,4 +0,4 @@
-import * as ts from 'typescript';
-import * as tsdoc from '@microsoft/tsdoc';
-import { INodePackageJson } from '@rushstack/node-core-library';
+import type * as ts from 'typescript';
+import type * as tsdoc from '@microsoft/tsdoc';
+import type { INodePackageJson } from '@rushstack/node-core-library';
 /**
@@ -5,0 +5,0 @@ * Constructor options for WorkingPackage

lib/enhancers/DocCommentEnhancer.d.ts

@@ -1,2 +0,2 @@
-import { Collector } from '../collector/Collector';
+import type { Collector } from '../collector/Collector';
 export declare class DocCommentEnhancer {
@@ -3,0 +3,0 @@ private readonly _collector;

lib/enhancers/ValidationEnhancer.d.ts

@@ -1,2 +0,2 @@
-import { Collector } from '../collector/Collector';
+import type { Collector } from '../collector/Collector';
 export declare class ValidationEnhancer {
@@ -3,0 +3,0 @@ static analyze(collector: Collector): void;

lib/generators/ApiModelGenerator.d.ts

 import { ApiModel, ApiPackage } from '@microsoft/api-extractor-model';
-import { Collector } from '../collector/Collector';
+import type { Collector } from '../collector/Collector';
 export declare class ApiModelGenerator {
@@ -4,0 +4,0 @@ private readonly _collector;

lib/generators/DeclarationReferenceGenerator.d.ts

 import * as ts from 'typescript';
 import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
-import { Collector } from '../collector/Collector';
+import type { Collector } from '../collector/Collector';
 export declare class DeclarationReferenceGenerator {
@@ -5,0 +5,0 @@ static readonly unknownReference: string;

lib/generators/DtsEmitHelpers.d.ts

@@ -1,7 +0,7 @@
-import { CollectorEntity } from '../collector/CollectorEntity';
+import type { CollectorEntity } from '../collector/CollectorEntity';
 import { AstImport } from '../analyzer/AstImport';
 import { AstDeclaration } from '../analyzer/AstDeclaration';
-import { Collector } from '../collector/Collector';
-import { Span } from '../analyzer/Span';
-import { IndentedWriter } from './IndentedWriter';
+import type { Collector } from '../collector/Collector';
+import type { Span } from '../analyzer/Span';
+import type { IndentedWriter } from './IndentedWriter';
 /**
@@ -8,0 +8,0 @@ * Some common code shared between DtsRollupGenerator and ApiReportGenerator.

lib/generators/DtsRollupGenerator.d.ts

@@ -1,3 +0,3 @@
-import { NewlineKind } from '@rushstack/node-core-library';
-import { Collector } from '../collector/Collector';
+import { type NewlineKind } from '@rushstack/node-core-library';
+import type { Collector } from '../collector/Collector';
 /**
@@ -4,0 +4,0 @@ * Used with DtsRollupGenerator.writeTypingsFile()

lib/generators/ExcerptBuilder.d.ts

 import * as ts from 'typescript';
-import { IExcerptToken, IExcerptTokenRange } from '@microsoft/api-extractor-model';
-import { DeclarationReferenceGenerator } from './DeclarationReferenceGenerator';
-import { AstDeclaration } from '../analyzer/AstDeclaration';
+import { type IExcerptToken, type IExcerptTokenRange } from '@microsoft/api-extractor-model';
+import type { DeclarationReferenceGenerator } from './DeclarationReferenceGenerator';
+import type { AstDeclaration } from '../analyzer/AstDeclaration';
 /**
@@ -6,0 +6,0 @@ * Used to provide ExcerptBuilder with a list of nodes whose token range we want to capture.

lib/generators/IndentedWriter.d.ts

@@ -1,2 +0,2 @@
-import { IStringBuilder } from '@rushstack/node-core-library';
+import { type IStringBuilder } from '@rushstack/node-core-library';
 /**
@@ -3,0 +3,0 @@ * A utility for writing indented text.

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "7.37.0",
+  "version": "7.37.1",
   "description": "Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups",
@@ -43,10 +43,10 @@ "keywords": [
     "typescript": "~5.0.4",
-    "@microsoft/api-extractor-model": "7.28.0",
-    "@rushstack/node-core-library": "3.60.0",
-    "@rushstack/rig-package": "0.5.0",
-    "@rushstack/ts-command-line": "4.16.0"
+    "@microsoft/api-extractor-model": "7.28.1",
+    "@rushstack/node-core-library": "3.60.1",
+    "@rushstack/rig-package": "0.5.1",
+    "@rushstack/ts-command-line": "4.16.1"
   },
   "devDependencies": {
-    "@rushstack/heft": "0.54.0",
-    "@rushstack/heft-node-rig": "2.2.6",
+    "@rushstack/heft": "0.59.0",
+    "@rushstack/heft-node-rig": "2.2.23",
     "@types/heft-jest": "1.0.1",
@@ -57,3 +57,3 @@ "@types/lodash": "4.14.116",
     "@types/semver": "7.5.0",
-    "@rushstack/eslint-config": "3.3.4"
+    "local-eslint-config": "1.0.0"
   },
@@ -60,0 +60,0 @@ "scripts": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1562564

increased by0.09%

Lines of code

15481

increased by0.02%

Dependency changes

• + Added@microsoft/api-extractor-model@7.28.1(transitive)

• + Added@rushstack/node-core-library@3.60.1(transitive)

• + Added@rushstack/rig-package@0.5.1(transitive)

• + Added@rushstack/ts-command-line@4.16.1(transitive)

• - Removed@microsoft/api-extractor-model@7.28.0(transitive)

• - Removed@rushstack/node-core-library@3.60.0(transitive)

• - Removed@rushstack/rig-package@0.5.0(transitive)

• - Removed@rushstack/ts-command-line@4.16.0(transitive)

• Updated@microsoft/api-extractor-model@7.28.1

• Updated@rushstack/node-core-library@3.60.1

• Updated@rushstack/rig-package@0.5.1

• Updated@rushstack/ts-command-line@4.16.1