@asteroidcms/core-utils 0.1.0 → 0.1.1

package/dist/index.d.cts

@@ -217,6 +217,38 @@ declare function cmsImage(id: string | undefined, options: {
 /** Hook variant that pulls `cmsUrl`/`mediaPath` from the provider. */
 declare function useCmsImage(): (id?: string) => string;
 
+type ReadTimeUnit = "short" | "long";
+interface GetContentReadTimeOptions {
+    /**
+     * Average words read per minute
+     * @default 200
+     */
+    wordsPerMinute?: number;
+    /**
+     * Output style
+     * short => "3 min read"
+     * long => "3 minutes read"
+     *
+     * @default "short"
+     */
+    format?: ReadTimeUnit;
+    /**
+     * Round mode for minutes
+     * ceil => always round up
+     * round => normal rounding
+     * floor => round down
+     *
+     * @default "ceil"
+     */
+    round?: "ceil" | "round" | "floor";
+    /**
+     * Minimum minutes returned
+     * @default 1
+     */
+    minMinutes?: number;
+}
+declare function getContentReadTime(content: string, options?: GetContentReadTimeOptions): string;
+
 /**
  * Portable rich-text parser for CMS content.
  *
@@ -263,4 +295,4 @@ declare function RichTextContent({ html, classMap, as, className, }: RichTextCon
     };
 }, HTMLElement>;
 
-export { type AsteroidCMSConfig, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ParseRichTextOptions, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, cmsImage, createApolloClient, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
+export { type AsteroidCMSConfig, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ParseRichTextOptions, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, cmsImage, createApolloClient, getContentReadTime, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };

package/dist/index.d.ts

@@ -217,6 +217,38 @@ declare function cmsImage(id: string | undefined, options: {
 /** Hook variant that pulls `cmsUrl`/`mediaPath` from the provider. */
 declare function useCmsImage(): (id?: string) => string;
 
+type ReadTimeUnit = "short" | "long";
+interface GetContentReadTimeOptions {
+    /**
+     * Average words read per minute
+     * @default 200
+     */
+    wordsPerMinute?: number;
+    /**
+     * Output style
+     * short => "3 min read"
+     * long => "3 minutes read"
+     *
+     * @default "short"
+     */
+    format?: ReadTimeUnit;
+    /**
+     * Round mode for minutes
+     * ceil => always round up
+     * round => normal rounding
+     * floor => round down
+     *
+     * @default "ceil"
+     */
+    round?: "ceil" | "round" | "floor";
+    /**
+     * Minimum minutes returned
+     * @default 1
+     */
+    minMinutes?: number;
+}
+declare function getContentReadTime(content: string, options?: GetContentReadTimeOptions): string;
+
 /**
  * Portable rich-text parser for CMS content.
  *
@@ -263,4 +295,4 @@ declare function RichTextContent({ html, classMap, as, className, }: RichTextCon
     };
 }, HTMLElement>;
 
-export { type AsteroidCMSConfig, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ParseRichTextOptions, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, cmsImage, createApolloClient, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
+export { type AsteroidCMSConfig, AsteroidCMSProvider, type AsteroidCMSProviderProps, type ParseRichTextOptions, type ResolvedAsteroidCMSConfig, type RichTextClassKey, type RichTextClassMap, RichTextContent, type UseCmsContentOptions, type UseCmsMutateOptions, cmsImage, createApolloClient, getContentReadTime, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };

package/dist/index.js

@@ -318,6 +318,35 @@ function useCmsImage() {
   return (id) => cmsImage(id, { cmsUrl, mediaPath });
 }
 
+// src/utils/getContentReadTime.ts
+function getContentReadTime(content, options = {}) {
+  const {
+    wordsPerMinute = 200,
+    format = "short",
+    round = "ceil",
+    minMinutes = 1
+  } = options;
+  if (!content || typeof content !== "string") {
+    return format === "short" ? `${minMinutes} min read` : `${minMinutes} minute read`;
+  }
+  let text = content.replace(/<script[\s\S]*?<\/script>/gi, " ").replace(/<style[\s\S]*?<\/style>/gi, " ");
+  text = text.replace(/<\/(p|div|h[1-6]|li|blockquote|pre|code|br|tr)>/gi, " ").replace(/<[^>]+>/g, " ");
+  text = text.replace(/&nbsp;/gi, " ").replace(/&amp;/gi, "&").replace(/&lt;/gi, "<").replace(/&gt;/gi, ">").replace(/&#39;/gi, "'").replace(/&quot;/gi, '"');
+  text = text.replace(/\s+/g, " ").trim();
+  const words = text.split(" ").filter(Boolean).length;
+  const rawMinutes = words / wordsPerMinute;
+  const roundMap = {
+    ceil: Math.ceil,
+    round: Math.round,
+    floor: Math.floor
+  };
+  const minutes = Math.max(minMinutes, roundMap[round](rawMinutes));
+  if (format === "long") {
+    return `${minutes} ${minutes === 1 ? "minute" : "minutes"} read`;
+  }
+  return `${minutes} min read`;
+}
+
 // src/components/richTextParser.ts
 var DEFAULT_ALLOWLIST = [
   "p",
@@ -1450,6 +1479,6 @@ function RichTextContent({
   });
 }
 
-export { AsteroidCMSProvider, RichTextContent, cmsImage, createApolloClient, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
+export { AsteroidCMSProvider, RichTextContent, cmsImage, createApolloClient, getContentReadTime, parseRichText, removeEmptyParagraphs, useAsteroidCMSConfig, useCmsContent, useCmsImage, useCmsMutate };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map