Repository navigation
feat!: Port DirectorySync to oagen - #1626
Conversation
The Directory Sync API can return a `suspended` state for directory users (e.g. SCIM-deactivated accounts), but the SDK types only modeled `active` and `inactive`. Consumers had no way to type-check against the suspended case.
Apply the deterministic output of the oagen-emitters fixes (node-bugfixes) directly, so this PR is correct ahead of a full re-generation: - Export `GetUserOptions` from the interfaces barrel. It was emitted and imported by the hand-owned `getUser`, but a cross-service collision with UserManagement's same-named `GetUserOptions` kept it out of the barrel. - Stop coercing `organizationId` to `''` when `organization_id` is absent; the field is optional, so pass the wire value (`undefined`) through. - Remove the orphaned `list-directories-options.serializer.ts`; its logic is inlined in `directory-sync.ts` and the file is referenced nowhere. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The oagen port exposed raw wire states (linked/unlinked/...) on Directory.state, a breaking change for consumers relying on the SDK's historical active/inactive values. The spec only describes the raw enum, so the linked->active / unlinked->inactive translation is restored as hand-owned: - directory-state.interface.ts: DirectoryState back to the mapped union; @oagen-ignore-file + dropped from the manifest. - directory.serializer.ts: restore deserializeDirectoryState and apply it; @oagen-ignore-file + dropped from the manifest. - directory-sync.spec.ts: fixture wire state `linked` now deserializes to `active`. EventDirectory.state already referenced DirectoryState, so it tracks the mapped union as on main (event payloads still pass through unmapped). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the hand-owned `@oagen-ignore-file` carve-out (58c2a08) with generated code now that the emitter supports enum value remaps (oagen-emitters `enumValueRemaps` + the openapi-spec config). `DirectoryState` and `directory.serializer.ts`'s `deserializeDirectoryState` mapper are regenerated (autogen headers restored, back in the manifest); behavior is unchanged (`linked`→`active`, `unlinked`→`inactive`) but a clean regen now reproduces it instead of skipping the files. tsc clean, directory-sync tests pass. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
qbalin
left a comment
There was a problem hiding this comment.
@gjtorikian Happy to approve. Are the greptile comments worth addressing in this PR?
… type Regenerate DirectorySync with the enum wire-companion emitter change: DirectoryResponse.state is now typed DirectoryStateResponse (raw wire linked/unlinked) and deserializeDirectoryState maps it to the DirectoryState domain type (active/inactive), restoring the wire/domain distinction flagged in review. Also picks up current-emitter regeneration of the directory-sync tests and serializers. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
@qbalin Thanks! I think all of this Greptile feedback is already addressed, it's just not clearing (no matter how many times I hit retrigger). This one, for instance, will be documented in the changelog and matches what the spec provides; this one also matches the existing webhook string timestamps and is intentional. |
createdAt/updatedAt on webhook directory event payloads were left as raw strings while every other directory-sync serializer (REST resources and the dsync.group.*/dsync.user.* event serializers) converts date-time fields to Date. event-directory.* is hand-owned, so the emitter's date-time -> new Date() rule never reached it. Bring it in line so all directory-sync timestamps are consistently Date objects. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
# Conflicts: # src/directory-sync/directory-sync.ts # src/directory-sync/interfaces/directory.interface.ts
There was a problem hiding this comment.
The replacement suite removes every direct test for listUsers and getUser, including filters, typed customAttributes, groups, and roles. These methods remain hand-written, and getUser changes its argument shape here. Without those tests, changes can break directory user reads unnoticed. Keep them inside the preserved region or in a separate hand-written spec; the generated tests do not replace this coverage.
Prompt To Fix With AI
This is a comment left during a code review.
Path: src/directory-sync/directory-sync.spec.ts
Line: 172-173
Comment:
**User methods lost tests**
The replacement suite removes every direct test for `listUsers` and `getUser`, including filters, typed `customAttributes`, groups, and roles. These methods remain hand-written, and `getUser` changes its argument shape here. Without those tests, changes can break directory user reads unnoticed. Keep them inside the preserved region or in a separate hand-written spec; the generated tests do not replace this coverage.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Description
This PR generates the DirectorySync category in the Node SDK from the OpenAPI spec.
Crucially, the serializer still maps the wire values
linked → activeandunlinked → inactive, preserving a difference between the backend and the SDK.Breaking changes
1. Four methods switched from a positional string argument to an options object:
2. Timestamps are now
Dateobjects, not strings.createdAt/updatedAtonDirectory,DirectoryGroup, andDirectoryUserWithGroupsnow come back asnew Date(...). This also applies to webhook event payloads: thedata.createdAt/data.updatedAtfields ondsync.activated,dsync.deleted,dsync.group.*, anddsync.user.*events are nowDateobjects. Consumers parsing these timestamps as strings must update accordingly.3.
Directory.domainis now optional. It changed fromdomain: stringtodomain?: string, so it is now typedstring | undefined. Consumers that assigndirectory.domainto astring-typed variable will see a TypeScript error.Because of these changes, this is a major breaking change to the SDK.