@nitpicker/crawler 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (387) hide show
  1. package/README.md +6 -4
  2. package/lib/archive/archive-accessor.d.ts +2 -2
  3. package/lib/archive/archive-accessor.js +2 -2
  4. package/lib/archive/archive-lock.d.ts +7 -0
  5. package/lib/archive/archive-lock.js +7 -0
  6. package/lib/archive/archive.d.ts +175 -13
  7. package/lib/archive/archive.js +198 -14
  8. package/lib/archive/cache/compute-archive-cache-key.d.ts +39 -0
  9. package/lib/archive/cache/compute-archive-cache-key.js +95 -0
  10. package/lib/archive/cache/extract-archive-to-cache.d.ts +43 -0
  11. package/lib/archive/cache/extract-archive-to-cache.js +309 -0
  12. package/lib/archive/cache/get-archive-cache-root.d.ts +20 -0
  13. package/lib/archive/cache/get-archive-cache-root.js +53 -0
  14. package/lib/archive/cache/is-archive-cache-disabled.d.ts +24 -0
  15. package/lib/archive/cache/is-archive-cache-disabled.js +34 -0
  16. package/lib/archive/cache/resolve-archive-cache-dir.d.ts +26 -0
  17. package/lib/archive/cache/resolve-archive-cache-dir.js +32 -0
  18. package/lib/archive/create-adjunct-tables.d.ts +43 -0
  19. package/lib/archive/create-adjunct-tables.js +213 -0
  20. package/lib/archive/create-entity-tables.d.ts +173 -0
  21. package/lib/archive/create-entity-tables.js +318 -0
  22. package/lib/archive/create-progress-reporter.d.ts +30 -0
  23. package/lib/archive/create-progress-reporter.js +38 -0
  24. package/lib/archive/create-ref-tables.d.ts +35 -0
  25. package/lib/archive/create-ref-tables.js +188 -0
  26. package/lib/archive/database.d.ts +130 -182
  27. package/lib/archive/database.js +524 -1777
  28. package/lib/archive/db-ops/_shared/clear-write-ref-caches.d.ts +27 -0
  29. package/lib/archive/db-ops/_shared/clear-write-ref-caches.js +34 -0
  30. package/lib/archive/db-ops/_shared/create-write-ref-caches.d.ts +17 -0
  31. package/lib/archive/db-ops/_shared/create-write-ref-caches.js +26 -0
  32. package/lib/archive/db-ops/_shared/decode-json-ref.d.ts +17 -0
  33. package/lib/archive/db-ops/_shared/decode-json-ref.js +31 -0
  34. package/lib/archive/db-ops/_shared/load-response-headers-by-set-ids.d.ts +20 -0
  35. package/lib/archive/db-ops/_shared/load-response-headers-by-set-ids.js +53 -0
  36. package/lib/archive/db-ops/_shared/resolve-content-item-id.d.ts +61 -0
  37. package/lib/archive/db-ops/_shared/resolve-content-item-id.js +111 -0
  38. package/lib/archive/db-ops/_shared/resolve-url-or-blob.d.ts +23 -0
  39. package/lib/archive/db-ops/_shared/resolve-url-or-blob.js +29 -0
  40. package/lib/archive/db-ops/_shared/retry-setting.d.ts +16 -0
  41. package/lib/archive/db-ops/_shared/retry-setting.js +18 -0
  42. package/lib/archive/db-ops/_shared/safe-parse-json.d.ts +11 -0
  43. package/lib/archive/db-ops/_shared/safe-parse-json.js +18 -0
  44. package/lib/archive/db-ops/_shared/types.d.ts +53 -0
  45. package/lib/archive/db-ops/_shared/types.js +1 -0
  46. package/lib/archive/db-ops/_shared/upsert-blob-ref.d.ts +25 -0
  47. package/lib/archive/db-ops/_shared/upsert-blob-ref.js +48 -0
  48. package/lib/archive/db-ops/_shared/upsert-content-type-ref.d.ts +30 -0
  49. package/lib/archive/db-ops/_shared/upsert-content-type-ref.js +45 -0
  50. package/lib/archive/db-ops/_shared/upsert-json-ref.d.ts +22 -0
  51. package/lib/archive/db-ops/_shared/upsert-json-ref.js +41 -0
  52. package/lib/archive/db-ops/_shared/upsert-response-headers.d.ts +35 -0
  53. package/lib/archive/db-ops/_shared/upsert-response-headers.js +49 -0
  54. package/lib/archive/db-ops/_shared/upsert-url-ref.d.ts +39 -0
  55. package/lib/archive/db-ops/_shared/upsert-url-ref.js +62 -0
  56. package/lib/archive/db-ops/analysis/replace-analysis-violations.d.ts +28 -0
  57. package/lib/archive/db-ops/analysis/replace-analysis-violations.js +152 -0
  58. package/lib/archive/db-ops/anchors/get-anchors-on-page.d.ts +10 -0
  59. package/lib/archive/db-ops/anchors/get-anchors-on-page.js +21 -0
  60. package/lib/archive/db-ops/config/get-base-url.d.ts +8 -0
  61. package/lib/archive/db-ops/config/get-base-url.js +14 -0
  62. package/lib/archive/db-ops/config/get-config.d.ts +10 -0
  63. package/lib/archive/db-ops/config/get-config.js +27 -0
  64. package/lib/archive/db-ops/config/get-name.d.ts +8 -0
  65. package/lib/archive/db-ops/config/get-name.js +14 -0
  66. package/lib/archive/db-ops/config/info-column-allowlist.d.ts +7 -0
  67. package/lib/archive/db-ops/config/info-column-allowlist.js +26 -0
  68. package/lib/archive/db-ops/config/info-json-columns.d.ts +5 -0
  69. package/lib/archive/db-ops/config/info-json-columns.js +10 -0
  70. package/lib/archive/db-ops/config/set-config.d.ts +12 -0
  71. package/lib/archive/db-ops/config/set-config.js +21 -0
  72. package/lib/archive/db-ops/config/update-config.d.ts +17 -0
  73. package/lib/archive/db-ops/config/update-config.js +36 -0
  74. package/lib/archive/db-ops/errors/insert-crawl-error.d.ts +15 -0
  75. package/lib/archive/db-ops/errors/insert-crawl-error.js +21 -0
  76. package/lib/archive/db-ops/errors/insert-page-error.d.ts +21 -0
  77. package/lib/archive/db-ops/errors/insert-page-error.js +28 -0
  78. package/lib/archive/db-ops/errors/list-dns-burned-host-candidates.d.ts +22 -0
  79. package/lib/archive/db-ops/errors/list-dns-burned-host-candidates.js +141 -0
  80. package/lib/archive/db-ops/html/get-html-of-page-by-id.d.ts +18 -0
  81. package/lib/archive/db-ops/html/get-html-of-page-by-id.js +29 -0
  82. package/lib/archive/db-ops/inventory/record-inventory-run.d.ts +21 -0
  83. package/lib/archive/db-ops/inventory/record-inventory-run.js +38 -0
  84. package/lib/archive/db-ops/lifecycle/checkpoint.d.ts +8 -0
  85. package/lib/archive/db-ops/lifecycle/checkpoint.js +9 -0
  86. package/lib/archive/db-ops/lifecycle/destroy.d.ts +6 -0
  87. package/lib/archive/db-ops/lifecycle/destroy.js +7 -0
  88. package/lib/archive/db-ops/lifecycle/init.d.ts +22 -0
  89. package/lib/archive/db-ops/lifecycle/init.js +42 -0
  90. package/lib/archive/db-ops/meta/get-jsonld-of-page.d.ts +13 -0
  91. package/lib/archive/db-ops/meta/get-jsonld-of-page.js +27 -0
  92. package/lib/archive/db-ops/meta/get-tags-of-page.d.ts +12 -0
  93. package/lib/archive/db-ops/meta/get-tags-of-page.js +28 -0
  94. package/lib/archive/db-ops/pages/order/set-url-order.d.ts +8 -0
  95. package/lib/archive/db-ops/pages/order/set-url-order.js +32 -0
  96. package/lib/archive/db-ops/pages/read/build-page-query.d.ts +18 -0
  97. package/lib/archive/db-ops/pages/read/build-page-query.js +40 -0
  98. package/lib/archive/db-ops/pages/read/get-crawling-state.d.ts +70 -0
  99. package/lib/archive/db-ops/pages/read/get-crawling-state.js +98 -0
  100. package/lib/archive/db-ops/pages/read/get-existing-page-urls.d.ts +15 -0
  101. package/lib/archive/db-ops/pages/read/get-existing-page-urls.js +30 -0
  102. package/lib/archive/db-ops/pages/read/get-page-count.d.ts +12 -0
  103. package/lib/archive/db-ops/pages/read/get-page-count.js +21 -0
  104. package/lib/archive/db-ops/pages/read/get-page-source-by-url.d.ts +24 -0
  105. package/lib/archive/db-ops/pages/read/get-page-source-by-url.js +28 -0
  106. package/lib/archive/db-ops/pages/read/get-pages-with-rels.d.ts +38 -0
  107. package/lib/archive/db-ops/pages/read/get-pages-with-rels.js +107 -0
  108. package/lib/archive/db-ops/pages/read/get-pages.d.ts +11 -0
  109. package/lib/archive/db-ops/pages/read/get-pages.js +51 -0
  110. package/lib/archive/db-ops/pages/read/get-scraped-html-page-count.d.ts +18 -0
  111. package/lib/archive/db-ops/pages/read/get-scraped-html-page-count.js +25 -0
  112. package/lib/archive/db-ops/pages/read/reconstruct-page-rows.d.ts +31 -0
  113. package/lib/archive/db-ops/pages/read/reconstruct-page-rows.js +32 -0
  114. package/lib/archive/db-ops/pages/reset/repromote-external-pages.d.ts +24 -0
  115. package/lib/archive/db-ops/pages/reset/repromote-external-pages.js +93 -0
  116. package/lib/archive/db-ops/pages/reset/reset-failed-pages.d.ts +47 -0
  117. package/lib/archive/db-ops/pages/reset/reset-failed-pages.js +124 -0
  118. package/lib/archive/db-ops/pages/write/insert-inventory-seeds.d.ts +37 -0
  119. package/lib/archive/db-ops/pages/write/insert-inventory-seeds.js +72 -0
  120. package/lib/archive/db-ops/pages/write/insert-jsonld.d.ts +17 -0
  121. package/lib/archive/db-ops/pages/write/insert-jsonld.js +49 -0
  122. package/lib/archive/db-ops/pages/write/insert-page.d.ts +36 -0
  123. package/lib/archive/db-ops/pages/write/insert-page.js +208 -0
  124. package/lib/archive/db-ops/pages/write/insert-tags.d.ts +16 -0
  125. package/lib/archive/db-ops/pages/write/insert-tags.js +34 -0
  126. package/lib/archive/db-ops/pages/write/link-redirect-sources.d.ts +36 -0
  127. package/lib/archive/db-ops/pages/write/link-redirect-sources.js +93 -0
  128. package/lib/archive/db-ops/pages/write/record-redirect.d.ts +35 -0
  129. package/lib/archive/db-ops/pages/write/record-redirect.js +100 -0
  130. package/lib/archive/db-ops/pages/write/set-skipped-page.d.ts +13 -0
  131. package/lib/archive/db-ops/pages/write/set-skipped-page.js +22 -0
  132. package/lib/archive/db-ops/pages/write/update-page.d.ts +29 -0
  133. package/lib/archive/db-ops/pages/write/update-page.js +334 -0
  134. package/lib/archive/db-ops/pages/write/write-page-html-blob.d.ts +19 -0
  135. package/lib/archive/db-ops/pages/write/write-page-html-blob.js +41 -0
  136. package/lib/archive/db-ops/referrers/get-redirects-for-pages.d.ts +9 -0
  137. package/lib/archive/db-ops/referrers/get-redirects-for-pages.js +15 -0
  138. package/lib/archive/db-ops/referrers/get-referrers-of-page.d.ts +17 -0
  139. package/lib/archive/db-ops/referrers/get-referrers-of-page.js +32 -0
  140. package/lib/archive/db-ops/referrers/get-referrers-of-resource.d.ts +8 -0
  141. package/lib/archive/db-ops/referrers/get-referrers-of-resource.js +15 -0
  142. package/lib/archive/db-ops/resources/build-resource-query.d.ts +25 -0
  143. package/lib/archive/db-ops/resources/build-resource-query.js +29 -0
  144. package/lib/archive/db-ops/resources/get-existing-resource-urls.d.ts +9 -0
  145. package/lib/archive/db-ops/resources/get-existing-resource-urls.js +24 -0
  146. package/lib/archive/db-ops/resources/get-resource-by-url.d.ts +13 -0
  147. package/lib/archive/db-ops/resources/get-resource-by-url.js +22 -0
  148. package/lib/archive/db-ops/resources/get-resource-url-list.d.ts +9 -0
  149. package/lib/archive/db-ops/resources/get-resource-url-list.js +13 -0
  150. package/lib/archive/db-ops/resources/get-resources.d.ts +8 -0
  151. package/lib/archive/db-ops/resources/get-resources.js +11 -0
  152. package/lib/archive/db-ops/resources/insert-inventory-resources.d.ts +24 -0
  153. package/lib/archive/db-ops/resources/insert-inventory-resources.js +64 -0
  154. package/lib/archive/db-ops/resources/insert-resource-referrers.d.ts +15 -0
  155. package/lib/archive/db-ops/resources/insert-resource-referrers.js +54 -0
  156. package/lib/archive/db-ops/resources/insert-resource.d.ts +34 -0
  157. package/lib/archive/db-ops/resources/insert-resource.js +73 -0
  158. package/lib/archive/db-ops/resources/reconstruct-resource-rows.d.ts +26 -0
  159. package/lib/archive/db-ops/resources/reconstruct-resource-rows.js +30 -0
  160. package/lib/archive/decode-html-blob.d.ts +18 -0
  161. package/lib/archive/decode-html-blob.js +31 -0
  162. package/lib/archive/derive-lineage-from-parent.d.ts +37 -0
  163. package/lib/archive/derive-lineage-from-parent.js +42 -0
  164. package/lib/archive/drop-legacy-tables.d.ts +45 -0
  165. package/lib/archive/drop-legacy-tables.js +56 -0
  166. package/lib/archive/filesystem/rename.js +1 -1
  167. package/lib/archive/get-failed-page-messages.d.ts +44 -0
  168. package/lib/archive/get-failed-page-messages.js +132 -0
  169. package/lib/archive/init-schema.d.ts +35 -39
  170. package/lib/archive/init-schema.js +111 -320
  171. package/lib/archive/is-inventory-source.d.ts +21 -0
  172. package/lib/archive/is-inventory-source.js +22 -0
  173. package/lib/archive/limited-page-ids.d.ts +2 -1
  174. package/lib/archive/limited-page-ids.js +5 -4
  175. package/lib/archive/meta/assert-compatible-version.d.ts +24 -3
  176. package/lib/archive/meta/assert-compatible-version.js +24 -3
  177. package/lib/archive/meta/types.d.ts +87 -1
  178. package/lib/archive/meta/types.js +34 -2
  179. package/lib/archive/migrate-entity-tables.d.ts +45 -0
  180. package/lib/archive/migrate-entity-tables.js +56 -0
  181. package/lib/archive/migrate-ref-tables.d.ts +25 -0
  182. package/lib/archive/migrate-ref-tables.js +38 -0
  183. package/lib/archive/page-meta-column-maps.d.ts +32 -0
  184. package/lib/archive/page-meta-column-maps.js +43 -0
  185. package/lib/archive/page.d.ts +6 -6
  186. package/lib/archive/page.js +5 -5
  187. package/lib/archive/peek-archive-lock.d.ts +2 -2
  188. package/lib/archive/peek-archive-lock.js +2 -2
  189. package/lib/archive/populate-entity-tables/collapse-anchor-rows.d.ts +41 -0
  190. package/lib/archive/populate-entity-tables/collapse-anchor-rows.js +87 -0
  191. package/lib/archive/populate-entity-tables/derive-dom-path.d.ts +35 -0
  192. package/lib/archive/populate-entity-tables/derive-dom-path.js +72 -0
  193. package/lib/archive/populate-entity-tables/is-blob-ref-value.d.ts +16 -0
  194. package/lib/archive/populate-entity-tables/is-blob-ref-value.js +19 -0
  195. package/lib/archive/populate-entity-tables/match-images-to-dom-paths.d.ts +66 -0
  196. package/lib/archive/populate-entity-tables/match-images-to-dom-paths.js +96 -0
  197. package/lib/archive/populate-entity-tables/populate-anchor-edges.d.ts +33 -0
  198. package/lib/archive/populate-entity-tables/populate-anchor-edges.js +153 -0
  199. package/lib/archive/populate-entity-tables/populate-content-items.d.ts +40 -0
  200. package/lib/archive/populate-entity-tables/populate-content-items.js +141 -0
  201. package/lib/archive/populate-entity-tables/populate-entities.d.ts +81 -0
  202. package/lib/archive/populate-entity-tables/populate-entities.js +111 -0
  203. package/lib/archive/populate-entity-tables/populate-image-items.d.ts +91 -0
  204. package/lib/archive/populate-entity-tables/populate-image-items.js +223 -0
  205. package/lib/archive/populate-entity-tables/populate-page-meta.d.ts +33 -0
  206. package/lib/archive/populate-entity-tables/populate-page-meta.js +267 -0
  207. package/lib/archive/populate-entity-tables/populate-resource-items.d.ts +22 -0
  208. package/lib/archive/populate-entity-tables/populate-resource-items.js +114 -0
  209. package/lib/archive/populate-entity-tables/populate-resource-ref-edges.d.ts +31 -0
  210. package/lib/archive/populate-entity-tables/populate-resource-ref-edges.js +33 -0
  211. package/lib/archive/populate-entity-tables/resolve-blob-refs.d.ts +31 -0
  212. package/lib/archive/populate-entity-tables/resolve-blob-refs.js +100 -0
  213. package/lib/archive/populate-entity-tables/resolve-content-type-refs.d.ts +22 -0
  214. package/lib/archive/populate-entity-tables/resolve-content-type-refs.js +27 -0
  215. package/lib/archive/populate-entity-tables/resolve-header-sets.d.ts +49 -0
  216. package/lib/archive/populate-entity-tables/resolve-header-sets.js +122 -0
  217. package/lib/archive/populate-entity-tables/resolve-json-refs.d.ts +25 -0
  218. package/lib/archive/populate-entity-tables/resolve-json-refs.js +67 -0
  219. package/lib/archive/populate-entity-tables/resolve-text-refs.d.ts +30 -0
  220. package/lib/archive/populate-entity-tables/resolve-text-refs.js +61 -0
  221. package/lib/archive/populate-entity-tables/resolve-url-or-blob-from-maps.d.ts +21 -0
  222. package/lib/archive/populate-entity-tables/resolve-url-or-blob-from-maps.js +27 -0
  223. package/lib/archive/populate-entity-tables/resolve-url-refs.d.ts +33 -0
  224. package/lib/archive/populate-entity-tables/resolve-url-refs.js +60 -0
  225. package/lib/archive/populate-entity-tables/test-utils/count-rows.d.ts +17 -0
  226. package/lib/archive/populate-entity-tables/test-utils/count-rows.js +20 -0
  227. package/lib/archive/populate-entity-tables/test-utils/seed-content-items.d.ts +25 -0
  228. package/lib/archive/populate-entity-tables/test-utils/seed-content-items.js +42 -0
  229. package/lib/archive/populate-entity-tables/test-utils/setup-entities-db.d.ts +23 -0
  230. package/lib/archive/populate-entity-tables/test-utils/setup-entities-db.js +178 -0
  231. package/lib/archive/populate-entity-tables/types.d.ts +157 -0
  232. package/lib/archive/populate-entity-tables/types.js +12 -0
  233. package/lib/archive/populate-entity-tables/upsert-text-refs.d.ts +38 -0
  234. package/lib/archive/populate-entity-tables/upsert-text-refs.js +78 -0
  235. package/lib/archive/populate-ref-tables/classify-content-type.d.ts +16 -0
  236. package/lib/archive/populate-ref-tables/classify-content-type.js +52 -0
  237. package/lib/archive/populate-ref-tables/compute-content-hash.d.ts +22 -0
  238. package/lib/archive/populate-ref-tables/compute-content-hash.js +26 -0
  239. package/lib/archive/populate-ref-tables/compute-header-flags.d.ts +16 -0
  240. package/lib/archive/populate-ref-tables/compute-header-flags.js +70 -0
  241. package/lib/archive/populate-ref-tables/content-type-rules.d.ts +38 -0
  242. package/lib/archive/populate-ref-tables/content-type-rules.js +133 -0
  243. package/lib/archive/populate-ref-tables/create-header-table-caches.d.ts +25 -0
  244. package/lib/archive/populate-ref-tables/create-header-table-caches.js +49 -0
  245. package/lib/archive/populate-ref-tables/data-uri-url-refs-limit.d.ts +15 -0
  246. package/lib/archive/populate-ref-tables/data-uri-url-refs-limit.js +15 -0
  247. package/lib/archive/populate-ref-tables/decode-data-uri.d.ts +21 -0
  248. package/lib/archive/populate-ref-tables/decode-data-uri.js +126 -0
  249. package/lib/archive/populate-ref-tables/decompose-header-set.d.ts +29 -0
  250. package/lib/archive/populate-ref-tables/decompose-header-set.js +157 -0
  251. package/lib/archive/populate-ref-tables/decompose-url.d.ts +25 -0
  252. package/lib/archive/populate-ref-tables/decompose-url.js +70 -0
  253. package/lib/archive/populate-ref-tables/header-stability.d.ts +19 -0
  254. package/lib/archive/populate-ref-tables/header-stability.js +22 -0
  255. package/lib/archive/populate-ref-tables/header-value-cache-key.d.ts +17 -0
  256. package/lib/archive/populate-ref-tables/header-value-cache-key.js +19 -0
  257. package/lib/archive/populate-ref-tables/normalize-mime.d.ts +24 -0
  258. package/lib/archive/populate-ref-tables/normalize-mime.js +36 -0
  259. package/lib/archive/populate-ref-tables/populate-blob-refs.d.ts +38 -0
  260. package/lib/archive/populate-ref-tables/populate-blob-refs.js +134 -0
  261. package/lib/archive/populate-ref-tables/populate-content-type-refs.d.ts +27 -0
  262. package/lib/archive/populate-ref-tables/populate-content-type-refs.js +70 -0
  263. package/lib/archive/populate-ref-tables/populate-header-tables.d.ts +35 -0
  264. package/lib/archive/populate-ref-tables/populate-header-tables.js +80 -0
  265. package/lib/archive/populate-ref-tables/populate-json-refs.d.ts +29 -0
  266. package/lib/archive/populate-ref-tables/populate-json-refs.js +101 -0
  267. package/lib/archive/populate-ref-tables/populate-refs.d.ts +51 -0
  268. package/lib/archive/populate-ref-tables/populate-refs.js +62 -0
  269. package/lib/archive/populate-ref-tables/populate-text-refs.d.ts +32 -0
  270. package/lib/archive/populate-ref-tables/populate-text-refs.js +133 -0
  271. package/lib/archive/populate-ref-tables/populate-url-refs.d.ts +28 -0
  272. package/lib/archive/populate-ref-tables/populate-url-refs.js +148 -0
  273. package/lib/archive/populate-ref-tables/test-utils/count-rows.d.ts +15 -0
  274. package/lib/archive/populate-ref-tables/test-utils/count-rows.js +17 -0
  275. package/lib/archive/populate-ref-tables/types.d.ts +197 -0
  276. package/lib/archive/populate-ref-tables/types.js +7 -0
  277. package/lib/archive/populate-ref-tables/upsert-one-header-set.d.ts +34 -0
  278. package/lib/archive/populate-ref-tables/upsert-one-header-set.js +208 -0
  279. package/lib/archive/populate-ref-tables/volatile-header-names.d.ts +20 -0
  280. package/lib/archive/populate-ref-tables/volatile-header-names.js +33 -0
  281. package/lib/archive/redirect-table.d.ts +4 -2
  282. package/lib/archive/redirect-table.js +15 -10
  283. package/lib/archive/resolve-redirect-chain.d.ts +3 -3
  284. package/lib/archive/resolve-redirect-chain.js +2 -2
  285. package/lib/archive/resource.d.ts +1 -1
  286. package/lib/archive/retarget-legacy-fk-tables.d.ts +47 -0
  287. package/lib/archive/retarget-legacy-fk-tables.js +107 -0
  288. package/lib/archive/test-utils/fk-parent-tables.d.ts +15 -0
  289. package/lib/archive/test-utils/fk-parent-tables.js +19 -0
  290. package/lib/archive/test-utils/seed-content-item.d.ts +35 -0
  291. package/lib/archive/test-utils/seed-content-item.js +42 -0
  292. package/lib/archive/test-utils/setup-legacy-fk-db.d.ts +33 -0
  293. package/lib/archive/test-utils/setup-legacy-fk-db.js +270 -0
  294. package/lib/archive/types.d.ts +151 -15
  295. package/lib/archive/verify-migration/capture-rejection.d.ts +24 -0
  296. package/lib/archive/verify-migration/capture-rejection.js +31 -0
  297. package/lib/archive/verify-migration/check-anchor-edges-count.d.ts +34 -0
  298. package/lib/archive/verify-migration/check-anchor-edges-count.js +72 -0
  299. package/lib/archive/verify-migration/check-anchor-edges-sum.d.ts +13 -0
  300. package/lib/archive/verify-migration/check-anchor-edges-sum.js +27 -0
  301. package/lib/archive/verify-migration/check-content-items-count.d.ts +16 -0
  302. package/lib/archive/verify-migration/check-content-items-count.js +30 -0
  303. package/lib/archive/verify-migration/check-content-type-preservation.d.ts +22 -0
  304. package/lib/archive/verify-migration/check-content-type-preservation.js +40 -0
  305. package/lib/archive/verify-migration/check-foreign-key-integrity.d.ts +31 -0
  306. package/lib/archive/verify-migration/check-foreign-key-integrity.js +47 -0
  307. package/lib/archive/verify-migration/check-image-items-count.d.ts +12 -0
  308. package/lib/archive/verify-migration/check-image-items-count.js +26 -0
  309. package/lib/archive/verify-migration/check-page-meta-count.d.ts +15 -0
  310. package/lib/archive/verify-migration/check-page-meta-count.js +31 -0
  311. package/lib/archive/verify-migration/check-reader-parity.d.ts +23 -0
  312. package/lib/archive/verify-migration/check-reader-parity.js +211 -0
  313. package/lib/archive/verify-migration/check-resource-items-count.d.ts +17 -0
  314. package/lib/archive/verify-migration/check-resource-items-count.js +33 -0
  315. package/lib/archive/verify-migration/check-url-round-trip.d.ts +43 -0
  316. package/lib/archive/verify-migration/check-url-round-trip.js +112 -0
  317. package/lib/archive/verify-migration/types.d.ts +70 -0
  318. package/lib/archive/verify-migration/types.js +63 -0
  319. package/lib/archive/verify-migration/verify-migration.d.ts +41 -0
  320. package/lib/archive/verify-migration/verify-migration.js +120 -0
  321. package/lib/classify-error-kind.d.ts +19 -0
  322. package/lib/classify-error-kind.js +122 -0
  323. package/lib/crawler/build-js-redirect-edge.d.ts +68 -0
  324. package/lib/crawler/build-js-redirect-edge.js +57 -0
  325. package/lib/crawler/build-redirect-event.d.ts +24 -0
  326. package/lib/crawler/build-redirect-event.js +28 -0
  327. package/lib/crawler/capture-image-dom-paths.d.ts +33 -0
  328. package/lib/crawler/capture-image-dom-paths.js +39 -0
  329. package/lib/crawler/clear-dns-burned-host-cache.d.ts +6 -0
  330. package/lib/crawler/clear-dns-burned-host-cache.js +11 -0
  331. package/lib/crawler/collect-image-dom-paths.d.ts +23 -0
  332. package/lib/crawler/collect-image-dom-paths.js +64 -0
  333. package/lib/crawler/crawler.d.ts +22 -1
  334. package/lib/crawler/crawler.js +679 -117
  335. package/lib/crawler/derive-js-redirect-target.d.ts +68 -0
  336. package/lib/crawler/derive-js-redirect-target.js +129 -0
  337. package/lib/crawler/derive-resource-source.d.ts +25 -15
  338. package/lib/crawler/derive-resource-source.js +28 -17
  339. package/lib/crawler/dns-burned-host-cache.d.ts +26 -0
  340. package/lib/crawler/dns-burned-host-cache.js +25 -0
  341. package/lib/crawler/dns-burned-host-short-circuit-counter.d.ts +13 -0
  342. package/lib/crawler/dns-burned-host-short-circuit-counter.js +11 -0
  343. package/lib/crawler/fetch-destination.d.ts +12 -4
  344. package/lib/crawler/fetch-destination.js +94 -16
  345. package/lib/crawler/inject-scope-auth.d.ts +1 -1
  346. package/lib/crawler/inject-scope-auth.js +1 -1
  347. package/lib/crawler/is-js-redirect-error-shape.d.ts +40 -0
  348. package/lib/crawler/is-js-redirect-error-shape.js +53 -0
  349. package/lib/crawler/is-puppeteer-fallback-candidate.d.ts +16 -0
  350. package/lib/crawler/is-puppeteer-fallback-candidate.js +63 -0
  351. package/lib/crawler/link-list.d.ts +21 -1
  352. package/lib/crawler/link-list.js +23 -3
  353. package/lib/crawler/normalize-content-type.d.ts +1 -1
  354. package/lib/crawler/normalize-content-type.js +1 -1
  355. package/lib/crawler/plan-sub-resource-emits.d.ts +63 -0
  356. package/lib/crawler/plan-sub-resource-emits.js +44 -0
  357. package/lib/crawler/preload-short-circuit-error.d.ts +22 -0
  358. package/lib/crawler/preload-short-circuit-error.js +25 -0
  359. package/lib/crawler/should-burn-host.d.ts +78 -0
  360. package/lib/crawler/should-burn-host.js +61 -0
  361. package/lib/crawler/should-get-fallback-on-head-failure.d.ts +38 -0
  362. package/lib/crawler/should-get-fallback-on-head-failure.js +46 -0
  363. package/lib/crawler/types.d.ts +108 -1
  364. package/lib/crawler-orchestrator.d.ts +22 -3
  365. package/lib/crawler-orchestrator.js +312 -73
  366. package/lib/crawler.d.ts +15 -2
  367. package/lib/crawler.js +24 -1
  368. package/lib/permanent-error-kinds.d.ts +43 -0
  369. package/lib/permanent-error-kinds.js +48 -0
  370. package/lib/types.d.ts +84 -0
  371. package/lib/utils/compute-file-sha256.d.ts +24 -0
  372. package/lib/utils/compute-file-sha256.js +56 -0
  373. package/lib/utils/error/emit-error-with-retry.d.ts +40 -0
  374. package/lib/utils/error/emit-error-with-retry.js +44 -0
  375. package/lib/utils/error/emit-error.d.ts +39 -0
  376. package/lib/utils/error/emit-error.js +41 -0
  377. package/package.json +12 -12
  378. package/lib/archive/migrate-crawl-errors.d.ts +0 -20
  379. package/lib/archive/migrate-crawl-errors.js +0 -38
  380. package/lib/archive/migrate-html-blob-tables.d.ts +0 -24
  381. package/lib/archive/migrate-html-blob-tables.js +0 -53
  382. package/lib/archive/migrate-page-errors.d.ts +0 -16
  383. package/lib/archive/migrate-page-errors.js +0 -35
  384. package/lib/archive/migrate-pages-resources-source.d.ts +0 -16
  385. package/lib/archive/migrate-pages-resources-source.js +0 -46
  386. package/lib/utils/error/error-emitter.d.ts +0 -18
  387. package/lib/utils/error/error-emitter.js +0 -29
