@remnawave/backend-contract 2.1.75 → 2.1.77

package/build/frontend/constants/subscription-template/template-type/request-template-type.constant.js

@@ -4,7 +4,6 @@ exports.REQUEST_TEMPLATE_TYPE_VALUES = exports.REQUEST_TEMPLATE_TYPE = void 0;
 exports.REQUEST_TEMPLATE_TYPE = {
     STASH: 'stash',
     SINGBOX: 'singbox',
-    SINGBOX_LEGACY: 'singbox-legacy',
     MIHOMO: 'mihomo',
     XRAY_JSON: 'json',
     V2RAY_JSON: 'v2ray-json',

package/build/frontend/constants/subscription-template/template-type/template-type.constant.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SUBSCRIPTION_TEMPLATE_TYPE_VALUES = exports.SUBSCRIPTION_TEMPLATE_TYPE = void 0;
 exports.SUBSCRIPTION_TEMPLATE_TYPE = {
-    STASH: 'STASH',
-    SINGBOX: 'SINGBOX',
-    SINGBOX_LEGACY: 'SINGBOX_LEGACY',
-    MIHOMO: 'MIHOMO',
     XRAY_JSON: 'XRAY_JSON',
+    XRAY_BASE64: 'XRAY_BASE64',
+    MIHOMO: 'MIHOMO',
+    STASH: 'STASH',
     CLASH: 'CLASH',
+    SINGBOX: 'SINGBOX',
 };
 exports.SUBSCRIPTION_TEMPLATE_TYPE_VALUES = Object.values(exports.SUBSCRIPTION_TEMPLATE_TYPE);

package/build/frontend/models/response-rules/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./response-rule-condition.schema"), exports);
 __exportStar(require("./response-rule.schema"), exports);
 __exportStar(require("./response-rules-config.schema"), exports);
-__exportStar(require("./response-rules-json-schema"), exports);

package/build/frontend/models/response-rules/response-rule-condition.schema.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseRuleConditionSchema = void 0;
+const zod_1 = require("zod");
+const constants_1 = require("../../constants");
+exports.ResponseRuleConditionSchema = zod_1.z.object({
+    headerName: zod_1.z
+        .string()
+        .regex(/^[!#$%&'*+\-.0-9A-Z^_`a-z|~]+$/, 'Invalid header name. Only letters(a-z, A-Z), numbers(0-9), underscores(_) and hyphens(-) are allowed.')
+        .describe(JSON.stringify({
+        title: 'Header Name',
+        markdownDescription: 'Name of the HTTP header to check, case insensitive, must comply with RFC 7230.',
+    })),
+    operator: zod_1.z.nativeEnum(constants_1.RESPONSE_RULES_CONDITION_OPERATORS).describe(JSON.stringify({
+        markdownDescription: `Comparison operator to compare the header value against.\n\n${Object.entries(constants_1.RESPONSE_RULES_CONDITION_OPERATORS_DESCRIPTION)
+            .map(([key, description]) => `- **${key}**: ${description}\n`)
+            .join('\n')}`,
+    })),
+    value: zod_1.z
+        .string()
+        .min(1, 'Value is required')
+        .max(255, 'Value must be less than 255 characters')
+        .describe(JSON.stringify({
+        markdownDescription: `Value to check against the header, case sensitive (excluding regex/not_regex operator). Maximum length is 255 characters.`,
+    })),
+    caseSensitive: zod_1.z.boolean().describe(JSON.stringify({
+        markdownDescription: 'Whether the value is case sensitive. If true, the value will be compared case sensitive. If false, the value will be lowercased before comparison.',
+    })),
+});

package/build/frontend/models/response-rules/response-rule.schema.js

@@ -3,27 +3,109 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResponseRuleSchema = void 0;
 const zod_1 = require("zod");
 const constants_1 = require("../../constants");
-exports.ResponseRuleSchema = zod_1.z.object({
-    name: zod_1.z.string().min(1, 'Name is required').max(50, 'Name must be less than 50 characters'),
+const response_rule_condition_schema_1 = require("./response-rule-condition.schema");
+const RuleExampleJson = JSON.stringify({
+    name: 'Block Legacy Clients',
+    description: 'Block requests from legacy clients',
+    enabled: true,
+    operator: constants_1.RESPONSE_RULES_OPERATORS.OR,
+    conditions: [
+        {
+            headerName: 'user-agent',
+            operator: constants_1.RESPONSE_RULES_CONDITION_OPERATORS.CONTAINS,
+            value: 'Hiddify',
+            caseSensitive: true,
+        },
+        {
+            headerName: 'user-agent',
+            operator: constants_1.RESPONSE_RULES_CONDITION_OPERATORS.CONTAINS,
+            value: 'FoxRay',
+            caseSensitive: true,
+        },
+    ],
+    responseType: constants_1.RESPONSE_RULES_RESPONSE_TYPES.BLOCK,
+}, null, 2);
+exports.ResponseRuleSchema = zod_1.z
+    .object({
+    name: zod_1.z
+        .string()
+        .min(1, 'Name is required')
+        .max(50, 'Name must be less than 50 characters')
+        .describe(JSON.stringify({
+        title: 'Name',
+        markdownDescription: 'Name of the response rule.',
+    })),
     description: zod_1.z
         .string()
         .min(1, 'Description is required')
         .max(250, 'Description must be less than 250 characters')
-        .optional(),
-    operator: zod_1.z.nativeEnum(constants_1.RESPONSE_RULES_OPERATORS).describe('Operator to use for the rule.'),
-    conditions: zod_1.z.array(zod_1.z.object({
-        headerName: zod_1.z
-            .string()
-            .regex(/^[!#$%&'*+\-.0-9A-Z^_`a-z|~]+$/, 'Invalid header name. Only letters(a-z, A-Z), numbers(0-9), underscores(_) and hyphens(-) are allowed.')
-            .describe('Name of the HTTP header to check, case insensitive, must comply with RFC 7230.'),
-        operator: zod_1.z
-            .nativeEnum(constants_1.RESPONSE_RULES_CONDITION_OPERATORS)
-            .describe('Operator to use for the condition.'),
-        value: zod_1.z
-            .string()
-            .min(1, 'Value is required')
-            .max(255, 'Value must be less than 255 characters')
-            .describe('Value to check against the header, case sensitive.'),
+        .optional()
+        .describe(JSON.stringify({
+        title: 'Description',
+        markdownDescription: 'Description of the response rule. Maximum length is 250 characters.',
+    })),
+    enabled: zod_1.z.boolean().describe(JSON.stringify({
+        markdownDescription: 'Whether the response rule is enabled. If disabled, the rule will not be applied.',
+    })),
+    operator: zod_1.z.nativeEnum(constants_1.RESPONSE_RULES_OPERATORS).describe(JSON.stringify({
+        title: 'Operator',
+        markdownDescription: 'Operator to use for combining conditions in the rule.',
+    })),
+    conditions: zod_1.z.array(response_rule_condition_schema_1.ResponseRuleConditionSchema),
+    responseType: zod_1.z.nativeEnum(constants_1.RESPONSE_RULES_RESPONSE_TYPES).describe(JSON.stringify({
+        markdownDescription: `Type of the response. Determines the type of **response** to be returned when the rule is matched.\n\n${Object.entries(constants_1.RESPONSE_RULES_RESPONSE_TYPES_DESCRIPTION)
+            .map(([key, description]) => `- **${key}**: ${description}\n`)
+            .join('\n')}`,
     })),
-    responseType: zod_1.z.nativeEnum(constants_1.RESPONSE_RULES_RESPONSE_TYPES).describe('Type of the response.'),
-});
+    responseModifications: zod_1.z.object({
+        headers: zod_1.z
+            .array(zod_1.z.object({
+            key: zod_1.z
+                .string()
+                .regex(/^[!#$%&'*+\-.0-9A-Z^_`a-z|~]+$/, 'Invalid header name. Only letters(a-z, A-Z), numbers(0-9), underscores(_) and hyphens(-) are allowed.')
+                .describe(JSON.stringify({
+                title: 'Key',
+                markdownDescription: 'Key of the response header. Must comply with RFC 7230.',
+            })),
+            value: zod_1.z
+                .string()
+                .min(1, 'Value is required')
+                .describe(JSON.stringify({
+                title: 'Value',
+                markdownDescription: 'Value of the response header. ',
+            })),
+        }))
+            .optional()
+            .describe(JSON.stringify({
+            markdownDescription: 'Response headers to be added when the rule is matched.',
+        })),
+    }),
+})
+    .describe(JSON.stringify({
+    title: 'Response Rule',
+    markdownDescription: `\n\nFields:\n- **name**: Name of the response rule (required)\n- **description**: Description of the response rule (optional)\n- **enabled**: Whether the response rule is enabled. If disabled, the rule will not be applied.\n- **operator**: Operator to combine conditions (AND/OR)\n- **conditions**: Array of conditions to match against HTTP headers\n  - **headerName**: Name of the HTTP header to check (case insensitive)\n  - **operator**: Comparison operator (CONTAINS, EQUALS, etc)\n  - **value**: Value to compare against (case sensitive, max 255 chars)\n- **responseType**: Type of response when rule matches (e.g. BLOCK)\n\nExample:\n\`\`\`json\n${RuleExampleJson}\n\`\`\``,
+    examples: [
+        {
+            name: 'This is example rule name',
+            description: 'This is example rule description (optional)',
+            enabled: true,
+            operator: constants_1.RESPONSE_RULES_OPERATORS.AND,
+            conditions: [
+                {
+                    headerName: 'user-agent',
+                    operator: constants_1.RESPONSE_RULES_CONDITION_OPERATORS.CONTAINS,
+                    value: 'Example Rule Value, replace with your own value',
+                    caseSensitive: true,
+                },
+            ],
+            responseType: constants_1.RESPONSE_RULES_RESPONSE_TYPES.BLOCK,
+        },
+        {
+            name: 'Empty rule',
+            enabled: true,
+            operator: constants_1.RESPONSE_RULES_OPERATORS.AND,
+            conditions: [],
+            responseType: constants_1.RESPONSE_RULES_RESPONSE_TYPES.BLOCK,
+        },
+    ],
+}));

package/build/frontend/models/response-rules/response-rules-config.schema.js

@@ -4,11 +4,52 @@ exports.ResponseRulesConfigSchema = void 0;
 const zod_1 = require("zod");
 const constants_1 = require("../../constants");
 const response_rule_schema_1 = require("./response-rule.schema");
+const RuleExampleJson = JSON.stringify({
+    name: 'Block Legacy Clients',
+    description: 'Block requests from legacy clients',
+    operator: constants_1.RESPONSE_RULES_OPERATORS.OR,
+    enabled: true,
+    conditions: [
+        {
+            headerName: 'user-agent',
+            operator: constants_1.RESPONSE_RULES_CONDITION_OPERATORS.CONTAINS,
+            value: 'Hiddify',
+            caseSensitive: true,
+        },
+        {
+            headerName: 'user-agent',
+            operator: constants_1.RESPONSE_RULES_CONDITION_OPERATORS.CONTAINS,
+            value: 'FoxRay',
+            caseSensitive: true,
+        },
+    ],
+    responseType: constants_1.RESPONSE_RULES_RESPONSE_TYPES.BLOCK,
+}, null, 2);
 exports.ResponseRulesConfigSchema = zod_1.z.object({
     version: zod_1.z.nativeEnum(constants_1.RESPONSE_RULES_CONFIG_VERSION).describe(JSON.stringify({
         title: 'Response Rules Config Version',
-        description: 'Version of the response rules config.',
-        examples: [constants_1.RESPONSE_RULES_CONFIG_VERSION[1]],
+        markdownDescription: 'Version of the **response rules** config. Currently supported version is **1**.',
+    })),
+    rules: zod_1.z.array(response_rule_schema_1.ResponseRuleSchema).describe(JSON.stringify({
+        examples: [
+            [
+                {
+                    name: 'This is example rule name',
+                    description: 'This is example rule description (optional)',
+                    operator: constants_1.RESPONSE_RULES_OPERATORS.AND,
+                    enabled: true,
+                    conditions: [
+                        {
+                            headerName: 'user-agent',
+                            operator: constants_1.RESPONSE_RULES_CONDITION_OPERATORS.CONTAINS,
+                            value: 'Example Rule Value, replace with your own value',
+                            caseSensitive: true,
+                        },
+                    ],
+                    responseType: constants_1.RESPONSE_RULES_RESPONSE_TYPES.BLOCK,
+                },
+            ],
+        ],
+        markdownDescription: `Array of **response rules**.\n\nRules served from top to bottom – first matched rule is applied. Each rule is an object with the following properties:\n\n- **name**: Name of the response rule.\n- **description**: Description of the response rule.(Optional) \n- **enabled**: Whether the response rule is enabled. If disabled, the rule will not be applied.\n- **operator**: Operator to use for the rule.\n- **conditions**: Array of conditions to use for the rule.\n- **responseType**: Type of the response.\n\nExamples:\n\n1. Block legacy clients:\n\n\`\`\`json\n${RuleExampleJson}\n\`\`\`\n\nThis example shows how to block requests from legacy clients by checking if the User-Agent header contains "Hiddify" or "FoxRay".`,
     })),
-    rules: zod_1.z.array(response_rule_schema_1.ResponseRuleSchema),
 });

package/build/frontend/models/subscription-settings.schema.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubscriptionSettingsSchema = void 0;
 const zod_1 = require("zod");
+const response_rules_1 = require("./response-rules");
 exports.SubscriptionSettingsSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     profileTitle: zod_1.z.string(),
@@ -21,6 +22,7 @@ exports.SubscriptionSettingsSchema = zod_1.z.object({
     disabledUsersRemarks: zod_1.z.array(zod_1.z.string()),
     customResponseHeaders: zod_1.z.nullable(zod_1.z.record(zod_1.z.string(), zod_1.z.string())),
     randomizeHosts: zod_1.z.boolean(),
+    responseRules: zod_1.z.nullable(response_rules_1.ResponseRulesConfigSchema),
     createdAt: zod_1.z
         .string()
         .datetime()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.1.75",
+  "version": "2.1.77",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",

package/build/backend/models/response-rules/response-rules-json-schema.d.ts

@@ -1,7 +0,0 @@
-export declare const ResponseRulesJsonSchema: import("zod-to-json-schema").JsonSchema7Type & {
-    $schema?: string | undefined;
-    definitions?: {
-        [key: string]: import("zod-to-json-schema").JsonSchema7Type;
-    } | undefined;
-};
-//# sourceMappingURL=response-rules-json-schema.d.ts.map

package/build/backend/models/response-rules/response-rules-json-schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"response-rules-json-schema.d.ts","sourceRoot":"","sources":["../../../../models/response-rules/response-rules-json-schema.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,uBAAuB;;;;;CAKlC,CAAC"}

package/build/backend/models/response-rules/response-rules-json-schema.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseRulesJsonSchema = void 0;
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const _1 = require(".");
-exports.ResponseRulesJsonSchema = (0, zod_to_json_schema_1.zodToJsonSchema)(_1.ResponseRulesConfigSchema, {
-    name: 'Response Rules Config Schema',
-    $refStrategy: 'none',
-    errorMessages: true,
-    markdownDescription: true,
-});

package/build/frontend/models/response-rules/response-rules-json-schema.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseRulesJsonSchema = void 0;
-const zod_to_json_schema_1 = require("zod-to-json-schema");
-const _1 = require(".");
-exports.ResponseRulesJsonSchema = (0, zod_to_json_schema_1.zodToJsonSchema)(_1.ResponseRulesConfigSchema, {
-    name: 'Response Rules Config Schema',
-    $refStrategy: 'none',
-    errorMessages: true,
-    markdownDescription: true,
-});