@rustrak/client 0.15.2 → 0.16.1

package/dist/index.d.cts

@@ -634,9 +634,16 @@ declare const bulkUpdateIssuesSchema: z.ZodObject<{
         high: "high";
     }>>;
 }, z.core.$strip>;
-declare const bulkDeleteIssuesSchema: z.ZodObject<{
+declare const bulkDeleteIssuesSchema: z.ZodUnion<readonly [z.ZodObject<{
     ids: z.ZodArray<z.ZodString>;
-}, z.core.$strip>;
+}, z.core.$strict>, z.ZodObject<{
+    filter: z.ZodEnum<{
+        open: "open";
+        resolved: "resolved";
+        muted: "muted";
+        all: "all";
+    }>;
+}, z.core.$strict>]>;
 
 type Issue = z.infer<typeof issueSchema>;
 type IssueStatus = z.infer<typeof issueStatusSchema>;
@@ -916,6 +923,24 @@ declare const cleanupCountsSchema: z.ZodObject<{
     logs: z.ZodNumber;
     issues_removed: z.ZodNumber;
 }, z.core.$strip>;
+declare const cleanupStatusSchema: z.ZodObject<{
+    state: z.ZodEnum<{
+        failed: "failed";
+        idle: "idle";
+        running: "running";
+        completed: "completed";
+    }>;
+    removed: z.ZodObject<{
+        events: z.ZodNumber;
+        transactions: z.ZodNumber;
+        spans: z.ZodNumber;
+        logs: z.ZodNumber;
+        issues_removed: z.ZodNumber;
+    }, z.core.$strip>;
+    started_at: z.ZodNullable<z.ZodString>;
+    finished_at: z.ZodNullable<z.ZodString>;
+    error: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
 declare const sourceMapGcResultSchema: z.ZodObject<{
     files_removed: z.ZodNumber;
     bytes_freed: z.ZodNumber;
@@ -932,6 +957,7 @@ type SourceMapStorage = z.infer<typeof sourceMapStorageSchema>;
 type StorageSummary = z.infer<typeof storageSummarySchema>;
 type ProjectStorage = z.infer<typeof projectStorageSchema>;
 type CleanupCounts = z.infer<typeof cleanupCountsSchema>;
+type CleanupStatus = z.infer<typeof cleanupStatusSchema>;
 type SourceMapGcResult = z.infer<typeof sourceMapGcResultSchema>;
 type CleanupOptions = z.infer<typeof cleanupOptionsSchema>;
 
@@ -1334,7 +1360,8 @@ declare class StorageResource extends BaseResource {
     getSummary(): Promise<Result<StorageSummary, RustrakError>>;
     getProjects(): Promise<Result<ProjectStorage[], RustrakError>>;
     previewCleanup(options: CleanupOptions): Promise<Result<CleanupCounts, RustrakError>>;
-    executeCleanup(options: CleanupOptions): Promise<Result<CleanupCounts, RustrakError>>;
+    executeCleanup(options: CleanupOptions): Promise<Result<CleanupStatus, RustrakError>>;
+    getCleanupStatus(): Promise<Result<CleanupStatus, RustrakError>>;
     previewGcSourceMaps(): Promise<Result<SourceMapGcResult, RustrakError>>;
     gcSourceMaps(): Promise<Result<SourceMapGcResult, RustrakError>>;
 }
@@ -1388,4 +1415,4 @@ declare class RustrakClient {
     constructor(config: ClientConfig);
 }
 
-export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChangePasswordRequest, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type PreviewTemplateResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RateLimits, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type SsoConfig, type SsoLink, type SsoStart, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };
+export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChangePasswordRequest, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type CleanupStatus, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type PreviewTemplateResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RateLimits, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type SsoConfig, type SsoLink, type SsoStart, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };

package/dist/index.d.ts

@@ -634,9 +634,16 @@ declare const bulkUpdateIssuesSchema: z.ZodObject<{
         high: "high";
     }>>;
 }, z.core.$strip>;
-declare const bulkDeleteIssuesSchema: z.ZodObject<{
+declare const bulkDeleteIssuesSchema: z.ZodUnion<readonly [z.ZodObject<{
     ids: z.ZodArray<z.ZodString>;
-}, z.core.$strip>;
+}, z.core.$strict>, z.ZodObject<{
+    filter: z.ZodEnum<{
+        open: "open";
+        resolved: "resolved";
+        muted: "muted";
+        all: "all";
+    }>;
+}, z.core.$strict>]>;
 
 type Issue = z.infer<typeof issueSchema>;
 type IssueStatus = z.infer<typeof issueStatusSchema>;
