ropegeo-common 1.20.0 → 1.20.1

package/dist/models/previews/offlinePagePreview.d.ts

@@ -1,8 +1,16 @@
 import { PagePreview } from './pagePreview';
+import { DownloadJob } from '../../download/downloadJob';
+import type { DownloadJobConfig } from '../../download/types';
 export declare class OfflinePagePreview extends PagePreview {
     readonly fetchType: "offline";
     downloadedImagePath: string | null;
     constructor(id: string, source: import('../pageDataSource').PageDataSource, downloadedImagePath: string | null, rating: number | null, ratingCount: number | null, title: string, regions: string[], aka: string[], difficultyRating: import('../difficulty/difficultyRating').DifficultyRating, mapData: string | null, externalLink: string | null, permit: import('../permitStatus').PermitStatus | null);
+    /**
+     * Re-downloads the page bundle by id/source (fetch-page-json path). Offline previews carry no
+     * `downloadFolder`, so this always uses the page-JSON fetch phase. Enables re-downloading a saved
+     * page whose bundle was removed (its preview stays offline while `downloadedPageViewPath` is null).
+     */
+    toDownloadJob(config: DownloadJobConfig): DownloadJob;
     static fromResult(result: unknown): OfflinePagePreview;
 }
 //# sourceMappingURL=offlinePagePreview.d.ts.map

package/dist/models/previews/offlinePagePreview.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"offlinePagePreview.d.ts","sourceRoot":"","sources":["../../../src/models/previews/offlinePagePreview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA6B,MAAM,eAAe,CAAC;AAEvE,qBAAa,kBAAmB,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAG,SAAS,CAAU;IACxC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;gBAG/B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,OAAO,mBAAmB,EAAE,cAAc,EAClD,mBAAmB,EAAE,MAAM,GAAG,IAAI,EAClC,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EAAE,EACjB,GAAG,EAAE,MAAM,EAAE,EACb,gBAAgB,EAAE,OAAO,gCAAgC,EAAE,gBAAgB,EAC3E,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,MAAM,EAAE,OAAO,iBAAiB,EAAE,YAAY,GAAG,IAAI;IAkBzD,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,kBAAkB;CAUzD"}
+{"version":3,"file":"offlinePagePreview.d.ts","sourceRoot":"","sources":["../../../src/models/previews/offlinePagePreview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA6B,MAAM,eAAe,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAS9D,qBAAa,kBAAmB,SAAQ,WAAW;IAC/C,QAAQ,CAAC,SAAS,EAAG,SAAS,CAAU;IACxC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;gBAG/B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,OAAO,mBAAmB,EAAE,cAAc,EAClD,mBAAmB,EAAE,MAAM,GAAG,IAAI,EAClC,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EAAE,EACjB,GAAG,EAAE,MAAM,EAAE,EACb,gBAAgB,EAAE,OAAO,gCAAgC,EAAE,gBAAgB,EAC3E,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,YAAY,EAAE,MAAM,GAAG,IAAI,EAC3B,MAAM,EAAE,OAAO,iBAAiB,EAAE,YAAY,GAAG,IAAI;IAkBzD;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW;IAyBrD,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,kBAAkB;CAUzD"}

package/dist/models/previews/offlinePagePreview.js

@@ -2,12 +2,47 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OfflinePagePreview = void 0;
 const pagePreview_1 = require("./pagePreview");
+const downloadJob_1 = require("../../download/downloadJob");
+const downloadPhase_1 = require("../../download/downloadPhase");
+const downloadPhaseTitles_1 = require("../../download/helpers/downloadPhaseTitles");
+const downloadDependencyKeys_1 = require("../../download/dependencies/downloadDependencyKeys");
+const fetchPageJsonTaskDependency_1 = require("../../download/dependencies/fetchPageJsonTaskDependency");
+const fetchPageJsonTask_1 = require("../../download/tasks/fetchPageJsonTask");
+const pageDataSource_1 = require("../pageDataSource");
+const pageViewType_1 = require("../pageViews/pageViewType");
 class OfflinePagePreview extends pagePreview_1.PagePreview {
     constructor(id, source, downloadedImagePath, rating, ratingCount, title, regions, aka, difficultyRating, mapData, externalLink, permit) {
         super(id, source, rating, ratingCount, title, regions, aka, difficultyRating, mapData, externalLink, permit);
         this.fetchType = 'offline';
         this.downloadedImagePath = downloadedImagePath;
     }
+    /**
+     * Re-downloads the page bundle by id/source (fetch-page-json path). Offline previews carry no
+     * `downloadFolder`, so this always uses the page-JSON fetch phase. Enables re-downloading a saved
+     * page whose bundle was removed (its preview stays offline while `downloadedPageViewPath` is null).
+     */
+    toDownloadJob(config) {
+        const pageViewType = this.source === pageDataSource_1.PageDataSource.Ropewiki
+            ? pageViewType_1.PageViewType.Ropewiki
+            : null;
+        if (pageViewType == null) {
+            throw new Error(`Unsupported page preview source "${String(this.source)}"`);
+        }
+        const fetchPageTask = new fetchPageJsonTask_1.FetchPageJsonTask();
+        const fetchPagePhase = new downloadPhase_1.DownloadPhase({
+            title: (0, downloadPhaseTitles_1.titleForPhase)([fetchPageTask]),
+            tasks: [fetchPageTask],
+        });
+        return new downloadJob_1.DownloadJob({
+            pageId: this.id,
+            pageViewType,
+            config,
+            phases: [(0, downloadPhaseTitles_1.buildDeleteStoredPagePhase)(), fetchPagePhase],
+            taskDependencies: {
+                [downloadDependencyKeys_1.DownloadDependencyKeys.FetchPageJson]: fetchPageJsonTaskDependency_1.FetchPageJsonTaskDependency.fromPreview(this, config),
+            },
+        });
+    }
     static fromResult(result) {
         if (result == null || typeof result !== 'object') {
             throw new Error('OfflinePagePreview result must be an object');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ropegeo-common",
-    "version": "1.20.0",
+    "version": "1.20.1",
     "description": "Shared domain models and helpers for RopeGeo and WebScraper",
     "license": "ISC",
     "repository": {