@lingo.dev/_spec 0.40.0 → 0.40.1

package/build/i18n.schema.json

@@ -3,29 +3,34 @@
   "properties": {
     "version": {
       "type": "number",
-      "default": 0
+      "default": 0,
+      "description": "The version number of the schema."
     },
     "locale": {
       "type": "object",
       "properties": {
         "source": {
-          "type": "string"
+          "type": "string",
+          "description": "Primary source locale code of your content (e.g. 'en', 'en-US', 'pt_BR', or 'pt-rBR'). Must be one of the supported locale codes – either a short ISO-639 language code or a full locale identifier using '-', '_' or Android '-r' notation."
         },
         "targets": {
           "type": "array",
           "items": {
             "$ref": "#/properties/locale/properties/source"
-          }
+          },
+          "description": "List of target locale codes to translate to."
         },
         "extraSource": {
-          "$ref": "#/properties/locale/properties/source"
+          "$ref": "#/properties/locale/properties/targets/items",
+          "description": "Optional extra source locale code used as fallback during translation."
         }
       },
       "required": [
         "source",
         "targets"
       ],
-      "additionalProperties": false
+      "additionalProperties": false,
+      "description": "Locale configuration block."
     },
     "buckets": {
       "type": "object",
@@ -43,7 +48,8 @@
                   "type": "object",
                   "properties": {
                     "path": {
-                      "type": "string"
+                      "type": "string",
+                      "description": "Path pattern containing a [locale] placeholder."
                     },
                     "delimiter": {
                       "type": [
@@ -54,17 +60,20 @@
                         "-",
                         "_",
                         null
-                      ]
+                      ],
+                      "description": "Delimiter that replaces the [locale] placeholder in the path (default: no delimiter)."
                     }
                   },
                   "required": [
                     "path"
                   ],
-                  "additionalProperties": false
+                  "additionalProperties": false,
+                  "description": "Bucket path item. Either a string path or an object specifying path and delimiter."
                 }
               ]
             },
-            "default": []
+            "default": [],
+            "description": "Glob patterns or bucket items to include for this bucket."
           },
           "exclude": {
             "type": "array",
@@ -78,37 +87,43 @@
                 }
               ]
             },
-            "default": []
+            "default": [],
+            "description": "Glob patterns or bucket items to exclude from this bucket."
           },
           "injectLocale": {
             "type": "array",
             "items": {
               "type": "string"
-            }
+            },
+            "description": "Keys within files where the current locale should be injected or removed."
           },
           "lockedKeys": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "default": []
+            "default": [],
+            "description": "Keys that must remain unchanged and should never be overwritten by translations."
           },
           "lockedPatterns": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "default": []
+            "default": [],
+            "description": "Regular expression patterns whose matched content should remain locked during translation."
           },
           "ignoredKeys": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "default": []
+            "default": [],
+            "description": "Keys that should be completely ignored by translation processes."
           }
         },
-        "additionalProperties": false
+        "additionalProperties": false,
+        "description": "Configuration options for a translation bucket."
       },
       "propertyNames": {
         "enum": [
@@ -161,16 +176,20 @@
             "ollama",
             "openrouter",
             "mistral"
-          ]
+          ],
+          "description": "Identifier of the translation provider service."
         },
         "model": {
-          "type": "string"
+          "type": "string",
+          "description": "Model name to use for translations."
         },
         "prompt": {
-          "type": "string"
+          "type": "string",
+          "description": "Prompt template used when requesting translations."
         },
         "baseUrl": {
-          "type": "string"
+          "type": "string",
+          "description": "Custom base URL for the provider API (optional)."
         }
       },
       "required": [
@@ -178,7 +197,8 @@
         "model",
         "prompt"
       ],
