@elsikora/nestjs-crud-automator 1.11.3 → 1.12.0

package/dist/esm/constant/interface/api/property/default-string-format.constant.js

@@ -0,0 +1,371 @@
+import '../../../../enum/decorator/api/property/data-type.enum.js';
+import '../../../../enum/decorator/api/property/date/identifier.enum.js';
+import '../../../../enum/decorator/api/property/date/type.enum.js';
+import '../../../../enum/decorator/api/property/desribe-type.enum.js';
+import '../../../../enum/decorator/api/property/number-type.enum.js';
+import { EApiPropertyStringType } from '../../../../enum/decorator/api/property/string-type.enum.js';
+
+const BASE64 = {
+    description: "base64 encoded string",
+    exampleValue: "SGVsbG8gV29ybGQ=",
+    maxLength: 1_000_000,
+    minLength: 4,
+    pattern: String.raw `/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/`,
+};
+const BCRYPT = {
+    description: "bcrypt password hash",
+    // eslint-disable-next-line @elsikora/no-secrets/no-secrets
+    exampleValue: "$2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy",
+    maxLength: 60,
+    minLength: 60,
+    pattern: String.raw `/^\$2[aby]\$\d{1,2}\$[.\/A-Za-z0-9]{53}$/`,
+};
+const COUNTRY_CODE_ALPHA2 = {
+    description: "ISO 3166-1 alpha-2 country code",
+    exampleValue: "US",
+    maxLength: 2,
+    minLength: 2,
+    pattern: String.raw `/^[A-Z]{2}$/`,
+};
+const COUNTRY_CODE_ALPHA3 = {
+    description: "ISO 3166-1 alpha-3 country code",
+    exampleValue: "USA",
+    maxLength: 3,
+    minLength: 3,
+    pattern: String.raw `/^[A-Z]{3}$/`,
+};
+const CURRENCY_CODE = {
+    description: "ISO 4217 currency code",
+    exampleValue: "USD",
+    maxLength: 3,
+    minLength: 3,
+    pattern: String.raw `/^[A-Z]{3}$/`,
+};
+const DOMAIN = {
+    description: "domain name",
+    exampleValue: "example.com",
+    maxLength: 253,
+    minLength: 1,
+    pattern: String.raw `/^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$/`,
+};
+const EMAIL = {
+    description: "email",
+    exampleValue: "user@example.com",
+    maxLength: 321,
+    minLength: 5,
+    pattern: String.raw `/^([a-zA-Z0-9_\-.+])+@([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}$/`,
+};
+const HASH_MD5 = {
+    description: "MD5 hash",
+    exampleValue: "5d41402abc4b2a76b9719d911017c592",
+    maxLength: 32,
+    minLength: 32,
+    pattern: String.raw `/^[a-fA-F0-9]{32}$/`,
+};
+const HASH_SHA256 = {
+    description: "SHA-256 hash",
+    exampleValue: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+    maxLength: 64,
+    minLength: 64,
+    pattern: String.raw `/^[a-fA-F0-9]{64}$/`,
+};
+const HEX_COLOR = {
+    description: "hexadecimal color code",
+    exampleValue: "#FF5733",
+    maxLength: 7,
+    minLength: 4,
+    pattern: String.raw `/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/`,
+};
+const IBAN = {
+    description: "International Bank Account Number",
+    exampleValue: "GB82WEST12345698765432",
+    maxLength: 34,
+    minLength: 15,
+    pattern: String.raw `/^[A-Z]{2}\d{2}[A-Z0-9]{1,30}$/`,
+};
+const IPV4 = {
+    description: "IPv4 address",
+    // eslint-disable-next-line @elsikora/sonar/no-hardcoded-ip
+    exampleValue: "192.168.0.1",
+    maxLength: 15,
+    minLength: 7,
+    pattern: String.raw `/^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/`,
+};
+const IPV6 = {
+    description: "IPv6 address",
+    // eslint-disable-next-line @elsikora/sonar/no-hardcoded-ip
+    exampleValue: "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
+    maxLength: 45,
+    minLength: 2,
+    pattern: String.raw `/^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|::)$/`,
+};
+const ISBN = {
+    description: "International Standard Book Number",
+    exampleValue: "978-3-16-148410-0",
+    maxLength: 17,
+    minLength: 10,
+    pattern: String.raw `/^(?:ISBN(?:-1[03])?:? )?(?=[0-9X]{10}$|(?=(?:[0-9]+[- ]){3})[- 0-9X]{13}$|97[89][0-9]{10}$|(?=(?:[0-9]+[- ]){4})[- 0-9]{17}$)(?:97[89][- ]?)?[0-9]{1,5}[- ]?[0-9]+[- ]?[0-9]+[- ]?[0-9X]$/`,
+};
+const JWT = {
+    description: "JSON Web Token",
+    // eslint-disable-next-line @elsikora/no-secrets/no-secrets
+    exampleValue: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+    maxLength: 10_000,
+    minLength: 100,
+    pattern: String.raw `/^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+$/`,
+};
+const LANGUAGE_CODE_ISO639 = {
+    description: "ISO 639-1 language code",
+    exampleValue: "en",
+    maxLength: 2,
+    minLength: 2,
+    pattern: String.raw `/^[a-z]{2}$/`,
+};
+const MAC_ADDRESS = {
+    description: "MAC address",
+    exampleValue: "00:1B:63:84:45:E6",
+    maxLength: 17,
+    minLength: 17,
+    pattern: String.raw `/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/`,
+};
+const MIME_TYPE = {
+    description: "MIME type",
+    exampleValue: "application/json",
+    maxLength: 255,
+    minLength: 3,
+    pattern: String.raw `/^[a-zA-Z0-9][a-zA-Z0-9!#$&^_+-]*(\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_+.-]*)+$/`,
+};
+const PHONE_NUMBER = {
+    description: "E.164 phone number",
+    exampleValue: "+14155552671",
+    maxLength: 16,
+    minLength: 8,
+    pattern: String.raw `/^\+[1-9]\d{1,14}$/`,
+};
+const POSTAL_CODE = {
+    description: "postal code",
+    exampleValue: "12345",
+    maxLength: 10,
+    minLength: 3,
+    pattern: String.raw `/^[A-Z0-9][A-Z0-9 -]{1,8}[A-Z0-9]$/`,
+};
+const SEMVER = {
+    description: "semantic version",
+    exampleValue: "1.2.3",
+    maxLength: 50,
+    minLength: 5,
+    pattern: String.raw `/^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/`,
+};
+const SLUG = {
+    description: "URL slug",
+    exampleValue: "my-blog-post",
+    maxLength: 200,
+    minLength: 1,
+    pattern: String.raw `/^[a-z0-9]+(?:-[a-z0-9]+)*$/`,
+};
+const TIMEZONE = {
+    description: "IANA timezone identifier",
+    exampleValue: "Europe/Kiev",
+    maxLength: 50,
+    minLength: 3,
+    pattern: String.raw `/^[A-Za-z]+(?:\/[A-Za-z_]+)+$/`,
+};
+const URL = {
+    description: "URL",
+    exampleValue: "https://example.com",
+    maxLength: 2048,
+    minLength: 3,
+    pattern: String.raw `/^(https?):\/\/[\w\-]+(\.[\w\-]+)+([\w.,@?^=%&:/~+#-]*[\w@?^=%&/~+#-])?$/`,
+};
+// eslint-disable-next-line @elsikora/no-secrets/no-pattern-match
+const API_KEY = {
+    description: "API key",
+    exampleValue: "sk_live_51HqT2xKz9pQr3sF8vN4hG2mL",
+    maxLength: 100,
+    minLength: 20,
+    pattern: String.raw `/^[a-zA-Z0-9_\-]{20,100}$/`,
+};
+const BITCOIN_ADDRESS = {
+    description: "Bitcoin address",
+    exampleValue: "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
+    maxLength: 35,
+    minLength: 26,
+    pattern: String.raw `/^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$/`,
+};
+const COORDINATES = {
+    description: "geographic coordinates (latitude,longitude)",
+    exampleValue: "50.4501,30.5234",
+    maxLength: 50,
+    minLength: 3,
+    pattern: String.raw `/^-?([1-8]?[0-9](\.\d+)?|90(\.0+)?),\s*-?(1[0-7][0-9](\.\d+)?|[1-9]?[0-9](\.\d+)?|180(\.0+)?)$/`,
+};
+const CRON = {
+    description: "cron expression",
+    exampleValue: "0 */6 * * *",
+    maxLength: 100,
+    minLength: 9,
+    pattern: String.raw `/^(\*|([0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-9]|5[0-9])|\*\/([0-9]|1[0-9]|2[0-9]|3[0-9]|4[0-9]|5[0-9])) (\*|([0-9]|1[0-9]|2[0-3])|\*\/([0-9]|1[0-9]|2[0-3])) (\*|([1-9]|1[0-9]|2[0-9]|3[0-1])|\*\/([1-9]|1[0-9]|2[0-9]|3[0-1])) (\*|([1-9]|1[0-2])|\*\/([1-9]|1[0-2])) (\*|([0-6])|\*\/([0-6]))$/`,
+};
+const DATA_URI = {
+    description: "data URI",
+    exampleValue: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA",
+    maxLength: 1_000_000,
+    minLength: 14,
+    pattern: String.raw `/^data:[a-zA-Z0-9\/+\-]+;base64,[A-Za-z0-9+\/=]+$/`,
+};
+const ETHEREUM_ADDRESS = {
+    description: "Ethereum address",
+    exampleValue: "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
+    maxLength: 42,
+    minLength: 42,
+    pattern: String.raw `/^0x[a-fA-F0-9]{40}$/`,
+};
+const FILE_PATH = {
+    description: "file path",
+    exampleValue: "/home/user/documents/file.txt",
+    maxLength: 500,
+    minLength: 1,
+    pattern: String.raw `/^[^\0]+$/`,
+};
+const GIT_COMMIT_SHA = {
+    description: "Git commit SHA",
+    exampleValue: "a3c4f2b1e8d9c7a6b5e4d3c2b1a098765432",
+    maxLength: 40,
+    minLength: 7,
+    pattern: String.raw `/^[a-fA-F0-9]{7,40}$/`,
+};
+const HSL_COLOR = {
+    description: "HSL color",
+    exampleValue: "hsl(120, 100%, 50%)",
+    maxLength: 30,
+    minLength: 10,
+    pattern: String.raw `/^hsl\(\s*(\d{1,3})\s*,\s*(\d{1,3})%\s*,\s*(\d{1,3})%\s*\)$/`,
+};
+const HSLA_COLOR = {
+    description: "HSLA color",
+    exampleValue: "hsla(120, 100%, 50%, 0.5)",
+    maxLength: 40,
+    minLength: 15,
+    pattern: String.raw `/^hsla\(\s*(\d{1,3})\s*,\s*(\d{1,3})%\s*,\s*(\d{1,3})%\s*,\s*(0|1|0?\.\d+)\s*\)$/`,
+};
+const LOCALE = {
+    description: "locale identifier",
+    exampleValue: "en-US",
+    maxLength: 8,
+    minLength: 2,
+    pattern: String.raw `/^[a-z]{2}(-[A-Z]{2})?$/`,
+};
+const MONGODB_OBJECT_ID = {
+    description: "MongoDB ObjectId",
+    exampleValue: "507f1f77bcf86cd799439011",
+    maxLength: 24,
+    minLength: 24,
+    pattern: String.raw `/^[a-fA-F0-9]{24}$/`,
+};
+const NANOID = {
+    description: "NanoID",
+    exampleValue: "V1StGXR8_Z5jdHi6B-myT",
+    maxLength: 21,
+    minLength: 21,
+    pattern: String.raw `/^[A-Za-z0-9_-]{21}$/`,
+};
+const OAUTH2_SCOPE = {
+    description: "OAuth2 scope",
+    exampleValue: "read:user write:repo",
+    maxLength: 200,
+    minLength: 1,
+    pattern: String.raw `/^[a-zA-Z0-9_:\-]+(?: [a-zA-Z0-9_:\-]+)*$/`,
+};
+const RGB_COLOR = {
+    description: "RGB color",
+    exampleValue: "rgb(255, 128, 0)",
+    maxLength: 20,
+    minLength: 10,
+    pattern: String.raw `/^rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)$/`,
+};
+const RGBA_COLOR = {
+    description: "RGBA color",
+    exampleValue: "rgba(255, 128, 0, 0.5)",
+    maxLength: 30,
+    minLength: 15,
+    pattern: String.raw `/^rgba\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(0|1|0?\.\d+)\s*\)$/`,
+};
+const ULID = {
+    description: "ULID",
+    exampleValue: "01ARZ3NDEKTSV4RRFFQ69G5FAV",
+    maxLength: 26,
+    minLength: 26,
+    pattern: String.raw `/^[0-9A-HJKMNP-TV-Z]{26}$/`,
+};
+const URL_PATH = {
+    description: "URL path",
+    exampleValue: "/api/v1/users/123",
+    maxLength: 500,
+    minLength: 1,
+    pattern: String.raw `/^\/[a-zA-Z0-9\/_\-\.]*$/`,
+};
+const USERNAME = {
+    description: "username",
+    exampleValue: "john_doe123",
+    maxLength: 30,
+    minLength: 3,
+    pattern: String.raw `/^[a-zA-Z0-9_]{3,30}$/`,
+};
+const UUID = {
+    description: "UUID",
+    exampleValue: "123e4567-e89b-12d3-a456-426614174000",
+    maxLength: 36,
+    minLength: 36,
+    pattern: String.raw `/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/`,
+};
+const DEFAULT_STRING_FORMAT_PROPERTY_API_INTERFACE_CONSTANT = {
+    DEFAULT_FORMAT_PROPERTIES: {
+        [EApiPropertyStringType.API_KEY]: API_KEY,
+        [EApiPropertyStringType.BASE64]: BASE64,
+        [EApiPropertyStringType.BCRYPT]: BCRYPT,
+        [EApiPropertyStringType.BITCOIN_ADDRESS]: BITCOIN_ADDRESS,
+        [EApiPropertyStringType.COORDINATES]: COORDINATES,
+        [EApiPropertyStringType.COUNTRY_CODE_ALPHA2]: COUNTRY_CODE_ALPHA2,
+        [EApiPropertyStringType.COUNTRY_CODE_ALPHA3]: COUNTRY_CODE_ALPHA3,
+        [EApiPropertyStringType.CRON]: CRON,
+        [EApiPropertyStringType.CURRENCY_CODE]: CURRENCY_CODE,
+        [EApiPropertyStringType.DATA_URI]: DATA_URI,
+        [EApiPropertyStringType.DOMAIN]: DOMAIN,
+        [EApiPropertyStringType.EMAIL]: EMAIL,
+        [EApiPropertyStringType.ETHEREUM_ADDRESS]: ETHEREUM_ADDRESS,
+        [EApiPropertyStringType.FILE_PATH]: FILE_PATH,
+        [EApiPropertyStringType.GIT_COMMIT_SHA]: GIT_COMMIT_SHA,
+        [EApiPropertyStringType.HASH_MD5]: HASH_MD5,
+        [EApiPropertyStringType.HASH_SHA256]: HASH_SHA256,
+        [EApiPropertyStringType.HEX_COLOR]: HEX_COLOR,
+        [EApiPropertyStringType.HSL_COLOR]: HSL_COLOR,
+        [EApiPropertyStringType.HSLA_COLOR]: HSLA_COLOR,
+        [EApiPropertyStringType.IBAN]: IBAN,
+        [EApiPropertyStringType.IPV4]: IPV4,
+        [EApiPropertyStringType.IPV6]: IPV6,
+        [EApiPropertyStringType.ISBN]: ISBN,
+        [EApiPropertyStringType.JWT]: JWT,
+        [EApiPropertyStringType.LANGUAGE_CODE_ISO639]: LANGUAGE_CODE_ISO639,
+        [EApiPropertyStringType.LOCALE]: LOCALE,
+        [EApiPropertyStringType.MAC_ADDRESS]: MAC_ADDRESS,
+        [EApiPropertyStringType.MIME_TYPE]: MIME_TYPE,
+        [EApiPropertyStringType.MONGODB_OBJECT_ID]: MONGODB_OBJECT_ID,
+        [EApiPropertyStringType.NANOID]: NANOID,
+        [EApiPropertyStringType.OAUTH2_SCOPE]: OAUTH2_SCOPE,
+        [EApiPropertyStringType.PHONE_NUMBER]: PHONE_NUMBER,
+        [EApiPropertyStringType.POSTAL_CODE]: POSTAL_CODE,
+        [EApiPropertyStringType.RGB_COLOR]: RGB_COLOR,
+        [EApiPropertyStringType.RGBA_COLOR]: RGBA_COLOR,
+        [EApiPropertyStringType.SEMVER]: SEMVER,
+        [EApiPropertyStringType.SLUG]: SLUG,
+        [EApiPropertyStringType.TIMEZONE]: TIMEZONE,
+        [EApiPropertyStringType.ULID]: ULID,
+        [EApiPropertyStringType.URL]: URL,
+        [EApiPropertyStringType.URL_PATH]: URL_PATH,
+        [EApiPropertyStringType.USERNAME]: USERNAME,
+        [EApiPropertyStringType.UUID]: UUID,
+    },
+};
+
+export { DEFAULT_STRING_FORMAT_PROPERTY_API_INTERFACE_CONSTANT };
+//# sourceMappingURL=default-string-format.constant.js.map

