Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(framework): Add disableOutputSanitization for Framework step options #700

Merged
merged 7 commits into from
Oct 9, 2024
Merged

docs(framework): Add disableOutputSanitization for Framework step options #700

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
411d903
docs: Add disableOutputSanitization example
rifont Sep 18, 2024
b182f29
docs: Fix typo in introduction.mdx
rifont Sep 18, 2024
98c8ee6
Update sdks/framework/typescript/steps/introduction.mdx
rifont Sep 18, 2024
9d75069
docs: update example for disableOutputSanitization
rifont Sep 18, 2024
86e9051
Merge branch 'nv-4300-introduce-disableoutputsanitization-step-option…
rifont Sep 18, 2024
afc2e36
docs: Update example code in introduction.mdx
rifont Sep 18, 2024
3fdb312
style: Fix spacing issue in introduction.mdx
rifont Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions sdks/framework/typescript/steps/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,31 @@ title: "Step Interface"
});
```
```typescript Skip
await step.email('stepId', resolver, {
await step.email('skipped-step', async () => ({
subject: 'Hello, world!',
body: 'My email message',
}), {
skip: async (controls) => true,
});
```
```typescript Disable Output Sanitization
await step.inApp(
'without-sanitization',
async () => ({
body: 'My in-app message',
data: {
link: '/pipeline/123?active=true&env=prod',
},
}),
{
// Prevent the `&` character in `data.link` from
// being converted to `&`
disableOutputSanitization: true,
}
);
```
```typescript Provider Overrides
await step.email('stepId', resolver, {
await step.email('provider-override', resolver, {
providers: {
slack: ({ controls, outputs }) => {
return {
Expand All @@ -38,7 +57,7 @@ title: "Step Interface"
});
```
```typescript Provider Passthrough
await step.email('stepId', resolver, {
await step.email('provider-passthrough', resolver, {
providers: {
sendgrid: ({ controls, outputs }) => {
return {
Expand Down Expand Up @@ -100,6 +119,10 @@ This is an optional configuration object that defines: [Controls Schema](/framew
This object used to access and override the underlying deliver providers SDKs. This is useful when you want to customize the content of the notification with properties that are unique to the provider.
</ResponseField>

<ResponseField name="disableOutputSanitization" type="boolean" default="false">
A flag to disable output sanitization for the step. This is useful when you want to return unescaped HTML content to the provider or the `<Inbox/>` component.
</ResponseField>

### Providers Overrides Object

This object used to access and override the underlying deliver providers SDKs. This is useful when you want to customize the content of the notification with properties that are unique to the provider.
Expand Down