Merge branch 'main' into chore/stop-generation

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/action.ts

@@ -1,7 +1,6 @@
 /**
  * Type of operation.
  */
-
 export type Action =
   | 'addObject'
   | 'clear'

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/anchoring.ts

@@ -1,5 +1,4 @@
 /**
  * Whether the pattern parameter must match the beginning or the end of the query string, or both, or none.
  */
-
 export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/aroundRadius.ts

@@ -1,3 +1,6 @@
 import type { AroundRadiusAll } from './aroundRadiusAll';
 
+/**
+ * Define the maximum radius for a geo search (in meters).
+ */
 export type AroundRadius = AroundRadiusAll | number;

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/builtInOperationType.ts

@@ -1,7 +1,6 @@
 /**
  * The operation to apply on the attribute.
  */
-
 export type BuiltInOperationType =
   | 'Add'
   | 'AddUnique'

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/dictionaryAction.ts

@@ -1,5 +1,4 @@
 /**
  * Actions to perform.
  */
-
 export type DictionaryAction = 'addEntry' | 'deleteEntry';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/dictionaryEntryState.ts

@@ -1,5 +1,4 @@
 /**
  * The state of the dictionary entry.
  */
-
 export type DictionaryEntryState = 'disabled' | 'enabled';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/exactOnSingleWordQuery.ts

@@ -1,5 +1,4 @@
 /**
  * Controls how the exact ranking criterion is computed when the query contains only one word.
  */
-
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/indexSettings.ts

@@ -1,4 +1,7 @@
 import type { BaseIndexSettings } from './baseIndexSettings';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 
+/**
+ * The Algolia index settings.
+ */
 export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/matchLevel.ts

@@ -1,5 +1,4 @@
 /**
  * Indicates how well the attribute matched the search query.
  */
-
 export type MatchLevel = 'full' | 'none' | 'partial';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/multipleQueriesType.ts

@@ -1,5 +1,4 @@
 /**
  * Perform a search query with `default`, will search for facet values if `facet` is given.
  */
-
 export type MultipleQueriesType = 'default' | 'facet';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/operationType.ts

@@ -1,5 +1,4 @@
 /**
  * Type of operation to perform (move or copy).
  */
-
 export type OperationType = 'copy' | 'move';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/queryType.ts

@@ -1,5 +1,4 @@
 /**
  * Controls if and how query words are interpreted as prefixes.
  */
-
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/removeWordsIfNoResults.ts

@@ -1,7 +1,6 @@
 /**
  * Selects a strategy to remove words from the query when it doesn\'t match any hits.
  */
-
 export type RemoveWordsIfNoResults =
   | 'allOptional'
   | 'firstWords'

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/synonymType.ts

@@ -1,7 +1,6 @@
 /**
  * Type of the synonym object.
  */
-
 export type SynonymType =
   | 'altcorrection1'
   | 'altcorrection2'

clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/typoTolerance.ts

@@ -1,5 +1,4 @@
 /**
  * Controls whether typo tolerance is enabled and how it is applied.
  */
-
 export type TypoTolerance = 'false' | 'min' | 'strict' | 'true';

clients/algoliasearch-client-javascript/packages/client-insights/model/eventType.ts

@@ -1,5 +1,4 @@
 /**
  * An eventType can be a click, a conversion, or a view.
  */
-
 export type EventType = 'click' | 'conversion' | 'view';

clients/algoliasearch-client-javascript/packages/client-query-suggestions/model/logLevel.ts

@@ -1,5 +1,4 @@
 /**
  * Type of the record, can be one of three values (INFO, SKIP or ERROR).
  */
-
 export type LogLevel = 'ERROR' | 'INFO' | 'SKIP';

clients/algoliasearch-client-javascript/packages/client-search/model/action.ts

@@ -1,7 +1,6 @@
 /**
  * Type of operation.
  */
-
 export type Action =
   | 'addObject'
   | 'clear'

clients/algoliasearch-client-javascript/packages/client-search/model/anchoring.ts

@@ -1,5 +1,4 @@
 /**
  * Whether the pattern parameter must match the beginning or the end of the query string, or both, or none.
  */
-
 export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';

clients/algoliasearch-client-javascript/packages/client-search/model/aroundRadius.ts

@@ -1,3 +1,6 @@
 import type { AroundRadiusAll } from './aroundRadiusAll';
 
+/**
+ * Define the maximum radius for a geo search (in meters).
+ */
 export type AroundRadius = AroundRadiusAll | number;

clients/algoliasearch-client-javascript/packages/client-search/model/builtInOperationType.ts