package/dist/esm/constant/interface/api/property/default-string-format.constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-string-format.constant.js","sources":["../../../../../../../src/constant/interface/api/property/default-string-format.constant.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;AAKA,MAAM,MAAM,GAA8C;AACzD,IAAA,WAAW,EAAE,uBAAuB;AACpC,IAAA,YAAY,EAAE,kBAAkB;AAChC,IAAA,SAAS,EAAE,SAAS;AACpB,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,qEAAA,CAAuE;CAC1F;AAED,MAAM,MAAM,GAA8C;AACzD,IAAA,WAAW,EAAE,sBAAsB;;AAEnC,IAAA,YAAY,EAAE,8DAA8D;AAC5E,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,yCAAA,CAA2C;CAC9D;AAED,MAAM,mBAAmB,GAA8C;AACtE,IAAA,WAAW,EAAE,iCAAiC;AAC9C,IAAA,YAAY,EAAE,IAAI;AAClB,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,YAAA,CAAc;CACjC;AAED,MAAM,mBAAmB,GAA8C;AACtE,IAAA,WAAW,EAAE,iCAAiC;AAC9C,IAAA,YAAY,EAAE,KAAK;AACnB,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,YAAA,CAAc;CACjC;AAED,MAAM,aAAa,GAA8C;AAChE,IAAA,WAAW,EAAE,wBAAwB;AACrC,IAAA,YAAY,EAAE,KAAK;AACnB,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,YAAA,CAAc;CACjC;AAED,MAAM,MAAM,GAA8C;AACzD,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,YAAY,EAAE,aAAa;AAC3B,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,oEAAA,CAAsE;CACzF;AAED,MAAM,KAAK,GAA8C;AACxD,IAAA,WAAW,EAAE,OAAO;AACpB,IAAA,YAAY,EAAE,kBAAkB;AAChC,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,sDAAA,CAAwD;CAC3E;AAED,MAAM,QAAQ,GAA8C;AAC3D,IAAA,WAAW,EAAE,UAAU;AACvB,IAAA,YAAY,EAAE,kCAAkC;AAChD,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,mBAAA,CAAqB;CACxC;AAED,MAAM,WAAW,GAA8C;AAC9D,IAAA,WAAW,EAAE,cAAc;AAC3B,IAAA,YAAY,EAAE,kEAAkE;AAChF,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,mBAAA,CAAqB;CACxC;AAED,MAAM,SAAS,GAA8C;AAC5D,IAAA,WAAW,EAAE,wBAAwB;AACrC,IAAA,YAAY,EAAE,SAAS;AACvB,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,oCAAA,CAAsC;CACzD;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,mCAAmC;AAChD,IAAA,YAAY,EAAE,wBAAwB;AACtC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,+BAAA,CAAiC;CACpD;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,cAAc;;AAE3B,IAAA,YAAY,EAAE,aAAa;AAC3B,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,uFAAA,CAAyF;CAC5G;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,cAAc;;AAE3B,IAAA,YAAY,EAAE,yCAAyC;AACvD,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,iYAAA,CAAmY;CACtZ;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,oCAAoC;AACjD,IAAA,YAAY,EAAE,mBAAmB;AACjC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,2LAAA,CAA6L;CAChN;AAED,MAAM,GAAG,GAA8C;AACtD,IAAA,WAAW,EAAE,gBAAgB;;AAE7B,IAAA,YAAY,EAAE,6JAA6J;AAC3K,IAAA,SAAS,EAAE,MAAM;AACjB,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,kDAAA,CAAoD;CACvE;AAED,MAAM,oBAAoB,GAA8C;AACvE,IAAA,WAAW,EAAE,yBAAyB;AACtC,IAAA,YAAY,EAAE,IAAI;AAClB,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,YAAA,CAAc;CACjC;AAED,MAAM,WAAW,GAA8C;AAC9D,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,YAAY,EAAE,mBAAmB;AACjC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,2CAAA,CAA6C;CAChE;AAED,MAAM,SAAS,GAA8C;AAC5D,IAAA,WAAW,EAAE,WAAW;AACxB,IAAA,YAAY,EAAE,kBAAkB;AAChC,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,wEAAA,CAA0E;CAC7F;AAED,MAAM,YAAY,GAA8C;AAC/D,IAAA,WAAW,EAAE,oBAAoB;AACjC,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,mBAAA,CAAqB;CACxC;AAED,MAAM,WAAW,GAA8C;AAC9D,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,YAAY,EAAE,OAAO;AACrB,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,mCAAA,CAAqC;CACxD;AAED,MAAM,MAAM,GAA8C;AACzD,IAAA,WAAW,EAAE,kBAAkB;AAC/B,IAAA,YAAY,EAAE,OAAO;AACrB,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,qLAAA,CAAuL;CAC1M;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,UAAU;AACvB,IAAA,YAAY,EAAE,cAAc;AAC5B,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,4BAAA,CAA8B;CACjD;AAED,MAAM,QAAQ,GAA8C;AAC3D,IAAA,WAAW,EAAE,0BAA0B;AACvC,IAAA,YAAY,EAAE,aAAa;AAC3B,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,8BAAA,CAAgC;CACnD;AAED,MAAM,GAAG,GAA8C;AACtD,IAAA,WAAW,EAAE,KAAK;AAClB,IAAA,YAAY,EAAE,qBAAqB;AACnC,IAAA,SAAS,EAAE,IAAI;AACf,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,yEAAA,CAA2E;CAC9F;AAED;AACA,MAAM,OAAO,GAA8C;AAC1D,IAAA,WAAW,EAAE,SAAS;AACtB,IAAA,YAAY,EAAE,mCAAmC;AACjD,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,0BAAA,CAA4B;CAC/C;AAED,MAAM,eAAe,GAA8C;AAClE,IAAA,WAAW,EAAE,iBAAiB;AAC9B,IAAA,YAAY,EAAE,oCAAoC;AAClD,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,mCAAA,CAAqC;CACxD;AAED,MAAM,WAAW,GAA8C;AAC9D,IAAA,WAAW,EAAE,6CAA6C;AAC1D,IAAA,YAAY,EAAE,iBAAiB;AAC/B,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,+FAAA,CAAiG;CACpH;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,iBAAiB;AAC9B,IAAA,YAAY,EAAE,aAAa;AAC3B,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,0RAAA,CAA4R;CAC/S;AAED,MAAM,QAAQ,GAA8C;AAC3D,IAAA,WAAW,EAAE,UAAU;AACvB,IAAA,YAAY,EAAE,oDAAoD;AAClE,IAAA,SAAS,EAAE,SAAS;AACpB,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,kDAAA,CAAoD;CACvE;AAED,MAAM,gBAAgB,GAA8C;AACnE,IAAA,WAAW,EAAE,kBAAkB;AAC/B,IAAA,YAAY,EAAE,2CAA2C;AACzD,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,qBAAA,CAAuB;CAC1C;AAED,MAAM,SAAS,GAA8C;AAC5D,IAAA,WAAW,EAAE,WAAW;AACxB,IAAA,YAAY,EAAE,+BAA+B;AAC7C,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,UAAA,CAAY;CAC/B;AAED,MAAM,cAAc,GAA8C;AACjE,IAAA,WAAW,EAAE,gBAAgB;AAC7B,IAAA,YAAY,EAAE,sCAAsC;AACpD,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,qBAAA,CAAuB;CAC1C;AAED,MAAM,SAAS,GAA8C;AAC5D,IAAA,WAAW,EAAE,WAAW;AACxB,IAAA,YAAY,EAAE,qBAAqB;AACnC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,4DAAA,CAA8D;CACjF;AAED,MAAM,UAAU,GAA8C;AAC7D,IAAA,WAAW,EAAE,YAAY;AACzB,IAAA,YAAY,EAAE,2BAA2B;AACzC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,iFAAA,CAAmF;CACtG;AAED,MAAM,MAAM,GAA8C;AACzD,IAAA,WAAW,EAAE,mBAAmB;AAChC,IAAA,YAAY,EAAE,OAAO;AACrB,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,wBAAA,CAA0B;CAC7C;AAED,MAAM,iBAAiB,GAA8C;AACpE,IAAA,WAAW,EAAE,kBAAkB;AAC/B,IAAA,YAAY,EAAE,0BAA0B;AACxC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,mBAAA,CAAqB;CACxC;AAED,MAAM,MAAM,GAA8C;AACzD,IAAA,WAAW,EAAE,QAAQ;AACrB,IAAA,YAAY,EAAE,uBAAuB;AACrC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,qBAAA,CAAuB;CAC1C;AAED,MAAM,YAAY,GAA8C;AAC/D,IAAA,WAAW,EAAE,cAAc;AAC3B,IAAA,YAAY,EAAE,sBAAsB;AACpC,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,0CAAA,CAA4C;CAC/D;AAED,MAAM,SAAS,GAA8C;AAC5D,IAAA,WAAW,EAAE,WAAW;AACxB,IAAA,YAAY,EAAE,kBAAkB;AAChC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,0DAAA,CAA4D;CAC/E;AAED,MAAM,UAAU,GAA8C;AAC7D,IAAA,WAAW,EAAE,YAAY;AACzB,IAAA,YAAY,EAAE,wBAAwB;AACtC,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,+EAAA,CAAiF;CACpG;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,MAAM;AACnB,IAAA,YAAY,EAAE,4BAA4B;AAC1C,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,0BAAA,CAA4B;CAC/C;AAED,MAAM,QAAQ,GAA8C;AAC3D,IAAA,WAAW,EAAE,UAAU;AACvB,IAAA,YAAY,EAAE,mBAAmB;AACjC,IAAA,SAAS,EAAE,GAAG;AACd,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,yBAAA,CAA2B;CAC9C;AAED,MAAM,QAAQ,GAA8C;AAC3D,IAAA,WAAW,EAAE,UAAU;AACvB,IAAA,YAAY,EAAE,aAAa;AAC3B,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,CAAC;AACZ,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,sBAAA,CAAwB;CAC3C;AAED,MAAM,IAAI,GAA8C;AACvD,IAAA,WAAW,EAAE,MAAM;AACnB,IAAA,YAAY,EAAE,sCAAsC;AACpD,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,SAAS,EAAE,EAAE;AACb,IAAA,OAAO,EAAE,MAAM,CAAC,GAAG,CAAA,CAAA,4FAAA,CAA8F;CACjH;AAEM,MAAM,qDAAqD,GAE9D;AACH,IAAA,yBAAyB,EAAE;AAC1B,QAAA,CAAC,sBAAsB,CAAC,OAAO,GAAG,OAAO;AACzC,QAAA,CAAC,sBAAsB,CAAC,MAAM,GAAG,MAAM;AACvC,QAAA,CAAC,sBAAsB,CAAC,MAAM,GAAG,MAAM;AACvC,QAAA,CAAC,sBAAsB,CAAC,eAAe,GAAG,eAAe;AACzD,QAAA,CAAC,sBAAsB,CAAC,WAAW,GAAG,WAAW;AACjD,QAAA,CAAC,sBAAsB,CAAC,mBAAmB,GAAG,mBAAmB;AACjE,QAAA,CAAC,sBAAsB,CAAC,mBAAmB,GAAG,mBAAmB;AACjE,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,QAAA,CAAC,sBAAsB,CAAC,aAAa,GAAG,aAAa;AACrD,QAAA,CAAC,sBAAsB,CAAC,QAAQ,GAAG,QAAQ;AAC3C,QAAA,CAAC,sBAAsB,CAAC,MAAM,GAAG,MAAM;AACvC,QAAA,CAAC,sBAAsB,CAAC,KAAK,GAAG,KAAK;AACrC,QAAA,CAAC,sBAAsB,CAAC,gBAAgB,GAAG,gBAAgB;AAC3D,QAAA,CAAC,sBAAsB,CAAC,SAAS,GAAG,SAAS;AAC7C,QAAA,CAAC,sBAAsB,CAAC,cAAc,GAAG,cAAc;AACvD,QAAA,CAAC,sBAAsB,CAAC,QAAQ,GAAG,QAAQ;AAC3C,QAAA,CAAC,sBAAsB,CAAC,WAAW,GAAG,WAAW;AACjD,QAAA,CAAC,sBAAsB,CAAC,SAAS,GAAG,SAAS;AAC7C,QAAA,CAAC,sBAAsB,CAAC,SAAS,GAAG,SAAS;AAC7C,QAAA,CAAC,sBAAsB,CAAC,UAAU,GAAG,UAAU;AAC/C,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,QAAA,CAAC,sBAAsB,CAAC,GAAG,GAAG,GAAG;AACjC,QAAA,CAAC,sBAAsB,CAAC,oBAAoB,GAAG,oBAAoB;AACnE,QAAA,CAAC,sBAAsB,CAAC,MAAM,GAAG,MAAM;AACvC,QAAA,CAAC,sBAAsB,CAAC,WAAW,GAAG,WAAW;AACjD,QAAA,CAAC,sBAAsB,CAAC,SAAS,GAAG,SAAS;AAC7C,QAAA,CAAC,sBAAsB,CAAC,iBAAiB,GAAG,iBAAiB;AAC7D,QAAA,CAAC,sBAAsB,CAAC,MAAM,GAAG,MAAM;AACvC,QAAA,CAAC,sBAAsB,CAAC,YAAY,GAAG,YAAY;AACnD,QAAA,CAAC,sBAAsB,CAAC,YAAY,GAAG,YAAY;AACnD,QAAA,CAAC,sBAAsB,CAAC,WAAW,GAAG,WAAW;AACjD,QAAA,CAAC,sBAAsB,CAAC,SAAS,GAAG,SAAS;AAC7C,QAAA,CAAC,sBAAsB,CAAC,UAAU,GAAG,UAAU;AAC/C,QAAA,CAAC,sBAAsB,CAAC,MAAM,GAAG,MAAM;AACvC,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,QAAA,CAAC,sBAAsB,CAAC,QAAQ,GAAG,QAAQ;AAC3C,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,QAAA,CAAC,sBAAsB,CAAC,GAAG,GAAG,GAAG;AACjC,QAAA,CAAC,sBAAsB,CAAC,QAAQ,GAAG,QAAQ;AAC3C,QAAA,CAAC,sBAAsB,CAAC,QAAQ,GAAG,QAAQ;AAC3C,QAAA,CAAC,sBAAsB,CAAC,IAAI,GAAG,IAAI;AACnC,KAAA;;;;;"}

