@ethlete/contentful 4.0.0-next.11 → 4.0.0-next.13

package/types/ethlete-contentful.d.ts

@@ -1,9 +1,8 @@
 import * as _angular_core from '@angular/core';
 import { Type, InputSignal, InjectionToken, Provider } from '@angular/core';
-import * as _ethlete_core from '@ethlete/core';
-import { NgClassType } from '@ethlete/core';
 import { GQL } from '@ethlete/query';
 import { Mark, BLOCKS, INLINES, NodeData, Block } from '@contentful/rich-text-types';
+import * as _ethlete_core from '@ethlete/core';
 import * as _ethlete_contentful from '@ethlete/contentful';
 import * as _ethlete_components from '@ethlete/components';
 import { PictureSource } from '@ethlete/components';
@@ -88,6 +87,43 @@ type ContentfulGqlCollectionFilterVariables<TCustomWhere extends Record<string,
     locale?: string;
 };
 
+type ContentfulGqlRichTextEntry = {
+    __typename?: string | null;
+    sys: {
+        id: string;
+    };
+    [field: string]: unknown;
+};
+type ContentfulGqlLinkList<T> = (T | null | undefined)[] | null;
+/**
+ * A rich-text field as returned by the Contentful GraphQL API. Select `json` and the `links` the
+ * document references, and pass the field to `[gqlRichText]` as-is.
+ */
+type ContentfulGqlRichText = {
+    json: RichTextResponse;
+    links?: {
+        assets?: {
+            block?: ContentfulGqlLinkList<ContentfulGqlAsset>;
+            hyperlink?: ContentfulGqlLinkList<ContentfulGqlAsset>;
+        } | null;
+        entries?: {
+            block?: ContentfulGqlLinkList<ContentfulGqlRichTextEntry>;
+            inline?: ContentfulGqlLinkList<ContentfulGqlRichTextEntry>;
+            hyperlink?: ContentfulGqlLinkList<ContentfulGqlRichTextEntry>;
+        } | null;
+    } | null;
+};
+/**
+ * Maps the `links` of a GraphQL rich-text field to the entries and assets the renderer resolves
+ * embeds against. An entry's content type id is its `__typename` with the first letter lower-cased,
+ * which is how Contentful derives a GraphQL type name from a content type id. Entries without a
+ * `__typename` are dropped.
+ */
+declare const mapContentfulGqlLinks: (links: ContentfulGqlRichText["links"]) => {
+    assets: ContentfulRestAsset[];
+    entries: ContentfulEntry[];
+};
+
 type MarkTagName = 'strong' | 'em' | 'u' | 'code' | 's' | 'sub' | 'sup';
 /**
  * Translates contentful text marks into the semantic html elements the marked text is
@@ -149,6 +185,8 @@ declare class ContentfulRichTextRendererComponent {
     private elementRef;
     private config;
     private document;
+    private location;
+    private url;
     /**
      * The contentful response gotten via their REST api.
      * @see https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries/entries-collection
@@ -158,9 +196,17 @@ declare class ContentfulRichTextRendererComponent {
      * The path to where the rich text field is inside the contentful response. Dot and array notation is allowed.
      * @example "items[0].fields.html"
      */
-    richTextPath: _angular_core.InputSignal<string>;
+    richTextPath: _angular_core.InputSignal<string | undefined>;
+    /**
+     * A rich-text field from the Contentful GraphQL API, passed as-is. An alternative to `content` and
+     * `richTextPath`; setting both is an error in dev mode.
+     * @example { json, links: { assets: { block, hyperlink }, entries: { block, inline, hyperlink } } }
+     */
+    gqlRichText: _angular_core.InputSignal<ContentfulGqlRichText | null | undefined>;
     private readonly executedCommandsCache;
+    private includes;
     private contentIncludesMap;
+    private includedEntries;
     private richTextData;
     private renderCommands;
     private renderInstructions;
