@fatagnus/remote-cmd-relay-convex 1.0.0

package/src/_generated/component.ts

@@ -0,0 +1,565 @@
+/* eslint-disable */
+/**
+ * Generated `ComponentApi` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type { FunctionReference } from "convex/server";
+
+/**
+ * A utility for referencing a Convex component's exposed API.
+ *
+ * Useful when expecting a parameter like `components.myComponent`.
+ * Usage:
+ * ```ts
+ * async function myFunction(ctx: QueryCtx, component: ComponentApi) {
+ *   return ctx.runQuery(component.someFile.someQuery, { ...args });
+ * }
+ * ```
+ */
+export type ComponentApi<Name extends string | undefined = string | undefined> =
+  {
+    assignments: {
+      create: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          apiKeyId: string;
+          createdBy: string;
+          machineId: string;
+          name: string;
+        },
+        string,
+        Name
+      >;
+      getByApiKeyId: FunctionReference<
+        "query",
+        "internal",
+        { apiKeyId: string },
+        {
+          _id: string;
+          apiKeyId: string;
+          createdAt: number;
+          createdBy: string;
+          enabled: boolean;
+          lastSeenAt?: number;
+          machineId: string;
+          name: string;
+          updatedAt: number;
+        } | null,
+        Name
+      >;
+      heartbeat: FunctionReference<
+        "mutation",
+        "internal",
+        { apiKeyId: string },
+        null,
+        Name
+      >;
+      listAll: FunctionReference<
+        "query",
+        "internal",
+        {},
+        Array<{
+          _id: string;
+          apiKeyId: string;
+          createdAt: number;
+          createdBy: string;
+          enabled: boolean;
+          lastSeenAt?: number;
+          machineId: string;
+          name: string;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      listByMachineId: FunctionReference<
+        "query",
+        "internal",
+        { machineId: string },
+        Array<{
+          _id: string;
+          apiKeyId: string;
+          createdAt: number;
+          createdBy: string;
+          enabled: boolean;
+          lastSeenAt?: number;
+          machineId: string;
+          name: string;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      remove: FunctionReference<
+        "mutation",
+        "internal",
+        { id: string },
+        null,
+        Name
+      >;
+      update: FunctionReference<
+        "mutation",
+        "internal",
+        { enabled?: boolean; id: string; name?: string },
+        null,
+        Name
+      >;
+    };
+    commands: {
+      claim: FunctionReference<
+        "mutation",
+        "internal",
+        { claimedBy: string; id: string },
+        boolean,
+        Name
+      >;
+      complete: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          durationMs?: number;
+          error?: string;
+          exitCode?: number;
+          id: string;
+          output?: string;
+          stderr?: string;
+          success: boolean;
+        },
+        null,
+        Name
+      >;
+      get: FunctionReference<
+        "query",
+        "internal",
+        { id: string },
+        {
+          _id: string;
+          claimedAt?: number;
+          claimedBy?: string;
+          command: string;
+          completedAt?: number;
+          createdAt: number;
+          createdBy: string;
+          durationMs?: number;
+          error?: string;
+          exitCode?: number;
+          machineId: string;
+          output?: string;
+          status:
+            | "pending"
+            | "claimed"
+            | "executing"
+            | "completed"
+            | "failed"
+            | "timeout";
+          stderr?: string;
+          targetHost?: string;
+          targetPort?: number;
+          targetType: "local" | "ssh";
+          targetUsername?: string;
+          timeoutMs: number;
+          updatedAt: number;
+        } | null,
+        Name
+      >;
+      listPending: FunctionReference<
+        "query",
+        "internal",
+        { limit?: number; machineId: string },
+        Array<{
+          _id: string;
+          command: string;
+          createdAt: number;
+          createdBy: string;
+          machineId: string;
+          status:
+            | "pending"
+            | "claimed"
+            | "executing"
+            | "completed"
+            | "failed"
+            | "timeout";
+          targetHost?: string;
+          targetPort?: number;
+          targetType: "local" | "ssh";
+          targetUsername?: string;
+          timeoutMs: number;
+        }>,
+        Name
+      >;
+      listRecent: FunctionReference<
+        "query",
+        "internal",
+        { limit?: number; machineId: string },
+        Array<{
+          _id: string;
+          command: string;
+          completedAt?: number;
+          createdAt: number;
+          durationMs?: number;
+          error?: string;
+          exitCode?: number;
+          machineId: string;
+          status:
+            | "pending"
+            | "claimed"
+            | "executing"
+            | "completed"
+            | "failed"
+            | "timeout";
+          targetType: "local" | "ssh";
+        }>,
+        Name
+      >;
+      queue: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          command: string;
+          createdBy: string;
+          machineId: string;
+          targetHost?: string;
+          targetPort?: number;
+          targetType: "local" | "ssh";
+          targetUsername?: string;
+          timeoutMs?: number;
+        },
+        string,
+        Name
+      >;
+      startExecution: FunctionReference<
+        "mutation",
+        "internal",
+        { id: string },
+        null,
+        Name
+      >;
+    };
+    configPush: {
+      get: FunctionReference<
+        "query",
+        "internal",
+        { id: string },
+        {
+          _id: string;
+          ackedAt?: number;
+          createdAt: number;
+          errorMessage?: string;
+          payload: string;
+          pushType: string;
+          relayId: string;
+          status: string;
+        } | null,
+        Name
+      >;
+      listAll: FunctionReference<
+        "query",
+        "internal",
+        {},
+        Array<{
+          _id: string;
+          createdAt: number;
+          payload: string;
+          pushType: string;
+          relayId: string;
+          status: string;
+        }>,
+        Name
+      >;
+      queue: FunctionReference<
+        "mutation",
+        "internal",
+        { payload: string; pushType: string; relayId: string },
+        string,
+        Name
+      >;
+    };
+    credentials: {
+      create: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          assignedRelays: Array<string>;
+          credentialType: "ssh_key" | "password" | "api_key";
+          encryptedValue: string;
+          name: string;
+          targetHost?: string;
+        },
+        string,
+        Name
+      >;
+      listAll: FunctionReference<
+        "query",
+        "internal",
+        {},
+        Array<{
+          _id: string;
+          assignedRelays: Array<string>;
+          createdAt: number;
+          credentialType: "ssh_key" | "password" | "api_key";
+          name: string;
+          targetHost?: string;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      listByRelay: FunctionReference<
+        "query",
+        "internal",
+        { relayId: string },
+        Array<{
+          _id: string;
+          credentialName: string;
+          credentialType: "ssh_key" | "password" | "api_key";
+          lastUpdatedAt: number;
+          relayId: string;
+          reportedAt: number;
+          storageMode: "relay_only" | "shared";
+          targetHost?: string;
+        }>,
+        Name
+      >;
+      remove: FunctionReference<
+        "mutation",
+        "internal",
+        { id: string },
+        null,
+        Name
+      >;
+    };
+    public: {
+      acknowledgeConfigPush: FunctionReference<
+        "mutation",
+        "internal",
+        { errorMessage?: string; pushId: string; success: boolean },
+        { success: boolean },
+        Name
+      >;
+      claimCommand: FunctionReference<
+        "mutation",
+        "internal",
+        { assignmentId: string; commandId: string },
+        | {
+            command: {
+              _id: string;
+              command: string;
+              targetHost?: string;
+              targetPort?: number;
+              targetType: "local" | "ssh";
+              targetUsername?: string;
+              timeoutMs: number;
+            };
+            success: true;
+          }
+        | { error: string; success: false },
+        Name
+      >;
+      getPendingCommands: FunctionReference<
+        "query",
+        "internal",
+        { machineId: string },
+        Array<{
+          _id: string;
+          command: string;
+          createdAt: number;
+          targetHost?: string;
+          targetPort?: number;
+          targetType: "local" | "ssh";
+          targetUsername?: string;
+          timeoutMs: number;
+        }>,
+        Name
+      >;
+      getPendingConfigPushes: FunctionReference<
+        "query",
+        "internal",
+        { relayId: string },
+        Array<{
+          _id: string;
+          createdAt: number;
+          payload: string;
+          pushType: string;
+        }>,
+        Name
+      >;
+      getSharedCredentials: FunctionReference<
+        "query",
+        "internal",
+        { relayId: string },
+        Array<{
+          credentialType: "ssh_key" | "password" | "api_key";
+          encryptedValue: string;
+          name: string;
+          targetHost?: string;
+          updatedAt: number;
+        }>,
+        Name
+      >;
+      reportFullStatus: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          capabilities: Array<"ssh" | "local_cmd" | "perf_metrics">;
+          credentials: Array<{
+            credentialName: string;
+            credentialType: "ssh_key" | "password" | "api_key";
+            lastUpdatedAt: number;
+            storageMode: "relay_only" | "shared";
+            targetHost?: string;
+          }>;
+          hostname?: string;
+          metrics?: {
+            cpuPercent?: number;
+            diskPercent?: number;
+            diskTotalGb?: number;
+            diskUsedGb?: number;
+            loadAvg15m?: number;
+            loadAvg1m?: number;
+            loadAvg5m?: number;
+            memoryPercent?: number;
+            memoryTotalMb?: number;
+            memoryUsedMb?: number;
+          };
+          platform?: string;
+          relayId: string;
+          version?: string;
+        },
+        {
+          pendingConfigPushes: number;
+          sharedCredentialsCount: number;
+          success: boolean;
+        },
+        Name
+      >;
+      sendHeartbeat: FunctionReference<
+        "mutation",
+        "internal",
+        { apiKeyId: string },
+        { success: boolean },
+        Name
+      >;
+      submitResult: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          commandId: string;
+          durationMs?: number;
+          error?: string;
+          exitCode?: number;
+          output?: string;
+          stderr?: string;
+          success: boolean;
+        },
+        { success: boolean },
+        Name
+      >;
+      verifyRelay: FunctionReference<
+        "query",
+        "internal",
+        { apiKeyId: string },
+        | { assignmentId: string; machineId: string; name: string; valid: true }
+        | { error: string; valid: false },
+        Name
+      >;
+    };
+    status: {
+      findByCapability: FunctionReference<
+        "query",
+        "internal",
+        { capability: "ssh" | "local_cmd" | "perf_metrics" },
+        Array<{
+          capabilities: Array<"ssh" | "local_cmd" | "perf_metrics">;
+          isOnline: boolean;
+          lastHeartbeatAt: number;
+          relayId: string;
+        }>,
+        Name
+      >;
+      getByRelayId: FunctionReference<
+        "query",
+        "internal",
+        { relayId: string },
+        {
+          _id: string;
+          capabilities: Array<"ssh" | "local_cmd" | "perf_metrics">;
+          createdAt: number;
+          hostname?: string;
+          lastHeartbeatAt: number;
+          metrics?: {
+            cpuPercent?: number;
+            diskPercent?: number;
+            diskTotalGb?: number;
+            diskUsedGb?: number;
+            loadAvg15m?: number;
+            loadAvg1m?: number;
+            loadAvg5m?: number;
+            memoryPercent?: number;
+            memoryTotalMb?: number;
+            memoryUsedMb?: number;
+          };
+          platform?: string;
+          relayId: string;
+          updatedAt: number;
+          version?: string;
+        } | null,
+        Name
+      >;
+      listAll: FunctionReference<
+        "query",
+        "internal",
+        {},
+        Array<{
+          _id: string;
+          capabilities: Array<"ssh" | "local_cmd" | "perf_metrics">;
+          hostname?: string;
+          isOnline: boolean;
+          lastHeartbeatAt: number;
+          metrics?: {
+            cpuPercent?: number;
+            diskPercent?: number;
+            diskTotalGb?: number;
+            diskUsedGb?: number;
+            loadAvg15m?: number;
+            loadAvg1m?: number;
+            loadAvg5m?: number;
+            memoryPercent?: number;
+            memoryTotalMb?: number;
+            memoryUsedMb?: number;
+          };
+          platform?: string;
+          relayId: string;
+          version?: string;
+        }>,
+        Name
+      >;
+      reportStatus: FunctionReference<
+        "mutation",
+        "internal",
+        {
+          capabilities: Array<"ssh" | "local_cmd" | "perf_metrics">;
+          hostname?: string;
+          metrics?: {
+            cpuPercent?: number;
+            diskPercent?: number;
+            diskTotalGb?: number;
+            diskUsedGb?: number;
+            loadAvg15m?: number;
+            loadAvg1m?: number;
+            loadAvg5m?: number;
+            memoryPercent?: number;
+            memoryTotalMb?: number;
+            memoryUsedMb?: number;
+          };
+          platform?: string;
+          relayId: string;
+          version?: string;
+        },
+        { statusId?: string; success: boolean },
+        Name
+      >;
+    };
+  };

