@algolia/monitoring 1.26.0 → 1.28.0

package/dist/worker.d.ts

@@ -13,54 +13,54 @@ type Incident = {
     /**
      * Description of the incident.
      */
-    title?: string;
-    status?: Status;
+    title?: string | undefined;
+    status?: Status | undefined;
 };
 
 type IncidentEntry = {
     /**
      * Timestamp, measured in milliseconds since the Unix epoch.
      */
-    t?: number;
-    v?: Incident;
+    t?: number | undefined;
+    v?: Incident | undefined;
 };
 
 type IncidentsResponse = {
     incidents?: {
         [key: string]: Array<IncidentEntry>;
-    };
+    } | undefined;
 };
 
 type TimeEntry = {
     /**
      * Timestamp, measured in milliseconds since the Unix epoch.
      */
-    t?: number;
+    t?: number | undefined;
     /**
      * Time in ms.
      */
-    v?: number;
+    v?: number | undefined;
 };
 
 type IndexingMetric = {
     indexing?: {
         [key: string]: Array<TimeEntry>;
-    };
+    } | undefined;
 };
 
 type IndexingTimeResponse = {
-    metrics?: IndexingMetric;
+    metrics?: IndexingMetric | undefined;
 };
 
 type ProbesMetric = {
     /**
      * Timestamp, measured in milliseconds since the Unix epoch.
      */
-    t?: number;
+    t?: number | undefined;
     /**
      * Value of the metric.
      */
-    v?: number;
+    v?: number | undefined;
 };
 
 type Metrics = {
@@ -69,35 +69,35 @@ type Metrics = {
      */
     cpu_usage?: {
         [key: string]: Array<ProbesMetric>;
-    };
+    } | undefined;
     /**
      * RAM used for indexing in MB.
      */
     ram_indexing_usage?: {
         [key: string]: Array<ProbesMetric>;
-    };
+    } | undefined;
     /**
      * RAM used for search in MB.
      */
     ram_search_usage?: {
         [key: string]: Array<ProbesMetric>;
-    };
+    } | undefined;
     /**
      * Solid-state disk (SSD) usage expressed as % of RAM.  0% means no SSD usage. A value of 50% indicates 32&nbsp;GB SSD usage for a machine with 64&nbsp;RAM.
      */
     ssd_usage?: {
         [key: string]: Array<ProbesMetric>;
-    };
+    } | undefined;
     /**
      * Average build time of the indices in seconds.
      */
     avg_build_time?: {
         [key: string]: Array<ProbesMetric>;
-    };
+    } | undefined;
 };
 
 type InfrastructureResponse = {
-    metrics?: Metrics;
+    metrics?: Metrics | undefined;
 };
 
 /**
@@ -113,42 +113,42 @@ type Server = {
     /**
      * Server name.
      */
-    name?: string;
-    region?: Region;
+    name?: string | undefined;
+    region?: Region | undefined;
     /**
      * Included to support legacy applications. Use `is_replica` instead.
      */
-    is_slave?: boolean;
+    is_slave?: boolean | undefined;
     /**
      * Whether this server is a replica of another server.
      */
-    is_replica?: boolean;
+    is_replica?: boolean | undefined;
     /**
      * Name of the cluster to which this server belongs.
      */
-    cluster?: string;
-    status?: ServerStatus;
-    type?: Type;
+    cluster?: string | undefined;
+    status?: ServerStatus | undefined;
+    type?: Type | undefined;
 };
 
 type InventoryResponse = {
-    inventory?: Array<Server>;
+    inventory?: Array<Server> | undefined;
 };
 
 type LatencyMetric = {
     latency?: {
         [key: string]: Array<TimeEntry>;
-    };
+    } | undefined;
 };
 
 type LatencyResponse = {
-    metrics?: LatencyMetric;
+    metrics?: LatencyMetric | undefined;
 };
 
 type StatusResponse = {
     status?: {
         [key: string]: Status;
-    };
+    } | undefined;
 };
 
 type Metric = 'avg_build_time' | 'ssd_usage' | 'ram_search_usage' | 'ram_indexing_usage' | 'cpu_usage' | '*';
