refactor: implement HWID settings in subscription and external squad management

- Updated .env.sample to remove HWID_DEVICE_LIMIT_ENABLED configuration.
- Bumped package versions to 2.3.0 and updated dependencies.
- Introduced HWID settings in subscription and external squad schemas.
- Enhanced subscription and external squad services to handle HWID settings.
- Refactored related queries and commands to incorporate HWID settings.
- Improved caching mechanisms for subscription settings.

Author: kastov

.env.sample

@@ -65,13 +65,6 @@ WEBHOOK_URL=https://your-webhook-url.com/endpoint
 ### This secret is used to sign the webhook payload, must be exact 64 characters. Only a-z, 0-9, A-Z are allowed.
 WEBHOOK_SECRET_HEADER=vsmu67Kmg6R8FjIOF1WUY8LWBHie4scdEqrfsKmyf4IAf8dY3nFS0wwYHkhh6ZvQ
 
-### HWID DEVICE DETECTION AND LIMITATION ###
-# Don't enable this if you don't know what you are doing.
-# Review documentation before enabling this feature.
-# https://docs.rw/docs/features/hwid-device-limit/
-HWID_DEVICE_LIMIT_ENABLED=false
-
-
 ### Bandwidth usage reached notifications
 BANDWIDTH_USAGE_NOTIFICATIONS_ENABLED=false
 # Only in ASC order (example: [60, 80]), must be valid array of integer(min: 25, max: 95) numbers. No more than 5 values.

libs/contract/commands/external-squads/update-external-squad.command.ts

@@ -5,6 +5,7 @@ import {
     ExternalSquadResponseHeadersSchema,
     ExternalSquadSchema,
     ExternalSquadSubscriptionSettingsSchema,
+    HwidSettingsSchema,
 } from '../../models';
 import { getEndpointDetails, SUBSCRIPTION_TEMPLATE_TYPE } from '../../constants';
 import { EXTERNAL_SQUADS_ROUTES, REST_API } from '../../api';
@@ -41,6 +42,7 @@ export namespace UpdateExternalSquadCommand {
         subscriptionSettings: ExternalSquadSubscriptionSettingsSchema.optional(),
         hostOverrides: ExternalSquadHostOverridesSchema.optional(),
         responseHeaders: ExternalSquadResponseHeadersSchema.optional(),
+        hwidSettings: z.optional(z.nullable(HwidSettingsSchema)),
     });
 
     export type Request = z.infer<typeof RequestSchema>;

libs/contract/commands/subscription-settings/update-subscription-settings.command.ts

@@ -1,6 +1,10 @@
 import { z } from 'zod';
 
-import { ResponseRulesConfigSchema, SubscriptionSettingsSchema } from '../../models';
+import {
+    HwidSettingsSchema,
+    ResponseRulesConfigSchema,
+    SubscriptionSettingsSchema,
+} from '../../models';
 import { REST_API, SUBSCRIPTION_SETTINGS_ROUTES } from '../../api';
 import { getEndpointDetails } from '../../constants';
 
@@ -52,6 +56,7 @@ export namespace UpdateSubscriptionSettingsCommand {
         randomizeHosts: z.optional(z.boolean()),
 
         responseRules: z.optional(ResponseRulesConfigSchema),
+        hwidSettings: z.optional(HwidSettingsSchema),
     });
 
     export type Request = z.infer<typeof RequestSchema>;

libs/contract/constants/cache-keys/cache-keys.constants.ts

@@ -2,6 +2,7 @@ import { TSubscriptionTemplateType } from '../subscription-template';
 
 export const CACHE_KEYS = {
     SUBSCRIPTION_SETTINGS: 'subscription_settings',
+    EXTERNAL_SQUAD_SETTINGS: (uuid: string) => `external_squad_settings:${uuid}`,
     SUBSCRIPTION_TEMPLATE: (name: string, type: TSubscriptionTemplateType) =>
         `subscription_template:${name}:${type}`,
     PASSKEY_REGISTRATION_OPTIONS: (uuid: string) => `passkey_registration_options:${uuid}`,
@@ -11,4 +12,6 @@ export const CACHE_KEYS = {
 
 export const CACHE_KEYS_TTL = {
     REMNAWAVE_SETTINGS: 86_400_000, // 1 day
+    EXTERNAL_SQUAD_SETTINGS: 3_600_000, // 1 hour
+    SUBSCRIPTION_SETTINGS: 3_600_000, // 1 hour
 } as const;

libs/contract/models/external-squad.schema.ts

@@ -5,6 +5,7 @@ import {
     ExternalSquadHostOverridesSchema,
     ExternalSquadResponseHeadersSchema,
 } from './external-squads';
+import { HwidSettingsSchema } from './subscription-settings/hwid-settings.schema';
 import { SUBSCRIPTION_TEMPLATE_TYPE } from '../constants';
 
 export const ExternalSquadSchema = z.object({
@@ -24,6 +25,7 @@ export const ExternalSquadSchema = z.object({
     subscriptionSettings: z.nullable(ExternalSquadSubscriptionSettingsSchema),
     hostOverrides: z.nullable(ExternalSquadHostOverridesSchema),
     responseHeaders: ExternalSquadResponseHeadersSchema,
+    hwidSettings: z.nullable(HwidSettingsSchema),
 
     createdAt: z
         .string()

libs/contract/models/index.ts

@@ -22,6 +22,7 @@ export * from './response-rules';
 export * from './snippets.schema';
 export * from './subscription-info.schema';
 export * from './subscription-request-history.schema';
+export * from './subscription-settings';
 export * from './subscription-settings.schema';
 export * from './tanstack-query';
 export * from './users.schema';

libs/contract/models/subscription-settings.schema.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 
+import { HwidSettingsSchema } from './subscription-settings/hwid-settings.schema';
 import { ResponseRulesConfigSchema } from './response-rules';
 
 export const SubscriptionSettingsSchema = z.object({
@@ -30,6 +31,8 @@ export const SubscriptionSettingsSchema = z.object({
 
     responseRules: z.nullable(ResponseRulesConfigSchema),
 
+    hwidSettings: z.nullable(HwidSettingsSchema),
+
     createdAt: z
         .string()
         .datetime()

libs/contract/models/subscription-settings/hwid-settings.schema.ts

@@ -0,0 +1,11 @@
+import z from 'zod';
+
+export const HwidSettingsSchema = z.object({
+    enabled: z.boolean(),
+    fallbackDeviceLimit: z.number(),
+    maxDevicesAnnounce: z.nullable(
+        z.string().max(200, { message: 'Announce must be less than 200 characters' }),
+    ),
+});
+
+export type THwidSettings = z.infer<typeof HwidSettingsSchema>;

libs/contract/models/subscription-settings/index.ts

@@ -0,0 +1 @@
+export * from './hwid-settings.schema';

libs/contract/package.json

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