@stryke/string-format 0.4.11 → 0.5.1

package/dist/acronyms.cjs

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.ACRONYMS = void 0;
-const ACRONYMS = exports.ACRONYMS = ["3D", "4D", "5G", "6G", "7G", "8G", "ACID", "AES", "AI", "AJAX", "API", "AR", "ASCII", "B2B", "B2C", "BFF", "BI", "BIOS", "BGP", "BOM", "BYOD", "C2C", "CAGR", "CAPTCHA", "CD", "CDN", "CDP", "CI", "CI/CD", "CIAM", "CICD", "CLI", "CMDB", "CORS", "CPU", "CRUD", "CSR", "CSS", "CX", "DAG", "DBMS", "DDoS", "DNS", "DNSSEC", "DOM", "DR", "DRM", "DWH", "E2E", "EAI", "EKS", "EOF", "EOD", "ETC", "ETL", "EULA", "FIDO", "FQDN", "FTP", "FaaS", "GDPR", "GCP", "GPU", "GUID", "GUI", "GZIP", "HCI", "HDD", "HDFS", "HIPAA", "HMAC", "HOTP", "HSM", "HTML", "HTTP", "HTTP/2", "HTTP/2.0", "HTTP/3", "HTTP/3.0", "HTTP2", "HTTPS", "HTTPS/2", "HTTPS/3", "HTTPS3", "IAM", "IAMM", "IAMT", "IaaS", "ID", "IMAP", "IP", "IPFS", "IoT", "JSON", "JSONP", "JWT", "K8s", "KMS", "KPI", "LAN", "LHS", "LXC", "MFA", "ML", "MLOps", "MVC", "MVP", "NAS", "NAT", "NDA", "NFS", "NIST", "NLP", "NPS", "OCR", "OEM", "OKR", "OLAP", "OLTP", "OOP", "ORM", "OS", "OTP", "P2P", "PDP", "PaaS", "PCI", "PKI", "PP", "PWA", "PX", "QA", "RAID", "RAM", "RDS", "REST", "RHS", "RPC", "RPA", "RUM", "RSS", "SAN", "SASE", "SDLC", "SDK", "SEO", "SFTP", "SIEM", "SLA", "SMB", "SMTP", "SOAP", "SOC", "SOA", "SPDY", "SPF", "SQL", "SRV", "SRE", "SSH", "SSDL", "SSO", "SSL", "SSR", "TDD", "TLD", "TLS", "TLS1.3", "TOTP", "TRPC", "TTL", "UDP", "UI", "UID", "URI", "URL", "UTF", "UUID", "UX", "VM", "VLAN", "VPN", "VR", "WAF", "WAN", "WLAN", "WPA", "XACML", "XML", "XSRF", "XSS", "XR", "YAML", "ZTA"];
+const ACRONYMS = exports.ACRONYMS = ["3D", "4D", "5G", "6G", "7G", "8G", "ACID", "AES", "AI", "AJAX", "API", "AR", "ASCII", "B2B", "B2C", "BFF", "BI", "BIOS", "BGP", "BOM", "BYOD", "C2C", "CAGR", "CAPTCHA", "CD", "CDN", "CDP", "CI", "CI/CD", "CIAM", "CICD", "CLI", "CMDB", "CORS", "CPU", "CRUD", "CSR", "CSS", "CX", "DAG", "DBMS", "DDoS", "DNS", "DNSSEC", "DOM", "DR", "DRM", "DWH", "E2E", "EAI", "EKS", "EOF", "EOD", "ETC", "ETL", "EULA", "FIDO", "FQDN", "FTP", "FaaS", "GDPR", "GCP", "GPU", "GUID", "GUI", "GZIP", "HCI", "HDD", "HDFS", "HIPAA", "HMAC", "HOTP", "HSM", "HTML", "HTTP", "HTTP/2", "HTTP/2.0", "HTTP/3", "HTTP/3.0", "HTTP2", "HTTPS", "HTTPS/2", "HTTPS/3", "HTTPS3", "IAM", "IAMM", "IAMT", "IaaS", "ID", "IMAP", "IP", "IPFS", "IoT", "JSON", "JSONP", "JWT", "K8s", "KMS", "KPI", "KV", "LAN", "LHS", "LXC", "MFA", "ML", "MLOps", "MVC", "MVP", "NAS", "NAT", "NDA", "NFS", "NIST", "NLP", "NPS", "OCR", "OEM", "OKR", "OLAP", "OLTP", "OOP", "ORM", "OS", "OTP", "P2P", "PDP", "PaaS", "PCI", "PKI", "PP", "PWA", "PX", "QA", "R2", "RAID", "RAM", "RDS", "REST", "RHS", "RPC", "RPA", "RUM", "RSS", "S3", "SAN", "SASE", "SDLC", "SDK", "SEO", "SFTP", "SIEM", "SLA", "SMB", "SMTP", "SOAP", "SOC", "SOA", "SPDY", "SPF", "SQL", "SRV", "SRE", "SSH", "SSDL", "SSO", "SSL", "SSR", "TDD", "TLD", "TLS", "TLS1.3", "TOTP", "TRPC", "TTL", "UDP", "UI", "UID", "URI", "URL", "UTF", "UUID", "UX", "VM", "VLAN", "VPN", "VR", "WAF", "WAN", "WLAN", "WPA", "XACML", "XML", "XSRF", "XSS", "XR", "YAML", "ZTA"];

