diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0d510dc68..4ba9e3c943 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,6 @@ yarn test --watch - Create a new feature branch based off the `master` branch. - Make sure all tests pass and there are no linting errors. - Submit a pull request, referencing any issues it addresses. -- If you changed external-facing types, make sure to also build the project locally and include the updated API report file etc/redux-toolkit.api.md in your pull request. Please try to keep your pull request focused in scope and avoid including unrelated commits. diff --git a/packages/toolkit/api-extractor-react.json b/packages/toolkit/api-extractor-react.json deleted file mode 100644 index 35ed8b94dd..0000000000 --- a/packages/toolkit/api-extractor-react.json +++ /dev/null @@ -1,356 +0,0 @@ -/** - * 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 "<projectFolder>" 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 "<lookup>", 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: <lookup> - * DEFAULT VALUE: "<lookup>" - */ - "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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - */ - "mainEntryPointFilePath": "dist/react/index.d.ts", - //"mainEntryPointFilePath": "/home/weber/tmp/rtk-origin-master/dist/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 "<projectFolder>". - * - * Note: This setting will be ignored if "overrideTsconfig" is used. - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/tsconfig.json" - */ - // "tsconfigFilePath": "<projectFolder>/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: <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<unscopedPackageName>.api.md" - */ - "reportFileName": "redux-toolkit-react.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/etc/" - */ - "reportFolder": "<projectFolder>/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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/" - */ - // "reportTempFolder": "<projectFolder>/temp/" - }, - - /** - * Configures how the doc model file (*.api.json) will be generated. - */ - "docModel": { - /** - * (REQUIRED) Whether to generate a doc model file. - */ - "enabled": false - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json" - */ - // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json" - }, - - /** - * Configures how the .d.ts rollup file will be generated. - */ - "dtsRollup": { - /** - * (REQUIRED) Whether to generate the .d.ts rollup file. - */ - "enabled": false, - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts" - */ - "untrimmedFilePath": "<projectFolder>/dist/react/typings.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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": false - - /** - * 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 "<projectFolder>". - * - * The default value is "<lookup>", 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: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<lookup>" - */ - // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json" - }, - - /** - * 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-forgotten-export": { - "logLevel": "none", - "addToApiReportFile": false - } - // - // . . . - }, - - /** - * 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": "none" - // "addToApiReportFile": false - } - - // "tsdoc-link-tag-unescaped-text": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - } - } -} diff --git a/packages/toolkit/api-extractor.json b/packages/toolkit/api-extractor.json deleted file mode 100644 index c931995350..0000000000 --- a/packages/toolkit/api-extractor.json +++ /dev/null @@ -1,356 +0,0 @@ -/** - * 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 "<projectFolder>" 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 "<lookup>", 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: <lookup> - * DEFAULT VALUE: "<lookup>" - */ - "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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - */ - "mainEntryPointFilePath": "dist/index.d.ts", - //"mainEntryPointFilePath": "/home/weber/tmp/rtk-origin-master/dist/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 "<projectFolder>". - * - * Note: This setting will be ignored if "overrideTsconfig" is used. - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/tsconfig.json" - */ - // "tsconfigFilePath": "<projectFolder>/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: <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<unscopedPackageName>.api.md" - */ - "reportFileName": "redux-toolkit.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/etc/" - */ - "reportFolder": "<projectFolder>/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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/" - */ - // "reportTempFolder": "<projectFolder>/temp/" - }, - - /** - * Configures how the doc model file (*.api.json) will be generated. - */ - "docModel": { - /** - * (REQUIRED) Whether to generate a doc model file. - */ - "enabled": false - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json" - */ - // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json" - }, - - /** - * Configures how the .d.ts rollup file will be generated. - */ - "dtsRollup": { - /** - * (REQUIRED) Whether to generate the .d.ts rollup file. - */ - "enabled": false, - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts" - */ - "untrimmedFilePath": "<projectFolder>/dist/typings.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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": false - - /** - * 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 "<projectFolder>". - * - * The default value is "<lookup>", 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: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<lookup>" - */ - // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json" - }, - - /** - * 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-forgotten-export": { - "logLevel": "none", - "addToApiReportFile": false - } - // - // . . . - }, - - /** - * 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": "none" - // "addToApiReportFile": false - } - - // "tsdoc-link-tag-unescaped-text": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - } - } -} diff --git a/packages/toolkit/api-extractor.query-react.json b/packages/toolkit/api-extractor.query-react.json deleted file mode 100644 index e8a86d387e..0000000000 --- a/packages/toolkit/api-extractor.query-react.json +++ /dev/null @@ -1,356 +0,0 @@ -/** - * 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 "<projectFolder>" 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 "<lookup>", 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: <lookup> - * DEFAULT VALUE: "<lookup>" - */ - "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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - */ - "mainEntryPointFilePath": "dist/query/react/index.d.ts", - //"mainEntryPointFilePath": "/home/weber/tmp/rtk-origin-master/dist/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 "<projectFolder>". - * - * Note: This setting will be ignored if "overrideTsconfig" is used. - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/tsconfig.json" - */ - // "tsconfigFilePath": "<projectFolder>/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: <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<unscopedPackageName>.api.md" - */ - "reportFileName": "rtk-query-react.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/etc/" - */ - "reportFolder": "<projectFolder>/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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/" - */ - // "reportTempFolder": "<projectFolder>/temp/" - }, - - /** - * Configures how the doc model file (*.api.json) will be generated. - */ - "docModel": { - /** - * (REQUIRED) Whether to generate a doc model file. - */ - "enabled": false - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json" - */ - // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json" - }, - - /** - * Configures how the .d.ts rollup file will be generated. - */ - "dtsRollup": { - /** - * (REQUIRED) Whether to generate the .d.ts rollup file. - */ - "enabled": false, - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts" - */ - "untrimmedFilePath": "<projectFolder>/dist/query/react/typings.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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": false - - /** - * 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 "<projectFolder>". - * - * The default value is "<lookup>", 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: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<lookup>" - */ - // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json" - }, - - /** - * 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-forgotten-export": { - "logLevel": "none", - "addToApiReportFile": false - } - // - // . . . - }, - - /** - * 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": "none" - // "addToApiReportFile": false - } - - // "tsdoc-link-tag-unescaped-text": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - } - } -} diff --git a/packages/toolkit/api-extractor.query.json b/packages/toolkit/api-extractor.query.json deleted file mode 100644 index c970908466..0000000000 --- a/packages/toolkit/api-extractor.query.json +++ /dev/null @@ -1,356 +0,0 @@ -/** - * 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 "<projectFolder>" 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 "<lookup>", 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: <lookup> - * DEFAULT VALUE: "<lookup>" - */ - "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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - */ - "mainEntryPointFilePath": "dist/query/index.d.ts", - //"mainEntryPointFilePath": "/home/weber/tmp/rtk-origin-master/dist/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 "<projectFolder>". - * - * Note: This setting will be ignored if "overrideTsconfig" is used. - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/tsconfig.json" - */ - // "tsconfigFilePath": "<projectFolder>/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: <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<unscopedPackageName>.api.md" - */ - "reportFileName": "rtk-query.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/etc/" - */ - "reportFolder": "<projectFolder>/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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/" - */ - // "reportTempFolder": "<projectFolder>/temp/" - }, - - /** - * Configures how the doc model file (*.api.json) will be generated. - */ - "docModel": { - /** - * (REQUIRED) Whether to generate a doc model file. - */ - "enabled": false - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json" - */ - // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json" - }, - - /** - * Configures how the .d.ts rollup file will be generated. - */ - "dtsRollup": { - /** - * (REQUIRED) Whether to generate the .d.ts rollup file. - */ - "enabled": false, - - /** - * 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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts" - */ - "untrimmedFilePath": "<projectFolder>/dist/query/typings.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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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 "<projectFolder>". - * - * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "" - */ - // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-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": false - - /** - * 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 "<projectFolder>". - * - * The default value is "<lookup>", 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: <projectFolder>, <packageName>, <unscopedPackageName> - * DEFAULT VALUE: "<lookup>" - */ - // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json" - }, - - /** - * 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-forgotten-export": { - "logLevel": "none", - "addToApiReportFile": false - } - // - // . . . - }, - - /** - * 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": "none" - // "addToApiReportFile": false - } - - // "tsdoc-link-tag-unescaped-text": { - // "logLevel": "warning", - // "addToApiReportFile": true - // }, - // - // . . . - } - } -} diff --git a/packages/toolkit/etc/redux-toolkit.api.md b/packages/toolkit/etc/redux-toolkit.api.md deleted file mode 100644 index dcfe7462b0..0000000000 --- a/packages/toolkit/etc/redux-toolkit.api.md +++ /dev/null @@ -1,840 +0,0 @@ -## API Report File for "@reduxjs/toolkit" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import type { Action } from 'redux' -import type { ActionCreator } from 'redux' -import type { UnknownAction } from 'redux' -import type { CombinedState } from 'redux' -import { default as createNextState } from 'immer' -import { createSelector } from 'reselect' -import { current } from 'immer' -import type { Dispatch } from 'redux' -import { Draft } from 'immer' -import { freeze } from 'immer' -import { isDraft } from 'immer' -import type { Middleware } from 'redux' -import { original } from 'immer' -import { OutputParametricSelector } from 'reselect' -import { OutputSelector } from 'reselect' -import { ParametricSelector } from 'reselect' -import type { PreloadedState } from 'redux' -import type { Reducer } from 'redux' -import type { ReducersMapObject } from 'redux' -import { Selector } from 'reselect' -import type { Store } from 'redux' -import type { StoreEnhancer } from 'redux' -import { ThunkAction } from 'redux-thunk' -import { ThunkDispatch } from 'redux-thunk' -import type { ThunkMiddleware } from 'redux-thunk' - -// @public -export interface ActionCreatorWithNonInferrablePayload< - T extends string = string, -> extends BaseActionCreator<unknown, T> { - <PT extends unknown>(payload: PT): PayloadAction<PT, T> -} - -// @public -export interface ActionCreatorWithOptionalPayload<P, T extends string = string> - extends BaseActionCreator<P, T> { - (payload?: P): PayloadAction<P, T> -} - -// @public -export interface ActionCreatorWithoutPayload<T extends string = string> - extends BaseActionCreator<undefined, T> { - (): PayloadAction<undefined, T> -} - -// @public -export interface ActionCreatorWithPayload<P, T extends string = string> - extends BaseActionCreator<P, T> { - (payload: P): PayloadAction<P, T> -} - -// @public -export interface ActionCreatorWithPreparedPayload< - Args extends unknown[], - P, - T extends string = string, - E = never, - M = never, -> extends BaseActionCreator<P, T, M, E> { - (...args: Args): PayloadAction<P, T, M, E> -} - -// @public (undocumented) -export type ActionMatchingAllOf< - Matchers extends [Matcher<any>, ...Matcher<any>[]], -> = UnionToIntersection<ActionMatchingAnyOf<Matchers>> - -// @public (undocumented) -export type ActionMatchingAnyOf< - Matchers extends [Matcher<any>, ...Matcher<any>[]], -> = ActionFromMatcher<Matchers[number]> - -// @public -export interface ActionReducerMapBuilder<State> { - addCase<ActionCreator extends TypedActionCreator<string>>( - actionCreator: ActionCreator, - reducer: CaseReducer<State, ReturnType<ActionCreator>>, - ): ActionReducerMapBuilder<State> - addCase<Type extends string, A extends Action<Type>>( - type: Type, - reducer: CaseReducer<State, A>, - ): ActionReducerMapBuilder<State> - addDefaultCase(reducer: CaseReducer<State, UnknownAction>): {} - addMatcher<A>( - matcher: TypeGuard<A> | ((action: any) => boolean), - reducer: CaseReducer<State, A extends Action ? A : A & Action>, - ): Omit<ActionReducerMapBuilder<State>, 'addCase'> -} - -// @public @deprecated -export type Actions<T extends keyof any = string> = Record<T, Action> - -// @public -export type AsyncThunk< - Returned, - ThunkArg, - ThunkApiConfig extends AsyncThunkConfig, -> = AsyncThunkActionCreator<Returned, ThunkArg, ThunkApiConfig> & { - pending: AsyncThunkPendingActionCreator<ThunkArg, ThunkApiConfig> - rejected: AsyncThunkRejectedActionCreator<ThunkArg, ThunkApiConfig> - fulfilled: AsyncThunkFulfilledActionCreator< - Returned, - ThunkArg, - ThunkApiConfig - > - typePrefix: string -} - -// @public -export type AsyncThunkAction< - Returned, - ThunkArg, - ThunkApiConfig extends AsyncThunkConfig, -> = ( - dispatch: GetDispatch<ThunkApiConfig>, - getState: () => GetState<ThunkApiConfig>, - extra: GetExtra<ThunkApiConfig>, -) => Promise< - | ReturnType<AsyncThunkFulfilledActionCreator<Returned, ThunkArg>> - | ReturnType<AsyncThunkRejectedActionCreator<ThunkArg, ThunkApiConfig>> -> & { - abort: (reason?: string) => void - requestId: string - arg: ThunkArg - unwrap: () => Promise<Returned> -} - -// @public -export type AsyncThunkOptions< - ThunkArg = void, - ThunkApiConfig extends AsyncThunkConfig = {}, -> = { - condition?( - arg: ThunkArg, - api: Pick<GetThunkAPI<ThunkApiConfig>, 'getState' | 'extra'>, - ): MaybePromise<boolean | undefined> - dispatchConditionRejection?: boolean - serializeError?: (x: unknown) => GetSerializedErrorType<ThunkApiConfig> - idGenerator?: (arg: ThunkArg) => string -} & IsUnknown< - GetPendingMeta<ThunkApiConfig>, - { - getPendingMeta?( - base: { - arg: ThunkArg - requestId: string - }, - api: Pick<GetThunkAPI<ThunkApiConfig>, 'getState' | 'extra'>, - ): GetPendingMeta<ThunkApiConfig> - }, - { - getPendingMeta( - base: { - arg: ThunkArg - requestId: string - }, - api: Pick<GetThunkAPI<ThunkApiConfig>, 'getState' | 'extra'>, - ): GetPendingMeta<ThunkApiConfig> - } -> - -// @public -export type AsyncThunkPayloadCreator< - Returned, - ThunkArg = void, - ThunkApiConfig extends AsyncThunkConfig = {}, -> = ( - arg: ThunkArg, - thunkAPI: GetThunkAPI<ThunkApiConfig>, -) => AsyncThunkPayloadCreatorReturnValue<Returned, ThunkApiConfig> - -// @public -export type AsyncThunkPayloadCreatorReturnValue< - Returned, - ThunkApiConfig extends AsyncThunkConfig, -> = MaybePromise< - | IsUnknown< - GetFulfilledMeta<ThunkApiConfig>, - Returned, - FulfillWithMeta<Returned, GetFulfilledMeta<ThunkApiConfig>> - > - | RejectWithValue< - GetRejectValue<ThunkApiConfig>, - GetRejectedMeta<ThunkApiConfig> - > -> - -// @public -export type CaseReducer<S = any, A extends Action = UnknownAction> = ( - state: Draft<S>, - action: A, -) => S | void | Draft<S> - -// @public -export type CaseReducerActions<CaseReducers extends SliceCaseReducers<any>> = { - [Type in keyof CaseReducers]: CaseReducers[Type] extends { - prepare: any - } - ? ActionCreatorForCaseReducerWithPrepare<CaseReducers[Type]> - : ActionCreatorForCaseReducer<CaseReducers[Type]> -} - -// @public @deprecated -export type CaseReducers<S, AS extends Actions> = { - [T in keyof AS]: AS[T] extends Action ? CaseReducer<S, AS[T]> : void -} - -// @public -export type CaseReducerWithPrepare<State, Action extends PayloadAction> = { - reducer: CaseReducer<State, Action> - prepare: PrepareAction<Action['payload']> -} - -// @public (undocumented) -export type Comparer<T> = (a: T, b: T) => number - -// @public -export type ConfigureEnhancersCallback = ( - defaultEnhancers: readonly StoreEnhancer[], -) => StoreEnhancer[] - -// @public -export function configureStore< - S = any, - A extends Action = UnknownAction, - M extends Middlewares<S> = [ThunkMiddlewareFor<S>], ->(options: ConfigureStoreOptions<S, A, M>): EnhancedStore<S, A, M> - -// @public -export interface ConfigureStoreOptions< - S = any, - A extends Action = UnknownAction, - M extends Middlewares<S> = Middlewares<S>, -> { - devTools?: boolean | EnhancerOptions - enhancers?: StoreEnhancer[] | ConfigureEnhancersCallback - middleware?: ((getDefaultMiddleware: CurriedGetDefaultMiddleware<S>) => M) | M - preloadedState?: PreloadedState<CombinedState<NoInfer<S>>> - reducer: Reducer<S, A> | ReducersMapObject<S, A> -} - -// @public -export function createAction<P = void, T extends string = string>( - type: T, -): PayloadActionCreator<P, T> - -// @public -export function createAction< - PA extends PrepareAction<any>, - T extends string = string, ->( - type: T, - prepareAction: PA, -): PayloadActionCreator<ReturnType<PA>['payload'], T, PA> - -// @public (undocumented) -export function createAsyncThunk<Returned, ThunkArg = void>( - typePrefix: string, - payloadCreator: AsyncThunkPayloadCreator<Returned, ThunkArg, {}>, - options?: AsyncThunkOptions<ThunkArg, {}>, -): AsyncThunk<Returned, ThunkArg, {}> - -// @public (undocumented) -export function createAsyncThunk< - Returned, - ThunkArg, - ThunkApiConfig extends AsyncThunkConfig, ->( - typePrefix: string, - payloadCreator: AsyncThunkPayloadCreator<Returned, ThunkArg, ThunkApiConfig>, - options?: AsyncThunkOptions<ThunkArg, ThunkApiConfig>, -): AsyncThunk<Returned, ThunkArg, ThunkApiConfig> - -// @public -export const createDraftSafeSelector: typeof createSelector - -// @public (undocumented) -export function createEntityAdapter<T>(options?: { - selectId?: IdSelector<T> - sortComparer?: false | Comparer<T> -}): EntityAdapter<T> - -// @public -export function createImmutableStateInvariantMiddleware( - options?: ImmutableStateInvariantMiddlewareOptions, -): Middleware - -export { createNextState } - -// @public -export function createReducer<S extends NotFunction<any>>( - initialState: S | (() => S), - builderCallback: (builder: ActionReducerMapBuilder<S>) => void, -): ReducerWithInitialState<S> - -// @public -export function createReducer< - S extends NotFunction<any>, - CR extends CaseReducers<S, any> = CaseReducers<S, any>, ->( - initialState: S | (() => S), - actionsMap: CR, - actionMatchers?: ActionMatcherDescriptionCollection<S>, - defaultCaseReducer?: CaseReducer<S>, -): ReducerWithInitialState<S> - -export { createSelector } - -// @public -export function createSerializableStateInvariantMiddleware( - options?: SerializableStateInvariantMiddlewareOptions, -): Middleware - -// @public -export function createSlice< - State, - CaseReducers extends SliceCaseReducers<State>, - Name extends string = string, ->( - options: CreateSliceOptions<State, CaseReducers, Name>, -): Slice<State, CaseReducers, Name> - -// @public -export interface CreateSliceOptions< - State = any, - CR extends SliceCaseReducers<State> = SliceCaseReducers<State>, - Name extends string = string, -> { - extraReducers?: - | CaseReducers<NoInfer<State>, any> - | ((builder: ActionReducerMapBuilder<NoInfer<State>>) => void) - initialState: State | (() => State) - name: Name - reducers: ValidateSliceCaseReducers<State, CR> -} - -export { current } - -// @public (undocumented) -export interface Dictionary<T> extends DictionaryNum<T> { - // (undocumented) - [id: string]: T | undefined -} - -export { Draft } - -// @public -export interface EnhancedStore< - S = any, - A extends Action = UnknownAction, - M extends Middlewares<S> = Middlewares<S>, -> extends Store<S, A> { - dispatch: Dispatch<A> & DispatchForMiddlewares<M> -} - -// @public (undocumented) -export interface EntityAdapter<T> extends EntityStateAdapter<T> { - // (undocumented) - getInitialState(): EntityState<T> - // (undocumented) - getInitialState<S extends object>(state: S): EntityState<T> & S - // (undocumented) - getSelectors(): EntitySelectors<T, EntityState<T>> - // (undocumented) - getSelectors<V>( - selectState: (state: V) => EntityState<T>, - ): EntitySelectors<T, V> - // (undocumented) - selectId: IdSelector<T> - // (undocumented) - sortComparer: false | Comparer<T> -} - -// @public (undocumented) -export type EntityId = number | string - -// @public (undocumented) -export interface EntitySelectors<T, V> { - // (undocumented) - selectAll: (state: V) => T[] - // (undocumented) - selectById: (state: V, id: EntityId) => T | undefined - // (undocumented) - selectEntities: (state: V) => Dictionary<T> - // (undocumented) - selectIds: (state: V) => EntityId[] - // (undocumented) - selectTotal: (state: V) => number -} - -// @public (undocumented) -export interface EntityState<T> { - // (undocumented) - entities: Dictionary<T> - // (undocumented) - ids: EntityId[] -} - -// @public (undocumented) -export interface EntityStateAdapter<T> { - // (undocumented) - addMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: readonly T[] | Record<EntityId, T>, - ): S - // (undocumented) - addMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: PayloadAction<readonly T[] | Record<EntityId, T>>, - ): S - // (undocumented) - addOne<S extends EntityState<T>>(state: PreventAny<S, T>, entity: T): S - // (undocumented) - addOne<S extends EntityState<T>>( - state: PreventAny<S, T>, - action: PayloadAction<T>, - ): S - // (undocumented) - removeAll<S extends EntityState<T>>(state: PreventAny<S, T>): S - // (undocumented) - removeMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - keys: readonly EntityId[], - ): S - // (undocumented) - removeMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - keys: PayloadAction<readonly EntityId[]>, - ): S - // (undocumented) - removeOne<S extends EntityState<T>>(state: PreventAny<S, T>, key: EntityId): S - // (undocumented) - removeOne<S extends EntityState<T>>( - state: PreventAny<S, T>, - key: PayloadAction<EntityId>, - ): S - // (undocumented) - setAll<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: readonly T[] | Record<EntityId, T>, - ): S - // (undocumented) - setAll<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: PayloadAction<readonly T[] | Record<EntityId, T>>, - ): S - // (undocumented) - setMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: readonly T[] | Record<EntityId, T>, - ): S - // (undocumented) - setMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: PayloadAction<readonly T[] | Record<EntityId, T>>, - ): S - // (undocumented) - setOne<S extends EntityState<T>>(state: PreventAny<S, T>, entity: T): S - // (undocumented) - setOne<S extends EntityState<T>>( - state: PreventAny<S, T>, - action: PayloadAction<T>, - ): S - // (undocumented) - updateMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - updates: ReadonlyArray<Update<T>>, - ): S - // (undocumented) - updateMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - updates: PayloadAction<ReadonlyArray<Update<T>>>, - ): S - // (undocumented) - updateOne<S extends EntityState<T>>( - state: PreventAny<S, T>, - update: Update<T>, - ): S - // (undocumented) - updateOne<S extends EntityState<T>>( - state: PreventAny<S, T>, - update: PayloadAction<Update<T>>, - ): S - // (undocumented) - upsertMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: readonly T[] | Record<EntityId, T>, - ): S - // (undocumented) - upsertMany<S extends EntityState<T>>( - state: PreventAny<S, T>, - entities: PayloadAction<readonly T[] | Record<EntityId, T>>, - ): S - // (undocumented) - upsertOne<S extends EntityState<T>>(state: PreventAny<S, T>, entity: T): S - // (undocumented) - upsertOne<S extends EntityState<T>>( - state: PreventAny<S, T>, - entity: PayloadAction<T>, - ): S -} - -// @public (undocumented) -export function findNonSerializableValue( - value: unknown, - path?: string, - isSerializable?: (value: unknown) => boolean, - getEntries?: (value: unknown) => [string, any][], - ignoredPaths?: readonly (string | RegExp)[], -): NonSerializableValue | false - -export { freeze } - -// @public @deprecated -export function getDefaultMiddleware< - S = any, - O extends Partial<GetDefaultMiddlewareOptions> = { - thunk: true - immutableCheck: true - serializableCheck: true - }, ->(options?: O): MiddlewareArray<Middleware<{}, S> | ThunkMiddlewareFor<S, O>> - -// @public -export function getType<T extends string>( - actionCreator: PayloadActionCreator<any, T>, -): T - -// @public (undocumented) -export type IdSelector<T> = (model: T) => EntityId - -// @public -export interface ImmutableStateInvariantMiddlewareOptions { - // (undocumented) - ignore?: string[] - ignoredPaths?: string[] - isImmutable?: IsImmutableFunc - warnAfter?: number -} - -// @public -export function isAllOf<Matchers extends [Matcher<any>, ...Matcher<any>[]]>( - ...matchers: Matchers -): ( - action: any, -) => action is UnionToIntersection<ActionFromMatcher<Matchers[number]>> - -// @public -export function isAnyOf<Matchers extends [Matcher<any>, ...Matcher<any>[]]>( - ...matchers: Matchers -): (action: any) => action is ActionFromMatcher<Matchers[number]> - -// @public -export function isAsyncThunkAction(): ( - action: any, -) => action is UnknownAsyncThunkAction - -// @public -export function isAsyncThunkAction< - AsyncThunks extends [AnyAsyncThunk, ...AnyAsyncThunk[]], ->( - ...asyncThunks: AsyncThunks -): (action: any) => action is ActionsFromAsyncThunk<AsyncThunks[number]> - -// @public -export function isAsyncThunkAction( - action: any, -): action is UnknownAsyncThunkAction - -export { isDraft } - -// @public -export function isFulfilled(): ( - action: any, -) => action is UnknownAsyncThunkFulfilledAction - -// @public -export function isFulfilled< - AsyncThunks extends [AnyAsyncThunk, ...AnyAsyncThunk[]], ->( - ...asyncThunks: AsyncThunks -): (action: any) => action is FulfilledActionFromAsyncThunk<AsyncThunks[number]> - -// @public -export function isFulfilled( - action: any, -): action is UnknownAsyncThunkFulfilledAction - -// @public -export function isImmutableDefault(value: unknown): boolean - -// @public -export function isPending(): ( - action: any, -) => action is UnknownAsyncThunkPendingAction - -// @public -export function isPending< - AsyncThunks extends [AnyAsyncThunk, ...AnyAsyncThunk[]], ->( - ...asyncThunks: AsyncThunks -): (action: any) => action is PendingActionFromAsyncThunk<AsyncThunks[number]> - -// @public -export function isPending(action: any): action is UnknownAsyncThunkPendingAction - -// @public -export function isPlain(val: any): boolean - -// @public -export function isPlainObject(value: unknown): value is object - -// @public -export function isRejected(): ( - action: any, -) => action is UnknownAsyncThunkRejectedAction - -// @public -export function isRejected< - AsyncThunks extends [AnyAsyncThunk, ...AnyAsyncThunk[]], ->( - ...asyncThunks: AsyncThunks -): (action: any) => action is RejectedActionFromAsyncThunk<AsyncThunks[number]> - -// @public -export function isRejected( - action: any, -): action is UnknownAsyncThunkRejectedAction - -// @public -export function isRejectedWithValue(): ( - action: any, -) => action is UnknownAsyncThunkRejectedAction - -// @public -export function isRejectedWithValue< - AsyncThunks extends [AnyAsyncThunk, ...AnyAsyncThunk[]], ->( - ...asyncThunks: AsyncThunks -): ( - action: any, -) => action is RejectedWithValueActionFromAsyncThunk<AsyncThunks[number]> - -// @public -export function isRejectedWithValue( - action: any, -): action is UnknownAsyncThunkRejectedAction - -// @public (undocumented) -export class MiddlewareArray< - Middlewares extends Middleware<any, any>, -> extends Array<Middlewares> { - // (undocumented) - static get [Symbol.species](): any - constructor(arrayLength?: number) - constructor(...items: Middlewares[]) - // (undocumented) - concat<AdditionalMiddlewares extends ReadonlyArray<Middleware<any, any>>>( - items: AdditionalMiddlewares, - ): MiddlewareArray<Middlewares | AdditionalMiddlewares[number]> - // (undocumented) - concat<AdditionalMiddlewares extends ReadonlyArray<Middleware<any, any>>>( - ...items: AdditionalMiddlewares - ): MiddlewareArray<Middlewares | AdditionalMiddlewares[number]> - // (undocumented) - prepend<AdditionalMiddlewares extends ReadonlyArray<Middleware<any, any>>>( - items: AdditionalMiddlewares, - ): MiddlewareArray<AdditionalMiddlewares[number] | Middlewares> - // (undocumented) - prepend<AdditionalMiddlewares extends ReadonlyArray<Middleware<any, any>>>( - ...items: AdditionalMiddlewares - ): MiddlewareArray<AdditionalMiddlewares[number] | Middlewares> -} - -// @public -export const miniSerializeError: (value: any) => SerializedError - -// @public (undocumented) -export let nanoid: (size?: number) => string - -export { original } - -export { OutputParametricSelector } - -export { OutputSelector } - -export { ParametricSelector } - -// @public -export type PayloadAction< - P = void, - T extends string = string, - M = never, - E = never, -> = { - payload: P - type: T -} & ([M] extends [never] - ? {} - : { - meta: M - }) & - ([E] extends [never] - ? {} - : { - error: E - }) - -// @public -export type PayloadActionCreator< - P = void, - T extends string = string, - PA extends PrepareAction<P> | void = void, -> = IfPrepareActionMethodProvided< - PA, - _ActionCreatorWithPreparedPayload<PA, T>, - IsAny< - P, - ActionCreatorWithPayload<any, T>, - IsUnknownOrNonInferrable< - P, - ActionCreatorWithNonInferrablePayload<T>, - IfVoid< - P, - ActionCreatorWithoutPayload<T>, - IfMaybeUndefined< - P, - ActionCreatorWithOptionalPayload<P, T>, - ActionCreatorWithPayload<P, T> - > - > - > - > -> - -// @public -export type PrepareAction<P> = - | ((...args: any[]) => { - payload: P - }) - | ((...args: any[]) => { - payload: P - meta: any - }) - | ((...args: any[]) => { - payload: P - error: any - }) - | ((...args: any[]) => { - payload: P - meta: any - error: any - }) - -export { Selector } - -// @public -export interface SerializableStateInvariantMiddlewareOptions { - getEntries?: (value: any) => [string, any][] - ignoredActionPaths?: (string | RegExp)[] - ignoredActions?: string[] - ignoredPaths?: (string | RegExp)[] - ignoreState?: boolean - isSerializable?: (value: any) => boolean - warnAfter?: number -} - -// @public (undocumented) -export interface SerializedError { - // (undocumented) - code?: string - // (undocumented) - message?: string - // (undocumented) - name?: string - // (undocumented) - stack?: string -} - -// @public -export interface Slice< - State = any, - CaseReducers extends SliceCaseReducers<State> = SliceCaseReducers<State>, - Name extends string = string, -> { - actions: CaseReducerActions<CaseReducers> - caseReducers: SliceDefinedCaseReducers<CaseReducers> - getInitialState: () => State - name: Name - reducer: Reducer<State> -} - -// @public @deprecated -export type SliceActionCreator<P> = PayloadActionCreator<P> - -// @public -export type SliceCaseReducers<State> = { - [K: string]: - | CaseReducer<State, PayloadAction<any>> - | CaseReducerWithPrepare<State, PayloadAction<any, string, any, any>> -} - -export { ThunkAction } - -export { ThunkDispatch } - -// @public (undocumented) -export function unwrapResult<R extends UnwrappableAction>( - action: R, -): UnwrappedActionPayload<R> - -// @public (undocumented) -export type Update<T> = { - id: EntityId - changes: Partial<T> -} - -// @public -export type ValidateSliceCaseReducers< - S, - ACR extends SliceCaseReducers<S>, -> = ACR & { - [T in keyof ACR]: ACR[T] extends { - reducer(s: S, action?: infer A): any - } - ? { - prepare(...a: never[]): Omit<A, 'type'> - } - : {} -} - -export * from 'redux' - -// (No @packageDocumentation comment for this package) -``` diff --git a/packages/toolkit/etc/rtk-query-react.api.md b/packages/toolkit/etc/rtk-query-react.api.md deleted file mode 100644 index d6945f469b..0000000000 --- a/packages/toolkit/etc/rtk-query-react.api.md +++ /dev/null @@ -1,316 +0,0 @@ -## API Report File for "@reduxjs/toolkit" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import { ActionCreatorWithoutPayload } from '@reduxjs/toolkit' -import { batch } from 'react-redux' -import { Context } from 'react' -import { ReactReduxContextValue } from 'react-redux' -import { ThunkDispatch } from '@reduxjs/toolkit' -import { useDispatch } from 'react-redux' -import { useSelector } from 'react-redux' -import { useStore } from 'react-redux' - -// @public (undocumented) -export type Api< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string, - TagTypes extends string, - Enhancers extends ModuleName = CoreModule, -> = Id< - Id< - UnionToIntersection< - ApiModules<BaseQuery, Definitions, ReducerPath, TagTypes>[Enhancers] - > - > & { - injectEndpoints<NewDefinitions extends EndpointDefinitions>(_: { - endpoints: ( - build: EndpointBuilder<BaseQuery, TagTypes, ReducerPath>, - ) => NewDefinitions - overrideExisting?: boolean - }): Api< - BaseQuery, - Definitions & NewDefinitions, - ReducerPath, - TagTypes, - Enhancers - > - enhanceEndpoints<NewTagTypes extends string = never>(_: { - addTagTypes?: readonly NewTagTypes[] - endpoints?: ReplaceTagTypes< - Definitions, - TagTypes | NoInfer<NewTagTypes> - > extends infer NewDefinitions - ? { - [K in keyof NewDefinitions]?: - | Partial<NewDefinitions[K]> - | ((definition: NewDefinitions[K]) => void) - } - : never - }): Api< - BaseQuery, - ReplaceTagTypes<Definitions, TagTypes | NewTagTypes>, - ReducerPath, - TagTypes | NewTagTypes, - Enhancers - > - } -> - -// @public (undocumented) -export interface ApiModules< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string, - TagTypes extends string, -> {} - -// @public -export function ApiProvider<A extends Api<any, {}, any, any>>(props: { - children: any - api: A - setupListeners?: Parameters<typeof setupListeners>[1] - context?: Context<ReactReduxContextValue | null> -}): JSX.Element - -// @public (undocumented) -export type ApiWithInjectedEndpoints< - ApiDefinition extends Api<any, any, any, any>, - Injections extends ApiDefinition extends Api<infer B, any, infer R, infer E> - ? [Api<B, any, R, E>, ...Api<B, any, R, E>[]] - : never, -> = Omit<ApiDefinition, 'endpoints'> & - Omit<Injections, 'endpoints'> & { - endpoints: ApiDefinition['endpoints'] & - Partial<UnionToIntersection<Injections[number]['endpoints']>> - } - -// @public (undocumented) -export type BaseQueryEnhancer< - AdditionalArgs = unknown, - AdditionalDefinitionExtraOptions = unknown, - Config = void, -> = <BaseQuery extends BaseQueryFn>( - baseQuery: BaseQuery, - config: Config, -) => BaseQueryFn< - BaseQueryArg<BaseQuery> & AdditionalArgs, - BaseQueryResult<BaseQuery>, - BaseQueryError<BaseQuery>, - BaseQueryExtraOptions<BaseQuery> & AdditionalDefinitionExtraOptions -> - -// @public (undocumented) -export type BaseQueryFn< - Args = any, - Result = unknown, - Error = unknown, - DefinitionExtraOptions = {}, - Meta = {}, -> = ( - args: Args, - api: BaseQueryApi, - extraOptions: DefinitionExtraOptions, -) => MaybePromise<QueryReturnValue<Result, Error, Meta>> - -// @public -export function buildCreateApi<Modules extends [Module<any>, ...Module<any>[]]>( - ...modules: Modules -): CreateApi<Modules[number]['name']> - -// @public (undocumented) -export function copyWithStructuralSharing<T>(oldObj: any, newObj: T): T - -// @public -export const coreModule: () => Module<CoreModule> - -// @public (undocumented) -export type CreateApi<Modules extends ModuleName> = { - < - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string = 'api', - TagTypes extends string = never, - >( - options: CreateApiOptions<BaseQuery, Definitions, ReducerPath, TagTypes>, - ): Api<BaseQuery, Definitions, ReducerPath, TagTypes, Modules> -} - -// @public (undocumented) -export const createApi: CreateApi< - typeof coreModuleName | typeof reactHooksModuleName -> - -// @public (undocumented) -export interface CreateApiOptions< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string = 'api', - TagTypes extends string = never, -> { - baseQuery: BaseQuery - endpoints( - build: EndpointBuilder<BaseQuery, TagTypes, ReducerPath>, - ): Definitions - keepUnusedDataFor?: number - reducerPath?: ReducerPath - refetchOnFocus?: boolean - refetchOnMountOrArgChange?: boolean | number - refetchOnReconnect?: boolean - serializeQueryArgs?: SerializeQueryArgs<unknown> - tagTypes?: readonly TagTypes[] -} - -// @public (undocumented) -export type EndpointDefinition< - QueryArg, - BaseQuery extends BaseQueryFn, - TagTypes extends string, - ResultType, - ReducerPath extends string = string, -> = - | QueryDefinition<QueryArg, BaseQuery, TagTypes, ResultType, ReducerPath> - | MutationDefinition<QueryArg, BaseQuery, TagTypes, ResultType, ReducerPath> - -// @public (undocumented) -export type EndpointDefinitions = Record< - string, - EndpointDefinition<any, any, any, any> -> - -// @public -export function fakeBaseQuery<ErrorType>(): BaseQueryFn< - void, - NEVER, - ErrorType, - {} -> - -// @public (undocumented) -export interface FetchArgs extends CustomRequestInit { - // (undocumented) - body?: any - // (undocumented) - params?: Record<string, any> - // (undocumented) - responseHandler?: ResponseHandler - // (undocumented) - url: string - // (undocumented) - validateStatus?: (response: Response, body: any) => boolean -} - -// @public -export function fetchBaseQuery({ - baseUrl, - prepareHeaders, - fetchFn, - ...baseFetchOptions -}?: FetchBaseQueryArgs): BaseQueryFn< - string | FetchArgs, - unknown, - FetchBaseQueryError, - {}, - FetchBaseQueryMeta -> - -// @public (undocumented) -export interface FetchBaseQueryError { - // (undocumented) - data: unknown - // (undocumented) - status: number -} - -// @public (undocumented) -export type Module<Name extends ModuleName> = { - name: Name - init< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string, - TagTypes extends string, - >( - api: Api<BaseQuery, EndpointDefinitions, ReducerPath, TagTypes, ModuleName>, - options: Required< - CreateApiOptions<BaseQuery, Definitions, ReducerPath, TagTypes> - >, - context: ApiContext<Definitions>, - ): { - injectEndpoint( - endpointName: string, - definition: EndpointDefinition<any, any, any, any>, - ): void - } -} - -// @public (undocumented) -export type MutationDefinition< - QueryArg, - BaseQuery extends BaseQueryFn, - TagTypes extends string, - ResultType, - ReducerPath extends string = string, -> = BaseEndpointDefinition<QueryArg, BaseQuery, ResultType> & - MutationExtraOptions<TagTypes, ResultType, QueryArg, BaseQuery, ReducerPath> - -// @public (undocumented) -export type QueryDefinition< - QueryArg, - BaseQuery extends BaseQueryFn, - TagTypes extends string, - ResultType, - ReducerPath extends string = string, -> = BaseEndpointDefinition<QueryArg, BaseQuery, ResultType> & - QueryExtraOptions<TagTypes, ResultType, QueryArg, BaseQuery, ReducerPath> - -// @public -export enum QueryStatus { - // (undocumented) - fulfilled = 'fulfilled', - // (undocumented) - pending = 'pending', - // (undocumented) - rejected = 'rejected', - // (undocumented) - uninitialized = 'uninitialized', -} - -// @public -export const reactHooksModule: ({ - batch, - useDispatch, - useSelector, - useStore, -}?: ReactHooksModuleOptions) => Module<ReactHooksModule> - -// @public -export const retry: BaseQueryEnhancer< - unknown, - StaggerOptions, - void | StaggerOptions -> & { - fail: typeof fail_2 -} - -// @public -export function setupListeners( - dispatch: ThunkDispatch<any, any, any>, - customHandler?: ( - dispatch: ThunkDispatch<any, any, any>, - actions: { - onFocus: typeof onFocus - onFocusLost: typeof onFocusLost - onOnline: typeof onOnline - onOffline: typeof onOffline - }, - ) => () => void, -): () => void - -// @public (undocumented) -export const skipSelector: unique symbol - -// (No @packageDocumentation comment for this package) -``` diff --git a/packages/toolkit/etc/rtk-query.api.md b/packages/toolkit/etc/rtk-query.api.md deleted file mode 100644 index d43183d3de..0000000000 --- a/packages/toolkit/etc/rtk-query.api.md +++ /dev/null @@ -1,331 +0,0 @@ -## API Report File for "@reduxjs/toolkit" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts -import type { ActionCreatorWithoutPayload } from '@reduxjs/toolkit' -import type { UnknownAction } from '@reduxjs/toolkit' -import type { SerializedError } from '@reduxjs/toolkit' -import type { ThunkDispatch } from '@reduxjs/toolkit' - -// @public (undocumented) -export type Api< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string, - TagTypes extends string, - Enhancers extends ModuleName = CoreModule, -> = UnionToIntersection< - ApiModules<BaseQuery, Definitions, ReducerPath, TagTypes>[Enhancers] -> & { - injectEndpoints<NewDefinitions extends EndpointDefinitions>(_: { - endpoints: ( - build: EndpointBuilder<BaseQuery, TagTypes, ReducerPath>, - ) => NewDefinitions - overrideExisting?: boolean - }): Api< - BaseQuery, - Definitions & NewDefinitions, - ReducerPath, - TagTypes, - Enhancers - > - enhanceEndpoints<NewTagTypes extends string = never>(_: { - addTagTypes?: readonly NewTagTypes[] - endpoints?: ReplaceTagTypes< - Definitions, - TagTypes | NoInfer<NewTagTypes> - > extends infer NewDefinitions - ? { - [K in keyof NewDefinitions]?: - | Partial<NewDefinitions[K]> - | ((definition: NewDefinitions[K]) => void) - } - : never - }): Api< - BaseQuery, - ReplaceTagTypes<Definitions, TagTypes | NewTagTypes>, - ReducerPath, - TagTypes | NewTagTypes, - Enhancers - > -} - -// @public (undocumented) -export interface ApiModules< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string, - TagTypes extends string, -> {} - -// @public (undocumented) -export type BaseQueryEnhancer< - AdditionalArgs = unknown, - AdditionalDefinitionExtraOptions = unknown, - Config = void, -> = <BaseQuery extends BaseQueryFn>( - baseQuery: BaseQuery, - config: Config, -) => BaseQueryFn< - BaseQueryArg<BaseQuery> & AdditionalArgs, - BaseQueryResult<BaseQuery>, - BaseQueryError<BaseQuery>, - BaseQueryExtraOptions<BaseQuery> & AdditionalDefinitionExtraOptions -> - -// @public (undocumented) -export type BaseQueryFn< - Args = any, - Result = unknown, - Error = unknown, - DefinitionExtraOptions = { - copyWithStructuralSharing?: boolean - }, - Meta = {}, -> = ( - args: Args, - api: BaseQueryApi, - extraOptions: DefinitionExtraOptions, -) => MaybePromise<QueryReturnValue<Result, Error, Meta>> - -// @public -export function buildCreateApi<Modules extends [Module<any>, ...Module<any>[]]>( - ...modules: Modules -): CreateApi<Modules[number]['name']> - -// @public (undocumented) -export function copyWithStructuralSharing<T>(oldObj: any, newObj: T): T - -// @public -export const coreModule: () => Module<CoreModule> - -// @public (undocumented) -export type CreateApi<Modules extends ModuleName> = { - < - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string = 'api', - TagTypes extends string = never, - >( - options: CreateApiOptions<BaseQuery, Definitions, ReducerPath, TagTypes>, - ): Api<BaseQuery, Definitions, ReducerPath, TagTypes, Modules> -} - -// @public (undocumented) -export const createApi: CreateApi<typeof coreModuleName> - -// @public (undocumented) -export interface CreateApiOptions< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string = 'api', - TagTypes extends string = never, -> { - baseQuery: BaseQuery - endpoints( - build: EndpointBuilder<BaseQuery, TagTypes, ReducerPath>, - ): Definitions - extractRehydrationInfo?: ( - action: UnknownAction, - { - reducerPath, - }: { - reducerPath: ReducerPath - }, - ) => - | undefined - | CombinedState< - NoInfer<Definitions>, - NoInfer<TagTypes>, - NoInfer<ReducerPath> - > - keepUnusedDataFor?: number - reducerPath?: ReducerPath - refetchOnFocus?: boolean - refetchOnMountOrArgChange?: boolean | number - refetchOnReconnect?: boolean - serializeQueryArgs?: SerializeQueryArgs<unknown> - structuralSharing?: boolean - tagTypes?: readonly TagTypes[] -} - -// @public (undocumented) -export type EndpointDefinition< - QueryArg, - BaseQuery extends BaseQueryFn, - TagTypes extends string, - ResultType, - ReducerPath extends string = string, -> = - | QueryDefinition<QueryArg, BaseQuery, TagTypes, ResultType, ReducerPath> - | MutationDefinition<QueryArg, BaseQuery, TagTypes, ResultType, ReducerPath> - -// @public (undocumented) -export type EndpointDefinitions = Record< - string, - EndpointDefinition<any, any, any, any> -> - -// @public -export function fakeBaseQuery<ErrorType>(): BaseQueryFn< - void, - NEVER, - ErrorType, - {} -> - -// @public (undocumented) -export interface FetchArgs extends CustomRequestInit { - // (undocumented) - body?: any - // (undocumented) - params?: Record<string, any> - // (undocumented) - responseHandler?: ResponseHandler - // (undocumented) - url: string - // (undocumented) - validateStatus?: (response: Response, body: any) => boolean -} - -// @public -export function fetchBaseQuery({ - baseUrl, - prepareHeaders, - fetchFn, - paramsSerializer, - ...baseFetchOptions -}?: FetchBaseQueryArgs): BaseQueryFn< - string | FetchArgs, - unknown, - FetchBaseQueryError, - {}, - FetchBaseQueryMeta -> - -// @public (undocumented) -export type FetchBaseQueryError = - | { - status: number - data: unknown - } - | { - status: 'FETCH_ERROR' - data?: undefined - error: string - } - | { - status: 'PARSING_ERROR' - originalStatus: number - data: string - error: string - } - | { - status: 'CUSTOM_ERROR' - data?: unknown - error: string - } - -// @public (undocumented) -export type FetchBaseQueryMeta = { - request: Request - response?: Response -} - -// @public (undocumented) -export type Module<Name extends ModuleName> = { - name: Name - init< - BaseQuery extends BaseQueryFn, - Definitions extends EndpointDefinitions, - ReducerPath extends string, - TagTypes extends string, - >( - api: Api<BaseQuery, EndpointDefinitions, ReducerPath, TagTypes, ModuleName>, - options: WithRequiredProp< - CreateApiOptions<BaseQuery, Definitions, ReducerPath, TagTypes>, - | 'reducerPath' - | 'serializeQueryArgs' - | 'keepUnusedDataFor' - | 'refetchOnMountOrArgChange' - | 'refetchOnFocus' - | 'refetchOnReconnect' - | 'tagTypes' - | 'structuralSharing' - >, - context: ApiContext<Definitions>, - ): { - injectEndpoint( - endpointName: string, - definition: EndpointDefinition<any, any, any, any>, - ): void - } -} - -// @public (undocumented) -export type MutationDefinition< - QueryArg, - BaseQuery extends BaseQueryFn, - TagTypes extends string, - ResultType, - ReducerPath extends string = string, -> = BaseEndpointDefinition<QueryArg, BaseQuery, ResultType> & - MutationExtraOptions<TagTypes, ResultType, QueryArg, BaseQuery, ReducerPath> - -// @public (undocumented) -export type QueryDefinition< - QueryArg, - BaseQuery extends BaseQueryFn, - TagTypes extends string, - ResultType, - ReducerPath extends string = string, -> = BaseEndpointDefinition<QueryArg, BaseQuery, ResultType> & - QueryExtraOptions<TagTypes, ResultType, QueryArg, BaseQuery, ReducerPath> - -// @public -export enum QueryStatus { - // (undocumented) - fulfilled = 'fulfilled', - // (undocumented) - pending = 'pending', - // (undocumented) - rejected = 'rejected', - // (undocumented) - uninitialized = 'uninitialized', -} - -// @public -export const retry: BaseQueryEnhancer< - unknown, - RetryOptions, - void | RetryOptions -> & { - fail: typeof fail_2 -} - -// @public -export function setupListeners( - dispatch: ThunkDispatch<any, any, any>, - customHandler?: ( - dispatch: ThunkDispatch<any, any, any>, - actions: { - onFocus: typeof onFocus - onFocusLost: typeof onFocusLost - onOnline: typeof onOnline - onOffline: typeof onOffline - }, - ) => () => void, -): () => void - -// @public @deprecated (undocumented) -export const skipSelector: symbol - -// @public (undocumented) -export type SkipToken = typeof skipToken - -// @public -export const skipToken: unique symbol - -// (No @packageDocumentation comment for this package) -``` diff --git a/packages/toolkit/package.json b/packages/toolkit/package.json index 7f3b530875..65c4ff70b7 100644 --- a/packages/toolkit/package.json +++ b/packages/toolkit/package.json @@ -52,7 +52,6 @@ "@arethetypeswrong/cli": "^0.13.5", "@babel/core": "^7.24.8", "@babel/helper-module-imports": "^7.24.7", - "@microsoft/api-extractor": "^7.13.2", "@phryneas/ts-version": "^1.0.2", "@size-limit/file": "^11.0.1", "@size-limit/webpack": "^11.0.1", diff --git a/packages/toolkit/src/query/core/setupListeners.ts b/packages/toolkit/src/query/core/setupListeners.ts index 1c52042738..69c38dbb34 100644 --- a/packages/toolkit/src/query/core/setupListeners.ts +++ b/packages/toolkit/src/query/core/setupListeners.ts @@ -1,6 +1,5 @@ import type { ThunkDispatch, - ActionCreatorWithoutPayload, // Workaround for API-Extractor } from '@reduxjs/toolkit' import { createAction } from './rtkImports' diff --git a/packages/toolkit/tsup.config.ts b/packages/toolkit/tsup.config.ts index 48955a54e8..1643501bd6 100644 --- a/packages/toolkit/tsup.config.ts +++ b/packages/toolkit/tsup.config.ts @@ -41,7 +41,6 @@ export interface EntryPointOptions { prefix: string folder: string entryPoint: string - extractionConfig: string externals?: string[] } @@ -92,27 +91,23 @@ const entryPoints: EntryPointOptions[] = [ prefix: 'redux-toolkit', folder: '', entryPoint: 'src/index.ts', - extractionConfig: 'api-extractor.json', }, { prefix: 'redux-toolkit-react', folder: 'react/', entryPoint: 'src/react/index.ts', - extractionConfig: 'api-extractor-react.json', externals: ['redux', '@reduxjs/toolkit'], }, { prefix: 'rtk-query', folder: 'query', entryPoint: 'src/query/index.ts', - extractionConfig: 'api-extractor.query.json', externals: ['redux', '@reduxjs/toolkit'], }, { prefix: 'rtk-query-react', folder: 'query/react', entryPoint: 'src/query/react/index.ts', - extractionConfig: 'api-extractor.query-react.json', externals: ['redux', '@reduxjs/toolkit'], }, ] diff --git a/yarn.lock b/yarn.lock index bbc10d1903..f958c92e48 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6827,40 +6827,6 @@ __metadata: languageName: node linkType: hard -"@microsoft/api-extractor-model@npm:7.30.1": - version: 7.30.1 - resolution: "@microsoft/api-extractor-model@npm:7.30.1" - dependencies: - "@microsoft/tsdoc": "npm:~0.15.1" - "@microsoft/tsdoc-config": "npm:~0.17.1" - "@rushstack/node-core-library": "npm:5.10.1" - checksum: 10/c805be8aa4e1023da06caab5af5a931ab9b7d69522a7547df05dcb9c66083af1f68866b0bb2b734778801b0b6d342e2b64e24fe4bfae39137a29538cd4601dcc - languageName: node - linkType: hard - -"@microsoft/api-extractor@npm:^7.13.2": - version: 7.48.1 - resolution: "@microsoft/api-extractor@npm:7.48.1" - dependencies: - "@microsoft/api-extractor-model": "npm:7.30.1" - "@microsoft/tsdoc": "npm:~0.15.1" - "@microsoft/tsdoc-config": "npm:~0.17.1" - "@rushstack/node-core-library": "npm:5.10.1" - "@rushstack/rig-package": "npm:0.5.3" - "@rushstack/terminal": "npm:0.14.4" - "@rushstack/ts-command-line": "npm:4.23.2" - lodash: "npm:~4.17.15" - minimatch: "npm:~3.0.3" - resolve: "npm:~1.22.1" - semver: "npm:~7.5.4" - source-map: "npm:~0.6.1" - typescript: "npm:5.4.2" - bin: - api-extractor: bin/api-extractor - checksum: 10/18b9dc1820d6489049d9e6db48f3eeee6028521ee90e067b155b42e38fe03e1048e914279fab0d0993e6f07f0c257579afa0b04a1145ec50b54e44f21ae9736a - languageName: node - linkType: hard - "@microsoft/fetch-event-source@npm:2.0.1": version: 2.0.1 resolution: "@microsoft/fetch-event-source@npm:2.0.1" @@ -6868,19 +6834,7 @@ __metadata: languageName: node linkType: hard -"@microsoft/tsdoc-config@npm:~0.17.1": - version: 0.17.1 - resolution: "@microsoft/tsdoc-config@npm:0.17.1" - dependencies: - "@microsoft/tsdoc": "npm:0.15.1" - ajv: "npm:~8.12.0" - jju: "npm:~1.4.0" - resolve: "npm:~1.22.2" - checksum: 10/19f57b752413916c7ad14466650f48ba1acaf674411b6a44065e93f762d391e501cb553eeb8ae3834f1f1f064ddc83a26bdbd8026c9b2c0c194fe90818078eb9 - languageName: node - linkType: hard - -"@microsoft/tsdoc@npm:0.15.1, @microsoft/tsdoc@npm:^0.15.0, @microsoft/tsdoc@npm:~0.15.1": +"@microsoft/tsdoc@npm:^0.15.0": version: 0.15.1 resolution: "@microsoft/tsdoc@npm:0.15.1" checksum: 10/1a92612883088fe184dba596e7ba7a0daef0e6981caeca22bad6ad551d2247294f12e368537d0d8192525cf5743f7f15fcc2ad7b3b849f26a09a15ffdd89fd0c @@ -7526,7 +7480,6 @@ __metadata: "@arethetypeswrong/cli": "npm:^0.13.5" "@babel/core": "npm:^7.24.8" "@babel/helper-module-imports": "npm:^7.24.7" - "@microsoft/api-extractor": "npm:^7.13.2" "@phryneas/ts-version": "npm:^1.0.2" "@size-limit/file": "npm:^11.0.1" "@size-limit/webpack": "npm:^11.0.1" @@ -8034,64 +7987,6 @@ __metadata: languageName: node linkType: hard -"@rushstack/node-core-library@npm:5.10.1": - version: 5.10.1 - resolution: "@rushstack/node-core-library@npm:5.10.1" - dependencies: - ajv: "npm:~8.13.0" - ajv-draft-04: "npm:~1.0.0" - ajv-formats: "npm:~3.0.1" - fs-extra: "npm:~7.0.1" - import-lazy: "npm:~4.0.0" - jju: "npm:~1.4.0" - resolve: "npm:~1.22.1" - semver: "npm:~7.5.4" - peerDependencies: - "@types/node": "*" - peerDependenciesMeta: - "@types/node": - optional: true - checksum: 10/440aade872d13c4b39eeaa762bdfca713fea60d34c72f7b869db345ef9e9aed62c7f9fb175bc90684cf0d1f46e1e5cd778941baf43b01f2ee576a51f2ba2cce7 - languageName: node - linkType: hard - -"@rushstack/rig-package@npm:0.5.3": - version: 0.5.3 - resolution: "@rushstack/rig-package@npm:0.5.3" - dependencies: - resolve: "npm:~1.22.1" - strip-json-comments: "npm:~3.1.1" - checksum: 10/b58a3925a41d7a0e79f4fde7c400a379683cc7b0073c447aba6d36231529a37e7d2f4559f459be785ad862ecb01b618b2d0ff60661046e5223437356155ccb14 - languageName: node - linkType: hard - -"@rushstack/terminal@npm:0.14.4": - version: 0.14.4 - resolution: "@rushstack/terminal@npm:0.14.4" - dependencies: - "@rushstack/node-core-library": "npm:5.10.1" - supports-color: "npm:~8.1.1" - peerDependencies: - "@types/node": "*" - peerDependenciesMeta: - "@types/node": - optional: true - checksum: 10/aede44b4255225777acd7887b1adba7b8cca578fe9adf4283c5591a0f28dbd45fb38f6b5f04a56973828e28da6a9d951da046bcb4f576d5fa360c8893cac6861 - languageName: node - linkType: hard - -"@rushstack/ts-command-line@npm:4.23.2": - version: 4.23.2 - resolution: "@rushstack/ts-command-line@npm:4.23.2" - dependencies: - "@rushstack/terminal": "npm:0.14.4" - "@types/argparse": "npm:1.0.38" - argparse: "npm:~1.0.9" - string-argv: "npm:~0.3.1" - checksum: 10/583cd23d2d3e3e9772184764a1a7e50dcb863fe1c6affefe196a935a69c64aaaa32cc71aa3fb55fb2dfbd353cc25db3f0b9999b79bbe13b75ee476a51cb48717 - languageName: node - linkType: hard - "@samverschueren/stream-to-observable@npm:^0.3.0": version: 0.3.1 resolution: "@samverschueren/stream-to-observable@npm:0.3.1" @@ -8902,13 +8797,6 @@ __metadata: languageName: node linkType: hard -"@types/argparse@npm:1.0.38": - version: 1.0.38 - resolution: "@types/argparse@npm:1.0.38" - checksum: 10/26ed7e3f1e3595efdb883a852f5205f971b798e4c28b7e30a32c5298eee596e8b45834ce831f014d250b9730819ab05acff5b31229666d3af4ba465b4697d0eb - languageName: node - linkType: hard - "@types/aria-query@npm:^5.0.1": version: 5.0.4 resolution: "@types/aria-query@npm:5.0.4" @@ -10648,7 +10536,7 @@ __metadata: languageName: node linkType: hard -"ajv-draft-04@npm:^1.0.0, ajv-draft-04@npm:~1.0.0": +"ajv-draft-04@npm:^1.0.0": version: 1.0.0 resolution: "ajv-draft-04@npm:1.0.0" peerDependencies: @@ -10674,20 +10562,6 @@ __metadata: languageName: node linkType: hard -"ajv-formats@npm:~3.0.1": - version: 3.0.1 - resolution: "ajv-formats@npm:3.0.1" - dependencies: - ajv: "npm:^8.0.0" - peerDependencies: - ajv: ^8.0.0 - peerDependenciesMeta: - ajv: - optional: true - checksum: 10/5679b9f9ced9d0213a202a37f3aa91efcffe59a6de1a6e3da5c873344d3c161820a1f11cc29899661fee36271fd2895dd3851b6461c902a752ad661d1c1e8722 - languageName: node - linkType: hard - "ajv-keywords@npm:^3.4.1, ajv-keywords@npm:^3.5.2": version: 3.5.2 resolution: "ajv-keywords@npm:3.5.2" @@ -10708,7 +10582,7 @@ __metadata: languageName: node linkType: hard -"ajv@npm:8.12.0, ajv@npm:~8.12.0": +"ajv@npm:8.12.0": version: 8.12.0 resolution: "ajv@npm:8.12.0" dependencies: @@ -10744,18 +10618,6 @@ __metadata: languageName: node linkType: hard -"ajv@npm:~8.13.0": - version: 8.13.0 - resolution: "ajv@npm:8.13.0" - dependencies: - fast-deep-equal: "npm:^3.1.3" - json-schema-traverse: "npm:^1.0.0" - require-from-string: "npm:^2.0.2" - uri-js: "npm:^4.4.1" - checksum: 10/4ada268c9a6e44be87fd295df0f0a91267a7bae8dbc8a67a2d5799c3cb459232839c99d18b035597bb6e3ffe88af6979f7daece854f590a81ebbbc2dfa80002c - languageName: node - linkType: hard - "algoliasearch-helper@npm:^3.13.3": version: 3.22.6 resolution: "algoliasearch-helper@npm:3.22.6" @@ -10987,7 +10849,7 @@ __metadata: languageName: node linkType: hard -"argparse@npm:^1.0.7, argparse@npm:~1.0.9": +"argparse@npm:^1.0.7": version: 1.0.10 resolution: "argparse@npm:1.0.10" dependencies: @@ -16798,17 +16660,6 @@ __metadata: languageName: node linkType: hard -"fs-extra@npm:~7.0.1": - version: 7.0.1 - resolution: "fs-extra@npm:7.0.1" - dependencies: - graceful-fs: "npm:^4.1.2" - jsonfile: "npm:^4.0.0" - universalify: "npm:^0.1.0" - checksum: 10/3fc6e56ba2f07c00d452163f27f21a7076b72ef7da8a50fef004336d59ef4c34deda11d10ecd73fd8fbcf20e4f575f52857293090b3c9f8741d4e0598be30fea - languageName: node - linkType: hard - "fs-minipass@npm:^3.0.0": version: 3.0.3 resolution: "fs-minipass@npm:3.0.3" @@ -18216,7 +18067,7 @@ __metadata: languageName: node linkType: hard -"import-lazy@npm:^4.0.0, import-lazy@npm:~4.0.0": +"import-lazy@npm:^4.0.0": version: 4.0.0 resolution: "import-lazy@npm:4.0.0" checksum: 10/943309cc8eb01ada12700448c288b0384f77a1bc33c7e00fa4cb223c665f467a13ce9aaceb8d2e4cf586b07c1d2828040263dcc069873ce63cfc2ac6fd087971 @@ -19952,13 +19803,6 @@ __metadata: languageName: node linkType: hard -"jju@npm:~1.4.0": - version: 1.4.0 - resolution: "jju@npm:1.4.0" - checksum: 10/1067ff8ce02221faac5a842116ed0ec79a53312a111d0bf8342a80bd02c0a3fdf0b8449694a65947db0a3e8420e8b326dffb489c7dd5866efc380c0d1708a707 - languageName: node - linkType: hard - "joi@npm:^17.9.2": version: 17.13.3 resolution: "joi@npm:17.13.3" @@ -20857,7 +20701,7 @@ __metadata: languageName: node linkType: hard -"lodash@npm:4.17.21, lodash@npm:^4.17.15, lodash@npm:^4.17.19, lodash@npm:^4.17.20, lodash@npm:^4.17.21, lodash@npm:^4.7.0, lodash@npm:~4.17.0, lodash@npm:~4.17.15": +"lodash@npm:4.17.21, lodash@npm:^4.17.15, lodash@npm:^4.17.19, lodash@npm:^4.17.20, lodash@npm:^4.17.21, lodash@npm:^4.7.0, lodash@npm:~4.17.0": version: 4.17.21 resolution: "lodash@npm:4.17.21" checksum: 10/c08619c038846ea6ac754abd6dd29d2568aa705feb69339e836dfa8d8b09abbb2f859371e86863eda41848221f9af43714491467b5b0299122431e202bb0c532 @@ -22239,15 +22083,6 @@ __metadata: languageName: node linkType: hard -"minimatch@npm:~3.0.3": - version: 3.0.8 - resolution: "minimatch@npm:3.0.8" - dependencies: - brace-expansion: "npm:^1.1.7" - checksum: 10/6df5373cb1ea79020beb6887ff5576c58cfabcfd32c5a65c2cf58f326e4ee8eae84f129e5fa50b8a4347fa1d1e583f931285c9fb3040d984bdfb5109ef6607ec - languageName: node - linkType: hard - "minimist@npm:^1.2.0, minimist@npm:^1.2.6, minimist@npm:^1.2.8": version: 1.2.8 resolution: "minimist@npm:1.2.8" @@ -27343,7 +27178,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:^1.1.6, resolve@npm:^1.1.7, resolve@npm:^1.10.1, resolve@npm:^1.14.2, resolve@npm:^1.17.0, resolve@npm:^1.19.0, resolve@npm:^1.20.0, resolve@npm:^1.22.4, resolve@npm:^1.22.8, resolve@npm:~1.22.1, resolve@npm:~1.22.2": +"resolve@npm:^1.1.6, resolve@npm:^1.1.7, resolve@npm:^1.10.1, resolve@npm:^1.14.2, resolve@npm:^1.17.0, resolve@npm:^1.19.0, resolve@npm:^1.20.0, resolve@npm:^1.22.4, resolve@npm:^1.22.8": version: 1.22.10 resolution: "resolve@npm:1.22.10" dependencies: @@ -27378,7 +27213,7 @@ __metadata: languageName: node linkType: hard -"resolve@patch:resolve@npm%3A^1.1.6#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.1.7#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.10.1#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.14.2#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.17.0#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.19.0#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.20.0#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.22.4#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.22.8#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A~1.22.1#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A~1.22.2#optional!builtin<compat/resolve>": +"resolve@patch:resolve@npm%3A^1.1.6#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.1.7#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.10.1#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.14.2#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.17.0#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.19.0#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.20.0#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.22.4#optional!builtin<compat/resolve>, resolve@patch:resolve@npm%3A^1.22.8#optional!builtin<compat/resolve>": version: 1.22.10 resolution: "resolve@patch:resolve@npm%3A1.22.10#optional!builtin<compat/resolve>::version=1.22.10&hash=c3c19d" dependencies: @@ -28042,17 +27877,6 @@ __metadata: languageName: node linkType: hard -"semver@npm:~7.5.4": - version: 7.5.4 - resolution: "semver@npm:7.5.4" - dependencies: - lru-cache: "npm:^6.0.0" - bin: - semver: bin/semver.js - checksum: 10/985dec0d372370229a262c737063860fabd4a1c730662c1ea3200a2f649117761a42184c96df62a0e885e76fbd5dace41087d6c1ac0351b13c0df5d6bcb1b5ac - languageName: node - linkType: hard - "send@npm:0.19.0": version: 0.19.0 resolution: "send@npm:0.19.0" @@ -28836,13 +28660,6 @@ __metadata: languageName: node linkType: hard -"string-argv@npm:~0.3.1": - version: 0.3.2 - resolution: "string-argv@npm:0.3.2" - checksum: 10/f9d3addf887026b4b5f997a271149e93bf71efc8692e7dc0816e8807f960b18bcb9787b45beedf0f97ff459575ee389af3f189d8b649834cac602f2e857e75af - languageName: node - linkType: hard - "string-env-interpolation@npm:1.0.1, string-env-interpolation@npm:^1.0.1": version: 1.0.1 resolution: "string-env-interpolation@npm:1.0.1" @@ -29140,7 +28957,7 @@ __metadata: languageName: node linkType: hard -"strip-json-comments@npm:^3.1.0, strip-json-comments@npm:^3.1.1, strip-json-comments@npm:~3.1.1": +"strip-json-comments@npm:^3.1.0, strip-json-comments@npm:^3.1.1": version: 3.1.1 resolution: "strip-json-comments@npm:3.1.1" checksum: 10/492f73e27268f9b1c122733f28ecb0e7e8d8a531a6662efbd08e22cccb3f9475e90a1b82cab06a392f6afae6d2de636f977e231296400d0ec5304ba70f166443 @@ -29296,7 +29113,7 @@ __metadata: languageName: node linkType: hard -"supports-color@npm:^8.0.0, supports-color@npm:^8.1.0, supports-color@npm:~8.1.1": +"supports-color@npm:^8.0.0, supports-color@npm:^8.1.0": version: 8.1.1 resolution: "supports-color@npm:8.1.1" dependencies: @@ -30367,16 +30184,6 @@ __metadata: languageName: node linkType: hard -"typescript@npm:5.4.2": - version: 5.4.2 - resolution: "typescript@npm:5.4.2" - bin: - tsc: bin/tsc - tsserver: bin/tsserver - checksum: 10/f8cfdc630ab1672f004e9561eb2916935b2d267792d07ce93e97fc601c7a65191af32033d5e9c0169b7dc37da7db9bf320f7432bc84527cb7697effaa4e4559d - languageName: node - linkType: hard - "typescript@npm:^4.1.3, typescript@npm:^4.3.4, typescript@npm:~4.9": version: 4.9.5 resolution: "typescript@npm:4.9.5" @@ -30427,16 +30234,6 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@npm%3A5.4.2#optional!builtin<compat/typescript>": - version: 5.4.2 - resolution: "typescript@patch:typescript@npm%3A5.4.2#optional!builtin<compat/typescript>::version=5.4.2&hash=5adc0c" - bin: - tsc: bin/tsc - tsserver: bin/tsserver - checksum: 10/f5f9a4133c2670761f0166eae5b3bafbc4a3fc24f0f42a93c9c893d9e9d6e66ea066969c5e7483fa66b4ae0e99125592553f3b92fd3599484de8be13b0615176 - languageName: node - linkType: hard - "typescript@patch:typescript@npm%3A^4.1.3#optional!builtin<compat/typescript>, typescript@patch:typescript@npm%3A^4.3.4#optional!builtin<compat/typescript>, typescript@patch:typescript@npm%3A~4.9#optional!builtin<compat/typescript>": version: 4.9.5 resolution: "typescript@patch:typescript@npm%3A4.9.5#optional!builtin<compat/typescript>::version=4.9.5&hash=289587" @@ -30827,7 +30624,7 @@ __metadata: languageName: node linkType: hard -"uri-js@npm:^4.2.2, uri-js@npm:^4.4.1": +"uri-js@npm:^4.2.2": version: 4.4.1 resolution: "uri-js@npm:4.4.1" dependencies: