@smartive/datocms-utils 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-# [1.5.0](https://github.com/smartive/datocms-utils/compare/v1.4.1...v1.5.0) (2025-01-07)
+# [1.6.0](https://github.com/smartive/datocms-utils/compare/v1.5.0...v1.6.0) (2025-02-07)
 
 
 ### Features
 
-* add truncate method ([#49](https://github.com/smartive/datocms-utils/issues/49)) ([94f4214](https://github.com/smartive/datocms-utils/commit/94f4214cd926621063b4b5de4a010c6f7839b907))
+* add getTelLink utility ([#61](https://github.com/smartive/datocms-utils/issues/61)) ([31044d9](https://github.com/smartive/datocms-utils/commit/31044d91f9d47736a2ca254501eb5d11dc6998a8))

package/README.md

@@ -37,6 +37,7 @@ CREATE TABLE IF NOT EXISTS query_cache_tags (
 ### Other Utilities
 
 - `classNames`: Cleans and joins an array of inputs with possible undefined or boolean values. Useful for tailwind classnames.
+- `getTelLink`: Formats a phone number to a tel link.
 
 ### Types
 

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './cache-tags';
 export * from './classnames';
+export * from './links';
 export * from './types';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './cache-tags';
 export * from './classnames';
+export * from './links';
 export * from './types';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/dist/links.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts a phone number into a `tel:` link.
+ *
+ * @param phoneNumber Phone number
+ * @returns `tel:` link for the phone number
+ */
+export declare const getTelLink: (phoneNumber: string) => string;

package/dist/links.js

@@ -0,0 +1,15 @@
+/**
+ * Converts a phone number into a `tel:` link.
+ *
+ * @param phoneNumber Phone number
+ * @returns `tel:` link for the phone number
+ */
+export const getTelLink = (phoneNumber) => {
+    if (typeof phoneNumber !== 'string') {
+        throw new Error('Phone number must be a string.');
+    }
+    // Remove non-digit characters except for '+' which is used for international numbers
+    const cleanedPhoneNumber = phoneNumber.replace(/[^\d+]/g, '');
+    return `tel:${cleanedPhoneNumber}`;
+};
+//# sourceMappingURL=links.js.map

package/dist/links.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"links.js","sourceRoot":"","sources":["../src/links.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,WAAmB,EAAU,EAAE;IACxD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,qFAAqF;IACrF,MAAM,kBAAkB,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAE9D,OAAO,OAAO,kBAAkB,EAAE,CAAC;AACrC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartive/datocms-utils",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "A set of utilities and helpers to work with DatoCMS in a Next.js project.",
   "source": "src/index.ts",
   "main": "dist/index.js",

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './cache-tags';
 export * from './classnames';
+export * from './links';
 export * from './types';

package/src/links.ts

@@ -0,0 +1,17 @@
+/**
+ * Converts a phone number into a `tel:` link.
+ *
+ * @param phoneNumber Phone number
+ * @returns `tel:` link for the phone number
+ */
+
+export const getTelLink = (phoneNumber: string): string => {
+  if (typeof phoneNumber !== 'string') {
+    throw new Error('Phone number must be a string.');
+  }
+
+  // Remove non-digit characters except for '+' which is used for international numbers
+  const cleanedPhoneNumber = phoneNumber.replace(/[^\d+]/g, '');
+
+  return `tel:${cleanedPhoneNumber}`;
+};