@@ -0,0 +1,318 @@
1
+ /**
2
+ * Creates the 6 core entity and edge tables of the 0.13 format (issue #192).
3
+ *
4
+ * These are the normalised entity / edge tables that replace the legacy
5
+ * write model (`pages`, `anchors`, `images`, `resources`, `resources-referrers`)
6
+ * in the 0.13 format. This migration is purely additive DDL — no existing table
7
+ * is modified and no row is inserted; the populate step
8
+ * (`populateEntityTables`) fills the tables from the legacy sources.
9
+ *
10
+ * Tables created:
11
+ *
12
+ * - `content_items` — replaces `pages` (core columns). The remaining
13
+ * per-page metadata splits into `page_meta`.
14
+ * - `page_meta` — page-specific metadata (title, description, meta tags,
15
+ * OpenGraph, Twitter, robots, denormalised aggregates, meta_extras JSON
16
+ * pointer). Split from `pages` so that filter / cursor queries against
17
+ * `content_items` scan a narrower row.
18
+ * - `resource_items` — replaces `resources`. Identity URL splits into
19
+ * `url_id` (regular URLs) vs `url_blob_id` (large `data:` URIs, routed
20
+ * via `blob_refs`) — a resource's own URL is captured verbatim from
21
+ * the network layer and, unlike a page's URL, can legally be a large
22
+ * inline `data:` URI (e.g. a CSS `background-image` sub-resource).
23
+ * - `anchor_edges` — replaces `anchors`. Deduped to distinct
24
+ * `(page_id, href_page_id)` pairs; `count` records how many instances
25
+ * were observed and `first_hash` / `first_text_id` capture the first
26
+ * instance's identity so the most important observable fact per link is
27
+ * preserved without every redundant row.
28
+ * - `resource_ref_edges` — replaces `resources-referrers`. Structural
29
+ * rename with an added `count` column; `WITHOUT ROWID` because the
30
+ * composite PK `(resource_id, page_id)` is the natural clustering key
31
+ * and every column is small — the same reasoning as `page_html_blobs`.
32
+ * - `image_items` — replaces `images`. `src` / `currentSrc` split into
33
+ * `*_url_id` (regular URLs) vs `*_blob_id` (large `data:` URIs, routed
34
+ * via `blob_refs`); `sourceCode` is replaced by `dom_path_text_id`,
35
+ * which the populate step derives from the `outerHTML` string.
36
+ *
37
+ * ### Key invariants
38
+ *
39
+ * **Same PK values as legacy.** `content_items.id`, `resource_items.id`,
40
+ * and `image_items.id` reuse the exact PK values from `pages.id`,
41
+ * `resources.id`, and `images.id` respectively. The populate step inserts
42
+ * rows with explicit IDs so every existing FK reference in `page_errors`,
43
+ * `page_tags`, `page_jsonld`, `page_html_ref`, and `resources-referrers`
44
+ * (before it becomes `resource_ref_edges`) survives the switch without
45
+ * any per-row UPDATE. `AUTOINCREMENT` is nevertheless applied on all four
46
+ * entity PKs (`content_items` / `resource_items` / `anchor_edges` /
47
+ * `image_items`) to match the legacy contract (`t.increments()` on
48
+ * `pages` / `resources` / `anchors` / `images`) — this prevents rowid
49
+ * reuse after DELETE, so external systems (analysis outputs, viewer
50
+ * bookmarks, Sheets exports) keyed on `content_item.id` cannot be
51
+ * silently reassigned to a different record.
52
+ *
53
+ * **UNIQUE(url_id) on content_items and resource_items.** The legacy
54
+ * `pages.url UNIQUE` / `resources.url UNIQUE` guaranteed one row per
55
+ * URL string. Under the new model the URL string is stored once in
56
+ * `url_refs` and each entity references `url_refs.id` via `url_id` —
57
+ * but `url_refs.url UNIQUE` only guarantees "one URL string → one
58
+ * ref id", it does NOT prevent two entity rows from claiming the same
59
+ * ref id. `UNIQUE(url_id)` on both `content_items` and `resource_items`
60
+ * re-establishes that guarantee at the entity level — without it a
61
+ * populate bug could attach two entity rows to the same URL, and every
62
+ * by-URL reader would silently return an arbitrary one. The UNIQUE
63
+ * constraint's auto-index also serves the by-URL seek path, so no
64
+ * separate `CREATE INDEX ... ON content_items(url_id)` is needed.
65
+ * `resource_items.url_id` is nullable (unlike `content_items.url_id`)
66
+ * because a resource's identity URL can itself be blob-routed — see the
67
+ * `resource_items url / blob mutual-exclusion CHECK` invariant below.
68
+ * `UNIQUE` on a nullable SQLite column only dedups the non-NULL values,
69
+ * so the guarantee still holds for every resource that does have a
70
+ * `url_id`.
71
+ *
72
+ * **`redirect_dest_id` self-reference is DEFERRABLE INITIALLY DEFERRED.**
73
+ * `content_items.redirect_dest_id` references `content_items(id)` (not
74
+ * `pages(id)`), mirroring the legacy `pages.redirectDestId → pages.id`
75
+ * self-reference. In the real archive shape, a redirect source can be
76
+ * discovered as an anchor (assigned a low `pages.id`) BEFORE its
77
+ * destination is crawled (higher `pages.id`), so a straight
78
+ * `ORDER BY id ASC` populate would violate the FK on the source row.
79
+ * Making the FK deferred lets the populate step commit all `content_items`
80
+ * inserts inside one transaction without any per-row ordering
81
+ * discipline — SQLite validates the constraint only at COMMIT time.
82
+ *
83
+ * **`page_meta.page_id` PK == FK ON DELETE CASCADE.** `page_meta` uses
84
+ * `page_id` as both the primary key and the FK back to `content_items(id)`.
85
+ * This is a 1:1 relation (every content_item has at most one meta row),
86
+ * so a separate autoincrement id would only bloat the row. The cascade
87
+ * mirrors the legacy `page_html_ref` / `page_tags` / `page_jsonld` FKs
88
+ * to `pages(id)` so a future cleanup pass can DELETE from
89
+ * `content_items` without leaving orphan meta rows.
90
+ *
91
+ * **`content_items.source` and `resource_items.source` DEFAULT 'crawled'.**
92
+ * The legacy `pages.source` / `resources.source` columns were
93
+ * `NOT NULL DEFAULT 'crawled'`, and multiple existing writer paths rely
94
+ * on the default (redirect-source insert, per-chunk resource insert, and
95
+ * `markBrowserScrape`). Preserving the default keeps those callsites
96
+ * working when the 0.13 write path re-points them at the new tables — dropping
97
+ * the default would turn a routine crawl into an immediate hard failure
98
+ * the first time a callsite omits `source`.
99
+ *
100
+ * **`anchor_edges` dedup shape.** `unique(page_id, href_page_id)` enforces
101
+ * the collapse from ≈ 13M legacy `anchors` rows to ≈ 9.7M `anchor_edges`
102
+ * rows (~25 % reduction on the reference archive).
103
+ * `first_hash` and `first_text_id` capture the anchor `hash` and
104
+ * `textContent` of the FIRST instance encountered (lowest `anchors.id`
105
+ * for the pair); duplicate observations are counted via `count` without
106
+ * retaining their bodies. The UNIQUE constraint's auto-index on
107
+ * `(page_id, href_page_id)` also serves any `WHERE page_id = ?` seek via
108
+ * SQLite's leading-prefix rule, so no separate `CREATE INDEX ... ON
109
+ * anchor_edges(page_id)` is needed; only the reverse-direction
110
+ * `idx_anchor_edges_href` on `href_page_id` alone is added.
111
+ *
112
+ * **`image_items.dom_path_text_id NOT NULL`.** Every image row must
113
+ * resolve to a `text_refs` entry describing its DOM position. The
114
+ * image-items populate derives the path from `images.sourceCode` (the
115
+ * stored `outerHTML`); an
116
+ * image whose `sourceCode` is empty falls back to the synthetic label
117
+ * `img[unknown]` (via the image-items populate) so the FK is never violated.
118
+ *
119
+ * **`image_items` src / blob mutual-exclusion CHECK.** `src_url_id` and
120
+ * `src_blob_id` (and their `current_src_*` mirror) are separate nullable
121
+ * columns because a `<img>` value can be either a plain URL or a large
122
+ * `data:` URI. A single legacy `images.src` TEXT column could not
123
+ * express the ambiguity; the new schema splits the two but adds a CHECK
124
+ * so at most one slot per (src, currentSrc) pair is non-null. Without
125
+ * the CHECK a populate bug or future writer could silently write both,
126
+ * and the viewer would arbitrarily pick one to render.
127
+ *
128
+ * **`resource_items` url / blob mutual-exclusion CHECK.** Same rationale
129
+ * as the image CHECK above, but stricter: `(url_id IS NULL) !=
130
+ * (url_blob_id IS NULL)` requires EXACTLY one slot to be non-null (not
131
+ * "at most one") because a resource — unlike an `<img>` that can
132
+ * legitimately have neither `src` nor `currentSrc` — is always
133
+ * identified by some URL. `resolveUrlOrBlob` (writer) /
134
+ * `resolveUrlOrBlobFromMaps` (populate) are shared with `image_items`'
135
+ * routing so the two entities never disagree on which values count as
136
+ * "large data URI".
137
+ *
138
+ * ### Index rationale
139
+ *
140
+ * Every index below reflects a legacy-baseline single-column index that
141
+ * an existing hot path already relies on. `content_items` gets six
142
+ * indexes: `url_id` (via `UNIQUE` auto-index), `is_external`, `scraped`,
143
+ * `redirect_dest_id` (for the Page Detail inbound-redirect list),
144
+ * `content_type_id`, `crawl_order`, and `source` — all present on
145
+ * legacy `pages`. `page_meta` gets `og_type` and `robots_noindex`
146
+ * because both were indexed on legacy `pages` for the noindex /
147
+ * og:type filter hot paths; after the split those readers land on
148
+ * `page_meta` and need the indexes to remain sub-second. `resource_items` gets `url_id`
149
+ * (via `UNIQUE` auto-index) and `source`. `anchor_edges` gets one
150
+ * reverse-direction index (`idx_anchor_edges_href`); the UNIQUE
151
+ * auto-index covers the forward direction. `resource_ref_edges` needs
152
+ * an explicit reverse-direction index on `page_id` because the
153
+ * composite PK `(resource_id, page_id)` only satisfies the `resource_id`-
154
+ * first prefix; the legacy `resources-referrers` table had exactly
155
+ * this reverse-direction index. `image_items` gets one index on
156
+ * `page_id`. No summary / listfilter compound indexes are created here —
157
+ * they belong to the viewer read model built directly against these
158
+ * tables.
159
+ *
160
+ * ### Idempotency
161
+ *
162
+ * All statements use `CREATE TABLE IF NOT EXISTS` / `CREATE INDEX IF NOT
163
+ * EXISTS` so the primitive is safe to call multiple times against the
164
+ * same DB. Both call sites (`initSchema` and
165
+ * `migrateEntityTables`) still guard on their own sentinels,
166
+ * but the function itself no longer depends on the sentinel being
167
+ * checked first — this closes the partial-corruption gap where, say,
168
+ * `content_items` exists but `page_meta` was dropped by an external
169
+ * repair pass.
170
+ * @param instance - The Knex query builder instance connected to the database.
171
+ */
172
+ export async function createEntityTables(instance) {
173
+ await instance.raw(`
174
+ CREATE TABLE IF NOT EXISTS content_items (
175
+ id INTEGER PRIMARY KEY AUTOINCREMENT,
176
+ url_id INTEGER NOT NULL UNIQUE REFERENCES url_refs(id),
177
+ is_external INTEGER NOT NULL,
178
+ scraped INTEGER NOT NULL,
179
+ is_target INTEGER NOT NULL,
180
+ status INTEGER,
181
+ status_text TEXT,
182
+ content_type_id INTEGER REFERENCES content_type_refs(id),
183
+ content_length INTEGER,
184
+ header_set_id INTEGER REFERENCES header_sets(id),
185
+ redirect_dest_id INTEGER REFERENCES content_items(id) DEFERRABLE INITIALLY DEFERRED,
186
+ source TEXT NOT NULL DEFAULT 'crawled',
187
+ first_crawled_at INTEGER,
188
+ last_crawled_at INTEGER,
189
+ crawl_order INTEGER,
190
+ is_skipped INTEGER,
191
+ skip_reason TEXT
192
+ )
193
+ `);
194
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_content_items_external ON content_items(is_external)');
195
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_content_items_scraped ON content_items(scraped)');
196
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_content_items_redirect_dest_id ON content_items(redirect_dest_id)');
197
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_content_items_content_type_id ON content_items(content_type_id)');
198
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_content_items_crawl_order ON content_items(crawl_order)');
199
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_content_items_source ON content_items(source)');
200
+ await instance.raw(`
201
+ CREATE TABLE IF NOT EXISTS page_meta (
202
+ page_id INTEGER PRIMARY KEY REFERENCES content_items(id) ON DELETE CASCADE,
203
+ lang TEXT,
204
+ dir TEXT,
205
+ charset TEXT,
206
+ base_href TEXT,
207
+ viewport_raw TEXT,
208
+ theme_color TEXT,
209
+ application_name TEXT,
210
+ author TEXT,
211
+ generator TEXT,
212
+ publisher TEXT,
213
+ title_text_id INTEGER REFERENCES text_refs(id),
214
+ description_text_id INTEGER REFERENCES text_refs(id),
215
+ keywords_text_id INTEGER REFERENCES text_refs(id),
216
+ robots_raw_text_id INTEGER REFERENCES text_refs(id),
217
+ robots_noindex INTEGER,
218
+ robots_nofollow INTEGER,
219
+ robots_noarchive INTEGER,
220
+ robots_noimageindex INTEGER,
221
+ googlebot TEXT,
222
+ canonical_url_id INTEGER REFERENCES url_refs(id),
223
+ amphtml_url_id INTEGER REFERENCES url_refs(id),
224
+ manifest_url_id INTEGER REFERENCES url_refs(id),
225
+ icon_url_id INTEGER REFERENCES url_refs(id),
226
+ apple_touch_icon_url_id INTEGER REFERENCES url_refs(id),
227
+ og_type TEXT,
228
+ og_title_text_id INTEGER REFERENCES text_refs(id),
229
+ og_description_text_id INTEGER REFERENCES text_refs(id),
230
+ og_url_id INTEGER REFERENCES url_refs(id),
231
+ og_image_url_id INTEGER REFERENCES url_refs(id),
232
+ og_site_name TEXT,
233
+ og_image_alt TEXT,
234
+ og_image_width TEXT,
235
+ og_image_height TEXT,
236
+ og_locale TEXT,
237
+ og_article_published_time TEXT,
238
+ og_article_modified_time TEXT,
239
+ twitter_card TEXT,
240
+ twitter_site TEXT,
241
+ twitter_creator TEXT,
242
+ twitter_title_text_id INTEGER REFERENCES text_refs(id),
243
+ twitter_description_text_id INTEGER REFERENCES text_refs(id),
244
+ twitter_image_url_id INTEGER REFERENCES url_refs(id),
245
+ fb_app_id TEXT,
246
+ verification_google TEXT,
247
+ format_detection_telephone INTEGER,
248
+ tag_count INTEGER,
249
+ jsonld_count INTEGER,
250
+ tags_providers_csv TEXT,
251
+ meta_extras_json_id INTEGER REFERENCES json_refs(id)
252
+ )
253
+ `);
254
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_page_meta_og_type ON page_meta(og_type)');
255
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_page_meta_robots_noindex ON page_meta(robots_noindex)');
256
+ await instance.raw(`
257
+ CREATE TABLE IF NOT EXISTS resource_items (
258
+ id INTEGER PRIMARY KEY AUTOINCREMENT,
259
+ url_id INTEGER UNIQUE REFERENCES url_refs(id),
260
+ url_blob_id INTEGER UNIQUE REFERENCES blob_refs(id),
261
+ is_external INTEGER NOT NULL,
262
+ status INTEGER,
263
+ status_text TEXT,
264
+ content_type_id INTEGER REFERENCES content_type_refs(id),
265
+ content_length INTEGER,
266
+ header_set_id INTEGER REFERENCES header_sets(id),
267
+ compress TEXT,
268
+ cdn TEXT,
269
+ source TEXT NOT NULL DEFAULT 'crawled',
270
+ CHECK ((url_id IS NULL) != (url_blob_id IS NULL))
271
+ )
272
+ `);
273
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_resource_items_source ON resource_items(source)');
274
+ await instance.raw(`
275
+ CREATE TABLE IF NOT EXISTS anchor_edges (
276
+ id INTEGER PRIMARY KEY AUTOINCREMENT,
277
+ page_id INTEGER NOT NULL REFERENCES content_items(id),
278
+ href_page_id INTEGER NOT NULL REFERENCES content_items(id),
279
+ count INTEGER NOT NULL,
280
+ first_hash TEXT,
281
+ first_text_id INTEGER REFERENCES text_refs(id),
282
+ UNIQUE(page_id, href_page_id)
283
+ )
284
+ `);
285
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_anchor_edges_href ON anchor_edges(href_page_id)');
286
+ await instance.raw(`
287
+ CREATE TABLE IF NOT EXISTS resource_ref_edges (
288
+ resource_id INTEGER NOT NULL REFERENCES resource_items(id),
289
+ page_id INTEGER NOT NULL REFERENCES content_items(id),
290
+ count INTEGER NOT NULL DEFAULT 1,
291
+ PRIMARY KEY(resource_id, page_id)
292
+ ) WITHOUT ROWID
293
+ `);
294
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_resource_ref_edges_page ON resource_ref_edges(page_id)');
295
+ await instance.raw(`
296
+ CREATE TABLE IF NOT EXISTS image_items (
297
+ id INTEGER PRIMARY KEY AUTOINCREMENT,
298
+ page_id INTEGER NOT NULL REFERENCES content_items(id),
299
+ src_url_id INTEGER REFERENCES url_refs(id),
300
+ current_src_url_id INTEGER REFERENCES url_refs(id),
301
+ src_blob_id INTEGER REFERENCES blob_refs(id),
302
+ current_src_blob_id INTEGER REFERENCES blob_refs(id),
303
+ alt_text_id INTEGER REFERENCES text_refs(id),
304
+ width REAL,
305
+ height REAL,
306
+ natural_width INTEGER,
307
+ natural_height INTEGER,
308
+ is_lazy INTEGER,
309
+ viewport_width INTEGER,
310
+ dom_path_text_id INTEGER NOT NULL REFERENCES text_refs(id),
311
+ CHECK (
312
+ (src_url_id IS NULL OR src_blob_id IS NULL)
313
+ AND (current_src_url_id IS NULL OR current_src_blob_id IS NULL)
314
+ )
315
+ )
316
+ `);
317
+ await instance.raw('CREATE INDEX IF NOT EXISTS idx_image_items_page ON image_items(page_id)');
318
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Emits a human-readable progress line for a long-running populate step.
3
+ * Injected the same way as `PageDomPathResolver`
4
+ * (`populate-entity-tables/populate-image-items.ts`) — the crawler
5
+ * package stays silent by default for library consumers, while
6
+ * `scripts/migrate-to-0.13.mjs` supplies a `console.log`-backed callback.
7
+ */
8
+ export type ProgressCallback = (message: string) => void;
9
+ /**
10
+ * Returns a `report(processed)` function that calls `onProgress` at most
11
+ * once per 5%-of-`total` tier crossed, so a keyset-paginated loop over a
12
+ * multi-million-row table can report progress every chunk without
13
+ * flooding the log with one line per chunk.
14
+ * @param label - Prefix identifying which populate step / source table
15
+ * this reporter tracks, e.g. `"url_refs (resources)"`.
16
+ * @param total - Total row/page count the loop will scan, precomputed by
17
+ * the caller via a `COUNT(*)`.
18
+ * @param onProgress - Caller-supplied sink, or `undefined` to disable
19
+ * reporting entirely (zero overhead — `report` becomes a no-op).
20
+ * @returns `report(processed)` — call after each chunk with the
21
+ * cumulative count processed so far.
22
+ * @example
23
+ * const total = Number((await trx('url_refs').count({ n: '*' }))[0]?.n ?? 0);
24
+ * const report = createProgressReporter('url_refs', total, onProgress);
25
+ * let processed = 0;
26
+ * // ...inside the read-chunk loop...
27
+ * processed += rows.length;
28
+ * report(processed);
29
+ */
30
+ export declare function createProgressReporter(label: string, total: number, onProgress: ProgressCallback | undefined): (processed: number) => void;
@@ -0,0 +1,38 @@
1
+ /** Progress tiers per run — one report per 5% of `total`, so a 13M-row table produces ~20 lines, not one per chunk. */
2
+ const TIERS = 20;
3
+ /**
4
+ * Returns a `report(processed)` function that calls `onProgress` at most
5
+ * once per 5%-of-`total` tier crossed, so a keyset-paginated loop over a
6
+ * multi-million-row table can report progress every chunk without
7
+ * flooding the log with one line per chunk.
8
+ * @param label - Prefix identifying which populate step / source table
9
+ * this reporter tracks, e.g. `"url_refs (resources)"`.
10
+ * @param total - Total row/page count the loop will scan, precomputed by
11
+ * the caller via a `COUNT(*)`.
12
+ * @param onProgress - Caller-supplied sink, or `undefined` to disable
13
+ * reporting entirely (zero overhead — `report` becomes a no-op).
14
+ * @returns `report(processed)` — call after each chunk with the
15
+ * cumulative count processed so far.
16
+ * @example
17
+ * const total = Number((await trx('url_refs').count({ n: '*' }))[0]?.n ?? 0);
18
+ * const report = createProgressReporter('url_refs', total, onProgress);
19
+ * let processed = 0;
20
+ * // ...inside the read-chunk loop...
21
+ * processed += rows.length;
22
+ * report(processed);
23
+ */
24
+ export function createProgressReporter(label, total, onProgress) {
25
+ let lastTier = 0;
26
+ return (processed) => {
27
+ if (onProgress === undefined || total === 0) {
28
+ return;
29
+ }
30
+ const tier = Math.floor((processed / total) * TIERS);
31
+ if (tier <= lastTier) {
32
+ return;
33
+ }
34
+ lastTier = tier;
35
+ const percent = Math.min(100, Math.round((processed / total) * 100));
36
+ onProgress(`${label}: ${processed}/${total} (${percent}%)`);
37
+ };
38
+ }
@@ -0,0 +1,35 @@
1
+ import type { Knex } from 'knex';
2
+ /**
3
+ * Creates the 10 dictionary tables of the 0.13 format (issue #190) and their index.
4
+ *
5
+ * These are the ref / header dictionary tables that form the durable
6
+ * write-model of the 0.13 format: `url_refs`, `content_type_refs`,
7
+ * `text_refs`, `json_refs`, `blob_refs`, `header_name_refs`,
8
+ * `header_value_refs`, `header_sets` (+ `idx_header_sets_stable`),
9
+ * `header_set_entries`, `header_flags`.
10
+ *
11
+ * The DDL is shared between fresh-archive provisioning ({@link initSchema}
12
+ * calls this on a brand new DB) and the lazy migration path
13
+ * ({@link migrateRefTables} calls it on archives created before the
14
+ * 0.13 format). Keeping the schema in one function guarantees that both
15
+ * origin points produce byte-identical tables — a divergence would silently
16
+ * break the 0.13 population step, which relies on the exact UNIQUE
17
+ * constraints and CHECK clauses declared here.
18
+ *
19
+ * Hash columns store 32-byte BLAKE3 as `BLOB`, matching `page_html_blobs.hash`.
20
+ * `blob_refs` intentionally uses a regular integer rowid PK (unlike
21
+ * `page_html_blobs`) because `image_items.src_blob_id` (added in 0.13)
22
+ * needs a plain integer FK and auto-increment is incompatible with WITHOUT
23
+ * ROWID; `UNIQUE(hash)` still enforces content-addressable dedup.
24
+ *
25
+ * `header_set_entries` is WITHOUT ROWID because the composite PK
26
+ * `(header_set_id, name_id, occurrence)` is the natural clustering key and
27
+ * every column is small — the same reasoning as `page_html_blobs`.
28
+ *
29
+ * `header_sets.raw_json_hash` is a temporary column used only by the
30
+ * legacy-to-0.13 population step for lookups against the legacy
31
+ * `responseHeaders` JSON; a follow-up cleanup migration is expected to
32
+ * drop it.
33
+ * @param instance - The Knex query builder instance connected to the database.
34
+ */
35
+ export declare function createRefTables(instance: Knex): Promise<void>;
@@ -0,0 +1,188 @@
1
+ /**
2
+ * Creates the 10 dictionary tables of the 0.13 format (issue #190) and their index.
3
+ *
4
+ * These are the ref / header dictionary tables that form the durable
5
+ * write-model of the 0.13 format: `url_refs`, `content_type_refs`,
6
+ * `text_refs`, `json_refs`, `blob_refs`, `header_name_refs`,
7
+ * `header_value_refs`, `header_sets` (+ `idx_header_sets_stable`),
8
+ * `header_set_entries`, `header_flags`.
9
+ *
10
+ * The DDL is shared between fresh-archive provisioning ({@link initSchema}
11
+ * calls this on a brand new DB) and the lazy migration path
12
+ * ({@link migrateRefTables} calls it on archives created before the
13
+ * 0.13 format). Keeping the schema in one function guarantees that both
14
+ * origin points produce byte-identical tables — a divergence would silently
15
+ * break the 0.13 population step, which relies on the exact UNIQUE
16
+ * constraints and CHECK clauses declared here.
17
+ *
18
+ * Hash columns store 32-byte BLAKE3 as `BLOB`, matching `page_html_blobs.hash`.
19
+ * `blob_refs` intentionally uses a regular integer rowid PK (unlike
20
+ * `page_html_blobs`) because `image_items.src_blob_id` (added in 0.13)
21
+ * needs a plain integer FK and auto-increment is incompatible with WITHOUT
22
+ * ROWID; `UNIQUE(hash)` still enforces content-addressable dedup.
23
+ *
24
+ * `header_set_entries` is WITHOUT ROWID because the composite PK
25
+ * `(header_set_id, name_id, occurrence)` is the natural clustering key and
26
+ * every column is small — the same reasoning as `page_html_blobs`.
27
+ *
28
+ * `header_sets.raw_json_hash` is a temporary column used only by the
29
+ * legacy-to-0.13 population step for lookups against the legacy
30
+ * `responseHeaders` JSON; a follow-up cleanup migration is expected to
31
+ * drop it.
32
+ * @param instance - The Knex query builder instance connected to the database.
33
+ */
34
+ export async function createRefTables(instance) {
35
+ // Unified URL dictionary. `url` is the natural unique key; scheme /
36
+ // host / port / path / query_hash / fragment are pre-decomposed columns
37
+ // filled by the 0.13 population step so filters like
38
+ // "same-host resources" avoid re-parsing the URL string per row.
39
+ // `query_hash` is BLAKE3 of the raw query string — storing query strings
40
+ // inline would defeat dedup on tracker URLs.
41
+ await instance.raw(`
42
+ CREATE TABLE url_refs (
43
+ id INTEGER PRIMARY KEY,
44
+ url TEXT NOT NULL UNIQUE,
45
+ scheme TEXT,
46
+ host TEXT,
47
+ port INTEGER,
48
+ path TEXT,
49
+ query_hash BLOB,
50
+ fragment TEXT
51
+ )
52
+ `);
53
+ // Content-type dictionary. `raw` is the wire value (unique).
54
+ // `normalized` is the lowercase MIME with parameters stripped;
55
+ // `category` is the coarse bucket used by viewer filters ('html',
56
+ // 'image', ...). Populated in 0.13 by `classifyContentType`.
57
+ await instance.raw(`
58
+ CREATE TABLE content_type_refs (
59
+ id INTEGER PRIMARY KEY,
60
+ raw TEXT NOT NULL UNIQUE,
61
+ normalized TEXT NOT NULL,
62
+ category TEXT NOT NULL
63
+ )
64
+ `);
65
+ // Short-text dictionary. Covers anchor textContent, image alt, page
66
+ // meta strings, and dom_path. The `(hash, text)` composite UNIQUE
67
+ // mirrors `analysis_text_refs` so lookups prefix-seek on `hash`. The
68
+ // two dictionaries stay separate because merging would require
69
+ // re-keying every existing `analysis_violations` row (out of scope
70
+ // for the 0.13 migration; revisit in a later cleanup pass).
71
+ await instance.raw(`
72
+ CREATE TABLE text_refs (
73
+ id INTEGER PRIMARY KEY,
74
+ hash BLOB NOT NULL,
75
+ text TEXT NOT NULL,
76
+ UNIQUE(hash, text)
77
+ )
78
+ `);
79
+ // Large JSON payload dictionary. Covers `pages.meta_extras`. `hash` is
80
+ // BLAKE3 of the pre-compression JSON bytes; `codec` records whether
81
+ // `json_text` is zstd-compressed. Sizes are stored so consumers can
82
+ // estimate savings without decompressing.
83
+ await instance.raw(`
84
+ CREATE TABLE json_refs (
85
+ id INTEGER PRIMARY KEY,
86
+ hash BLOB NOT NULL UNIQUE,
87
+ json_text BLOB NOT NULL,
88
+ codec TEXT NOT NULL CHECK(codec IN ('zstd', 'none')),
89
+ size_raw INTEGER NOT NULL,
90
+ size_stored INTEGER NOT NULL
91
+ )
92
+ `);
93
+ // Large binary payload dictionary. Covers `data:` URIs longer than
94
+ // 512 bytes attached to `<img>` src / currentSrc. Well-formed http(s)
95
+ // URLs virtually never exceed 512 chars, so this threshold routes all
96
+ // data URIs here without misclassifying URLs.
97
+ await instance.raw(`
98
+ CREATE TABLE blob_refs (
99
+ id INTEGER PRIMARY KEY,
100
+ hash BLOB NOT NULL UNIQUE,
101
+ body BLOB NOT NULL,
102
+ codec TEXT NOT NULL CHECK(codec IN ('zstd', 'none')),
103
+ size_raw INTEGER NOT NULL,
104
+ size_stored INTEGER NOT NULL
105
+ )
106
+ `);
107
+ // Response-header decomposition tables. `responseHeaders` on the old
108
+ // `pages` / `resources` tables was a JSON blob whose raw hash barely
109
+ // deduped (99.4 % distinct on the reference archive) because volatile
110
+ // headers like `Date` / `ETag` / `CF-Ray` change every response. The
111
+ // five tables below split header sets into (name, value, occurrence)
112
+ // tuples so a stable-only hash can achieve real dedup, and expose the
113
+ // commonly-checked security flags as pre-computed booleans in
114
+ // `header_flags` so `checkHeaders` no longer needs a per-row LIKE
115
+ // scan.
116
+ await instance.raw(`
117
+ CREATE TABLE header_name_refs (
118
+ id INTEGER PRIMARY KEY,
119
+ name TEXT NOT NULL UNIQUE
120
+ )
121
+ `);
122
+ await instance.raw(`
123
+ CREATE TABLE header_value_refs (
124
+ id INTEGER PRIMARY KEY,
125
+ hash BLOB NOT NULL,
126
+ value TEXT NOT NULL,
127
+ UNIQUE(hash, value)
128
+ )
129
+ `);
130
+ // `raw_json_hash` is BLAKE3 of the raw `responseHeaders` JSON string
131
+ // exactly as stored in the old tables — kept only so the 0.13
132
+ // migration can look up an existing `header_sets.id` without calling
133
+ // any SQL function (SQLite has no built-in BLAKE3). Scheduled for drop
134
+ // in a follow-up cleanup migration.
135
+ // `raw_hash` is BLAKE3 of the sorted `name=value` pairs of every
136
+ // header (stable + volatile); `stable_hash` is BLAKE3 of the sorted
137
+ // `name=value` pairs of stable headers only.
138
+ // Both `raw_json_hash` and `raw_hash` are UNIQUE so a JS-side upsert
139
+ // can guarantee dedup — duplicate raw JSON strings map to the same
140
+ // row and same PK.
141
+ // `idx_header_sets_stable` accelerates the "how many pages share this
142
+ // stable header profile" lookup that 0.13 readers use.
143
+ await instance.raw(`
144
+ CREATE TABLE header_sets (
145
+ id INTEGER PRIMARY KEY,
146
+ raw_json_hash BLOB NOT NULL UNIQUE,
147
+ raw_hash BLOB NOT NULL UNIQUE,
148
+ stable_hash BLOB NOT NULL,
149
+ volatile_hash BLOB,
150
+ entry_count INTEGER NOT NULL,
151
+ stable_entry_count INTEGER NOT NULL
152
+ )
153
+ `);
154
+ await instance.raw('CREATE INDEX idx_header_sets_stable ON header_sets(stable_hash)');
155
+ // `occurrence` is the 1-based index among entries sharing the same
156
+ // `(header_set_id, name_id)` pair. HTTP allows a header name to appear
157
+ // multiple times in one response (e.g. multiple `Set-Cookie` lines);
158
+ // the composite PK preserves all values without truncation.
159
+ await instance.raw(`
160
+ CREATE TABLE header_set_entries (
161
+ header_set_id INTEGER NOT NULL REFERENCES header_sets(id),
162
+ name_id INTEGER NOT NULL REFERENCES header_name_refs(id),
163
+ occurrence INTEGER NOT NULL,
164
+ value_id INTEGER NOT NULL REFERENCES header_value_refs(id),
165
+ is_volatile INTEGER NOT NULL,
166
+ PRIMARY KEY(header_set_id, name_id, occurrence)
167
+ ) WITHOUT ROWID
168
+ `);
169
+ // Pre-computed booleans for the security / caching header checks that
170
+ // `checkHeaders` currently expresses as per-row LIKE predicates over
171
+ // `responseHeaders`. Populated in 0.13 by reusing
172
+ // `headerPresenceExpression`'s logic so the flag rules stay in one
173
+ // place. `cache_policy` is a short summary string captured for display;
174
+ // nullable when the header is absent.
175
+ await instance.raw(`
176
+ CREATE TABLE header_flags (
177
+ header_set_id INTEGER PRIMARY KEY REFERENCES header_sets(id),
178
+ has_csp INTEGER NOT NULL,
179
+ has_x_frame_options INTEGER NOT NULL,
180
+ has_x_content_type_options INTEGER NOT NULL,
181
+ has_hsts INTEGER NOT NULL,
182
+ has_referrer_policy INTEGER NOT NULL,
183
+ has_permissions_policy INTEGER NOT NULL,
184
+ has_set_cookie INTEGER NOT NULL,
185
+ cache_policy TEXT
186
+ )
187
+ `);
188
+ }