package/dist/esm/constant/interface/api/property/index.d.ts

@@ -1,2 +1,3 @@
+export { DEFAULT_STRING_FORMAT_PROPERTY_API_INTERFACE_CONSTANT } from './default-string-format.constant';
 export { STRING_PROPERTY_API_INTERFACE_CONSTANT } from './string.constant';
 export { WALLET_PROPERTY_API_INTERFACE_CONSTANT } from './wallet.constant';

package/dist/esm/constant/interface/api/property/string.constant.d.ts

@@ -1,6 +1,7 @@
 import type { IsIpVersion } from "class-validator/types/decorator/string/IsIP";
 export declare const STRING_PROPERTY_API_INTERFACE_CONSTANT: {
     readonly IP_VERSION: IsIpVersion;
+    readonly IP_VERSION_6: IsIpVersion;
     readonly REGEX_FLAGS_INDEX: number;
     readonly REGEX_PATTERN_INDEX: number;
 };

package/dist/esm/constant/interface/api/property/string.constant.js

@@ -1,8 +1,10 @@
 const REGEX_PATTERN_INDEX = 1;
 const REGEX_FLAGS_INDEX = 2;
 const IP_VERSION = 4;
+const IP_VERSION_6 = 6;
 const STRING_PROPERTY_API_INTERFACE_CONSTANT = {
     IP_VERSION,
+    IP_VERSION_6,
     REGEX_FLAGS_INDEX,
     REGEX_PATTERN_INDEX,
 };

