@boxd-sh/convex 0.1.0

package/dist/component/machines.d.ts

@@ -0,0 +1,337 @@
+/**
+ * Machines: reactive queries over the `machines` table, the bookkeeping
+ * mutations behind them, and the lifecycle actions that call boxd and write
+ * back what they observed.
+ */
+export declare const get: import("convex/server").RegisteredQuery<"public", {
+    ownerId?: string | undefined;
+    machineId: string;
+}, Promise<{
+    _id: import("convex/values").GenericId<"machines">;
+    _creationTime: number;
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+} | null>>;
+/** The owner's machines, newest first. Destroyed machines stay listed. */
+export declare const list: import("convex/server").RegisteredQuery<"public", {
+    ownerId?: string | undefined;
+    limit?: number | undefined;
+}, Promise<{
+    _id: import("convex/values").GenericId<"machines">;
+    _creationTime: number;
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+}[]>>;
+export declare const record: import("convex/server").RegisteredQuery<"internal", {
+    machineId: string;
+}, Promise<{
+    _id: import("convex/values").GenericId<"machines">;
+    _creationTime: number;
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+} | null>>;
+/**
+ * Insert a machine's row or refresh it with what boxd reported. `ownerId`
+ * and `forkedFrom` are set once, on insert. A success clears `lastError`.
+ * "destroyed" is final: an action that read the machine before a concurrent
+ * destroy finished must not bring the row back to life.
+ */
+export declare const upsert: import("convex/server").RegisteredMutation<"internal", {
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+}, Promise<{
+    _id: import("convex/values").GenericId<"machines">;
+    _creationTime: number;
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+}>>;
+export declare const setError: import("convex/server").RegisteredMutation<"internal", {
+    machineId: string;
+    error: string;
+}, Promise<null>>;
+/** Keep the row, and with it the execution history, as a record. */
+export declare const markDestroyed: import("convex/server").RegisteredMutation<"internal", {
+    machineId: string;
+}, Promise<{
+    status: string;
+    lastError: undefined;
+    updatedAt: number;
+    _id: import("convex/values").GenericId<"machines">;
+    _creationTime: number;
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    machineId: string;
+    name: string;
+} | null>>;
+export declare const create: import("convex/server").RegisteredAction<"public", {
+    env?: Record<string, string> | undefined;
+    ownerId?: string | undefined;
+    autoDestroySeconds?: number | undefined;
+    autoSuspendSeconds?: number | undefined;
+    image?: string | undefined;
+    isolated?: boolean | undefined;
+    memory?: string | undefined;
+    name?: string | undefined;
+    readyTimeoutMs?: number | undefined;
+    vcpu?: number | undefined;
+    waitUntilReady?: boolean | undefined;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/**
+ * Fork a running machine: a copy of its disk and memory, booted as a new
+ * machine. The fork has the source's owner and records `forkedFrom`.
+ */
+export declare const fork: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    name?: string | undefined;
+    readyTimeoutMs?: number | undefined;
+    waitUntilReady?: boolean | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Re-read the machine from boxd into its row. */
+export declare const refresh: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Boot a stopped machine (cold boot: disk kept, memory not). */
+export declare const start: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    readyTimeoutMs?: number | undefined;
+    waitUntilReady?: boolean | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Shut the machine down. The disk is kept. */
+export declare const stop: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Suspend to RAM: frozen in place, resumes in milliseconds. */
+export declare const pause: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Resume a paused machine. */
+export declare const resume: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    readyTimeoutMs?: number | undefined;
+    waitUntilReady?: boolean | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Suspend to disk: frees the host's memory, `wake` restores it. */
+export declare const hibernate: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Restore a hibernated machine, memory included. */
+export declare const wake: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    readyTimeoutMs?: number | undefined;
+    waitUntilReady?: boolean | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/** Destroy the machine. Its row stays, with status "destroyed". */
+export declare const destroy: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    machineId: string;
+}, Promise<{
+    ownerId?: string | undefined;
+    image?: string | undefined;
+    vcpu?: number | undefined;
+    url?: string | undefined;
+    memoryBytes?: number | undefined;
+    forkedFrom?: string | undefined;
+    lastError?: string | undefined;
+    machineId: string;
+    name: string;
+    status: string;
+    updatedAt: number;
+    _creationTime: number;
+    _id: import("convex/values").GenericId<"machines">;
+}>>;
+/**
+ * Route public HTTPS to a port inside the machine. Without `name`, this
+ * points the machine's default URL (`https://<machine>.<zone>`) at `port`.
+ * With `name`, it adds `https://<name>.<machine>.<zone>` beside it.
+ */
+export declare const expose: import("convex/server").RegisteredAction<"public", {
+    ownerId?: string | undefined;
+    name?: string | undefined;
+    machineId: string;
+    port: number;
+}, Promise<{
+    url: string;
+    port: number;
+}>>;
+//# sourceMappingURL=machines.d.ts.map

package/dist/component/machines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"machines.d.ts","sourceRoot":"","sources":["../../src/component/machines.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAwCH,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;UAUd,CAAC;AAEH,0EAA0E;AAC1E,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;KAUf,CAAC;AAIH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;UASjB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;GAgCjB,CAAC;AAEH,eAAO,MAAM,QAAQ;;;iBAgBnB,CAAC;AAEH,oEAAoE;AACpE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;UAiBxB,CAAC;AA+FH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CjB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;GAqBf,CAAC;AAEH,kDAAkD;AAClD,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;GAOlB,CAAC;AAiGH,iEAAiE;AACjE,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;GAAkB,CAAC;AACrC,+CAA+C;AAC/C,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;GAAmB,CAAC;AACrC,gEAAgE;AAChE,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;GAAoB,CAAC;AACvC,+BAA+B;AAC/B,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;GAAmB,CAAC;AACvC,oEAAoE;AACpE,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;GAAwB,CAAC;AAC/C,qDAAqD;AACrD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;GAAiB,CAAC;AAEnC,mEAAmE;AACnE,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;GAiBlB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,MAAM;;;;;;;;GAgCjB,CAAC"}