@griddo/core 1.73.28 → 1.74.0

package/dist/src/types/core.d.ts

@@ -0,0 +1,419 @@
+/**
+ * Type for a Griddo component which is an object with properties and values
+ * that at least includes the prop component.
+ */
+export declare module Core {
+    type GriddoComponent<T> = T & {
+        component: string;
+    };
+    type ArrayFieldGroup<FieldKeys> = Array<FieldKeys>;
+    type AsyncCheckGroup = Array<string>;
+    type CheckGroupField<Options> = Options;
+    type ColorPickerField = string;
+    type ColorPickerFixedField = {
+        name: string;
+        hex: string;
+    };
+    type ComponentArrayField<ComponentProps> = Array<ComponentProps>;
+    type ComponentContainerField<T> = GriddoComponent<T>;
+    type ConditionalField<T> = T;
+    type DateField = string;
+    type FileField = {
+        /** URL for the document */
+        url?: string;
+        /** Size for the document file in bytes */
+        sizeBytes?: number;
+        /** Upload date */
+        uploadDate?: string;
+    };
+    type HeadingField<HeadingTagsType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "span"> = {
+        /** Text content */
+        content?: string;
+        /** HTML tag used to render the content */
+        tag?: HeadingTagsType | null;
+    };
+    type ImageField = {
+        /** Image id */
+        id?: number;
+        /** Original image name */
+        name?: string;
+        /** Image name from the gallery */
+        title?: string;
+        /** Image description from the gallery */
+        description?: string;
+        /** Alternative text for the image */
+        alt?: string;
+        /** Image tags from the gallery */
+        tags?: Array<string>;
+        /** Griddo DAM image url */
+        url?: string;
+        /** Griddo DAM image url thumbnail */
+        thumb?: string;
+        /** Cloudinary `public-id`
+         * @deprecated
+         * Cloudinary will be deprecated in the future
+         * */
+        publicId?: string;
+        /** Griddo DAM image id
+         * @deprecated
+         * This id is internal and should not be used
+         */
+        damId?: string;
+        /** Image publication date */
+        published?: string;
+        /** Original image size in bytes */
+        size?: number;
+        /** Original image width in pixels */
+        width?: number;
+        /** Original image height in pixels */
+        height?: number;
+        /** Original image orientation
+         * P: Portrait
+         * L: Landscape
+         * S: Square
+         */
+        orientation?: "P" | "L" | "S";
+        /** Site to which image belongs */
+        site?: number;
+    };
+    interface LinkFieldCommon {
+        /** Link text */
+        text?: string;
+    }
+    interface LinkFieldUrl extends LinkFieldCommon {
+        linkType: "url";
+        url: UrlField;
+    }
+    interface LinkFieldModal<T> extends LinkFieldCommon {
+        linkType: "modal";
+        modal?: {
+            [key: string]: ComponentContainerField<T>;
+        };
+    }
+    /** Field of type link in which a whitelist of modules can be added, for example to open them in a modal. */
+    type LinkField<ModalComponents> = LinkFieldUrl | LinkFieldModal<ModalComponents>;
+    type SourceReturn = {
+        value?: number | string;
+        name?: number;
+        title?: string;
+        label?: string;
+    };
+    type MultiCheckSelectField = Array<SourceReturn>;
+    type MultiCheckSelectGroup<T extends string> = {
+        [K in T]: MultiCheckSelectField;
+    };
+    type NoteField = string;
+    type NumberField = number;
+    type RadioGroupField<OptionsValues> = OptionsValues;
+    type ReferenceField<ContentType> = {
+        mode: "auto" | "manual";
+        order: string;
+        source: ContentType extends {
+            contentTypeName: unknown;
+        } ? Array<ContentType["contentTypeName"]> : never;
+        /** 0 means all */
+        quantity: number;
+        filter: Array<{
+            id: number;
+            label: string;
+            source: string;
+        }>;
+        fullRelations: boolean;
+    };
+    type RichTextField = string;
+    type ScrollableUniqueSelectionField = string;
+    type SelectField<Values> = Values;
+    type SliderField = number;
+    type TextAreaField = string;
+    /** Return type of an TextField */
+    type TextField = string;
+    type TimeField = string;
+    type UrlField = {
+        href?: string;
+        title?: string;
+        linkToURL?: string;
+        newTab?: boolean;
+        noFollow?: boolean;
+        subSlug?: string;
+    };
+    type VisualUniqueSelectionField<Values> = Values;
+    type WysiwygField = string;
+    type Renderers = "gatsby" | "editor" | "preview";
+    type Breadcrumb = Array<{
+        path?: string;
+        label: string;
+        fullPath: string;
+    }>;
+    type ConfigBase = {
+        type?: "link" | "group";
+        headerStyle?: string;
+        footerStyle?: string;
+    };
+    type MenuItemBase = {
+        label?: string;
+        url?: UrlField;
+        auxText?: string;
+        image?: ImageField;
+    };
+    interface GroupLinkType extends ConfigBase {
+        type?: "group";
+    }
+    interface ConfigLinkType extends ConfigBase {
+        type?: "link";
+    }
+    interface MenuChildrenGroupType extends MenuItemBase {
+        url?: never;
+        config?: GroupLinkType;
+        children?: Array<MenuElement>;
+    }
+    interface MenuChildrenLinkType extends MenuItemBase {
+        config?: ConfigLinkType;
+        children?: Array<MenuElement>;
+    }
+    type MenuElement = MenuChildrenGroupType | MenuChildrenLinkType;
+    type Menu = {
+        elements: Array<MenuElement>;
+    };
+    type TemplateSection<GriddoModule> = {
+        modules: Array<GriddoModule>;
+    };
+    interface PageLanguage {
+        id: number;
+        locale: string;
+    }
+    interface SiteLanguage {
+        id: number;
+        locale: string;
+        language: string;
+        label: string;
+        isDefault: boolean;
+    }
+    interface Page {
+        language?: PageLanguage;
+        id?: number;
+        setAsHome?: boolean;
+        entity?: string;
+        site: number;
+        title: string;
+        slug: string;
+        author?: number;
+        readonly isHome?: boolean;
+        canonicalURL?: string;
+        parent?: unknown;
+        readonly component?: "Page";
+        deleted?: boolean;
+        follow?: boolean;
+        header?: unknown;
+        footer?: unknown;
+        isIndexed?: boolean;
+        liveStatus?: {
+            id: 1 | 2 | 3 | 4 | 5 | 6;
+            title: string;
+            status: "offline" | "upload-pending" | "active" | "offline-pending" | "modified" | "scheduled";
+        };
+        locale?: unknown;
+        metaDescription?: string;
+        metaTitle?: string;
+        metasAdvanced?: string;
+        socialTitle?: string;
+        socialDescription?: string;
+        socialImage?: unknown;
+        template: {
+            type?: string;
+            templateType: string;
+            [key: string]: unknown;
+        };
+        url?: string;
+        workflowStatus?: unknown;
+        modified?: string;
+        published?: string;
+        pageLanguages?: [
+            {
+                siteId: number;
+                languageId: number;
+                pageId: number;
+                title: string;
+                locale: string;
+                isLive: boolean;
+                draftFromPage: unknown;
+                url: string;
+                path: {
+                    site: string;
+                    domain: string;
+                    domainUrl: string;
+                    language: string;
+                    page: string;
+                    compose: string;
+                };
+            }
+        ];
+        templateId?: string;
+        structuredData?: unknown;
+        readonly hash?: string;
+        origin?: string;
+        editable?: boolean;
+        manuallyImported?: boolean;
+        availableSites?: Array<{
+            id: number;
+            name: string;
+        }>;
+        canBeUnpublished?: boolean;
+        editing?: {
+            id: number;
+            name: string;
+            username: string;
+            email: string;
+        };
+        draftFromPage?: unknown;
+        haveDraftPage?: unknown;
+        liveChanged?: boolean;
+        noTranslate?: boolean;
+        dimensions?: {
+            values: unknown;
+        };
+        readonly breadcrumb?: Breadcrumb;
+        readonly path?: string;
+        readonly fullPath?: {
+            site: string;
+            domain: string;
+            domainUrl: string;
+            language: string;
+            page: string;
+            compose: string;
+        };
+        readonly fullUrl?: string;
+        templateConfig?: unknown;
+    }
+    type CloudinaryDefaults = {
+        domain: "https://res.cloudinary.com";
+        uploadFolder: "image/upload";
+        fallback404Image: "placeholders/fallback-404-image";
+        quality: "80";
+        crop: "fill";
+        gravity: "faces:center";
+        format: "auto";
+        loading: "lazy";
+        backgroundLazy: false;
+        decoding: "auto";
+    };
+    type GriddoDamDefaults = {
+        quality: number;
+        crop: ImageCropType;
+        loading: ImageLoading;
+        decoding: ImageDecoding;
+        blurSize: string;
+        blurCSSTransition: string;
+        formats: Array<ImageFormats>;
+    };
+    interface Site {
+        apiUrl?: string;
+        bigAvatar: string;
+        cloudinaryCloudName?: string;
+        cloudinaryDefaults?: CloudinaryDefaults;
+        defaultLanguage?: SiteLanguage;
+        domain: number;
+        favicon: string;
+        griddoDamDefaults?: GriddoDamDefaults;
+        name: string;
+        path: string;
+        publicApiUrl?: string;
+        renderer?: Renderers;
+        siteId?: number;
+        siteLangs?: Array<{
+            id: number;
+            locale: string;
+            language: string;
+            path: string;
+            label: string;
+            isDefault: boolean;
+            home: string;
+            domain: {
+                id: number;
+                url: string;
+                slug: string;
+            };
+        }>;
+        smallAvatar: string;
+        theme: string;
+        thumbnail: string;
+        timezone: TimeZone;
+        translations?: Record<string, unknown>;
+    }
+    type FetchPriority = "auto" | "high" | "low";
+    type ImageCropType = "cover" | "contain" | "fill" | "inside" | "outside";
+    type ImageDecoding = "auto" | "sync" | "async";
+    type ImageFormats = "avif" | "webp" | "jpeg" | "jpg" | "png" | "gif";
+    type ImageLoading = "lazy" | "eager";
+    type ImageTransform = "grayscale" | "flip" | "flop" | "blur";
+    type QueriedDataOf<ContentType> = Array<{
+        structuredData?: ContentType extends {
+            contentTypeName: unknown;
+        } ? ContentType["contentTypeName"] : never;
+        content?: Omit<ContentType, "contentTypeName">;
+        relatedPage?: {
+            pageId: number;
+            url?: string;
+            origin?: string;
+            availableSites?: Array<{
+                id?: number;
+                name?: string;
+            }>;
+            editable?: boolean;
+            manuallyImported?: boolean;
+            originalPageId?: number;
+            originalStructuredDataId?: number;
+        };
+        relatedSite?: number;
+        modified?: string;
+        published?: string;
+    }>;
+    type QueriedData<ContentType> = QueriedDataOf<ContentType>;
+    type BackgroundImageSizesProps = {
+        breakpoint: string;
+        width?: string;
+        height?: string;
+        quality?: number;
+    };
+    type ImagePosition = "top" | "right top" | "right" | "right bottom" | "bottom" | "left bottom" | "left" | "left top" | "entropy" | "attention";
+    interface GriddoCoreComponentProps {
+        component: string;
+        libComponents: {
+            [key: string]: unknown;
+        };
+    }
+    type TimeZone = "" | "Pacific/Pago_Pago" | "Pacific/Honolulu" | "America/Los_Angeles" | "America/Tijuana" | "America/Denver" | "America/Phoenix" | "America/Mazatlan" | "America/Chicago" | "America/Mexico_City" | "America/Regina" | "America/Guatemala" | "America/Bogota" | "America/New_York" | "America/Lima" | "America/Caracas" | "America/Halifax" | "America/Guyana" | "America/La_Paz" | "America/Argentina/Buenos_Aires" | "America/Godthab" | "America/Montevideo" | "America/St_Johns" | "America/Santiago" | "America/Sao_Paulo" | "Atlantic/South_Georgia" | "Atlantic/Azores" | "Atlantic/Cape_Verde" | "Africa/Casablanca" | "Europe/Dublin" | "Europe/Lisbon" | "Europe/London" | "Africa/Monrovia" | "Africa/Algiers" | "Europe/Amsterdam" | "Europe/Berlin" | "Europe/Brussels" | "Europe/Budapest" | "Europe/Belgrade" | "Europe/Prague" | "Europe/Copenhagen" | "Europe/Madrid" | "Europe/Paris" | "Europe/Rome" | "Europe/Stockholm" | "Europe/Vienna" | "Europe/Warsaw" | "Europe/Athens" | "Europe/Bucharest" | "Africa/Cairo" | "Asia/Jerusalem" | "Africa/Johannesburg" | "Europe/Helsinki" | "Europe/Kiev" | "Europe/Kaliningrad" | "Europe/Riga" | "Europe/Sofia" | "Europe/Tallinn" | "Europe/Vilnius" | "Europe/Istanbul" | "Asia/Baghdad" | "Africa/Nairobi" | "Europe/Minsk" | "Asia/Riyadh" | "Europe/Moscow" | "Asia/Tehran" | "Asia/Baku" | "Europe/Samara" | "Asia/Tbilisi" | "Asia/Yerevan" | "Asia/Kabul" | "Asia/Karachi" | "Asia/Yekaterinburg" | "Asia/Tashkent" | "Asia/Colombo" | "Asia/Almaty" | "Asia/Dhaka" | "Asia/Rangoon" | "Asia/Bangkok" | "Asia/Jakarta" | "Asia/Krasnoyarsk" | "Asia/Shanghai" | "Asia/Hong_Kong" | "Asia/Kuala_Lumpur" | "Asia/Irkutsk" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Ulaanbaatar" | "Australia/Perth" | "Asia/Yakutsk" | "Asia/Seoul" | "Asia/Tokyo" | "Australia/Darwin" | "Australia/Brisbane" | "Pacific/Guam" | "Asia/Magadan" | "Asia/Vladivostok" | "Pacific/Port_Moresby" | "Australia/Adelaide" | "Australia/Hobart" | "Australia/Sydney" | "Pacific/Guadalcanal" | "Pacific/Noumea" | "Pacific/Majuro" | "Asia/Kamchatka" | "Pacific/Auckland" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Tongatapu" | "Pacific/Apia";
+    interface Module {
+        component: string;
+        [key: string]: unknown;
+    }
+    type UseListItem<T> = Omit<T, "contentTypeName"> & {
+        id: number;
+    };
+    type UseListState<Item> = {
+        isError: {
+            code: number;
+            message: string;
+        };
+        isLoading: boolean;
+        msg: {
+            code: number;
+            msg: string;
+        };
+        query?: {
+            page: number;
+            totalItems: number;
+            items: Array<UseListItem<Item>>;
+        };
+    };
+    interface UseListSetStateAction<ContentType> {
+        data: ReferenceField<ContentType>;
+        items?: number;
+        page?: number;
+        filterIds?: Array<number>;
+        /** String array of the keys/properties you want the query restrict to.
+         * @example
+         * fields: ['title', 'image']
+         */
+        fields?: Array<keyof Omit<ContentType, "contentTypeName">>;
+    }
+}

package/dist/src/types/fields.d.ts

@@ -0,0 +1,7 @@
+export * as UIFields from "./schema-functions/fields/ui-fields";
+export * as PureDataFields from "./schema-functions/fields/pure-data-fields";
+export * as SimpleContentTypeFields from "./schema-functions/fields/pure-data-fields";
+export * as SimpleCTFields from "./schema-functions/fields/pure-data-fields";
+export * as PageDataFields from "./schema-functions/fields/page-data-fields";
+export * as PageContentTypeFields from "./schema-functions/fields/page-data-fields";
+export * as PageCTFields from "./schema-functions/fields/page-data-fields";