package/dist/acronyms.mjs

@@ -1 +1 @@
-export const ACRONYMS=["3D","4D","5G","6G","7G","8G","ACID","AES","AI","AJAX","API","AR","ASCII","B2B","B2C","BFF","BI","BIOS","BGP","BOM","BYOD","C2C","CAGR","CAPTCHA","CD","CDN","CDP","CI","CI/CD","CIAM","CICD","CLI","CMDB","CORS","CPU","CRUD","CSR","CSS","CX","DAG","DBMS","DDoS","DNS","DNSSEC","DOM","DR","DRM","DWH","E2E","EAI","EKS","EOF","EOD","ETC","ETL","EULA","FIDO","FQDN","FTP","FaaS","GDPR","GCP","GPU","GUID","GUI","GZIP","HCI","HDD","HDFS","HIPAA","HMAC","HOTP","HSM","HTML","HTTP","HTTP/2","HTTP/2.0","HTTP/3","HTTP/3.0","HTTP2","HTTPS","HTTPS/2","HTTPS/3","HTTPS3","IAM","IAMM","IAMT","IaaS","ID","IMAP","IP","IPFS","IoT","JSON","JSONP","JWT","K8s","KMS","KPI","LAN","LHS","LXC","MFA","ML","MLOps","MVC","MVP","NAS","NAT","NDA","NFS","NIST","NLP","NPS","OCR","OEM","OKR","OLAP","OLTP","OOP","ORM","OS","OTP","P2P","PDP","PaaS","PCI","PKI","PP","PWA","PX","QA","RAID","RAM","RDS","REST","RHS","RPC","RPA","RUM","RSS","SAN","SASE","SDLC","SDK","SEO","SFTP","SIEM","SLA","SMB","SMTP","SOAP","SOC","SOA","SPDY","SPF","SQL","SRV","SRE","SSH","SSDL","SSO","SSL","SSR","TDD","TLD","TLS","TLS1.3","TOTP","TRPC","TTL","UDP","UI","UID","URI","URL","UTF","UUID","UX","VM","VLAN","VPN","VR","WAF","WAN","WLAN","WPA","XACML","XML","XSRF","XSS","XR","YAML","ZTA"];
+export const ACRONYMS=["3D","4D","5G","6G","7G","8G","ACID","AES","AI","AJAX","API","AR","ASCII","B2B","B2C","BFF","BI","BIOS","BGP","BOM","BYOD","C2C","CAGR","CAPTCHA","CD","CDN","CDP","CI","CI/CD","CIAM","CICD","CLI","CMDB","CORS","CPU","CRUD","CSR","CSS","CX","DAG","DBMS","DDoS","DNS","DNSSEC","DOM","DR","DRM","DWH","E2E","EAI","EKS","EOF","EOD","ETC","ETL","EULA","FIDO","FQDN","FTP","FaaS","GDPR","GCP","GPU","GUID","GUI","GZIP","HCI","HDD","HDFS","HIPAA","HMAC","HOTP","HSM","HTML","HTTP","HTTP/2","HTTP/2.0","HTTP/3","HTTP/3.0","HTTP2","HTTPS","HTTPS/2","HTTPS/3","HTTPS3","IAM","IAMM","IAMT","IaaS","ID","IMAP","IP","IPFS","IoT","JSON","JSONP","JWT","K8s","KMS","KPI","KV","LAN","LHS","LXC","MFA","ML","MLOps","MVC","MVP","NAS","NAT","NDA","NFS","NIST","NLP","NPS","OCR","OEM","OKR","OLAP","OLTP","OOP","ORM","OS","OTP","P2P","PDP","PaaS","PCI","PKI","PP","PWA","PX","QA","R2","RAID","RAM","RDS","REST","RHS","RPC","RPA","RUM","RSS","S3","SAN","SASE","SDLC","SDK","SEO","SFTP","SIEM","SLA","SMB","SMTP","SOAP","SOC","SOA","SPDY","SPF","SQL","SRV","SRE","SSH","SSDL","SSO","SSL","SSR","TDD","TLD","TLS","TLS1.3","TOTP","TRPC","TTL","UDP","UI","UID","URI","URL","UTF","UUID","UX","VM","VLAN","VPN","VR","WAF","WAN","WLAN","WPA","XACML","XML","XSRF","XSS","XR","YAML","ZTA"];

