@tailor-platform/function-types 0.8.2 → 0.8.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/package.json +1 -1
- package/tailor.d.ts +34 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @tailor-platform/function-types
|
|
2
2
|
|
|
3
|
+
## 0.8.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#158](https://github.com/tailor-platform/function/pull/158) [`dc091f4`](https://github.com/tailor-platform/function/commit/dc091f48c30eef11304191af946c43b8f675ea37) Thanks [@k1LoW](https://github.com/k1LoW)! - Add optional `fromName` and `subject` params to `SendPasswordResetEmailInput`
|
|
8
|
+
|
|
9
|
+
## 0.8.3
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [#150](https://github.com/tailor-platform/function/pull/150) [`02134c6`](https://github.com/tailor-platform/function/commit/02134c6ce2014a7f82440650c4d4f9345be96f7b) Thanks [@k1LoW](https://github.com/k1LoW)! - Add `userByName` method to `tailor.idp.Client` for fetching a user by name
|
|
14
|
+
|
|
3
15
|
## 0.8.2
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/package.json
CHANGED
package/tailor.d.ts
CHANGED
|
@@ -363,6 +363,10 @@ declare namespace tailor.idp {
|
|
|
363
363
|
userId: string;
|
|
364
364
|
/** The URI to redirect to after password reset */
|
|
365
365
|
redirectUri: string;
|
|
366
|
+
/** The sender display name. Defaults to 'Tailor Platform IdP'. */
|
|
367
|
+
fromName?: string;
|
|
368
|
+
/** The email subject line. Defaults to the localized default subject. */
|
|
369
|
+
subject?: string;
|
|
366
370
|
}
|
|
367
371
|
|
|
368
372
|
/**
|
|
@@ -381,6 +385,11 @@ declare namespace tailor.idp {
|
|
|
381
385
|
*/
|
|
382
386
|
user(userId: string): Promise<User>;
|
|
383
387
|
|
|
388
|
+
/**
|
|
389
|
+
* Get a user by name.
|
|
390
|
+
*/
|
|
391
|
+
userByName(name: string): Promise<User>;
|
|
392
|
+
|
|
384
393
|
/**
|
|
385
394
|
* Create a new user.
|
|
386
395
|
*/
|
|
@@ -461,4 +470,29 @@ declare namespace tailor.workflow {
|
|
|
461
470
|
implementation.
|
|
462
471
|
*/
|
|
463
472
|
function triggerJobFunction(job_name: string, args?: any): any;
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* Suspends the current workflow execution and waits for an external signal to resume.
|
|
476
|
+
* The workflow will be parked in "Waiting" status until resolved via `resolve()`.
|
|
477
|
+
*
|
|
478
|
+
* @param key - A unique key identifying this wait point. Must match `^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$`.
|
|
479
|
+
* @param payload - Optional JSON-serializable payload persisted with the wait. Accessible by the resolve callback.
|
|
480
|
+
* @returns The result provided by the `resolve()` callback when the workflow resumes.
|
|
481
|
+
*/
|
|
482
|
+
function wait(key: string, payload?: any): any;
|
|
483
|
+
|
|
484
|
+
/**
|
|
485
|
+
* Resolves a waiting workflow execution, causing it to resume.
|
|
486
|
+
* The callback receives the wait payload and must return a JSON-serializable result
|
|
487
|
+
* that will be passed back to the `wait()` caller.
|
|
488
|
+
*
|
|
489
|
+
* @param executionId - The workflow execution ID to resolve
|
|
490
|
+
* @param key - The wait key that was used in the `wait()` call
|
|
491
|
+
* @param callback - A function that receives the wait payload and returns a result
|
|
492
|
+
*/
|
|
493
|
+
function resolve(
|
|
494
|
+
executionId: string,
|
|
495
|
+
key: string,
|
|
496
|
+
callback: (waitPayload: any) => any
|
|
497
|
+
): Promise<void>;
|
|
464
498
|
}
|