@ethlete/contentful 3.7.2 → 3.9.0

package/lib/components/rich-text-renderer/rich-text-renderer.component.d.ts

@@ -1,205 +0,0 @@
-import { ComponentType } from '@angular/cdk/portal';
-import { ComponentRef, ElementRef, Renderer2, ViewContainerRef } from '@angular/core';
-import { Mark } from '@contentful/rich-text-types';
-import { ContentfulCollection, ContentfulEntry, ContentfulEntryLinkItem, ContentfulRestAsset, RichTextResponse } from '../../types';
-import * as i0 from "@angular/core";
-export declare const RENDER_COMMAND_TYPE: {
-    readonly HTML_OPEN: 0;
-    readonly HTML_CLOSE: 1;
-    readonly TEXT: 2;
-    readonly COMPONENT: 3;
-};
-export declare const RENDER_COMMAND_POSITION: {
-    readonly TYPE: 0;
-    readonly NESTING_LEVEL: 1;
-    readonly DOM_POSITION: 2;
-    readonly INDEX: 3;
-};
-export declare const HTML_OPEN_RENDER_COMMAND_POSITION: {
-    readonly ATTRIBUTES: 4;
-    readonly TAG_NAME: 5;
-    readonly ELEMENT_ID: 6;
-};
-export declare const HTML_CLOSE_RENDER_COMMAND_POSITION: {
-    readonly TAG_NAME: 4;
-    readonly ELEMENT_ID: 5;
-};
-export declare const TEXT_RENDER_COMMAND_POSITION: {
-    readonly ATTRIBUTES: 4;
-    readonly TEXT: 5;
-    readonly TEXT_ID: 6;
-};
-export declare const COMPONENT_RENDER_COMMAND_POSITION: {
-    readonly ATTRIBUTES: 4;
-    readonly COMPONENT: 5;
-    readonly INPUTS: 6;
-    readonly COMPONENT_ID: 7;
-};
-type HtmlOpenRenderCommand = [
-    type: typeof RENDER_COMMAND_TYPE.HTML_OPEN,
-    nestingLevel: number,
-    domPosition: number,
-    index: number,
-    attributes: Record<string, string>,
-    tagName: string,
-    textId: string
-];
-type HtmlCloseRenderCommand = [
-    type: typeof RENDER_COMMAND_TYPE.HTML_CLOSE,
-    nestingLevel: number,
-    domPosition: number,
-    index: number,
-    tagName: string,
-    elementId: string
-];
-type TextRenderCommand = [
-    type: typeof RENDER_COMMAND_TYPE.TEXT,
-    nestingLevel: number,
-    domPosition: number,
-    index: number,
-    attributes: Record<string, string>,
-    text: string,
-    elementId: string
-];
-type ComponentRenderCommand = [
-    type: typeof RENDER_COMMAND_TYPE.COMPONENT,
-    nestingLevel: number,
-    domPosition: number,
-    index: number,
-    attributes: Record<string, string>,
-    component: ComponentType<unknown>,
-    inputs: Record<string, unknown>,
-    componentId: string
-];
-type RenderCommand = HtmlOpenRenderCommand | HtmlCloseRenderCommand | TextRenderCommand | ComponentRenderCommand;
-export declare const RENDER_INSTRUCTION_POSITION: {
-    readonly TYPE: 0;
-    readonly COMMAND: 1;
-};
-export declare const RENDER_INSTRUCTION_TYPE: {
-    readonly CREATE: 0;
-    readonly UPDATE: 1;
-    readonly DELETE: 2;
-    readonly MOVE: 3;
-};
-type RenderInstructionTypeValue = (typeof RENDER_INSTRUCTION_TYPE)[keyof typeof RENDER_INSTRUCTION_TYPE];
-type RenderInstruction = [RenderInstructionTypeValue, RenderCommand];
-export declare const marksToClass: (marks: Mark[]) => string;
-export declare const isHtmlOpenRenderCommand: (command: RenderCommand) => command is HtmlOpenRenderCommand;
-export declare const isHtmlCloseRenderCommand: (command: RenderCommand) => command is HtmlCloseRenderCommand;
-export declare const isTextRenderCommand: (command: RenderCommand) => command is TextRenderCommand;
-export declare const isComponentRenderCommand: (command: RenderCommand) => command is ComponentRenderCommand;
-export declare const getRenderCommandId: (command: RenderCommand) => string;
-type ExecutedCommandCacheItemBase = {
-    element: HTMLElement;
-};
-type ExecutedComponentCommandCacheItem = {
-    command: ComponentRenderCommand;
-    componentRef: ComponentRef<unknown>;
-} & ExecutedCommandCacheItemBase;
-type ExecutedHtmlCommandCacheItem = {
-    command: HtmlOpenRenderCommand | HtmlCloseRenderCommand;
-} & ExecutedCommandCacheItemBase;
-type ExecutedTextCommandCacheItem = {
-    command: TextRenderCommand;
-    textNode: unknown;
-} & ExecutedCommandCacheItemBase;
-type ExecutedCommandCacheItem = ExecutedComponentCommandCacheItem | ExecutedHtmlCommandCacheItem | ExecutedTextCommandCacheItem;
-export declare const isExecutedComponentCommandCacheItem: (cache: ExecutedCommandCacheItem) => cache is ExecutedComponentCommandCacheItem;
-export declare const isExecutedHtmlOrTextCommandCacheItem: (cache: ExecutedCommandCacheItem) => cache is ExecutedHtmlCommandCacheItem;
-export declare const isExecutedTextCommandCacheItem: (cache: ExecutedCommandCacheItem) => cache is ExecutedTextCommandCacheItem;
-export declare const ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID = "$$$_et-contentful-any-entry-content-type-sys-id";
-export type ContentfulIncludeMap = {
-    /**
-     * Select an entry by its ID and content type ID.
-     *
-     * The content type ID can be found inside the entry -> sys -> contentType -> sys -> id property.
-     *
-     * You can provide the `ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID` constant to match any entry sys ID.
-     * But be aware that this will return the entry as is without any type checking.
-     */
-    getEntry: <T extends {
-        [key: string]: any;
-    }>(id: string, contentTypeId: string) => ContentfulEntry<T> | null;
-    /**
-     * Select multiple entries by their IDs and content type ID.
-     * If an entry is not found, it will be omitted from the result.
-     *
-     * The content type ID can be found inside the entry -> sys -> contentType -> sys -> id property.
-     *
-     * You can provide the `ET_CONTENTFUL_ANY_ENTRY_CONTENT_TYPE_SYS_ID` constant to match any entry sys ID.
-     * But be aware that this will return the entry as is without any type checking.
-     */
-    getEntries: <T extends {
-        [key: string]: any;
-    }>(ids: string[] | ContentfulEntryLinkItem[], contentTypeId: string) => ContentfulEntry<T>[];
-    /**
-     * Select an asset by its ID.
-     */
-    getAsset: (id: string) => ContentfulRestAsset | null;
-    /**
-     * Select multiple assets by their IDs. If an asset is not found, it will be omitted from the result.
-     */
-    getAssets: (ids: string[]) => ContentfulRestAsset[];
-};
-export interface 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.
- */
-export declare const createContentfulIncludeMap: (config: CreateContentfulIncludeMapConfig) => ContentfulIncludeMap;
-export declare class ContentfulRichTextRendererComponent {
-    _viewContainerRef: ViewContainerRef;
-    _renderer: Renderer2;
-    _elementRef: ElementRef<HTMLElement>;
-    _document: Document;
-    _config: import("../../types").ContentfulConfig;
-    /**
-     * A cache for all executed commands that are not deleted.
-     * This is used to keep track of all rendered elements and components.
-     * The key is the render command element ID.
-     */
-    _executedCommandsCache: Map<string, ExecutedCommandCacheItem>;
-    /**
-     * The contentful response gotten via their REST api.
-     * @see https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries/entries-collection
-     */
-    content: import("@angular/core").InputSignal<ContentfulCollection | null | undefined>;
-    /**
-     * 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: import("@angular/core").InputSignal<string>;
-    /**
-     * A map of all includes in the contentful response.
-     * This is useful for looking up assets and entries that are referenced in the rich text without having to use loops.
-     */
-    contentIncludesMap: import("@angular/core").Signal<ContentfulIncludeMap>;
-    /**
-     * The rich text data that should be rendered.
-     */
-    richTextData: import("@angular/core").Signal<RichTextResponse | null>;
-    renderCommands: import("@angular/core").Signal<RenderCommand[]>;
-    renderCommandHistory: import("@angular/core").Signal<[RenderCommand[], RenderCommand[]]>;
-    previousRenderCommandMap: import("@angular/core").Signal<Map<string | number, RenderCommand>>;
-    renderInstructions: import("@angular/core").Signal<RenderInstruction[]>;
-    constructor();
-    private _createRenderCommands;
-    private _execInstructions;
-    private _runCreateInstruction;
-    private _runUpdateInstruction;
-    private _runMoveInstruction;
-    private _runDeleteInstruction;
-    private _getComponentRootNode;
-    private _updateComponentInputs;
-    private _findParent;
-    private _findFollowingElement;
-    private _renderInsertOrAppend;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ContentfulRichTextRendererComponent, never>;
-    static ɵcmp: i0.ɵɵ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>;
-}
-export {};

