@docslurp/contrib-algolia-server 0.3.0 → 0.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 [Package docs](https://docslurp.io/docs/packages/contrib-algolia-server) · [GitHub](https://github.com/DocSlurp/docslurp-oss/tree/main/packages/contrib-algolia-server) · [npm](https://www.npmjs.com/package/@docslurp/contrib-algolia-server)
 
-Sync Algolia-style settings, synonyms, rules and imports into DocSlurp from a backend job, migration script or API adapter. `createDocSlurpAlgoliaServerClient()` wraps [`@docslurp/contrib-search-compat/algolia`](https://docslurp.io/docs/packages/contrib-search-compat) and adds `searchIndex`, `syncSettings`, `syncSynonyms` and `syncRules`. Use it with a server key; writes are refused for browser keys.
+Sync Algolia-style settings, synonyms, rules and imports into DocSlurp from a backend job, migration script or API adapter. `createDocSlurpAlgoliaServerClient()` wraps [`@docslurp/contrib-search-compat/algolia`](https://docslurp.io/docs/packages/contrib-search-compat) and adds `searchIndex`, `syncSettings`, `syncSynonyms` and `syncRules`. Use it with a server key: writes need the `workspaces:manage` scope, which only organization owners and admins can grant, and are refused for browser keys.
 
 ## Install and use
 
@@ -15,7 +15,7 @@ import { createDocSlurpAlgoliaServerClient } from "@docslurp/contrib-algolia-ser
 
 const client = createDocSlurpAlgoliaServerClient({
   apiUrl: "https://docslurp.io",
-  clientKey: process.env.DOCSLURP_API_KEY!, // A server key. The option is named clientKey.
+  clientKey: process.env.DOCSLURP_API_KEY!, // A server key with the workspaces:manage scope. The option is named clientKey.
 });
 
 const res = await client.searchIndex("product-manuals", { query: "invoice" });

package/dist/index.d.ts

@@ -3,19 +3,6 @@ export type DocSlurpAlgoliaServerClientOptions = DocSlurpAlgoliaClientOptions &
     defaultIndexName?: string;
 };
 export declare function createDocSlurpAlgoliaServerClient(options: DocSlurpAlgoliaServerClientOptions): {
-    searchIndex: (indexName: string, request: AlgoliaSearchRequest) => Promise<AlgoliaSearchResponse>;
-    syncSettings: (indexName: string, settings: AlgoliaCompatSettings) => Promise<{
-        ok: boolean;
-        settings: AlgoliaCompatSettings;
-    }>;
-    syncSynonyms: (indexName: string, synonyms: AlgoliaSynonymEntry[]) => Promise<{
-        updatedAt: string;
-        count: number;
-    }>;
-    syncRules: (indexName: string, rules: AlgoliaRuleEntry[]) => Promise<{
-        updatedAt: string;
-        count: number;
-    }>;
     initIndex: (indexName: string) => {
         search: (query: string | AlgoliaSearchRequest, params?: Omit<AlgoliaSearchRequest, "query">) => Promise<AlgoliaSearchResponse>;
         getSettings: () => Promise<AlgoliaCompatSettings>;
@@ -129,5 +116,18 @@ export declare function createDocSlurpAlgoliaServerClient(options: DocSlurpAlgol
         results: AlgoliaSearchResponse[];
     }>;
     importIndex: (payload: Record<string, unknown>) => Promise<unknown>;
+    searchIndex: (indexName: string, request: AlgoliaSearchRequest) => Promise<AlgoliaSearchResponse>;
+    syncSettings: (indexName: string, settings: AlgoliaCompatSettings) => Promise<{
+        ok: boolean;
+        settings: AlgoliaCompatSettings;
+    }>;
+    syncSynonyms: (indexName: string, synonyms: AlgoliaSynonymEntry[]) => Promise<{
+        updatedAt: string;
+        count: number;
+    }>;
+    syncRules: (indexName: string, rules: AlgoliaRuleEntry[]) => Promise<{
+        updatedAt: string;
+        count: number;
+    }>;
 };
 export default createDocSlurpAlgoliaServerClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docslurp/contrib-algolia-server",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Server-side Algolia-style wrapper for syncing settings, synonyms, rules and imports into DocSlurp.",
   "license": "MIT",
   "homepage": "https://docslurp.io/docs/packages/contrib-algolia-server",
@@ -23,11 +23,11 @@
     "LICENSES"
   ],
   "dependencies": {
-    "@docslurp/contrib-search-compat": "^0.3.0"
+    "@docslurp/contrib-search-compat": "^0.4.0"
   },
   "devDependencies": {
-    "@types/node": "^26.6.5",
-    "typescript": "^6.0.3"
+    "@types/node": "^26.6.6",
+    "typescript": "^7.0.2"
   },
   "publishConfig": {
     "access": "public"