@justin06lee/subaru 0.1.0

package/dist/web.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/web.ts"],"sourcesContent":["import { createUpdater, webStorage, type Adapter, type Policy, type Release, type Updater } from './core';\nimport { mountCard, type MountCardOptions } from './card';\n\n/**\n * The stamp file `subaru stamp` writes at build time and this adapter polls.\n * Any change to `id` is a new deploy.\n */\nexport interface Stamp {\n  id: string;\n  version?: string;\n  commit?: string;\n  builtAt?: string;\n  notes?: string;\n  url?: string;\n}\n\nexport interface WebAdapterOptions {\n  /** Where the stamp is served. Default \"/subaru.json\". */\n  url?: string;\n  /** Minimum time between polls. Default 5 minutes. */\n  interval?: number;\n  /**\n   * The id of the build the page was loaded with. Defaults to a\n   * <meta name=\"subaru-version\" content=\"...\"> tag when present, otherwise to\n   * whatever the first poll returns.\n   */\n  current?: string;\n  /** Injection points for tests. */\n  fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;\n  reload?: () => void;\n  document?: Document;\n  window?: Window;\n}\n\n/**\n * Updates for a web app: a new deploy is detected by polling a tiny JSON stamp\n * and applied by reloading the page. \"Install and restart\" reloads now;\n * \"apply, take effect later\" reloads the moment the tab is hidden, so a\n * person mid-typing never loses the page under their hands.\n */\nexport function webAdapter(options: WebAdapterOptions = {}): Adapter {\n  const url = options.url ?? '/subaru.json';\n  const doFetch = options.fetch ?? ((input, init) => fetch(input, init));\n  const doc = options.document ?? (typeof document !== 'undefined' ? document : undefined);\n  const win = options.window ?? (typeof window !== 'undefined' ? window : undefined);\n  const reload = options.reload ?? (() => win?.location.reload());\n  let current: string | undefined = options.current ?? metaVersion(doc);\n  let pendingReload = false;\n\n  return {\n    kind: 'web',\n    name: `web:${typeof location !== 'undefined' ? location.host : ''}${url}`,\n    interval: options.interval ?? 5 * 60 * 1000,\n    storage: webStorage(),\n    async check(signal) {\n      const res = await doFetch(url, { cache: 'no-store', signal, headers: { accept: 'application/json' } });\n      if (!res.ok) throw new Error(`${url}: ${res.status}`);\n      const stamp = (await res.json()) as Stamp;\n      if (!stamp || typeof stamp.id !== 'string' || !stamp.id) throw new Error(`${url}: no id`);\n      if (current === undefined) {\n        current = stamp.id;\n        return null;\n      }\n      if (stamp.id === current) return null;\n      const release: Release = { tag: stamp.id };\n      if (stamp.version) release.version = stamp.version;\n      if (stamp.notes) release.notes = stamp.notes;\n      if (stamp.url) release.url = stamp.url;\n      if (stamp.builtAt) release.date = stamp.builtAt;\n      return release;\n    },\n    async install(_release, { relaunch }) {\n      if (relaunch || !doc || doc.visibilityState === 'hidden') {\n        reload();\n        return 'restarting';\n      }\n      if (!pendingReload) {\n        pendingReload = true;\n        const onHide = () => {\n          if (doc.visibilityState === 'hidden') {\n            doc.removeEventListener('visibilitychange', onHide);\n            reload();\n          }\n        };\n        doc.addEventListener('visibilitychange', onHide);\n      }\n      return 'ready';\n    },\n    async restart() {\n      reload();\n    },\n  };\n}\n\nfunction metaVersion(doc: Document | undefined): string | undefined {\n  const content = doc?.querySelector('meta[name=\"subaru-version\"]')?.getAttribute('content');\n  return content || undefined;\n}\n\nexport interface WebAutoOptions extends WebAdapterOptions {\n  policy?: Policy;\n  /** Program name shown on the card. */\n  name?: string;\n  /** false: no card; bring your own UI with updater.subscribe or useUpdater. */\n  ui?: boolean | MountCardOptions;\n  debug?: (message: string) => void;\n}\n\n/**\n * The whole integration in one call: poll the deploy stamp, show the card\n * when a new deploy lands, reload on \"Update now\". Returns the updater for\n * anything more.\n *\n *   import { subaru } from '@justin06lee/subaru/web';\n *   subaru({ name: 'hours' });\n */\nexport function subaru(options: WebAutoOptions = {}): Updater {\n  const updater = createUpdater({ adapter: webAdapter(options), policy: options.policy, debug: options.debug });\n  if (options.ui !== false && typeof document !== 'undefined') {\n    mountCard(updater, { name: options.name, ...(typeof options.ui === 'object' ? options.ui : {}) });\n  }\n  updater.start();\n  return updater;\n}\n"],"mappings":";;;;;;;;;;AAwCO,SAAS,WAAW,UAA6B,CAAC,GAAY;AACnE,QAAM,MAAM,QAAQ,OAAO;AAC3B,QAAM,UAAU,QAAQ,UAAU,CAAC,OAAO,SAAS,MAAM,OAAO,IAAI;AACpE,QAAM,MAAM,QAAQ,aAAa,OAAO,aAAa,cAAc,WAAW;AAC9E,QAAM,MAAM,QAAQ,WAAW,OAAO,WAAW,cAAc,SAAS;AACxE,QAAM,SAAS,QAAQ,WAAW,MAAM,KAAK,SAAS,OAAO;AAC7D,MAAI,UAA8B,QAAQ,WAAW,YAAY,GAAG;AACpE,MAAI,gBAAgB;AAEpB,SAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM,OAAO,OAAO,aAAa,cAAc,SAAS,OAAO,EAAE,GAAG,GAAG;AAAA,IACvE,UAAU,QAAQ,YAAY,IAAI,KAAK;AAAA,IACvC,SAAS,WAAW;AAAA,IACpB,MAAM,MAAM,QAAQ;AAClB,YAAM,MAAM,MAAM,QAAQ,KAAK,EAAE,OAAO,YAAY,QAAQ,SAAS,EAAE,QAAQ,mBAAmB,EAAE,CAAC;AACrG,UAAI,CAAC,IAAI,GAAI,OAAM,IAAI,MAAM,GAAG,GAAG,KAAK,IAAI,MAAM,EAAE;AACpD,YAAM,QAAS,MAAM,IAAI,KAAK;AAC9B,UAAI,CAAC,SAAS,OAAO,MAAM,OAAO,YAAY,CAAC,MAAM,GAAI,OAAM,IAAI,MAAM,GAAG,GAAG,SAAS;AACxF,UAAI,YAAY,QAAW;AACzB,kBAAU,MAAM;AAChB,eAAO;AAAA,MACT;AACA,UAAI,MAAM,OAAO,QAAS,QAAO;AACjC,YAAM,UAAmB,EAAE,KAAK,MAAM,GAAG;AACzC,UAAI,MAAM,QAAS,SAAQ,UAAU,MAAM;AAC3C,UAAI,MAAM,MAAO,SAAQ,QAAQ,MAAM;AACvC,UAAI,MAAM,IAAK,SAAQ,MAAM,MAAM;AACnC,UAAI,MAAM,QAAS,SAAQ,OAAO,MAAM;AACxC,aAAO;AAAA,IACT;AAAA,IACA,MAAM,QAAQ,UAAU,EAAE,SAAS,GAAG;AACpC,UAAI,YAAY,CAAC,OAAO,IAAI,oBAAoB,UAAU;AACxD,eAAO;AACP,eAAO;AAAA,MACT;AACA,UAAI,CAAC,eAAe;AAClB,wBAAgB;AAChB,cAAM,SAAS,MAAM;AACnB,cAAI,IAAI,oBAAoB,UAAU;AACpC,gBAAI,oBAAoB,oBAAoB,MAAM;AAClD,mBAAO;AAAA,UACT;AAAA,QACF;AACA,YAAI,iBAAiB,oBAAoB,MAAM;AAAA,MACjD;AACA,aAAO;AAAA,IACT;AAAA,IACA,MAAM,UAAU;AACd,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEA,SAAS,YAAY,KAA+C;AAClE,QAAM,UAAU,KAAK,cAAc,6BAA6B,GAAG,aAAa,SAAS;AACzF,SAAO,WAAW;AACpB;AAmBO,SAAS,OAAO,UAA0B,CAAC,GAAY;AAC5D,QAAM,UAAU,cAAc,EAAE,SAAS,WAAW,OAAO,GAAG,QAAQ,QAAQ,QAAQ,OAAO,QAAQ,MAAM,CAAC;AAC5G,MAAI,QAAQ,OAAO,SAAS,OAAO,aAAa,aAAa;AAC3D,cAAU,SAAS,EAAE,MAAM,QAAQ,MAAM,GAAI,OAAO,QAAQ,OAAO,WAAW,QAAQ,KAAK,CAAC,EAAG,CAAC;AAAA,EAClG;AACA,UAAQ,MAAM;AACd,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,120 @@
+{
+  "name": "@justin06lee/subaru",
+  "version": "0.1.0",
+  "description": "One update flow for web apps, Tauri and Electron desktop apps: check in the background, then ask, tell, or just do it.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Justin Lee <tenet.sh@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/justin06lee/subaru.git",
+    "directory": "js"
+  },
+  "keywords": [
+    "update",
+    "updater",
+    "self-update",
+    "auto-update",
+    "tauri",
+    "electron",
+    "web",
+    "react",
+    "github-releases",
+    "source",
+    "make"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "subaru": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./web": {
+      "types": "./dist/web.d.ts",
+      "import": "./dist/web.js"
+    },
+    "./source": {
+      "types": "./dist/source.d.ts",
+      "import": "./dist/source.js"
+    },
+    "./tauri": {
+      "types": "./dist/tauri.d.ts",
+      "import": "./dist/tauri.js"
+    },
+    "./electron": {
+      "types": "./dist/electron.d.ts",
+      "import": "./dist/electron.js"
+    },
+    "./electron/renderer": {
+      "types": "./dist/electron-renderer.d.ts",
+      "import": "./dist/electron-renderer.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "bun test",
+    "demo": "bun run demo/server.ts",
+    "prepublishOnly": "bun run typecheck && bun test && bun run build"
+  },
+  "peerDependencies": {
+    "@tauri-apps/plugin-process": ">=2",
+    "@tauri-apps/plugin-shell": ">=2",
+    "@tauri-apps/plugin-updater": ">=2",
+    "electron": ">=28",
+    "electron-updater": ">=6",
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "@tauri-apps/plugin-process": {
+      "optional": true
+    },
+    "@tauri-apps/plugin-shell": {
+      "optional": true
+    },
+    "@tauri-apps/plugin-updater": {
+      "optional": true
+    },
+    "electron": {
+      "optional": true
+    },
+    "electron-updater": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@happy-dom/global-registrator": "^20.14.0",
+    "@tauri-apps/plugin-process": "^2.3.1",
+    "@tauri-apps/plugin-shell": "^2.3.6",
+    "@tauri-apps/plugin-updater": "^2.11.0",
+    "@types/bun": "^1.4.1",
+    "@types/react": "^19.2.18",
+    "@types/react-dom": "^19.2.7",
+    "electron": "^44.2.0",
+    "electron-updater": "^6.8.9",
+    "happy-dom": "^20.14.0",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3"
+  }
+}