refactor(lerna): move typings to /typings folder and provide manual dts file for getDependencies to make it work in both js/ts modules

Author: Hotell

scripts/monorepo/src/getDependencies.d.ts

@@ -0,0 +1,11 @@
+// Why is this manual type declaration needed?
+// - modules(projects) written in TS not having enabled `checkJS:true` wont infer types from .js files, thus the API will have `any` type.
+// This errors in strict ts check mode.
+
+/// <reference path="../../../typings/lerna/index.d.ts" />
+export declare function getDependencies(packageName: string | string[]): Promise<{
+  dependencies: string[];
+  devDependencies: string[];
+  all: string[];
+  projectGraph: import('lerna/utils').ProjectGraphWithPackages;
+}>;

scripts/monorepo/src/getDependencies.js

@@ -1,9 +1,9 @@
-const { utils: lernaUtils } = require('./lerna-utils');
+const lernaUtils = require('lerna/utils');
 
 /**
  *
  * @param {string[]} packageNames
- * @param {import('./lerna-utils').ProjectGraphWithPackages} projectGraph
+ * @param {lernaUtils.ProjectGraphWithPackages} projectGraph
  * @param {{dependenciesOnly?:boolean}} options
  * @param {string[]} _packagesList
  * @returns

scripts/monorepo/src/lerna-utils/index.js

@@ -0,0 +1,75 @@
+// Type definitions for lerna 7.0.0
+
+// NOTE: types taken from @see https://github.com/lerna/lerna/blob/main/libs/core/src/lib/project-graph-with-packages.ts
+// ISSUE: https://github.com/lerna/lerna/issues/3851
+
+declare module 'lerna/utils' {
+  import type { ProjectFileMap, ProjectGraph, ProjectGraphDependency, ProjectGraphProjectNode } from '@nx/devkit';
+
+  interface RawManifest {
+    name: string;
+    version: string;
+    description?: string;
+    private?: boolean;
+    bin?: Record<string, string> | string;
+    scripts?: Record<string, string>;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    optionalDependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+    publishConfig?: Record<'directory' | 'registry' | 'tag', string>;
+    workspaces?: string[];
+    nx?: Record<string, unknown>;
+    gitHead?: string;
+    lerna?: RawManifestLernaConfig;
+  }
+
+  interface RawManifestLernaConfig {
+    command?: {
+      publish?: {
+        directory?: string;
+        assets?: AssetDefinition[];
+      };
+    };
+  }
+  type AssetDefinition = string | { from: string; to: string };
+
+  interface Package extends Omit<RawManifest, 'lerna' | 'nx' | 'gitHead' | 'workspaces'> {
+    /**
+     * Map-like retrieval of arbitrary values from package.json
+     */
+    get(key: string): unknown;
+    binLocation: string;
+
+    resolved: Record<string, unknown>;
+    /**
+     * path to package.json
+     */
+    manifestLocation: string;
+    location: string;
+    lernaConfig: RawManifest['lerna'] | undefined;
+  }
+
+  type ExtendedNpaResult = {
+    workspaceSpec?: string;
+    workspaceAlias?: string;
+  };
+
+  interface ProjectGraphProjectNodeWithPackage extends ProjectGraphProjectNode {
+    package: Package | null;
+  }
+  interface ProjectGraphWorkspacePackageDependency extends ProjectGraphDependency {
+    targetVersionMatchesDependencyRequirement: boolean;
+    targetResolvedNpaResult: ExtendedNpaResult;
+    dependencyCollection: 'dependencies' | 'devDependencies' | 'optionalDependencies'; // lerna doesn't manage peer dependencies
+  }
+  export interface ProjectGraphWithPackages extends ProjectGraph {
+    nodes: Record<string, ProjectGraphProjectNodeWithPackage>;
+    localPackageDependencies: Record<string, ProjectGraphWorkspacePackageDependency[]>;
+  }
+
+  export function detectProjects(): Promise<{
+    projectGraph: ProjectGraphWithPackages;
+    projectFileMap: ProjectFileMap;
+  }>;
+}

scripts/monorepo/src/lerna-utils/types.ts

@@ -0,0 +1,5 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {},
+  "include": ["*.d.ts"]
+}

typings/lerna/index.d.ts

@@ -30,6 +30,9 @@
     },
     {
       "path": "./find-free-port/tsconfig.json"
+    },
+    {
+      "path": "./lerna/tsconfig.json"
     }
   ]
 }