@ethlete/contentful 3.9.0 → 4.0.0-beta.3

package/package.json

@@ -1,29 +1,34 @@
 {
   "name": "@ethlete/contentful",
-  "version": "3.9.0",
+  "version": "4.0.0-beta.3",
   "license": "MIT",
   "sideEffects": false,
   "peerDependencies": {
-    "@angular/cdk": "20.0.3",
-    "@angular/common": "20.0.3",
-    "@angular/core": "20.0.3",
-    "@contentful/rich-text-types": "17.0.0",
-    "@ethlete/cdk": "^4.0.3",
-    "@ethlete/core": "^4.0.3",
-    "@ethlete/query": "^5.0.3",
-    "rxjs": "7.8.2"
+    "@analogjs/vite-plugin-angular": "2.5.1",
+    "@angular/cdk": "21.2.11",
+    "@angular/common": "21.2.13",
+    "@angular/core": "21.2.13",
+    "@angular/router": "21.2.13",
+    "@contentful/rich-text-types": "17.2.7",
+    "@ethlete/cdk": "^5.0.0-beta.12",
+    "@ethlete/core": "^5.0.0-beta.11",
+    "@ethlete/query": "^6.0.0-beta.8",
+    "@nx/vite": "22.7.2",
+    "rxjs": "7.8.2",
+    "vite": "8.0.13"
   },
   "module": "fesm2022/ethlete-contentful.mjs",
-  "typings": "index.d.ts",
+  "typings": "types/ethlete-contentful.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
     },
     ".": {
-      "types": "./index.d.ts",
+      "types": "./types/ethlete-contentful.d.ts",
       "default": "./fesm2022/ethlete-contentful.mjs"
     }
   },
+  "type": "module",
   "dependencies": {
     "tslib": "^2.3.0"
   }

package/{index.d.ts → types/ethlete-contentful.d.ts}

@@ -1,14 +1,15 @@
 import * as _angular_core from '@angular/core';
-import { ComponentRef, ViewContainerRef, Renderer2, ElementRef, InputSignal, InjectionToken } from '@angular/core';
+import { ViewContainerRef, ElementRef, ComponentRef, InputSignal, InjectionToken } from '@angular/core';
 import { NgClassType } from '@ethlete/core';
 import * as _ethlete_query from '@ethlete/query';
 import { ComponentType } from '@angular/cdk/portal';
 import { Mark, BLOCKS, INLINES, NodeData, Block } from '@contentful/rich-text-types';
+import * as _ethlete_contentful from '@ethlete/contentful';
 import * as _ethlete_cdk from '@ethlete/cdk';
 import { PictureSource } from '@ethlete/cdk';
 
 declare const GQL_FRAGMENT_CONTENTFUL_ASSET: _ethlete_query.GQL;
