@microsoft/api-extractor - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

CHANGELOG.json

@@ -5,2 +5,19 @@ {
     {
+      "version": "3.2.0",
+      "tag": "@microsoft/api-extractor_v3.2.0",
+      "date": "Tue, 05 Sep 2017 19:03:56 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Add the constructor signature and package name to the exported API signature"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/node-core-library\" from `~0.2.3` to `~0.2.4`"
+          }
+        ]
+      }
+    },
+    {
       "version": "3.1.0",
@@ -7,0 +24,0 @@ "tag": "@microsoft/api-extractor_v3.1.0",

CHANGELOG.md

 # Change Log - @microsoft/api-extractor
 
-This log was last generated on Sat, 02 Sep 2017 01:04:26 GMT and should not be manually modified.
+This log was last generated on Tue, 05 Sep 2017 19:03:56 GMT and should not be manually modified.
 
+## 3.2.0
+Tue, 05 Sep 2017 19:03:56 GMT
+
+### Minor changes
+
+- Add the constructor signature and package name to the exported API signature
+
 ## 3.1.0
@@ -6,0 +13,0 @@ Sat, 02 Sep 2017 01:04:26 GMT

lib/api/api-json.schema.json

@@ -671,2 +671,6 @@ {
     },
+    "name": {
+      "description": "The name of the NPM package, including the optional scope.  Example: \"@microsoft/example-package\"",
+      "type": "string"
+    },
     "summary": {
@@ -697,3 +701,3 @@ "$ref": "#/definitions/docElementCollection"
   "additionalProperties": false,
-  "required": [ "kind", "exports" ]
+  "required": [ "kind", "name", "exports" ]
 }

lib/api/ApiItem.d.ts

@@ -161,2 +161,18 @@ import { IDocElement } from '../markup/OldMarkup';
 /**
+ * A Typescript function.
+ * @alpha
+ */
+export interface IApiConstructor extends IApiBaseDefinition {
+    /**
+     * {@inheritdoc IApiBaseDefinition.kind}
+     */
+    kind: 'constructor';
+    /**
+     * parameters of the function
+     */
+    parameters: {
+        [name: string]: IApiParameter;
+    };
+}
+/**
  * IApiClass represetns an exported class.
@@ -240,2 +256,8 @@ * @alpha
     /**
+     * The name of the NPM package, including the optional scope.
+     * @remarks
+     * Example: "@microsoft/example-package"
+     */
+    name: string;
+    /**
      * IDocItems of exported API items
@@ -265,3 +287,3 @@ */
  */
-export declare type ApiItem = IApiProperty | ApiMember | IApiFunction | IApiClass | IApiEnum | IApiInterface | IApiPackage;
+export declare type ApiItem = IApiProperty | ApiMember | IApiFunction | IApiConstructor | IApiClass | IApiEnum | IApiInterface | IApiPackage;
 /**
@@ -268,0 +290,0 @@ * Describes a return type and description of the return type

lib/DocItemLoader.js

@@ -169,8 +169,5 @@ "use strict";
     DocItemLoader.prototype.loadPackageIntoCache = function (apiJsonFilePath, cachePackageName) {
-        var astPackage = node_core_library_1.JsonFile.loadAndValidateWithCallback(apiJsonFilePath, ApiJsonGenerator_1.default.jsonSchema, function (errorInfo) {
-            var errorMessage = path.basename(apiJsonFilePath) + ' does not conform to the expected schema.' + os.EOL
-                + '(Was it created by an incompatible release of API Extractor?)' + os.EOL
-                + errorInfo.details;
-            console.log(os.EOL + 'ERROR: ' + errorMessage + os.EOL + os.EOL);
-            throw new Error(errorMessage);
+        var astPackage = node_core_library_1.JsonFile.loadAndValidate(apiJsonFilePath, ApiJsonGenerator_1.default.jsonSchema, {
+            customErrorHeader: 'The API JSON file does not conform to the expected schema, and may' + os.EOL
+                + 'have been created by an incompatible release of API Extractor:'
         });
@@ -177,0 +174,0 @@ this._cache.set(cachePackageName, astPackage);

lib/example1-output.json

 {
   "kind": "package",
+  "name": "example1",
   "summary": [],
@@ -4,0 +5,0 @@ "remarks": [],

lib/example2-output.json

 {
   "kind": "package",
+  "name": "example2",
   "summary": [
@@ -4,0 +5,0 @@ {

lib/example3-output.json

 {
   "kind": "package",
+  "name": "@scope/example3",
   "summary": [
@@ -4,0 +5,0 @@ {

lib/example4-output.json

 {
   "kind": "package",
+  "name": "example4",
   "summary": [],
@@ -4,0 +5,0 @@ "remarks": [],

lib/generators/ApiJsonGenerator.js

@@ -171,2 +171,3 @@ "use strict";
         refObject['kind'] = ApiJsonFile_1.default.convertKindToJson(astPackage.kind);
+        refObject['name'] = astPackage.name;
         refObject['summary'] = astPackage.documentation.summary;
@@ -173,0 +174,0 @@ refObject['remarks'] = astPackage.documentation.remarks;

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Validate, document, and review the exported API for a TypeScript library",
@@ -30,3 +30,3 @@ "keywords": [
   "dependencies": {
-    "@microsoft/node-core-library": "~0.2.3",
+    "@microsoft/node-core-library": "~0.2.4",
     "@types/es6-collections": "0.5.29",
@@ -33,0 +33,0 @@ "@types/fs-extra": "0.0.37",

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

770448

increased by0.17%

Lines of code

9980

increased by0.45%

Dependency changes

• Updated@microsoft/node-core-library@~0.2.4