@@ -916,6 +923,24 @@ declare const cleanupCountsSchema: z.ZodObject<{
     logs: z.ZodNumber;
     issues_removed: z.ZodNumber;
 }, z.core.$strip>;
+declare const cleanupStatusSchema: z.ZodObject<{
+    state: z.ZodEnum<{
+        failed: "failed";
+        idle: "idle";
+        running: "running";
+        completed: "completed";
+    }>;
+    removed: z.ZodObject<{
+        events: z.ZodNumber;
+        transactions: z.ZodNumber;
+        spans: z.ZodNumber;
+        logs: z.ZodNumber;
+        issues_removed: z.ZodNumber;
+    }, z.core.$strip>;
+    started_at: z.ZodNullable<z.ZodString>;
+    finished_at: z.ZodNullable<z.ZodString>;
+    error: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
 declare const sourceMapGcResultSchema: z.ZodObject<{
     files_removed: z.ZodNumber;
     bytes_freed: z.ZodNumber;
@@ -932,6 +957,7 @@ type SourceMapStorage = z.infer<typeof sourceMapStorageSchema>;
 type StorageSummary = z.infer<typeof storageSummarySchema>;
 type ProjectStorage = z.infer<typeof projectStorageSchema>;
 type CleanupCounts = z.infer<typeof cleanupCountsSchema>;
+type CleanupStatus = z.infer<typeof cleanupStatusSchema>;
 type SourceMapGcResult = z.infer<typeof sourceMapGcResultSchema>;
 type CleanupOptions = z.infer<typeof cleanupOptionsSchema>;
 
@@ -1334,7 +1360,8 @@ declare class StorageResource extends BaseResource {
     getSummary(): Promise<Result<StorageSummary, RustrakError>>;
     getProjects(): Promise<Result<ProjectStorage[], RustrakError>>;
     previewCleanup(options: CleanupOptions): Promise<Result<CleanupCounts, RustrakError>>;
-    executeCleanup(options: CleanupOptions): Promise<Result<CleanupCounts, RustrakError>>;
+    executeCleanup(options: CleanupOptions): Promise<Result<CleanupStatus, RustrakError>>;
+    getCleanupStatus(): Promise<Result<CleanupStatus, RustrakError>>;
     previewGcSourceMaps(): Promise<Result<SourceMapGcResult, RustrakError>>;
     gcSourceMaps(): Promise<Result<SourceMapGcResult, RustrakError>>;
 }
@@ -1388,4 +1415,4 @@ declare class RustrakClient {
     constructor(config: ClientConfig);
 }
 
-export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChangePasswordRequest, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type PreviewTemplateResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RateLimits, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type SsoConfig, type SsoLink, type SsoStart, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };
+export { type AcceptInvitation, type ActivityEntry, type AgentBreakdownOptions, type AgentDurationPoint, type AgentModelRow, type AgentSummary, type AgentTimeseriesOptions, type AgentTimeseriesPoint, type AgentToolRow, type AgentTraceSummary, type AgentTracesOptions, type AlertHistory, type AlertIntegration, type AlertRule, type AlertRuleChannelInput, type AlertStatus, type AlertType, type ApiError, type AssembleInput, type AssembleResponse, type AuthResponse, type AuthToken, type AuthTokenCreated, type BulkDeleteIssues, type BulkUpdateIssues, type ChangePasswordRequest, type ChunkUploadCapability, type CleanupCounts, type CleanupOptions, type CleanupStatus, type ClientConfig, type CreateAlertIntegration, type CreateAlertRule, type CreateAuthToken, type CreateComment, type CreateInvitation, type CreateProject, type CreateUserReport, Err, type Event, type EventDetail, type EventTimeseries, type EventTimeseriesPoint, FIELD_ERROR_CODES, type FieldError, type FieldErrorCode, type GenAiBreakdownRow, type GlobalRole, type Invitation, type InvitationInfo, type Issue, type IssueAggregates, type IssueFilter, type IssueHash, type IssuePriority, type IssueSort, type IssueStats, type IssueStatsWindow, type IssueStatus, type IssueTagValue, type ListAlertHistoryOptions, type ListEventsOptions, type ListIssuesOptions, type ListLogsOptions, type ListProjectsOptions, type ListSourceMapsResponse, type ListSpansOptions, type ListTransactionsOptions, type Log, type LoginRequest, type LoginResult, type MetricDelta, NETWORK_ERROR_MESSAGE, type OffsetPaginatedResponse, Ok, type PaginatedResponse, type PreviewTemplateResponse, type Project, type ProjectListStats, type ProjectMember, type ProjectRole, type ProjectStatsSummary, type ProjectStorage, type ProviderType, type RateLimits, type RegisterRequest, type ReleaseHealthRow, type ReleaseHealthStatsOptions, type Result, type RoutingOverride, RustrakClient, type RustrakError, type RustrakErrorKind, SERVER_ERROR_MESSAGE, type ServerVersion, type SessionSummary, type SessionTimeseries, type SessionTimeseriesPoint, type SortOrder, type SourceMapFile, type SourceMapGcResult, type SourceMapStorage, type Span, type SpanDetail, type SsoConfig, type SsoLink, type SsoStart, type StorageSummary, TIMEOUT_ERROR_MESSAGE, type TagSummary, type TagValueCount, type TeamMember, type TestChannelResponse, type TestIntegrationBody, type Transaction, type TransactionDetail, type TransactionStats, type UpdateAlertIntegration, type UpdateAlertRule, type UpdateIssueState, type UpdateProject, type UpdateUserRole, type UpsertProjectMember, type User, type UserReport, isRetryable, mapResult, unwrap, unwrapOr };

package/dist/index.js

@@ -20,7 +20,7 @@ z.enum([
   "last_seen",
   "event_count"
 ]);
-z.enum(["open", "resolved", "muted", "all"]);
+var issueFilterSchema = z.enum(["open", "resolved", "muted", "all"]);
 var dateTimeSchema = z.string().datetime();
 var uuidSchema = z.string().uuid();
 var eventIdSchema = z.string().regex(
@@ -381,9 +381,10 @@ var bulkUpdateIssuesSchema = z.object({
   status: z.union([issueStatusSchema, z.literal("resolvedInNextRelease")]).optional(),
   priority: issuePrioritySchema.optional()
 });
-var bulkDeleteIssuesSchema = z.object({
-  ids: z.array(uuidSchema)
-});
+var bulkDeleteIssuesSchema = z.union([
+  z.strictObject({ ids: z.array(uuidSchema) }),
+  z.strictObject({ filter: issueFilterSchema })
+]);
 var logSchema = z.object({
   id: uuidSchema,
   trace_id: z.string().nullable(),
@@ -588,6 +589,13 @@ var cleanupCountsSchema = z.object({
   logs: z.number(),
   issues_removed: z.number()
 });
+var cleanupStatusSchema = z.object({
+  state: z.enum(["idle", "running", "completed", "failed"]),
+  removed: cleanupCountsSchema,
+  started_at: z.string().nullable(),
+  finished_at: z.string().nullable(),
+  error: z.string().nullable()
+});
 var sourceMapGcResultSchema = z.object({
   files_removed: z.number(),
   bytes_freed: z.number()
@@ -2374,8 +2382,13 @@ var StorageResource = class extends BaseResource {
     );
   }
   /**
-   * Execute a cleanup: delete data older than `older_than_days` (optionally
-   * scoped to one project) and remove any issue left with zero events.
+   * Start a cleanup: delete data older than `older_than_days` (optionally
+   * scoped to one project) and remove the issues it leaves with zero events.
+   *
+   * Returns as soon as the server has started it, with the `running` status.
+   * The deletion runs in the background; follow it with
+   * {@link getCleanupStatus}. A second start while one is running fails with
+   * a `conflict`.
    */
   async executeCleanup(options) {
     const validatedInput = this.validateInput(options, cleanupOptionsSchema);
@@ -2383,8 +2396,23 @@ var StorageResource = class extends BaseResource {
       return validatedInput;
     }
     return this.request(
-      () => this.http.post("api/storage/cleanup", { json: validatedInput.data }),
-      cleanupCountsSchema
+      () => this.http.post("api/storage/cleanup", {
+        json: validatedInput.data,
+        // No retry: if the first attempt started the cleanup and only its
+        // response was lost, a retry would be refused as a second run and
+        // report a failure for a cleanup that is in fact running.
+        retry: 0
+      }),
+      cleanupStatusSchema
+    );
+  }
+  /**
+   * The running cleanup's progress, or the outcome of the last one.
+   */
+  async getCleanupStatus() {
+    return this.request(
+      () => this.http.get("api/storage/cleanup/status"),
+      cleanupStatusSchema
     );
   }
   /**