@checkstack/common 0.0.2 → 0.0.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @checkstack/common
 
+## 0.0.3
+
+### Patch Changes
+
+- f5b1f49: Added generic `TransportClient` interface for health check strategy transport abstraction.
+
 ## 0.0.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/common",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",

package/src/index.ts

@@ -5,3 +5,5 @@ export * from "./plugin-metadata";
 export * from "./client-definition";
 export * from "./permission-utils";
 export * from "./icons";
+export * from "./transport-client";
+export * from "./json-schema";

package/src/json-schema.ts

@@ -0,0 +1,35 @@
+/**
+ * Generic base JSON Schema property type.
+ * Uses a generic Self parameter for recursive properties to allow proper extension.
+ */
+export interface JsonSchemaPropertyCore<
+  Self = JsonSchemaPropertyCore<unknown>
+> {
+  type?: string;
+  description?: string;
+  enum?: string[];
+  const?: string | number | boolean;
+  properties?: Record<string, Self>;
+  items?: Self;
+  required?: string[];
+  additionalProperties?: boolean | Self;
+  format?: string;
+  default?: unknown;
+  oneOf?: Self[];
+  anyOf?: Self[];
+}
+
+/**
+ * Concrete base JSON Schema property type without extensions.
+ */
+export type JsonSchemaPropertyBase =
+  JsonSchemaPropertyCore<JsonSchemaPropertyBase>;
+
+/**
+ * Base JSON Schema type for object schemas.
+ */
+export interface JsonSchemaBase<TProp = JsonSchemaPropertyBase> {
+  type?: string;
+  properties?: Record<string, TProp>;
+  required?: string[];
+}

package/src/transport-client.ts

@@ -0,0 +1,16 @@
+/**
+ * Generic transport client interface for remote command execution.
+ *
+ * Transport strategies (SSH, SNMP, WinRM) implement this interface to provide
+ * a consistent abstraction for collectors.
+ *
+ * @template TCommand - Command type (e.g., string for SSH, OidRequest for SNMP)
+ * @template TResult - Result type (e.g., { stdout, stderr, exitCode } for SSH)
+ */
+export interface TransportClient<TCommand, TResult> {
+  /**
+   * Execute a command on the remote host.
+   * The command and result types are defined by the transport implementation.
+   */
+  exec(command: TCommand): Promise<TResult>;
+}