package/lib/components/rich-text-renderer/rich-text-renderer.errors.d.ts

@@ -1,12 +0,0 @@
-export declare const RICH_TEXT_RENDERER_ERRORS: {
-    readonly rich_text_undefined: "The property value given at richTextPath is undefined. Use the richTextPath input to specify the path to the rich text object.";
-    readonly rich_text_wrong_type: "The rich text object does not satisfy the RichTextResponse interface. It should contain a property named \"nodeType\" with the value \"document\".";
-    readonly asset_id_not_found: "The asset ID was not found. This node is not supported.";
-    readonly entry_id_not_found: "The entry ID was not found. This node is not supported.";
-    readonly asset_not_found: "The asset was not found. This node is not supported.";
-    readonly entry_not_found: "The entry was not found. This node is not supported.";
-    readonly custom_component_not_found: "No custom component found for entry type. Please provide one for this type.";
-    readonly text_parent_not_found: "The parent node is not found. This structure is not supported.";
-    readonly text_parent_wrong_type: "The parent node neither a html element nor a custom component. This structure is not supported.";
-};
-export declare const richTextRendererError: (code: keyof typeof RICH_TEXT_RENDERER_ERRORS, devOnly: boolean, data?: unknown) => never;

package/lib/components/rich-text-renderer/rich-text-renderer.util.d.ts

