feat!: Port AuditLogs to oagen by gjtorikian · Pull Request #1627 · workos/workos-node

gjtorikian · 2026-06-17T00:25:55Z

Description

This PR generates the AuditLogs category in the Node SDK from the OpenAPI spec.

Almost every existing method changed its input signature, its output, or both. Callers cannot expect the same input/output format.

┌──────────────┬─────────────────────────────────────────────────┬────────────────────────────────────────────────────────────┐
│    Method    │                     Before                      │                           After                            │
├──────────────┼─────────────────────────────────────────────────┼────────────────────────────────────────────────────────────┤
│ createEvent  │ createEvent(organization: string, event,        │ createEvent(options: CreateEventOptions) →                 │
│              │ options?) → Promise<void>                       │ Promise<AuditLogEventCreateResponse>                       │
├──────────────┼─────────────────────────────────────────────────┼────────────────────────────────────────────────────────────┤
│ createSchema │ createSchema(schema: {action, ...}, options?)   │ createSchema(options: {actionName, ...})                   │
├──────────────┼─────────────────────────────────────────────────┼────────────────────────────────────────────────────────────┤
│ listSchemas  │ listSchemas(action: string, options?)           │ renamed → listActionSchemas(options: {actionName, ...})    │
├──────────────┼─────────────────────────────────────────────────┼────────────────────────────────────────────────────────────┤
│ getExport    │ getExport(auditLogExportId: string)             │ getExport(options: {auditLogExportId})                     │
├──────────────┼─────────────────────────────────────────────────┼────────────────────────────────────────────────────────────┤
│ createExport │ createExport(options: AuditLogExportOptions)    │ same signature                                             │
└──────────────┴─────────────────────────────────────────────────┴────────────────────────────────────────────────────────────┘

As well:

AuditLogExport.createdAt / updatedAt change: string → Date
AuditLogSchema.createdAt also changed string → Date

The following new methods were added:

getOrganizationAuditLogsRetention(options)
updateOrganizationAuditLogsRetention(options)
listActions(options?)

Because of these changes, this is a major breaking change to the SDK.

greptile-apps · 2026-06-17T00:31:02Z

Greptile Summary

This PR ports the AuditLogs SDK category to the OpenAPI-driven oagen generator, replacing hand-written serializers, interfaces, and method signatures with auto-generated equivalents. All files are marked "Do not edit."

Breaking changes across the board: createEvent gains a return type, createExport/getExport/createSchema change their input shapes, listSchemas is renamed to listActionSchemas, and rangeStart/rangeEnd on AuditLogExportOptions change from Date to string; three new methods (getOrganizationAuditLogsRetention, updateOrganizationAuditLogsRetention, listActions) are added.
Idempotency preserved: createEvent still auto-generates a workos-node-{uuid} idempotency key when none is provided and merges requestOptions correctly; the new test-utils-based spec verifies the key format and that an explicit key is forwarded.
Date deserialization added: createdAt/updatedAt on AuditLogExport and AuditLogSchema now return Date objects (breaking change from string).

Confidence Score: 5/5

Safe to merge — the implementation is correct, idempotency key generation is preserved, URL parameters are properly encoded, and date deserialization is handled throughout.

The auto-generated code is clean and consistent. Idempotency key handling in createEvent is correct (key generated once per call via requestOptions spread, so retries reuse it). Date fields are properly deserialized with new Date(). URL parameters use encodeURIComponent. The only concern is a test coverage regression where retry/idempotency contract tests were removed, but this does not affect the correctness of the shipped code.

src/audit-logs/audit-logs.spec.ts — the auto-generated spec dropped all retry tests for createEvent; worth reviewing whether the generator can be configured to include them.

Important Files Changed

