walkback-engine 0.2.1

package/index.d.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/** Create a `.undo` directory under `workdir`. */
+export declare function init(workdir: string): void
+/** Mark a checkpoint. Returns its id. */
+export declare function checkpoint(workdir: string, label: string): string
+/**
+ * Capture a path (recursively, if a directory) before the agent changes it.
+ * Returns a newline-joined description of every effect recorded.
+ */
+export declare function track(workdir: string, path: string): string
+/** Record a network mutation with an optional compensating request. */
+export declare function recordHttp(workdir: string, method: string, url: string, compMethod?: string | undefined | null, compUrl?: string | undefined | null, compBody?: string | undefined | null): void
+/** JSON `{ checkpoint, effects }` for what's changed since the last checkpoint. */
+export declare function statusJson(workdir: string): string
+/** JSON array of every journal row, oldest first. */
+export declare function logJson(workdir: string): string
+/**
+ * Rewind everything since `target` (or the latest checkpoint). Returns a JSON
+ * `{ checkpoint, reverted, skipped, failed }` report. If `failed` is non-empty
+ * the journal was left intact and the rollback can be retried.
+ */
+export declare function rollback(workdir: string, target?: string | undefined | null): string
+/** Undo the last rollback. Returns a JSON `{ restored, failed }` report. */
+export declare function redo(workdir: string): string
+/**
+ * Selective undo: reverse just one file. Returns a description, or null if the
+ * path wasn't tracked.
+ */
+export declare function revert(workdir: string, path: string): string | null
+/**
+ * JSON array of `{ path, status, added, removed, hunk }` — a PR-style diff of
+ * everything changed since the last checkpoint.
+ */
+export declare function diffJson(workdir: string): string

package/index.js

@@ -0,0 +1,324 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'walkback-engine.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.android-arm64.node')
+          } else {
+            nativeBinding = require('walkback-engine-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'walkback-engine.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('walkback-engine-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'walkback-engine.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('walkback-engine-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'walkback-engine.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('walkback-engine-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'walkback-engine.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('walkback-engine-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'walkback-engine.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./walkback-engine.darwin-universal.node')
+      } else {
+        nativeBinding = require('walkback-engine-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'walkback-engine.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.darwin-x64.node')
+          } else {
+            nativeBinding = require('walkback-engine-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'walkback-engine.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.darwin-arm64.node')
+          } else {
+            nativeBinding = require('walkback-engine-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'walkback-engine.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./walkback-engine.freebsd-x64.node')
+      } else {
+        nativeBinding = require('walkback-engine-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'walkback-engine.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./walkback-engine.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('walkback-engine-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'walkback-engine.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./walkback-engine.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('walkback-engine-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { init, checkpoint, track, recordHttp, statusJson, logJson, rollback, redo, revert, diffJson } = nativeBinding
+
+module.exports.init = init
+module.exports.checkpoint = checkpoint
+module.exports.track = track
+module.exports.recordHttp = recordHttp
+module.exports.statusJson = statusJson
+module.exports.logJson = logJson
+module.exports.rollback = rollback
+module.exports.redo = redo
+module.exports.revert = revert
+module.exports.diffJson = diffJson

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "walkback-engine",
+  "version": "0.2.1",
+  "description": "NAPI-built native binding to the Rust undo engine.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "license": "MIT",
+  "repository": "https://github.com/tathagat22/walkback",
+  "publishConfig": {
+    "access": "public"
+  },
+  "napi": {
+    "name": "walkback-engine",
+    "triples": {
+      "defaults": true,
+      "additional": [
+        "aarch64-apple-darwin"
+      ]
+    }
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "*.node"
+  ],
+  "scripts": {
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "prepublishOnly": "napi prepublish -t npm --skip-gh-release"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4"
+  },
+  "optionalDependencies": {
+    "walkback-engine-win32-x64-msvc": "0.2.1",
+    "walkback-engine-darwin-x64": "0.2.1",
+    "walkback-engine-linux-x64-gnu": "0.2.1",
+    "walkback-engine-darwin-arm64": "0.2.1"
+  }
+}