@rsdoctor/types 0.0.2-beta.0

package/dist/sdk/statement.d.ts

@@ -0,0 +1,177 @@
+import type { SourceRange, ModuleInstance } from './module';
+import type { NonFunctionProperties } from '../common';
+/** Statement position */
+export interface StatementPosition {
+    /**
+     * Source code location
+     * - Because sourceMap may not exist, there may not be a value here
+     * There are many reasons why sourceMap does not exist, it may be a parsing failure, or it may be ignored during the loader conversion process
+     */
+    source?: SourceRange;
+    /** Converted code position */
+    transformed: SourceRange;
+}
+/** statement category */
+export declare enum StatementKind {
+    /**
+     * Import by default
+     * @example
+     * ```ts
+     * import defaultName from 'name';
+     * ```
+     */
+    ImportDefault = 100,
+    /**
+     * Named import
+     * @example
+     * ```ts
+     * import { name1, name as name2 } from 'name';
+     * ```
+     */
+    ImportNamed = 101,
+    /**
+     * Default and named import
+     * @example
+     * ```ts
+     * import defaultName, { name1 } from 'name';
+     * ```
+     */
+    ImportDefaultWithNamed = 102,
+    /**
+     * Default and Namespace import
+     * @example
+     * ```ts
+     * import defaultName, * as name from 'name';
+     * ```
+     */
+    ImportDefaultWithNamespace = 103,
+    /**
+     * Namespace import
+     * @example
+     * ```ts
+     * import * as namespaceName from 'name';
+     * ```
+     */
+    ImportNamespace = 104,
+    /**
+     * Side effects import
+     * @example
+     * ```ts
+     * import 'name';
+     * ```
+     */
+    ImportSideEffect = 105,
+    /**
+     * Dynamic import
+     * @example
+     * ```ts
+     * import('name');
+     * ```
+     */
+    ImportDynamic = 106,
+    /**
+     * Declare export
+     * @example
+     * ```ts
+     * export const name = '123';
+     * ```
+     */
+    ExportDeclaration = 200,
+    /**
+     * List export
+     * @example
+     * ```ts
+     * export { item1, item as item2 };
+     * ```
+     */
+    ExportList = 201,
+    /**
+     * Default export
+     * @example
+     * ```ts
+     * export default name;
+     * ```
+     */
+    ExportDefault = 202,
+    /**
+     * Re-export
+     * @example
+     * ```ts
+     * export { default as defaultName, item1, item as item2 } from 'name';
+     * ```
+     */
+    ExportAggregating = 203,
+    /**
+     * Re-export to Namespace
+     * @example
+     * ```ts
+     * export * as namespaceName from 'name';
+     * ```
+     */
+    ExportNamespace = 204,
+    /**
+     * CJS module import
+     * @example
+     * ```ts
+     * require('name');
+     * ```
+     */
+    RequireCall = 300,
+    /**
+     * CJS named import
+     * @example
+     * ```ts
+     * require('name').name
+     * ```
+     */
+    RequireName = 301,
+    /**
+     * Overall export
+     * @example
+     * ```ts
+     * module.exports = {};
+     * ```
+     */
+    RequireExports = 302,
+    /**
+     * CJS re-export
+     * @example
+     * ```ts
+     * module.exports = require('name');
+     * ```
+     */
+    RequireExportAggregating = 303,
+    /**
+     * Named export
+     * @example
+     * ```ts
+     * export.name = '123';
+     * ```
+     */
+    RequireExportName = 304,
+    /**
+     * Unknown statement
+     */
+    Unknown = 999
+}
+/** Statement class */
+export interface StatementInstance {
+    /** Current statement position */
+    readonly position: StatementPosition;
+    /** Module where the statement is located */
+    readonly module: ModuleInstance;
+    /** Is it the same statement */
+    isSame(statement: StatementInstance): boolean;
+    /**
+     * Get original location
+     * - When running for the first time and the Module contains sourceMap, it will be calculated
+     */
+    getSourcePosition(): SourceRange | undefined;
+    /** Output data */
+    toData(): StatementData;
+}
+/** statement data */
+export interface StatementData extends Omit<NonFunctionProperties<StatementInstance>, 'module'> {
+    /** Module number where the statement is located */
+    module: number;
+}

