Add readme

samples/react-zod/README.md

@@ -1,73 +1,140 @@
-# react-zod
+# Zod
 
 ## Summary
 
-Short summary on functionality and used technologies.
+This sample shows the usage of [Zod](https://zod.dev/) to eliminate manual cast and validation of the data coming from external API (e.g. SharePoint REST API, Graph API, etc.).
 
-[picture of the solution in action, if possible]
+I have a `Form Results` list that has these columns:
+Column|Type
+-------|----
+Title|Single line of text
+Description|Multiple lines of text
+Qty|Number (> 0)
+Rating|Number (1 - 10)
+Email|Single line of text
+Status|Choice
+PublishDate|Date
+Contact|Person
 
-## Used SharePoint Framework Version
+When we get list items data from SharePoint REST API. It would be better to have fully typed data to eliminate runtime error and also make it easier to process the data in TypeScript. 
 
-![version](https://img.shields.io/badge/version-1.13-green.svg)
+So I used [Zod](https://zod.dev/) to automatically cast and validate type of the data.
+
+Below is example on how to setup the schema for my data above ([Model.ts](/src/webparts/reactZod/utils/Models.ts)):
+![Schema](assets/schema.png)
+
+We can also generate TypeScript [Type](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html) from the schema (See `FormResultModel` and `FormResultsModel`).
+
+Below is how to cast and validate data based on the schema ([SharePointHelper.ts](/src/webparts/reactZod/utils/SharePointHelper.ts)):
+![Parse Data](assets/parse-data.png)
+
+That line of code will do the following:
+- Cast
+  - `Id` as number
+  - `Title` as string
+  - `Description` as string
+  - `IsActive` as boolean
+  - `Qty` as number
+  - `Rating` as number
+  - `Email` as string
+  - `Status` as string
+  - `PublishDate` as string
+  - `Contact` as object
+- Validate
+  - `Qty` should be non negative
+  - `Rating` should be between 1 - 10
+  - `Email` should be valid email
+  - `Status` should be "Active", "Done", or "Rejected"
+- Transform
+  - `PublishDate` to be DateTime
+  - `Contact` to be Contact.Title value from API
+
+Below is the result type from the parse operation:
+![Result](assets/result.png)
+
+When it's failed to parse (wrong type or not pass validation), it will throw error.
+In this example I just simple render error message when it happens.
+![Failed parse](assets/failed-parse.png)
+
+In this example, I used the parsed result data to be displayed on a [DetailsList](https://developer.microsoft.com/en-us/fluentui#/controls/web/detailslist) component
+![Data usage](assets/data-usage.png)
+
+## Compatibility
+
+![SPFx 1.15.2](https://img.shields.io/badge/SPFx-1.15.2-green.svg)
+![Node.js v14 | v16](https://img.shields.io/badge/Node.js-v14%20%7C%20v16-green.svg)
+![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
 
 ## Applies to
 
-- [SharePoint Framework](https://aka.ms/spfx)
-- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
+* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
+* [Microsoft 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
 
 > Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
 
-## Prerequisites
-
-> Any special pre-requisites?
-
 ## Solution
 
-| Solution    | Author(s)                                               |
-| ----------- | ------------------------------------------------------- |
-| folder name | Author details (name, company, twitter alias with link) |
+Solution|Author(s)
+--------|---------
+react-zod | [Ari Gunawan](https://github.com/AriGunawan) ([@arigunawan3023](https://twitter.com/arigunawan3023))
 
 ## Version history
 
-| Version | Date             | Comments        |
-| ------- | ---------------- | --------------- |
-| 1.1     | March 10, 2021   | Update comment  |
-| 1.0     | January 29, 2021 | Initial release |
+Version|Date|Comments
+-------|----|--------
+1.0|October 15, 2022|Initial release
+
+## Prerequisites
+
+Create a `Form Results` list that has these columns:
+Column|Type
+-------|----
+Title|Single line of text
+Description|Multiple lines of text
+Qty|Number (> 0)
+Rating|Number (1 - 10)
+Email|Single line of text
+Status|Choice
+PublishDate|Date
+Contact|Person
+
+## Minimal path to awesome
+
+* Clone this repository (or [download this solution as a .ZIP file](https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-zod) then unzip it)
+* From your command line, change your current directory to the directory containing this sample (`react-zod`, located under `samples`)
+* in the command line run:
+  * `npm install`
+  * `gulp serve`
+
+
+<!--
+RESERVED FOR REPO MAINTAINERS
+
+We'll add the video from the community call recording here
+
+## Video
+
+[![YouTube video title](./assets/video-thumbnail.jpg)](https://www.youtube.com/watch?v=XXXXX "YouTube video title")
+-->
+
+## Help
+
+We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for  community members to volunteer their time and help resolve issues.
+
+If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
+
+You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20react-zod%22) to see if anybody else is having the same issues.
+
+You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=react-zod) and see what the community is saying.
+
+If you encounter any issues using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20react-zod&template=bug-report.yml&sample=react-zod&authors=@AriGunawan&title=react-zod%20-%20).
+
+For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20react-zod&template=question.yml&sample=react-zod&authors=@AriGunawan&title=react-zod%20-%20).
+
+Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20react-zod&template=suggestion.yml&sample=react-zod&authors=@AriGunawan&title=react-zod%20-%20).
 
 ## Disclaimer
 
-**THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
+**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
 
----
-
-## Minimal Path to Awesome
-
-- Clone this repository
-- Ensure that you are at the solution folder
-- in the command-line run:
-  - **npm install**
-  - **gulp serve**
-
-> Include any additional steps as needed.
-
-## Features
-
-Description of the extension that expands upon high-level summary above.
-
-This extension illustrates the following concepts:
-
-- topic 1
-- topic 2
-- topic 3
-
-> Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance.
-
-> Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp.
-
-## References
-
-- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
-- [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview)
-- [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
-- [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview)
-- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
+<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/react-zod" />