@alwaysai/device-agent-schemas 3.3.0 → 3.3.1

package/src/schemas/app-install-response-schema.json

@@ -0,0 +1,38 @@
+{
+  "$id": "https://alwaysai.co/app-install-response-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_install_response",
+  "type": "object",
+  "properties": {
+    "appInstallResponse": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        },
+        "appReleaseHash": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+        },
+        "appInstallPayload": {
+          "type": "object",
+          "properties": {
+            "appSignedUrl": {
+              "type": "string"
+            }
+          },
+          "required": ["appSignedUrl"]
+        },
+        "modelsInstallPayload": {
+          "$ref": "https://alwaysai.co/models-install-payload-schema.json"
+        }
+      },
+      "required": [
+        "projectId",
+        "appReleaseHash",
+        "appInstallPayload",
+        "modelsInstallPayload"
+      ]
+    }
+  },
+  "required": ["appInstallResponse"]
+}

package/src/schemas/app-install-schema.json

@@ -0,0 +1,25 @@
+{
+  "$id": "https://alwaysai.co/app-install-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_install",
+  "type": "object",
+  "properties": {
+    "baseCommand": {
+      "type": "string",
+      "enum": ["install"]
+    },
+    "projectId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+    },
+    "appReleaseHash": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+    },
+    "appConfig":{
+      "type": "string"
+    },
+    "envVars": {
+      "type": "string"
+    }
+  },
+  "required": ["baseCommand", "projectId", "appReleaseHash"]
+}

package/src/schemas/app-logs-schema.json

@@ -0,0 +1,15 @@
+{
+  "$id": "https://alwaysai.co/app-logs-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_logs",
+  "type": "object",
+  "properties": {
+    "projectId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+    },
+    "logChunk": {
+      "type": "string"
+    }
+  },
+  "required": ["projectId", "logChunk"]
+}

package/src/schemas/app-state-control-schema.json

@@ -0,0 +1,16 @@
+{
+  "$id": "https://alwaysai.co/app-state-control-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_state_control",
+  "type": "object",
+  "properties": {
+    "baseCommand": {
+      "type": "string",
+      "enum": ["start", "stop", "restart"]
+    },
+    "projectId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+    }
+  },
+  "required": ["baseCommand", "projectId"]
+}

package/src/schemas/app-state-schema.json

@@ -0,0 +1,45 @@
+{
+  "$id": "https://alwaysai.co/app-state-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_state",
+  "type": "object",
+  "properties": {
+    "appState": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "appDetails": {
+            "type": "object",
+            "properties": {
+              "projectId": {
+                "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+              },
+              "version": {
+                "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+              }
+            },
+            "required": ["projectId", "version"]
+          },
+          "services": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "state": {
+                  "enum": ["up", "stopped", "restarting"]
+                }
+              },
+              "required": ["name", "state"]
+            }
+          }
+        },
+        "required": ["appDetails", "services"]
+      }
+    }
+  },
+  "required": ["appState"]
+}

package/src/schemas/app-uninstall-schema.json

@@ -0,0 +1,16 @@
+{
+  "$id": "https://alwaysai.co/app-uninstall-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_uninstall",
+  "type": "object",
+  "properties": {
+    "baseCommand": {
+      "type": "string",
+      "enum": ["uninstall"]
+    },
+    "projectId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+    }
+  },
+  "required": ["baseCommand", "projectId"]
+}

package/src/schemas/app-update-config-schema.json

@@ -0,0 +1,22 @@
+{
+  "$id": "https://alwaysai.co/app-update-config-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_update_config",
+  "type": "object",
+  "properties": {
+    "baseCommand": {
+      "type": "string",
+      "enum": ["update_config"]
+    },
+    "projectId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+    },
+    "appCfg":{
+      "type": "string"
+    },
+    "envVars": {
+      "type": "string"
+    }
+  },
+  "required": ["baseCommand", "projectId"]
+}

package/src/schemas/app-version-control-schema.json

@@ -0,0 +1,17 @@
+{
+  "$id": "https://alwaysai.co/app-version-control-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_version_control",
+  "type": "object",
+  "oneOf": [
+    {
+      "$ref": "https://alwaysai.co/app-install-schema.json"
+    },
+    {
+      "$ref": "https://alwaysai.co/app-update-config-schema.json"
+    },
+    {
+      "$ref": "https://alwaysai.co/app-uninstall-schema.json"
+    }
+  ]
+}