@@ -175,7 +221,7 @@ declare class ContentfulRichTextRendererComponent {
     private findParent;
     private renderInsertAfter;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContentfulRichTextRendererComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulRichTextRendererComponent, "et-contentful-rich-text-renderer", never, { "content": { "alias": "content"; "required": true; "isSignal": true; }; "richTextPath": { "alias": "richTextPath"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulRichTextRendererComponent, "et-contentful-rich-text-renderer", never, { "content": { "alias": "content"; "required": false; "isSignal": true; }; "richTextPath": { "alias": "richTextPath"; "required": false; "isSignal": true; }; "gqlRichText": { "alias": "gqlRichText"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare const isRichTextRootNode: (node: unknown) => node is RichTextResponse;
@@ -194,8 +240,8 @@ type ComponentLikeWithAsset = Type<{
 type ComponentLikeWithLink = Type<{
     href: InputSignal<string>;
     text: InputSignal<string>;
-    textClass: InputSignal<string>;
-    anchorClass?: InputSignal<string>;
+    marks?: InputSignal<readonly string[]>;
+    richText?: InputSignal<boolean>;
 }>;
 type ComponentLikeWithContentfulRendererInputs = Type<{
     fields?: InputSignal<any>;
@@ -212,7 +258,8 @@ type ContentfulAssetComponents = {
 };
 type ContentfulConfig = {
     /**
-     * Default components for rendering contentful assets
+     * Components for rendering contentful assets and hyperlinks. Empty unless
+     * `CONTENTFUL_DEFAULT_COMPONENTS` is spread into the config or a component is named here.
      */
     components: ContentfulAssetComponents;
     /**
@@ -249,11 +296,15 @@ type ContentfulConfig = {
          */
         sizes: string[];
         /**
-         * Background color for the image in hex. Eg. `"000000"`
+         * Background color for the image in hex. Eg. `"000000"` (a leading `#` is stripped)
          */
         backgroundColor: string | null;
     };
 };
+type ContentfulConfigOptions = Partial<Omit<ContentfulConfig, 'imageOptions'>> & {
+    /** Merged one level deep into the defaults, so a single option can be overridden. */
+    imageOptions?: Partial<ContentfulConfig['imageOptions']>;
+};
 type ContentfulLinkType = 'Space' | 'ContentType' | 'Environment' | 'Entry' | 'Asset' | 'Tag';
 type ContentfulLink<T extends ContentfulLinkType> = {
     type: 'Link';
@@ -347,15 +398,12 @@ type RichTextResponse = {
 
 declare class ContentfulAudioComponent {
     asset: _angular_core.InputSignal<ContentfulGqlAsset | ContentfulRestAsset | null | undefined>;
-    audioClass: _angular_core.InputSignal<NgClassType>;
-    figureClass: _angular_core.InputSignal<NgClassType>;
-    figcaptionClass: _angular_core.InputSignal<NgClassType>;
     protected data: _angular_core.Signal<{
         url: string;
         title: string | null;
     } | null>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContentfulAudioComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulAudioComponent, "et-contentful-audio", never, { "asset": { "alias": "asset"; "required": true; "isSignal": true; }; "audioClass": { "alias": "audioClass"; "required": false; "isSignal": true; }; "figureClass": { "alias": "figureClass"; "required": false; "isSignal": true; }; "figcaptionClass": { "alias": "figcaptionClass"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulAudioComponent, "et-contentful-audio", never, { "asset": { "alias": "asset"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 /** Every string `et-contentful-file` renders itself. Override them app-wide with {@link provideContentfulFileLabels}. */
@@ -379,14 +427,13 @@ declare const CONTENTFUL_FILE_LABELS: _angular_core.InjectionToken<_ethlete_core
 declare class ContentfulFileComponent {
     protected labels: _angular_core.Signal<_ethlete_contentful.ContentfulFileLabels>;
     asset: _angular_core.InputSignal<ContentfulGqlAsset | ContentfulRestAsset | null | undefined>;
-    fileClass: _angular_core.InputSignal<NgClassType>;
     protected data: _angular_core.Signal<{
         url: string;
         size: number | null;
         title: string | null;
     } | null>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContentfulFileComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulFileComponent, "et-contentful-file", never, { "asset": { "alias": "asset"; "required": true; "isSignal": true; }; "fileClass": { "alias": "fileClass"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulFileComponent, "et-contentful-file", never, { "asset": { "alias": "asset"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare class ContentfulImageComponent {
@@ -441,46 +488,65 @@ declare const generateContentfulImageSources: (data: ContentfulRestAsset | Conte
 
 declare class ContentfulLinkComponent {
     private document;
+    private location;
     private router;
     private config;
     private url;
     href: _angular_core.InputSignal<string>;
     text: _angular_core.InputSignal<string>;
-    textClass: _angular_core.InputSignal<string>;
-    anchorClass: _angular_core.InputSignal<string>;
+    marks: _angular_core.InputSignal<readonly string[]>;
+    richText: _angular_core.InputSignal<boolean>;
     protected usesRouterLink: _angular_core.Signal<boolean>;
+    protected anchorHref: _angular_core.Signal<string>;
     protected openInNewTab: _angular_core.Signal<boolean>;
     protected internalPath: _angular_core.Signal<string>;
     protected internalUrlTree: _angular_core.Signal<_angular_router.UrlTree>;
-    protected linkClass: _angular_core.Signal<string | null>;
+    protected modifierClasses: _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; }; "anchorClass": { "alias": "anchorClass"; "required": false; "isSignal": true; }; }, {}, never, never, true, 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; }; "marks": { "alias": "marks"; "required": false; "isSignal": true; }; "richText": { "alias": "richText"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare class ContentfulVideoComponent {
     asset: _angular_core.InputSignal<ContentfulGqlAsset | ContentfulRestAsset | null | undefined>;
-    videoClass: _angular_core.InputSignal<NgClassType>;
     protected data: _angular_core.Signal<{
         url: string;
         contentType: string | null;
     } | null>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContentfulVideoComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulVideoComponent, "et-contentful-video", never, { "asset": { "alias": "asset"; "required": true; "isSignal": true; }; "videoClass": { "alias": "videoClass"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContentfulVideoComponent, "et-contentful-video", never, { "asset": { "alias": "asset"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare const CONTENTFUL_CONFIG: InjectionToken<ContentfulConfig>;
 
 declare const ContentfulImports: readonly [typeof ContentfulAudioComponent, typeof ContentfulFileComponent, typeof ContentfulImageComponent, typeof ContentfulVideoComponent, typeof ContentfulRichTextRendererComponent];
 
-declare const createContentfulConfig: (config?: Partial<ContentfulConfig> | null) => ContentfulConfig;
+declare const createContentfulConfig: (options?: ContentfulConfigOptions | null) => ContentfulConfig;
 /**
  * Reads the contentful config from the current injector. Falls back to a config without
  * any `components` when none was provided via `provideContentfulConfig()`.
  */
 declare const injectContentfulConfig: () => ContentfulConfig;
 
-declare const provideContentfulConfig: (contentfulConfig?: Partial<ContentfulConfig> | null) => Provider;
+/**
+ * The shipped audio, file, image, video and link components, to spread into `provideContentfulConfig`.
+ * An app that brings its own components, or renders text only, leaves this out and bundles none of them.
+ * To replace one, spread the map instead: `components: { ...CONTENTFUL_DEFAULT_COMPONENTS.components, image: MyImage }`.
+ *
+ * @example
+ * provideContentfulConfig({ ...CONTENTFUL_DEFAULT_COMPONENTS });
+ */
+declare const CONTENTFUL_DEFAULT_COMPONENTS: {
+    components: {
+        audio: typeof ContentfulAudioComponent;
+        file: typeof ContentfulFileComponent;
+        image: typeof ContentfulImageComponent;
+        video: typeof ContentfulVideoComponent;
+        link: typeof ContentfulLinkComponent;
+    };
+};
+
+declare const provideContentfulConfig: (contentfulConfig?: ContentfulConfigOptions | null) => Provider;
 declare const isContentfulEntryType: <T extends ContentfulEntry>(entry: ContentfulEntry, type: string) => entry is T;
 
-export { CONTENTFUL_CONFIG, CONTENTFUL_FILE_LABELS, ContentfulAudioComponent, ContentfulFileComponent, ContentfulImageComponent, ContentfulImports, ContentfulLinkComponent, ContentfulRichTextRendererComponent, ContentfulVideoComponent, DEFAULT_CONTENTFUL_FILE_LABELS, ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID, GQL_FRAGMENT_CONTENTFUL_ASSET, createContentfulConfig, createContentfulIncludeMap, generateContentfulImageSources, generateDefaultContentfulImageSource, injectContentfulConfig, injectContentfulFileLabels, isContentfulEntryType, isContentfulGqlAsset, isRichTextRootNode, marksToClass, marksToTags, parseContentfulImageSize, provideContentfulConfig, provideContentfulFileLabels, translateContentfulNodeTypeToHtmlTag };
-export type { ComponentLikeWithAsset, ComponentLikeWithContentfulRendererInputs, ComponentLikeWithLink, ContentfulAssetComponents, ContentfulAssetFileData, ContentfulAssetImageData, ContentfulAssetLink, ContentfulAssetLinkItem, ContentfulCollection, ContentfulConfig, ContentfulContentTypeLink, ContentfulEntry, ContentfulEntryLink, ContentfulEntryLinkItem, ContentfulEntrySys, ContentfulEnvironmentLink, ContentfulFileLabels, ContentfulGqlAsset, ContentfulGqlCollectionFilterVariables, ContentfulGqlOrder, ContentfulGqlWhereFilter, ContentfulImageFocusArea, ContentfulImageResizeBehavior, ContentfulImageSourcesOptions, ContentfulIncludeMap, ContentfulLink, ContentfulLinkType, ContentfulMetadata, ContentfulRestAsset, ContentfulSpaceLink, ContentfulSys, ContentfulTagLink, ContentfulTagLinkItem, CreateContentfulIncludeMapConfig, RichTextResponse };
+export { CONTENTFUL_CONFIG, CONTENTFUL_DEFAULT_COMPONENTS, CONTENTFUL_FILE_LABELS, ContentfulAudioComponent, ContentfulFileComponent, ContentfulImageComponent, ContentfulImports, ContentfulLinkComponent, ContentfulRichTextRendererComponent, ContentfulVideoComponent, DEFAULT_CONTENTFUL_FILE_LABELS, ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID, GQL_FRAGMENT_CONTENTFUL_ASSET, createContentfulConfig, createContentfulIncludeMap, generateContentfulImageSources, generateDefaultContentfulImageSource, injectContentfulConfig, injectContentfulFileLabels, isContentfulEntryType, isContentfulGqlAsset, isRichTextRootNode, mapContentfulGqlLinks, marksToClass, marksToTags, parseContentfulImageSize, provideContentfulConfig, provideContentfulFileLabels, translateContentfulNodeTypeToHtmlTag };
+export type { ComponentLikeWithAsset, ComponentLikeWithContentfulRendererInputs, ComponentLikeWithLink, ContentfulAssetComponents, ContentfulAssetFileData, ContentfulAssetImageData, ContentfulAssetLink, ContentfulAssetLinkItem, ContentfulCollection, ContentfulConfig, ContentfulConfigOptions, ContentfulContentTypeLink, ContentfulEntry, ContentfulEntryLink, ContentfulEntryLinkItem, ContentfulEntrySys, ContentfulEnvironmentLink, ContentfulFileLabels, ContentfulGqlAsset, ContentfulGqlCollectionFilterVariables, ContentfulGqlOrder, ContentfulGqlRichText, ContentfulGqlRichTextEntry, ContentfulGqlWhereFilter, ContentfulImageFocusArea, ContentfulImageResizeBehavior, ContentfulImageSourcesOptions, ContentfulIncludeMap, ContentfulLink, ContentfulLinkType, ContentfulMetadata, ContentfulRestAsset, ContentfulSpaceLink, ContentfulSys, ContentfulTagLink, ContentfulTagLinkItem, CreateContentfulIncludeMapConfig, RichTextResponse };