feat(javascript): guides

Author: Fluf22

templates/javascript/guides/search/deleteMultipleIndices.mustache

@@ -0,0 +1,36 @@
+{{> snippets/import}}
+import type { MultipleBatchRequest } from 'algoliasearch';
+
+try {
+  // You need an API key with `deleteIndex`
+  {{> snippets/init}}
+
+  // List all indices
+  const indices = {{#dynamicSnippet}}listIndicesSimple{{/dynamicSnippet}};
+
+  // Primary indices don't have a `primary` key
+  const primaryIndices = indices.items.filter(item => item.primary == null);
+  const replicaIndices = indices.items.filter(item => item.primary != null);
+
+  // Delete primary indices first
+  if (primaryIndices.length > 0) {
+      const requests: MultipleBatchRequest[] = primaryIndices.map(index => ({
+        action: 'delete',
+        indexName: index.name
+      }));
+      {{#dynamicSnippet}}deleteMultipleIndicesPrimary{{/dynamicSnippet}};
+      console.log("Deleted primary indices.");
+  }
+
+  // Now, delete replica indices
+  if (replicaIndices.length > 0) {
+      const requests: MultipleBatchRequest[] = replicaIndices.map(index => ({
+        action: 'delete',
+        indexName: index.name
+      }));
+      {{#dynamicSnippet}}deleteMultipleIndicesReplica{{/dynamicSnippet}};
+      console.log("Deleted replica indices.");
+  }
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/saveObjectsChunks.mustache

@@ -0,0 +1,16 @@
+{{> snippets/import}}
+
+try {
+  {{> snippets/init}}
+
+  const { default: records } = await import('./actors.json');
+
+  const chunkSize = 10000
+
+  for (let beginIndex = 0; beginIndex < records.length; beginIndex += chunkSize) {
+    const chunk = records.slice(beginIndex, beginIndex + chunkSize);
+    {{#dynamicSnippet}}saveObjectsChunks{{/dynamicSnippet}}
+  }
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/saveObjectsMCM.mustache

@@ -0,0 +1,22 @@
+{{> snippets/import}}
+
+const getAllAppIDConfigurations = (): Record<string, string>[] => {
+  return [/* A list of your MCM AppID/ApiKey pairs */]
+}
+
+const playlists: Record<string, any>[] = [ /* Your records */ ]
+
+// Fetch from your own data storage and with your own code
+// the list of application IDs and API keys to target each cluster
+const configurations = getAllAppIDConfigurations();
+
+// Send the records to each cluster
+Object.keys(configurations).forEach(async (appID) => {
+  try {
+    const client = algoliasearch(appID, configurations[appID]);
+
+    {{#dynamicSnippet}}saveObjectsPlaylists{{/dynamicSnippet}}
+  } catch (e) {
+    console.error(e);
+  }
+});

templates/javascript/guides/search/saveObjectsModified.mustache

@@ -0,0 +1,21 @@
+{{> snippets/import}}
+
+try {
+  {{> snippets/init}}
+
+  const { default: products } = await import('./actors.json');
+
+  const records = products.map((product) => {
+      const reference = product["product_reference"];
+      const suffixes: string[] = []
+
+      for (let i = reference.length; i > 1; i--) {
+          suffixes.unshift(reference.slice(i));
+      }
+      return { ...product, product_reference_suffixes: suffixes };
+  });
+
+  {{#dynamicSnippet}}saveObjectsRecords{{/dynamicSnippet}}
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/saveObjectsPublicUser.mustache

@@ -0,0 +1,11 @@
+{{> snippets/import}}
+
+const playlists: Record<string, any>[] = [] // Your records
+
+try {
+  {{> snippets/init}}
+
+  {{#dynamicSnippet}}saveObjectsPlaylistsWithUserIDPublic{{/dynamicSnippet}}
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/savePopularRecords.mustache

@@ -0,0 +1,20 @@
+{{> snippets/import}}
+
+try {
+  {{> snippets/init}}
+
+  const records: Record<string, any> = [];
+
+  await client.browseObjects<Record<string, any>>({ indexName: "<YOUR_INDEX_NAME>", browseParams: undefined, aggregator: (res) =>
+      records.push(
+        res.hits.map((record) => ({
+          ...record,
+          isPopular: record.nbFollowers >= 1_000_000,
+        }))
+      )
+  });
+
+  {{#dynamicSnippet}}saveObjectsRecords{{/dynamicSnippet}}
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/searchRecentlyPublishedBooks.mustache

@@ -0,0 +1,16 @@
+{{> snippets/import}}
+import type { SearchParams } from 'algoliasearch';
+
+try {
+  {{> snippets/init}}
+
+  const dateTimestamp = Date.now();
+  const searchParams: SearchParams = {
+    query: "<YOUR_SEARCH_QUERY>",
+    filters: `date_timestamp > ${dateTimestamp}`
+  };
+
+  {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/searchWithGAToken.mustache

@@ -0,0 +1,25 @@
+{{> snippets/import}}
+import type { SearchParams } from 'algoliasearch';
+
+const getGoogleAnalyticsUserIdFromBrowserCookie = (_: string) => {
+  return ""; // Implement your logic here
+}
+
+try {
+  {{> snippets/init}}
+
+  const userToken = getGoogleAnalyticsUserIdFromBrowserCookie('_ga');
+  let searchParams: SearchParams = {
+    query: "<YOUR_SEARCH_QUERY>",
+    userToken
+  };
+
+  {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}
+
+  const loggedInUser: string | undefined = undefined;
+  searchParams.userToken = loggedInUser ?? userToken;
+
+  {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/searchWithOptionalFilters.mustache

@@ -0,0 +1,22 @@
+{{> snippets/import}}
+import type { OptionalFilters, SearchParams } from 'algoliasearch';
+
+const labels: string[] = [] // A list of labels
+
+const reduceLabelsToFilters = (_labels: string[]): OptionalFilters => {
+  return []; // Implement your logic here
+}
+
+try {
+  {{> snippets/init}}
+
+  const optionalFilters = reduceLabelsToFilters(labels)
+  const searchParams: SearchParams = {
+    query: "<YOUR_SEARCH_QUERY>",
+    optionalFilters: optionalFilters
+  };
+
+  {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}
+} catch (e) {
+  console.error(e);
+}

templates/javascript/guides/search/searchWithRuleContextBuyer.mustache

@@ -0,0 +1,21 @@
+{{> snippets/import}}
+import type { SearchParams } from 'algoliasearch';
+
+const getBuyerAccountId = () => {
+ return ""; // Implement your logic here
+}
+
+try {
+  {{> snippets/init}}
+
+  // get the buyer account information
+  const buyer = getBuyerAccountId();
+  const searchParams: SearchParams = {
+    query: "<YOUR_SEARCH_QUERY>",
+    ruleContexts: [buyer]
+  };
+
+  {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}
+} catch (e) {
+  console.error(e);
+}