package/dist/get-words.cjs

@@ -7,6 +7,6 @@ exports.CASE_SPLIT_PATTERN = void 0;
 exports.getWords = getWords;
 const CASE_SPLIT_PATTERN = exports.CASE_SPLIT_PATTERN = /[A-Z]?[a-z]+|\d+|[A-Z]+(?![a-z])/g;
 function getWords(r) {
-  if (r.length > 1e3) throw new Error("The regular expression parameter of `get-words` can't handle strings longer than 1000 characters");
+  if (r.length > 2e3) throw new Error("The regular expression parameter of `get-words` can't handle strings longer than 2000 characters");
   return [...(r.match(CASE_SPLIT_PATTERN) ?? [])];
 }

package/dist/get-words.mjs

@@ -1 +1 @@
-export const CASE_SPLIT_PATTERN=/[A-Z]?[a-z]+|\d+|[A-Z]+(?![a-z])/g;export function getWords(r){if(r.length>1e3)throw new Error("The regular expression parameter of `get-words` can't handle strings longer than 1000 characters");return[...r.match(CASE_SPLIT_PATTERN)??[]]}
+export const CASE_SPLIT_PATTERN=/[A-Z]?[a-z]+|\d+|[A-Z]+(?![a-z])/g;export function getWords(r){if(r.length>2e3)throw new Error("The regular expression parameter of `get-words` can't handle strings longer than 2000 characters");return[...r.match(CASE_SPLIT_PATTERN)??[]]}

package/dist/kebab-case.cjs

