@atlaspack/types-internal 2.14.7 → 2.14.8

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaspack/types-internal
 
+## 2.14.8
+
+### Patch Changes
+
+- [#595](https://github.com/atlassian-labs/atlaspack/pull/595) [`51aba5f`](https://github.com/atlassian-labs/atlaspack/commit/51aba5fc0e49235ee06bbc3c376f48c3e7da5c4b) Thanks [@yamadapc](https://github.com/yamadapc)! - Add bundleId to write bundle request results
+
 ## 2.14.7
 
 ### Patch Changes

package/lib/index.d.ts

@@ -937,16 +937,17 @@ export interface Config {
    */
   getConfigFrom<T>(searchPath: FilePath, filePaths: Array<FilePath>, options?: {
     /**
-     * @deprecated Use `configKey` instead.
+     * @deprecated Use `readTracking` instead.
      */
     packageKey?: string;
     parse?: boolean;
     exclude?: boolean;
   } | {
     /**
-     * If specified, only invalidate when this config key changes.
+     * If specified, this function will return a proxy object that will track reads to
+     * config fields and only register invalidations for when those keys change.
      */
-    configKey?: string;
+    readTracking?: boolean;
   }): Promise<ConfigResultWithFilePath<T> | null | undefined>;
 
   /** Finds the nearest package.json from the config's searchPath. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/types-internal",
-  "version": "2.14.7",
+  "version": "2.14.8",
   "license": "(MIT OR Apache-2.0)",
   "main": "src/index.js",
   "types": "lib/index.d.ts",

package/src/index.js

@@ -978,7 +978,7 @@ export interface Config {
     options?:
       | {|
           /**
-           * @deprecated Use `configKey` instead.
+           * @deprecated Use `readTracking` instead.
            */
           packageKey?: string,
           parse?: boolean,
@@ -986,9 +986,10 @@ export interface Config {
         |}
       | {|
           /**
-           * If specified, only invalidate when this config key changes.
+           * If specified, this function will return a proxy object that will track reads to
+           * config fields and only register invalidations for when those keys change.
            */
-          configKey?: string,
+          readTracking?: boolean,
         |},
   ): Promise<?ConfigResultWithFilePath<T>>;
   /** Finds the nearest package.json from the config's searchPath. */