package/dist/sdk/statement.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatementKind = void 0;
+/** statement category */
+var StatementKind;
+(function (StatementKind) {
+    /**
+     * Import by default
+     * @example
+     * ```ts
+     * import defaultName from 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ImportDefault"] = 100] = "ImportDefault";
+    /**
+     * Named import
+     * @example
+     * ```ts
+     * import { name1, name as name2 } from 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ImportNamed"] = 101] = "ImportNamed";
+    /**
+     * Default and named import
+     * @example
+     * ```ts
+     * import defaultName, { name1 } from 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ImportDefaultWithNamed"] = 102] = "ImportDefaultWithNamed";
+    /**
+     * Default and Namespace import
+     * @example
+     * ```ts
+     * import defaultName, * as name from 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ImportDefaultWithNamespace"] = 103] = "ImportDefaultWithNamespace";
+    /**
+     * Namespace import
+     * @example
+     * ```ts
+     * import * as namespaceName from 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ImportNamespace"] = 104] = "ImportNamespace";
+    /**
+     * Side effects import
+     * @example
+     * ```ts
+     * import 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ImportSideEffect"] = 105] = "ImportSideEffect";
+    /**
+     * Dynamic import
+     * @example
+     * ```ts
+     * import('name');
+     * ```
+     */
+    StatementKind[StatementKind["ImportDynamic"] = 106] = "ImportDynamic";
+    /**
+     * Declare export
+     * @example
+     * ```ts
+     * export const name = '123';
+     * ```
+     */
+    StatementKind[StatementKind["ExportDeclaration"] = 200] = "ExportDeclaration";
+    /**
+     * List export
+     * @example
+     * ```ts
+     * export { item1, item as item2 };
+     * ```
+     */
+    StatementKind[StatementKind["ExportList"] = 201] = "ExportList";
+    /**
+     * Default export
+     * @example
+     * ```ts
+     * export default name;
+     * ```
+     */
+    StatementKind[StatementKind["ExportDefault"] = 202] = "ExportDefault";
+    /**
+     * Re-export
+     * @example
+     * ```ts
+     * export { default as defaultName, item1, item as item2 } from 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ExportAggregating"] = 203] = "ExportAggregating";
+    /**
+     * Re-export to Namespace
+     * @example
+     * ```ts
+     * export * as namespaceName from 'name';
+     * ```
+     */
+    StatementKind[StatementKind["ExportNamespace"] = 204] = "ExportNamespace";
+    /**
+     * CJS module import
+     * @example
+     * ```ts
+     * require('name');
+     * ```
+     */
+    StatementKind[StatementKind["RequireCall"] = 300] = "RequireCall";
+    /**
+     * CJS named import
+     * @example
+     * ```ts
+     * require('name').name
+     * ```
+     */
+    StatementKind[StatementKind["RequireName"] = 301] = "RequireName";
+    /**
+     * Overall export
+     * @example
+     * ```ts
+     * module.exports = {};
+     * ```
+     */
+    StatementKind[StatementKind["RequireExports"] = 302] = "RequireExports";
+    /**
+     * CJS re-export
+     * @example
+     * ```ts
+     * module.exports = require('name');
+     * ```
+     */
+    StatementKind[StatementKind["RequireExportAggregating"] = 303] = "RequireExportAggregating";
+    /**
+     * Named export
+     * @example
+     * ```ts
+     * export.name = '123';
+     * ```
+     */
+    StatementKind[StatementKind["RequireExportName"] = 304] = "RequireExportName";
+    /**
+     * Unknown statement
+     */
+    StatementKind[StatementKind["Unknown"] = 999] = "Unknown";
+})(StatementKind || (exports.StatementKind = StatementKind = {}));

package/dist/sdk/summary.d.ts

@@ -0,0 +1,18 @@
+interface SummaryCostsData {
+    /**
+     * such as 'bootstrap' / 'compile' / 'minify' or else.
+     */
+    name: string;
+    /**
+     * the start timestamp of the data.
+     */
+    startAt: number;
+    costs: number;
+}
+export interface SummaryData {
+    /**
+     * costs of different data.
+     */
+    costs: SummaryCostsData[];
+}
+export {};

package/dist/sdk/summary.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/treeShaking.d.ts

