feat(javascript): improve on task trigger type guards (#1286)

algolia · Feb 3, 2023 · dc5a22d · dc5a22d
1 parent dbc270d
commit dc5a22d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/specs/ingestion/common/schemas/task.yml b/specs/ingestion/common/schemas/task.yml
@@ -27,6 +27,7 @@ Task:
     - taskID
     - sourceID
     - destinationID
+    - trigger
     - enabled
     - action
     - createdAt

diff --git a/templates/javascript/clients/api-single.mustache b/templates/javascript/clients/api-single.mustache
@@ -7,6 +7,11 @@ export const apiClientVersion = '{{packageVersion}}';
 {{#operations}}
 {{> client/api/hosts}}
 
+
+{{#isIngestionClient}}
+  {{> client/api/guards}}
+{{/isIngestionClient}}
+
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function create{{capitalizedApiName}}({
     appId: appIdOption,
@@ -83,9 +88,6 @@ export function create{{capitalizedApiName}}({
     {{#isSearchClient}}
     {{> client/api/helpers}}
     {{/isSearchClient}}
-    {{#isIngestionClient}}
-    {{> client/api/guards}}
-    {{/isIngestionClient}}
     {{#operation}}
     {{> client/api/operation/jsdoc}}
     {{nickname}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}( {{> client/api/operation/parameters}} ) : Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}{{#vendorExtensions.x-is-generic}}<T>{{/vendorExtensions.x-is-generic}}> {

diff --git a/templates/javascript/clients/client/api/guards.mustache b/templates/javascript/clients/client/api/guards.mustache
@@ -5,33 +5,33 @@
  * @summary Guard method that returns a strongly typed specific OnDemandTrigger for a given Trigger.
  * @param trigger - The given Task Trigger.
  */
-isOnDemandTrigger(
+export function isOnDemandTrigger(
   trigger: Trigger
 ): trigger is OnDemandTrigger {
   return trigger.type === 'on_demand';
-},
+}
 
 /**
  * Guard: Return strongly typed specific ScheduleTrigger for a given Trigger.
  *
  * @summary Guard method that returns a strongly typed specific ScheduleTrigger for a given Trigger.
  * @param trigger - The given Task Trigger.
  */
-isScheduleTrigger(
+export function isScheduleTrigger(
   trigger: Trigger
 ): trigger is ScheduleTrigger {
   return trigger.type === 'schedule';
-},
+}
 
 /**
  * Guard: Return strongly typed specific SubscriptionTrigger for a given Trigger.
  *
  * @summary Guard method that returns a strongly typed specific SubscriptionTrigger for a given Trigger.
  * @param trigger - The given Task Trigger.
  */
-isSubscriptionTrigger(
+export function isSubscriptionTrigger(
   trigger: Trigger
 ): trigger is SubscriptionTrigger {
   return trigger.type === 'subscription';
-},
+}
 {{/isIngestionClient}}