@graphcommerce/algolia-products 9.0.0-canary.100

package/scripts/base-schema-filter.mts

@@ -0,0 +1,45 @@
+import type { OpenAPIV3 } from 'openapi-types'
+
+function isRef(value: any): value is OpenAPIV3.ReferenceObject {
+  return typeof value === 'object' && '$ref' in value
+}
+
+export function algoliaSchemaBaseFilter(
+  schemaKey: string,
+  schema: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject,
+): [string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject] {
+  if (isRef(schema)) return [schemaKey, schema]
+
+  if (
+    schema.oneOf &&
+    schema.oneOf[0]?.['$ref'] === '#/components/schemas/searchParamsString' &&
+    schema.oneOf[1]?.['$ref'] === '#/components/schemas/searchParamsObject'
+  ) {
+    return [schemaKey, { $ref: '#/components/schemas/searchParamsObject' }]
+  }
+
+  if (schemaKey === 'facetFilters') {
+    return [schemaKey, { ...schema, example: undefined, oneOf: undefined, type: 'object' }]
+  }
+
+  return [
+    schemaKey,
+    {
+      ...schema,
+      default: undefined,
+      properties: schema.properties
+        ? Object.fromEntries(
+            Object.entries(schema.properties).map(([propertyKey, property]) => {
+              if (isRef(property)) return [propertyKey, property]
+
+              if (propertyKey === 'customNormalization' || propertyKey === 'facets') {
+                return [propertyKey, { ...property, example: undefined }]
+              }
+
+              return [propertyKey, { ...property, default: undefined }]
+            }),
+          )
+        : undefined,
+    },
+  ]
+}

package/scripts/generate-spec.mts

@@ -0,0 +1,69 @@
+import yaml from 'js-yaml'
+import { writeFile } from 'node:fs/promises'
+import type { OpenAPIV3 } from 'openapi-types'
+import prettier from 'prettier'
+import conf from '@graphcommerce/prettier-config-pwa'
+import { algoliaSchemaBaseFilter } from './base-schema-filter.mjs'
+
+const response = await fetch(
+  'https://raw.githubusercontent.com/algolia/api-clients-automation/main/specs/bundled/search.yml',
+)
+
+const openApiSchema = yaml.load(await response.text()) as OpenAPIV3.Document
+
+const acl = ['search']
+
+const newSchema: OpenAPIV3.Document = {
+  ...openApiSchema,
+  components: {
+    ...openApiSchema.components,
+    schemas: Object.fromEntries(
+      Object.entries(openApiSchema.components?.schemas ?? {}).map(([schemaKey, schema]) => {
+        return algoliaSchemaBaseFilter(schemaKey, schema)
+      }),
+    ),
+  },
+  paths: {
+    ...Object.fromEntries(
+      Object.entries(openApiSchema.paths)
+        .map(([path, pathItem]) => {
+          if (!pathItem) return [path, pathItem]
+          const newValue = pathItem
+
+          const keys = ['post', 'get', 'put', 'delete', 'patch', 'options'] as const
+
+          keys.forEach((method) => {
+            if (!newValue[method]?.['x-acl']?.some((value: string) => acl.includes(value))) {
+              newValue[method] = undefined
+            }
+          })
+
+          return [path, pathItem]
+        })
+        .filter(([path, pathItem]) => {
+          if (!pathItem) return
+
+          // Remove the search endpoint + remove the getObjects endpoint.
+          if (
+            path === '/1/indexes/*/queries' ||
+            path === '/1/indexes/*/objects' ||
+            path === '/1/indexes/{indexName}/{objectID}'
+          )
+            return false
+
+          const keys = ['post', 'get', 'put', 'delete', 'patch', 'options'] as const
+          if (keys.every((key) => !pathItem[key])) return false
+
+          return true
+        }),
+    ),
+  },
+}
+
+await writeFile(
+  './algolia-spec.yaml',
+  await prettier.format(yaml.dump(newSchema), {
+    parser: 'yaml',
+    ...conf,
+  }),
+)

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "exclude": ["**/node_modules", "**/.*/"],
+  "include": ["**/*.ts", "**/*.tsx"],
+  "extends": "@graphcommerce/typescript-config-pwa/nextjs.json"
+}

package/utils/applyCategoryEngineVariable.ts

@@ -0,0 +1,11 @@
+import type { ProductListQueryVariables } from '@graphcommerce/magento-product'
+
+export function applyEngineVariables(variables: ProductListQueryVariables | undefined) {
+  return {
+    ...variables,
+    filters: {
+      ...variables?.filters,
+      engine: { eq: 'algolia' },
+    },
+  }
+}

package/utils/applyEngineVariable.ts

@@ -0,0 +1,11 @@
+import type { ProductListQueryVariables } from '@graphcommerce/magento-product'
+
+export function applyEngineVariables(variables: ProductListQueryVariables | undefined) {
+  return {
+    ...variables,
+    filters: {
+      ...variables?.filters,
+      engine: { eq: 'algolia' },
+    },
+  }
+}