diff --git a/.changeset/ranged-dashboard-metrics.md b/.changeset/ranged-dashboard-metrics.md deleted file mode 100644 index aa43e59..0000000 --- a/.changeset/ranged-dashboard-metrics.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -'@seamless-auth/types': minor ---- - -Time ranges for the dashboard metrics and security anomalies (fells-code/seamless-auth-api#132). - -- `DashboardMetricsQuerySchema` (`from`, `to`) and `SecurityAnomaliesQuerySchema` (`from`, `to`, `limit` 1 to 200 with a default of 200, `offset` with a default of 0). The range rules are the same as `MetricsQuerySchema`'s, which now shares them. -- `DashboardMetricsResponseSchema` gains optional `window`, `newUsers`, `loginSuccess`, `loginFailed`, `successRate`, `otpUsage` and `passkeyUsage`, which cover the requested window. The `*24h` fields keep meaning the last 24 hours. -- `SecurityAnomaliesResponseSchema` gains optional `window`, `limit` and `offset`, and `total` is documented as every matching event in the window. - -All the new response fields are optional, so a response from a server without ranges still parses. diff --git a/CHANGELOG.md b/CHANGELOG.md index c219503..4899543 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # @seamless-auth/types +## 0.28.0 + +### Minor Changes + +- e2d2a28: Time ranges for the dashboard metrics and security anomalies (fells-code/seamless-auth-api#132). + + - `DashboardMetricsQuerySchema` (`from`, `to`) and `SecurityAnomaliesQuerySchema` (`from`, `to`, `limit` 1 to 200 with a default of 200, `offset` with a default of 0). The range rules are the same as `MetricsQuerySchema`'s, which now shares them. + - `DashboardMetricsResponseSchema` gains optional `window`, `newUsers`, `loginSuccess`, `loginFailed`, `successRate`, `otpUsage` and `passkeyUsage`, which cover the requested window. The `*24h` fields keep meaning the last 24 hours. + - `SecurityAnomaliesResponseSchema` gains optional `window`, `limit` and `offset`, and `total` is documented as every matching event in the window. + + All the new response fields are optional, so a response from a server without ranges still parses. + ## 0.27.0 ### Minor Changes diff --git a/package.json b/package.json index 7269ce2..ce90f63 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@seamless-auth/types", - "version": "0.27.0", + "version": "0.28.0", "description": "Shared TypeScript types and Zod schemas for SeamlessAuth.", "author": "Fells Code, LLC", "license": "Apache-2.0",