octoparse-cli 0.1.14

package/schemas/capabilities-v1.schema.json

@@ -0,0 +1,234 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://octoparse.local/schemas/capabilities-v1.schema.json",
+  "title": "Octo Engine Capabilities Response v1",
+  "description": "Full response shape for octoparse capabilities --json.",
+  "type": "object",
+  "required": ["ok", "data"],
+  "properties": {
+    "ok": { "const": true },
+    "data": {
+      "type": "object",
+      "required": [
+        "name",
+        "version",
+        "agentContractVersion",
+        "authentication",
+        "output",
+        "machineContract",
+        "exitCodes",
+        "commands",
+        "dataSources",
+        "exportFormats",
+        "env"
+      ],
+      "properties": {
+        "name": { "const": "octoparse" },
+        "version": {
+          "type": "string",
+          "minLength": 1
+        },
+        "agentContractVersion": { "const": 1 },
+        "authentication": {
+          "type": "object",
+          "required": [
+            "requiredForUse",
+            "loginVerifiesKeyBeforeSaving",
+            "setupCommandsWithoutAuth",
+            "diagnosticCommandsWithoutAuth",
+            "env",
+            "file"
+          ],
+          "properties": {
+            "requiredForUse": { "const": true },
+            "loginVerifiesKeyBeforeSaving": { "const": true },
+            "setupCommandsWithoutAuth": {
+              "type": "array",
+              "items": { "type": "string" }
+            },
+            "diagnosticCommandsWithoutAuth": {
+              "type": "array",
+              "items": { "type": "string" }
+            },
+            "env": { "const": "OCTO_ENGINE_API_KEY" },
+            "file": { "type": "string" }
+          },
+          "additionalProperties": true
+        },
+        "output": {
+          "type": "object",
+          "required": ["jsonEnvelope", "jsonlEvents", "detachedBootstrap", "stdout", "stderr"],
+          "properties": {
+            "jsonEnvelope": { "type": "object" },
+            "jsonlEvents": {
+              "type": "array",
+              "items": { "type": "string" }
+            },
+            "detachedBootstrap": {
+              "type": "array",
+              "items": { "type": "string" }
+            },
+            "stdout": { "type": "string" },
+            "stderr": { "type": "string" }
+          },
+          "additionalProperties": true
+        },
+        "machineContract": {
+          "type": "object",
+          "required": ["stable", "defaultOutput", "schemas", "json", "jsonl", "artifacts", "lifecycle"],
+          "properties": {
+            "stable": { "const": true },
+            "defaultOutput": { "const": "human" },
+            "schemas": {
+              "type": "object",
+              "required": ["capabilities", "jsonEnvelope", "runEvent", "detachedBootstrap"],
+              "properties": {
+                "capabilities": { "type": "string" },
+                "jsonEnvelope": { "type": "string" },
+                "runEvent": { "type": "string" },
+                "detachedBootstrap": { "type": "string" }
+              },
+              "additionalProperties": true
+            },
+            "json": {
+              "type": "object",
+              "required": ["flag", "envelope", "usageErrorsUseEnvelope", "commonErrorCodes"],
+              "properties": {
+                "flag": { "const": "--json" },
+                "envelope": {
+                  "type": "object",
+                  "required": ["successRequiredFields", "failureRequiredFields"],
+                  "properties": {
+                    "successRequiredFields": {
+                      "type": "array",
+                      "items": { "type": "string" }
+                    },
+                    "failureRequiredFields": {
+                      "type": "array",
+                      "items": { "type": "string" }
+                    }
+                  },
+                  "additionalProperties": true
+                },
+                "usageErrorsUseEnvelope": { "const": true },
+                "commonErrorCodes": {
+                  "type": "array",
+                  "items": { "type": "string" }
+                }
+              },
+              "additionalProperties": true
+            },
+            "jsonl": {
+              "type": "object",
+              "required": ["flag", "command", "eventField", "stableEvents"],
+              "properties": {
+                "flag": { "const": "--jsonl" },
+                "command": { "const": "run <taskId>" },
+                "eventField": { "const": "event" },
+                "stableEvents": {
+                  "type": "array",
+                  "items": { "type": "string" }
+                }
+              },
+              "additionalProperties": true
+            },
+            "artifacts": {
+              "type": "object",
+              "required": ["localRunDir", "detachedBootstrapDir"],
+              "properties": {
+                "localRunDir": {
+                  "type": "array",
+                  "items": { "type": "string" }
+                },
+                "detachedBootstrapDir": {
+                  "type": "array",
+                  "items": { "type": "string" }
+                }
+              },
+              "additionalProperties": true
+            },
+            "lifecycle": {
+              "type": "object",
+              "required": [
+                "detachModel",
+                "daemonRequired",
+                "activeRunIdentity",
+                "artifactRunIdentity",
+                "maxActiveLocalRunsPerTaskId",
+                "orphanDetection",
+                "cleanupCommands"
+              ],
+              "properties": {
+                "detachModel": { "const": "child-process" },
+                "daemonRequired": { "const": false },
+                "activeRunIdentity": { "const": "taskId" },
+                "artifactRunIdentity": { "const": "runId" },
+                "maxActiveLocalRunsPerTaskId": {
+                  "type": "integer",
+                  "minimum": 1
+                },
+                "orphanDetection": { "type": "boolean" },
+                "cleanupCommands": {
+                  "type": "array",
+                  "items": { "type": "string" }
+                }
+              },
+              "additionalProperties": true
+            }
+          },
+          "additionalProperties": true
+        },
+        "exitCodes": {
+          "type": "object",
+          "required": ["0", "1", "2", "3"],
+          "additionalProperties": { "type": "string" }
+        },
+        "commands": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["command", "risk", "json", "authRequired"],
+            "properties": {
+              "command": { "type": "string" },
+              "risk": {
+                "type": "string",
+                "enum": ["low", "medium", "high"]
+              },
+              "json": { "type": "boolean" },
+              "jsonl": { "type": "boolean" },
+              "authRequired": { "type": "boolean" },
+              "hidden": { "type": "boolean" },
+              "internal": { "type": "boolean" }
+            },
+            "additionalProperties": true
+          }
+        },
+        "dataSources": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["local", "cloud"]
+          }
+        },
+        "exportFormats": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["xlsx", "csv", "html", "json", "xml"]
+          }
+        },
+        "env": {
+          "type": "object",
+          "required": ["apiKey", "apiBaseUrl"],
+          "properties": {
+            "apiKey": { "const": "OCTO_ENGINE_API_KEY" },
+            "apiBaseUrl": { "const": "OCTO_ENGINE_API_BASE_URL" }
+          },
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": true
+}