package/dist/esm/constant/interface/api/property/string.constant.js.map

@@ -1 +1 @@
-{"version":3,"file":"string.constant.js","sources":["../../../../../../../src/constant/interface/api/property/string.constant.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA,MAAM,mBAAmB,GAAW,CAAC;AACrC,MAAM,iBAAiB,GAAW,CAAC;AACnC,MAAM,UAAU,GAAgB,CAAC;AAE1B,MAAM,sCAAsC,GAI/C;IACH,UAAU;IACV,iBAAiB;IACjB,mBAAmB;;;;;"}
+{"version":3,"file":"string.constant.js","sources":["../../../../../../../src/constant/interface/api/property/string.constant.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA,MAAM,mBAAmB,GAAW,CAAC;AACrC,MAAM,iBAAiB,GAAW,CAAC;AACnC,MAAM,UAAU,GAAgB,CAAC;AACjC,MAAM,YAAY,GAAgB,CAAC;AAE5B,MAAM,sCAAsC,GAK/C;IACH,UAAU;IACV,YAAY;IACZ,iBAAiB;IACjB,mBAAmB;;;;;"}

package/dist/esm/decorator/api/controller/decorator.d.ts

@@ -3,7 +3,24 @@ import type { IApiControllerProperties } from '../../../interface/decorator/api/
 import type { TApiControllerConstructor } from '../../../type/decorator/api/controller/index';
 /**
  * Automatically generates CRUD endpoints for an entity.
- *
+ * @param {IApiControllerProperties<E>} options - The controller properties
+ * @returns {TApiControllerConstructor} The controller constructor
+ * @template E - The entity type
+ * @example
+ * ```typescript
+ * @ApiController<UserEntity>({
+ *   entity: UserEntity,
+ *   name: "Users",
+ *   routes: {
+ *     [EApiRouteType.CREATE]: {},
+ *     [EApiRouteType.GET]: {},
+ *     [EApiRouteType.GET_LIST]: {},
+ *     [EApiRouteType.UPDATE]: {},
+ *     [EApiRouteType.DELETE]: {},
+ *   },
+ * })
+ * export class UserController {}
+ * ```
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators#apicontroller | API Reference - ApiController}
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/core-concepts/controllers | Core Concepts - Controllers}
  */

package/dist/esm/decorator/api/controller/decorator.js

@@ -2,7 +2,24 @@ import { ApiControllerFactory } from '../../../factory/api/controller.factory.js
 
 /**
  * Automatically generates CRUD endpoints for an entity.
- *
+ * @param {IApiControllerProperties<E>} options - The controller properties
+ * @returns {TApiControllerConstructor} The controller constructor
+ * @template E - The entity type
+ * @example
+ * ```typescript
+ * @ApiController<UserEntity>({
+ *   entity: UserEntity,
+ *   name: "Users",
+ *   routes: {
+ *     [EApiRouteType.CREATE]: {},
+ *     [EApiRouteType.GET]: {},
+ *     [EApiRouteType.GET_LIST]: {},
+ *     [EApiRouteType.UPDATE]: {},
+ *     [EApiRouteType.DELETE]: {},
+ *   },
+ * })
+ * export class UserController {}
+ * ```
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators#apicontroller | API Reference - ApiController}
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/core-concepts/controllers | Core Concepts - Controllers}
  */

package/dist/esm/decorator/api/controller/decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorator.js","sources":["../../../../../../src/decorator/api/controller/decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAMA;;;;;AAKG;AACI,MAAM,aAAa,GACzB,CAA2B,OAAoC,KAC/D,CAAsC,MAAS,KAAO;IACrD,MAAM,OAAO,GAA4B,IAAI,oBAAoB,CAAI,MAAM,EAAE,OAAO,CAAC;IACrF,OAAO,CAAC,IAAI,EAAE;;AAGd,IAAA,MAAM,mBAAmB,GAA2D,cAAc,MAAM,CAAA;;AAEvG,QAAA,WAAA,CAAY,GAAG,UAAe,EAAA;;AAE7B,YAAA,KAAK,CAAC,GAAG,UAAU,CAAC;QACrB;KACA;AACD,IAAA,MAAM,CAAC,cAAc,CAAC,mBAAmB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;AAE1E,IAAA,OAAO,mBAAwB;AAChC;;;;"}
+{"version":3,"file":"decorator.js","sources":["../../../../../../src/decorator/api/controller/decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAMA;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,MAAM,aAAa,GACzB,CAA2B,OAAoC,KAC/D,CAAsC,MAAS,KAAO;IACrD,MAAM,OAAO,GAA4B,IAAI,oBAAoB,CAAI,MAAM,EAAE,OAAO,CAAC;IACrF,OAAO,CAAC,IAAI,EAAE;;AAGd,IAAA,MAAM,mBAAmB,GAA2D,cAAc,MAAM,CAAA;;AAEvG,QAAA,WAAA,CAAY,GAAG,UAAe,EAAA;;AAE7B,YAAA,KAAK,CAAC,GAAG,UAAU,CAAC;QACrB;KACA;AACD,IAAA,MAAM,CAAC,cAAc,CAAC,mBAAmB,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;AAE1E,IAAA,OAAO,mBAAwB;AAChC;;;;"}

package/dist/esm/decorator/api/property/describe.decorator.d.ts

@@ -79,7 +79,6 @@ import type { TApiPropertyDescribeProperties } from '../../../type/decorator/api
  * })
  * posts: Post[];
  * ```
- *
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators#apipropertydescribe | API Reference - ApiPropertyDescribe}
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/core-concepts/entities | Core Concepts - Entities}
  */

package/dist/esm/decorator/api/property/describe.decorator.js

@@ -82,7 +82,6 @@ import { PROPERTY_DESCRIBE_DECORATOR_API_CONSTANT } from '../../../constant/deco
  * })
  * posts: Post[];
  * ```
- *
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/api-reference/decorators#apipropertydescribe | API Reference - ApiPropertyDescribe}
  * @see {@link https://elsikora.com/docs/nestjs-crud-automator/core-concepts/entities | Core Concepts - Entities}
  */

package/dist/esm/decorator/api/property/describe.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"describe.decorator.js","sources":["../../../../../../src/decorator/api/property/describe.decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmFG;AACG,SAAU,mBAAmB,CAAC,UAA0C,EAAA;AAC7E,IAAA,OAAO,CAAC,MAA8B,EAAE,WAA4B,KAAU;AAC7E,QAAA,MAAM,UAAU,GAAW,MAAM,CAAC,WAAW,CAAC,IAAI;AAClD,QAAA,eAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,EAAE,wCAAwC,CAAC,YAAY,EAAE,UAAU,CAAC;AACtI,IAAA,CAAC;AACF;;;;"}
+{"version":3,"file":"describe.decorator.js","sources":["../../../../../../src/decorator/api/property/describe.decorator.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkFG;AACG,SAAU,mBAAmB,CAAC,UAA0C,EAAA;AAC7E,IAAA,OAAO,CAAC,MAA8B,EAAE,WAA4B,KAAU;AAC7E,QAAA,MAAM,UAAU,GAAW,MAAM,CAAC,WAAW,CAAC,IAAI;AAClD,QAAA,eAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,EAAE,wCAAwC,CAAC,YAAY,EAAE,UAAU,CAAC;AACtI,IAAA,CAAC;AACF;;;;"}