@pagepocket/write-down-unit 0.11.1 → 0.13.0

package/dist/write-down-unit.d.ts

@@ -1,4 +1,4 @@
-import { Unit, type CaptureResult, type UnitContext } from "@pagepocket/lib";
+import { Unit, type CaptureResult, type UnitContext, type UnitRuntime } from "@pagepocket/lib";
 export type WriteDownUnitOptions = {
     type: "raw" | "zip";
     outputPath: string;
@@ -11,10 +11,10 @@ export type WriteDownUnitOptions = {
  */
 export declare class WriteDownUnit extends Unit {
     readonly id = "writeDown";
-    readonly kind = "write.down";
+    readonly description = "Writing snapshot to disk";
     private options;
     constructor(options: WriteDownUnitOptions);
-    run(ctx: UnitContext, rt: import("@pagepocket/lib").UnitRuntime): Promise<{
+    run(ctx: UnitContext, rt: UnitRuntime): Promise<{
         __pagepocketResult: CaptureResult;
     }>;
 }

package/dist/write-down-unit.js

@@ -9,7 +9,7 @@ export class WriteDownUnit extends Unit {
     constructor(options) {
         super();
         this.id = "writeDown";
-        this.kind = "write.down";
+        this.description = "Writing snapshot to disk";
         this.options = options;
     }
     async run(ctx, rt) {

package/dist/write-down.d.ts

@@ -1,10 +1,9 @@
-import type { FileTree } from "@pagepocket/lib";
+import type { EntryInfo, FileTree, PagePocketCaptureResult } from "@pagepocket/lib";
 export type WriteDownOptions = {
     type: "raw" | "zip";
     outputPath: string;
     overwrite: boolean;
 };
-type EntryInfo = import("@pagepocket/lib").EntryInfo;
 export declare const writeDown: (input: {
     entry: EntryInfo;
     html: {
@@ -16,5 +15,4 @@ export declare const writeDown: (input: {
     type: WriteDownOptions["type"];
     outputPath: string;
     overwrite: boolean;
-}) => Promise<import("@pagepocket/lib").PagePocketCaptureResult>;
-export {};
+}) => Promise<PagePocketCaptureResult>;

package/dist/write-down.js

@@ -25,21 +25,19 @@ const tryHostname = (url) => {
         return undefined;
     }
 };
-const pathExists = async (p) => {
+const pathExists = async (pathToCheck) => {
     try {
-        await stat(p);
+        await stat(pathToCheck);
         return true;
     }
     catch {
         return false;
     }
 };
-const removeExistingPath = async (p) => {
-    await rm(p, { force: true, recursive: true });
-};
-const isUrlEntry = (entry) => {
-    return entry.kind === "url";
+const removeExistingPath = async (pathToRemove) => {
+    await rm(pathToRemove, { force: true, recursive: true });
 };
+const isUrlEntry = (entry) => entry.kind === "url";
 const withUniquePath = async (desiredPath, options) => {
     if (!(await pathExists(desiredPath))) {
         return desiredPath;
@@ -51,8 +49,8 @@ const withUniquePath = async (desiredPath, options) => {
     const parsed = pathMod.parse(desiredPath);
     const base = pathMod.join(parsed.dir, parsed.name);
     const ext = parsed.ext;
-    for (let i = 2; i <= 9999; i += 1) {
-        const candidate = `${base}-${i}${ext}`;
+    for (let candidateIndex = 2; candidateIndex <= 9999; candidateIndex += 1) {
+        const candidate = `${base}-${candidateIndex}${ext}`;
         if (!(await pathExists(candidate))) {
             return candidate;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagepocket/write-down-unit",
-  "version": "0.11.1",
+  "version": "0.13.0",
   "description": "PagePocket plugin: write snapshot output to fs (raw or zip)",
   "type": "module",
   "main": "dist/index.js",
@@ -11,9 +11,9 @@
   "license": "ISC",
   "dependencies": {
     "fflate": "^0.8.2",
-    "@pagepocket/lib": "0.11.1",
-    "@pagepocket/contracts": "0.11.1",
-    "@pagepocket/uni-fs": "0.11.1"
+    "@pagepocket/lib": "0.13.0",
+    "@pagepocket/contracts": "0.13.0",
+    "@pagepocket/uni-fs": "0.13.0"
   },
   "devDependencies": {
     "@types/node": "^20.17.12",