From 45613475d06e58043c2138c05a8b9aeda8732d0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Mon, 31 Aug 2020 11:16:17 +0200 Subject: [PATCH 1/9] chore: add api-extractor references --- package-lock.json | 174 ++++++++++++++++++++++++++++++++++++++++++++++ package.json | 1 + 2 files changed, 175 insertions(+) diff --git a/package-lock.json b/package-lock.json index f98eed6c..196ef1db 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2562,6 +2562,60 @@ "gl-matrix": "^3.0.0" } }, + "@microsoft/api-extractor": { + "version": "7.9.11", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.9.11.tgz", + "integrity": "sha512-t+LwGAuTjr+odFEl5xV3vl7qOWf84CM8BWKgb93kEnVd8uha3KfuWtDfnstxG4oC/TL6tu5+9rOwKJiNIidf2A==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.8.19", + "@microsoft/tsdoc": "0.12.19", + "@rushstack/node-core-library": "3.30.0", + "@rushstack/ts-command-line": "4.6.4", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~3.9.5" + }, + "dependencies": { + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + }, + "semver": { + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.2.tgz", + "integrity": "sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==", + "dev": true + }, + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + } + } + }, + "@microsoft/api-extractor-model": { + "version": "7.8.19", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.8.19.tgz", + "integrity": "sha512-tEEPuww0Gbyw9LuTcJ7nDCTjb+aLSAox8Xl9/iSxNTv5yHJN1QX3cqajlC3ibDHlRz7oMpQfHZX7YpAygbgIvg==", + "dev": true, + "requires": { + "@microsoft/tsdoc": "0.12.19", + "@rushstack/node-core-library": "3.30.0" + } + }, + "@microsoft/tsdoc": { + "version": "0.12.19", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.19.tgz", + "integrity": "sha512-IpgPxHrNxZiMNUSXqR1l/gePKPkfAmIKoDRP9hp7OwjU29ZR8WCJsOJ8iBKgw0Qk+pFwR+8Y1cy8ImLY6e9m4A==", + "dev": true + }, "@nodelib/fs.scandir": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.3.tgz", @@ -2736,6 +2790,69 @@ "@babel/runtime": "^7.0.0" } }, + "@rushstack/node-core-library": { + "version": "3.30.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.30.0.tgz", + "integrity": "sha512-vZo1fi/ObL3CmRXlQUX/E1xL9KL9arBfCJ7pYf3O/vFrD8ffSfpQ6+6lhgAsKrCIM5Epddsgeb2REPxMwYZX1g==", + "dev": true, + "requires": { + "@types/node": "10.17.13", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + }, + "dependencies": { + "@types/node": { + "version": "10.17.13", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz", + "integrity": "sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg==", + "dev": true + }, + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + }, + "import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "dev": true + }, + "semver": { + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.2.tgz", + "integrity": "sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==", + "dev": true + } + } + }, + "@rushstack/ts-command-line": { + "version": "4.6.4", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.6.4.tgz", + "integrity": "sha512-ubIANZimyU07+ChU56LfiD36NJ8gvw1txlvUP20GYNQi4lf5N0xEnev4r+AtKkOdnowpGy60ObGmYxSUpSacpw==", + "dev": true, + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + }, + "dependencies": { + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + } + } + }, "@salte-auth/popup": { "version": "1.0.0-rc.2", "resolved": "https://registry.npmjs.org/@salte-auth/popup/-/popup-1.0.0-rc.2.tgz", @@ -2781,6 +2898,12 @@ "defer-to-connect": "^2.0.0" } }, + "@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", + "dev": true + }, "@types/babel__core": { "version": "7.1.9", "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.1.9.tgz", @@ -11501,6 +11624,12 @@ } } }, + "jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=", + "dev": true + }, "jmespath": { "version": "0.15.0", "resolved": "https://registry.npmjs.org/jmespath/-/jmespath-0.15.0.tgz", @@ -12095,6 +12224,18 @@ "integrity": "sha1-ywcE1Hq3F4n/oN6Ll92Sb7iLE7E=", "dev": true }, + "lodash.get": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", + "dev": true + }, + "lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=", + "dev": true + }, "lodash.memoize": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz", @@ -19176,6 +19317,12 @@ "setimmediate": "^1.0.4" } }, + "timsort": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz", + "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=", + "dev": true + }, "tmp": { "version": "0.0.33", "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", @@ -20046,6 +20193,12 @@ "spdx-expression-parse": "^3.0.0" } }, + "validator": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-8.2.0.tgz", + "integrity": "sha512-Yw5wW34fSv5spzTXNkokD6S6/Oq92d8q/t14TqsS3fAiA1RYnxSFSIZ+CY3n6PGGRCq5HhJTSepQvFUS2QUDxA==", + "dev": true + }, "vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -21021,6 +21174,27 @@ "camelcase": "^5.0.0", "decamelize": "^1.2.0" } + }, + "z-schema": { + "version": "3.18.4", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.18.4.tgz", + "integrity": "sha512-DUOKC/IhbkdLKKiV89gw9DUauTV8U/8yJl1sjf6MtDmzevLKOF2duNJ495S3MFVjqZarr+qNGCPbkg4mu4PpLw==", + "dev": true, + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + }, + "dependencies": { + "commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "dev": true, + "optional": true + } + } } } } diff --git a/package.json b/package.json index bebccca6..f96e7cc9 100644 --- a/package.json +++ b/package.json @@ -47,6 +47,7 @@ "@babel/preset-env": "^7.11.0", "@babel/preset-typescript": "^7.10.4", "@danmarshall/deckgl-typings": "^4.3.2", + "@microsoft/api-extractor": "^7.9.11", "@salte-auth/popup": "1.0.0-rc.2", "@salte-auth/salte-auth": "3.0.0-rc.8", "@types/chroma-js": "^2.0.0", From 41d52a058ec15d2eeaeceafc15a74c7acfb58821 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Mon, 31 Aug 2020 11:21:19 +0200 Subject: [PATCH 2/9] chore: first basic config --- api-extractor.json | 364 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 364 insertions(+) create mode 100644 api-extractor.json diff --git a/api-extractor.json b/api-extractor.json new file mode 100644 index 00000000..b8baa574 --- /dev/null +++ b/api-extractor.json @@ -0,0 +1,364 @@ +/** + * Config file for API Extractor. For more info, please visit: https://api-extractor.com + */ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + + /** + * Optionally specifies another JSON config file that this file extends from. This provides a way for + * standard settings to be shared across multiple projects. + * + * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains + * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be + * resolved using NodeJS require(). + * + * SUPPORTED TOKENS: none + * DEFAULT VALUE: "" + */ + // "extends": "./shared/api-extractor-base.json" + // "extends": "my-package/include/api-extractor-base.json" + + /** + * Determines the "" token that can be used with other config file settings. The project folder + * typically contains the tsconfig.json and package.json config files, but the path is user-defined. + * + * The path is resolved relative to the folder of the config file that contains the setting. + * + * The default value for "projectFolder" is the token "", which means the folder is determined by traversing + * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder + * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error + * will be reported. + * + * SUPPORTED TOKENS: + * DEFAULT VALUE: "" + */ + "projectFolder": ".", + + /** + * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor + * analyzes the symbols exported by this module. + * + * The file extension must be ".d.ts" and not ".ts". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + */ + "mainEntryPointFilePath": "/dist/types/index.d.ts", + + /** + * A list of NPM package names whose exports should be treated as part of this package. + * + * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1", + * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part + * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly + * imports library2. To avoid this, we can specify: + * + * "bundledPackages": [ "library2" ], + * + * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been + * local files for library1. + */ + "bundledPackages": [], + + /** + * Determines how the TypeScript compiler engine will be invoked by API Extractor. + */ + "compiler": { + /** + * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * Note: This setting will be ignored if "overrideTsconfig" is used. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/tsconfig.json" + */ + // "tsconfigFilePath": "/tsconfig.json", + /** + * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. + * The object must conform to the TypeScript tsconfig schema: + * + * http://json.schemastore.org/tsconfig + * + * If omitted, then the tsconfig.json file will be read from the "projectFolder". + * + * DEFAULT VALUE: no overrideTsconfig section + */ + // "overrideTsconfig": { + // . . . + // } + /** + * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended + * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when + * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses + * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. + * + * DEFAULT VALUE: false + */ + // "skipLibCheck": true, + }, + + /** + * Configures how the API report file (*.api.md) will be generated. + */ + "apiReport": { + /** + * (REQUIRED) Whether to generate an API report. + */ + "enabled": true, + + /** + * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce + * a full file path. + * + * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/". + * + * SUPPORTED TOKENS: , + * DEFAULT VALUE: ".api.md" + */ + // "reportFileName": ".api.md", + + /** + * Specifies the folder where the API report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, + * e.g. for an API review. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/etc/" + */ + "reportFolder": "/docs/etc/" + + /** + * Specifies the folder where the temporary report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * After the temporary file is written to disk, it is compared with the file in the "reportFolder". + * If they are different, a production build will fail. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/" + */ + // "reportTempFolder": "/temp/" + }, + + /** + * Configures how the doc model file (*.api.json) will be generated. + */ + "docModel": { + /** + * (REQUIRED) Whether to generate a doc model file. + */ + "enabled": true + + /** + * The output path for the doc model file. The file extension should be ".api.json". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/.api.json" + */ + // "apiJsonFilePath": "/temp/.api.json" + }, + + /** + * Configures how the .d.ts rollup file will be generated. + */ + "dtsRollup": { + /** + * (REQUIRED) Whether to generate the .d.ts rollup file. + */ + "enabled": true + + /** + * Specifies the output path for a .d.ts rollup file to be generated without any trimming. + * This file will include all declarations that are exported by the main entry point. + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/dist/.d.ts" + */ + // "untrimmedFilePath": "/dist/.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. + * This file will include only declarations that are marked as "@public" or "@beta". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "betaTrimmedFilePath": "/dist/-beta.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. + * This file will include only declarations that are marked as "@public". + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "publicTrimmedFilePath": "/dist/-public.d.ts", + + /** + * When a declaration is trimmed, by default it will be replaced by a code comment such as + * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the + * declaration completely. + * + * DEFAULT VALUE: false + */ + // "omitTrimmingComments": true + }, + + /** + * Configures how the tsdoc-metadata.json file will be generated. + */ + "tsdocMetadata": { + /** + * Whether to generate the tsdoc-metadata.json file. + * + * DEFAULT VALUE: true + */ + // "enabled": true, + /** + * Specifies where the TSDoc metadata file should be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", + * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup + * falls back to "tsdoc-metadata.json" in the package folder. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" + }, + + /** + * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files + * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. + * To use the OS's default newline kind, specify "os". + * + * DEFAULT VALUE: "crlf" + */ + // "newlineKind": "crlf", + + /** + * Configures how API Extractor reports error and warning messages produced during analysis. + * + * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. + */ + "messages": { + /** + * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing + * the input .d.ts files. + * + * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "compilerMessageReporting": { + /** + * Configures the default routing for messages that don't match an explicit rule in this table. + */ + "default": { + /** + * Specifies whether the message should be written to the the tool's output log. Note that + * the "addToApiReportFile" property may supersede this option. + * + * Possible values: "error", "warning", "none" + * + * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail + * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes + * the "--local" option), the warning is displayed but the build will not fail. + * + * DEFAULT VALUE: "warning" + */ + "logLevel": "warning" + + /** + * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), + * then the message will be written inside that file; otherwise, the message is instead logged according to + * the "logLevel" option. + * + * DEFAULT VALUE: false + */ + // "addToApiReportFile": false + } + + // "TS2551": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by API Extractor during its analysis. + * + * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" + * + * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings + */ + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "ae-extra-release-tag": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by the TSDoc parser when analyzing code comments. + * + * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "tsdoc-link-tag-unescaped-text": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + } + } +} From 16a71d0a175776df0cad4eb321b261416e9d8b4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Mon, 31 Aug 2020 11:21:43 +0200 Subject: [PATCH 3/9] chore: report file --- docs/etc/web-sdk.api.md | 110 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 docs/etc/web-sdk.api.md diff --git a/docs/etc/web-sdk.api.md b/docs/etc/web-sdk.api.md new file mode 100644 index 00000000..7c34b789 --- /dev/null +++ b/docs/etc/web-sdk.api.md @@ -0,0 +1,110 @@ +## API Report File for "@carto/web-sdk" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { AggregationType as AggregationType_2 } from '@/data/operations/aggregation/'; +import { AggregationType as AggregationType_3 } from '@/data/operations/aggregation'; +import { CategoryDataView as CategoryDataView_2 } from '@/viz/dataview'; +import { CategoryDataViewData as CategoryDataViewData_2 } from '@/viz/dataview/category/CategoryDataViewImpl'; +import { ColumnFilters as ColumnFilters_2 } from '@/viz/filters/types'; +import { Credentials as Credentials_2 } from '@/auth'; +import { DataView as DataView_3 } from '@/viz/dataview/DataView'; +import { Deck } from '@deck.gl/core'; +import { Feature } from 'geojson'; +import { Filter as Filter_2 } from '@/viz/filters/types'; +import { FilterOptions } from '@/viz/filters/types'; +import { FormulaDataView as FormulaDataView_2 } from '@/viz/dataview'; +import { FormulaDataViewData as FormulaDataViewData_2 } from '@/viz/dataview/formula/FormulaDataViewImpl'; +import { GeoJSON as GeoJSON_2 } from 'geojson'; +import { GeoJsonLayerProps } from '@deck.gl/layers/geojson-layer/geojson-layer'; +import { HistogramDataView as HistogramDataView_2 } from '@/viz/dataview/histogram/HistogramDataView'; +import { HistogramDataViewData as HistogramDataViewData_2 } from '@/viz/dataview/histogram/HistogramDataViewImpl'; +import { IconLayerProps } from '@deck.gl/layers/icon-layer/icon-layer'; +import { Layer as Layer_2 } from '@/viz'; +import { Layer as Layer_3 } from '@/viz/layer'; +import { LegendProperties } from '@/viz/legend'; +import { LegendWidgetOptions } from '@/viz/legend'; +import { MapOptions } from '@/maps/Client'; +import { default as mitt_2 } from 'mitt'; +import { Source } from '@/viz'; +import { SpatialFilters } from '@/viz/filters/types'; +import { WithEvents } from '@/core/mixins/WithEvents'; + +// @public (undocumented) +export const auth: { + Credentials: typeof Credentials; + setDefaultCredentials: typeof setDefaultCredentials; +}; + +// @public (undocumented) +export const version: any; + +// @public (undocumented) +export const viz: { + Layer: typeof Layer; + Popup: typeof Popup; + createMap: typeof createMap; + createGoogleMap: typeof createGoogleMap; + source: { + GeoJSON: typeof GeoJSONSource; + SQL: typeof SQLSource; + Dataset: typeof DatasetSource; + BQ: typeof BQSource; + }; + dataview: { + Category: typeof CategoryDataView; + Formula: typeof FormulaDataView; + Histogram: typeof HistogramDataView; + }; + widget: { + Category: typeof CategoryWidget; + Formula: typeof FormulaWidget; + Histogram: typeof HistogramWidget; + }; + style: { + basic: typeof basicStyle; + colorBins: typeof colorBinsStyle; + colorCategories: typeof colorCategoriesStyle; + colorContinuous: typeof colorContinuousStyle; + sizeBins: typeof sizeBinsStyle; + sizeCategories: typeof sizeCategoriesStyle; + sizeContinuous: typeof sizeContinuousStyle; + icon: typeof iconStyle; + }; + Legend: typeof LegendWidget; +}; + + +// Warnings were encountered during analysis: +// +// src/index.ts:51:18 - (ae-forgotten-export) The symbol "Credentials" needs to be exported by the entry point index.d.ts +// src/index.ts:51:18 - (ae-forgotten-export) The symbol "setDefaultCredentials" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "Layer" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "Popup" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "createMap" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "createGoogleMap" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "CategoryDataView" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "FormulaDataView" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "HistogramDataView" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "CategoryWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "FormulaWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "HistogramWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "basicStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "colorBinsStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "colorCategoriesStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "colorContinuousStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "sizeBinsStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "sizeCategoriesStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "sizeContinuousStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "iconStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:96:17 - (ae-forgotten-export) The symbol "LegendWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:102:1 - (ae-forgotten-export) The symbol "GeoJSONSource" needs to be exported by the entry point index.d.ts +// src/index.ts:103:1 - (ae-forgotten-export) The symbol "SQLSource" needs to be exported by the entry point index.d.ts +// src/index.ts:104:1 - (ae-forgotten-export) The symbol "DatasetSource" needs to be exported by the entry point index.d.ts +// src/index.ts:105:1 - (ae-forgotten-export) The symbol "BQSource" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` From 243f51f48554bca2f0e9e704cd32c4117e51bc9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Thu, 3 Sep 2020 00:16:18 +0200 Subject: [PATCH 4/9] chore: basic references in package --- package-lock.json | 33 +++++++++++++++++++++++++++++++++ package.json | 4 +++- 2 files changed, 36 insertions(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index 196ef1db..0f05a0ed 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2562,6 +2562,39 @@ "gl-matrix": "^3.0.0" } }, + "@microsoft/api-documenter": { + "version": "7.8.37", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.8.37.tgz", + "integrity": "sha512-Nyf/W+GHYeZ4No1nfuHjovWHof2413+PdmPzjc4RTAD3eHx2zcIemrk9a6HzjgIpM6fT9GTO1ZZd4/khDssEqA==", + "dev": true, + "requires": { + "@microsoft/api-extractor-model": "7.8.19", + "@microsoft/tsdoc": "0.12.19", + "@rushstack/node-core-library": "3.30.0", + "@rushstack/ts-command-line": "4.6.4", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "dependencies": { + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "dev": true + }, + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dev": true, + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + } + } + }, "@microsoft/api-extractor": { "version": "7.9.11", "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.9.11.tgz", diff --git a/package.json b/package.json index f96e7cc9..1271abc0 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "lib": "src", "example": "examples" }, - "types": "dist/types/index.d.ts", + "types": "dist/web-sdk.d.ts", "scripts": { "prettify": "prettier --write 'src/**/*.ts'", "lint": "eslint 'src/**/*{.ts,.tsx}' --no-error-on-unmatched-pattern", @@ -29,6 +29,7 @@ "build:cjs": "BABEL_ENV=COMMONJS npx babel --source-maps --config-file ./babel.config.js --out-dir dist/cjs --extensions '.ts' ./src", "build:umd": "webpack --config webpack.config.js", "build:watch": "webpack --config webpack.config.js --watch ", + "build:reference": "npm run build && npx api-extractor run --local --verbose", "prewatch": "rimraf dist/", "prerelease": "npm run build && npm run test", "release": "npx release-it && ./scripts/publish-release.sh", @@ -47,6 +48,7 @@ "@babel/preset-env": "^7.11.0", "@babel/preset-typescript": "^7.10.4", "@danmarshall/deckgl-typings": "^4.3.2", + "@microsoft/api-documenter": "^7.8.37", "@microsoft/api-extractor": "^7.9.11", "@salte-auth/popup": "1.0.0-rc.2", "@salte-auth/salte-auth": "3.0.0-rc.8", From ad953d5920ac5d469331bd4be686308bc1280e68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Thu, 3 Sep 2020 00:16:37 +0200 Subject: [PATCH 5/9] chore: api extractor configuration --- api-extractor.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/api-extractor.json b/api-extractor.json index b8baa574..72d3e7ba 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -181,7 +181,7 @@ /** * (REQUIRED) Whether to generate the .d.ts rollup file. */ - "enabled": true + "enabled": true, /** * Specifies the output path for a .d.ts rollup file to be generated without any trimming. @@ -195,7 +195,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "/dist/.d.ts" */ - // "untrimmedFilePath": "/dist/.d.ts", + "untrimmedFilePath": "/dist/.d.ts", /** * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. @@ -221,7 +221,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "" */ - // "publicTrimmedFilePath": "/dist/-public.d.ts", + "publicTrimmedFilePath": "/dist/-public.d.ts", /** * When a declaration is trimmed, by default it will be replaced by a code comment such as @@ -299,7 +299,7 @@ * * DEFAULT VALUE: "warning" */ - "logLevel": "warning" + "logLevel": "warning", /** * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), @@ -308,7 +308,7 @@ * * DEFAULT VALUE: false */ - // "addToApiReportFile": false + "addToApiReportFile": true } // "TS2551": { From a81725b706cea81a956c7bdf2d0d8839866b6c12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Thu, 3 Sep 2020 08:42:54 +0200 Subject: [PATCH 6/9] chore: add package documentation to entry point --- src/index.ts | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/index.ts b/src/index.ts index a2edaa58..a46faf94 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,3 +1,14 @@ +// Copyright (c) CARTO 2020. All rights reserved. Licensed under the BSD-3 license. + +/** + * Web SDK + * + * @remarks + * A JavaScript library to create custom applications on top of CARTO, using deck.gl + * + * @packageDocumentation + */ + // Auth import { Credentials, setDefaultCredentials } from './auth'; From b91508e5e0a6e16f525c87554ca2bbb003584e1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Thu, 3 Sep 2020 09:28:24 +0200 Subject: [PATCH 7/9] chore: add basic header to Layer --- src/viz/layer/Layer.ts | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/viz/layer/Layer.ts b/src/viz/layer/Layer.ts index 1732cc56..0e6f61c6 100644 --- a/src/viz/layer/Layer.ts +++ b/src/viz/layer/Layer.ts @@ -32,6 +32,16 @@ export enum LayerEvent { FILTER_CHANGE = 'filterChange' // must be the same value as GenericDataSourceEvent.FILTER_CHANGE } +/** + * Main class of the library, representing a layer connected to a CARTO datasource + * + * @export + * @class Layer + * @extends {WithEvents} + * @implements {StyledLayer} + * + * @public + */ export class Layer extends WithEvents implements StyledLayer { // #region Private props private _source: Source; From e61d2b87ac14bbdab09e03256b487b940543a186 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Thu, 3 Sep 2020 09:28:59 +0200 Subject: [PATCH 8/9] chore: initial automatic api report --- docs/etc/web-sdk.api.md | 178 +++++++++++++++++++++++++++++++++------- 1 file changed, 150 insertions(+), 28 deletions(-) diff --git a/docs/etc/web-sdk.api.md b/docs/etc/web-sdk.api.md index 7c34b789..8e6cde69 100644 --- a/docs/etc/web-sdk.api.md +++ b/docs/etc/web-sdk.api.md @@ -26,7 +26,7 @@ import { Layer as Layer_2 } from '@/viz'; import { Layer as Layer_3 } from '@/viz/layer'; import { LegendProperties } from '@/viz/legend'; import { LegendWidgetOptions } from '@/viz/legend'; -import { MapOptions } from '@/maps/Client'; +import { MapOptions } from '@/maps'; import { default as mitt_2 } from 'mitt'; import { Source } from '@/viz'; import { SpatialFilters } from '@/viz/filters/types'; @@ -79,32 +79,154 @@ export const viz: { // Warnings were encountered during analysis: // -// src/index.ts:51:18 - (ae-forgotten-export) The symbol "Credentials" needs to be exported by the entry point index.d.ts -// src/index.ts:51:18 - (ae-forgotten-export) The symbol "setDefaultCredentials" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "Layer" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "Popup" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "createMap" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "createGoogleMap" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "CategoryDataView" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "FormulaDataView" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "HistogramDataView" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "CategoryWidget" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "FormulaWidget" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "HistogramWidget" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "basicStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "colorBinsStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "colorCategoriesStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "colorContinuousStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "sizeBinsStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "sizeCategoriesStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "sizeContinuousStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "iconStyle" needs to be exported by the entry point index.d.ts -// src/index.ts:96:17 - (ae-forgotten-export) The symbol "LegendWidget" needs to be exported by the entry point index.d.ts -// src/index.ts:102:1 - (ae-forgotten-export) The symbol "GeoJSONSource" needs to be exported by the entry point index.d.ts -// src/index.ts:103:1 - (ae-forgotten-export) The symbol "SQLSource" needs to be exported by the entry point index.d.ts -// src/index.ts:104:1 - (ae-forgotten-export) The symbol "DatasetSource" needs to be exported by the entry point index.d.ts -// src/index.ts:105:1 - (ae-forgotten-export) The symbol "BQSource" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) +// node_modules/@math.gl/core/src/addons/polygon.d.ts:10:3 - (TS7010) 'forEachSegment', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:16:6 - (TS7006) Parameter 'arrayOrObject' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:17:12 - (TS7006) Parameter 'target' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:36:7 - (TS7019) Rest parameter 'vectors' implicitly has an 'any[]' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:37:12 - (TS7019) Rest parameter 'vectors' implicitly has an 'any[]' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:39:9 - (TS7006) Parameter 'scale' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:43:7 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:44:13 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:45:13 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:46:13 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:47:18 - (TS7006) Parameter 'scalar' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:48:16 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:49:15 - (TS7006) Parameter 'min' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:49:20 - (TS7006) Parameter 'max' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/math-array.d.ts:53:20 - (TS7006) Parameter 'scalar' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/matrix.d.ts:8:3 - (TS7010) 'getElement', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/base/matrix.d.ts:10:3 - (TS7010) 'setElement', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/base/matrix.d.ts:11:3 - (TS7010) 'getColumn', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/base/matrix.d.ts:12:3 - (TS7010) 'setColumn', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:19:12 - (TS7006) Parameter 'mathArray' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:21:19 - (TS7006) Parameter 'mathArray' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:23:7 - (TS7006) Parameter 'mathArray' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:28:12 - (TS7019) Rest parameter 'vectors' implicitly has an 'any[]' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:30:10 - (TS7019) Rest parameter 'vectors' implicitly has an 'any[]' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:35:21 - (TS7006) Parameter 'vector' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:37:16 - (TS7006) Parameter 'i' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:38:16 - (TS7006) Parameter 'i' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/base/vector.d.ts:38:19 - (TS7006) Parameter 'value' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:27:8 - (TS7006) Parameter 'array' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:31:3 - (TS7010) 'set', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:45:3 - (TS7010) 'setRowMajor', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:56:3 - (TS7010) 'setRowMajor', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:81:13 - (TS7006) Parameter 'vec' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:88:19 - (TS7006) Parameter 'vector' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:88:27 - (TS7006) Parameter 'result' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:88:3 - (TS7010) 'transformVector', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:89:20 - (TS7006) Parameter 'vector' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:89:28 - (TS7006) Parameter 'result' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:89:3 - (TS7010) 'transformVector2', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:90:20 - (TS7006) Parameter 'vector' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:90:28 - (TS7006) Parameter 'result' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix3.d.ts:90:3 - (TS7010) 'transformVector3', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:17:3 - (TS7010) 'copy', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:20:3 - (TS7010) 'set', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:38:3 - (TS7010) 'setRowMajor', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:57:3 - (TS7010) 'toRowMajor', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:117:3 - (TS7010) 'getRotation', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:118:3 - (TS7010) 'getRotationMatrix3', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:128:9 - (TS7006) Parameter 'factor' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:129:13 - (TS7006) Parameter 'vec' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:134:14 - (TS7006) Parameter 'radians' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/matrix4.d.ts:134:23 - (TS7006) Parameter 'axis' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:30:20 - (TS7006) Parameter 'axis' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:30:26 - (TS7006) Parameter 'rad' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:42:16 - (TS7006) Parameter 'axis' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:42:22 - (TS7006) Parameter 'rad' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:53:14 - (TS7006) Parameter 'vectorA' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:53:23 - (TS7006) Parameter 'vectorB' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:74:8 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:74:11 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:74:14 - (TS7006) Parameter 't' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:77:17 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:77:20 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:79:16 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:79:19 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:100:20 - (TS7006) Parameter 'vector' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:100:28 - (TS7006) Parameter 'result' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:100:3 - (TS7010) 'transformVector4', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:104:20 - (TS7006) Parameter 'axis' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:104:26 - (TS7006) Parameter 'rad' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:105:15 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:105:18 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:106:12 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/quaternion.d.ts:106:15 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector2.d.ts:37:14 - (TS7006) Parameter 'object' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector3.d.ts:32:3 - (TS7010) 'set', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/vector3.d.ts:34:3 - (TS7010) 'copy', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/vector3.d.ts:36:14 - (TS7006) Parameter 'object' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector3.d.ts:36:3 - (TS7010) 'fromObject', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/vector3.d.ts:37:12 - (TS7006) Parameter 'object' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector3.d.ts:37:3 - (TS7010) 'toObject', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:16:7 - (TS7006) Parameter 'x' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:16:10 - (TS7006) Parameter 'y' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:16:13 - (TS7006) Parameter 'z' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:16:16 - (TS7006) Parameter 'w' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:16:3 - (TS7010) 'set', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:18:8 - (TS7006) Parameter 'array' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:18:3 - (TS7010) 'copy', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:20:14 - (TS7006) Parameter 'object' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:20:3 - (TS7010) 'fromObject', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:22:12 - (TS7006) Parameter 'object' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/classes/vector4.d.ts:22:3 - (TS7010) 'toObject', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:50:25 - (TS7006) Parameter 'degrees' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:50:34 - (TS7006) Parameter 'result' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:50:17 - (TS7010) 'radians', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:51:25 - (TS7006) Parameter 'radians' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:51:34 - (TS7006) Parameter 'result' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:51:17 - (TS7010) 'degrees', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:57:21 - (TS7006) Parameter 'radians' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:57:17 - (TS7010) 'cos', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:59:21 - (TS7006) Parameter 'radians' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:59:17 - (TS7010) 'tan', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:62:22 - (TS7006) Parameter 'radians' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:62:17 - (TS7010) 'asin', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:64:22 - (TS7006) Parameter 'radians' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:64:17 - (TS7010) 'acos', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:66:22 - (TS7006) Parameter 'radians' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:66:17 - (TS7010) 'atan', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:69:23 - (TS7006) Parameter 'value' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:69:30 - (TS7006) Parameter 'min' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:69:35 - (TS7006) Parameter 'max' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:69:17 - (TS7010) 'clamp', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:72:22 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:72:25 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:72:17 - (TS7010) 'lerp', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:74:24 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:74:27 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:74:17 - (TS7010) 'equals', which lacks return-type annotation, implicitly has an 'any' return type. +// node_modules/@math.gl/core/src/lib/common.d.ts:76:29 - (TS7006) Parameter 'a' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:76:32 - (TS7006) Parameter 'b' implicitly has an 'any' type. +// node_modules/@math.gl/core/src/lib/common.d.ts:76:17 - (TS7010) 'exactEquals', which lacks return-type annotation, implicitly has an 'any' return type. +// src/index.ts:62:18 - (ae-forgotten-export) The symbol "Credentials" needs to be exported by the entry point index.d.ts +// src/index.ts:62:18 - (ae-forgotten-export) The symbol "setDefaultCredentials" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "Layer" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "Popup" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "createMap" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "createGoogleMap" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "CategoryDataView" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "FormulaDataView" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "HistogramDataView" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "CategoryWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "FormulaWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "HistogramWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "basicStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "colorBinsStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "colorCategoriesStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "colorContinuousStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "sizeBinsStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "sizeCategoriesStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "sizeContinuousStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "iconStyle" needs to be exported by the entry point index.d.ts +// src/index.ts:107:17 - (ae-forgotten-export) The symbol "LegendWidget" needs to be exported by the entry point index.d.ts +// src/index.ts:113:1 - (ae-forgotten-export) The symbol "GeoJSONSource" needs to be exported by the entry point index.d.ts +// src/index.ts:114:1 - (ae-forgotten-export) The symbol "SQLSource" needs to be exported by the entry point index.d.ts +// src/index.ts:115:1 - (ae-forgotten-export) The symbol "DatasetSource" needs to be exported by the entry point index.d.ts +// src/index.ts:116:1 - (ae-forgotten-export) The symbol "BQSource" needs to be exported by the entry point index.d.ts +// src/viz/basemap/createGoogleMap.ts:50:35 - (TS2339) Property 'deck' does not exist on type 'Window & typeof globalThis'. +// src/viz/basemap/createMap.ts:59:15 - (TS2339) Property 'deck' does not exist on type 'Window & typeof globalThis'. +// src/viz/basemap/createMap.ts:85:31 - (TS2339) Property 'deck' does not exist on type 'Window & typeof globalThis'. ``` From c6ff4cf956a91631d558af2baa26f1055482771a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Velarde?= Date: Thu, 3 Sep 2020 09:29:55 +0200 Subject: [PATCH 9/9] chore: rename script for api extraction --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 1271abc0..426490b9 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,7 @@ "build:cjs": "BABEL_ENV=COMMONJS npx babel --source-maps --config-file ./babel.config.js --out-dir dist/cjs --extensions '.ts' ./src", "build:umd": "webpack --config webpack.config.js", "build:watch": "webpack --config webpack.config.js --watch ", - "build:reference": "npm run build && npx api-extractor run --local --verbose", + "build:extract-api": "npm run build && npx api-extractor run --local --verbose", "prewatch": "rimraf dist/", "prerelease": "npm run build && npm run test", "release": "npx release-it && ./scripts/publish-release.sh",