package/src/_generated/dataModel.ts

@@ -0,0 +1,60 @@
+/* eslint-disable */
+/**
+ * Generated data model types.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+
+import type {
+  DataModelFromSchemaDefinition,
+  DocumentByName,
+  TableNamesInDataModel,
+  SystemTableNames,
+} from "convex/server";
+import type { GenericId } from "convex/values";
+import schema from "../schema.js";
+
+/**
+ * The names of all of your Convex tables.
+ */
+export type TableNames = TableNamesInDataModel<DataModel>;
+
+/**
+ * The type of a document stored in Convex.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Doc<TableName extends TableNames> = DocumentByName<
+  DataModel,
+  TableName
+>;
+
+/**
+ * An identifier for a document in Convex.
+ *
+ * Convex documents are uniquely identified by their `Id`, which is accessible
+ * on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids).
+ *
+ * Documents can be loaded using `db.get(tableName, id)` in query and mutation functions.
+ *
+ * IDs are just strings at runtime, but this type can be used to distinguish them from other
+ * strings when type checking.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Id<TableName extends TableNames | SystemTableNames> =
+  GenericId<TableName>;
+
+/**
+ * A type describing your Convex data model.
+ *
+ * This type includes information about what tables you have, the type of
+ * documents stored in those tables, and the indexes defined on them.
+ *
+ * This type is used to parameterize methods like `queryGeneric` and
+ * `mutationGeneric` to make them type-safe.
+ */
+export type DataModel = DataModelFromSchemaDefinition<typeof schema>;