@lerna-lite/core 1.1.0 → 1.4.0

package/dist/package.d.ts

@@ -1,96 +1,91 @@
-/**
- * @typedef {object} RawManifest The subset of package.json properties that Lerna-Lite uses
- * @property {string} name
- * @property {string} version
- * @property {boolean} [private]
- * @property {Record<string, string>|string} [bin]
- * @property {Record<string, string>} [scripts]
- * @property {Record<string, string>} [dependencies]
- * @property {Record<string, string>} [devDependencies]
- * @property {Record<string, string>} [optionalDependencies]
- * @property {Record<string, string>} [peerDependencies]
- * @property {Record<'directory' | 'registry' | 'tag', string>} [publishConfig]
- * @property {string[] | { packages: string[] }} [workspaces]
- */
-/**
- * Lerna's internal representation of a local package, with
- * many values resolved directly from the original JSON.
- */
-export declare class Package {
-    _id: string;
-    name: string;
-    licensePath: string;
-    localDependencies: Map<string, any>;
-    /**
-     * Create a Package instance from parameters, possibly reusing existing instance.
-     * @param {string|Package|RawManifest} ref A path to a package.json file, Package instance, or JSON object
-     * @param {string} [dir] If `ref` is a JSON object, this is the location of the manifest
-     * @returns {Package}
-     */
-    static lazy(ref: any, dir?: string): any;
-    /**
-     * @param {RawManifest} pkg
-     * @param {string} location
-     * @param {string} [rootPath]
-     */
-    constructor(pkg: Package, location: string, rootPath?: string);
-    get location(): string;
-    get private(): boolean;
-    get resolved(): {
-        name: string;
-        bin: any;
-        scope: any;
-    };
-    get rootPath(): string;
-    get scripts(): any;
-    get bin(): any;
-    get binLocation(): string;
-    get manifestLocation(): string;
-    get nodeModulesLocation(): string;
-    get __isLernaPackage(): boolean;
-    get version(): string;
-    set version(version: string);
-    get contents(): any;
-    set contents(subDirectory: any);
-    get dependencies(): string[];
-    get devDependencies(): string[];
-    get optionalDependencies(): string[];
-    get peerDependencies(): string[];
-    get pkg(): Package;
-    /**
-     * Map-like retrieval of arbitrary values
-     * @template {keyof RawManifest} K
-     * @param {K} key field name to retrieve value
-     * @returns {RawManifest[K]} value stored under key, if present
-     */
-    get(key: any): any;
-    /**
-     * Map-like storage of arbitrary values
-     * @template {keyof RawManifest} K
-     * @param {T} key field name to store value
-     * @param {RawManifest[K]} val value to store
-     * @returns {Package} instance for chaining
-     */
-    set(key: string, val: any): this;
-    /**
-     * Provide shallow copy for munging elsewhere
-     * @returns {Object}
-     */
-    toJSON(): {};
-    /**
-     * Refresh internal state from disk (e.g., changed by external lifecycles)
-     */
-    refresh(): Promise<this>;
-    /**
-     * Write manifest changes to disk
-     * @returns {Promise} resolves when write finished
-     */
-    serialize(): Promise<this>;
-    /**
-     * Mutate local dependency spec according to type
-     * @param {Object} resolved npa metadata
-     * @param {String} depVersion semver
-     * @param {String} savePrefix npm_config_save_prefix
-     */
-    updateLocalDependency(resolved: any, depVersion: any, savePrefix: any): void;
-}
+import { CommandType, NpaResolveResult, RawManifest } from './models';
+/**
+ * Lerna's internal representation of a local package, with
+ * many values resolved directly from the original JSON.
+ */
+export declare class Package {
+    _id: string;
+    name: string;
+    licensePath: string;
+    localDependencies: Map<string, any>;
+    /**
+     * Create a Package instance from parameters, possibly reusing existing instance.
+     * @param {string|Package|RawManifest} ref A path to a package.json file, Package instance, or JSON object
+     * @param {string} [dir] If `ref` is a JSON object, this is the location of the manifest
+     * @returns {Package}
+     */
+    static lazy(ref: string | Package | RawManifest, dir?: string): Package;
+    /**
+     * @param {RawManifest} pkg
+     * @param {string} location
+     * @param {string} [rootPath]
+     */
+    constructor(pkg: RawManifest, location: string, rootPath?: string);
+    get location(): string;
+    get private(): boolean;
+    get resolved(): {
+        name: string;
+        bin: any;
+        scope: any;
+    };
+    get rootPath(): string;
+    get scripts(): any;
+    get bin(): any;
+    get binLocation(): string;
+    get manifestLocation(): string;
+    get nodeModulesLocation(): string;
+    get __isLernaPackage(): boolean;
+    get version(): string;
+    set version(version: string);
+    get workspaces(): string[] | {
+        packages: string[];
+    };
+    set workspaces(workspaces: string[] | {
+        packages: string[];
+    });
+    get contents(): string;
+    set contents(subDirectory: string);
+    get dependencies(): string[];
+    get devDependencies(): string[];
+    get optionalDependencies(): string[];
+    get peerDependencies(): string[];
+    get pkg(): Package;
+    /**
+     * Map-like retrieval of arbitrary values
+     * @template {keyof RawManifest} K
+     * @param {K} key field name to retrieve value
+     * @returns {RawManifest[K]} value stored under key, if present
+     */
+    get<K extends keyof RawManifest>(key: string): K;
+    /**
+     * Map-like storage of arbitrary values
+     * @template {keyof RawManifest} K
+     * @param {T} key field name to store value
+     * @param {RawManifest[K]} val value to store
+     * @returns {Package} instance for chaining
+     */
+    set(key: string, val: RawManifest[keyof RawManifest]): Package;
+    /**
+     * Provide shallow copy for munging elsewhere
+     * @returns {Object}
+     */
+    toJSON(): {};
+    /**
+     * Refresh internal state from disk (e.g., changed by external lifecycles)
+     */
+    refresh(): Promise<this>;
+    /**
+     * Write manifest changes to disk
+     * @returns {Promise} resolves when write finished
+     */
+    serialize(): Promise<this>;
+    /**
+     * Mutate local dependency spec according to type
+     * @param {Object} resolved npa metadata
+     * @param {String} depVersion semver
+     * @param {String} savePrefix npm_config_save_prefix
+     * @param {Boolean} workspaceStrictMatch - are we using strict match with `workspace:` protocol
+     * @param {String} updatedByCommand - which command called this update?
+     */
+    updateLocalDependency(resolved: NpaResolveResult, depVersion: string, savePrefix: string, workspaceStrictMatch?: boolean, updatedByCommand?: CommandType): void;
+}