Merge branch 'main' into fix/more-broken-links

Author: millotp

docs/bundled/analytics.yml

@@ -7343,7 +7343,7 @@ components:
         - ':'
         - <
         - <=
-        - '='
+        - =
         - '!='
         - '>'
         - '>='

docs/bundled/composition.yml

@@ -6504,7 +6504,8 @@ components:
 
         `facet:\-value`.
       example:
-        - - category:Book
+        -
+          - category:Book
           - category:-Movie
         - author:John Doe
       oneOf:
@@ -6567,7 +6568,8 @@ components:
 
         The same combination rules apply as for `facetFilters`.
       example:
-        - - inStock = 1
+        -
+          - inStock = 1
           - deliveryDate < 1441755506
         - price < 1000
       oneOf:
@@ -6713,11 +6715,13 @@ components:
         For more information, see [rectangular
         area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
       example:
-        - - 47.3165
+        -
+          - 47.3165
           - 4.9665
           - 47.3424
           - 5.0201
-        - - 40.9234
+        -
+          - 40.9234
           - 2.1185
           - 38.643
           - 1.9916
@@ -6751,13 +6755,15 @@ components:
 
         This parameter is ignored if you also specify `insideBoundingBox`.
       example:
-        - - 47.3165
+        -
+          - 47.3165
           - 4.9665
           - 47.3424
           - 5.0201
           - 47.32
           - 4.9
-        - - 40.9234
+        -
+          - 40.9234
           - 2.1185
           - 38.643
           - 1.9916

docs/bundled/query-suggestions.yml

@@ -3199,7 +3199,8 @@ components:
               type: string
         - type: 'null'
       example:
-        - - color
+        -
+          - color
           - brand
     External:
       description: >

docs/bundled/recommend.yml

@@ -3077,7 +3077,8 @@ components:
 
         `facet:\-value`.
       example:
-        - - category:Book
+        -
+          - category:Book
           - category:-Movie
         - author:John Doe
       oneOf:
@@ -3140,7 +3141,8 @@ components:
 
         The same combination rules apply as for `facetFilters`.
       example:
-        - - inStock = 1
+        -
+          - inStock = 1
           - deliveryDate < 1441755506
         - price < 1000
       oneOf:
@@ -3166,7 +3168,8 @@ components:
 
         The same combination and escaping rules apply as for `facetFilters`.
       example:
-        - - Book
+        -
+          - Book
           - Movie
         - SciFi
       oneOf:
@@ -3364,11 +3367,13 @@ components:
         For more information, see [rectangular
         area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
       example:
-        - - 47.3165
+        -
+          - 47.3165
           - 4.9665
           - 47.3424
           - 5.0201
-        - - 40.9234
+        -
+          - 40.9234
           - 2.1185
           - 38.643
           - 1.9916
@@ -3402,13 +3407,15 @@ components:
 
         This parameter is ignored if you also specify `insideBoundingBox`.
       example:
-        - - 47.3165
+        -
+          - 47.3165
           - 4.9665
           - 47.3424
           - 5.0201
           - 47.32
           - 4.9
-        - - 40.9234
+        -
+          - 40.9234
           - 2.1185
           - 38.643
           - 1.9916

docs/bundled/search.yml

@@ -19203,7 +19203,8 @@ components:
 
         `facet:\-value`.
       example:
-        - - category:Book
+        -
+          - category:Book
           - category:-Movie
         - author:John Doe
       oneOf:
@@ -19266,7 +19267,8 @@ components:
 
         The same combination rules apply as for `facetFilters`.
       example:
-        - - inStock = 1
+        -
+          - inStock = 1
           - deliveryDate < 1441755506
         - price < 1000
       oneOf:
@@ -19292,7 +19294,8 @@ components:
 
         The same combination and escaping rules apply as for `facetFilters`.
       example:
-        - - Book
+        -
+          - Book
           - Movie
         - SciFi
       oneOf:
@@ -19487,11 +19490,13 @@ components:
         For more information, see [rectangular
         area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
       example:
-        - - 47.3165
+        -
+          - 47.3165
           - 4.9665
           - 47.3424
           - 5.0201
-        - - 40.9234
+        -
+          - 40.9234
           - 2.1185
           - 38.643
           - 1.9916
@@ -19525,13 +19530,15 @@ components:
 
         This parameter is ignored if you also specify `insideBoundingBox`.
       example:
-        - - 47.3165
+        -
+          - 47.3165
           - 4.9665
           - 47.3424
           - 5.0201
           - 47.32
           - 4.9
-        - - 40.9234
+        -
+          - 40.9234
           - 2.1185
           - 38.643
           - 1.9916

scripts/cache.ts

@@ -7,23 +7,23 @@ import { exists } from './common.ts';
 export class Cache {
   folder: string;
   generatedFiles: string[];
-  filesToCache: string[];
+  dependencies: string[];
   cacheFile: string;
 
   constructor({
     folder,
     generatedFiles,
-    filesToCache,
+    dependencies,
     cacheFile,
   }: {
     folder: string;
     generatedFiles: string[];
-    filesToCache: string[];
+    dependencies: string[];
     cacheFile: string;
   }) {
     this.folder = folder;
     this.generatedFiles = generatedFiles;
-    this.filesToCache = filesToCache;
+    this.dependencies = dependencies;
     this.cacheFile = cacheFile;
   }
 
@@ -34,14 +34,14 @@ export class Cache {
       hash += (await hashElement(`${this.folder}/${generatedFile}`)).hash;
     }
 
-    for (const fileToCache of this.filesToCache) {
-      hash += (await hashElement(`${this.folder}/${fileToCache}`)).hash;
+    for (const dependency of this.dependencies) {
+      hash += (await hashElement(`${this.folder}/${dependency}`)).hash;
     }
 
     return hash;
   }
 
-  async isValid(): Promise<boolean> {
+  async hit(): Promise<boolean> {
     if (!(await exists(this.cacheFile))) {
       return false;
     }

scripts/common.ts

@@ -33,6 +33,7 @@ export const ROOT_DIR = path.resolve(process.cwd(), '..');
 export const GENERATORS = Object.entries(clientsConfig).reduce(
   (current, [language, opts]) => {
     if (typeof opts === 'string') {
+      // skip $schema
       return current;
     }
 
@@ -51,7 +52,6 @@ export const GENERATORS = Object.entries(clientsConfig).reduce(
       }
 
       current[key] = {
-        additionalProperties: {},
         ...opts,
         output,
         client: clientName,
@@ -61,7 +61,7 @@ export const GENERATORS = Object.entries(clientsConfig).reduce(
 
       // guess the package name for js from the output folder variable
       if (language === 'javascript') {
-        current[key].additionalProperties.packageName = output.substring(output.lastIndexOf('/') + 1);
+        current[key].packageName = output.substring(output.lastIndexOf('/') + 1);
       }
     }
 
@@ -153,11 +153,11 @@ async function buildCustomGenerators(): Promise<void> {
   const cache = new Cache({
     folder: toAbsolutePath('generators/'),
     generatedFiles: ['build/classes'],
-    filesToCache: ['src', 'build.gradle', 'settings.gradle', '../config/.java-version'],
+    dependencies: ['src', 'build.gradle', 'settings.gradle', '../config/.java-version'],
     cacheFile: toAbsolutePath('generators/.cache'),
   });
 
-  const cacheExists = await cache.isValid();
+  const cacheExists = await cache.hit();
 
   if (cacheExists) {
     spinner.succeed('job skipped, cache found for custom generators');

scripts/config.ts

@@ -1,7 +1,7 @@
 import clientsConfig from '../config/clients.config.json' with { type: 'json' };
 
-import { CI } from './common.ts';
-import type { Language, LanguageConfig } from './types.ts';
+import { CI, createClientName } from './common.ts';
+import type { Generator, Language, LanguageConfig } from './types.ts';
 
 export function getClientsConfigField(
   language: Language,
@@ -45,6 +45,10 @@ export function getTestOutputFolder(language: Language): string {
   return getClientsConfigField(language, ['tests', 'outputFolder']);
 }
 
+export function getSnippetFile(gen: Generator): string {
+  return `docs/snippets/${gen.language}/${gen.snippets.outputFolder}/${createClientName(gen.client, gen.language)}${gen.snippets.extension}`;
+}
+
 export function getDockerImage(language?: Language): string | undefined {
   if (CI || !language) {
     return undefined;

scripts/release/dart.ts

@@ -18,7 +18,7 @@ export async function updateDartPackages(changelog: string, nextVersion: string)
     }
 
     if (!nextVersion) {
-      throw new Error(`Failed to bump '${gen.packageName}'.`);
+      throw new Error(`Failed to bump '${gen.client}'.`);
     }
 
     let currentVersion = await getPubspecField(gen.output, 'version');

scripts/specs/format.ts

@@ -18,11 +18,11 @@ export async function lintCommon(useCache: boolean): Promise<void> {
   const cache = new Cache({
     folder: toAbsolutePath('specs/'),
     generatedFiles: [],
-    filesToCache: ['common'],
+    dependencies: ['common'],
     cacheFile: toAbsolutePath('specs/dist/common.cache'),
   });
 
-  if (useCache && (await cache.isValid())) {
+  if (useCache && (await cache.hit())) {
     spinner.succeed("job skipped, cache found for 'common' spec");
     return;
   }