@voxgig/apidef 3.6.0 → 3.7.0

package/src/utility.ts

@@ -120,21 +120,27 @@ function depluralize(word: string): string {
     'horses': 'horse',
     'house': 'houses',
     'indices': 'index',
+    'lens': 'lens',
     'license': 'licenses',
     'matrices': 'matrix',
     'men': 'man',
     'mice': 'mouse',
+    'movies': 'movie',
     'notice': 'notices',
     'oases': 'oasis',
+    'phrase': 'phrase',
     'releases': 'release',
     'people': 'person',
     'phenomena': 'phenomenon',
     'practice': 'practices',
     'promise': 'promises',
+    'series': 'series',
+    'species': 'species',
     'teeth': 'tooth',
     'theses': 'thesis',
     'vertices': 'vertex',
     'women': 'woman',
+    'yes': 'yes',
   }
 
   if (irregulars[word]) {
@@ -149,14 +155,12 @@ function depluralize(word: string): string {
 
   // Rules for regular plurals (applied in order)
 
+  // -ies -> -y (cities -> city), but only if result is > 2 chars
   if (word.endsWith('ies') && word.length > 3) {
-    return word.slice(0, -3) + 'y'
-  }
-
-
-  // -ies -> -y (cities -> city)
-  if (word.endsWith('ies') && word.length > 3) {
-    return word.slice(0, -3) + 'y'
+    const result = word.slice(0, -3) + 'y'
+    if (result.length > 2) {
+      return result
+    }
   }
 
   // -ves -> -f or -fe (wolves -> wolf, knives -> knife)
@@ -186,10 +190,11 @@ function depluralize(word: string): string {
     return word.slice(0, -2)
   }
 
-  // -s -> remove -s (cats -> cat)
+  // -s -> remove -s (cats -> cat), but only if result is > 2 chars
   if (word.endsWith('s') &&
     !word.endsWith('ss') &&
-    !word.endsWith('us')
+    !word.endsWith('us') &&
+    word.length > 3
   ) {
     return word.slice(0, -1)
   }
@@ -726,8 +731,119 @@ function validator(torig: undefined | string | string[]): any {
   }
 }
 
+const FILE_EXT_RE =
+  /\.(php|json|txt|png|jpg|jpeg|gif|svg|xml|html|csv|yml|yaml|md)$/i
+
+function transliterate(s: string): string {
+  return s.normalize('NFD').replace(/[\u0300-\u036f]/g, '')
+}
+
 function canonize(s: string) {
-  return depluralize(snakify(s)).replace(/[^a-zA-Z_0-9]/g, '')
+  if (null == s || '' === s) return ''
+  return depluralize(snakify(transliterate(s).replace(FILE_EXT_RE, '')))
+    .replace(/[^a-zA-Z_0-9]/g, '')
+}
+
+
+const BOOLEAN_NAME_RE = /^(is_|has_|can_|should_|allow_|enabled$|disabled$|active$|visible$|deleted$|verified$|public$|private$|locked$|archived$|blocked$)/
+const INTEGER_NAME_RE = /(_count$|_number$|^total_|^count_|^num_|^limit$|^page$|^offset$|^per_page$|^page_size$|^size$|^skip$)/
+const NUMBER_NAME_RE = /^(latitude$|longitude$|lat$|lng$|lon$|price$|amount$|rate$|score$|weight$|height$|width$|depth$|radius$|distance$|duration$|percentage$|percent$)/
+const STRING_NAME_RE = /^(url$|href$|link$|uri$|email$|name$|title$|description$|slug$|path$|label$|username$|password$|token$|key$)/
+const ID_NAME_RE = /(_id$|^id$)/
+
+function inferFieldType(name: string, specType: string): string {
+  // Only override $ANY, or $STRING for boolean-patterned names
+  if ('`$ANY`' === specType) {
+    if (BOOLEAN_NAME_RE.test(name)) return '`$BOOLEAN`'
+    if (ID_NAME_RE.test(name)) return '`$STRING`'
+    if (INTEGER_NAME_RE.test(name)) return '`$INTEGER`'
+    if (NUMBER_NAME_RE.test(name)) return '`$NUMBER`'
+    if (STRING_NAME_RE.test(name)) return '`$STRING`'
+  }
+  else if ('`$STRING`' === specType) {
+    if (BOOLEAN_NAME_RE.test(name)) return '`$BOOLEAN`'
+  }
+  return specType
+}
+
+
+function normalizeFieldName(s: string): string {
+  if (null == s || '' === s) return ''
+  return s
+    .replace(/\[\]/g, '')
+    .replace(/[\[\].]+/g, '_')
+    .replace(/_+/g, '_')
+    .replace(/^_|_$/g, '')
+}
+
+
+const MIN_ENTITY_NAME_LEN = 3
+const MAX_ENTITY_NAME_LEN = 67
+
+function ensureMinEntityName(
+  name: string,
+  existing: Record<string, any>,
+): string {
+  let padded = name.replace(/[^a-zA-Z_0-9]/g, '').replace(/^_+/, '')
+
+  // Truncate sentence-length names by taking leading segments
+  if (padded.length > MAX_ENTITY_NAME_LEN) {
+    const parts = padded.split('_')
+    let truncated = ''
+    for (const part of parts) {
+      const next = truncated === '' ? part : truncated + '_' + part
+      if (next.length > MAX_ENTITY_NAME_LEN) break
+      truncated = next
+    }
+    padded = truncated || parts[0].substring(0, MAX_ENTITY_NAME_LEN)
+  }
+
+  if (padded.length > 0 && padded[0] >= '0' && padded[0] <= '9') {
+    padded = 'n' + padded
+  }
+  if (padded.length < MIN_ENTITY_NAME_LEN) {
+    const padding = 'nt'.substring(0, MIN_ENTITY_NAME_LEN - padded.length)
+    padded = padded + padding
+  }
+
+  if (padded !== name && null != existing[padded]) {
+    let i = 2
+    while (null != existing[padded + i]) {
+      i++
+    }
+    padded = padded + i
+  }
+
+  return padded
+}
+
+
+const CMP_SUFFIXES = ['_rest_controller', '_controller', '_response', '_request']
+const CMP_PREFIXES = ['get_', 'post_', 'put_', 'delete_', 'patch_']
+
+function cleanComponentName(name: string): string {
+  let cleaned = name
+
+  for (const suffix of CMP_SUFFIXES) {
+    if (cleaned.endsWith(suffix)) {
+      const parts = cleaned.split('_')
+      const suffixParts = suffix.split('_').filter(s => s !== '').length
+      cleaned = canonize(parts.slice(0, parts.length - suffixParts).join('_'))
+      break
+    }
+  }
+
+  for (const prefix of CMP_PREFIXES) {
+    if (cleaned.startsWith(prefix)) {
+      const remainder = cleaned.substring(prefix.length)
+      if (remainder.length >= 3) {
+        cleaned = remainder
+      }
+      break
+    }
+  }
+
+  return cleaned
 }
 
 
@@ -942,6 +1058,11 @@ export {
   formatJSONIC,
   validator,
   canonize,
+  transliterate,
+  cleanComponentName,
+  ensureMinEntityName,
+  inferFieldType,
+  normalizeFieldName,
   debugpath,
   findPathsWithPrefix,
   writeFileSyncWarn,