Skip to content

feat(schema): add optional operator field to Wiki schema #110

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
Yomzy2223 merged 2 commits into from
Sep 23, 2025
Merged

feat(schema): add optional operator field to Wiki schema #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c7a0f0
feat(schema): add optional operator field to Wiki schema
Yomzy2223 Sep 23, 2025
f830dca
add changesets
Yomzy2223 Sep 23, 2025
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
5 changes: 5 additions & 0 deletions .changeset/large-goats-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@everipedia/iq-utils": patch
---

add operator field to wiki schema
1 change: 1 addition & 0 deletions src/schema/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@ export const Wiki = z
events: z.array(BaseEvents).nullish(),
user: z.object({ id: z.string() }),
author: z.object({ id: z.string() }),
operator: z.object({ id: z.string() }).optional(),
Copy link

@gemini-code-assist gemini-code-assist bot Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The structure z.object({ id: z.string() }) is now duplicated across user, author, and the newly added operator fields. To improve maintainability and adhere to the DRY (Don't Repeat Yourself) principle, I suggest creating a reusable schema for this structure.

You could define a new schema in the 'Supporting Schemas' section, similar to other base types in this file:

export const UserReference = z.object({ id: z.string() });

Then, you can use it for user, author, and operator fields like so:

user: UserReference,
author: UserReference,
operator: UserReference.optional(),

This will make the Wiki schema cleaner and easier to manage if the user reference structure ever needs to be changed.

language: LanguagesISO.default(LanguagesISO.Enum.en),
version: z.number().default(1),
linkedWikis: z
Expand Down