-interface ContentfulGqlAsset {
+type ContentfulGqlAsset = {
     sys: {
         id: string;
     };
@@ -19,7 +20,7 @@ interface ContentfulGqlAsset {
     width: number | null;
     height: number | null;
     size: number | null;
-}
+};
 declare const isContentfulGqlAsset: (asset: any) => asset is ContentfulGqlAsset;
 type ContentfulGqlWhereFilter<TLinkedFrom extends Record<string, unknown> = Record<string, unknown>> = {
     /**
@@ -123,7 +124,7 @@ type HtmlOpenRenderCommand = [
     domPosition: number,
     index: number,
     attributes: Record<string, string>,
-    tagName: string,
+    tagName: keyof HTMLElementTagNameMap,
     textId: string
 ];
 type HtmlCloseRenderCommand = [
@@ -131,7 +132,7 @@ type HtmlCloseRenderCommand = [
     nestingLevel: number,
     domPosition: number,
     index: number,
-    tagName: string,
+    tagName: keyof HTMLElementTagNameMap,
     elementId: string
 ];
 type TextRenderCommand = [
@@ -224,22 +225,59 @@ type ContentfulIncludeMap = {
      */
     getAssets: (ids: string[]) => ContentfulRestAsset[];
 };
-interface CreateContentfulIncludeMapConfig {
+type CreateContentfulIncludeMapConfig = {
     /** The entries that should be present inside the map  */
     entries: ContentfulEntry[];
     /** The assets that should be present inside the map  */
     assets: ContentfulRestAsset[];
-}
+};
 /**
  * Create a contentful include map using the provided entries and assets.
  */
 declare const createContentfulIncludeMap: (config: CreateContentfulIncludeMapConfig) => ContentfulIncludeMap;
 declare class ContentfulRichTextRendererComponent {
     _viewContainerRef: ViewContainerRef;
-    _renderer: Renderer2;
+    _renderer: {
+        addClass: (element: HTMLElement, ...classes: string[]) => void;
+        removeClass: (element: HTMLElement, ...classes: string[]) => void;
+        toggleClass: (element: HTMLElement, className: string, force?: boolean) => boolean;
+        setStyle: (element: HTMLElement, style: Partial<Record<keyof CSSStyleDeclaration, string | null>>, flags?: _angular_core.RendererStyleFlags2) => void;
+        removeStyle: (element: HTMLElement, style: keyof CSSStyleDeclaration | string, flags?: _angular_core.RendererStyleFlags2) => void;
+        removeStyles: (element: HTMLElement, ...styles: (keyof CSSStyleDeclaration | string)[]) => void;
+        setAttribute: (element: HTMLElement, name: string, value: string | null, namespace?: string | null) => void;
+        removeAttribute: (element: HTMLElement, ...names: string[]) => void;
+        setProperty: (element: HTMLElement, name: string, value: unknown) => void;
+        setProperties: (element: HTMLElement, properties: Record<string, unknown>) => void;
+        createElement: <K extends keyof HTMLElementTagNameMap>(tagName: K, namespace?: string | null) => HTMLElementTagNameMap[K];
+        createText: (value: string) => globalThis.Text;
+        createComment: (value: string) => Comment;
+        appendChild: (parent: HTMLElement, newChild: Node) => void;
+        insertBefore: (parent: Node, newChild: Node, refChild: Node | null) => void;
+        removeChild: (parent: Node, oldChild: Node, isHostElement?: boolean) => void;
+        selectRootElement: (selectorOrNode: string | HTMLElement, preserveContent?: boolean) => HTMLElement;
+        parentNode: (node: Node) => Node | null;
+        nextSibling: (node: Node) => Node | null;
+        setValue: (node: Node, value: string) => void;
+        listen: (target: HTMLElement | Window | Document | "window" | "document" | "body", eventName: string, callback: (event: Event) => boolean | void) => (() => void);
+        destroyNode: (node: Node) => void;
+        replaceChild: (parent: Node, newChild: Node, oldChild: Node) => void;
+        empty: (element: HTMLElement) => void;
+        setTextContent: (element: HTMLElement, text: string) => void;
+        setInnerHTML: (element: HTMLElement, html: string) => void;
+        setAttributes: (element: HTMLElement, attributes: Record<string, string | null>, namespace?: string | null) => void;
+        setDataAttributes: (element: HTMLElement, data: Record<string, string | null>) => void;
+        setCssProperty: (element: HTMLElement, name: string, value: string | null) => void;
+        setCssProperties: (element: HTMLElement, properties: Record<string, string | null>) => void;
+        moveBefore: (config: {
+            newParent: HTMLElement;
+            child: HTMLElement;
+            before?: Node | null;
+        }) => void;
+        renderer: _angular_core.Renderer2;
+    };
     _elementRef: ElementRef<HTMLElement>;
     _document: Document;
-    _config: ContentfulConfig;
+    _config: _ethlete_contentful.ContentfulConfig;
     /**
      * A cache for all executed commands that are not deleted.
      * This is used to keep track of all rendered elements and components.
@@ -286,26 +324,32 @@ declare class ContentfulRichTextRendererComponent {
 }
 
 declare const isRichTextRootNode: (node: unknown) => node is RichTextResponse;
-declare const translateContentfulNodeTypeToHtmlTag: (nodeType: "text" | BLOCKS | INLINES) => "document" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "ul" | "ol" | "li" | "hr" | "blockquote" | "table" | "tr" | "td" | "th" | "div" | "a" | "span";
+declare const translateContentfulNodeTypeToHtmlTag: (nodeType: "text" | BLOCKS | INLINES) => "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "ul" | "ol" | "li" | "hr" | "blockquote" | "table" | "tr" | "td" | "th" | "div" | "a" | "span";
 
 type ContentfulImageResizeBehavior = 'pad' | 'crop' | 'fill' | 'scale' | 'thumb' | 'fit';
 type ContentfulImageFocusArea = 'top' | 'bottom' | 'left' | 'right' | 'center' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'face' | 'faces';
 type ComponentLikeWithAsset = ComponentType<{
     asset: InputSignal<ContentfulRestAsset | ContentfulGqlAsset | null | undefined>;
 }>;
+type ComponentLikeWithLink = ComponentType<{
+    href: InputSignal<string>;
+    text: InputSignal<string>;
+    textClass: InputSignal<string>;
+}>;
 type ComponentLikeWithContentfulRendererInputs = ComponentType<{
     fields?: InputSignal<any>;
     includes?: InputSignal<ContentfulIncludeMap>;
     metadata?: InputSignal<ContentfulMetadata>;
     sys?: InputSignal<ContentfulEntrySys>;
 }>;
-interface ContentfulAssetComponents {
+type ContentfulAssetComponents = {
     file: ComponentLikeWithAsset;
     image: ComponentLikeWithAsset;
     video: ComponentLikeWithAsset;
     audio: ComponentLikeWithAsset;
-}
-interface ContentfulConfig {
+    link: ComponentLikeWithLink;
+};
+type ContentfulConfig = {
     /**
      * Default components for rendering contentful assets
      */
@@ -318,6 +362,15 @@ interface ContentfulConfig {
      * Determines if the contentful rich text renderer should render the contentful rich text with tailwind css classes
      */
     useTailwindClasses: boolean;
+    /**
+     * Additional hostnames that should be treated as internal links (in addition to the current page's host).
+     * Useful when the app runs on localhost during development but Contentful content references the production domain.
+     * Comparison is done by primary domain (last two hostname labels), so adding "example.com" is sufficient
+     * to also treat "foo.example.com" as internal.
+     *
+     * @example ['example.com']
+     */
+    internalHosts: string[];
     /**
      * Default options for the contentful image api
      */
@@ -343,31 +396,31 @@ interface ContentfulConfig {
          */
         backgroundColor: string | null;
     };
-}
+};
 type ContentfulLinkType = 'Space' | 'ContentType' | 'Environment' | 'Entry' | 'Asset' | 'Tag';
-interface ContentfulLink<T extends ContentfulLinkType> {
+type ContentfulLink<T extends ContentfulLinkType> = {
     type: 'Link';
     linkType: T;
     id: string;
-}
+};
 type ContentfulSpaceLink = ContentfulLink<'Space'>;
 type ContentfulEnvironmentLink = ContentfulLink<'Environment'>;
 type ContentfulContentTypeLink = ContentfulLink<'ContentType'>;
 type ContentfulEntryLink = ContentfulLink<'Entry'>;
 type ContentfulAssetLink = ContentfulLink<'Asset'>;
 type ContentfulTagLink = ContentfulLink<'Tag'>;
-interface ContentfulTagLinkItem {
+type ContentfulTagLinkItem = {
     sys: ContentfulTagLink;
-}
-interface ContentfulEntryLinkItem {
+};
+type ContentfulEntryLinkItem = {
     sys: ContentfulEntryLink;
-}
-interface ContentfulAssetLinkItem {
+};
+type ContentfulAssetLinkItem = {
     sys: ContentfulAssetLink;
-}
-interface ContentfulMetadata {
+};
+type ContentfulMetadata = {
     tags: ContentfulTagLinkItem[];
-}
+};
 type ContentfulSys = {
     type: string;
     id: string;
@@ -387,11 +440,11 @@ type ContentfulEntrySys = ContentfulSys & {
         sys: ContentfulContentTypeLink;
     };
 };
-interface ContentfulAssetImageData {
+type ContentfulAssetImageData = {
     width: number;
     height: number;
-}
-interface ContentfulAssetFileData {
+};
+type ContentfulAssetFileData = {
     url: string | null;
     details: {
         size: number | null;
@@ -399,8 +452,8 @@ interface ContentfulAssetFileData {
     };
     fileName: string | null;
     contentType: string | null;
-}
-interface ContentfulRestAsset {
+};
+type ContentfulRestAsset = {
     sys: ContentfulSys;
     fields: {
         title: string;
@@ -408,15 +461,15 @@ interface ContentfulRestAsset {
         file: ContentfulAssetFileData;
     };
     metadata: ContentfulMetadata;
-}
-interface ContentfulEntry<T = {
+};
+type ContentfulEntry<T = {
     [key: string]: any;
-}> {
+}> = {
     sys: ContentfulEntrySys;
     fields: T;
     metadata: ContentfulMetadata;
-}
-interface ContentfulCollection {
+};
+type ContentfulCollection = {
     includes: {
         Asset: ContentfulRestAsset[];
         Entry: ContentfulEntry[];
@@ -428,12 +481,12 @@ interface ContentfulCollection {
     sys: {
         type: 'Array';
     };
-}
-interface RichTextResponse {
+};
+type RichTextResponse = {
     nodeType: 'document';
     data: NodeData;
     content: Block[];
-}
+};
 
 declare class ContentfulAudioComponent {
     asset: _angular_core.InputSignal<ContentfulGqlAsset | ContentfulRestAsset | null | undefined>;
@@ -462,7 +515,7 @@ declare class ContentfulFileComponent {
 }
 
 declare class ContentfulImageComponent {
-    _contentfulConfig: ContentfulConfig;
+    _contentfulConfig: _ethlete_contentful.ContentfulConfig;
     asset: _angular_core.InputSignal<ContentfulGqlAsset | ContentfulRestAsset | null | undefined>;
     backgroundColor: _angular_core.InputSignal<string | null>;
     srcsetSizes: _angular_core.InputSignal<string[]>;
@@ -502,6 +555,20 @@ declare const parseContentfulImageSize: (size: string) => {
 };
 declare const generateContentfulImageSources: (data: ContentfulRestAsset | ContentfulGqlAsset, srcsetSizes: string[], backgroundColor: string | null, quality: number | null, focusArea: ContentfulImageFocusArea | null, resizeBehavior: ContentfulImageResizeBehavior | null) => PictureSource[];
 
+declare class ContentfulLinkComponent {
+    private readonly _document;
+    private readonly _config;
+    href: _angular_core.InputSignal<string>;
+    text: _angular_core.InputSignal<string>;
+    textClass: _angular_core.InputSignal<string>;
+    isExternal: _angular_core.Signal<boolean>;
+    openInNewTab: _angular_core.Signal<boolean>;
+    internalPath: _angular_core.Signal<string>;
+    linkClass: _angular_core.Signal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContentfulLinkComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulLinkComponent, "et-contentful-link", never, { "href": { "alias": "href"; "required": true; "isSignal": true; }; "text": { "alias": "text"; "required": true; "isSignal": true; }; "textClass": { "alias": "textClass"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
 declare class ContentfulVideoComponent {
     asset: _angular_core.InputSignal<ContentfulGqlAsset | ContentfulRestAsset | null | undefined>;
     videoClass: _angular_core.InputSignal<NgClassType>;
@@ -525,5 +592,5 @@ declare const provideContentfulConfig: (contentfulConfig?: Partial<ContentfulCon
 };
 declare const isContentfulEntryType: <T extends ContentfulEntry>(entry: ContentfulEntry, type: string) => entry is T;
 
-export { COMPONENT_RENDER_COMMAND_POSITION, CONTENTFUL_CONFIG, ContentfulAudioComponent, ContentfulFileComponent, ContentfulImageComponent, ContentfulImports, ContentfulRichTextRendererComponent, ContentfulVideoComponent, ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID, GQL_FRAGMENT_CONTENTFUL_ASSET, HTML_CLOSE_RENDER_COMMAND_POSITION, HTML_OPEN_RENDER_COMMAND_POSITION, RENDER_COMMAND_POSITION, RENDER_COMMAND_TYPE, RENDER_INSTRUCTION_POSITION, RENDER_INSTRUCTION_TYPE, TEXT_RENDER_COMMAND_POSITION, createContentfulConfig, createContentfulIncludeMap, generateContentfulImageSources, generateDefaultContentfulImageSource, getRenderCommandId, isComponentRenderCommand, isContentfulEntryType, isContentfulGqlAsset, isExecutedComponentCommandCacheItem, isExecutedHtmlOrTextCommandCacheItem, isExecutedTextCommandCacheItem, isHtmlCloseRenderCommand, isHtmlOpenRenderCommand, isRichTextRootNode, isTextRenderCommand, marksToClass, parseContentfulImageSize, provideContentfulConfig, translateContentfulNodeTypeToHtmlTag };
-export type { ComponentLikeWithAsset, ComponentLikeWithContentfulRendererInputs, ContentfulAssetComponents, ContentfulAssetFileData, ContentfulAssetImageData, ContentfulAssetLink, ContentfulAssetLinkItem, ContentfulCollection, ContentfulConfig, ContentfulContentTypeLink, ContentfulEntry, ContentfulEntryLink, ContentfulEntryLinkItem, ContentfulEntrySys, ContentfulEnvironmentLink, ContentfulGqlAsset, ContentfulGqlCollectionFilterVariables, ContentfulGqlOrder, ContentfulGqlWhereFilter, ContentfulImageFocusArea, ContentfulImageResizeBehavior, ContentfulIncludeMap, ContentfulLink, ContentfulLinkType, ContentfulMetadata, ContentfulRestAsset, ContentfulSpaceLink, ContentfulSys, ContentfulTagLink, ContentfulTagLinkItem, CreateContentfulIncludeMapConfig, RichTextResponse };
+export { COMPONENT_RENDER_COMMAND_POSITION, CONTENTFUL_CONFIG, ContentfulAudioComponent, ContentfulFileComponent, ContentfulImageComponent, ContentfulImports, ContentfulLinkComponent, ContentfulRichTextRendererComponent, ContentfulVideoComponent, ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID, GQL_FRAGMENT_CONTENTFUL_ASSET, HTML_CLOSE_RENDER_COMMAND_POSITION, HTML_OPEN_RENDER_COMMAND_POSITION, RENDER_COMMAND_POSITION, RENDER_COMMAND_TYPE, RENDER_INSTRUCTION_POSITION, RENDER_INSTRUCTION_TYPE, TEXT_RENDER_COMMAND_POSITION, createContentfulConfig, createContentfulIncludeMap, generateContentfulImageSources, generateDefaultContentfulImageSource, getRenderCommandId, isComponentRenderCommand, isContentfulEntryType, isContentfulGqlAsset, isExecutedComponentCommandCacheItem, isExecutedHtmlOrTextCommandCacheItem, isExecutedTextCommandCacheItem, isHtmlCloseRenderCommand, isHtmlOpenRenderCommand, isRichTextRootNode, isTextRenderCommand, marksToClass, parseContentfulImageSize, provideContentfulConfig, translateContentfulNodeTypeToHtmlTag };
+export type { ComponentLikeWithAsset, ComponentLikeWithContentfulRendererInputs, ComponentLikeWithLink, ContentfulAssetComponents, ContentfulAssetFileData, ContentfulAssetImageData, ContentfulAssetLink, ContentfulAssetLinkItem, ContentfulCollection, ContentfulConfig, ContentfulContentTypeLink, ContentfulEntry, ContentfulEntryLink, ContentfulEntryLinkItem, ContentfulEntrySys, ContentfulEnvironmentLink, ContentfulGqlAsset, ContentfulGqlCollectionFilterVariables, ContentfulGqlOrder, ContentfulGqlWhereFilter, ContentfulImageFocusArea, ContentfulImageResizeBehavior, ContentfulIncludeMap, ContentfulLink, ContentfulLinkType, ContentfulMetadata, ContentfulRestAsset, ContentfulSpaceLink, ContentfulSys, ContentfulTagLink, ContentfulTagLinkItem, CreateContentfulIncludeMapConfig, RichTextResponse };