Revert "Update scripts/search/ci-update-search-index.ts for TypeScript (#14055)"

This reverts commit 180bf4a.

Author: iwahbe

package.json

@@ -8,7 +8,6 @@
     "lint-markdown": "tsx ./scripts/lint/lint-markdown.ts",
     "build-search-index": "tsx ./scripts/search/main.ts",
     "check-urls": "tsx ./scripts/search/check-urls.ts",
-    "update-search-index": "tsx ./scripts/search/update-search-index.ts",
     "prepare": "husky"
   },
   "type": "module",

scripts/ci-update-search-index.sh

@@ -2,4 +2,4 @@
 
 # This script downloads the search indexes for registry and docs from pulumi.com then combines
 # the two indexes and pushes them to Algolia.
-yarn run update-search-index "$1"
+node ./scripts/search/update-search-index.cjs "$1"

scripts/search/registry.ts

@@ -0,0 +1,86 @@
+const fs = require("fs");
+const path = require("path");
+const page = require("./page");
+
+module.exports = {
+
+    // Fetch a set of objects representing all Registry resources.
+    getObjects(pathToRegistryJSON, hugoPageItems) {
+        const registryPackageNames = fs.readdirSync(pathToRegistryJSON);
+        const registryItems = [];
+
+        registryPackageNames
+            .map(providerJSON => {
+                const providerName = providerJSON.replace(".json", "");
+                const providerResults = [];
+
+                // API docs JSON doesn't contain proper provider/package names, so we obtain those
+                // from the Hugo-generated set.
+                const providerTitle = hugoPageItems.find(o => {
+                    return o.href === `/registry/packages/${providerName}/`;
+                }).title;
+
+                // Read the API docs JSON file.
+                const providerItems = JSON.parse(
+                    fs.readFileSync(path.join(pathToRegistryJSON, providerJSON), "utf8").toString(),
+                );
+
+                // For every resource in that file, generate an individual search record, including
+                // tokens as keywords to make them easier to find by copy/paste.
+                function getMember(itemPath, item) {
+
+                    // Some of the items in our registry nav files contain trailing slashes, which
+                    // don't play nicely with the string concatenation we do to build up our search
+                    // URLs. So we strip them out to avoid ending up with doubles (and thus 404s).
+                    item.link = item.link.replace(/\/+$/, "");
+
+                    providerResults.push({
+                        title: `${item.name} (${itemPath.concat(item.name).join(".")})`,
+                        description: `API documentation for the ${item.name} ${item.type} of the ${providerTitle} provider, including examples, input and output properties, lookup functions, and supporting types.`,
+                        type: item.type,
+                        href: `/registry/packages/${providerName}/api-docs/${itemPath.concat(item.link).slice(1).join("/").toLowerCase()}/`,
+                        keywords: [
+                            item.name,
+                            itemPath.concat(item.name).slice(1).join(" ").toLowerCase(),
+                            itemPath.concat(item.name).join("."),
+                            itemPath.concat(item.name).join(":"),
+                            itemPath.concat(item.name).join(" "),
+                            `${providerTitle} ${item.name}`
+                        ],
+                        ancestors: [ "Registry", providerTitle, "API Docs" ],
+                    });
+
+                    if (item.children) {
+                        item.children.map(child => {
+                            getMember([...itemPath, item.name], child);
+                        });
+                    }
+                }
+
+                providerItems.forEach(item => {
+                    getMember([ providerName ], item);
+                });
+
+                return {
+                    name: providerName,
+                    items: providerResults,
+                };
+            })
+            .forEach(member => {
+                registryItems.push(...member.items);
+            });
+
+            return registryItems.map(item => {
+                return {
+                    objectID: page.getObjectID(item),
+                    title: item.title,
+                    description: item.description,
+                    section: "Registry",
+                    href: item.href,
+                    rank: page.getRank(item),
+                    keywords: item.keywords,
+                    ancestors: item.ancestors,
+                };
+            });
+    }
+};

scripts/search/settings.ts

