Skip to content

Commit fc79811

Browse files
shortcutsshortcuts
authored
Merge branch 'main' into dependabot/npm_and_yarn/website/ua-parser-js-0.7.33
2 parents b58a4ad + 02c1abf commit fc79811

File tree

26 files changed

+278
-84
lines changed

26 files changed

+278
-84
lines changed

‎clients/algoliasearch-client-java-2/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## [4.0.0-SNAPSHOT](https://github.com/algolia/algoliasearch-client-java-2/compare/4.0.0-SNAPSHOT...4.0.0-SNAPSHOT)
22

3+
- [a1c7c245](https://github.com/algolia/api-clients-automation/commit/a1c7c245) fix(specs): correct types for Tasks trigger ([#1279](https://github.com/algolia/api-clients-automation/pull/1279)) by [@shortcuts](https://github.com/shortcuts/)
4+
5+
## [4.0.0-SNAPSHOT](https://github.com/algolia/algoliasearch-client-java-2/compare/4.0.0-SNAPSHOT...4.0.0-SNAPSHOT)
6+
37
- [aed20fe6](https://github.com/algolia/api-clients-automation/commit/aed20fe6) feat(specs): add more descriptions to the Ingestion API ([#1273](https://github.com/algolia/api-clients-automation/pull/1273)) by [@shortcuts](https://github.com/shortcuts/)
48
- [3739451a](https://github.com/algolia/api-clients-automation/commit/3739451a) fix(specs): add query params for observability ([#1277](https://github.com/algolia/api-clients-automation/pull/1277)) by [@millotp](https://github.com/millotp/)
59
- [859c0a97](https://github.com/algolia/api-clients-automation/commit/859c0a97) feat(specs): source update changes ([#1276](https://github.com/algolia/api-clients-automation/pull/1276)) by [@mehmetaligok](https://github.com/mehmetaligok/)

‎clients/algoliasearch-client-javascript/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## [5.0.0-alpha.40](https://github.com/algolia/algoliasearch-client-javascript/compare/5.0.0-alpha.39...5.0.0-alpha.40)
2+
3+
- [91f21487](https://github.com/algolia/api-clients-automation/commit/91f21487) feat(javascript): add task trigger type guards ([#1280](https://github.com/algolia/api-clients-automation/pull/1280)) by [@Fluf22](https://github.com/Fluf22/)
4+
- [a1c7c245](https://github.com/algolia/api-clients-automation/commit/a1c7c245) fix(specs): correct types for Tasks trigger ([#1279](https://github.com/algolia/api-clients-automation/pull/1279)) by [@shortcuts](https://github.com/shortcuts/)
5+
16
## [5.0.0-alpha.39](https://github.com/algolia/algoliasearch-client-javascript/compare/5.0.0-alpha.38...5.0.0-alpha.39)
27

38
- [aed20fe6](https://github.com/algolia/api-clients-automation/commit/aed20fe6) feat(specs): add more descriptions to the Ingestion API ([#1273](https://github.com/algolia/api-clients-automation/pull/1273)) by [@shortcuts](https://github.com/shortcuts/)

‎clients/algoliasearch-client-javascript/packages/client-common/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@algolia/client-common",
3-
"version": "5.0.0-alpha.39",
3+
"version": "5.0.0-alpha.40",
44
"description": "Common package for the Algolia JavaScript API client.",
55
"repository": "algolia/algoliasearch-client-javascript",
66
"license": "MIT",

‎clients/algoliasearch-client-javascript/packages/ingestion/model/index.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ export * from './listEventsResponse';
3737
export * from './listSourcesResponse';
3838
export * from './listTasksResponse';
3939
export * from './methodType';
40+
export * from './onDemandTrigger';
41+
export * from './onDemandTriggerType';
4042
export * from './pagination';
4143
export * from './platform';
4244
export * from './platformNone';
@@ -50,6 +52,7 @@ export * from './runStatus';
5052
export * from './runType';
5153
export * from './scheduleTrigger';
5254
export * from './scheduleTriggerInput';
55+
export * from './scheduleTriggerType';
5356
export * from './source';
5457
export * from './sourceBigCommerce';
5558
export * from './sourceCommercetools';
@@ -64,12 +67,12 @@ export * from './sourceUpdateCommercetools';
6467
export * from './sourceUpdateInput';
6568
export * from './sourceUpdateJson';
6669
export * from './sourceUpdateResponse';
70+
export * from './subscriptionTrigger';
6771
export * from './task';
6872
export * from './taskCreate';
6973
export * from './taskCreateResponse';
7074
export * from './taskCreateTrigger';
7175
export * from './taskSearch';
72-
export * from './taskTrigger';
7376
export * from './taskUpdate';
7477
export * from './taskUpdateResponse';
7578
export * from './trigger';

‎clients/algoliasearch-client-javascript/packages/ingestion/model/onDemandTrigger.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2+
3+
import type { OnDemandTriggerType } from './onDemandTriggerType';
4+
5+
/**
6+
* The trigger information of a task of type `on-demand`.
7+
*/
8+
export type OnDemandTrigger = {
9+
type: OnDemandTriggerType;
10+
11+
/**
12+
* The last time the scheduled task ran.
13+
*/
14+
lastRun?: string;
15+
};

‎clients/algoliasearch-client-javascript/packages/ingestion/model/onDemandTriggerType.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2+
3+
/**
4+
* A task which is manually executed via the run task endpoint.
5+
*/
6+
export type OnDemandTriggerType = 'on_demand';

‎clients/algoliasearch-client-javascript/packages/ingestion/model/scheduleTrigger.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
22

3-
import type { TriggerType } from './triggerType';
3+
import type { ScheduleTriggerType } from './scheduleTriggerType';
44

55
/**
66
* The trigger information for a task of type \'schedule\'.
77
*/
88
export type ScheduleTrigger = {
9-
type: TriggerType;
9+
type: ScheduleTriggerType;
1010

1111
/**
1212
* A cron expression that represent at which regularity the task should run.
@@ -16,7 +16,7 @@ export type ScheduleTrigger = {
1616
/**
1717
* The last time the scheduled task ran.
1818
*/
19-
lastRun: string;
19+
lastRun?: string;
2020

2121
/**
2222
* The next scheduled run of the task.

‎clients/algoliasearch-client-javascript/packages/ingestion/model/scheduleTriggerInput.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
22

3-
import type { TriggerType } from './triggerType';
3+
import type { ScheduleTriggerType } from './scheduleTriggerType';
44

55
/**
66
* The trigger input for a task of type \'schedule\'.
77
*/
88
export type ScheduleTriggerInput = {
9-
type: TriggerType;
9+
type: ScheduleTriggerType;
1010

1111
/**
1212
* A cron expression that represent at which regularity the task should run.

‎clients/algoliasearch-client-javascript/packages/ingestion/model/scheduleTriggerType.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2+
3+
/**
4+
* A task which is triggered by a schedule (cron expression).
5+
*/
6+
export type ScheduleTriggerType = 'schedule';

‎clients/algoliasearch-client-javascript/packages/ingestion/model/subscriptionTrigger.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
2+
3+
import type { TriggerType } from './triggerType';
4+
5+
/**
6+
* The trigger input for a task of type \'subscription\'.
7+
*/
8+
export type SubscriptionTrigger = {
9+
type: TriggerType;
10+
};

‎clients/algoliasearch-client-javascript/packages/ingestion/model/task.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
22

33
import type { ActionType } from './actionType';
4-
import type { TaskTrigger } from './taskTrigger';
4+
import type { Trigger } from './trigger';
55

66
export type Task = {
77
/**
@@ -19,7 +19,7 @@ export type Task = {
1919
*/
2020
destinationID: string;
2121

22-
trigger?: TaskTrigger;
22+
trigger?: Trigger;
2323

2424
/**
2525
* Whether the task is enabled or not.

‎clients/algoliasearch-client-javascript/packages/ingestion/model/taskTrigger.ts

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎clients/algoliasearch-client-javascript/packages/ingestion/model/trigger.ts

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
22

3-
import type { TriggerType } from './triggerType';
3+
import type { OnDemandTrigger } from './onDemandTrigger';
4+
import type { ScheduleTrigger } from './scheduleTrigger';
5+
import type { SubscriptionTrigger } from './subscriptionTrigger';
46

5-
/**
6-
* The trigger information of a task.
7-
*/
8-
export type Trigger = {
9-
type: TriggerType;
10-
};
7+
export type Trigger = OnDemandTrigger | ScheduleTrigger | SubscriptionTrigger;

‎clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,23 @@ import type { ListDestinationsResponse } from '../model/listDestinationsResponse
5757
import type { ListEventsResponse } from '../model/listEventsResponse';
5858
import type { ListSourcesResponse } from '../model/listSourcesResponse';
5959
import type { ListTasksResponse } from '../model/listTasksResponse';
60+
import type { OnDemandTrigger } from '../model/onDemandTrigger';
6061
import type { Run } from '../model/run';
6162
import type { RunListResponse } from '../model/runListResponse';
6263
import type { RunResponse } from '../model/runResponse';
64+
import type { ScheduleTrigger } from '../model/scheduleTrigger';
6365
import type { Source } from '../model/source';
6466
import type { SourceCreate } from '../model/sourceCreate';
6567
import type { SourceCreateResponse } from '../model/sourceCreateResponse';
6668
import type { SourceSearch } from '../model/sourceSearch';
6769
import type { SourceUpdateResponse } from '../model/sourceUpdateResponse';
70+
import type { SubscriptionTrigger } from '../model/subscriptionTrigger';
6871
import type { Task } from '../model/task';
6972
import type { TaskCreate } from '../model/taskCreate';
7073
import type { TaskCreateResponse } from '../model/taskCreateResponse';
7174
import type { TaskSearch } from '../model/taskSearch';
7275
import type { TaskUpdateResponse } from '../model/taskUpdateResponse';
76+
import type { Trigger } from '../model/trigger';
7377

7478
export const apiClientVersion = '1.0.0-alpha.13';
7579

@@ -149,6 +153,36 @@ export function createIngestionClient({
149153
transporter.algoliaAgent.add({ segment, version });
150154
},
151155

156+
/**
157+
* Guard: Return strongly typed specific OnDemandTrigger for a given Trigger.
158+
*
159+
* @summary Guard method that returns a strongly typed specific OnDemandTrigger for a given Trigger.
160+
* @param trigger - The given Task Trigger.
161+
*/
162+
isOnDemandTrigger(trigger: Trigger): trigger is OnDemandTrigger {
163+
return trigger.type === 'on_demand';
164+
},
165+
166+
/**
167+
* Guard: Return strongly typed specific ScheduleTrigger for a given Trigger.
168+
*
169+
* @summary Guard method that returns a strongly typed specific ScheduleTrigger for a given Trigger.
170+
* @param trigger - The given Task Trigger.
171+
*/
172+
isScheduleTrigger(trigger: Trigger): trigger is ScheduleTrigger {
173+
return trigger.type === 'schedule';
174+
},
175+
176+
/**
177+
* Guard: Return strongly typed specific SubscriptionTrigger for a given Trigger.
178+
*
179+
* @summary Guard method that returns a strongly typed specific SubscriptionTrigger for a given Trigger.
180+
* @param trigger - The given Task Trigger.
181+
*/
182+
isSubscriptionTrigger(trigger: Trigger): trigger is SubscriptionTrigger {
183+
return trigger.type === 'subscription';
184+
},
185+
152186
/**
153187
* Create a authentication.
154188
*

‎clients/algoliasearch-client-javascript/packages/requester-browser-xhr/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@algolia/requester-browser-xhr",
3-
"version": "5.0.0-alpha.39",
3+
"version": "5.0.0-alpha.40",
44
"description": "Promise-based request library for browser using xhr.",
55
"repository": "algolia/algoliasearch-client-javascript",
66
"license": "MIT",
@@ -19,7 +19,7 @@
1919
"test": "jest"
2020
},
2121
"dependencies": {
22-
"@algolia/client-common": "5.0.0-alpha.39"
22+
"@algolia/client-common": "5.0.0-alpha.40"
2323
},
2424
"devDependencies": {
2525
"@types/jest": "28.1.8",

‎clients/algoliasearch-client-javascript/packages/requester-fetch/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@algolia/requester-fetch",
3-
"version": "5.0.0-alpha.39",
3+
"version": "5.0.0-alpha.40",
44
"description": "Promise-based request library using Fetch.",
55
"repository": "algolia/algoliasearch-client-javascript",
66
"license": "MIT",
@@ -19,7 +19,7 @@
1919
"test": "jest"
2020
},
2121
"dependencies": {
22-
"@algolia/client-common": "5.0.0-alpha.39"
22+
"@algolia/client-common": "5.0.0-alpha.40"
2323
},
2424
"devDependencies": {
2525
"@types/jest": "28.1.8",

‎clients/algoliasearch-client-javascript/packages/requester-node-http/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@algolia/requester-node-http",
3-
"version": "5.0.0-alpha.39",
3+
"version": "5.0.0-alpha.40",
44
"description": "Promise-based request library for node using the native http module.",
55
"repository": "algolia/algoliasearch-client-javascript",
66
"license": "MIT",
@@ -19,7 +19,7 @@
1919
"test": "jest"
2020
},
2121
"dependencies": {
22-
"@algolia/client-common": "5.0.0-alpha.39"
22+
"@algolia/client-common": "5.0.0-alpha.40"
2323
},
2424
"devDependencies": {
2525
"@types/jest": "28.1.8",

‎clients/algoliasearch-client-php/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## [4.0.0-alpha.39](https://github.com/algolia/algoliasearch-client-php/compare/4.0.0-alpha.38...4.0.0-alpha.39)
2+
3+
- [a1c7c245](https://github.com/algolia/api-clients-automation/commit/a1c7c245) fix(specs): correct types for Tasks trigger ([#1279](https://github.com/algolia/api-clients-automation/pull/1279)) by [@shortcuts](https://github.com/shortcuts/)
4+
15
## [4.0.0-alpha.38](https://github.com/algolia/algoliasearch-client-php/compare/4.0.0-alpha.37...4.0.0-alpha.38)
26

37
- [aed20fe6](https://github.com/algolia/api-clients-automation/commit/aed20fe6) feat(specs): add more descriptions to the Ingestion API ([#1273](https://github.com/algolia/api-clients-automation/pull/1273)) by [@shortcuts](https://github.com/shortcuts/)

‎config/clients.config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"folder": "clients/algoliasearch-client-javascript",
1616
"npmNamespace": "@algolia",
1717
"gitRepoId": "algoliasearch-client-javascript",
18-
"utilsPackageVersion": "5.0.0-alpha.39",
18+
"utilsPackageVersion": "5.0.0-alpha.40",
1919
"modelFolder": "model",
2020
"apiFolder": "src",
2121
"customGenerator": "algolia-javascript",
@@ -27,7 +27,7 @@
2727
"php": {
2828
"folder": "clients/algoliasearch-client-php",
2929
"gitRepoId": "algoliasearch-client-php",
30-
"packageVersion": "4.0.0-alpha.38",
30+
"packageVersion": "4.0.0-alpha.39",
3131
"modelFolder": "lib/Model",
3232
"customGenerator": "algolia-php",
3333
"apiFolder": "lib/Api",

‎config/openapitools.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,63 +6,63 @@
66
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/algoliasearch",
77
"reservedWordsMappings": "queryParameters=queryParameters,requestOptions=requestOptions,delete=delete",
88
"additionalProperties": {
9-
"packageVersion": "5.0.0-alpha.39"
9+
"packageVersion": "5.0.0-alpha.40"
1010
}
1111
},
1212
"javascript-search": {
1313
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-search",
1414
"reservedWordsMappings": "queryParameters=queryParameters,requestOptions=requestOptions,delete=delete",
1515
"additionalProperties": {
16-
"packageVersion": "5.0.0-alpha.39"
16+
"packageVersion": "5.0.0-alpha.40"
1717
}
1818
},
1919
"javascript-recommend": {
2020
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/recommend",
2121
"reservedWordsMappings": "queryParameters=queryParameters,delete=delete",
2222
"additionalProperties": {
23-
"packageVersion": "5.0.0-alpha.39"
23+
"packageVersion": "5.0.0-alpha.40"
2424
}
2525
},
2626
"javascript-personalization": {
2727
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-personalization",
2828
"additionalProperties": {
29-
"packageVersion": "5.0.0-alpha.39"
29+
"packageVersion": "5.0.0-alpha.40"
3030
}
3131
},
3232
"javascript-analytics": {
3333
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-analytics",
3434
"additionalProperties": {
35-
"packageVersion": "5.0.0-alpha.39"
35+
"packageVersion": "5.0.0-alpha.40"
3636
}
3737
},
3838
"javascript-insights": {
3939
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-insights",
4040
"additionalProperties": {
41-
"packageVersion": "5.0.0-alpha.39"
41+
"packageVersion": "5.0.0-alpha.40"
4242
}
4343
},
4444
"javascript-abtesting": {
4545
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-abtesting",
4646
"additionalProperties": {
47-
"packageVersion": "5.0.0-alpha.39"
47+
"packageVersion": "5.0.0-alpha.40"
4848
}
4949
},
5050
"javascript-query-suggestions": {
5151
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-query-suggestions",
5252
"additionalProperties": {
53-
"packageVersion": "5.0.0-alpha.39"
53+
"packageVersion": "5.0.0-alpha.40"
5454
}
5555
},
5656
"javascript-predict": {
5757
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/predict",
5858
"additionalProperties": {
59-
"packageVersion": "1.0.0-alpha.39"
59+
"packageVersion": "1.0.0-alpha.40"
6060
}
6161
},
6262
"javascript-ingestion": {
6363
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/ingestion",
6464
"additionalProperties": {
65-
"packageVersion": "1.0.0-alpha.13"
65+
"packageVersion": "1.0.0-alpha.14"
6666
}
6767
},
6868
"java-search": {

‎generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ private void setDefaultGeneratorOptions() {
119119
additionalProperties.put("algoliaAgent", Utils.capitalize(CLIENT));
120120
additionalProperties.put("gitRepoId", "algoliasearch-client-javascript");
121121
additionalProperties.put("isSearchClient", CLIENT.equals("search"));
122-
additionalProperties.put("useAlgoliaUA", !CLIENT.equals("ingestion"));
122+
additionalProperties.put("isIngestionClient", CLIENT.equals("ingestion"));
123123
additionalProperties.put("isAlgoliasearchClient", isAlgoliasearchClient);
124124

125125
if (isAlgoliasearchClient) {

0 commit comments

Comments
 (0)