@expofp/offline 3.0.0-alpha.8 → 3.0.0

package/README.md

@@ -0,0 +1,31 @@
+## Offline: generating ZIPs
+
+The `@expofp/offline` package provides a CLI (`expofp-offline`) that creates self-contained ZIP archives of floor plans. The ZIP can be opened in any browser without internet connectivity.
+
+### Usage
+
+```bash
+npx @expofp/offline@<tag-or-version> <manifest-url> [options]
+```
+
+Use a dist-tag or exact version to match the deployed floor plan (e.g. `@latest`, `@next`, `@customer1`, `@3.0.0-alpha.9`).
+
+| Option            | Description         | Default       |
+| ----------------- | ------------------- | ------------- |
+| `-o`, `--output`  | Output file path    | `offline.zip` |
+| `-h`, `--help`    | Show help message   |               |
+| `-v`, `--version` | Show version number |               |
+
+### Example
+
+```bash
+npx @expofp/offline@next https://demo.expofp.com/manifest.json -o offline.zip
+```
+
+### Debugging
+
+Enable debug output with the `DEBUG` env variable:
+
+```bash
+DEBUG=efp:offline:* npx @expofp/offline https://...
+```

package/dist/lib/generate-offline-data-legacy.js

@@ -1,5 +1,5 @@
 import { resolve } from '@expofp/resolve';
-import { deepClone, makeLocalPath, niceFetch } from '@expofp/utils';
+import { deepClone, fetchWithRetry, makeLocalPath } from '@expofp/utils';
 import debug from 'debug';
 import { offlinizeAssetsInPlace } from './offlinize-assets-in-place.js';
 const log = debug('efp:offline:generate-offline-data-legacy');
