@standards/constants 1.0.0-alpha.415 → 1.0.0-alpha.418

package/README.md

@@ -21,7 +21,7 @@ pnpm add @standards/constants
 ### Countries
 
 ```typescript
-import { COUNTRIES, getCountryByIso2, isValidIso2 } from "@standards/constants";
+import { COUNTRIES, getCountryByIso2 } from "@standards/constants";
 
 // Get country by ISO2 code
 const france = COUNTRIES.FR;
@@ -30,7 +30,6 @@ console.log(france.phoneCode);   // "+33"
 
 // Lookup functions
 const country = getCountryByIso2("FR");
-const isValid = isValidIso2("FR"); // true
 
 // Type-safe ISO codes
 import type { CountryIso2, CountryIso3 } from "@standards/constants";
@@ -40,7 +39,7 @@ const code: CountryIso2 = "FR"; // Type-safe
 ### Currencies
 
 ```typescript
-import { CURRENCIES, getCurrency, getCurrencySymbol } from "@standards/constants";
+import { CURRENCIES, isValidCurrencyCode } from "@standards/constants";
 
 // Get currency
 const euro = CURRENCIES.EUR;
@@ -48,9 +47,8 @@ console.log(euro.name);     // "Euro"
 console.log(euro.symbol);   // "€"
 console.log(euro.decimals); // 2
 
-// Helper functions
-const symbol = getCurrencySymbol("EUR"); // "€"
-const currency = getCurrency("USD");
+// Type guard
+const isValid = isValidCurrencyCode("usd"); // true
 
 // Type-safe currency codes
 import type { CurrencyCode } from "@standards/constants";
@@ -60,71 +58,36 @@ const code: CurrencyCode = "EUR"; // Type-safe
 ### File Sizes
 
 ```typescript
-import { FILE_SIZE, RECOMMENDED_MAX_SIZES, mbToBytes } from "@standards/constants";
+import { FILE_SIZE } from "@standards/constants";
 
 // Intuitive constants
 const avatarMaxSize = FILE_SIZE.MB_2;      // 2,097,152 bytes
 const documentMaxSize = FILE_SIZE.MB_10;   // 10,485,760 bytes
 const videoMaxSize = FILE_SIZE.MB_500;     // 524,288,000 bytes
-
-// Recommended sizes by use case
-const maxSize = RECOMMENDED_MAX_SIZES.AVATAR;    // 2 MB
-const maxSize = RECOMMENDED_MAX_SIZES.DOCUMENT;  // 10 MB
-const maxSize = RECOMMENDED_MAX_SIZES.VIDEO;     // 500 MB
-
-// Conversion utilities
-const bytes = mbToBytes(5);           // 5,242,880
-
-// Validation
-import { isWithinSizeLimit } from "@standards/constants";
-const isValid = isWithinSizeLimit(1048576, FILE_SIZE.MB_5); // true
 ```
 
 ### MIME Types
 
 ```typescript
-import {
-  IMAGE_MIME_TYPES,
-  DOCUMENT_MIME_TYPES,
-  VIDEO_MIME_TYPES,
-  WEB_IMAGES,
-  OFFICE_DOCUMENTS,
-  isImageMimeType,
-} from "@standards/constants";
+import { DOCUMENT_MIME_TYPES, IMAGE_MIME_TYPES, INLINE_IMAGE_ACCEPT } from "@standards/constants";
 
-// Individual MIME types
 const jpeg = IMAGE_MIME_TYPES.JPEG;  // "image/jpeg"
 const pdf = DOCUMENT_MIME_TYPES.PDF; // "application/pdf"
-const mp4 = VIDEO_MIME_TYPES.MP4;    // "video/mp4"
 
-// Grouped collections
-const webImages = WEB_IMAGES;           // ["image/jpeg", "image/png", "image/gif", "image/webp"]
-const officeFiles = OFFICE_DOCUMENTS;   // [PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX]
-
-// Type checking
-const isImage = isImageMimeType("image/jpeg"); // true
-const isDoc = isDocumentMimeType("application/pdf"); // true
-
-// Type-safe MIME types
-import type { MimeType, ImageMimeType } from "@standards/constants";
-const type: MimeType = "image/jpeg"; // Type-safe
+// The raster images a browser may paint inline, as a file input's `accept`
+const accept = INLINE_IMAGE_ACCEPT; // "image/png,image/jpeg,image/gif,image/webp,image/avif"
 ```
 
 ### Integration with @standards/schema
 
 ```typescript
 import { currency, document, location, phone } from "@standards/schema";
-import {
-  FILE_SIZE,
-  WEB_IMAGES,
-  DOCUMENT_MIME_TYPES,
-  RECOMMENDED_MAX_SIZES,
-} from "@standards/constants";
+import { DOCUMENT_MIME_TYPES, FILE_SIZE, IMAGE_MIME_TYPES } from "@standards/constants";
 
 // File attribute with MIME type validation
 const avatar = document("avatar", "Avatar")
-  .maxFileSize(RECOMMENDED_MAX_SIZES.AVATAR)
-  .accepts([...WEB_IMAGES])
+  .maxFileSize(FILE_SIZE.MB_2)
+  .accepts([IMAGE_MIME_TYPES.JPEG, IMAGE_MIME_TYPES.PNG, IMAGE_MIME_TYPES.WEBP])
   .build();
 
 // Document upload
@@ -167,13 +130,11 @@ const mobile = phone("phone", "Phone")
 - Gigabytes: GB_1, GB_2, GB_5, GB_10
 
 ### MIME Types
-- Images: JPEG, PNG, GIF, WebP, SVG, BMP, TIFF, HEIC, HEIF
-- Documents: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, ODT, TXT, CSV, Markdown
-- Archives: ZIP, RAR, TAR, GZIP, 7Z, BZ2
-- Audio: MP3, WAV, OGG, AAC, FLAC, M4A
-- Video: MP4, WebM, OGG, AVI, MOV, MKV
-- Code: JavaScript, TypeScript, JSON, XML, HTML, CSS, Python, Java
-- Fonts: TTF, OTF, WOFF, WOFF2
+- Images (`IMAGE_MIME_TYPES`): JPEG, PNG, GIF, WebP, SVG, BMP, TIFF, HEIC, HEIF
+- Documents (`DOCUMENT_MIME_TYPES`): PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, ODT, TXT, CSV, Markdown
+- Audio (`AUDIO_MIME_TYPES`): MP3, WAV, OGG, AAC, FLAC, M4A
+- Code (`CODE_MIME_TYPES`): JavaScript, TypeScript, JSON, XML, HTML, CSS, Python, Java
+- Email (`EMAIL_MIME_TYPES`): EML, Outlook MSG
 
 ## Testing
 
@@ -194,9 +155,6 @@ import type {
   CountryIso2,
   CountryIso3,
   CurrencyCode,
-  MimeType,
-  ImageMimeType,
-  DocumentMimeType,
 } from "@standards/constants";
 ```