LA-128 Fix docs for region codes (#5511)

Co-authored-by: Lucano Vera <[email protected]>
ethyca · Nov 19, 2024 · 6fc8086 · 6fc8086
1 parent 2c64212
commit 6fc8086
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 21 deletions.
diff --git a/clients/fides-js/docs/README.md b/clients/fides-js/docs/README.md
@@ -26,14 +26,13 @@ Google Tag Manager, IAB TCF, etc.
 See [Fides](interfaces/Fides.md) for how to use the `window.Fides` JavaScript API, [FidesOptions](interfaces/FidesOptions.md) for supported options to customize it's behavior, and [FidesEvent](interfaces/FidesEvent.md) for how to use `window.addEventListener(...)` to subscribe to
 custom Fides events for real-time updates.
 
+## Enumerations
+
+- [PrivacyNoticeRegion](enumerations/PrivacyNoticeRegion.md)
+
 ## Interfaces
 
 - [FidesEvent](interfaces/FidesEvent.md)
 - [FidesExperienceConfig](interfaces/FidesExperienceConfig.md)
 - [FidesOptions](interfaces/FidesOptions.md)
 - [Fides](interfaces/Fides.md)
-
-
-## Types
-
-- [PrivacyNoticeRegion](types/PrivacyNoticeRegion.md)  
diff --git a/...ides-js/docs/types/PrivacyNoticeRegion.md → .../docs/enumerations/PrivacyNoticeRegion.md b/...ides-js/docs/types/PrivacyNoticeRegion.md → .../docs/enumerations/PrivacyNoticeRegion.md
@@ -1,21 +1,18 @@
-# Types: PrivacyNoticeRegion
+# Enumeration: PrivacyNoticeRegion
 
 A string that represents a specific region of the world. It is used to specify regions that apply to a [Privacy Experience](/tutorials/consent-management/consent-management-configuration/privacy-experiences#what-are-privacy-experiences).
-
 The string is formatted with [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) two-letter codes for a country and subdivisions. They're written in lowercase and separated with an underscore. Subdivisions are currently supported for the United States and Canada.
-
 The PrivacyNoticeRegion can also be one of the following non-iso standard codes:
-
-- `eea` : European Economic Area  
-- `mexico_central_america` : Mexico and Central America  
+- `eea` : European Economic Area
+- `non_eea` : European countries that are not part of the European Economic Area
+- `mexico_central_america` : Mexico and Central America
 - `caribbean` : Caribbean
 
 ### Example values:
-
-`us` : United States  
-`ca` : Canada  
-`fr` : France  
-`us_ca` : United States - State of California  
-`us_ny` : United States - State of New York  
-`ca_on` : Canada - Ontario Province  
-`eea` : European Economic Area
+- `us` : United States
+- `ca` : Canada
+- `fr` : France
+- `us_ca` : United States - State of California
+- `us_ny` : United States - State of New York
+- `ca_on` : Canada - Ontario Province
+- `eea` : European Economic Area
diff --git a/clients/fides-js/docs/interfaces/FidesExperienceConfig.md b/clients/fides-js/docs/interfaces/FidesExperienceConfig.md
@@ -80,9 +80,10 @@ Full name of the configured experience (e.g. `"US Modal"`)
 
 ### regions?
 
-> `optional` **regions**: [PrivacyNoticeRegion](../types/PrivacyNoticeRegion)[]
+> `optional` **regions**: `string`[]
 
-List of [region codes](../types/PrivacyNoticeRegion) that apply.
+List of region codes that apply.
+For more information on valid values see [PrivacyNoticeRegion](../enumerations/PrivacyNoticeRegion.md)
 
 #### Example
 

diff --git a/clients/fides-js/src/docs/fides-experience-config.ts b/clients/fides-js/src/docs/fides-experience-config.ts
@@ -58,6 +58,7 @@ export interface FidesExperienceConfig {
 
   /**
    * List of region codes that apply.
+   * For more information on valid values see {@link PrivacyNoticeRegion}
    * @example
    * ```ts
    * [ "us_ca", "us_co", "us_ct", "us_ut", "us_va", "us_or", "us_tx" ]

diff --git a/clients/fides-js/src/docs/index.ts b/clients/fides-js/src/docs/index.ts
@@ -52,3 +52,4 @@ export * from "./fides";
 export * from "./fides-event";
 export * from "./fides-experience-config";
 export * from "./fides-options";
+export * from "./privacy-notice-region";
diff --git a/clients/fides-js/src/docs/privacy-notice-region.ts b/clients/fides-js/src/docs/privacy-notice-region.ts
@@ -0,0 +1,20 @@
+/**
+ * A string that represents a specific region of the world. It is used to specify regions that apply to a [Privacy Experience](/tutorials/consent-management/consent-management-configuration/privacy-experiences#what-are-privacy-experiences).
+ * The string is formatted with [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) two-letter codes for a country and subdivisions. They're written in lowercase and separated with an underscore. Subdivisions are currently supported for the United States and Canada.
+ * The PrivacyNoticeRegion can also be one of the following non-iso standard codes:
+ * - `eea` : European Economic Area
+ * - `non_eea` : European countries that are not part of the European Economic Area
+ * - `mexico_central_america` : Mexico and Central America
+ * - `caribbean` : Caribbean
+ *
+ * ### Example values:
+ * - `us` : United States
+ * - `ca` : Canada
+ * - `fr` : France
+ * - `us_ca` : United States - State of California
+ * - `us_ny` : United States - State of New York
+ * - `ca_on` : Canada - Ontario Province
+ * - `eea` : European Economic Area
+ */
+
+export enum PrivacyNoticeRegion {}