-      "additionalProperties": false
+      "additionalProperties": false,
+      "description": "Configuration for the machine-translation provider."
     }
   },
   "required": [

package/build/index.cjs

@@ -363,9 +363,13 @@ var bucketTypeSchema = _zod2.default.enum(bucketTypes);
 // src/config.ts
 
 var localeSchema = _zod2.default.object({
-  source: localeCodeSchema,
-  targets: _zod2.default.array(localeCodeSchema)
-});
+  source: localeCodeSchema.describe(
+    "Primary source locale code of your content (e.g. 'en', 'en-US', 'pt_BR', or 'pt-rBR'). Must be one of the supported locale codes \u2013 either a short ISO-639 language code or a full locale identifier using '-', '_' or Android '-r' notation."
+  ),
+  targets: _zod2.default.array(localeCodeSchema).describe(
+    "List of target locale codes to translate to."
+  )
+}).describe("Locale configuration block.");
 var createConfigDefinition = (definition) => definition;
 var extendConfigDefinition = (definition, params) => {
   const schema = params.createSchema(definition.schema);
@@ -404,7 +408,7 @@ ${localeErrors.join("\n")}`);
   });
 };
 var configV0Schema = _zod2.default.object({
-  version: _zod2.default.number().default(0)
+  version: _zod2.default.number().default(0).describe("The version number of the schema.")
 });
 var configV0Definition = createConfigDefinition({
   schema: configV0Schema,
@@ -416,7 +420,9 @@ var configV0Definition = createConfigDefinition({
 var configV1Definition = extendConfigDefinition(configV0Definition, {
   createSchema: (baseSchema) => baseSchema.extend({
     locale: localeSchema,
-    buckets: _zod2.default.record(_zod2.default.string(), bucketTypeSchema).default({}).optional()
+    buckets: _zod2.default.record(_zod2.default.string(), bucketTypeSchema).default({}).describe(
+      "Mapping of source file paths (glob patterns) to bucket types."
+    ).optional()
   }),
   createDefaultValue: () => ({
     version: 1,
@@ -440,8 +446,12 @@ var configV1_1Definition = extendConfigDefinition(configV1Definition, {
     buckets: _zod2.default.record(
       bucketTypeSchema,
       _zod2.default.object({
-        include: _zod2.default.array(_zod2.default.string()).default([]),
-        exclude: _zod2.default.array(_zod2.default.string()).default([]).optional()
+        include: _zod2.default.array(_zod2.default.string()).default([]).describe(
+          "File paths or glob patterns to include for this bucket."
+        ),
+        exclude: _zod2.default.array(_zod2.default.string()).default([]).optional().describe(
+          "File paths or glob patterns to exclude from this bucket."
+        )
       })
     ).default({})
   }),
@@ -476,7 +486,9 @@ var configV1_2Definition = extendConfigDefinition(
   {
     createSchema: (baseSchema) => baseSchema.extend({
       locale: localeSchema.extend({
-        extraSource: localeCodeSchema.optional()
+        extraSource: localeCodeSchema.optional().describe(
+          "Optional extra source locale code used as fallback during translation."
+        )
       })
     }),
     createDefaultValue: (baseDefaultValue) => ({
@@ -490,18 +502,20 @@ var configV1_2Definition = extendConfigDefinition(
   }
 );
 var bucketItemSchema = _zod2.default.object({
-  path: _zod2.default.string(),
-  delimiter: _zod2.default.union([
-    _zod2.default.literal("-"),
-    _zod2.default.literal("_"),
-    _zod2.default.literal(null)
-  ]).optional()
-});
+  path: _zod2.default.string().describe("Path pattern containing a [locale] placeholder."),
+  delimiter: _zod2.default.union([_zod2.default.literal("-"), _zod2.default.literal("_"), _zod2.default.literal(null)]).optional().describe(
+    "Delimiter that replaces the [locale] placeholder in the path (default: no delimiter)."
+  )
+}).describe(
+  "Bucket path item. Either a string path or an object specifying path and delimiter."
+);
 var bucketValueSchemaV1_3 = _zod2.default.object({
-  include: _zod2.default.array(_zod2.default.union([_zod2.default.string(), bucketItemSchema])).default([]),
-  exclude: _zod2.default.array(_zod2.default.union([_zod2.default.string(), bucketItemSchema])).default([]).optional(),
-  injectLocale: _zod2.default.array(_zod2.default.string()).optional()
-});
+  include: _zod2.default.array(_zod2.default.union([_zod2.default.string(), bucketItemSchema])).default([]).describe("Glob patterns or bucket items to include for this bucket."),
+  exclude: _zod2.default.array(_zod2.default.union([_zod2.default.string(), bucketItemSchema])).default([]).optional().describe("Glob patterns or bucket items to exclude from this bucket."),
+  injectLocale: _zod2.default.array(_zod2.default.string()).optional().describe(
+    "Keys within files where the current locale should be injected or removed."
+  )
+}).describe("Configuration options for a translation bucket.");
 var configV1_3Definition = extendConfigDefinition(
   configV1_2Definition,
   {
@@ -545,11 +559,13 @@ var providerSchema = _zod2.default.object({
     "ollama",
     "openrouter",
     "mistral"
-  ]),
-  model: _zod2.default.string(),
-  prompt: _zod2.default.string(),
-  baseUrl: _zod2.default.string().optional()
-});
+  ]).describe("Identifier of the translation provider service."),
+  model: _zod2.default.string().describe("Model name to use for translations."),
+  prompt: _zod2.default.string().describe(
+    "Prompt template used when requesting translations."
+  ),
+  baseUrl: _zod2.default.string().optional().describe("Custom base URL for the provider API (optional).")
+}).describe("Configuration for the machine-translation provider.");
 var configV1_5Definition = extendConfigDefinition(
   configV1_4Definition,
   {
@@ -567,7 +583,9 @@ var configV1_5Definition = extendConfigDefinition(
   }
 );
 var bucketValueSchemaV1_6 = bucketValueSchemaV1_3.extend({
-  lockedKeys: _zod2.default.array(_zod2.default.string()).default([]).optional()
+  lockedKeys: _zod2.default.array(_zod2.default.string()).default([]).optional().describe(
+    "Keys that must remain unchanged and should never be overwritten by translations."
+  )
 });
 var configV1_6Definition = extendConfigDefinition(
   configV1_5Definition,
@@ -586,7 +604,9 @@ var configV1_6Definition = extendConfigDefinition(
   }
 );
 var bucketValueSchemaV1_7 = bucketValueSchemaV1_6.extend({
-  lockedPatterns: _zod2.default.array(_zod2.default.string()).default([]).optional()
+  lockedPatterns: _zod2.default.array(_zod2.default.string()).default([]).optional().describe(
+    "Regular expression patterns whose matched content should remain locked during translation."
+  )
 });
 var configV1_7Definition = extendConfigDefinition(
   configV1_6Definition,
@@ -605,7 +625,9 @@ var configV1_7Definition = extendConfigDefinition(
   }
 );
 var bucketValueSchemaV1_8 = bucketValueSchemaV1_7.extend({
-  ignoredKeys: _zod2.default.array(_zod2.default.string()).default([]).optional()
+  ignoredKeys: _zod2.default.array(_zod2.default.string()).default([]).optional().describe(
+    "Keys that should be completely ignored by translation processes."
+  )
 });
 var configV1_8Definition = extendConfigDefinition(
   configV1_7Definition,

package/build/index.mjs

@@ -363,9 +363,13 @@ var bucketTypeSchema = Z2.enum(bucketTypes);
 // src/config.ts
 import Z3 from "zod";
 var localeSchema = Z3.object({
-  source: localeCodeSchema,
-  targets: Z3.array(localeCodeSchema)
-});
+  source: localeCodeSchema.describe(
+    "Primary source locale code of your content (e.g. 'en', 'en-US', 'pt_BR', or 'pt-rBR'). Must be one of the supported locale codes \u2013 either a short ISO-639 language code or a full locale identifier using '-', '_' or Android '-r' notation."
+  ),
+  targets: Z3.array(localeCodeSchema).describe(
+    "List of target locale codes to translate to."
+  )
+}).describe("Locale configuration block.");
 var createConfigDefinition = (definition) => definition;
 var extendConfigDefinition = (definition, params) => {
   const schema = params.createSchema(definition.schema);
@@ -404,7 +408,7 @@ ${localeErrors.join("\n")}`);
   });
 };
 var configV0Schema = Z3.object({
-  version: Z3.number().default(0)
+  version: Z3.number().default(0).describe("The version number of the schema.")
 });
 var configV0Definition = createConfigDefinition({
   schema: configV0Schema,
@@ -416,7 +420,9 @@ var configV0Definition = createConfigDefinition({
 var configV1Definition = extendConfigDefinition(configV0Definition, {
   createSchema: (baseSchema) => baseSchema.extend({
     locale: localeSchema,
-    buckets: Z3.record(Z3.string(), bucketTypeSchema).default({}).optional()
+    buckets: Z3.record(Z3.string(), bucketTypeSchema).default({}).describe(
+      "Mapping of source file paths (glob patterns) to bucket types."
+    ).optional()
   }),
   createDefaultValue: () => ({
     version: 1,
@@ -440,8 +446,12 @@ var configV1_1Definition = extendConfigDefinition(configV1Definition, {
     buckets: Z3.record(
       bucketTypeSchema,
       Z3.object({
-        include: Z3.array(Z3.string()).default([]),
-        exclude: Z3.array(Z3.string()).default([]).optional()
+        include: Z3.array(Z3.string()).default([]).describe(
+          "File paths or glob patterns to include for this bucket."
+        ),
+        exclude: Z3.array(Z3.string()).default([]).optional().describe(
+          "File paths or glob patterns to exclude from this bucket."
+        )
       })
     ).default({})
   }),
@@ -476,7 +486,9 @@ var configV1_2Definition = extendConfigDefinition(
   {
     createSchema: (baseSchema) => baseSchema.extend({
       locale: localeSchema.extend({
-        extraSource: localeCodeSchema.optional()
+        extraSource: localeCodeSchema.optional().describe(
+          "Optional extra source locale code used as fallback during translation."
+        )
       })
     }),
     createDefaultValue: (baseDefaultValue) => ({
@@ -490,18 +502,20 @@ var configV1_2Definition = extendConfigDefinition(
   }
 );
 var bucketItemSchema = Z3.object({
-  path: Z3.string(),
-  delimiter: Z3.union([
-    Z3.literal("-"),
-    Z3.literal("_"),
-    Z3.literal(null)
-  ]).optional()
-});
+  path: Z3.string().describe("Path pattern containing a [locale] placeholder."),
+  delimiter: Z3.union([Z3.literal("-"), Z3.literal("_"), Z3.literal(null)]).optional().describe(
+    "Delimiter that replaces the [locale] placeholder in the path (default: no delimiter)."
+  )
+}).describe(
+  "Bucket path item. Either a string path or an object specifying path and delimiter."
+);
 var bucketValueSchemaV1_3 = Z3.object({
-  include: Z3.array(Z3.union([Z3.string(), bucketItemSchema])).default([]),
-  exclude: Z3.array(Z3.union([Z3.string(), bucketItemSchema])).default([]).optional(),
-  injectLocale: Z3.array(Z3.string()).optional()
-});
+  include: Z3.array(Z3.union([Z3.string(), bucketItemSchema])).default([]).describe("Glob patterns or bucket items to include for this bucket."),
+  exclude: Z3.array(Z3.union([Z3.string(), bucketItemSchema])).default([]).optional().describe("Glob patterns or bucket items to exclude from this bucket."),
+  injectLocale: Z3.array(Z3.string()).optional().describe(
+    "Keys within files where the current locale should be injected or removed."
+  )
+}).describe("Configuration options for a translation bucket.");
 var configV1_3Definition = extendConfigDefinition(
   configV1_2Definition,
   {
@@ -545,11 +559,13 @@ var providerSchema = Z3.object({
     "ollama",
     "openrouter",
     "mistral"
-  ]),
-  model: Z3.string(),
-  prompt: Z3.string(),
-  baseUrl: Z3.string().optional()
-});
+  ]).describe("Identifier of the translation provider service."),
+  model: Z3.string().describe("Model name to use for translations."),
+  prompt: Z3.string().describe(
+    "Prompt template used when requesting translations."
+  ),
+  baseUrl: Z3.string().optional().describe("Custom base URL for the provider API (optional).")
+}).describe("Configuration for the machine-translation provider.");
 var configV1_5Definition = extendConfigDefinition(
   configV1_4Definition,
   {
@@ -567,7 +583,9 @@ var configV1_5Definition = extendConfigDefinition(
   }
 );
 var bucketValueSchemaV1_6 = bucketValueSchemaV1_3.extend({
-  lockedKeys: Z3.array(Z3.string()).default([]).optional()
+  lockedKeys: Z3.array(Z3.string()).default([]).optional().describe(
+    "Keys that must remain unchanged and should never be overwritten by translations."
+  )
 });
 var configV1_6Definition = extendConfigDefinition(
   configV1_5Definition,
@@ -586,7 +604,9 @@ var configV1_6Definition = extendConfigDefinition(
   }
 );
 var bucketValueSchemaV1_7 = bucketValueSchemaV1_6.extend({
-  lockedPatterns: Z3.array(Z3.string()).default([]).optional()
+  lockedPatterns: Z3.array(Z3.string()).default([]).optional().describe(
+    "Regular expression patterns whose matched content should remain locked during translation."
+  )
 });
 var configV1_7Definition = extendConfigDefinition(
   configV1_6Definition,
@@ -605,7 +625,9 @@ var configV1_7Definition = extendConfigDefinition(
   }
 );
 var bucketValueSchemaV1_8 = bucketValueSchemaV1_7.extend({
-  ignoredKeys: Z3.array(Z3.string()).default([]).optional()
+  ignoredKeys: Z3.array(Z3.string()).default([]).optional().describe(
+    "Keys that should be completely ignored by translation processes."
+  )
 });
 var configV1_8Definition = extendConfigDefinition(
   configV1_7Definition,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingo.dev/_spec",
-  "version": "0.40.0",
+  "version": "0.40.1",
   "description": "Lingo.dev open specification",
   "private": false,
   "publishConfig": {