@@ -4,9 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.kebabCase = kebabCase;
-var _types = require("@stryke/types");
-var _upperCaseFirst = require("./upper-case-first.cjs");
-function kebabCase(t) {
-  const r = t?.replace(/[A-Z]+/g, e => (0, _upperCaseFirst.upperCaseFirst)(e) ?? _types.EMPTY_STRING)?.split(/(?=[A-Z])|[\s._-]/).map(e => e.toLowerCase()) ?? [];
-  return r.length === 0 ? "" : r.length === 1 ? r[0] : r.reduce((e, s) => `${e}-${s.toLowerCase()}`.toLowerCase());
+var _getWords = require("./get-words.cjs");
+function kebabCase(e) {
+  const r = e ? (0, _getWords.getWords)(e) : [];
+  return r.length === 0 ? "" : r.join("-").toLowerCase();
 }

package/dist/kebab-case.mjs

@@ -1 +1 @@
-import{EMPTY_STRING as n}from"@stryke/types";import{upperCaseFirst as o}from"./upper-case-first";export function kebabCase(t){const r=t?.replace(/[A-Z]+/g,e=>o(e)??n)?.split(/(?=[A-Z])|[\s._-]/).map(e=>e.toLowerCase())??[];return r.length===0?"":r.length===1?r[0]:r.reduce((e,s)=>`${e}-${s.toLowerCase()}`.toLowerCase())}
+import{getWords as t}from"./get-words";export function kebabCase(e){const r=e?t(e):[];return r.length===0?"":r.join("-").toLowerCase()}

package/dist/title-case.cjs

@@ -3,11 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.LOWER_CASE_WHEN_NOT_FIRST = exports.FORMAT_MAPPING = void 0;
 exports.titleCase = titleCase;
 var _acronyms = require("./acronyms.cjs");
 var _upperCaseFirst = require("./upper-case-first.cjs");
-function titleCase(e) {
-  if (!e) return e;
-  const s = t => t.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map(r => _acronyms.ACRONYMS.includes(r.toUpperCase()) ? r.toUpperCase() : `${(0, _upperCaseFirst.upperCaseFirst)(r.toLowerCase())}`).join(" ");
-  return e.split(/\s+-\s+/).map(t => s(t)).join(" - ");
+const FORMAT_MAPPING = exports.FORMAT_MAPPING = _acronyms.ACRONYMS.reduce((s, e) => (s[e.toLowerCase()] = e, s), {
+    cspell: "CSpell",
+    eslint: "ESLint",
+    nx: "Nx"
+  }),
+  LOWER_CASE_WHEN_NOT_FIRST = exports.LOWER_CASE_WHEN_NOT_FIRST = ["a", "an", "the", "is", "are", "of", "and", "to", "in", "for", "on", "with", "as", "at", "by"];
+function titleCase(s, e = {}) {
+  if (!s) return s;
+  const n = r => r.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map((t, i) => !e.skipLowerCaseWhenNotFirst && LOWER_CASE_WHEN_NOT_FIRST.includes(t.toLowerCase()) && i > 0 ? t.toLowerCase() : !e.skipFormatMapping && Object.keys(FORMAT_MAPPING).includes(t.toLowerCase()) ? FORMAT_MAPPING[t.toLowerCase()] : e.mapping && Object.keys(e.mapping).includes(t.toLowerCase()) ? e.mapping[t.toLowerCase()] : `${(0, _upperCaseFirst.upperCaseFirst)(t.toLowerCase())}`).join(" ");
+  return s.split(/\s+-\s+/).map(r => n(r)).join(" - ");
 }

package/dist/title-case.d.ts

@@ -1,3 +1,33 @@
+export declare const FORMAT_MAPPING: Record<string, string>;
+export declare const LOWER_CASE_WHEN_NOT_FIRST: string[];
+export interface TitleCaseOptions {
+    /**
+     * If true, skip the format mapping. This will skip the conversion of known acronyms to their upper case form.
+     *
+     * @remarks
+     * The current list of word format mappings is stored in {@link FORMAT_MAPPING}.
+     *
+     * @defaultValue false
+     */
+    skipFormatMapping?: boolean;
+    /**
+     * If true, lower case words that are not the first word in the title.
+     *
+     * @remarks
+     * The current list of words that are lower cased when not first are stored in {@link LOWER_CASE_WHEN_NOT_FIRST}.
+     *
+     *
+     * @defaultValue false
+     */
+    skipLowerCaseWhenNotFirst?: boolean;
+    /**
+     * A custom mapping of words to their formatted versions.
+     *
+     * @remarks
+     * This allows you to provide your own mappings for specific words that should be formatted in a certain way.
+     */
+    mapping?: Record<string, string>;
+}
 /**
  * Convert the input string to title case.
  *
@@ -7,4 +37,4 @@
  * @param input - The input string.
  * @returns The title cased string.
  */
-export declare function titleCase<T extends string | undefined>(input?: T): T;
+export declare function titleCase<T extends string | undefined>(input?: T, options?: TitleCaseOptions): T;

package/dist/title-case.mjs

@@ -1 +1 @@
-import{ACRONYMS as o}from"./acronyms";import{upperCaseFirst as n}from"./upper-case-first";export function titleCase(e){if(!e)return e;const s=t=>t.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map(r=>o.includes(r.toUpperCase())?r.toUpperCase():`${n(r.toLowerCase())}`).join(" ");return e.split(/\s+-\s+/).map(t=>s(t)).join(" - ")}
+import{ACRONYMS as a}from"./acronyms";import{upperCaseFirst as o}from"./upper-case-first";export const FORMAT_MAPPING=a.reduce((s,e)=>(s[e.toLowerCase()]=e,s),{cspell:"CSpell",eslint:"ESLint",nx:"Nx"}),LOWER_CASE_WHEN_NOT_FIRST=["a","an","the","is","are","of","and","to","in","for","on","with","as","at","by"];export function titleCase(s,e={}){if(!s)return s;const n=r=>r.toLowerCase().split(/[\s\-_]+/).filter(Boolean).map((t,i)=>!e.skipLowerCaseWhenNotFirst&&LOWER_CASE_WHEN_NOT_FIRST.includes(t.toLowerCase())&&i>0?t.toLowerCase():!e.skipFormatMapping&&Object.keys(FORMAT_MAPPING).includes(t.toLowerCase())?FORMAT_MAPPING[t.toLowerCase()]:e.mapping&&Object.keys(e.mapping).includes(t.toLowerCase())?e.mapping[t.toLowerCase()]:`${o(t.toLowerCase())}`).join(" ");return s.split(/\s+-\s+/).map(r=>n(r)).join(" - ")}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/string-format",
-  "version": "0.4.11",
+  "version": "0.5.1",
   "type": "module",
   "description": "A package containing utility functions to transform strings into various formats.",
   "repository": {
@@ -10,7 +10,7 @@
   },
   "private": false,
   "publishConfig": { "access": "public" },
-  "dependencies": { "@stryke/helpers": "^0.6.1", "@stryke/types": "^0.8.4" },
+  "dependencies": { "@stryke/helpers": "^0.6.2", "@stryke/types": "^0.8.5" },
   "devDependencies": {},
   "sideEffects": false,
   "files": ["dist/**/*"],
@@ -332,5 +332,6 @@
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts"
+  "types": "./dist/index.d.ts",
+  "gitHead": "4052d0819f6c27c02af4ccd7460b5cd28c36f5c4"
 }