Filename	Overview
src/audit-logs/audit-logs.ts	Main implementation: method signatures updated, idempotency key preserved, URL params encoded, new retention/action endpoints added
src/audit-logs/audit-logs.spec.ts	Auto-generated spec replacing hand-written tests; retry/idempotency regression tests dropped; single test exercises multiple createEvent calls with only one fetchOnce mock
src/audit-logs/interfaces/audit-log-export-options.interface.ts	rangeStart/rangeEnd changed from Date to string; SerializedAuditLogExportOptions removed; actors deprecated field not exposed to callers
src/audit-logs/interfaces/audit-log-export.interface.ts	createdAt/updatedAt changed from string to Date; AuditLogExportState const/type added in separate file but not referenced here
src/audit-logs/serializers/audit-log-export.serializer.ts	Correctly deserializes dates with new Date(); uses null-coalescing for url field to handle potential null from API
src/audit-logs/serializers/audit-log-export-creation.serializer.ts	Replaces deleted serializeAuditLogExportOptions; correctly maps camelCase to snake_case; handles deprecated actors field
src/audit-logs/interfaces/index.ts	Re-exports expanded with 15 new interfaces; old create-event/schema options replaced; all new types publicly exposed
src/audit-logs/serializers.spec.ts	New auto-generated serializer spec with round-trip tests for all new serializers

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant Caller
    participant AuditLogs
    participant WorkOSHTTP

    Note over AuditLogs: createEvent
    Caller->>AuditLogs: createEvent(CreateEventOptions, PostOptions?)
    AuditLogs->>AuditLogs: serializeAuditLogEventIngestion
    AuditLogs->>AuditLogs: auto-generate idempotencyKey if not provided
    AuditLogs->>WorkOSHTTP: POST /audit_logs/events + Idempotency-Key header
    WorkOSHTTP-->>AuditLogs: AuditLogEventCreateResponseWire
    AuditLogs-->>Caller: AuditLogEventCreateResponse

    Note over AuditLogs: createExport
    Caller->>AuditLogs: createExport(AuditLogExportOptions)
    AuditLogs->>AuditLogs: serializeAuditLogExportCreation
    AuditLogs->>WorkOSHTTP: POST /audit_logs/exports
    WorkOSHTTP-->>AuditLogs: AuditLogExportResponse
    AuditLogs->>AuditLogs: deserializeAuditLogExport - dates to Date objects
    AuditLogs-->>Caller: AuditLogExport

    Note over AuditLogs: getOrganizationAuditLogsRetention new
    Caller->>AuditLogs: getOrganizationAuditLogsRetention id
    AuditLogs->>WorkOSHTTP: GET /organizations/:id/audit_logs_retention
    WorkOSHTTP-->>AuditLogs: AuditLogsRetentionResponse
    AuditLogs-->>Caller: AuditLogsRetention

    Note over AuditLogs: listActions new
    Caller->>AuditLogs: listActions(options?)
    AuditLogs->>WorkOSHTTP: GET /audit_logs/actions
    WorkOSHTTP-->>AuditLogs: ListResponse AuditLogActionResponse
    AuditLogs-->>Caller: AutoPaginatable AuditLogAction

%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
    participant Caller
    participant AuditLogs
    participant WorkOSHTTP

    Note over AuditLogs: createEvent
    Caller->>AuditLogs: createEvent(CreateEventOptions, PostOptions?)
    AuditLogs->>AuditLogs: serializeAuditLogEventIngestion
    AuditLogs->>AuditLogs: auto-generate idempotencyKey if not provided
    AuditLogs->>WorkOSHTTP: POST /audit_logs/events + Idempotency-Key header
    WorkOSHTTP-->>AuditLogs: AuditLogEventCreateResponseWire
    AuditLogs-->>Caller: AuditLogEventCreateResponse

    Note over AuditLogs: createExport
    Caller->>AuditLogs: createExport(AuditLogExportOptions)
    AuditLogs->>AuditLogs: serializeAuditLogExportCreation
    AuditLogs->>WorkOSHTTP: POST /audit_logs/exports
    WorkOSHTTP-->>AuditLogs: AuditLogExportResponse
    AuditLogs->>AuditLogs: deserializeAuditLogExport - dates to Date objects
    AuditLogs-->>Caller: AuditLogExport

    Note over AuditLogs: getOrganizationAuditLogsRetention new
    Caller->>AuditLogs: getOrganizationAuditLogsRetention id
    AuditLogs->>WorkOSHTTP: GET /organizations/:id/audit_logs_retention
    WorkOSHTTP-->>AuditLogs: AuditLogsRetentionResponse
    AuditLogs-->>Caller: AuditLogsRetention

    Note over AuditLogs: listActions new
    Caller->>AuditLogs: listActions(options?)
    AuditLogs->>WorkOSHTTP: GET /audit_logs/actions
    WorkOSHTTP-->>AuditLogs: ListResponse AuditLogActionResponse
    AuditLogs-->>Caller: AutoPaginatable AuditLogAction

_{Reviews (4): Last reviewed commit: "Merge branch 'main' into oagen/own-audit..." | Re-trigger Greptile}

…zer test Regenerate AuditLogs with the fixed node emitter and fold in the review findings from #1627: - createEvent regains idempotency: a `requestOptions: PostOptions = {}` param and an auto-generated `workos-node-${uuid}` Idempotency-Key, so a 5xx retry no longer silently duplicates an audit event (the options-object emitter path previously dropped it entirely). - createExport JSDoc no longer documents `options.actors` — the curated AuditLogExportOptions doesn't expose that deprecated field. - Drop the dead `SerializedAuditLogExportOptions` interface (its only consumer, the old serializeAuditLogExportOptions, was removed in the port). - serializers.spec.ts now reconstructs the camelCase domain model from the wire fixture instead of feeding the serializer a snake_case object (which threw `model.occurredAt.toISOString()` on undefined). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Regenerated audit-logs.spec.ts with the node emitter's new idempotency test emission. Adds assertions that createEvent forwards a caller-supplied Idempotency-Key header and auto-generates a `workos-node-` prefixed one when none is given — the coverage the oagen port dropped and that review flagged. The behavior was already correct; this guards it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

