Skip to content

feat: Add optional fields for additionalMetadata and keywords in Expe… #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Ewocker merged 1 commit into from
Nov 5, 2025
Merged

feat: Add optional fields for additionalMetadata and keywords in Expe… #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/api/interfaces/ExperienceField.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Each field contains a name and corresponding value.

## Properties

### additionalMetadata?

> `optional` **additionalMetadata**: `Record`\<`string`, `any`\>

Additional metadata for the experience field

***

### fieldName

> **fieldName**: `string`
Expand All @@ -24,3 +32,11 @@ Name of the experience field
> **fieldValue**: `string`

Value associated with the experience field

***

### keywords?

> `optional` **keywords**: `string`[]

Keywords for the experience field
34 changes: 19 additions & 15 deletions src/types/experience/Experience.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,28 +18,32 @@ import { Template } from "../template";
* An Experience is a container for various fields that define its characteristics.
*/
export interface Experience {
/** Unique identifier for the experience */
id: string;
/** Collection of experience fields stored as key-value pairs */
experienceFields: Record<string, ExperienceField>;
/** Template associated with the experience */
template?: Template;
/** Metadata associated with the experience */
metadata?: ExperienceMetadata;
/** Unique identifier for the experience */
id: string;
/** Collection of experience fields stored as key-value pairs */
experienceFields: Record<string, ExperienceField>;
/** Template associated with the experience */
template?: Template;
/** Metadata associated with the experience */
metadata?: ExperienceMetadata;
}

/**
* Represents a field within an Experience.
* Each field contains a name and corresponding value.
*/
export interface ExperienceField {
/** Name of the experience field */
fieldName: string;
/** Value associated with the experience field */
fieldValue: string;
/** Name of the experience field */
fieldName: string;
/** Value associated with the experience field */
fieldValue: string;
/** Keywords for the experience field */
keywords?: string[];
/** Additional metadata for the experience field */
additionalMetadata?: Record<string, any>;
}

export type ExperienceMetadata = {
locale?: string;
[key: string]: any;
}
locale?: string;
[key: string]: any;
};