Skip to content

Commit

Permalink
Finish cdocs-data package
Browse files Browse the repository at this point in the history
  • Loading branch information
jhgilbert committed Jan 24, 2025
1 parent df5dcaf commit 1091b6a
Show file tree
Hide file tree
Showing 50 changed files with 2,421 additions and 3,953 deletions.
1 change: 1 addition & 0 deletions markdoc/cdocs-data/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

package-lock.json
dist/
vitest.config.js

.yarn/*
!.yarn/releases
Expand Down
36 changes: 35 additions & 1 deletion markdoc/cdocs-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ A *filter* is a pairing of:
- A *trait*, which represents a user's characteristics or preferences, such as `programming_language`.
- An *option group* that contains an ordered list of options for that trait, such as `python` or `go`.

The available traits, options, and option groups are defined in YAML *glossaries* (allowlists containing all valid entries for each group).

A *resolved filter* includes:
- a trait
- an option group
Expand Down Expand Up @@ -171,4 +173,36 @@ To experiment with the package's functionality:

1. Create a new branch.
2. Make modifications to [the simple example script](./test/integration/simpleExample/simpleExample.test.ts)/[configuration data](./test/integration/simpleExample/customization_config/), or the [complex example script](./test/integration/complexExample/complexExample.test.ts)/[configuration data](./test/integration/complexExample/customization_config/).
3. Run `yarn test` inside the `cdocs-data` directory to see how your changes have impacted any logs, test snapshots, and so on.
3. Run `yarn test` inside the `cdocs-data` directory to see how your changes have impacted any logs, test snapshots, and so on.

## Code conventions

### Type and schemas

#### Naming

Where possible, TypeScript types are derived from Zod schemas. The schema for `SomeType` will be named `SomeTypeSchema`.

When something has been ingested from YAML but is not yet in its final form, use the prefix `Raw`, such as `RawFrontmatter`.

Record types should end in `ById` or a similar indicator of what they are keyed by.

If a piece of data comes from YAML, it generally keeps its snake_case_name. This is because writers may need to reference configuration data in markup, and may find the camelcase conversion confusing.

#### Documentation

Data examples (tagged with `@example`) are often included in inline type documentation, but not inline schema documentation. This is to cut down on repetition without much downside, since examples are most useful on hover, and people are much more likely to hover on a type than a schema.

### Design patterns

#### Functional approach

The code uses pure functions where possible (no side effects like mutating parameters, mutating instance variables, etc.) The code is naturally opaque since it implements abstract operations that could be used on a wide range of data, and using pure functions reduces the potential for confusion and unexpected side effects that are difficult to debug.

#### Function arguments

To improve clarity, functions often take a single object as their argument, with the keys of that object serving as labels for the data. This object is always named `p`. For example, `function parkCar(p: { car: Car, space: ParkingSpace }`.

`p` should not be mutated in the function, and its data should not be destructured (copied) unless the intention is to mutate the copy. Instead, just access the data as `p.someData` throughout the function to keep the source of the data clear and reduce accidental mutations.

When a copy of any data in `p` is made (for example, in order to mutate it), the name of the copy should end in `Dup`.
Binary file added markdoc/cdocs-data/cdocs-data-v1.0.0.tgz
Binary file not shown.
16 changes: 8 additions & 8 deletions markdoc/cdocs-data/docs/classes/CdocsClientStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Class: CdocsClientStorage

Defined in: [src/api/browser/CdocsClientStorage.ts:6](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L6)
Defined in: [src/api/browser/CdocsClientStorage.ts:6](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L6)

A wrapper for local storage that stores trait values,
ensuring that the number of stored keys does not exceed
Expand All @@ -18,7 +18,7 @@ a maximum value.

> **new CdocsClientStorage**(`p`): [`CdocsClientStorage`](CdocsClientStorage.md)
Defined in: [src/api/browser/CdocsClientStorage.ts:22](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L22)
Defined in: [src/api/browser/CdocsClientStorage.ts:22](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L22)

Create a new instance of CdocsClientStorage, resuming
any previous sessions by loading any existing trait values
Expand Down Expand Up @@ -52,7 +52,7 @@ will be kept in local storage, such as 'cdocs-client-storage'.

> **clear**(): `void`
Defined in: [src/api/browser/CdocsClientStorage.ts:100](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L100)
Defined in: [src/api/browser/CdocsClientStorage.ts:100](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L100)

Erase all stored trait values, but keep the top-level key.

Expand All @@ -66,7 +66,7 @@ Erase all stored trait values, but keep the top-level key.

> **destroy**(): `void`
Defined in: [src/api/browser/CdocsClientStorage.ts:108](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L108)
Defined in: [src/api/browser/CdocsClientStorage.ts:108](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L108)

Erase all browser data stored by this class.

Expand All @@ -80,7 +80,7 @@ Erase all browser data stored by this class.

> **getTraitVals**(): `Record`\<`string`, `string`\>
Defined in: [src/api/browser/CdocsClientStorage.ts:38](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L38)
Defined in: [src/api/browser/CdocsClientStorage.ts:38](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L38)

Get the value of all traits, keyed by trait ID.

Expand All @@ -97,7 +97,7 @@ such as { 'os': 'linux' }.

> **loadLocalStorageData**(): `void`
Defined in: [src/api/browser/CdocsClientStorage.ts:89](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L89)
Defined in: [src/api/browser/CdocsClientStorage.ts:89](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L89)

Overwrite the in-memory storage with
whatever is in local storage.
Expand All @@ -112,7 +112,7 @@ whatever is in local storage.

> **setTraitVals**(`entries`): `Record`\<`string`, `string`\>
Defined in: [src/api/browser/CdocsClientStorage.ts:57](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L57)
Defined in: [src/api/browser/CdocsClientStorage.ts:57](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L57)

Update the value of one or more traits.
Any trait IDs not provided will be left unchanged.
Expand All @@ -138,7 +138,7 @@ regardless of whether they were updated in this batch.

> **writeToLocalStorage**(): `Promise`\<`void`\>
Defined in: [src/api/browser/CdocsClientStorage.ts:81](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/CdocsClientStorage.ts#L81)
Defined in: [src/api/browser/CdocsClientStorage.ts:81](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/CdocsClientStorage.ts#L81)

Asynchronously write the current storage to local storage,
so it can be accessed in future sessions.
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/functions/buildFiltersManifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **buildFiltersManifest**(`p`): [`FiltersManifest`](../type-aliases/FiltersManifest.md)
Defined in: [src/api/compilation/buildFiltersManifest.ts:26](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/compilation/buildFiltersManifest.ts#L26)
Defined in: [src/api/compilation/buildFiltersManifest.ts:25](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/compilation/buildFiltersManifest.ts#L25)

Combine a page's frontmatter, the global glossary,
and the global filter config into a single object
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/functions/getTraitValsFromUrl.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **getTraitValsFromUrl**(`p`): `Record`\<`string`, `string`\>
Defined in: [src/api/browser/getTraitValsFromUrl.ts:9](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/getTraitValsFromUrl.ts#L9)
Defined in: [src/api/browser/getTraitValsFromUrl.ts:9](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/getTraitValsFromUrl.ts#L9)

Read the selected trait values from the URL.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **loadCustomizationConfig**(`p`): `object`
Defined in: [src/api/compilation/loadCustomizationConfig.ts:17](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/compilation/loadCustomizationConfig.ts#L17)
Defined in: [src/api/compilation/loadCustomizationConfig.ts:21](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/compilation/loadCustomizationConfig.ts#L21)

Loads the customization configuration for all languages into memory,
including all configured traits, options, and option groups.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **pruneManifestForClient**(`manifest`): [`ClientSideFiltersManifest`](../type-aliases/ClientSideFiltersManifest.md)
Defined in: [src/api/compilation/pruneManifestForClient.ts:13](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/compilation/pruneManifestForClient.ts#L13)
Defined in: [src/api/compilation/pruneManifestForClient.ts:17](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/compilation/pruneManifestForClient.ts#L17)

Convert a standard compile-time page filters manifest
to a lighter version to be used client-side.
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/functions/resolveFilters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **resolveFilters**(`p`): [`ResolvedFilters`](../type-aliases/ResolvedFilters.md)
Defined in: [src/api/shared/resolveFilters.ts:47](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/shared/resolveFilters.ts#L47)
Defined in: [src/api/shared/resolveFilters.ts:47](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/shared/resolveFilters.ts#L47)

Resolve the page filters object that is used
to populate the page customization menu.
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/functions/writeTraitValsToUrl.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **writeTraitValsToUrl**(`p`): `URL`
Defined in: [src/api/browser/writeTraitValsToUrl.ts:10](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/api/browser/writeTraitValsToUrl.ts#L10)
Defined in: [src/api/browser/writeTraitValsToUrl.ts:10](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/api/browser/writeTraitValsToUrl.ts#L10)

Write a record of trait values to a URL,
forwarding any non-trait params.
Expand Down
4 changes: 2 additions & 2 deletions markdoc/cdocs-data/docs/type-aliases/CdocsCoreError.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@

> **CdocsCoreError**: `object`
Defined in: [src/schemas/errors.ts:8](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/errors.ts#L8)
Defined in: [src/schemas/errors.ts:8](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/errors.ts#L8)

## Type declaration

### data?

> `optional` **data**: `Record`\<`string`, `any`\>
> `optional` **data**: `Record`\<`string`, `unknown`\>
### message

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **ClientSideFiltersManifest**: `object`
Defined in: [src/schemas/pageFilters.ts:262](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/pageFilters.ts#L262)
Defined in: [src/schemas/pageFilters.ts:262](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/pageFilters.ts#L262)

A lighter version of the FiltersManifest schema,
designed to be used client-side.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **CustomizationConfig**: `object`
Defined in: [src/schemas/customizationConfig.ts:12](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/customizationConfig.ts#L12)
Defined in: [src/schemas/customizationConfig.ts:12](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/customizationConfig.ts#L12)

## Type declaration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@

> **CustomizationConfigByLang**: `Record`\<`string`, \{ `optionGroupsById`: `Record`\<`string`, `object`[]\>; `optionsById`: `Record`\<`string`, \{ `id`: `string`; `internal_notes`: `string`; `label`: `string`; \}\>; `traitsById`: `Record`\<`string`, \{ `id`: `string`; `internal_notes`: `string`; `label`: `string`; \}\>; \}\>
Defined in: [src/schemas/customizationConfig.ts:16](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/customizationConfig.ts#L16)
Defined in: [src/schemas/customizationConfig.ts:16](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/customizationConfig.ts#L16)
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/type-aliases/FilterConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **FilterConfig**: `object`
Defined in: src/schemas/frontmatter.ts:62
Defined in: [src/schemas/frontmatter.ts:62](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/frontmatter.ts#L62)

The configuration of an individual page filter,
as defined in the front matter of a document
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/type-aliases/FiltersManifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **FiltersManifest**: `object`
Defined in: [src/schemas/pageFilters.ts:218](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/pageFilters.ts#L218)
Defined in: [src/schemas/pageFilters.ts:218](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/pageFilters.ts#L218)

A object containing all of the potential trait IDs
and option groups for a page, created by populating the front matter
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/type-aliases/FrontMatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **Frontmatter**: `object`
Defined in: src/schemas/frontmatter.ts:142
Defined in: [src/schemas/frontmatter.ts:142](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/frontmatter.ts#L142)

The front matter of a document required by the integration
(additional keys are allowed in the front matter YAML,
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/type-aliases/OptionGlossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **OptionGlossary**: `Record`\<`string`, \{ `id`: `string`; `internal_notes`: `string`; `label`: `string`; \}\>
Defined in: [src/schemas/glossaries/optionGlossary.ts:57](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/glossaries/optionGlossary.ts#L57)
Defined in: [src/schemas/glossaries/optionGlossary.ts:57](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/glossaries/optionGlossary.ts#L57)

A glossary of all the options that can be used on a site,
regardless of which filters they are associated with.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **OptionGroupGlossary**: `Record`\<`string`, `object`[]\>
Defined in: [src/schemas/glossaries/optionGroupGlossary.ts:137](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/glossaries/optionGroupGlossary.ts#L137)
Defined in: [src/schemas/glossaries/optionGroupGlossary.ts:137](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/glossaries/optionGroupGlossary.ts#L137)

A glossary of all the option groups that can be used on a site,
regardless of which filters they are associated with.
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/type-aliases/ResolvedFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **ResolvedFilter**: `object`
Defined in: [src/schemas/pageFilters.ts:72](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/pageFilters.ts#L72)
Defined in: [src/schemas/pageFilters.ts:72](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/pageFilters.ts#L72)

A page filter that has been "resolved" into
its current value and available options.
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/type-aliases/ResolvedFilters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **ResolvedFilters**: `Record`\<`string`, \{ `currentValue`: `string`; `defaultValue`: `string`; `id`: `string`; `label`: `string`; `options`: `object`[]; \}\>
Defined in: [src/schemas/pageFilters.ts:103](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/pageFilters.ts#L103)
Defined in: [src/schemas/pageFilters.ts:103](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/pageFilters.ts#L103)

A collection of ResolvedFilter objects, indexed by their
unique IDs.
Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/type-aliases/TraitGlossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> **TraitGlossary**: `Record`\<`string`, \{ `id`: `string`; `internal_notes`: `string`; `label`: `string`; \}\>
Defined in: [src/schemas/glossaries/traitGlossary.ts:52](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/glossaries/traitGlossary.ts#L52)
Defined in: [src/schemas/glossaries/traitGlossary.ts:52](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/glossaries/traitGlossary.ts#L52)

A glossary of all user traits that can be used in customization.

Expand Down
2 changes: 1 addition & 1 deletion markdoc/cdocs-data/docs/variables/CdocsCoreErrorSchema.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@

> `const` **CdocsCoreErrorSchema**: `ZodObject`\<[`CdocsCoreError`](../type-aliases/CdocsCoreError.md)\>
Defined in: [src/schemas/errors.ts:3](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/errors.ts#L3)
Defined in: [src/schemas/errors.ts:3](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/errors.ts#L3)
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> `const` **ClientSideFiltersManifestSchema**: `ZodObject`\<[`ClientSideFiltersManifest`](../type-aliases/ClientSideFiltersManifest.md)\>
Defined in: [src/schemas/pageFilters.ts:244](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/pageFilters.ts#L244)
Defined in: [src/schemas/pageFilters.ts:244](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/pageFilters.ts#L244)

A lighter version of the FiltersManifest schema,
designed to be used client-side.
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@

> `const` **CustomizationConfigByLangSchema**: `ZodRecord`\<[`CustomizationConfigByLang`](../type-aliases/CustomizationConfigByLang.md)\>
Defined in: [src/schemas/customizationConfig.ts:14](https://github.com/DataDog/documentation/blob/b898db3da077c905d05644b1aca1c0fe199f9494/markdoc/cdocs-data/src/schemas/customizationConfig.ts#L14)
Defined in: [src/schemas/customizationConfig.ts:14](https://github.com/DataDog/corp-node-packages/blob/767b31fa96466b395043a1746f343c475d12807b/packages/cdocs-data/src/schemas/customizationConfig.ts#L14)
Loading

0 comments on commit 1091b6a

Please sign in to comment.