Merge pull request #992 from EltonLobo07/doc/add-rawTransformAsync

add `rawTransformAsync` API reference

website/src/routes/api/(actions)/rawCheck/AddIssue/index.mdx

@@ -1,5 +1,5 @@
 ---
-title: AddIssue
+title: AddIssue (rawCheck)
 description: Add issue type.
 contributors:
   - EltonLobo07

website/src/routes/api/(actions)/rawCheck/Context/index.mdx

@@ -1,5 +1,5 @@
 ---
-title: Context
+title: Context (rawCheck)
 description: Context type.
 contributors:
   - EltonLobo07

website/src/routes/api/(actions)/rawCheck/IssueInfo/index.mdx

@@ -1,5 +1,5 @@
 ---
-title: IssueInfo
+title: IssueInfo (rawCheck)
 description: Issue info type.
 contributors:
   - EltonLobo07

website/src/routes/api/(actions)/rawTransform/AddIssue/index.mdx

@@ -0,0 +1,21 @@
+---
+title: AddIssue (rawTransform)
+description: Add issue type.
+contributors:
+  - EltonLobo07
+---
+
+import { Property } from '~/components';
+import { properties } from './properties';
+
+# AddIssue
+
+Add issue type.
+
+## Generics
+
+- `TInput` <Property {...properties.TInput} />
+
+## Definition
+
+- `AddIssue` <Property {...properties.AddIssue} />

website/src/routes/api/(actions)/rawTransform/AddIssue/properties.ts

@@ -0,0 +1,31 @@
+import type { PropertyProps } from '~/components';
+
+export const properties: Record<string, PropertyProps> = {
+  TInput: {
+    modifier: 'extends',
+    type: 'any',
+  },
+  AddIssue: {
+    type: {
+      type: 'function',
+      params: [
+        {
+          name: 'info',
+          optional: true,
+          type: {
+            type: 'custom',
+            name: 'IssueInfo',
+            href: '../IssueInfo/',
+            generics: [
+              {
+                type: 'custom',
+                name: 'TInput',
+              },
+            ],
+          },
+        },
+      ],
+      return: 'void',
+    },
+  },
+};

website/src/routes/api/(actions)/rawTransform/Context/index.mdx

@@ -0,0 +1,25 @@
+---
+title: Context (rawTransform)
+description: Context type.
+contributors:
+  - EltonLobo07
+---
+
+import { Property } from '~/components';
+import { properties } from './properties';
+
+# Context
+
+Context type.
+
+## Generics
+
+- `TInput` <Property {...properties.TInput} />
+
+## Definition
+
+- `Context`
+  - `dataset` <Property {...properties.dataset} />
+  - `config` <Property {...properties.config} />
+  - `addIssue` <Property {...properties.addIssue} />
+  - `NEVER` <Property {...properties.NEVER} />

website/src/routes/api/(actions)/rawTransform/Context/properties.ts

@@ -0,0 +1,57 @@
+import type { PropertyProps } from '~/components';
+
+export const properties: Record<string, PropertyProps> = {
+  TInput: {
+    modifier: 'extends',
+    type: 'any',
+  },
+  dataset: {
+    type: {
+      type: 'custom',
+      name: 'SuccessDataset',
+      href: '../../SuccessDataset/',
+      generics: [
+        {
+          type: 'custom',
+          name: 'TInput',
+        },
+      ],
+    },
+  },
+  config: {
+    type: {
+      type: 'custom',
+      name: 'Config',
+      href: '../../Config/',
+      generics: [
+        {
+          type: 'custom',
+          name: 'RawTransformIssue',
+          href: '../../RawTransformIssue/',
+          generics: [
+            {
+              type: 'custom',
+              name: 'TInput',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  addIssue: {
+    type: {
+      type: 'custom',
+      name: 'AddIssue',
+      href: '../AddIssue/',
+      generics: [
+        {
+          type: 'custom',
+          name: 'TInput',
+        },
+      ],
+    },
+  },
+  NEVER: {
+    type: 'never',
+  },
+};

website/src/routes/api/(actions)/rawTransform/IssueInfo/index.mdx

@@ -0,0 +1,27 @@
+---
+title: IssueInfo (rawTransform)
+description: Issue info type.
+contributors:
+  - EltonLobo07
+---
+
+import { Property } from '~/components';
+import { properties } from './properties';
+
+# IssueInfo
+
+Issue info type.
+
+## Generics
+
+- `TInput` <Property {...properties.TInput} />
+
+## Definition
+
+- `IssueInfo`
+  - `label` <Property {...properties.label} />
+  - `input` <Property {...properties.input} />
+  - `expected` <Property {...properties.expected} />
+  - `received` <Property {...properties.received} />
+  - `message` <Property {...properties.message} />
+  - `path` <Property {...properties.path} />

website/src/routes/api/(actions)/rawTransform/IssueInfo/properties.ts

@@ -0,0 +1,91 @@
+import type { PropertyProps } from '~/components';
+
+export const properties: Record<string, PropertyProps> = {
+  TInput: {
+    modifier: 'extends',
+    type: 'any',
+  },
+  kind: {
+    type: {
+      type: 'string',
+      value: 'metadata',
+    },
+  },
+  label: {
+    type: {
+      type: 'union',
+      options: ['string', 'undefined'],
+    },
+  },
+  input: {
+    type: {
+      type: 'union',
+      options: ['unknown', 'undefined'],
+    },
+  },
+  expected: {
+    type: {
+      type: 'union',
+      options: ['string', 'undefined'],
+    },
+  },
+  received: {
+    type: {
+      type: 'union',
+      options: ['string', 'undefined'],
+    },
+  },
+  message: {
+    type: {
+      type: 'union',
+      options: [
+        {
+          type: 'custom',
+          name: 'ErrorMessage',
+          href: '../../ErrorMessage/',
+          generics: [
+            {
+              type: 'custom',
+              name: 'RawTransformIssue',
+              href: '../../RawTransformIssue/',
+              generics: [
+                {
+                  type: 'custom',
+                  name: 'TInput',
+                },
+              ],
+            },
+          ],
+        },
+        'undefined',
+      ],
+    },
+  },
+  path: {
+    type: {
+      type: 'union',
+      options: [
+        {
+          type: 'tuple',
+          items: [
+            {
+              type: 'custom',
+              name: 'IssuePathItem',
+              href: '../../IssuePathItem/',
+            },
+            {
+              type: 'array',
+              item: {
+                type: 'custom',
+                name: 'IssuePathItem',
+                href: '../../IssuePathItem/',
+              },
+              spread: true,
+            },
+          ],
+        },
+        'undefined',
+      ],
+    },
+  },
+};