@tryghost/algolia-netlify 0.4.0 → 0.4.2

package/README.md

@@ -23,12 +23,14 @@ Use a restricted Algolia API key to limit the impact of unauthorized requests.
 
 ### Set up Algolia
 
-The functions need the Algolia Application ID and an API key that can update the target index. The general Admin API key works, but a key scoped to this index is preferable. A scoped key needs these permissions:
+Run the [`@tryghost/algolia` CLI](../algolia/README.md) once before enabling the webhooks. It creates the index and adds `filterOnly(slug)`, which the unpublish webhook uses to delete all records for a post. If you use custom index settings, add `filterOnly(slug)` to `attributesForFaceting` yourself.
+
+The functions need your Algolia Application ID and an API key restricted to the target index. Give this key these permissions:
 
 - Add records (`addObject`)
 - Delete records matching a filter (`deleteIndex`)
-- Get index settings (`settings`)
-- Set index settings (`editSettings`)
+
+Algolia requires `deleteIndex` for filtered deletions. The name is a bit misleading: this permission can also delete the whole index, so do not grant the key access to any other index. The publish webhook does not read or change settings, so the key does not need `settings` or `editSettings` after setup.
 
 ### Deploy the Netlify Functions
 
@@ -59,7 +61,7 @@ Use the function URL shown by Netlify and pass the configured `NETLIFY_KEY` as t
 https://YOUR-SITE-ID.netlify.app/.netlify/functions/post-published?key=NETLIFY_KEY
 ```
 
-These webhooks keep future post changes synchronized. Use the [`@tryghost/algolia` CLI](../algolia/README.md) to create the initial index.
+Once configured, these webhooks keep post changes in sync without touching the index settings.
 
 ## Development
 
@@ -74,7 +76,7 @@ pnpm dev
 
 `pnpm dev` starts Netlify Dev, which builds the TypeScript functions as needed. Use the local URL it prints for endpoints such as `/.netlify/functions/post-published`.
 
-Run this package's tests and ESLint checks from the repository root:
+Run this package's tests and lint checks from the repository root:
 
 ```sh
 pnpm --filter @tryghost/algolia-netlify test
@@ -86,7 +88,7 @@ Run the full monorepo suite with `pnpm test`.
 
 The modern handlers use native `Request` and `Response` objects. Malformed, empty, or structurally invalid JSON now receives `400 Invalid request body`; a valid Ghost envelope with no selected post remains a `200 No valid request body detected` response. Existing valid webhook behavior, endpoint URLs, and optional `key` handling are unchanged.
 
-`pnpm pack` builds an ESM-only Node 24 package with generated TypeScript declarations. The package intentionally exposes only the two handlers; webhook utilities remain internal.
+From this package directory, `pnpm pack` builds an ESM-only package with generated TypeScript declarations. The supported Node range is declared in [`package.json`](package.json). The package intentionally exposes only the two handlers; webhook utilities remain internal.
 
 ---
 

package/dist/functions/post-published.mjs

@@ -65,7 +65,7 @@ async function postPublished(request) {
     const algoliaObjects = transforms.transformToAlgoliaObject([post]);
     const fragments = algoliaObjects.reduce(transforms.fragmentTransformer, []);
     const index = new IndexFactory(algoliaSettings());
-    await index.setSettingsForIndex();
+    await index.initIndex();
     await index.save(fragments);
     console.log("Fragments successfully saved to Algolia index");
     return textResponse(`Post "${String(post.title)}" has been added to the index.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/algolia-netlify",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/algolia.git",
@@ -34,47 +34,23 @@
   "publishConfig": {
     "access": "public"
   },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-      "ecmaVersion": 2023,
-      "sourceType": "module"
-    },
-    "extends": [
-      "airbnb-base",
-      "plugin:ghost/browser"
-    ],
-    "plugins": [
-      "ghost"
-    ]
-  },
-  "eslintIgnore": [
-    "webpack.functions.js",
-    "build/*",
-    "dist/*"
-  ],
   "devDependencies": {
     "@types/node": "24.13.3",
-    "@typescript-eslint/parser": "8.67.0",
-    "eslint": "8.57.1",
-    "eslint-config-airbnb-base": "15.0.0",
-    "eslint-plugin-ghost": "3.5.0",
-    "eslint-plugin-import": "2.32.0",
     "esbuild": "0.28.2",
     "netlify-cli": "27.1.1",
-    "typescript": "6.0.3"
+    "typescript": "7.0.2"
   },
   "dependencies": {
     "algolia-html-extractor": "0.0.1",
-    "algoliasearch": "4.20.0",
-    "@tryghost/algolia-indexer": "^0.3.2",
-    "@tryghost/algolia-fragmenter": "^0.2.8"
+    "algoliasearch": "5.56.0",
+    "@tryghost/algolia-fragmenter": "^0.2.9",
+    "@tryghost/algolia-indexer": "^0.3.3"
   },
   "scripts": {
     "dev": "pnpm --dir ../.. exec netlify dev --filter @tryghost/algolia-netlify",
     "test": "NODE_ENV=testing vitest run --root .",
     "typecheck": "tsc --project tsconfig.functions.json && tsc --project tsconfig.test.json",
-    "lint": "eslint . --ext .js,.cjs,.ts,.mts,.cts --cache",
+    "lint": "oxlint --quiet . && oxfmt --check .",
     "posttest": "pnpm typecheck && pnpm lint",
     "build": "NODE_ENV=production pnpm --dir ../.. exec netlify build --offline --filter @tryghost/algolia-netlify",
     "build:package": "node scripts/build-package.mjs && tsc --project tsconfig.package.json && node scripts/clean-package.mjs"