@expofp/offline 3.0.0-alpha.10 → 3.0.0-alpha.12

package/README.md

@@ -0,0 +1,79 @@
+# @expofp/offline
+
+CLI and programmatic API for creating offline ZIP archives of ExpoFP floor plans.
+
+## CLI
+
+```bash
+npx expofp-offline <manifest-url> [options]
+```
+
+### Arguments
+
+| Argument       | Description                         |
+| -------------- | ----------------------------------- |
+| `manifest-url` | URL to the floor plan manifest JSON |
+
+### Options
+
+| 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 https://demo.expofp.com/manifest.json -o demo-offline.zip
+```
+
+## Programmatic API
+
+### `buildOfflineZip(manifest, options): Promise<Blob>`
+
+Generates a complete offline ZIP archive as a `Blob`. Works in both browser and Node.js.
+
+```ts
+import { buildOfflineZip } from '@expofp/offline';
+
+const blob = await buildOfflineZip(
+  { $ref: 'https://demo.expofp.com/manifest.json' },
+  { runtimeBaseUrl: 'https://cdn.expofp.com/runtime/' },
+);
+```
+
+### `downloadOfflineZip(manifest, options): Promise<void>`
+
+Builds the ZIP and triggers a browser download. Browser-only.
+
+```ts
+import { downloadOfflineZip } from '@expofp/offline';
+
+await downloadOfflineZip(manifest, {
+  runtimeBaseUrl: 'https://cdn.expofp.com/runtime/',
+});
+```
+
+### `saveOfflineZip(manifest, path, options): Promise<void>`
+
+Builds the ZIP and writes it to disk. Node.js-only.
+
+```ts
+import { saveOfflineZip } from '@expofp/offline';
+
+await saveOfflineZip({ $ref: 'https://demo.expofp.com/manifest.json' }, './offline.zip', {
+  runtimeBaseUrl: 'https://cdn.expofp.com/runtime/',
+});
+```
+
+### Options
+
+```ts
+interface OfflineOptions {
+  /** Base URL of the @expofp/floorplan runtime assets */
+  runtimeBaseUrl: string;
+  /** AbortSignal to cancel the operation */
+  signal?: AbortSignal;
+}
+```

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

@@ -22,7 +22,7 @@ export async function* generateOfflineData(inputManifest, options) {
     // generate index.html
     yield {
         text: getIndexHtml(entry, manifest),
-        targetFilePath: './index.html',
+        targetFilePath: 'index.html',
     };
 }
 /** Build a complete offline ZIP archive from a manifest. */

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.10",
+  "version": "3.0.0-alpha.12",
   "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.10",
-    "@expofp/floorplan": "3.0.0-alpha.10",
-    "@expofp/resolve": "3.0.0-alpha.10",
-    "@expofp/utils": "3.0.0-alpha.10"
+    "@expofp/data": "3.0.0-alpha.12",
+    "@expofp/floorplan": "3.0.0-alpha.12",
+    "@expofp/utils": "3.0.0-alpha.12",
+    "@expofp/resolve": "3.0.0-alpha.12"
   }
 }