@regle/mcp-server 1.17.0-beta.1 → 1.17.0

package/dist/regle-mcp-server.js

@@ -20,7 +20,7 @@ var docs_data_default = {
 			"title": "Global configuration",
 			"category": "advanced-usage",
 			"path": "advanced-usage/global-config.md",
-			"content": "# Global configuration\n\nIf your app includes multiple forms, it can be helpful to define a global configuration that centralizes your custom validators, error messages, and modifiers. This eliminates the need to declare these settings repeatedly for every `useRegle` call, improving both code consistency and developer experience with features like autocompletion and type checking.\n\n## Replace built-in rules messages\n\nEach `@regle/rules` rule provides a default error message. You may may not want to call `withMessage` every time you need to use one with a custom error message.\n\n`defineRegleConfig` allows you to redefine the default messages of built-in rules.\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => ({\n    required: withMessage(required, 'You need to provide a value'),\n    minLength: withMessage(minLength, ({ $value, $params: [max] }) => {\n      return `Minimum length is ${max}. Current length: ${$value?.length}`;\n    })\n  })\n})\n\nconst { r$ } = useCustomRegle({ name: '' }, {\n  name: {\n    required,\n    minLength: minLength(6)\n  }\n})\n```\n\nResult: \n\n:::tip\nIf you use Nuxt, check out the [Nuxt module](/integrations/nuxt) for a even better DX.  \nIt provides a way to add your custom global config to your auto-imports.\n:::\n\n### i18n\n\nYou can also use any i18n library directly inside the config.\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\nimport { useI18n } from 'vue-i18n';\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => {\n    const { t } = useI18n()\n\n    return {\n      required: withMessage(required, t('general.required')),\n      minLength: withMessage(minLength, ({ $value, $params: [max] }) => {\n        return t('general.minLength', {max});\n      })\n    }\n  }\n})\n```\n\n## Declare new rules\n\nWhile `useRegle` allows you to use any rule key, adding custom rules to the global configuration provides autocompletion and type checking. This improves maintainability and consistency across your application.\n\n```ts twoslash\nconst someAsyncCall = async () => await Promise.resolve(true);\n// ---cut---\n\nimport { defineRegleConfig, createRule, Maybe } from '@regle/core';\nimport { withMessage, isFilled } from '@regle/rules';\n\nconst asyncEmail = createRule({\n  async validator(value: Maybe<string>) {\n    if (!isFilled(value)) {\n      return true;\n    }\n\n    const result = await someAsyncCall();\n    return result;\n  },\n  message: 'Email already exists',\n});\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => ({\n    asyncEmail\n  })\n})\n\nconst { r$ } = useCustomRegle({ name: '' }, {\n  name: {\n    asy\n\n  }\n})\n```\n\n## Declare modifiers\n\nYou can include global modifiers in your configuration to automatically apply them wherever you use the `useRegle` composable. This avoids repetitive declarations and keeps your code clean.\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\n\nexport const { useRegle: useCustomRegle } = defineRegleConfig({\n  modifiers: {\n    autoDirty: false,\n    silent: true,\n    lazy: true,\n    rewardEarly: true\n  }\n})\n```\n\n## Export scoped `inferRules` helper\n\n`defineRegleConfig` also returns a scoped `inferRules` helper, similar to the one exported from `@regle/core`, but that will autocomplete and check your custom rules.\n\nFor information about `inferRules`, check [Typing rules docs](/typescript/typing-rules)\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\n\nexport const { useRegle, inferRules } = defineRegleConfig({/* */})\n```\n\n## Extend global config\n\nIt's also possible to add additional config to an already created custom `useRegle`.\n\nWith `extendRegleConfig`, you can recreate a custom one with a existing composable as an input.\n\n```ts twoslash\n\nimport { defineRegleConfig, extendRegleConfig, createRule } from '@regle/core';\nimport { withMessage, required } from '@regle/rules';\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => ({\n    customRule: withMessage(required, 'Custom rule'),\n  })\n})\n\nconst {useRegle: useExtendedRegle} = extendRegleConfig(useCustomRegle, {\n  rules: () => ({\n    customRuleExtended: withMessage(required, 'Custom rule 2'),\n  })\n})\n\nuseExtendedRegle({name: ''}, {\n  name: {\n    custom\n    \n  }\n})\n\n```\n\n## Override default behaviors\n\nYou can override the default behaviors of Regle processors by using the `overrides` property.\n\n### `isEdited`\n\nOverride the default `$edited` property handler. Useful to handle custom comparisons for complex object types.\n\n:::warning\nIt's highly recommended to use this override with the [`markStatic`](/advanced-usage/immutable-constructors) helper to handle immutable constructors.\n:::\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { Decimal } from 'decimal.js';\n\nexport const { useRegle: useCustomRegle } = defineRegleConfig({\n  overrides: {\n    isEdited(currentValue, initialValue, defaultHandlerFn) {\n      if (currentValue instanceof Decimal && initialValue instanceof Decimal) {\n        return currentValue.toNearest(0.01).toString() !== initialValue.toNearest(0.01).toString();\n      }\n      // fallback to the default handler\n      return defaultHandlerFn(currentValue, initialValue);\n    },\n  },\n})"
+			"content": "# Global configuration\n\nIf your app includes multiple forms, it can be helpful to define a global configuration that centralizes your custom validators, error messages, and modifiers. This eliminates the need to declare these settings repeatedly for every `useRegle` call, improving both code consistency and developer experience with features like autocompletion and type checking.\n\n## Replace built-in rules messages\n\nEach `@regle/rules` rule provides a default error message. You may may not want to call `withMessage` every time you need to use one with a custom error message.\n\n`defineRegleConfig` allows you to redefine the default messages of built-in rules.\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => ({\n    required: withMessage(required, 'You need to provide a value'),\n    minLength: withMessage(minLength, ({ $value, $params: [max] }) => {\n      return `Minimum length is ${max}. Current length: ${$value?.length}`;\n    })\n  })\n})\n\nconst { r$ } = useCustomRegle({ name: '' }, {\n  name: {\n    required,\n    minLength: minLength(6)\n  }\n})\n```\n\nResult: \n\n:::tip\nIf you use Nuxt, check out the [Nuxt module](/integrations/nuxt) for a even better DX.  \nIt provides a way to add your custom global config to your auto-imports.\n:::\n\n### i18n\n\nYou can also use any i18n library directly inside the config.\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\nimport { useI18n } from 'vue-i18n';\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => {\n    const { t } = useI18n()\n\n    return {\n      required: withMessage(required, t('general.required')),\n      minLength: withMessage(minLength, ({ $value, $params: [max] }) => {\n        return t('general.minLength', {max});\n      })\n    }\n  }\n})\n```\n\n## Declare new rules\n\nWhile `useRegle` allows you to use any rule key, adding custom rules to the global configuration provides autocompletion and type checking. This improves maintainability and consistency across your application.\n\n```ts twoslash\nconst someAsyncCall = async () => await Promise.resolve(true);\n// ---cut---\n\nimport { defineRegleConfig, createRule, Maybe } from '@regle/core';\nimport { withMessage, isFilled } from '@regle/rules';\n\nconst asyncEmail = createRule({\n  async validator(value: Maybe<string>) {\n    if (!isFilled(value)) {\n      return true;\n    }\n\n    const result = await someAsyncCall();\n    return result;\n  },\n  message: 'Email already exists',\n});\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => ({\n    asyncEmail\n  })\n})\n\nconst { r$ } = useCustomRegle({ name: '' }, {\n  name: {\n    asy\n\n  }\n})\n```\n\n## Declare modifiers\n\nYou can include global modifiers in your configuration to automatically apply them wherever you use the `useRegle` composable. This avoids repetitive declarations and keeps your code clean.\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\n\nexport const { useRegle: useCustomRegle } = defineRegleConfig({\n  modifiers: {\n    autoDirty: false,\n    silent: true,\n    lazy: true,\n    rewardEarly: true\n  }\n})\n```\n\n## Export scoped `inferRules` helper\n\n`defineRegleConfig` also returns a scoped `inferRules` helper, similar to the one exported from `@regle/core`, but that will autocomplete and check your custom rules.\n\nFor information about `inferRules`, check [Typing rules docs](/typescript/typing-rules)\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { withMessage, minLength, required } from '@regle/rules';\n\nexport const { useRegle, inferRules } = defineRegleConfig({/* */})\n```\n\n## Extend global config\n\nIt's also possible to add additional config to an already created custom `useRegle`.\n\nWith `extendRegleConfig`, you can recreate a custom one with a existing composable as an input.\n\n```ts twoslash\n\nimport { defineRegleConfig, extendRegleConfig, createRule } from '@regle/core';\nimport { withMessage, required } from '@regle/rules';\n\nconst { useRegle: useCustomRegle } = defineRegleConfig({\n  rules: () => ({\n    customRule: withMessage(required, 'Custom rule'),\n  })\n})\n\nconst {useRegle: useExtendedRegle} = extendRegleConfig(useCustomRegle, {\n  rules: () => ({\n    customRuleExtended: withMessage(required, 'Custom rule 2'),\n  })\n})\n\nuseExtendedRegle({name: ''}, {\n  name: {\n    custom\n    \n  }\n})\n\n```\n\n## Override default behaviors\n\nYou can override the default behaviors of Regle processors by using the `overrides` property.\n\n### `isEdited`\n\nOverride the default `$edited` property handler. Useful to handle custom comparisons for complex object types.\n\n:::warning\nIt's highly recommended to use this override with the [`markStatic`](/advanced-usage/immutable-constructors) helper to handle immutable constructors.\n:::\n\n```ts\nimport { defineRegleConfig } from '@regle/core';\nimport { Decimal } from 'decimal.js';\n\nexport const { useRegle: useCustomRegle } = defineRegleConfig({\n  overrides: {\n    isEdited(currentValue, initialValue, defaultHandlerFn) {\n      if (currentValue instanceof Decimal && initialValue instanceof Decimal) {\n        return currentValue.toNearest(0.01).toString() !== initialValue.toNearest(0.01).toString();\n      }\n      // fallback to the default handler\n      return defaultHandlerFn(currentValue, initialValue);\n    },\n  },\n})\n```"
 		},
 		{
 			"id": "advanced-usage-immutable-constructors",
@@ -1814,7 +1814,7 @@ function searchApi(query) {
 	return results;
 }
 
-var version = "1.17.0-beta.1";
+var version = "1.17.0";
 
 let posthogClient = null;
 posthogClient = new PostHog("phc_kqgJoylCpKkGkkRGxb4MyN2mViehoQcUFEGwVkk4l8E", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regle/mcp-server",
-  "version": "1.17.0-beta.1",
+  "version": "1.17.0",
   "description": "MCP Server for Regle",
   "dependencies": {
     "@modelcontextprotocol/sdk": "1.25.2",