diff --git a/docs/docs/transformers/system/int-phone.mdx b/docs/docs/transformers/system/int-phone.mdx index 68a176380f..7b1ef2f9c6 100644 --- a/docs/docs/transformers/system/int-phone.mdx +++ b/docs/docs/transformers/system/int-phone.mdx @@ -11,7 +11,7 @@ import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; diff --git a/docs/docs/transformers/system/random-int.mdx b/docs/docs/transformers/system/random-int.mdx index 2fd6265ed1..b2cdeaca75 100644 --- a/docs/docs/transformers/system/random-int.mdx +++ b/docs/docs/transformers/system/random-int.mdx @@ -11,7 +11,7 @@ import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; diff --git a/docs/docs/transformers/system/state.mdx b/docs/docs/transformers/system/state.mdx new file mode 100644 index 0000000000..1a68a8565a --- /dev/null +++ b/docs/docs/transformers/system/state.mdx @@ -0,0 +1,42 @@ +--- +title: State +id: state +hide_title: true +slug: /transformers/system/state +--- + +import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; + +import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; + + + +## Definition + +The state transformer generates a randomly selected US state. You can see the complete list of cities that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). + +If you'd rather not get back a real state value, you can use the [Random String Transformer](/transformers/system/random-string) to generate a random string value. + +## Configurations + +There are no configurations for the state transformer. + +## Examples + +Here are some examples of what an output state value may look like. + + diff --git a/docs/docs/transformers/system/street-address.mdx b/docs/docs/transformers/system/street-address.mdx new file mode 100644 index 0000000000..835163bf03 --- /dev/null +++ b/docs/docs/transformers/system/street-address.mdx @@ -0,0 +1,43 @@ +--- +title: Street Address +id: street-address +hide_title: true +slug: /transformers/system/street-address +--- + +import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; + +import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; + + + +## Definition + +The street address transformer generates a randomly selects a real street address that exists in the United States. You can see the complete list of street addresses that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). + +The street address transformer returns a valid United States address. For example: +`123 Main Street Boston` + +## Configurations + +There are no configurations for the street adddress transformer. + +## Examples + +Here are some examples of what an output street address value may look like. + + diff --git a/docs/docs/transformers/system/unix-ts.mdx b/docs/docs/transformers/system/unix-ts.mdx new file mode 100644 index 0000000000..f5c6ee9140 --- /dev/null +++ b/docs/docs/transformers/system/unix-ts.mdx @@ -0,0 +1,63 @@ +--- +title: Unix Timestamp +id: unix-ts +hide_title: true +slug: /transformers/system/unix-ts +--- + +import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; + +import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; + + + +## Definition + +The unix timestamp transformer randomly generates a unix timestamp in UTC timezone and returns back an int64 representation of that timestamp. + +By default, the generated timestamp will always be in the **past**. To generate a timestamp that is in the future, set the `alwaysFuture` config to true. + +## Configurations + +Depending on your validations, you may want to configure the output unix timestamp. The unix timestamp transformer has the following configuration options: + + + +## Examples + +Here are some examples of what an output state value may look like. + + diff --git a/docs/sidebars.js b/docs/sidebars.js index 5fb418371c..cb68490ba6 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -136,6 +136,11 @@ const sidebars = { id: 'transformers/system/string-phone', label: 'Phone (string)', }, + { + type: 'doc', + id: 'transformers/system/street-address', + label: 'Street Address', + }, { type: 'doc', id: 'transformers/system/city', @@ -146,6 +151,11 @@ const sidebars = { id: 'transformers/system/full-address', label: 'Full Address', }, + { + type: 'doc', + id: 'transformers/system/state', + label: 'State', + }, { type: 'doc', id: 'transformers/system/card-number', @@ -196,6 +206,11 @@ const sidebars = { id: 'transformers/system/random-string', label: 'Random String', }, + { + type: 'doc', + id: 'transformers/system/unix-ts', + label: 'Unix Timestamp', + }, ], }, { diff --git a/docs/src/theme/DocSidebarItem/Link/index.js b/docs/src/theme/DocSidebarItem/Link/index.js index fc7b8a5729..dcab715484 100644 --- a/docs/src/theme/DocSidebarItem/Link/index.js +++ b/docs/src/theme/DocSidebarItem/Link/index.js @@ -17,14 +17,16 @@ import { AiOutlineMail, AiOutlinePhone, } from 'react-icons/ai'; -import { BiLogoPostgresql, BiSolidCity } from 'react-icons/bi'; +import { BiLogoPostgresql, BiSolidCity, BiTimeFive } from 'react-icons/bi'; import { BsFunnel, BsGenderAmbiguous, BsShieldCheck } from 'react-icons/bs'; import { FaAws, FaDocker, FaRegAddressBook, FaRegAddressCard, + FaStreetView, } from 'react-icons/fa'; +import { GiTexas } from 'react-icons/gi'; import { GoCode } from 'react-icons/go'; import { GrMysql } from 'react-icons/gr'; import { IoBuildOutline } from 'react-icons/io5'; @@ -154,6 +156,12 @@ export const RenderIcon = (name) => { return ; case 'Random String': return ; + case 'State': + return ; + case 'Street Address': + return ; + case 'Unix Timestamp': + return ; default: return ; }