@atlaskit/dependency-version-analytics 0.3.11 → 0.3.13

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/dependency-version-analytics
 
+## 0.3.13
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
+## 0.3.12
+
+### Patch Changes
+
+- [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`.
+
 ## 0.3.11
 
 ### Patch Changes

package/cli/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/cli.js",
   "module:es2019": "../dist/es2019/cli.js",
   "sideEffects": false,
-  "types": "../dist/types/cli.d.ts"
+  "types": "../dist/types/cli.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/cli.d.ts"
+      ]
+    }
+  }
 }

package/constants/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/constants.js",
   "module:es2019": "../dist/es2019/constants.js",
   "sideEffects": false,
-  "types": "../dist/types/constants.d.ts"
+  "types": "../dist/types/constants.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/constants.d.ts"
+      ]
+    }
+  }
 }

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dependency-version-analytics",
-	"version": "0.3.11",
+	"version": "0.3.13",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dependency-version-analytics",
-	"version": "0.3.11",
+	"version": "0.3.13",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/dependency-version-analytics",
-	"version": "0.3.11",
+	"version": "0.3.13",
 	"sideEffects": false
 }

package/dist/types-ts4.0/cli.d.ts

@@ -0,0 +1,4 @@
+/// <reference lib="es2017.object" />
+export declare function run({ dev }: {
+    dev: boolean;
+}): Promise<void> | Promise<import("./types").UpgradeEvent[]>;

package/dist/types-ts4.0/commands/populate-historic-data/__fixtures__/git.d.ts

@@ -0,0 +1,2 @@
+import type { LogResult } from 'simple-git';
+export declare const generateLogs: (fileChanges: string[][]) => LogResult;

package/dist/types-ts4.0/commands/populate-historic-data/index.d.ts

@@ -0,0 +1,2 @@
+export { default as populateProduct } from './product';
+export { default as populatePackage } from './package';

package/dist/types-ts4.0/commands/populate-historic-data/lib/dependency-store.d.ts

@@ -0,0 +1,39 @@
+/** Workspace code */
+import { DependencyMap } from '../types';
+import type { DefaultLogFields, ListLogLine } from 'simple-git';
+/**
+ * Stores the state of atlaskit dependencies in a repository
+ */
+export declare class DependencyStore {
+    private cwd;
+    /** Mapping of dependency names to arrays of unique dependency type + versions */
+    private dependencies;
+    /** Mapping of workspaces to their dependency map. Each dependency in their map links to an entry in `dependencies` */
+    private workspaces;
+    /** Set of workspace globs. Used to verify that a package.json is a valid workspace */
+    private workspaceGlobs;
+    private initialised;
+    constructor(cwd?: string);
+    /** Scans the repo for dependencies at the specified git ref and return the flattened dependency map */
+    initialise(gitRef: string | undefined): Promise<DependencyMap>;
+    /** Updates the repo dependency store based on the changes in `logItem`.
+     * Returns the updated flattened dependencies
+     */
+    update(logItem: DefaultLogFields & ListLogLine): Promise<DependencyMap>;
+    /** Retrieve a flattened list of p repo dependencies.
+     * If multiple versions of a dependency exist, the lowest version is returned.
+     * If the dependency is listed under multiple dependency types, 'dependencies' is prioritised over 'devDependencies'
+     */
+    private getFlattenedDeps;
+    private assertInitialised;
+    /** Scans all workspaces in repo and rebuilds dependency store */
+    private resetStore;
+    private getWorkspaceDependencies;
+    private updateWorkspaces;
+    private addDependency;
+    private removeDependency;
+    private static getAkDependencies;
+    private static getMinimumVersion;
+    private static transformDepName;
+    private static transformDepVersion;
+}

package/dist/types-ts4.0/commands/populate-historic-data/package.d.ts

@@ -0,0 +1,7 @@
+import { PopulateHistoricDataFlags } from './types';
+import { UpgradeEvent } from '../../types';
+export declare type PopulatePackageFlags = PopulateHistoricDataFlags & {
+    since?: string;
+    pkg: string;
+};
+export default function populatePackage(flags: PopulatePackageFlags): Promise<UpgradeEvent[]>;

package/dist/types-ts4.0/commands/populate-historic-data/product.d.ts

@@ -0,0 +1,9 @@
+import { PopulateHistoricDataFlags } from './types';
+export declare type PopulateProductFlags = PopulateHistoricDataFlags & {
+    csv: boolean;
+    product: string;
+    reset: boolean;
+    statlas?: boolean;
+    tag?: string;
+};
+export default function populateProduct(flags: PopulateProductFlags): Promise<void>;

package/dist/types-ts4.0/commands/populate-historic-data/types.d.ts

@@ -0,0 +1,18 @@
+import { DependencyType } from '../../types';
+export declare type PopulateHistoricDataFlags = {
+    cwd?: string;
+    dev: boolean;
+    dryRun: boolean;
+    limit?: number;
+    interactive: boolean;
+};
+export declare type DependencyMap = {
+    [name: string]: {
+        version: string;
+        type: DependencyType;
+    };
+};
+export declare type AkPackageChange = {
+    akDeps: DependencyMap;
+    date: string;
+};

package/dist/types-ts4.0/commands/populate-historic-data/util/generate-csv.d.ts

@@ -0,0 +1,3 @@
+import { AkPackageChange } from '../types';
+/** Generates a CSV of product package changes over time */
+export declare const generateCSV: (packageChanges: AkPackageChange[]) => string;

package/dist/types-ts4.0/constants.d.ts

@@ -0,0 +1,19 @@
+export declare const DEFAULT_TAG = "atlaskit-dependency-version-analytics-last-run";
+export declare const DEP_TYPES: readonly [
+    {
+        readonly packageJsonKey: "devDependencies";
+        readonly depTypeName: "devDependency";
+    },
+    {
+        readonly packageJsonKey: "dependencies";
+        readonly depTypeName: "dependency";
+    },
+    {
+        readonly packageJsonKey: "peerDependencies";
+        readonly depTypeName: "peerDependency";
+    },
+    {
+        readonly packageJsonKey: "optionalDependencies";
+        readonly depTypeName: "optionalDependency";
+    }
+];

package/dist/types-ts4.0/index.d.ts

@@ -0,0 +1,3 @@
+export { populateProduct, populatePackage, } from './commands/populate-historic-data';
+export { sendAnalytics } from './util/analytics';
+export type { DependencyType, UpgradeType, UpgradeSubType, UpgradeEvent, } from './types';

package/dist/types-ts4.0/types.d.ts

@@ -0,0 +1,18 @@
+import { ReleaseType } from 'semver';
+export declare type DependencyType = 'devDependency' | 'dependency' | 'optionalDependency' | 'peerDependency';
+export declare type UpgradeType = 'add' | 'upgrade' | 'remove' | 'downgrade';
+export declare type UpgradeSubType = ReleaseType | null;
+export declare type UpgradeEvent = {
+    dependencyName: string;
+    versionString: string;
+    major: string | null;
+    minor: string | null;
+    patch: string | null;
+    date: string;
+    upgradeType: UpgradeType;
+    upgradeSubType: UpgradeSubType;
+    cliVersion: string;
+    dependencyType?: DependencyType;
+    historical?: boolean;
+    commitHash?: string;
+};

package/dist/types-ts4.0/util/analytics.d.ts

@@ -0,0 +1,12 @@
+import { UpgradeEvent, DependencyType } from '../types';
+export declare function createUpgradeEvent(name: string, version: string | undefined, previousVersion: string | undefined, date: string, optionalArgs?: {
+    commitHash?: string;
+    dependencyType?: DependencyType;
+    historical?: boolean;
+}): UpgradeEvent | null;
+export declare function sendAnalytics(analyticsEvents: UpgradeEvent[], { dev, limit, product, skipPrompt, }: {
+    dev?: boolean;
+    limit?: number;
+    product: string;
+    skipPrompt?: boolean;
+}): Promise<void>;

package/dist/types-ts4.0/util/assert.d.ts

@@ -0,0 +1,2 @@
+/** Generic assertion function */
+export declare function assert(condition: any, msg?: string): asserts condition;

package/dist/types-ts4.0/util/env-with-guard.d.ts

@@ -0,0 +1 @@
+export default function (name: string): string | null;

package/dist/types-ts4.0/util/get-file-history-from-git.d.ts

@@ -0,0 +1 @@
+export default function getFileHistoryFromGit(fileName: string): Promise<string>;

package/dist/types-ts4.0/util/get-package-version-history.d.ts

@@ -0,0 +1,4 @@
+export declare type PackageVersionHistory = {
+    [version: string]: string;
+};
+export default function getPackageVersionHistory(packageName: string): Promise<PackageVersionHistory>;

package/dist/types-ts4.0/util/git.d.ts

@@ -0,0 +1,14 @@
+import type { LogResult } from 'simple-git';
+export declare function getChangesSince(since?: string): Promise<LogResult>;
+export declare function tagCommit(tag: string): Promise<string>;
+export declare function doesTagExist(tag: string): Promise<boolean>;
+export declare function refetchTag(tag: string): Promise<{
+    fetchTagResult: import("simple-git").FetchResult | undefined;
+}>;
+export declare function getHash(ref: string): Promise<string>;
+export declare function showFile(ref: string, filename: string, opts?: {
+    cwd?: string;
+}): import("simple-git").Response<string>;
+export declare function getFiles(ref: string, glob: string, opts?: {
+    cwd?: string;
+}): Promise<string[]>;

package/dist/types-ts4.0/util/statlas.d.ts

@@ -0,0 +1,5 @@
+export declare type Meta = {
+    lastRunHash: string;
+};
+export declare function getMeta(product: string): Promise<Meta | null>;
+export declare function uploadMeta(product: string, lastRunHash: string): Promise<void>;

package/dist/types-ts4.0/util/yarn.d.ts

@@ -0,0 +1,2 @@
+export declare function getWorkspaceGlobs(ref: string, cwd: string): Promise<Set<string> | null>;
+export declare function getWorkspacePaths(ref: string, workspaceGlobs: Set<string>, cwd: string): Promise<string[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/dependency-version-analytics",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "description": "Tool to pull atlaskit version history from a repo",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -10,6 +10,13 @@
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "atlassian": {
@@ -40,8 +47,8 @@
     "@types/jest": "^26.0.14",
     "@types/micromatch": "^4.0.1",
     "@types/node": "~16.11.27",
-    "ts-node": "^10.0.0",
-    "typescript": "4.2.4"
+    "ts-node": "^10.9.1",
+    "typescript": "4.5.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
 }

package/report.api.md

@@ -2,16 +2,24 @@
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
+<!--
+	Generated API Report version: 2.0
+-->
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
 ```ts
 import { ReleaseType } from 'semver';
 
-export declare type DependencyType =
+// @public (undocumented)
+export type DependencyType =
   | 'devDependency'
   | 'dependency'
   | 'optionalDependency'
   | 'peerDependency';
 
-declare type PopulateHistoricDataFlags = {
+// @public (undocumented)
+type PopulateHistoricDataFlags = {
   cwd?: string;
   dev: boolean;
   dryRun: boolean;
@@ -19,20 +27,22 @@ declare type PopulateHistoricDataFlags = {
   interactive: boolean;
 };
 
-export declare function populatePackage(
+// @public (undocumented)
+export function populatePackage(
   flags: PopulatePackageFlags,
 ): Promise<UpgradeEvent[]>;
 
-declare type PopulatePackageFlags = PopulateHistoricDataFlags & {
+// @public (undocumented)
+type PopulatePackageFlags = PopulateHistoricDataFlags & {
   since?: string;
   pkg: string;
 };
 
-export declare function populateProduct(
-  flags: PopulateProductFlags,
-): Promise<void>;
+// @public (undocumented)
+export function populateProduct(flags: PopulateProductFlags): Promise<void>;
 
-declare type PopulateProductFlags = PopulateHistoricDataFlags & {
+// @public (undocumented)
+type PopulateProductFlags = PopulateHistoricDataFlags & {
   csv: boolean;
   product: string;
   reset: boolean;
@@ -40,7 +50,8 @@ declare type PopulateProductFlags = PopulateHistoricDataFlags & {
   tag?: string;
 };
 
-export declare function sendAnalytics(
+// @public (undocumented)
+export function sendAnalytics(
   analyticsEvents: UpgradeEvent[],
   {
     dev,
@@ -55,7 +66,8 @@ export declare function sendAnalytics(
   },
 ): Promise<void>;
 
-export declare type UpgradeEvent = {
+// @public (undocumented)
+export type UpgradeEvent = {
   dependencyName: string;
   versionString: string;
   major: string | null;
@@ -70,9 +82,11 @@ export declare type UpgradeEvent = {
   commitHash?: string;
 };
 
-export declare type UpgradeSubType = ReleaseType | null;
+// @public (undocumented)
+export type UpgradeSubType = ReleaseType | null;
 
-export declare type UpgradeType = 'add' | 'upgrade' | 'remove' | 'downgrade';
+// @public (undocumented)
+export type UpgradeType = 'add' | 'upgrade' | 'remove' | 'downgrade';
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```

package/types/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
   "sideEffects": false,
-  "types": "../dist/types/types.d.ts"
+  "types": "../dist/types/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/types.d.ts"
+      ]
+    }
+  }
 }