@@ -168,7 +168,7 @@ type CustomDeleteProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customGet` method.
@@ -183,7 +183,7 @@ type CustomGetProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customPost` method.
@@ -198,11 +198,11 @@ type CustomPostProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `customPut` method.
@@ -217,11 +217,11 @@ type CustomPutProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `getClusterIncidents` method.
@@ -282,7 +282,7 @@ type GetReachabilityProps = {
     clusters: string;
 };
 
-declare const apiClientVersion = "1.26.0";
+declare const apiClientVersion = "1.28.0";
 declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -307,7 +307,7 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
      * @param segment - The algolia agent (user-agent) segment to add.
      * @param version - The version of the agent.
      */
-    addAlgoliaAgent(segment: string, version?: string): void;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
     /**
      * Helper method to switch the API key used to authenticate the requests.
      *
@@ -369,7 +369,7 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
      * Retrieves known incidents for all clusters.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getIncidents(requestOptions?: RequestOptions): Promise<IncidentsResponse>;
+    getIncidents(requestOptions?: RequestOptions | undefined): Promise<IncidentsResponse>;
     /**
      * Retrieves average times for indexing operations for selected clusters.
      * @param getIndexingTime - The getIndexingTime object.
@@ -407,35 +407,35 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
      * Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getServers(requestOptions?: RequestOptions): Promise<InventoryResponse>;
+    getServers(requestOptions?: RequestOptions | undefined): Promise<InventoryResponse>;
     /**
      * Retrieves the status of all Algolia clusters and instances.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getStatus(requestOptions?: RequestOptions): Promise<StatusResponse>;
+    getStatus(requestOptions?: RequestOptions | undefined): Promise<StatusResponse>;
 };
 
 type BadRequest = {
-    reason?: string;
+    reason?: string | undefined;
 };
 
 /**
  * Error.
  */
 type ErrorBase = Record<string, any> & {
-    message?: string;
+    message?: string | undefined;
 };
 
 type Forbidden = {
-    reason?: string;
+    reason?: string | undefined;
 };
 
 type Unauthorized = {
-    reason?: string;
+    reason?: string | undefined;
 };
 
 type MonitoringClient = ReturnType<typeof createMonitoringClient>;
 
-declare function monitoringClient(appId: string, apiKey: string, options?: ClientOptions): MonitoringClient;
+declare function monitoringClient(appId: string, apiKey: string, options?: ClientOptions | undefined): MonitoringClient;
 
 export { type BadRequest, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type ErrorBase, type Forbidden, type GetClusterIncidentsProps, type GetClusterStatusProps, type GetIndexingTimeProps, type GetLatencyProps, type GetMetricsProps, type GetReachabilityProps, type Incident, type IncidentEntry, type IncidentsResponse, type IndexingMetric, type IndexingTimeResponse, type InfrastructureResponse, type InventoryResponse, type LatencyMetric, type LatencyResponse, type Metric, type Metrics, type MonitoringClient, type Period, type ProbesMetric, type Region, type Server, type ServerStatus, type Status, type StatusResponse, type TimeEntry, type Type, type Unauthorized, apiClientVersion, monitoringClient };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.26.0",
+  "version": "1.28.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,14 +49,14 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.26.0",
-    "@algolia/requester-browser-xhr": "5.26.0",
-    "@algolia/requester-fetch": "5.26.0",
-    "@algolia/requester-node-http": "5.26.0"
+    "@algolia/client-common": "5.28.0",
+    "@algolia/requester-browser-xhr": "5.28.0",
+    "@algolia/requester-fetch": "5.28.0",
+    "@algolia/requester-node-http": "5.28.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.18.1",
-    "@types/node": "22.15.29",
+    "@arethetypeswrong/cli": "0.18.2",
+    "@types/node": "22.15.31",
     "publint": "0.3.12",
     "rollup": "4.41.0",
     "tsup": "8.5.0",