@callstack/repack - npm Package Compare versions

Comparing version 3.0.1 to 3.1.0

CHANGELOG.md

 # @callstack/repack
 
+## 3.1.0
+
+### Minor Changes
+
+- [#287](https://github.com/callstack/repack/pull/287) [`47bdd09`](https://github.com/callstack/repack/commit/47bdd09f22e1ebf9cdfc29f0bb157a68f7af5b44) Thanks [@andrewworld](https://github.com/andrewworld)!
+
+  A new optional callback `shouldUpdateScript` was added. It could be passed into so-called _locator_ config in `addResolver` callback function return statement. Its main usage would be to ask a user whether they want to download the latest update of Federated Scripts or not (for example – if they are not connected to wifi and they would rather save their cellular data).
+
+  ```
+  shouldUpdateScript?: (
+      scriptId?: string,
+      caller?: string,
+      isScriptCacheOutdated?: boolean
+  ) => Promise<boolean> | boolean;
+  ```
+
+  More info and a set of examples describing what are the intended usages of this API will be published soon in a form of a guide in Repack docs. For now, if you're interested in playing with this API please refer to the linked PR or to the [API docs](https://re-pack.netlify.app/docs/api/repack/client/interfaces/ScriptLocator#shouldupdatescript) 
+
+### Patch Changes
+
+- [#293](https://github.com/callstack/repack/pull/293) [`7eeca5e`](https://github.com/callstack/repack/commit/7eeca5ed2619e7678ef88d8fb45735c14f1ecc75) Thanks [@RafikiTiki](https://github.com/RafikiTiki)! - Removed usage of deprecated jcenter repository from `build.gradle`.
+
+* [#288](https://github.com/callstack/repack/pull/288) [`7e0092e`](https://github.com/callstack/repack/commit/7e0092e9554e26a1de405261fb56c1e6b886e261) Thanks [@RafikiTiki](https://github.com/RafikiTiki)! - Fix [#258](https://github.com/callstack/repack/issues/293) – previously `entryName` config value was not passed from `RepackPlugin` to the `OutputPlugin`.
+
+- [#294](https://github.com/callstack/repack/pull/294) [`28cc721`](https://github.com/callstack/repack/commit/28cc721e8d6ac085bc66c47e627633046cb0d644) Thanks [@RafikiTiki](https://github.com/RafikiTiki)! - Updated kotlin-gradle-plugin version used by Repack to `1.7.0`.
+
 ## 3.0.1
@@ -13,2 +39,3 @@
   - [#276](https://github.com/callstack/repack/pull/276) [`a15e881`](https://github.com/callstack/repack/commit/a15e8816c640c6627ef3ebb5a9d18b58f7178c6f) Thanks [@RafikiTiki](https://github.com/RafikiTiki)! - Fix: assetsCache not available on Windows platform due to problem with path encoding
+
 - [#255](https://github.com/callstack/repack/pull/255) [`d974069`](https://github.com/callstack/repack/commit/d974069ab2e7abee2a4b7103a8a86fe476fc122a) Thanks [@meypod](https://github.com/meypod)! - Fix v3 `debugger-app` not working on Windows platform
@@ -15,0 +42,0 @@

dist/modules/ScriptManager/Script.d.ts

@@ -63,2 +63,10 @@ import type { NormalizedScriptLocator, ScriptLocator, WebpackContext } from './types';
     /**
+     * Check if the script was already cached and cache should be updated with new data.
+     *
+     * @param cachedData Cached data for the same script.
+     *
+     * @internal
+     */
+    shouldUpdateCache(cachedData: Pick<NormalizedScriptLocator, 'method' | 'url' | 'query' | 'headers' | 'body'>): boolean;
+    /**
      * Check if the script should be fetched again or reused,
@@ -73,2 +81,10 @@ * based on previous cached data.
     /**
+     * Check if previous cached data is the same as the new one.
+     *
+     * @param cachedData Cached data for the same script.
+     *
+     * @internal
+     */
+    checkIfCacheDataOutdated(cachedData: Pick<NormalizedScriptLocator, 'method' | 'url' | 'query' | 'headers' | 'body'>): boolean;
+    /**
      * Get object to store in cache.
@@ -75,0 +91,0 @@ *

dist/modules/ScriptManager/Script.js

@@ -122,2 +122,18 @@ /* globals Headers, FormData */
   /**
+   * Check if the script was already cached and cache should be updated with new data.
+   *
+   * @param cachedData Cached data for the same script.
+   *
+   * @internal
+   */
+
+
+  shouldUpdateCache(cachedData) {
+    if (!this.cache || !cachedData) {
+      return false;
+    }
+
+    return this.checkIfCacheDataOutdated(cachedData);
+  }
+  /**
    * Check if the script should be fetched again or reused,
@@ -137,2 +153,14 @@ * based on previous cached data.
 
+    return this.checkIfCacheDataOutdated(cachedData);
+  }
+  /**
+   * Check if previous cached data is the same as the new one.
+   *
+   * @param cachedData Cached data for the same script.
+   *
+   * @internal
+   */
+
+
+  checkIfCacheDataOutdated(cachedData) {
     const diffs = [cachedData.method !== this.locator.method, cachedData.url !== this.locator.url, cachedData.query !== this.locator.query, !shallowEqual(cachedData.headers, this.locator.headers), cachedData.body !== this.locator.body];
@@ -139,0 +167,0 @@ return diffs.some(diff => diff);

dist/modules/ScriptManager/ScriptManager.js

@@ -246,4 +246,20 @@ /* globals __DEV__, __webpack_require__ */
       }, locator, false);
-      const cacheKey = `${scriptId}_${caller ?? 'unknown'}`;
+      const cacheKey = `${scriptId}_${caller ?? 'unknown'}`; // Check if user provided a custom shouldUpdateScript function
 
+      if (locator.shouldUpdateScript) {
+        // If so, we need to wait for it to resolve
+        const fetch = await locator.shouldUpdateScript(scriptId, caller, script.shouldUpdateCache(this.cache[cacheKey])); // If it returns true, we need to fetch the script
+
+        if (fetch) {
+          script.locator.fetch = true;
+          this.cache[cacheKey] = script.getCacheData();
+          await this.saveCache();
+        }
+
+        this.emit('resolved', script.toObject()); // if it returns false, we don't need to fetch the script
+
+        return script;
+      } // If no custom shouldUpdateScript function was provided, we use the default behaviour
+
+
       if (!this.cache[cacheKey]) {
@@ -250,0 +266,0 @@ script.locator.fetch = true;

dist/modules/ScriptManager/types.d.ts

@@ -81,2 +81,20 @@ export interface WebpackContext {
     cache?: boolean;
+    /**
+     * Function called before loading or getting from the cache and after resolving the script locator.
+     * It's an async function which should return a boolean indicating whether the script should be loaded or use default behaviour.
+     * This is useful when you want to load a script only when certain conditions are met
+     * (e.g. ask user if they want to update/download new version of the script)
+     *
+     * When `true` is returned, the script will be loaded from the network.
+     * When `false` is returned, the script will be loaded from the cache.
+     *
+     * @param scriptId Id of the script to resolve.
+     * @param caller Name of the calling script - it can be for example: name of the bundle, chunk or container.
+     * @param isScriptCacheOutdated Boolean indicating whether the script cache is outdated or not. It's `true` when the script
+     * cache is outdated and `false` when the script cache is up to date or there is no cache for the script.
+     * Outdated cache means that the script was previously downloaded and put into cache,
+     * but the script locator data (method, url, query, headers, or body) has changed since then.
+     * @returns Boolean indicating whether the script should be loaded or not
+     */
+    shouldUpdateScript?: (scriptId?: string, caller?: string, isScriptCacheOutdated?: boolean) => Promise<boolean> | boolean;
 }
@@ -83,0 +101,0 @@ /**

dist/webpack/plugins/RepackPlugin.js

@@ -101,2 +101,3 @@ "use strict";
       output: this.config.output,
+      entryName: this.config.entryName,
       extraChunks: this.config.extraChunks
@@ -103,0 +104,0 @@ }).apply(compiler);

package.json

 {
   "name": "@callstack/repack",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "A Webpack-based toolkit to build your React Native application with full support of Webpack ecosystem.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

739170

25.94%

Number of package files

303

42.25%

Lines of code

6311

1.11%

No dependency changes