@@ -1,7 +1,6 @@
 /**
  * The operation to apply on the attribute.
  */
-
 export type BuiltInOperationType =
   | 'Add'
   | 'AddUnique'

clients/algoliasearch-client-javascript/packages/client-search/model/dictionaryAction.ts

@@ -1,5 +1,4 @@
 /**
  * Actions to perform.
  */
-
 export type DictionaryAction = 'addEntry' | 'deleteEntry';

clients/algoliasearch-client-javascript/packages/client-search/model/dictionaryEntryState.ts

@@ -1,5 +1,4 @@
 /**
  * The state of the dictionary entry.
  */
-
 export type DictionaryEntryState = 'disabled' | 'enabled';

clients/algoliasearch-client-javascript/packages/client-search/model/exactOnSingleWordQuery.ts

@@ -1,5 +1,4 @@
 /**
  * Controls how the exact ranking criterion is computed when the query contains only one word.
  */
-
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

clients/algoliasearch-client-javascript/packages/client-search/model/indexSettings.ts

@@ -1,4 +1,7 @@
 import type { BaseIndexSettings } from './baseIndexSettings';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 
+/**
+ * The Algolia index settings.
+ */
 export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;

clients/algoliasearch-client-javascript/packages/client-search/model/matchLevel.ts

@@ -1,5 +1,4 @@
 /**
  * Indicates how well the attribute matched the search query.
  */
-
 export type MatchLevel = 'full' | 'none' | 'partial';

clients/algoliasearch-client-javascript/packages/client-search/model/multipleQueriesType.ts

@@ -1,5 +1,4 @@
 /**
  * Perform a search query with `default`, will search for facet values if `facet` is given.
  */
-
 export type MultipleQueriesType = 'default' | 'facet';

clients/algoliasearch-client-javascript/packages/client-search/model/operationType.ts

@@ -1,5 +1,4 @@
 /**
  * Type of operation to perform (move or copy).
  */
-
 export type OperationType = 'copy' | 'move';

clients/algoliasearch-client-javascript/packages/client-search/model/queryType.ts

@@ -1,5 +1,4 @@
 /**
  * Controls if and how query words are interpreted as prefixes.
  */
-
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

clients/algoliasearch-client-javascript/packages/client-search/model/removeWordsIfNoResults.ts

@@ -1,7 +1,6 @@
 /**
  * Selects a strategy to remove words from the query when it doesn\'t match any hits.
  */
-
 export type RemoveWordsIfNoResults =
   | 'allOptional'
   | 'firstWords'

clients/algoliasearch-client-javascript/packages/client-search/model/synonymType.ts

@@ -1,7 +1,6 @@
 /**
  * Type of the synonym object.
  */
-
 export type SynonymType =
   | 'altcorrection1'
   | 'altcorrection2'

clients/algoliasearch-client-javascript/packages/client-search/model/typoTolerance.ts

@@ -1,5 +1,4 @@
 /**
  * Controls whether typo tolerance is enabled and how it is applied.
  */
-
 export type TypoTolerance = 'false' | 'min' | 'strict' | 'true';

clients/algoliasearch-client-javascript/packages/client-sources/model/authenticationType.ts

@@ -1,5 +1,4 @@
 /**
  * The type of authentication to use.
  */
-
 export type AuthenticationType = 'basic';

clients/algoliasearch-client-javascript/packages/client-sources/model/method.ts

@@ -1,5 +1,4 @@
 /**
  * The HTTP method that will be used to fetch the URL.
  */
-
 export type Method = 'GET' | 'POST';

clients/algoliasearch-client-javascript/packages/client-sources/model/operationType.ts

@@ -1,5 +1,4 @@
 /**
  * The type of operation to execute.
  */
-
 export type OperationType = 'replace';

clients/algoliasearch-client-javascript/packages/client-sources/model/productType.ts

@@ -1,5 +1,4 @@
 /**
  * The product to target.
  */
-
 export type ProductType = 'search';

clients/algoliasearch-client-javascript/packages/client-sources/model/taskType.ts

@@ -1,5 +1,4 @@
 /**
  * The type of the task executed.
  */
-
 export type TaskType = 'csv';

clients/algoliasearch-client-javascript/packages/recommend/model/aroundRadius.ts

@@ -1,3 +1,6 @@
 import type { AroundRadiusAll } from './aroundRadiusAll';
 
+/**
+ * Define the maximum radius for a geo search (in meters).
+ */
 export type AroundRadius = AroundRadiusAll | number;

clients/algoliasearch-client-javascript/packages/recommend/model/exactOnSingleWordQuery.ts

