Merge pull request #5306 from Polymer/publish-polymer-3-types

Add typings to Polymer 3

.gitignore

@@ -15,3 +15,9 @@ npm-debug.log
 
 # Analyzer output used in the docs
 analysis.json
+
+# NPM artifact
+polymer-polymer-*.tgz
+
+# Typings are generated upon publish to NPM
+*.d.ts

.npmignore

@@ -0,0 +1,20 @@
+# dependencies
+bower_components
+node_modules
+
+# compiled output
+dist
+
+# IDEs
+.idea
+.vscode
+
+# misc
+.DS_Store
+npm-debug.log
+
+# Analyzer output used in the docs
+analysis.json
+
+# NPM artifact
+polymer-polymer-*.tgz

.travis.yml

@@ -12,6 +12,7 @@ before_script:
 - npm install -g gulp-cli@1
 - gulp lint-eslint
 script:
+- npm run generate-types
 - node ./node_modules/.bin/polymer test --npm --module-resolution=node -l chrome
 - node ./node_modules/.bin/polymer test --npm --module-resolution=node -l firefox
 - if [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then travis_wait 30 ./util/travis-sauce-test.sh; fi

externs/closure-types.js

@@ -246,7 +246,7 @@ Polymer_TemplateStamp.prototype._addMethodEventListenerToNode = function(node, e
 */
 Polymer_TemplateStamp.prototype._addEventListenerToNode = function(node, eventName, handler){};
 /**
-* @param {Node} node Node to remove event listener from
+* @param {!Node} node Node to remove event listener from
 * @param {string} eventName Name of event
 * @param {function (!Event): void} handler Listener function to remove
 * @return {void}

gulpfile.js

@@ -117,11 +117,11 @@ gulp.task('generate-externs', gulp.series('clean', async () => {
 
 gulp.task('generate-typescript', async () => {
   let genTs = require('@polymer/gen-typescript-declarations').generateDeclarations;
-  await del(['types/**/*.d.ts', '!types/extra-types.d.ts']);
-  const config = await fs.readJson('gen-tsd.json');
-  const files = await genTs('.', config);
+  await del(['**/*.d.ts', '!interfaces.d.ts', '!node_modules/**']);
+  const config = await fs.readJson(path.join(__dirname, 'gen-tsd.json'));
+  const files = await genTs(__dirname, config);
   for (const [filePath, contents] of files) {
-    await fs.outputFile(path.join('types', filePath), contents);
+    await fs.outputFile(path.join(__dirname, filePath), contents);
   }
 });
 

lib/mixins/property-effects.js

@@ -1678,9 +1678,9 @@ export const PropertyEffects = dedupingMixin(superClass => {
      * a specific order (compute, propagate, reflect, observe, notify).
      *
      * @param {!Object} currentProps Bag of all current accessor values
-     * @param {!Object} changedProps Bag of properties changed since the last
+     * @param {?Object} changedProps Bag of properties changed since the last
      *   call to `_propertiesChanged`
-     * @param {!Object} oldProps Bag of previous values for each property
+     * @param {?Object} oldProps Bag of previous values for each property
      *   in `changedProps`
      * @return {void}
      */

lib/mixins/template-stamp.js

@@ -475,7 +475,7 @@ export const TemplateStamp = dedupingMixin(
     /**
      * Override point for adding custom or simulated event handling.
      *
-     * @param {Node} node Node to remove event listener from
+     * @param {!Node} node Node to remove event listener from
      * @param {string} eventName Name of event
      * @param {function(!Event):void} handler Listener function to remove
      * @return {void}

package.json

@@ -9,7 +9,7 @@
   },
   "devDependencies": {
     "@polymer/gen-closure-declarations": "^0.4.0",
-    "@polymer/gen-typescript-declarations": "^1.3.0",
+    "@polymer/gen-typescript-declarations": "^1.4.0",
     "@polymer/iron-component-page": "^3.0.0-pre.12",
     "@polymer/test-fixture": "^3.0.0-pre.12",
     "@webcomponents/webcomponentsjs": "^2.0.0",
@@ -33,6 +33,7 @@
     "polymer-build": "^3.0.4",
     "polymer-cli": "^1.7.0",
     "through2": "^2.0.0",
+    "typescript": "^2.9.2",
     "wct-browser-legacy": "^1.0.0"
   },
   "scripts": {
@@ -40,7 +41,8 @@
     "test": "npm run lint && polymer test --npm --module-resolution=node",
     "serve": "polymer serve --npm --module-resolution=node",
     "lint": "gulp lint",
-    "generate-types": "gulp generate-types",
+    "generate-types": "gulp generate-types && npm run verify-types",
+    "verify-types": "tsc --project verify-types-tsconfig.json",
     "regen-package-lock": "rm -rf node_modules package-lock.json; npm install",
     "prepack": "npm run generate-types"
   },

verify-types-tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "moduleResolution": "node",
+    "strict": true,
+    "pretty": true,
+    "lib": [
+      "dom",
+      "es2017"
+    ]
+  }
+}