package/src/schemas/common-schema.json

@@ -0,0 +1,27 @@
+{
+  "$id": "https://alwaysai.co/common-schema.json",
+  "title": "common",
+  "$defs": {
+    "projectId": {
+      "description": "The specific project associated with the message payload.",
+      "type": "string",
+      "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+    },
+    "appReleaseHash": {
+      "description": "The version of the project associated with the message payload.",
+      "type": "string",
+      "pattern": "[0-9a-z]{64}"
+    },
+    "modelId":  {
+      "description": "The id of a model",
+      "type": "string",
+      "pattern": "[A-Za-z0-9_]+/[A-Za-z0-9_]*"
+    },
+    "txId": {
+      "type": "string",
+      "minLength": 36,
+      "maxLength": 36,
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+    }
+  }
+}

package/src/schemas/device-action-schema.json

@@ -0,0 +1,13 @@
+{
+  "$id": "https://alwaysai.co/device-action-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "device_action",
+  "type": "object",
+  "properties": {
+    "action": {
+      "type": "string",
+      "enum": ["system_restart"]
+    }
+  },
+  "required": ["action"]
+  }

package/src/schemas/device-agent-status-schema.json

@@ -0,0 +1,33 @@
+{
+  "$id": "https://alwaysai.co/device-agent-status-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "device_agent_status",
+  "description": "Whether the analytics passthrough is enabled and available",
+  "type": "object",
+  "properties": {
+    "passthrough": {
+      "type": "object",
+      "properties": {
+        "status": {
+          "type": "string",
+          "enum": [
+            "starting",
+            "running",
+            "error",
+            "disabled"
+          ]
+        },
+        "message": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "status",
+        "message"
+      ]
+    }
+  },
+  "required": [
+    "passthrough"
+  ]
+}

package/src/schemas/device-stats-schema.json

@@ -0,0 +1,57 @@
+{
+  "$id": "https://alwaysai.co/device-stats-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "device_stats",
+  "type": "object",
+  "properties": {
+    "cpuUsage": {
+      "type": "number",
+      "description": "The percentage of the CPU that is currently being used."
+    },
+    "diskUtil": {
+      "type": "number",
+      "description": "The percentage of the drive storage that is being used."
+    },
+    "usedMemoryPercentage": {
+      "type": "number",
+      "description": "The percentage of the memory that is being used."
+    },
+    "cpuDetails": {
+      "type": "object",
+      "description": "CPU utilization information",
+      "properties": {
+        "usedPerc": {
+          "type": ["number"]
+        },
+        "temperature": {
+          "type": ["number"]
+        }
+      }
+    },
+    "diskDetails": {
+      "type": "object",
+      "description": "Disk utilization information",
+      "properties": {
+        "usedGb": {
+          "type": ["number"]
+        },
+        "freeGb": {
+          "type": ["number"]
+        }
+      }
+    },
+    "memDetails": {
+      "type": "object",
+      "description": "Memory utilization information",
+      "properties": {
+        "usedMb": {
+          "type": ["number"]
+        },
+        "freeMb": {
+          "type": ["number"]
+        }
+      }
+    }
+  },
+  "required": []
+}

package/src/schemas/env-var-schema.json

@@ -0,0 +1,18 @@
+{
+  "$id": "https://alwaysai.co/env-var-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "env-var",
+  "type": "object",
+  "patternProperties": {
+    ".*": {
+      "type": "object",
+      "patternProperties": {
+        "^[^\\s]+$": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/src/schemas/live-updates-toggle-schema.json

@@ -0,0 +1,27 @@
+{
+  "$id": "https://alwaysai.co/live-updates-toggle-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "live_state_updates",
+  "type": "object",
+  "properties": {
+    "deviceStats": {
+      "type": "boolean"
+    },
+    "appState": {
+      "type": "boolean"
+    },
+    "appLogs": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        },
+        "toggle": {
+          "type": "boolean"
+        }
+      },
+      "required": ["projectId", "toggle"]
+    }
+  },
+  "required": []
+}

package/src/schemas/models-install-payload-schema.json

@@ -0,0 +1,21 @@
+{
+  "$id": "https://alwaysai.co/models-install-payload-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "models_install_payload",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "id": {
+        "$ref": "https://alwaysai.co/common-schema.json#/$defs/modelId"
+      },
+      "version": {
+        "type": "number"
+      },
+      "modelSignedUrl": {
+        "type": "string"
+      }
+    },
+    "required": ["id", "version", "modelSignedUrl"]
+  }
+}

