@blockscout/autoscout-types 1.8.0 → 1.8.2-alpha.1

package/dist/v1/autoscout.d.ts

@@ -32,6 +32,21 @@ export declare enum DepositType {
     DAIMO = "DEPOSIT_TYPE_DAIMO",
     PROMOTION_FLAT_BONUS = "DEPOSIT_TYPE_PROMOTION_FLAT_BONUS"
 }
+export declare enum PluginVariant {
+    UNSPECIFIED_PLUGIN_VARIANT = "UNSPECIFIED_PLUGIN_VARIANT",
+    STATS = "PLUGIN_VARIANT_STATS",
+    USER_OPS = "PLUGIN_VARIANT_USER_OPS"
+}
+export declare enum PluginStatus {
+    UNSPECIFIED_PLUGIN_STATUS = "UNSPECIFIED_PLUGIN_STATUS",
+    STOPPED = "PLUGIN_STATUS_STOPPED",
+    RUNNING = "PLUGIN_STATUS_RUNNING"
+}
+export declare enum PluginEventType {
+    UNSPECIFIED_PLUGIN_EVENT_TYPE = "UNSPECIFIED_PLUGIN_EVENT_TYPE",
+    STATUS_CHANGE = "PLUGIN_EVENT_TYPE_STATUS_CHANGE",
+    HEALTH_CHANGE = "PLUGIN_EVENT_TYPE_HEALTH_CHANGE"
+}
 export interface HealthStatus {
     ok: boolean;
     last_check: string;
@@ -70,6 +85,7 @@ export interface Deployment {
     total_cost: string;
     health_status: HealthStatus | undefined;
     indexing_status: IndexingStatus | undefined;
+    plugins_status: DeploymentPluginStatuses | undefined;
 }
 export interface DeploymentLog {
     id: number;
@@ -87,6 +103,22 @@ export interface DeploymentHourStorageUsage {
     free_quota_mb: number;
     overage_cost_per_gb_hour: string;
 }
+export interface PluginEvent {
+    variant: PluginVariant;
+    timestamp: string;
+    event_type: PluginEventType;
+    event_data?: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface PluginStatuses {
+    launch_status: PluginStatus;
+    health_status: HealthStatus | undefined;
+}
+export interface DeploymentPluginStatuses {
+    stats_status: PluginStatuses | undefined;
+    user_ops_status: PluginStatuses | undefined;
+}
 export interface UserAction {
     action: string;
     instance_id?: string | undefined;
@@ -229,9 +261,12 @@ export interface GetInstanceRequest {
     instance_id: string;
 }
 export interface ListInstancesRequest {
+    page?: number | undefined;
+    per_page?: number | undefined;
 }
 export interface ListInstancesResponse {
     items: Instance[];
+    pagination: PaginationResult | undefined;
 }
 export interface SearchInstancesRequest {
     instance_id?: number | undefined;
@@ -239,6 +274,7 @@ export interface SearchInstancesRequest {
     instance_slug?: string | undefined;
     user_id?: number | undefined;
     user_email?: string | undefined;
+    deployment_status: DeploymentStatus;
     page?: number | undefined;
     per_page?: number | undefined;
 }
@@ -296,6 +332,35 @@ export interface GetDeploymentLogRequest {
     deployment_id: string;
     id: number;
 }
+export interface ListPluginEventsRequest {
+    deployment_id: string;
+    /**
+     * comma-separated list of plugin variants to return;
+     * see `PluginVariant` for available values
+     */
+    variants: string[];
+    /**
+     * comma-separated list of plugin event types to return;
+     * see `PluginEventType` for available values
+     */
+    event_types: string[];
+    page?: number | undefined;
+    per_page?: number | undefined;
+}
+export interface ListPluginEventsResponse {
+    items: PluginEvent[];
+    pagination: PaginationResult | undefined;
+}
+export interface ListPluginLogsRequest {
+    deployment_id: string;
+    plugin_variant: string;
+    page?: number | undefined;
+    per_page?: number | undefined;
+}
+export interface ListPluginLogsResponse {
+    items: DeploymentLog[];
+    pagination: PaginationResult | undefined;
+}
 export interface GetProfileRequest {
 }
 export interface ListAuthTokensRequest {
@@ -446,7 +511,11 @@ export interface Autoscout {
     GetCurrentDeployment(request: GetCurrentDeploymentRequest): Promise<Deployment>;
     /** Get list of deployments of the instance */
     ListDeployments(request: ListDeploymentsRequest): Promise<ListDeploymentsResponse>;
+    /** Get hourly storage usage information on the deployment */
     GetDeploymentStorageUsage(request: GetDeploymentStorageUsageRequest): Promise<GetDeploymentStorageUsageResponse>;
+    /** Get detailed history of (all) plugin events */
+    ListPluginEvents(request: ListPluginEventsRequest): Promise<ListPluginEventsResponse>;
+    ListPluginLogs(request: ListPluginLogsRequest): Promise<ListPluginLogsResponse>;
     ListDeploymentLogs(request: ListDeploymentLogsRequest): Promise<ListDeploymentLogsResponse>;
     GetDeploymentLog(request: GetDeploymentLogRequest): Promise<DeploymentLog>;
     /** Register new profile */

package/dist/v1/autoscout.js

@@ -5,7 +5,7 @@
 //   protoc               v4.23.4
 // source: v1/autoscout.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DepositType = exports.DepositStatus = exports.UpdateInstanceAction = exports.DeploymentStatus = void 0;
+exports.PluginEventType = exports.PluginStatus = exports.PluginVariant = exports.DepositType = exports.DepositStatus = exports.UpdateInstanceAction = exports.DeploymentStatus = void 0;
 var DeploymentStatus;
 (function (DeploymentStatus) {
     DeploymentStatus["NO_STATUS"] = "NO_STATUS";
@@ -42,3 +42,21 @@ var DepositType;
     DepositType["DAIMO"] = "DEPOSIT_TYPE_DAIMO";
     DepositType["PROMOTION_FLAT_BONUS"] = "DEPOSIT_TYPE_PROMOTION_FLAT_BONUS";
 })(DepositType || (exports.DepositType = DepositType = {}));
+var PluginVariant;
+(function (PluginVariant) {
+    PluginVariant["UNSPECIFIED_PLUGIN_VARIANT"] = "UNSPECIFIED_PLUGIN_VARIANT";
+    PluginVariant["STATS"] = "PLUGIN_VARIANT_STATS";
+    PluginVariant["USER_OPS"] = "PLUGIN_VARIANT_USER_OPS";
+})(PluginVariant || (exports.PluginVariant = PluginVariant = {}));
+var PluginStatus;
+(function (PluginStatus) {
+    PluginStatus["UNSPECIFIED_PLUGIN_STATUS"] = "UNSPECIFIED_PLUGIN_STATUS";
+    PluginStatus["STOPPED"] = "PLUGIN_STATUS_STOPPED";
+    PluginStatus["RUNNING"] = "PLUGIN_STATUS_RUNNING";
+})(PluginStatus || (exports.PluginStatus = PluginStatus = {}));
+var PluginEventType;
+(function (PluginEventType) {
+    PluginEventType["UNSPECIFIED_PLUGIN_EVENT_TYPE"] = "UNSPECIFIED_PLUGIN_EVENT_TYPE";
+    PluginEventType["STATUS_CHANGE"] = "PLUGIN_EVENT_TYPE_STATUS_CHANGE";
+    PluginEventType["HEALTH_CHANGE"] = "PLUGIN_EVENT_TYPE_HEALTH_CHANGE";
+})(PluginEventType || (exports.PluginEventType = PluginEventType = {}));

package/dist/v1/autoscout.ts

@@ -44,6 +44,24 @@ export enum DepositType {
   PROMOTION_FLAT_BONUS = "DEPOSIT_TYPE_PROMOTION_FLAT_BONUS",
 }
 
+export enum PluginVariant {
+  UNSPECIFIED_PLUGIN_VARIANT = "UNSPECIFIED_PLUGIN_VARIANT",
+  STATS = "PLUGIN_VARIANT_STATS",
+  USER_OPS = "PLUGIN_VARIANT_USER_OPS",
+}
+
+export enum PluginStatus {
+  UNSPECIFIED_PLUGIN_STATUS = "UNSPECIFIED_PLUGIN_STATUS",
+  STOPPED = "PLUGIN_STATUS_STOPPED",
+  RUNNING = "PLUGIN_STATUS_RUNNING",
+}
+
+export enum PluginEventType {
+  UNSPECIFIED_PLUGIN_EVENT_TYPE = "UNSPECIFIED_PLUGIN_EVENT_TYPE",
+  STATUS_CHANGE = "PLUGIN_EVENT_TYPE_STATUS_CHANGE",
+  HEALTH_CHANGE = "PLUGIN_EVENT_TYPE_HEALTH_CHANGE",
+}
+
 export interface HealthStatus {
   ok: boolean;
   last_check: string;
@@ -83,6 +101,7 @@ export interface Deployment {
   total_cost: string;
   health_status: HealthStatus | undefined;
   indexing_status: IndexingStatus | undefined;
+  plugins_status: DeploymentPluginStatuses | undefined;
 }
 
 export interface DeploymentLog {
@@ -103,6 +122,23 @@ export interface DeploymentHourStorageUsage {
   overage_cost_per_gb_hour: string;
 }
 
+export interface PluginEvent {
+  variant: PluginVariant;
+  timestamp: string;
+  event_type: PluginEventType;
+  event_data?: { [key: string]: any } | undefined;
+}
+
+export interface PluginStatuses {
+  launch_status: PluginStatus;
+  health_status: HealthStatus | undefined;
+}
+
+export interface DeploymentPluginStatuses {
+  stats_status: PluginStatuses | undefined;
+  user_ops_status: PluginStatuses | undefined;
+}
+
 export interface UserAction {
   action: string;
   instance_id?: string | undefined;
@@ -269,10 +305,13 @@ export interface GetInstanceRequest {
 }
 
 export interface ListInstancesRequest {
+  page?: number | undefined;
+  per_page?: number | undefined;
 }
 
 export interface ListInstancesResponse {
   items: Instance[];
+  pagination: PaginationResult | undefined;
 }
 
 export interface SearchInstancesRequest {
@@ -281,6 +320,7 @@ export interface SearchInstancesRequest {
   instance_slug?: string | undefined;
   user_id?: number | undefined;
   user_email?: string | undefined;
+  deployment_status: DeploymentStatus;
   page?: number | undefined;
   per_page?: number | undefined;
 }
@@ -352,6 +392,39 @@ export interface GetDeploymentLogRequest {
   id: number;
 }
 
+export interface ListPluginEventsRequest {
+  deployment_id: string;
+  /**
+   * comma-separated list of plugin variants to return;
+   * see `PluginVariant` for available values
+   */
+  variants: string[];
+  /**
+   * comma-separated list of plugin event types to return;
+   * see `PluginEventType` for available values
+   */
+  event_types: string[];
+  page?: number | undefined;
+  per_page?: number | undefined;
+}
+
+export interface ListPluginEventsResponse {
+  items: PluginEvent[];
+  pagination: PaginationResult | undefined;
+}
+
+export interface ListPluginLogsRequest {
+  deployment_id: string;
+  plugin_variant: string;
+  page?: number | undefined;
+  per_page?: number | undefined;
+}
+
+export interface ListPluginLogsResponse {
+  items: DeploymentLog[];
+  pagination: PaginationResult | undefined;
+}
+
 export interface GetProfileRequest {
 }
 
@@ -534,7 +607,11 @@ export interface Autoscout {
   GetCurrentDeployment(request: GetCurrentDeploymentRequest): Promise<Deployment>;
   /** Get list of deployments of the instance */
   ListDeployments(request: ListDeploymentsRequest): Promise<ListDeploymentsResponse>;
+  /** Get hourly storage usage information on the deployment */
   GetDeploymentStorageUsage(request: GetDeploymentStorageUsageRequest): Promise<GetDeploymentStorageUsageResponse>;
+  /** Get detailed history of (all) plugin events */
+  ListPluginEvents(request: ListPluginEventsRequest): Promise<ListPluginEventsResponse>;
+  ListPluginLogs(request: ListPluginLogsRequest): Promise<ListPluginLogsResponse>;
   ListDeploymentLogs(request: ListDeploymentLogsRequest): Promise<ListDeploymentLogsResponse>;
   GetDeploymentLog(request: GetDeploymentLogRequest): Promise<DeploymentLog>;
   /** Register new profile */

package/dist/v1/config.d.ts

@@ -48,6 +48,11 @@ export declare enum IndexerBlockTransformer {
     BASE = "BASE",
     CLIQUE = "CLIQUE"
 }
+export declare enum UserOpsTraceClient {
+    UNSPECIFIED_TRACE_CLIENT = "UNSPECIFIED_TRACE_CLIENT",
+    DEBUG = "DEBUG",
+    TRACE = "TRACE"
+}
 export interface DeployConfig {
     rpc_url: string;
     server_size: string;
@@ -97,6 +102,8 @@ export interface DeployConfig {
     google_analytics_property_id?: string | undefined;
     production_ready?: boolean | undefined;
     api_docs_tabs?: StringList | undefined;
+    stats_plugin_config?: StatsPluginConfig | undefined;
+    user_ops_plugin_config?: UserOpsPluginConfig | undefined;
 }
 export interface Footer {
     columns: FooterColumn[];
@@ -279,3 +286,29 @@ export interface ZksyncConfig {
     /** INDEXER_ZKSYNC_BATCHES_STATUS_RECHECK_INTERVAL */
     batches_status_recheck_interval?: string | undefined;
 }
+export interface StatsPluginConfig {
+    enabled: boolean;
+}
+export interface UserOpsPluginConfig {
+    enabled: boolean;
+    rpc_url?: string | undefined;
+    entrypoints_v06?: UserOpsEntrypointConfig | undefined;
+    entrypoints_v07?: UserOpsEntrypointConfig | undefined;
+    entrypoints_v08?: UserOpsEntrypointConfig | undefined;
+    realtime_enabled?: boolean | undefined;
+    realtime_polling_interval?: string | undefined;
+    realtime_polling_block_range?: number | undefined;
+    realtime_max_block_range?: number | undefined;
+    past_rpc_logs_indexer_enabled?: boolean | undefined;
+    past_rpc_logs_indexer_block_range?: number | undefined;
+    past_db_logs_indexer_enabled?: boolean | undefined;
+    past_db_logs_indexer_start_block?: string | undefined;
+    past_db_logs_indexer_end_block?: string | undefined;
+    trace_client: UserOpsTraceClient;
+}
+export interface UserOpsEntrypointConfig {
+    /** / Enabled by default */
+    enabled?: boolean | undefined;
+    /** / Empty - default (see user ops docs for default) */
+    entry_point: string[];
+}

package/dist/v1/config.js

@@ -5,7 +5,7 @@
 //   protoc               v4.23.4
 // source: v1/config.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndexerBlockTransformer = exports.AdBannerProvider = exports.AdTextProvider = exports.Identicon = exports.ColorTheme = exports.NavigationLayout = exports.NodeType = exports.ChainType = void 0;
+exports.UserOpsTraceClient = exports.IndexerBlockTransformer = exports.AdBannerProvider = exports.AdTextProvider = exports.Identicon = exports.ColorTheme = exports.NavigationLayout = exports.NodeType = exports.ChainType = void 0;
 /* eslint-disable */
 var ChainType;
 (function (ChainType) {
@@ -65,3 +65,9 @@ var IndexerBlockTransformer;
     IndexerBlockTransformer["BASE"] = "BASE";
     IndexerBlockTransformer["CLIQUE"] = "CLIQUE";
 })(IndexerBlockTransformer || (exports.IndexerBlockTransformer = IndexerBlockTransformer = {}));
+var UserOpsTraceClient;
+(function (UserOpsTraceClient) {
+    UserOpsTraceClient["UNSPECIFIED_TRACE_CLIENT"] = "UNSPECIFIED_TRACE_CLIENT";
+    UserOpsTraceClient["DEBUG"] = "DEBUG";
+    UserOpsTraceClient["TRACE"] = "TRACE";
+})(UserOpsTraceClient || (exports.UserOpsTraceClient = UserOpsTraceClient = {}));

package/dist/v1/config.ts

@@ -64,6 +64,12 @@ export enum IndexerBlockTransformer {
   CLIQUE = "CLIQUE",
 }
 
+export enum UserOpsTraceClient {
+  UNSPECIFIED_TRACE_CLIENT = "UNSPECIFIED_TRACE_CLIENT",
+  DEBUG = "DEBUG",
+  TRACE = "TRACE",
+}
+
 export interface DeployConfig {
   rpc_url: string;
   server_size: string;
@@ -115,6 +121,8 @@ export interface DeployConfig {
   google_analytics_property_id?: string | undefined;
   production_ready?: boolean | undefined;
   api_docs_tabs?: StringList | undefined;
+  stats_plugin_config?: StatsPluginConfig | undefined;
+  user_ops_plugin_config?: UserOpsPluginConfig | undefined;
 }
 
 export interface Footer {
@@ -384,3 +392,34 @@ export interface ZksyncConfig {
   /** INDEXER_ZKSYNC_BATCHES_STATUS_RECHECK_INTERVAL */
   batches_status_recheck_interval?: string | undefined;
 }
+
+export interface StatsPluginConfig {
+  enabled: boolean;
+}
+
+export interface UserOpsPluginConfig {
+  enabled: boolean;
+  rpc_url?: string | undefined;
+  entrypoints_v06?: UserOpsEntrypointConfig | undefined;
+  entrypoints_v07?: UserOpsEntrypointConfig | undefined;
+  entrypoints_v08?: UserOpsEntrypointConfig | undefined;
+  realtime_enabled?: boolean | undefined;
+  realtime_polling_interval?: string | undefined;
+  realtime_polling_block_range?: number | undefined;
+  realtime_max_block_range?: number | undefined;
+  past_rpc_logs_indexer_enabled?: boolean | undefined;
+  past_rpc_logs_indexer_block_range?: number | undefined;
+  past_db_logs_indexer_enabled?: boolean | undefined;
+  past_db_logs_indexer_start_block?: string | undefined;
+  past_db_logs_indexer_end_block?: string | undefined;
+  trace_client: UserOpsTraceClient;
+}
+
+export interface UserOpsEntrypointConfig {
+  /** / Enabled by default */
+  enabled?:
+    | boolean
+    | undefined;
+  /** / Empty - default (see user ops docs for default) */
+  entry_point: string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockscout/autoscout-types",
-  "version": "1.8.0",
+  "version": "1.8.2-alpha.1",
   "description": "TypeScript definitions for Autoscout microservice",
   "main": "./index.js",
   "types": "./index.d.ts",