@@ -1,4 +0,0 @@
-import { BLOCKS, INLINES } from '@contentful/rich-text-types';
-import { RichTextResponse } from '../../types';
-export declare const isRichTextRootNode: (node: unknown) => node is RichTextResponse;
-export 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";

package/lib/components/video/contentful-video.component.d.ts

@@ -1,14 +0,0 @@
-import { NgClassType } from '@ethlete/core';
-import { ContentfulGqlAsset } from '../../gql';
-import { ContentfulRestAsset } from '../../types';
-import * as i0 from "@angular/core";
-export declare class ContentfulVideoComponent {
-    asset: import("@angular/core").InputSignal<ContentfulGqlAsset | ContentfulRestAsset | null | undefined>;
-    videoClass: import("@angular/core").InputSignal<NgClassType>;
-    data: import("@angular/core").Signal<{
-        url: string | null;
-        contentType: string | null;
-    } | null>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ContentfulVideoComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ContentfulVideoComponent, "et-contentful-video", never, { "asset": { "alias": "asset"; "required": true; "isSignal": true; }; "videoClass": { "alias": "videoClass"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}

package/lib/components/video/index.d.ts

@@ -1 +0,0 @@
-export * from './contentful-video.component';

package/lib/constants/contentful.constants.d.ts

@@ -1,3 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { ContentfulConfig } from '../types';
-export declare const CONTENTFUL_CONFIG: InjectionToken<ContentfulConfig>;

package/lib/constants/index.d.ts

@@ -1 +0,0 @@
-export * from './contentful.constants';

package/lib/contentful.imports.d.ts

@@ -1,6 +0,0 @@
-import { ContentfulAudioComponent } from './components/audio';
-import { ContentfulFileComponent } from './components/file';
-import { ContentfulImageComponent } from './components/image';
-import { ContentfulRichTextRendererComponent } from './components/rich-text-renderer';
-import { ContentfulVideoComponent } from './components/video';
-export declare const ContentfulImports: readonly [typeof ContentfulAudioComponent, typeof ContentfulFileComponent, typeof ContentfulImageComponent, typeof ContentfulVideoComponent, typeof ContentfulRichTextRendererComponent];

package/lib/gql/asset.fragments.d.ts

@@ -1,77 +0,0 @@
-export declare const GQL_FRAGMENT_CONTENTFUL_ASSET: string;
-export interface ContentfulGqlAsset {
-    sys: {
-        id: string;
-    };
-    title: string | null;
-    contentType: string | null;
-    url: string | null;
-    description: string | null;
-    width: number | null;
-    height: number | null;
-    size: number | null;
-}
-export declare const isContentfulGqlAsset: (asset: any) => asset is ContentfulGqlAsset;
-export type ContentfulGqlWhereFilter<TLinkedFrom extends Record<string, unknown> = Record<string, unknown>> = {
-    /**
-     * Filer by ids.
-     * @see https://www.contentful.com/developers/docs/references/graphql/#/reference/collection-filters/sys-filters
-     */
-    sys?: {
-        id?: string;
-        id_not?: string;
-        id_in?: string[];
-        id_not_in?: string[];
-        id_contains?: string;
-        id_not_contains?: string;
-    };
-    /**
-     * Filer by tags.
-     * @see https://www.contentful.com/developers/docs/references/graphql/#/reference/collection-filters/contentfulmetadata-filters
-     */
-    contentfulMetadata?: {
-        tags_exists?: boolean;
-        tags?: {
-            id_contains_some?: string[];
-            id_contains_none?: string[];
-            id_contains_all?: string[];
-        };
-    };
-    /**
-     * Retrieve a collection of entries linked to the specified entry or asset.
-     * @see https://www.contentful.com/developers/docs/references/graphql/#links-to-a-specific-item
-     */
-    linkedFrom?: TLinkedFrom;
-};
-export type ContentfulGqlOrder = `${string}_${'ASC' | 'DESC'}`;
-export type ContentfulGqlCollectionFilterVariables<TCustomWhere extends Record<string, unknown> = Record<string, unknown>, TLinkedFrom extends Record<string, unknown> = Record<string, unknown>> = {
-    /**
-     * Zero-indexed offset in the collection from which items are fetched
-     * @default 0
-     */
-    skip?: number;
-    /**
-     * Maximum number of items to fetch. Maximum is 1000.
-     * @default 100
-     */
-    limit?: number;
-    /**
-     * Filter specifications to apply on the collection query.
-     * @see https://www.contentful.com/developers/docs/references/graphql/#/reference/collection-filters
-     */
-    where?: TCustomWhere & ContentfulGqlWhereFilter<TLinkedFrom>;
-    /**
-     * Order specifications to apply on the collection query.
-     * @see https://www.contentful.com/developers/docs/references/graphql/#/reference/collection-order
-     */
-    order?: ContentfulGqlOrder[];
-    /**
-     * When set to `true` the field will be resolved with non published content.
-     * @default false
-     */
-    preview?: boolean;
-    /**
-     * Locale for the collection items. If not set the default locale is used.
-     */
-    locale?: string;
-};

package/lib/gql/index.d.ts

@@ -1 +0,0 @@
-export * from './asset.fragments';

package/lib/types/contentful.types.d.ts

@@ -1,151 +0,0 @@
-import { ComponentType } from '@angular/cdk/portal';
-import { InputSignal } from '@angular/core';
-import { Block, NodeData } from '@contentful/rich-text-types';
-import { ContentfulIncludeMap } from '../components/rich-text-renderer';
-import { ContentfulGqlAsset } from '../gql';
-export type ContentfulImageResizeBehavior = 'pad' | 'crop' | 'fill' | 'scale' | 'thumb' | 'fit';
-export type ContentfulImageFocusArea = 'top' | 'bottom' | 'left' | 'right' | 'center' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'face' | 'faces';
-export type ComponentLikeWithAsset = ComponentType<{
-    asset: InputSignal<ContentfulRestAsset | ContentfulGqlAsset | null | undefined>;
-}>;
-export type ComponentLikeWithContentfulRendererInputs = ComponentType<{
-    fields?: InputSignal<any>;
-    includes?: InputSignal<ContentfulIncludeMap>;
-    metadata?: InputSignal<ContentfulMetadata>;
-    sys?: InputSignal<ContentfulEntrySys>;
-}>;
-export interface ContentfulAssetComponents {
-    file: ComponentLikeWithAsset;
-    image: ComponentLikeWithAsset;
-    video: ComponentLikeWithAsset;
-    audio: ComponentLikeWithAsset;
-}
-export interface ContentfulConfig {
-    /**
-     * Default components for rendering contentful assets
-     */
-    components: ContentfulAssetComponents;
-    /**
-     * Component for rendering embedded entries
-     */
-    customComponents: Record<string, ComponentLikeWithContentfulRendererInputs>;
-    /**
-     * Determines if the contentful rich text renderer should render the contentful rich text with tailwind css classes
-     */
-    useTailwindClasses: boolean;
-    /**
-     * Default options for the contentful image api
-     */
-    imageOptions: {
-        /**
-         * Source set sizes. Eg.
-         * - `"400"` - 400px width
-         * - `"400x300"` - 400px width and 300px height
-         * - `"400w"` - 400px width
-         * - `"400h"` - 400px height
-         * - `"400wx300h"` - 400px width and 300px height
-         **/
-        srcsetSizes: string[];
-        /**
-         * Sizes for the image. Eg.
-         *  - `"100vw"` - 100% of the viewport width
-         *  - `"50vw"` - 50% of the viewport width
-         *  - `(min-width: 30em) 30em"` - 30em if the viewport is at least 30em wide
-         */
-        sizes: string[];
-        /**
-         * Background color for the image in hex. Eg. `"000000"`
-         */
-        backgroundColor: string | null;
-    };
-}
-export type ContentfulLinkType = 'Space' | 'ContentType' | 'Environment' | 'Entry' | 'Asset' | 'Tag';
-export interface ContentfulLink<T extends ContentfulLinkType> {
-    type: 'Link';
-    linkType: T;
-    id: string;
-}
-export type ContentfulSpaceLink = ContentfulLink<'Space'>;
-export type ContentfulEnvironmentLink = ContentfulLink<'Environment'>;
-export type ContentfulContentTypeLink = ContentfulLink<'ContentType'>;
-export type ContentfulEntryLink = ContentfulLink<'Entry'>;
-export type ContentfulAssetLink = ContentfulLink<'Asset'>;
-export type ContentfulTagLink = ContentfulLink<'Tag'>;
-export interface ContentfulTagLinkItem {
-    sys: ContentfulTagLink;
-}
-export interface ContentfulEntryLinkItem {
-    sys: ContentfulEntryLink;
-}
-export interface ContentfulAssetLinkItem {
-    sys: ContentfulAssetLink;
-}
-export interface ContentfulMetadata {
-    tags: ContentfulTagLinkItem[];
-}
-export type ContentfulSys = {
-    type: string;
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    locale: string;
-    revision?: number;
-    space?: {
-        sys: ContentfulSpaceLink;
-    };
-    environment?: {
-        sys: ContentfulEnvironmentLink;
-    };
-};
-export type ContentfulEntrySys = ContentfulSys & {
-    contentType: {
-        sys: ContentfulContentTypeLink;
-    };
-};
-export interface ContentfulAssetImageData {
-    width: number;
-    height: number;
-}
-export interface ContentfulAssetFileData {
-    url: string | null;
-    details: {
-        size: number | null;
-        image?: ContentfulAssetImageData;
-    };
-    fileName: string | null;
-    contentType: string | null;
-}
-export interface ContentfulRestAsset {
-    sys: ContentfulSys;
-    fields: {
-        title: string;
-        description: string;
-        file: ContentfulAssetFileData;
-    };
-    metadata: ContentfulMetadata;
-}
-export interface ContentfulEntry<T = {
-    [key: string]: any;
-}> {
-    sys: ContentfulEntrySys;
-    fields: T;
-    metadata: ContentfulMetadata;
-}
-export interface ContentfulCollection {
-    includes: {
-        Asset: ContentfulRestAsset[];
-        Entry: ContentfulEntry[];
-    };
-    items: ContentfulEntry[];
-    limit: number;
-    skip: number;
-    total: number;
-    sys: {
-        type: 'Array';
-    };
-}
-export interface RichTextResponse {
-    nodeType: 'document';
-    data: NodeData;
-    content: Block[];
-}

package/lib/types/index.d.ts

@@ -1 +0,0 @@
-export * from './contentful.types';

package/lib/utils/contentful-config.d.ts

@@ -1,2 +0,0 @@
-import { ContentfulConfig } from '../types';
-export declare const createContentfulConfig: (config?: Partial<ContentfulConfig> | null | undefined) => ContentfulConfig;

package/lib/utils/contentful.util.d.ts

@@ -1,6 +0,0 @@
-import { ContentfulConfig, ContentfulEntry } from '../types';
-export declare const provideContentfulConfig: (contentfulConfig?: Partial<ContentfulConfig> | null | undefined) => {
-    provide: import("@angular/core").InjectionToken<ContentfulConfig>;
-    useValue: ContentfulConfig;
-};
-export declare const isContentfulEntryType: <T extends ContentfulEntry>(entry: ContentfulEntry, type: string) => entry is T;

package/lib/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from './contentful-config';
-export * from './contentful.util';