package/schemas/detached-bootstrap-v1.schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://octoparse.local/schemas/detached-bootstrap-v1.schema.json",
+  "title": "Octo Engine Detached Bootstrap v1",
+  "description": "bootstrap.json written under <output>/.detach_<taskId>_<timestamp>/ for detached run startup observability.",
+  "type": "object",
+  "properties": {
+    "taskId": { "type": "string" },
+    "pid": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "status": {
+      "type": "string",
+      "enum": ["spawning", "spawned", "starting", "running", "completed", "failed", "stopped"]
+    },
+    "runId": { "type": "string" },
+    "lotId": { "type": "string" },
+    "taskName": { "type": "string" },
+    "outputDir": { "type": "string" },
+    "stdout": { "type": "string" },
+    "stderr": { "type": "string" },
+    "error": { "type": "string" },
+    "total": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "updatedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "stoppedAt": {
+      "type": "string",
+      "format": "date-time"
+    }
+  },
+  "additionalProperties": true
+}

package/schemas/json-envelope-v1.schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://octoparse.local/schemas/json-envelope-v1.schema.json",
+  "title": "Octo Engine JSON Envelope v1",
+  "description": "Common --json response envelope. Commands return exactly one object matching either the success or failure branch.",
+  "oneOf": [
+    {
+      "type": "object",
+      "required": ["ok", "data"],
+      "properties": {
+        "ok": { "const": true },
+        "data": true
+      },
+      "additionalProperties": true
+    },
+    {
+      "type": "object",
+      "required": ["ok", "error"],
+      "properties": {
+        "ok": { "const": false },
+        "error": {
+          "type": "object",
+          "required": ["code", "message"],
+          "properties": {
+            "code": {
+              "type": "string",
+              "minLength": 1
+            },
+            "message": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    }
+  ]
+}

package/schemas/run-event-v1.schema.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://octoparse.local/schemas/run-event-v1.schema.json",
+  "title": "Octo Engine Run JSONL Event v1",
+  "description": "One line from octoparse run <taskId> --jsonl. The event field is stable; additional fields may be added.",
+  "type": "object",
+  "required": ["event"],
+  "properties": {
+    "event": {
+      "type": "string",
+      "enum": [
+        "run.started",
+        "row",
+        "log",
+        "run.paused",
+        "run.resumed",
+        "captcha",
+        "proxy",
+        "run.stopping",
+        "run.stopped"
+      ]
+    },
+    "runId": { "type": "string" },
+    "lotId": { "type": "string" },
+    "taskId": { "type": "string" },
+    "taskName": { "type": "string" },
+    "status": {
+      "type": "string",
+      "enum": ["running", "paused", "stopping", "completed", "failed", "stopped"]
+    },
+    "total": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "level": { "type": "string" },
+    "message": { "type": "string" },
+    "reason": { "type": "string" },
+    "stopReason": { "type": "string" },
+    "maxRows": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "data": true,
+    "outputDir": { "type": "string" }
+  },
+  "additionalProperties": true
+}