dts-gen 0.6.0 → 0.7.1

package/SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.7 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

package/bin/lib/definitely-typed.js

@@ -1,32 +1,34 @@
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 const http_1 = require("http");
+const https_1 = require("https");
 const os_1 = require("os");
 const parseGitConfig = require("parse-git-config");
 const path_1 = require("path");
 const url_1 = require("url");
 const names_1 = require("./names");
 function writeDefinitelyTypedPackage(indexDtsContent, packageName, overwrite) {
-    const dtName = names_1.getDTName(packageName);
-    const packageDir = path_1.join("types", dtName);
+    const dtName = (0, names_1.getDTName)(packageName);
+    const packageDir = (0, path_1.join)("types", dtName);
     // Check for overwrite
     if (!overwrite) {
-        if (fs_1.existsSync(packageDir)) {
-            console.log(`Directory ${packageDir} already exists and -overwrite was not specified; exiting.`);
+        if ((0, fs_1.existsSync)(packageDir)) {
+            console.log(`Directory ${packageDir} already exists and --overwrite was not specified; exiting.`);
             process.exit(2);
         }
     }
-    if (!fs_1.existsSync(packageDir)) {
-        fs_1.mkdirSync(packageDir);
+    if (!(0, fs_1.existsSync)(packageDir)) {
+        (0, fs_1.mkdirSync)(packageDir);
     }
     run(indexDtsContent, packageName, dtName, packageDir).catch(e => {
         console.error(e);
@@ -37,24 +39,45 @@ exports.default = writeDefinitelyTypedPackage;
 function run(indexDtsContent, packageName, dtName, packageDir) {
     return __awaiter(this, void 0, void 0, function* () {
         const files = [
-            ["index.d.ts", yield getIndex(indexDtsContent, packageName)],
+            ["index.d.ts", indexDtsContent],
             [`${dtName}-tests.ts`, ""],
             ["tsconfig.json", `${JSON.stringify(getTSConfig(dtName), undefined, 4)}\n`],
-            ["tslint.json", '{ "extends": "dtslint/dt.json" }\n'],
+            ["package.json", `${JSON.stringify(yield getPackageJson(dtName, packageName), undefined, 4)}\n`],
+            ["tslint.json", '{ "extends": "@definitelytyped/dtslint/dt.json" }\n'],
         ];
         for (const [name, text] of files) {
-            fs_1.writeFileSync(path_1.join(packageDir, name), text, "utf-8");
+            (0, fs_1.writeFileSync)((0, path_1.join)(packageDir, name), text, "utf-8");
         }
     });
 }
-function getIndex(content, packageName) {
+function getTSConfig(dtName) {
+    return {
+        compilerOptions: {
+            module: "commonjs",
+            lib: ["es6"],
+            noImplicitAny: true,
+            noImplicitThis: true,
+            strictFunctionTypes: true,
+            strictNullChecks: true,
+            types: [],
+            noEmit: true,
+            forceConsistentCasingInFileNames: true,
+        },
+        files: [
+            "index.d.ts",
+            `${dtName}-tests.ts`,
+        ],
+    };
+}
+function getPackageJson(dtName, packageName) {
+    var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         let version = "x.x";
         let project = "https://github.com/baz/foo " +
             "(Does not have to be to GitHub, " +
             "but prefer linking to a source code repository rather than to a project website.)";
         try {
-            const reg = JSON.parse(yield loadString(`http://registry.npmjs.org/${packageName}`));
+            const reg = JSON.parse(yield loadString(`https://registry.npmjs.org/${packageName}`));
             const { latest } = reg["dist-tags"];
             const { homepage } = reg.versions[latest];
             version = latest.split(".").slice(0, 2).join("."); // Just major.minor
@@ -66,7 +89,7 @@ function getIndex(content, packageName) {
         }
         let authorName = 'My Self';
         try {
-            const globalGitConfig = parseGitConfig.sync({ cwd: os_1.homedir(), path: '.gitconfig' });
+            const globalGitConfig = parseGitConfig.sync({ cwd: (0, os_1.homedir)(), path: '.gitconfig' });
             if (globalGitConfig.user && globalGitConfig.user.name) {
                 authorName = globalGitConfig.user.name;
             }
@@ -76,54 +99,40 @@ function getIndex(content, packageName) {
         }
         let authorUserName = 'me';
         try {
-            const repoGitConfig = parseGitConfig.sync({ path: path_1.join('.git', 'config') });
+            const repoGitConfig = parseGitConfig.sync({ path: (0, path_1.join)('.git', 'config') });
             if (repoGitConfig['remote "origin"'] && repoGitConfig['remote "origin"'].url) {
-                const url = url_1.parse(repoGitConfig['remote "origin"'].url);
+                const url = (0, url_1.parse)(repoGitConfig['remote "origin"'].url);
                 if (url.hostname === 'github.com' && url.pathname) {
                     authorUserName = url.pathname.split('/')[1] || authorUserName;
                 }
+                else if ((_a = url.pathname) === null || _a === void 0 ? void 0 : _a.startsWith('git@github.com')) {
+                    authorUserName = ((_c = (_b = url.pathname.split(':')) === null || _b === void 0 ? void 0 : _b[1].split('/')) === null || _c === void 0 ? void 0 : _c[0]) || authorUserName;
+                }
             }
         }
         catch (e) {
             console.warn(`Warning: Could not retrieve author's user name: ${e.message}`);
         }
-        const authorUrl = url_1.format({
-            protocol: 'https',
-            hostname: 'github.com',
-            pathname: authorUserName,
-        });
-        return `// Type definitions for ${packageName} ${version}
-// Project: ${project}
-// Definitions by: ${authorName} <${authorUrl}>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
-${content}`;
+        return {
+            private: true,
+            name: `@types/${dtName}`,
+            version: `${version}.0.99999`,
+            projects: [project],
+            devDependencies: {
+                [`@types/${dtName}`]: "workspace:."
+            },
+            contributors: [
+                {
+                    name: authorName,
+                    githubUsername: authorUserName
+                }
+            ]
+        };
     });
 }
-function getTSConfig(dtName) {
-    return {
-        compilerOptions: {
-            module: "commonjs",
-            lib: ["es6"],
-            noImplicitAny: true,
-            noImplicitThis: true,
-            strictFunctionTypes: true,
-            strictNullChecks: true,
-            baseUrl: "../",
-            typeRoots: ["../"],
-            types: [],
-            noEmit: true,
-            forceConsistentCasingInFileNames: true,
-        },
-        files: [
-            "index.d.ts",
-            `${dtName}-tests.ts`,
-        ],
-    };
-}
 function loadString(url) {
     return new Promise((resolve, reject) => {
-        http_1.get(url, res => {
+        (0, https_1.get)(url, res => {
             if (res.statusCode !== 200) {
                 return reject(new Error(`HTTP Error ${res.statusCode}: ${http_1.STATUS_CODES[res.statusCode || 500]} for ${url}`));
             }

package/bin/lib/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateIdentifierDeclarationFile = exports.generateModuleDeclarationFile = void 0;
 const dom = require("dts-dom");
 const dts_dom_1 = require("dts-dom");
-const names_1 = require("./names");
 const ts = require("typescript");
+const names_1 = require("./names");
 const builtins = {
     Date,
     RegExp,
@@ -12,29 +13,29 @@ const builtins = {
 };
 function forceAsIdentifier(s) {
     // TODO: Make this more comprehensive
-    return names_1.getDTName(s.replace(/-/g, '_'));
+    return (0, names_1.getDTName)(s.replace(/-/g, '_'));
 }
 function getValueTypes(value) {
     if (typeof value === 'object') {
         // Objects can't be callable, so no need to check for class / function
-        return 4 /* Object */;
+        return 4 /* ValueTypes.Object */;
     }
     else if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-        return 8 /* Primitive */;
+        return 8 /* ValueTypes.Primitive */;
     }
     else if (value === null || value === undefined) {
-        return 16 /* NullOrUndefined */;
+        return 16 /* ValueTypes.NullOrUndefined */;
     }
     else if (typeof value === 'function') {
         if (isClasslike(value)) {
-            return 1 /* Class */ | (hasCloduleProperties(value) ? 4 /* Object */ : 0 /* None */);
+            return 1 /* ValueTypes.Class */ | (hasCloduleProperties(value) ? 4 /* ValueTypes.Object */ : 0 /* ValueTypes.None */);
         }
         else {
-            return 2 /* Function */ | (hasFunduleProperties(value) ? 4 /* Object */ : 0 /* None */);
+            return 2 /* ValueTypes.Function */ | (hasFunduleProperties(value) ? 4 /* ValueTypes.Object */ : 0 /* ValueTypes.None */);
         }
     }
     else {
-        return 32 /* Unknown */;
+        return 32 /* ValueTypes.Unknown */;
     }
 }
 // A class has clodule properties if it has any classes. Anything else can be written with 'static'
@@ -182,11 +183,11 @@ function getTopLevelDeclarations(name, obj) {
             // If anything in here is classlike or functionlike, write it as a namespace.
             // Otherwise, write as a 'const'
             const keys = getKeysOfObject(obj);
-            let constituentTypes = 0 /* None */;
+            let constituentTypes = 0 /* ValueTypes.None */;
             for (const k of keys) {
                 constituentTypes = constituentTypes | getValueTypes(obj[k]);
             }
-            if (constituentTypes & (1 /* Class */ | 2 /* Function */)) {
+            if (constituentTypes & (1 /* ValueTypes.Class */ | 2 /* ValueTypes.Function */)) {
                 const ns = dom.create.namespace(name);
                 for (const k of keys) {
                     const decls = getTopLevelDeclarations(k, obj[k]);
@@ -341,8 +342,9 @@ function inferParameterType(_fn, _param) {
     // TODO: Inspect function body for clues
     return dom.type.any;
 }
+const stringifyFunction = Function.prototype.call.bind(Function.prototype.toString);
 function parseFunctionBody(fn) {
-    const setup = `const myFn = ${fn.toString()};`;
+    const setup = `const myFn = ${stringifyFunction(fn)};`;
     const srcFile = ts.createSourceFile('test.ts', setup, ts.ScriptTarget.Latest, true);
     const statement = srcFile.statements[0];
     const decl = statement.declarationList.declarations[0];
@@ -350,5 +352,5 @@ function parseFunctionBody(fn) {
     return init;
 }
 function isNativeFunction(fn) {
-    return fn.toString().indexOf('{ [native code] }') > 0;
+    return stringifyFunction(fn).indexOf('{ [native code] }') > 0;
 }

package/bin/lib/names.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDTName = void 0;
 function getDTName(s) {
     if (s.indexOf('@') === 0 && s.indexOf('/') !== -1) {
         // we have a scoped module, e.g. @bla/foo

package/bin/lib/run.js

@@ -42,17 +42,17 @@ try {
         throw new ArgsError('Must specify exactly one input');
     }
     if (typeof args.name === 'boolean')
-        throw new ArgsError('Must specify a value for "-name"');
+        throw new ArgsError('Must specify a value for "--name"');
     if (typeof args.identifier === 'boolean')
-        throw new ArgsError('Must specify a value for "-identifier"');
+        throw new ArgsError('Must specify a value for "--identifier"');
     if (typeof args.module === 'boolean')
-        throw new ArgsError('Must specify a value for "-module"');
+        throw new ArgsError('Must specify a value for "--module"');
     if (args.overwrite !== undefined && args.overwrite !== true)
-        throw new ArgsError('-overwrite does not accept an argument');
+        throw new ArgsError('--overwrite does not accept an argument');
     let name;
     if (args.module) {
         if (args.name)
-            throw new ArgsError('Cannot use -name with -module');
+            throw new ArgsError('Cannot use --name with --module');
         name = args.module;
         module.paths.unshift(process.cwd() + '/node_modules');
         result = guess.generateModuleDeclarationFile(args.module, require(args.module));
@@ -63,7 +63,7 @@ try {
     }
     else if (args['expression-file']) {
         if (args.name)
-            throw new ArgsError('Cannot use -name with -expression-file');
+            throw new ArgsError('Cannot use --name with --expression-file');
         const filename = args['expression-file'];
         name = path.basename(filename, path.extname(filename)).replace(/[^A-Za-z0-9]/g, '_');
         module.paths.unshift(process.cwd() + '/node_modules');
@@ -72,7 +72,7 @@ try {
     }
     else if (args.identifier) {
         if (args.name)
-            throw new ArgsError('Cannot use -name with -identifier');
+            throw new ArgsError('Cannot use --name with --identifier');
         if (args.module || args.expression)
             throw new ArgsError('Cannot specify more than one input');
         name = args.identifier;
@@ -83,14 +83,14 @@ try {
             throw new ArgsError('Needs a name');
         name = args.name;
         if (args.module || args.expression)
-            throw new ArgsError('Cannot mix -template with -module or -expression');
+            throw new ArgsError('Cannot mix --template with --module or --expression');
         result = getTemplate(args.template);
     }
     else {
         throw new Error('Internal error, please log a bug with the commandline you specified');
     }
     if (args.dt) {
-        definitely_typed_1.default(result, name, !!args.overwrite);
+        (0, definitely_typed_1.default)(result, name, !!args.overwrite);
     }
     else if (args.stdout) {
         console.log(result);
@@ -101,7 +101,7 @@ try {
             filename = filename + '.d.ts';
         }
         if (!args.overwrite && fs.existsSync(filename)) {
-            console.error(`File ${filename} already exists and -overwrite was not specified; exiting.`);
+            console.error(`File ${filename} already exists and --overwrite was not specified; exiting.`);
             process.exit(2);
         }
         fs.writeFileSync(filename, prependOurHeader(result), 'utf-8');
@@ -116,8 +116,9 @@ catch (e) {
         process.exit(1);
     }
     else if (e.code === 'MODULE_NOT_FOUND') {
-        console.log(`Couldn't load module "${args.module}". ` +
-            `Please install it globally (npm install -g ${args.module}) and try again.`);
+        console.error(`Error loading module "${args.module}".\n` +
+            getErrorMessageFirstLine(e).replace(/'/g, '"') + '.\n' +
+            `Please install missing module and try again.`);
         process.exit(1);
     }
     else {
@@ -160,3 +161,6 @@ function getTemplate(templateName) {
 function allTemplateNames() {
     return fs.readdirSync(templatesDirectory).map(t => t.slice(0, t.length - ".d.ts".length)).join(", ");
 }
+function getErrorMessageFirstLine(error) {
+    return error.message.split('\n', 1)[0];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dts-gen",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "description": "TypeScript Definition File Generator",
   "main": "bin/lib/index.js",
   "bin": {

package/.vscode/launch.json

@@ -1,19 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node",
-            "request": "attach",
-            "name": "Attach",
-            "port": 9229,
-            "sourceMaps": true
-        },
-        {
-            "name": "Launch Program",
-            "program": "${workspaceFolder}/bin/lib/index.js"
-        }
-    ]
-}