@@ -0,0 +1,152 @@
+import type { ModuleInstance, DependencyInstance } from './module';
+import type { StatementInstance, StatementData } from './statement';
+import type { NonFunctionProperties } from '../common';
+/** Variable data */
+export interface VariableInstance {
+    /** Variable number */
+    readonly id: number;
+    /** Variable name */
+    readonly name: string;
+    /** Module */
+    readonly module: ModuleInstance;
+    /** Is it used */
+    readonly usedInfo: string;
+    /** variable identifier declaration location */
+    readonly identifier: StatementInstance;
+    /** Set as export variable */
+    setExportInfo(info: ExportInstance): void;
+    /** Get export information */
+    getExportInfo(): ExportInstance | undefined;
+    /** Get data */
+    toData(): VariableData;
+}
+export interface VariableData extends Omit<NonFunctionProperties<VariableInstance>, 'identifier' | 'module'> {
+    identifier: StatementData;
+    module: number;
+    exported?: number;
+}
+/** Export variable */
+export interface ExportInstance {
+    /** Number */
+    readonly id: number;
+    /**
+     * Export name
+     * - Default export is 'default'
+     */
+    readonly name: string;
+    /**
+     * Variable data
+     * - This item is empty when the original variable does not exist
+     */
+    readonly variable?: VariableInstance;
+    /**
+     * The position of the export variable in the export statement
+     * - If it is exported as namespace or reexport, this item does not exist
+     */
+    readonly identifier?: StatementInstance;
+    /** Is it a re-export */
+    readonly isReExport: boolean;
+    /** Set as export variable */
+    addSideEffect(info: SideEffectInstance): void;
+    /** Get all side effects */
+    getSideEffects(): SideEffectInstance[];
+    /** Set superior export */
+    setFromExport(from: ExportInstance): void;
+    /**
+     * Obtain superior data
+     * Will return to itself when there is no superior data
+     * @param [number] - depth is Infinity by default, get the original export, get the superior export when it is 1
+     */
+    getRecursiveExport(depth?: number): ExportInstance;
+    toData(): ExportData;
+}
+/** Export variable data */
+export interface ExportData extends Omit<NonFunctionProperties<ExportInstance>, 'identifier' | 'variable'> {
+    from?: number;
+    root?: number;
+    used: number[];
+    identifier?: StatementData;
+    variable?: number;
+}
+/** Import variable data */
+export interface SideEffectInstance {
+    /** Number */
+    readonly id: number;
+    /**
+     * Import name
+     * - default import is 'default'
+     */
+    readonly name: string;
+    /**
+     * Import original name
+     * - default import is 'default'
+     * - 'namespace' for full import
+     */
+    readonly originName?: string;
+    /** Module */
+    readonly module: ModuleInstance;
+    /** The position of the imported variable in the statement */
+    readonly identifier: StatementInstance;
+    /** Variable data */
+    readonly variable?: VariableInstance;
+    /** Superior export statement */
+    readonly exports?: ExportInstance[];
+    /** Whether it is a named import */
+    readonly isNameSpace: boolean;
+    /**
+     * Dependency derived from side effects
+     * - This item is empty when it is a local side effect
+     */
+    readonly fromDependency?: DependencyInstance;
+    /** Connect all exported data of the module */
+    setModuleExport(module: ModuleGraphModuleInstance): void;
+    /** Connect to export data */
+    setExportInfo(info: ExportInstance): void;
+    toData(): SideEffectData;
+}
+export interface SideEffectData extends Omit<NonFunctionProperties<SideEffectInstance>, 'module' | 'exports' | 'identifier' | 'variable' | 'isNameSpace' | 'fromDependency'> {
+    module: number;
+    identifier: StatementData;
+    fromDependency?: number;
+    variable?: number;
+    exports?: number[];
+    isNameSpace?: boolean;
+}
+export interface ModuleGraphModuleInstance {
+    /** Current Module */
+    readonly module: ModuleInstance;
+    /**
+     * Dynamic reference
+     * - indicates that when referencing this module, the module's exportsType is 'dynamic ' , and tree-shaking analysis will be ignored
+     */
+    readonly dynamic: boolean;
+    /** Add export data */
+    addExportInfo(data: ExportInstance): void;
+    /** Add side effect data */
+    addSideEffect(data: SideEffectInstance): void;
+    /** Add variable data */
+    addVariable(data: VariableInstance): void;
+    /** Get all exports */
+    getExports(): ExportInstance[];
+    /** Get all imports */
+    getSideEffects(name?: string): SideEffectInstance[];
+    /** Get local export */
+    getOwnExports(): ExportInstance[];
+    /** Get export data */
+    getExport(name: string): ExportInstance | undefined;
+    /** Get self-exported data */
+    getOwnExport(name: string): ExportInstance | undefined;
+    /** Get re-exported data */
+    getReExport(name: string): ExportInstance | undefined;
+    toData(): ModuleGraphModuleData;
+}
+export interface ModuleGraphModuleData extends Omit<NonFunctionProperties<ModuleGraphModuleInstance>, 'module'> {
+    /** Module number */
+    module: number;
+    /** Export data */
+    exports: number[];
+    /** Side effect data */
+    sideEffects: number[];
+    /** Variable data */
+    variables: number[];
+}

package/dist/sdk/treeShaking.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/thirdparty.d.ts

@@ -0,0 +1,2 @@
+import type connect from 'connect';
+export { connect };

package/dist/thirdparty.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@rsdoctor/types",
+  "version": "0.0.2-beta.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rsdoctor",
+    "directory": "packages/types"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@rspack/core": "0.3.14",
+    "@types/connect": "3.4.35",
+    "@types/estree": "1.0.0",
+    "@types/tapable": "2.2.2",
+    "@types/webpack": "5.28.0",
+    "source-map": "^0.7.4"
+  },
+  "devDependencies": {
+    "@types/node": "^16",
+    "@types/react": "^18",
+    "tslib": "2.4.1",
+    "typescript": "^5.2.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "npm run start",
+    "start": "npm run build -- -w"
+  }
+}