@babelize/engine 0.0.0-stage → 0.1.0

package/schemas/translate-report.schema.json

@@ -0,0 +1,297 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://babelize.co/schemas/translate-report.v1.json",
+  "title": "Babelize translate report",
+  "description": "What `babelize translate --json` prints and `.babelize/local/report.json` contains (TranslateReport in @babelize/engine). Every per-key list is complete.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "$schema", "schemaVersion", "ok", "startedAt", "finishedAt", "durationMs", "framework", "frameworkStatus",
+    "provider", "sourceLocale", "targetLocales", "keptLocales", "droppedLocales", "dryRun", "applied",
+    "filesChanged", "diffSummary", "stats", "summary", "locales", "failures", "qaWarnings", "missing",
+    "unchanged", "notInjected", "unusedKeys", "dynamicKeyFiles", "keys", "warnings", "notes", "engineLog",
+    "lockfile", "lockfileIgnored"
+  ],
+  "properties": {
+    "$schema": { "type": "string" },
+    "schemaVersion": { "const": 1 },
+    "ok": { "type": "boolean", "description": "False when any key failed (the run is partial; the CLI exits 6)." },
+    "startedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$" },
+    "finishedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$" },
+    "durationMs": { "type": "number", "minimum": 0 },
+    "framework": { "type": "string" },
+    "frameworkStatus": { "enum": ["supported", "beta"] },
+    "provider": {
+      "oneOf": [
+        { "type": "null" },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["provider", "name"],
+          "properties": {
+            "provider": { "type": "string" },
+            "name": { "type": "string" },
+            "model": { "type": "string" }
+          }
+        }
+      ]
+    },
+    "sourceLocale": { "type": "string" },
+    "targetLocales": { "$ref": "#/$defs/strings" },
+    "keptLocales": { "$ref": "#/$defs/strings" },
+    "droppedLocales": { "$ref": "#/$defs/strings" },
+    "dryRun": { "type": "boolean" },
+    "applied": { "type": "boolean" },
+    "filesChanged": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["added", "modified", "deleted"],
+      "properties": {
+        "added": { "$ref": "#/$defs/strings" },
+        "modified": { "$ref": "#/$defs/strings" },
+        "deleted": { "$ref": "#/$defs/strings" }
+      }
+    },
+    "diffSummary": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["file", "kind", "added", "removed"],
+        "properties": {
+          "file": { "type": "string" },
+          "kind": { "enum": ["added", "modified", "deleted"] },
+          "added": { "$ref": "#/$defs/count" },
+          "removed": { "$ref": "#/$defs/count" }
+        }
+      }
+    },
+    "diff": { "type": "string", "description": "Unified diff; dry runs only." },
+    "stats": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["filesScanned", "stringsExtracted", "keysExtracted", "injectionsApplied", "keysFromLockfile", "keysSentToTranslator"],
+      "properties": {
+        "filesScanned": { "$ref": "#/$defs/count" },
+        "stringsExtracted": { "$ref": "#/$defs/count" },
+        "keysExtracted": { "$ref": "#/$defs/count" },
+        "injectionsApplied": { "$ref": "#/$defs/count" },
+        "keysFromLockfile": { "$ref": "#/$defs/count" },
+        "keysSentToTranslator": { "$ref": "#/$defs/count" },
+        "translatedThisRun": { "$ref": "#/$defs/count" }
+      }
+    },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["sourceKeys", "translations", "newTranslations", "reused", "failed", "qaWarnings", "missing", "unchanged", "notInjected"],
+      "properties": {
+        "sourceKeys": { "$ref": "#/$defs/count" },
+        "translations": { "$ref": "#/$defs/count" },
+        "newTranslations": { "$ref": "#/$defs/count" },
+        "reused": { "$ref": "#/$defs/count" },
+        "failed": { "$ref": "#/$defs/count" },
+        "qaWarnings": { "$ref": "#/$defs/count" },
+        "missing": { "$ref": "#/$defs/count" },
+        "unchanged": { "$ref": "#/$defs/count" },
+        "notInjected": { "$ref": "#/$defs/count" }
+      }
+    },
+    "locales": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["locale", "status", "total", "translated", "missing", "failed", "qaWarnings", "sameAsSource"],
+        "properties": {
+          "locale": { "type": "string" },
+          "status": { "enum": ["ok", "warning", "failed"] },
+          "total": { "$ref": "#/$defs/count" },
+          "translated": { "$ref": "#/$defs/count" },
+          "missing": { "$ref": "#/$defs/count" },
+          "failed": { "$ref": "#/$defs/count" },
+          "qaWarnings": { "$ref": "#/$defs/count" },
+          "sameAsSource": { "$ref": "#/$defs/count" }
+        }
+      }
+    },
+    "failures": {
+      "$ref": "#/$defs/list",
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["locale", "key", "source", "reason", "retryable"],
+            "properties": {
+              "locale": { "type": "string" },
+              "key": { "type": "string" },
+              "source": { "type": "string" },
+              "reason": { "$ref": "#/$defs/failureReason" },
+              "retryable": { "type": "boolean" },
+              "message": { "type": "string" }
+            }
+          }
+        }
+      }
+    },
+    "qaWarnings": {
+      "$ref": "#/$defs/list",
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["locale", "key", "warnings"],
+            "properties": {
+              "locale": { "type": "string" },
+              "key": { "type": "string" },
+              "warnings": { "$ref": "#/$defs/strings" }
+            }
+          }
+        }
+      }
+    },
+    "missing": {
+      "$ref": "#/$defs/list",
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["locale", "key"],
+            "properties": { "locale": { "type": "string" }, "key": { "type": "string" } }
+          }
+        }
+      }
+    },
+    "unchanged": {
+      "$ref": "#/$defs/list",
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["locale", "key", "value"],
+            "properties": { "locale": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }
+          }
+        }
+      }
+    },
+    "notInjected": {
+      "$ref": "#/$defs/list",
+      "type": "object",
+      "properties": {
+        "items": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["file", "key", "text", "reason"],
+            "properties": {
+              "file": { "type": "string" },
+              "key": { "type": "string" },
+              "text": { "type": "string" },
+              "reason": { "type": "string" }
+            }
+          }
+        }
+      }
+    },
+    "unusedKeys": {
+      "$ref": "#/$defs/list",
+      "type": "object",
+      "properties": { "items": { "$ref": "#/$defs/strings" } }
+    },
+    "dynamicKeyFiles": { "$ref": "#/$defs/strings" },
+    "keys": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["key", "source", "locales"],
+        "properties": {
+          "key": { "type": "string" },
+          "source": { "type": "string" },
+          "locales": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["status"],
+              "properties": {
+                "status": { "enum": ["translated", "warning", "unchanged", "failed", "missing"] },
+                "value": { "type": "string" },
+                "reason": { "$ref": "#/$defs/failureReason" },
+                "message": { "type": "string" },
+                "retryable": { "type": "boolean" },
+                "warnings": { "$ref": "#/$defs/strings" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["type", "file", "message"],
+        "properties": {
+          "type": { "type": "string" },
+          "file": { "type": "string" },
+          "line": { "type": "number" },
+          "message": { "type": "string" }
+        }
+      }
+    },
+    "notes": { "$ref": "#/$defs/strings" },
+    "engineLog": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["level", "message"],
+        "properties": { "level": { "enum": ["warn", "error"] }, "message": { "type": "string" } }
+      }
+    },
+    "formatter": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["tool", "files", "ok"],
+      "properties": {
+        "tool": { "enum": ["prettier", "biome"] },
+        "files": { "$ref": "#/$defs/strings" },
+        "ok": { "type": "boolean" },
+        "message": { "type": "string" }
+      }
+    },
+    "lockfile": { "type": "string" },
+    "lockfileIgnored": { "type": "boolean" }
+  },
+  "$defs": {
+    "count": { "type": "integer", "minimum": 0 },
+    "strings": { "type": "array", "items": { "type": "string" } },
+    "list": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["total", "items"],
+      "properties": { "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array" } }
+    },
+    "failureReason": {
+      "enum": [
+        "missing_from_response", "empty_value", "placeholder_lost", "untranslated", "icu_invalid",
+        "markup_mismatch", "unsupported_by_provider", "provider_error"
+      ]
+    }
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.