fix(*): make distributionId optionnal

ScreebApp · Oct 15, 2024 · 4184b6b · 4184b6b
1 parent 3ffe822
commit 4184b6b
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 14 deletions.
diff --git a/packages/screeb-sdk-browser/docs/README.md b/packages/screeb-sdk-browser/docs/README.md
@@ -1057,7 +1057,7 @@ ___
 
 ### surveyStart
 
-▸ **surveyStart**(`surveyId`, `distributionId`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
+▸ **surveyStart**(`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -1066,7 +1066,7 @@ Starts a survey by its ID.
 | Name | Type | Default value |
 | :------ | :------ | :------ |
 | `surveyId` | `string` | `undefined` |
-| `distributionId` | `string` | `undefined` |
+| `distributionId?` | `string` | `undefined` |
 | `allowMultipleResponses` | `boolean` | `true` |
 | `hiddenFields` | [`PropertyRecord`](README.md#propertyrecord) | `{}` |
 | `hooks?` | [`HooksSurveyStart`](README.md#hookssurveystart) | `undefined` |

diff --git a/packages/screeb-sdk-browser/src/index.ts b/packages/screeb-sdk-browser/src/index.ts
@@ -447,7 +447,7 @@ export const surveyClose = () => callScreebCommand("survey.close");
  */
 export const surveyStart = (
   surveyId: string,
-  distributionId: string,
+  distributionId?: string,
   allowMultipleResponses = true,
   hiddenFields: PropertyRecord = {},
   hooks?: HooksSurveyStart,

diff --git a/packages/screeb-sdk-react/docs/README.md b/packages/screeb-sdk-react/docs/README.md
@@ -585,7 +585,7 @@ ___
 
 ### SurveyStartFunction
 
-Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `distributionId`: `string`, `allowMultipleResponses`: `boolean`, `hiddenFields`: `PropertyRecord`, `hooks?`: `HooksSurveyStart`, `language?`: `string`) => `Promise`\<`unknown`\>
+Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `distributionId?`: `string`, `allowMultipleResponses?`: `boolean`, `hiddenFields?`: `PropertyRecord`, `hooks?`: `HooksSurveyStart`, `language?`: `string`) => `Promise`\<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -607,16 +607,16 @@ surveyStart(
 
 #### Type declaration
 
-▸ (`surveyId`, `distributionId`, `allowMultipleResponses`, `hiddenFields`, `hooks?`, `language?`): `Promise`\<`unknown`\>
+▸ (`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `Promise`\<`unknown`\>
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `surveyId` | `string` |
-| `distributionId` | `string` |
-| `allowMultipleResponses` | `boolean` |
-| `hiddenFields` | `PropertyRecord` |
+| `distributionId?` | `string` |
+| `allowMultipleResponses?` | `boolean` |
+| `hiddenFields?` | `PropertyRecord` |
 | `hooks?` | `HooksSurveyStart` |
 | `language?` | `string` |
 

diff --git a/packages/screeb-sdk-react/src/provider.tsx b/packages/screeb-sdk-react/src/provider.tsx
@@ -197,9 +197,9 @@ export const ScreebProvider: React.FC<
   const surveyStart = React.useCallback(
     async (
       surveyId: string,
-      distributionId: string,
-      allowMultipleResponses: boolean,
-      hiddenFields: Screeb.PropertyRecord,
+      distributionId?: string,
+      allowMultipleResponses?: boolean,
+      hiddenFields?: Screeb.PropertyRecord,
       hooks?: Screeb.HooksSurveyStart,
       language?: string,
     ) =>

diff --git a/packages/screeb-sdk-react/src/types.ts b/packages/screeb-sdk-react/src/types.ts
@@ -346,9 +346,9 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  */
 export type SurveyStartFunction = (
   surveyId: string,
-  distributionId: string,
-  allowMultipleResponses: boolean,
-  hiddenFields: PropertyRecord,
+  distributionId?: string,
+  allowMultipleResponses?: boolean,
+  hiddenFields?: PropertyRecord,
   hooks?: HooksSurveyStart,
   language?: string,
 ) => Promise<unknown>;