swaroopThereItIs-workos · 2026-07-23T15:49:52Z

-  organization_id: string;
-  range_end: string;
-  range_start: string;
+  rangeEnd: string;


is there a reason to make this string in lieu of date?

No; this should be corrected in the OpenAPI spec.

swaroopThereItIs-workos · 2026-07-23T16:13:02Z

+   * @throws {NotFoundException} 404
+   * @throws {UnprocessableEntityException} 422
+   */
+  async listActionSchemas(


seems like a pretty big breaking change to change the name from listSchemas -> ListActionSchemas

I can rename this 👍

swaroopThereItIs-workos · 2026-07-23T16:35:37Z

 import { AutoPaginatable } from '../common/utils/pagination';
-import { WorkOS } from '../workos';
-import {
-  CreateAuditLogEventOptions,


the new export structure will break some implementations

swaroopThereItIs-workos

a bit worried about the breaeking changes

ConderShou · 2026-09-14T16:00:13Z

Commenting on this thread as a follow-up to this issue: #1704

The two retention SDK methods added here are currently the only path to GET/PUT /organizations/{id}/audit_logs_retention from Node. If we're worried about the breaking changes, would you consider splitting these three methods (getOrganizationAuditLogsRetention, updateOrganizationAuditLogsRetention, listActions) into a separate PR? I imagine these shouldn't need anything major.

gjtorikian · 2026-09-14T16:53:34Z

Yes, I can pull those out--will do so.

The API now takes a `retention_period` enum (`1_MONTH` through `11_MONTHS`, `1_YEAR` through `10_YEARS`) and has deprecated `retention_period_in_days`. The two are mutually exclusive, so the options type is a union — matching the hand-written `RemoveRoleOptions` precedent — and the serializer only emits the key that was provided, since sending the other as `null` would trip the API's exclusivity check. The enum name `UpdateAuditLogsRetentionRetentionPeriod` mirrors what oagen emits for the other SDKs so the Node surface stays consistent when the full port (#1627) is regenerated.

Port AuditLogs to oagen

20364e2

gjtorikian requested review from a team as code owners June 17, 2026 00:25

gjtorikian requested a review from tribble June 17, 2026 00:25

greptile-apps Bot reviewed Jun 17, 2026

View reviewed changes

Comment thread src/audit-logs/audit-logs.ts

Comment thread src/audit-logs/audit-logs.ts

gjtorikian marked this pull request as draft June 18, 2026 19:06

gjtorikian changed the title ~~feat! Port AuditLogs to oagen~~ feat!: Port AuditLogs to oagen Jun 18, 2026

gjtorikian added the autogenerated Autogenerated code or content label Jun 18, 2026

gjtorikian marked this pull request as ready for review July 2, 2026 18:55

gjtorikian added the breaking change Contains a breaking change label Jul 7, 2026

Merge branch 'main' into oagen/own-audit-logs

48cbf52

swaroopThereItIs-workos reviewed Jul 23, 2026

View reviewed changes

swaroopThereItIs-workos approved these changes Jul 23, 2026

View reviewed changes

tribble removed their request for review August 27, 2026 21:57

ConderShou mentioned this pull request Sep 14, 2026

AuditLogs: no method for Audit Log Retention #1704

Closed

gjtorikian mentioned this pull request Sep 17, 2026

fix: encode caller-supplied path parameters in legacy modules #1710

Open

Navigation Menu

feat!: Port AuditLogs to oagen - #1627

feat!: Port AuditLogs to oagen#1627
gjtorikian wants to merge 4 commits into
mainfrom
oagen/own-audit-logs

gjtorikian commented Jun 17, 2026 •

edited

Loading

Uh oh!

greptile-apps Bot commented Jun 17, 2026 •

edited

Loading

Sequence Diagram

Uh oh!

Uh oh!

Uh oh!

swaroopThereItIs-workos Jul 23, 2026

Uh oh!

gjtorikian Jul 24, 2026

Uh oh!

swaroopThereItIs-workos Jul 23, 2026

Uh oh!

gjtorikian Jul 24, 2026

Uh oh!

swaroopThereItIs-workos Jul 23, 2026

Uh oh!

swaroopThereItIs-workos left a comment

Uh oh!

ConderShou commented Sep 14, 2026

Uh oh!

gjtorikian commented Sep 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

gjtorikian commented Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

greptile-apps Bot commented Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Sequence Diagram

Uh oh!

Uh oh!

Uh oh!

swaroopThereItIs-workos Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

gjtorikian Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

swaroopThereItIs-workos Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

gjtorikian Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

swaroopThereItIs-workos Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

swaroopThereItIs-workos left a comment

Choose a reason for hiding this comment

Uh oh!

ConderShou commented Sep 14, 2026

Uh oh!

gjtorikian commented Sep 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

gjtorikian commented Jun 17, 2026 •

edited

Loading

greptile-apps Bot commented Jun 17, 2026 •

edited

Loading