@callstack/licenses 0.2.2 → 0.3.0

package/src/{utils → node/utils}/packageUtils.ts

@@ -1,10 +1,10 @@
 import fs from 'fs';
 import path from 'path';
 
-import type { LicenseObj, ScanPackageOptionsFactory } from '../types';
+import type { License, ScanPackageOptionsFactory } from '../../types';
+import { normalizeRepositoryUrl } from '../../utils/repositoryUtils';
 
 import { sha512 } from './miscUtils';
-import { normalizeRepositoryUrl } from './repositoryUtils';
 
 export function getPackageJsonPath(dependency: string, root?: string) {
   const rootsToSearch = [
@@ -54,7 +54,7 @@ export function normalizePackageName(packageName: string): string {
   return packageName.replace('/', '_');
 }
 
-export function prepareAboutLibrariesLicenseField(license: LicenseObj) {
+export function prepareAboutLibrariesLicenseField(license: License) {
   if (!license.type) {
     return '';
   }

package/src/types/AggregatedLicensesMapping.ts

@@ -0,0 +1,7 @@
+import type { License } from './License';
+
+/**
+ * Mapping from package keys in format `<package-name>@<package-version>` to license objects.
+ * @see {@link License}
+ */
+export type AggregatedLicensesMapping = Record<string, License>;

package/src/types/{LicenseObj.ts → License.ts}

@@ -1,7 +1,8 @@
 import type { DependencyType } from './DependencyType';
+import type { ParentPackageInfo } from './ParentPackageInfo';
 import type { ScanPackageCallContext } from './ScanPackageCallContext';
 
-export type LicenseObj = {
+export type License = {
   /** Package name */
   name: string;
 
@@ -31,4 +32,10 @@ export type LicenseObj = {
 
   /** The required version specified in package.json */
   requiredVersion: string;
-} & Pick<ScanPackageCallContext, 'parentPackageName' | 'parentPackageRequiredVersion' | 'parentPackageResolvedVersion'>;
+
+  /**
+   * The name(s) of the package(s) that introduced the package as a dependency (of any type);
+   * empty array if the package is a dependency of the root package
+   */
+  parentPackages: ParentPackageInfo[];
+} & Pick<ScanPackageCallContext, 'parentPackageRequiredVersion' | 'parentPackageResolvedVersion'>;

package/src/types/LicenseAnalysisResult.ts

@@ -0,0 +1,7 @@
+import type { LicenseCategory } from '../licenses/LicenseCategory';
+
+import type { LicenseStats } from './LicenseStats';
+
+export interface LicenseAnalysisResult extends LicenseStats {
+  categorizedLicenses: Record<string, LicenseCategory>;
+}

package/src/types/LicenseStats.ts

@@ -0,0 +1,33 @@
+import type { LicenseCategory } from '../licenses/LicenseCategory';
+
+export interface LicenseStats {
+  /**
+   * Total number of packages
+   */
+  total: number;
+
+  /**
+   * Mapping of license category to count of packages in that category
+   */
+  byCategory: Record<LicenseCategory, number>;
+
+  /**
+   * Mapping of license name to count of packages with that license
+   */
+  byLicense: Record<string, number>;
+
+  /**
+   * Information about the presence of different license categories
+   */
+  categoriesPresence: {
+    hasAnyUnknown: boolean;
+    hasAnyWeakCopyleft: boolean;
+    hasAnyStrongCopyleft: boolean;
+    hasAllPermissive: boolean;
+  };
+
+  /**
+   * Description of the graph state based on the license categories
+   */
+  description: string;
+}

package/src/types/ParentPackageInfo.ts

@@ -0,0 +1,16 @@
+export type ParentPackageInfo = {
+  /**
+   * The name of the package
+   */
+  name: string;
+
+  /**
+   * The required version, as specified in package.json
+   */
+  requiredVersion: string;
+
+  /**
+   * The resolved version, as specified in package.json
+   */
+  resolvedVersion: string;
+};

package/src/types/index.ts

@@ -1,5 +1,5 @@
-export * from './LicenseObj';
-export * from './AggregatedLicensesObj';
+export * from './License';
+export * from './AggregatedLicensesMapping';
 export * from './AboutLibrariesLibraryJsonPayload';
 export * from './AboutLibrariesLicenseJsonPayload';
 export * from './LicensePlistPayload';
@@ -7,3 +7,6 @@ export * from './AboutLibrariesLikePackageInfo';
 export * from './ScanPackageOptions';
 export * from './ScanPackageCallContext';
 export * from './DependencyType';
+export * from './ParentPackageInfo';
+export * from './LicenseAnalysisResult';
+export * from './LicenseStats';

package/src/utils/index.ts

@@ -1,4 +1,2 @@
-export * as PackageUtils from './packageUtils';
-export * as MiscUtils from './miscUtils';
 export * as RepositoryUtils from './repositoryUtils';
 export * as YamlUtils from './yamlUtils';

package/build/types/AggregatedLicensesObj.d.ts

@@ -1,6 +0,0 @@
-import type { LicenseObj } from './LicenseObj';
-/**
- * Mapping from package keys in format `<package-name>/<package-version>` to license objects.
- * @see {@link LicenseObj}
- */
-export type AggregatedLicensesObj = Record<string, LicenseObj>;

package/src/types/AggregatedLicensesObj.ts

@@ -1,7 +0,0 @@
-import type { LicenseObj } from './LicenseObj';
-
-/**
- * Mapping from package keys in format `<package-name>/<package-version>` to license objects.
- * @see {@link LicenseObj}
- */
-export type AggregatedLicensesObj = Record<string, LicenseObj>;