@@ -1,5 +1,4 @@
 /**
  * Controls how the exact ranking criterion is computed when the query contains only one word.
  */
-
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

clients/algoliasearch-client-javascript/packages/recommend/model/matchLevel.ts

@@ -1,5 +1,4 @@
 /**
  * Indicates how well the attribute matched the search query.
  */
-
 export type MatchLevel = 'full' | 'none' | 'partial';

clients/algoliasearch-client-javascript/packages/recommend/model/queryType.ts

@@ -1,5 +1,4 @@
 /**
  * Controls if and how query words are interpreted as prefixes.
  */
-
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

clients/algoliasearch-client-javascript/packages/recommend/model/recommendationModels.ts

@@ -1,5 +1,4 @@
 /**
  * The recommendation model to use.
  */
-
 export type RecommendationModels = 'bought-together' | 'related-products';

clients/algoliasearch-client-javascript/packages/recommend/model/removeWordsIfNoResults.ts

@@ -1,7 +1,6 @@
 /**
  * Selects a strategy to remove words from the query when it doesn\'t match any hits.
  */
-
 export type RemoveWordsIfNoResults =
   | 'allOptional'
   | 'firstWords'

clients/algoliasearch-client-javascript/packages/recommend/model/trendingModels.ts

@@ -1,5 +1,4 @@
 /**
  * The trending model to use.
  */
-
 export type TrendingModels = 'trending-facets' | 'trending-items';

clients/algoliasearch-client-javascript/packages/recommend/model/typoTolerance.ts

@@ -1,5 +1,4 @@
 /**
  * Controls whether typo tolerance is enabled and how it is applied.
  */
-
 export type TypoTolerance = 'false' | 'min' | 'strict' | 'true';

templates/javascript/model.mustache

@@ -1,47 +1,29 @@
-{{#models}}
-{{#model}}
+{{#models}}{{#model}}
 {{#tsImports}}
 import { {{classname}} } from '{{filename}}';
 {{/tsImports}}
 
 {{! We handle types that depend on other interfaces }}
 {{#interfaces.size}}
-export type {{classname}} = {{#oneOf}}{{.}} {{^-last}}|{{/-last}} {{/oneOf}}{{#allOf}}{{.}} {{^-last}}&{{/-last}} {{/allOf}};
-{{/interfaces.size}}
-
-{{^interfaces}}
 {{#description}}
 /**
 * {{{description}}}
-*/
-{{/description}}
-{{^isEnum}}
-export type {{classname}} = {{#parent}} {{{.}}} & {{/parent}} {
-{{#vars}}
+*/{{/description}}
+export type {{classname}} = {{#oneOf}}{{{.}}} {{^-last}}|{{/-last}} {{/oneOf}}{{#allOf}}{{{.}}} {{^-last}}&{{/-last}} {{/allOf}};
+{{/interfaces.size}}{{^interfaces.size}}
 {{#description}}
+/**
+* {{{description}}}
+*/{{/description}}{{^isEnum}}
+export type {{classname}} = {{#parent}} {{{.}}} & {{/parent}} {
+{{#vars}}{{#description}}
     /**
     * {{{description}}}
-    */
-{{/description}}
-    {{name}}{{^required}}?{{/required}}: {{#isEnum}}{{classname}}{{{nameInCamelCase}}}{{#isArray}}[]{{/isArray}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}};
-{{/vars}}
+    */{{/description}}
+    {{name}}{{^required}}?{{/required}}: {{#isEnum}}{{classname}}{{{nameInCamelCase}}}{{#isArray}}[]{{/isArray}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}};{{/vars}}
 }
-
-{{#hasEnums}}
-{{#vars}}
-{{#isEnum}}
-export type {{classname}}{{nameInCamelCase}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}|{{/-last}}{{/enumVars}}{{/allowableValues}}
-
-{{/isEnum}}
-{{/vars}}
-{{/hasEnums}}
-{{/isEnum}}
-
-{{#isEnum}}
-export type {{classname}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}|{{/-last}}{{/enumVars}}{{/allowableValues}}
-
 {{/isEnum}}
+{{#hasEnums}}{{#vars}}{{#isEnum}}export type {{classname}}{{nameInCamelCase}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}|{{/-last}}{{/enumVars}}{{/allowableValues}}{{/isEnum}}{{/vars}}{{/hasEnums}}
+{{#isEnum}}export type {{classname}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}|{{/-last}}{{/enumVars}}{{/allowableValues}}{{/isEnum}}
 
-{{/interfaces}}
-{{/model}}
-{{/models}}
+{{/interfaces.size}}{{/model}}{{/models}}