@storybook/cli 7.0.0-beta.6 → 7.0.0-beta.61

package/dist/index.d.ts

@@ -0,0 +1,134 @@
+import { PackageJson } from '@storybook/types';
+export { PackageJson } from '@storybook/types';
+
+declare const useNpmWarning: () => void;
+
+type PackageJsonWithDepsAndDevDeps = PackageJson & Required<Pick<PackageJson, 'dependencies' | 'devDependencies'>>;
+type PackageJsonWithMaybeDeps = Partial<Pick<PackageJson, 'dependencies' | 'devDependencies' | 'peerDependencies' | 'files'>>;
+
+type PackageManagerName = 'npm' | 'yarn1' | 'yarn2' | 'pnpm';
+/**
+ * Extract package name and version from input
+ *
+ * @param pkg A string like `@storybook/cli`, `react` or `react@^16`
+ * @return A tuple of 2 elements: [packageName, packageVersion]
+ */
+declare function getPackageDetails(pkg: string): [string, string?];
+interface JsPackageManagerOptions {
+    cwd?: string;
+}
+declare abstract class JsPackageManager {
+    abstract readonly type: PackageManagerName;
+    abstract initPackageJson(): void;
+    abstract getRunStorybookCommand(): string;
+    abstract getRunCommand(command: string): string;
+    setRegistryURL(url: string): void;
+    getRegistryURL(): string;
+    readonly cwd?: string;
+    constructor(options?: JsPackageManagerOptions);
+    /**
+     * Install dependencies listed in `package.json`
+     */
+    installDependencies(): void;
+    packageJsonPath(): string;
+    readPackageJson(): PackageJson;
+    writePackageJson(packageJson: PackageJson): void;
+    /**
+     * Read the `package.json` file available in the directory the command was call from
+     * If there is no `package.json` it will create one.
+     */
+    retrievePackageJson(): PackageJsonWithDepsAndDevDeps;
+    getAllDependencies(): Record<string, string>;
+    /**
+     * Add dependencies to a project using `yarn add` or `npm install`.
+     *
+     * @param {Object} options contains `skipInstall`, `packageJson` and `installAsDevDependencies` which we use to determine how we install packages.
+     * @param {Array} dependencies contains a list of packages to add.
+     * @example
+     * addDependencies(options, [
+     *   `@storybook/react@${storybookVersion}`,
+     *   `@storybook/addon-actions@${actionsVersion}`,
+     *   `@storybook/addon-links@${linksVersion}`,
+     *   `@storybook/preview-api@${addonsVersion}`,
+     * ]);
+     */
+    addDependencies(options: {
+        skipInstall?: boolean;
+        installAsDevDependencies?: boolean;
+        packageJson?: PackageJson;
+    }, dependencies: string[]): void;
+    /**
+     * Remove dependencies from a project using `yarn remove` or `npm uninstall`.
+     *
+     * @param {Object} options contains `skipInstall`, `packageJson` and `installAsDevDependencies` which we use to determine how we install packages.
+     * @param {Array} dependencies contains a list of packages to remove.
+     * @example
+     * removeDependencies(options, [
+     *   `@storybook/react`,
+     *   `@storybook/addon-actions`,
+     * ]);
+     */
+    removeDependencies(options: {
+        skipInstall?: boolean;
+        packageJson?: PackageJson;
+    }, dependencies: string[]): void;
+    /**
+     * Return an array of strings matching following format: `<package_name>@<package_latest_version>`
+     *
+     * @param packages
+     */
+    getVersionedPackages(packages: string[]): Promise<string[]>;
+    /**
+     * Return an array of string standing for the latest version of the input packages.
+     * To be able to identify which version goes with which package the order of the input array is keep.
+     *
+     * @param packageNames
+     */
+    getVersions(...packageNames: string[]): Promise<string[]>;
+    /**
+     * Return the latest version of the input package available on npmjs registry.
+     * If constraint are provided it return the latest version matching the constraints.
+     *
+     * For `@storybook/*` packages the latest version is retrieved from `cli/src/versions.json` file directly
+     *
+     * @param packageName The name of the package
+     * @param constraint A valid semver constraint, example: '1.x || >=2.5.0 || 5.0.0 - 7.2.3'
+     */
+    getVersion(packageName: string, constraint?: string): Promise<string>;
+    /**
+     * Get the latest version of the package available on npmjs.com.
+     * If constraint is set then it returns a version satisfying it, otherwise the latest version available is returned.
+     *
+     * @param packageName Name of the package
+     * @param constraint Version range to use to constraint the returned version
+     */
+    latestVersion(packageName: string, constraint?: string): Promise<string>;
+    addStorybookCommandInScripts(options?: {
+        port: number;
+        preCommand?: string;
+    }): void;
+    addESLintConfig(): void;
+    addScripts(scripts: Record<string, string>): void;
+    addPackageResolutions(versions: Record<string, string>): void;
+    protected abstract runInstall(): void;
+    protected abstract runAddDeps(dependencies: string[], installAsDevDependencies: boolean): void;
+    protected abstract runRemoveDeps(dependencies: string[]): void;
+    protected abstract getResolutions(packageJson: PackageJson, versions: Record<string, string>): Record<string, any>;
+    /**
+     * Get the latest or all versions of the input package available on npmjs.com
+     *
+     * @param packageName Name of the package
+     * @param fetchAllVersions Should return
+     */
+    protected abstract runGetVersions<T extends boolean>(packageName: string, fetchAllVersions: T): Promise<T extends true ? string[] : string>;
+    abstract runPackageCommand(command: string, args: string[], cwd?: string): string;
+    executeCommand(command: string, args: string[], stdio?: 'pipe' | 'inherit', cwd?: string): string;
+}
+
+declare class JsPackageManagerFactory {
+    static getPackageManager({ force }?: {
+        force?: PackageManagerName;
+    }, cwd?: string): JsPackageManager;
+}
+
+export { JsPackageManager, JsPackageManagerFactory, PackageJsonWithDepsAndDevDeps, PackageJsonWithMaybeDeps, PackageManagerName, getPackageDetails, useNpmWarning };