package/src/schemas/models-install-response-schema.json

@@ -0,0 +1,21 @@
+{
+  "$id": "https://alwaysai.co/models-install-response-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "models_install_response",
+  "type": "object",
+  "properties": {
+    "modelsInstallResponse": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        },
+        "newModels": {
+          "$ref": "https://alwaysai.co/models-install-payload-schema.json"
+        }
+      },
+      "required": ["projectId", "newModels"]
+    }
+  },
+  "required": ["modelsInstallResponse"]
+}

package/src/schemas/secure-tunnel-schema.json

@@ -0,0 +1,31 @@
+{
+  "$id": "https://alwaysai.co/secure-tunnel-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "secure-tunnel",
+  "type": "object",
+  "properties": {
+    "st_ports": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["enabled","type","ip","port"],
+        "properties": {
+          "enabled": {
+            "type": "boolean"
+          },
+          "type": {
+            "type": "string"
+          },
+          "ip": {
+            "type": "string"
+          },
+          "port": {
+            "type": "number"
+          }
+        }
+      }
+    }
+  },
+  "required": ["st_ports"],
+  "additionalProperties": false
+}

package/src/schemas/shadow-project-update-legacy-schema.json

@@ -0,0 +1,30 @@
+{
+  "$id": "https://alwaysai.co/shadow-project-update-legacy-schema.json",
+  "title": "shadow_project_update_legacy_schema",
+  "description": "[LEGACY] The messaging payload structure for all properties of a single project shadow update",
+  "type": "object",
+  "nullable": true,
+  "properties": {
+    "appConfig": {
+      "type": "string"
+    },
+    "envVars": {
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "patternProperties":{
+            ".*": {
+              "type": ["string", "null"]
+            }
+          },
+          "required": [],
+          "additionalProperties": false
+        }
+      },
+      "required": [],
+      "additionalProperties": false
+    }
+  },
+  "required": []
+}

package/src/schemas/shadow-project-update-schema.json

@@ -0,0 +1,16 @@
+{
+  "$id": "https://alwaysai.co/shadow-project-update-schema.json",
+  "title": "shadow_project_update_schema",
+  "description": "The messaging payload structure for all properties of a single project shadow update",
+  "type": "object",
+  "nullable": true,
+  "properties": {
+    "appConfig": {
+      "type": "string"
+    },
+    "envVars": {
+      "type": "string"
+    }
+  },
+  "required": []
+}

package/src/schemas/shadow-projects-update-all-schema.json

@@ -0,0 +1,20 @@
+{
+  "$id": "https://alwaysai.co/shadow-projects-update-all-schema.json",
+  "title": "shadow-projects-update-all",
+  "description": "The messaging payload structure for shadow's projects update delta",
+  "type": "object",
+  "patternProperties": {
+    ".*": {
+      "type": ["object","null"],
+      "anyOf":[
+        {"$ref": "https://alwaysai.co/shadow-project-update-schema.json"},
+        {"$ref": "https://alwaysai.co/shadow-project-update-legacy-schema.json"}
+      ]
+    }
+  },
+  "propertyNames": {
+    "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+  },
+  "required": [],
+  "additionalProperties": false
+}

package/src/schemas/signed-urls-request-schema.json

@@ -0,0 +1,39 @@
+{
+  "$id": "https://alwaysai.co/signed-urls-request-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "signed_urls_request",
+  "type": "object",
+  "properties": {
+    "signedUrlsRequest": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        },
+        "appReleaseHash": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+        }
+      },
+      "required": ["projectId", "appReleaseHash"]
+    },
+    "modelsOnlyUrlsRequest": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        },
+        "models": {
+          "type": "object",
+          "patternProperties": {
+            "[A-Za-z0-9_]+/[A-Za-z0-9_]*": {
+              "type": ["integer"]
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": ["projectId", "models"]
+    }
+  },
+  "required": []
+}

package/src/schemas/status-response-schema.json

@@ -0,0 +1,15 @@
+{
+  "$id": "https://alwaysai.co/status-response-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "status_response",
+  "type": "object",
+  "properties": {
+    "status": {
+      "enum": ["requested", "in_progress", "failure", "success", "connection_lost"]
+    },
+    "message": {
+      "type": "string"
+    }
+  },
+  "required": ["status"]
+}