feat(telemetry): adding telemetry endpoints (#445)

Author: billxinli

src/index.ts

@@ -74,6 +74,9 @@ export type {
   PatchFile,
   PatchRecord,
   PatchViewResponse,
+  TelemetryConfig,
+  PostOrgTelemetryPayload,
+  PostOrgTelemetryResponse,
   QueryParams,
   RequestInfo,
   RequestOptions,

src/socket-sdk-class.ts

@@ -73,6 +73,8 @@ import type {
   GetOptions,
   GotOptions,
   PatchViewResponse,
+  PostOrgTelemetryPayload,
+  PostOrgTelemetryResponse,
   QueryParams,
   RequestOptions,
   SendOptions,
@@ -3481,6 +3483,113 @@ export class SocketSdk {
         })
     })
   }
+
+  /**
+   * Update organization's telemetry configuration.
+   * Enables or disables telemetry for the organization.
+   *
+   * @param orgSlug - Organization identifier
+   * @param telemetryData - Telemetry configuration with enabled flag
+   * @returns Updated telemetry configuration
+   *
+   * @throws {Error} When server returns 5xx status codes
+   */
+  async updateOrgTelemetryConfig(
+    orgSlug: string,
+    telemetryData: { enabled?: boolean | undefined },
+  ): Promise<SocketSdkResult<'updateOrgTelemetryConfig'>> {
+    try {
+      const data = await this.#executeWithRetry(
+        async () =>
+          await getResponseJson(
+            await createRequestWithJson(
+              'PUT',
+              this.#baseUrl,
+              `orgs/${encodeURIComponent(orgSlug)}/telemetry/config`,
+              telemetryData,
+              this.#reqOptions,
+            ),
+          ),
+      )
+      return this.#handleApiSuccess<'updateOrgTelemetryConfig'>(data)
+      /* c8 ignore start - Standard API error handling, tested via public method error cases */
+    } catch (e) {
+      return await this.#handleApiError<'updateOrgTelemetryConfig'>(e)
+    }
+    /* c8 ignore stop */
+  }
+
+  /**
+   * Get organization's telemetry configuration.
+   * Returns whether telemetry is enabled for the organization.
+   *
+   * @param orgSlug - Organization identifier
+   * @returns Telemetry configuration with enabled status
+   *
+   * @throws {Error} When server returns 5xx status codes
+   */
+  async getTelemetryConfig(
+    orgSlug: string,
+  ): Promise<SocketSdkResult<'getOrgTelemetryConfig'>> {
+    try {
+      const data = await this.#executeWithRetry(
+        async () =>
+          await getResponseJson(
+            await createGetRequest(
+              this.#baseUrl,
+              `orgs/${encodeURIComponent(orgSlug)}/telemetry/config`,
+              this.#reqOptions,
+            ),
+          ),
+      )
+      return this.#handleApiSuccess<'getOrgTelemetryConfig'>(data)
+      /* c8 ignore start - Standard API error handling, tested via public method error cases */
+    } catch (e) {
+      return await this.#handleApiError<'getOrgTelemetryConfig'>(e)
+    }
+    /* c8 ignore stop */
+  }
+
+  /**
+   * Post telemetry data for an organization.
+   * Sends telemetry events and analytics data for monitoring and analysis.
+   *
+   * @param orgSlug - Organization identifier
+   * @param telemetryData - Telemetry payload containing events and metrics
+   * @returns Empty object on successful submission
+   *
+   * @throws {Error} When server returns 5xx status codes
+   */
+  async postOrgTelemetry(
+    orgSlug: string,
+    telemetryData: PostOrgTelemetryPayload,
+  ): Promise<SocketSdkGenericResult<PostOrgTelemetryResponse>> {
+    try {
+      const data = (await this.#executeWithRetry(
+        async () =>
+          await getResponseJson(
+            await createRequestWithJson(
+              'POST',
+              this.#baseUrl,
+              `orgs/${encodeURIComponent(orgSlug)}/telemetry`,
+              telemetryData,
+              this.#reqOptions,
+            ),
+          ),
+      )) as PostOrgTelemetryResponse
+      return {
+        cause: undefined,
+        data,
+        error: undefined,
+        status: 200,
+        success: true,
+      }
+      /* c8 ignore start - Standard API error handling, tested via public method error cases */
+    } catch (e) {
+      return this.#createQueryErrorResult<PostOrgTelemetryResponse>(e)
+    }
+    /* c8 ignore stop */
+  }
 }
 
 // Optional live heap trace.

src/types.ts

@@ -423,6 +423,20 @@ export type StreamOrgFullScanOptions = {
   output?: boolean | string | undefined
 }
 
+export type PostOrgTelemetryPayload = Record<string, unknown>
+
+export type PostOrgTelemetryResponse = Record<string, never>
+
+/**
+ * Configuration for telemetry collection.
+ * Controls whether telemetry is enabled and how events are collected.
+ */
+export interface TelemetryConfig {
+  telemetry: {
+    enabled: boolean
+  }
+}
+
 export type UploadManifestFilesOptions = {
   pathsRelativeTo?: string | undefined
 }

test/unit/socket-sdk-api-methods.coverage.test.mts

@@ -152,6 +152,20 @@ describe('SocketSdk - API Methods Coverage', () => {
         } else if (url.includes('/quota')) {
           // Quota endpoint
           res.end(JSON.stringify({ data: { limit: 1000, used: 100 } }))
+        } else if (url.includes('/telemetry/config')) {
+          // Telemetry config endpoint
+          if (req.method === 'PUT') {
+            res.end(JSON.stringify({ telemetry: { enabled: true } }))
+          } else {
+            res.end(JSON.stringify({ telemetry: { enabled: false } }))
+          }
+        } else if (url.includes('/telemetry')) {
+          // Telemetry POST endpoint (must come before generic /settings)
+          if (req.method === 'POST') {
+            res.end(JSON.stringify({}))
+          } else {
+            res.end(JSON.stringify({}))
+          }
         } else if (url.includes('/settings')) {
           // Settings endpoint
           res.end(JSON.stringify({ data: { success: true } }))
@@ -492,6 +506,42 @@ describe('SocketSdk - API Methods Coverage', () => {
     })
   })
 
+  describe('Telemetry Methods', () => {
+    it('covers getTelemetryConfig', async () => {
+      const result = await client.getTelemetryConfig('test-org')
+      expect(result.success).toBe(true)
+      if (result.success) {
+        expect(result.data).toBeDefined()
+        expect(result.data.telemetry).toBeDefined()
+        expect(result.data.telemetry.enabled).toBe(false)
+      }
+    })
+
+    it('covers updateOrgTelemetryConfig', async () => {
+      const result = await client.updateOrgTelemetryConfig('test-org', {
+        enabled: true,
+      })
+      expect(result.success).toBe(true)
+      if (result.success) {
+        expect(result.data).toBeDefined()
+        expect(result.data.telemetry).toBeDefined()
+        expect(result.data.telemetry.enabled).toBe(true)
+      }
+    })
+
+    it('covers postOrgTelemetry', async () => {
+      const result = await client.postOrgTelemetry('test-org', {
+        event: 'test-event',
+        timestamp: Date.now(),
+      })
+      expect(result.success).toBe(true)
+      if (result.success) {
+        expect(result.data).toBeDefined()
+        expect(result.data).toEqual({})
+      }
+    })
+  })
+
   describe('API Token Methods', () => {
     it('covers getAPITokens', async () => {
       const result = await client.getAPITokens('test-org')