@@ -53,7 +53,7 @@ export async function* generateOfflineDataLegacy(manifest, options) {
  * (the function itself is Node-only).
  */
 async function execScriptInSandbox(url, signal) {
-    const response = await niceFetch(url, { signal });
+    const response = await fetchWithRetry(url, { signal });
     if (!response.ok) {
         throw new Error(`Failed to fetch script (HTTP ${response.status}): ${url}`);
     }

package/dist/lib/generate-offline-data.js

@@ -9,20 +9,35 @@ const log = debug('efp:offline:generate-offline-data');
 export async function* generateOfflineData(inputManifest, options) {
     const manifest = deepClone(await resolve(inputManifest));
     log(`Generating offline files for expo: ${manifest.expo}`);
+    const pathPrefix = manifest.expo;
+    // this is a requirement of mobile SDK, paths in the ZIP must be prefixed with the expo name
+    // TODO: make sure SDK works with unprefixed paths, and remove the prefixing logic from this function
+    const prefixPath = (path) => `${pathPrefix}/${path}`;
     if (manifest.legacyDataUrlBase) {
-        yield* generateOfflineDataLegacy(manifest, options);
+        for await (const d of generateOfflineDataLegacy(manifest, options)) {
+            yield { ...d, targetFilePath: prefixPath(d.targetFilePath) };
+        }
     }
     // transform entire manifest + assets
     const data = await offlinizeAssetsInPlace(manifest, options);
     for (const d of data) {
-        yield d;
+        yield { ...d, targetFilePath: prefixPath(d.targetFilePath) };
     }
-    // add runtime files
-    const { entry } = yield* generateRuntimeFilesData(options.runtimeBaseUrl);
+    // add runtime files — manually iterate to prefix paths while capturing return value
+    const runtimeGen = generateRuntimeFilesData(options.runtimeBaseUrl);
+    let runtimeResult = await runtimeGen.next();
+    while (!runtimeResult.done) {
+        yield {
+            ...runtimeResult.value,
+            targetFilePath: prefixPath(runtimeResult.value.targetFilePath),
+        };
+        runtimeResult = await runtimeGen.next();
+    }
+    const { entry } = runtimeResult.value;
     // generate index.html
     yield {
         text: getIndexHtml(entry, manifest),
-        targetFilePath: './index.html',
+        targetFilePath: prefixPath('index.html'),
     };
 }
 /** Build a complete offline ZIP archive from a manifest. */
@@ -31,13 +46,17 @@ export async function buildOfflineZip(manifest, options) {
     const files = dataToFiles(data, { signal: options.signal });
     return await buildZipArchive(files);
 }
+/** Known path — file lives in `packages/floorplan/public/` and is copied to dist by Vite. */
+const COMPAT_HELPER = 'compat-helper.js';
 function getIndexHtml(entry, manifest) {
+    // entry is "./runtime/index.js", derive the runtime base path
+    const runtimeBase = entry.slice(0, entry.lastIndexOf('/') + 1);
     return `\
 <!DOCTYPE html>
+<script src="${runtimeBase}${COMPAT_HELPER}"></script>
 <script type="module">
   import { load } from ${JSON.stringify(entry)};
   await load(${JSON.stringify(manifest)});
-  console.info('loaded');
 </script>
 `;
 }

package/dist/lib/generate-runtime-files-data.js

@@ -1,16 +1,16 @@
-import { importJsonModule } from '@expofp/utils';
+import { importJson } from '@expofp/utils';
 import debug from 'debug';
 const log = debug('efp:offline:generate-runtime-files-data');
 export async function* generateRuntimeFilesData(runtimeBaseUrl) {
     const bundleJsonUrl = new URL('bundle.json', runtimeBaseUrl).href;
-    const bundleJson = await importJsonModule(bundleJsonUrl);
+    const bundleJson = await importJson(bundleJsonUrl);
     log(`Generating runtime files from ${bundleJsonUrl}, ${bundleJson.files.length} files found`);
-    const basePath = './runtime/';
+    const basePath = 'runtime/';
     for (const file of bundleJson.files) {
         yield {
             url: new URL(file.file, runtimeBaseUrl),
             targetFilePath: `${basePath}${file.file}`,
         };
     }
-    return { entry: `${basePath}${bundleJson.entry}` };
+    return { entry: `./${basePath}${bundleJson.entry}` };
 }

package/dist/lib/offlinize-assets-in-place.js

@@ -1,4 +1,4 @@
-import { makeLocalPath, niceFetch } from '@expofp/utils';
+import { fetchWithRetry, makeLocalPath } from '@expofp/utils';
 import debug from 'debug';
 import { offlinizeAssetUrl } from './offlinize-asset-url.js';
 import { offlinizeCssAssetText } from './offlinize-css-asset-text.js';
@@ -66,7 +66,7 @@ export async function offlinizeAssetsInPlace(data, opts) {
                     // Mark as fetched to prevent duplicates
                     log(`Offlinizing $ref: ${refValue} -> ${targetFilePath}${fragment}`);
                     // Fetch and recursively process the referenced document
-                    const response = await niceFetch(urlKey, { signal: opts.signal });
+                    const response = await fetchWithRetry(urlKey, { signal: opts.signal });
                     if (response.ok) {
                         const referencedData = await response.json();
                         processedRefs.set(urlKey, referencedData);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expofp/offline",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0",
   "type": "module",
   "description": "CLI tool for creating offline copies of ExpoFP floor plans",
   "license": "MIT",
@@ -30,9 +30,9 @@
   "dependencies": {
     "debug": "^4.4.3",
     "tslib": "^2.3.0",
-    "@expofp/data": "3.0.0-alpha.8",
-    "@expofp/floorplan": "3.0.0-alpha.8",
-    "@expofp/resolve": "3.0.0-alpha.8",
-    "@expofp/utils": "3.0.0-alpha.8"
+    "@expofp/data": "3.0.0",
+    "@expofp/floorplan": "3.0.0",
+    "@expofp/resolve": "3.0.0",
+    "@expofp/utils": "3.0.0"
   }
 }