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

package/types/ethlete-contentful.d.ts

@@ -1,8 +1,10 @@
 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_contentful from '@ethlete/contentful';
 import * as _ethlete_components from '@ethlete/components';
 import { PictureSource } from '@ethlete/components';
 import * as _angular_router from '@angular/router';
@@ -13,6 +15,7 @@ type ContentfulGqlAsset = {
         id: string;
     };
     title: string | null;
+    fileName?: string | null;
     contentType: string | null;
     url: string | null;
     description: string | null;
@@ -145,6 +148,7 @@ declare class ContentfulRichTextRendererComponent {
     private renderer;
     private elementRef;
     private config;
+    private document;
     /**
      * The contentful response gotten via their REST api.
      * @see https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries/entries-collection
@@ -169,14 +173,18 @@ declare class ContentfulRichTextRendererComponent {
     private runDeleteInstruction;
     private getComponentRootNode;
     private findParent;
-    private findFollowingElement;
-    private renderInsertOrAppend;
+    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>;
 }
 
 declare const isRichTextRootNode: (node: unknown) => node is RichTextResponse;
-declare const translateContentfulNodeTypeToHtmlTag: (nodeType: "text" | BLOCKS | INLINES) => "hr" | "blockquote" | "table" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p" | "ul" | "ol" | "li" | "tr" | "td" | "th" | "div" | "a" | "span";
+/**
+ * The html element a structural rich text node renders as. A node type without an element
+ * (an unsupported inline or block) falls back to `span` for inlines and `div` otherwise,
+ * with a dev-mode warning.
+ */
+declare const translateContentfulNodeTypeToHtmlTag: (nodeType: "text" | BLOCKS | INLINES) => keyof HTMLElementTagNameMap;
 
 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';
@@ -187,6 +195,7 @@ type ComponentLikeWithLink = Type<{
     href: InputSignal<string>;
     text: InputSignal<string>;
     textClass: InputSignal<string>;
+    anchorClass?: InputSignal<string>;
 }>;
 type ComponentLikeWithContentfulRendererInputs = Type<{
     fields?: InputSignal<any>;
@@ -306,7 +315,7 @@ type ContentfulRestAsset = {
     fields: {
         title: string;
         description: string;
-        file: ContentfulAssetFileData;
+        file?: ContentfulAssetFileData;
     };
     metadata: ContentfulMetadata;
 };
@@ -349,7 +358,26 @@ declare class ContentfulAudioComponent {
     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>;
 }
 
+/** Every string `et-contentful-file` renders itself. Override them app-wide with {@link provideContentfulFileLabels}. */
+type ContentfulFileLabels = {
+    /** The size shown after the file title, e.g. `'(1.5 MB)'`. */
+    fileSize: (bytes: number) => string;
+};
+/** The built-in English labels. */
+declare const DEFAULT_CONTENTFUL_FILE_LABELS: ContentfulFileLabels;
+/**
+ * Localize `et-contentful-file` for everything below this injector, and read the set in effect here as a signal.
+ * Partial - whatever you leave out keeps its {@link DEFAULT_CONTENTFUL_FILE_LABELS} value.
+ *
+ * @example
+ * provideContentfulFileLabels({ fileSize: (bytes) => `(${new Intl.NumberFormat('de').format(bytes)} Byte)` });
+ */
+declare const provideContentfulFileLabels: (labels: _ethlete_core.LabelsSource<ContentfulFileLabels>) => _angular_core.Provider;
+declare const injectContentfulFileLabels: () => _angular_core.Signal<ContentfulFileLabels>;
+declare const CONTENTFUL_FILE_LABELS: _angular_core.InjectionToken<_ethlete_core.LabelsSource<ContentfulFileLabels>>;
+
 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<{
@@ -396,22 +424,37 @@ declare const parseContentfulImageSize: (size: string) => {
     width: number | null;
     height: number | null;
 };
-declare const generateContentfulImageSources: (data: ContentfulRestAsset | ContentfulGqlAsset, srcsetSizes: string[], backgroundColor: string | null, quality: number | null, focusArea: ContentfulImageFocusArea | null, resizeBehavior: ContentfulImageResizeBehavior | null) => PictureSource[];
+type ContentfulImageSourcesOptions = {
+    srcsetSizes?: string[];
+    backgroundColor?: string | null;
+    quality?: number | null;
+    focusArea?: ContentfulImageFocusArea | null;
+    resizeBehavior?: ContentfulImageResizeBehavior | null;
+};
+/**
+ * Builds AVIF and WebP `<source>` entries for a Contentful asset through the Contentful Images API.
+ *
+ * @example
+ * generateContentfulImageSources(asset, { srcsetSizes: ['400w', '800w'], quality: 80 });
+ */
+declare const generateContentfulImageSources: (data: ContentfulRestAsset | ContentfulGqlAsset, options?: ContentfulImageSourcesOptions) => PictureSource[];
 
 declare class ContentfulLinkComponent {
     private document;
     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>;
     protected usesRouterLink: _angular_core.Signal<boolean>;
     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>;
+    protected linkClass: _angular_core.Signal<string | null>;
     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>;
+    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>;
 }
 
 declare class ContentfulVideoComponent {
@@ -439,5 +482,5 @@ declare const injectContentfulConfig: () => ContentfulConfig;
 declare const provideContentfulConfig: (contentfulConfig?: Partial<ContentfulConfig> | null) => Provider;
 declare const isContentfulEntryType: <T extends ContentfulEntry>(entry: ContentfulEntry, type: string) => entry is T;
 
-export { CONTENTFUL_CONFIG, ContentfulAudioComponent, ContentfulFileComponent, ContentfulImageComponent, ContentfulImports, ContentfulLinkComponent, ContentfulRichTextRendererComponent, ContentfulVideoComponent, ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID, GQL_FRAGMENT_CONTENTFUL_ASSET, createContentfulConfig, createContentfulIncludeMap, generateContentfulImageSources, generateDefaultContentfulImageSource, injectContentfulConfig, isContentfulEntryType, isContentfulGqlAsset, isRichTextRootNode, marksToClass, marksToTags, 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 };
+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 };