@@ -1,21 +1,22 @@
-import * as page from "./page";
+const page = require("./page");
 
 // Algolia index settings.
 //
 // Changes to this file should be made with extreme care.
+module.exports = {
 
     // Attributes for faceting are the properties to use for top-level filtering of results -- for
     // example, whether a given record is returned for a "Docs" query, "Registry" query, and so on.
     // https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/
-    export function getAttributesForFaceting() {
+    getAttributesForFaceting() {
         return [
             "searchable(section)",
         ];
-    }
+    },
 
     // Synonyms allow us to surface content that may not directly match users' queries.
     // https://www.algolia.com/doc/api-reference/api-methods/save-synonyms/#save-synonyms
-    export function getSynonyms() {
+    getSynonyms() {
         return [
             [".NET", "dotnet"],
             ["aws", "aws classic"],
@@ -47,7 +48,7 @@ import * as page from "./page";
                 synonyms,
             };
         });
-    }
+    },
 
     // Searchable attributes control the fields that Algolia uses for query matching, as well as how
     // relevant those fields are in relation to one another.
@@ -57,7 +58,7 @@ import * as page from "./page";
     // the change on an index that isn't production.
     //
     // https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/#set-searchable-attributes-with-the-api
-    export function getSearchableAttributes() {
+    getSearchableAttributes() {
         return [
             "title,h1",            // Title and H1 are considered of equal relevance, so they're listed on the same level.
             "keywords",            // Keywords are treated as ordered. Those higher up in the list are considered more relevant.
@@ -68,25 +69,25 @@ import * as page from "./page";
             "section",             // Section is the primary "facet" of a record -- Docs, Registry, Blog, Examples, etc.
             "unordered(authors)",  // Blog-post authors are occasionally useful for searching, but their order is considered irrelevant.
         ];
-    }
+    },
 
     // Attributes to highlight contains the list of searchable attributes that might be used to highlight query matches in the UI.
     // https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/
-    export function getAttributesToHighlight() {
+    getAttributesToHighlight() {
         return [
             "title",
             "h1",
             "description",
         ];
-    }
+    },
 
     // Custom rankings are the attributes that Algolia uses for determining relative ranking --
     // specifically for breaking ties between records that rank similarly for text matching. Similar
     // to the above, order here is significant as well, so any changes here should be made with
     // equal care.
     //
     // https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/configure-custom-ranking
-    export function getCustomRanking() {
+    getCustomRanking() {
         return [
 
             // https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/configure-custom-ranking/#configure-custom-ranking-with-the-api
@@ -95,12 +96,12 @@ import * as page from "./page";
             // https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/boost-or-penalize-some-records/#using-the-api
             "desc(boosted)",
         ];
-    }
+    },
 
     // Rules are explicit instructions that apply fine-grained control over how certain queries are handled.
     // https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/
     // https://www.algolia.com/doc/api-reference/api-methods/save-rule
-    export function getRules() {
+    getRules() {
         return [
 
             // When the query is for "cloud", deliver the Pulumi Cloud overview page as the top result.
@@ -207,4 +208,5 @@ import * as page from "./page";
                 },
             },
         ];
-    }
+    },
+};

scripts/search/update-search-index.ts

@@ -1,6 +1,6 @@
-import * as axios from "axios";
-import * as settings from "./settings";
-import * as algoliasearch from "algoliasearch";
+const axios = require('axios');
+const settings = require("./settings");
+const algoliasearch = require("algoliasearch");
 
 // URL of the JSON file
 const registrySearchIndexUrl = "https://www.pulumi.com/registry/search-index.json";
@@ -19,7 +19,7 @@ if (!config.appID || !config.searchAPIKey || !config.adminAPIKey || !config.inde
 }
 
 // Initialize the Algolia search client.
-const client = algoliasearch.default(config.appID, config.adminAPIKey);
+const client = algoliasearch(config.appID, config.adminAPIKey);
 const algoliaIndex = client.initIndex(config.indexName);
 
 async function publishIndex() {
@@ -100,4 +100,4 @@ async function publishIndex() {
     await updateIndex(allObjects);
 }
 
-publishIndex();
+publishIndex();