diff --git a/packages/cli-node/api-report.md b/packages/cli-node/api-report.md new file mode 100644 index 0000000000..91148596b3 --- /dev/null +++ b/packages/cli-node/api-report.md @@ -0,0 +1,167 @@ +## API Report File for "@backstage/cli-node" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { JsonValue } from '@backstage/types'; +import { Package } from '@manypkg/get-packages'; + +// @public +export type BackstagePackage = { + dir: string; + packageJson: BackstagePackageJson; +}; + +// @public +export interface BackstagePackageJson { + // (undocumented) + backstage?: { + role?: PackageRole; + }; + // (undocumented) + bundled?: boolean; + // (undocumented) + dependencies?: { + [key: string]: string; + }; + // (undocumented) + devDependencies?: { + [key: string]: string; + }; + // (undocumented) + exports?: JsonValue; + // (undocumented) + files?: string[]; + // (undocumented) + main?: string; + // (undocumented) + module?: string; + // (undocumented) + name: string; + // (undocumented) + optionalDependencies?: { + [key: string]: string; + }; + // (undocumented) + peerDependencies?: { + [key: string]: string; + }; + // (undocumented) + private?: boolean; + // (undocumented) + publishConfig?: { + access?: 'public' | 'restricted'; + directory?: string; + registry?: string; + alphaTypes?: string; + betaTypes?: string; + }; + // (undocumented) + scripts?: { + [key: string]: string; + }; + // (undocumented) + types?: string; + // (undocumented) + typesVersions?: Record>; + // (undocumented) + version: string; +} + +// @public +export class GitUtils { + static listChangedFiles(ref: string): Promise; + static readFileAtRef(path: string, ref: string): Promise; +} + +// @public +export function isMonoRepo(): Promise; + +// @public +export class Lockfile { + createSimplifiedDependencyGraph(): Map>; + diff(otherLockfile: Lockfile): LockfileDiff; + static load(path: string): Promise; + static parse(content: string): Lockfile; +} + +// @public +export type LockfileDiff = { + added: LockfileDiffEntry[]; + changed: LockfileDiffEntry[]; + removed: LockfileDiffEntry[]; +}; + +// @public +export type LockfileDiffEntry = { + name: string; + range: string; +}; + +// @public +export class PackageGraph extends Map { + collectPackageNames( + startingPackageNames: string[], + collectFn: (pkg: PackageGraphNode) => Iterable | undefined, + ): Set; + static fromPackages(packages: Package[]): PackageGraph; + listChangedPackages(options: { + ref: string; + analyzeLockfile?: boolean; + }): Promise; + static listTargetPackages(): Promise; +} + +// @public +export type PackageGraphNode = { + name: string; + dir: string; + packageJson: BackstagePackageJson; + allLocalDependencies: Map; + publishedLocalDependencies: Map; + localDependencies: Map; + localDevDependencies: Map; + localOptionalDependencies: Map; + allLocalDependents: Map; + publishedLocalDependents: Map; + localDependents: Map; + localDevDependents: Map; + localOptionalDependents: Map; +}; + +// @public +export type PackageOutputType = 'bundle' | 'types' | 'esm' | 'cjs'; + +// @public +export type PackagePlatform = 'node' | 'web' | 'common'; + +// @public +export type PackageRole = + | 'frontend' + | 'backend' + | 'cli' + | 'web-library' + | 'node-library' + | 'common-library' + | 'frontend-plugin' + | 'frontend-plugin-module' + | 'backend-plugin' + | 'backend-plugin-module'; + +// @public +export interface PackageRoleInfo { + // (undocumented) + output: PackageOutputType[]; + // (undocumented) + platform: PackagePlatform; + // (undocumented) + role: PackageRole; +} + +// @public +export class PackageRoles { + static detectRoleFromPackage(pkgJson: unknown): PackageRole | undefined; + static getRoleFromPackage(pkgJson: unknown): PackageRole | undefined; + static getRoleInfo(role: string): PackageRoleInfo; +} +```