@sitecore-content-sdk/react 1.3.0-canary.9 → 1.4.0-canary.2

package/types/components/FEaaS/models.d.ts

@@ -1,125 +1,136 @@
-import * as FEAAS from '@sitecore-feaas/clientside/react';
-import { ComponentFields, ComponentRendering } from '@sitecore-content-sdk/core/layout';
-import { Page } from '@sitecore-content-sdk/core/client';
-import { MissingComponentProps } from '../MissingComponent';
-export declare const FEAAS_WRAPPER_RENDERING_NAME = "FEaaSWrapper";
-export declare const FEAAS_COMPONENT_RENDERING_NAME = "FEaaSComponent";
-export declare const BYOC_WRAPPER_RENDERING_NAME = "BYOCWrapper";
-export declare const BYOC_COMPONENT_RENDERING_NAME = "BYOCComponent";
-/**
- * FEaaS props for server rendering.
- */
-export type BYOCServerProps = {
-    /**
-     * Fetched data from server component props for server rendering, based on rendering params.
-     */
-    fetchedData?: FEAAS.DataScopes;
-};
-/**
- * Data from rendering params on Sitecore's BYOC rendering
- */
-export type BYOCComponentParams = {
-    /**
-     * Name of the component to render
-     */
-    ComponentName?: string;
-    /**
-     * JSON props to pass into rendered component
-     */
-    ComponentProps?: string;
-    /**
-     * A JSON object with data sources to be fetched and passed to the component
-     */
-    ComponentDataOverride?: string;
-    /**
-     * A string with classes that can be used to apply themes, via SXA functionality
-     */
-    styles?: string;
-    RenderingIdentifier?: string;
-};
-/**
- * Props for BYOCComponent. Includes components list to load external components from.
- */
-export type BYOCComponentClientProps = {
-    /**
-     * rendering data
-     */
-    rendering: ComponentRendering;
-    /**
-     * rendering params
-     */
-    params?: BYOCComponentParams;
-    /**
-     * fields from datasource items to be passed as rendered child component props
-     */
-    fields?: ComponentFields;
-    /**
-     * Error component override. To be shown when Renderer or underlying component throws
-     */
-    errorComponent?: React.ComponentClass<ErrorComponentProps> | React.FC<ErrorComponentProps>;
-    /**
-     * Override to indicate missing component situations. Would be shown when BYOC component is not registered
-     * or ComponentName is missing
-     */
-    missingComponentComponent?: React.ComponentClass<MissingComponentProps> | React.FC<MissingComponentProps>;
-};
-export type BYOCServerWrapperProps = BYOCComponentProps & {
-    rendering: ComponentRendering;
-};
-export type BYOCComponentProps = BYOCComponentClientProps & BYOCServerProps;
-export type ErrorComponentProps = {
-    [prop: string]: unknown;
-    error?: Error;
-};
-/**
- * Params from a Sitecore FEaaS rendering
- */
-export type FEaaSComponentParams = {
-    LibraryId?: string;
-    ComponentId?: string;
-    ComponentVersion?: string;
-    ComponentRevision?: RevisionType;
-    ComponentHostName?: string;
-    ComponentInstanceId?: string;
-    ComponentDataOverride?: string;
-    ComponentHTMLOverride?: string;
-    styles?: string;
-    RenderingIdentifier?: string;
-};
-export type RevisionType = number | 'staged' | 'published' | 'saved';
-export type FEaaSServerWrapperProps = FEaaSComponentProps & {
-    rendering?: ComponentRendering;
-    page?: Page;
-};
-export type FEaaSComponentProps = FEaaSComponentServerProps & FEaaSComponentClientProps;
-/**
- * FEaaS props for server rendering.
- */
-export type FEaaSComponentServerProps = {
-    /**
-     * HTML template for presentation rendered inside the component
-     */
-    template?: string;
-    /**
-     * Default revision to be fetched. Should be 'staged' for editing/preview. Can be overriden by params.ComponentRevision
-     */
-    revisionFallback?: RevisionType;
-    /**
-     * Fetched data from server component props for server rendering, based on rendering params.
-     */
-    fetchedData?: FEAAS.DataScopes;
-};
-/**
- * FEaaS props for client side component. Should be used as fallback when server props are not provided.
- * Would also be passed on server to avoid hydration issues
- */
-export type FEaaSComponentClientProps = {
-    /**
-     * parameters from Sitecore's FEAAS component
-     */
-    params?: FEaaSComponentParams;
-    /**
-     * field data from component's datasource
-     */
-    fields?: ComponentFields;
-};
+import * as FEAAS from '@sitecore-feaas/clientside/react';
+import { ComponentFields, ComponentRendering } from '@sitecore-content-sdk/core/layout';
+import { Page } from '@sitecore-content-sdk/core/client';
+import { MissingComponentProps } from '../MissingComponent';
+export declare const FEAAS_WRAPPER_RENDERING_NAME = "FEaaSWrapper";
+export declare const FEAAS_COMPONENT_RENDERING_NAME = "FEaaSComponent";
+export declare const BYOC_WRAPPER_RENDERING_NAME = "BYOCWrapper";
+export declare const BYOC_COMPONENT_RENDERING_NAME = "BYOCComponent";
+/**
+ * FEaaS props for server rendering.
+ */
+export type BYOCServerProps = {
+    /**
+     * Fetched data from server component props for server rendering, based on rendering params.
+     */
+    fetchedData?: FEAAS.DataScopes;
+};
+/**
+ * Data from rendering params on Sitecore's BYOC rendering
+ * @public
+ */
+export type BYOCComponentParams = {
+    /**
+     * Name of the component to render
+     */
+    ComponentName?: string;
+    /**
+     * JSON props to pass into rendered component
+     */
+    ComponentProps?: string;
+    /**
+     * A JSON object with data sources to be fetched and passed to the component
+     */
+    ComponentDataOverride?: string;
+    /**
+     * A string with classes that can be used to apply themes, via SXA functionality
+     */
+    styles?: string;
+    RenderingIdentifier?: string;
+};
+/**
+ * Props for BYOCComponent. Includes components list to load external components from.
+ */
+export type BYOCComponentClientProps = {
+    /**
+     * rendering data
+     */
+    rendering: ComponentRendering;
+    /**
+     * rendering params
+     */
+    params?: BYOCComponentParams;
+    /**
+     * fields from datasource items to be passed as rendered child component props
+     */
+    fields?: ComponentFields;
+    /**
+     * Error component override. To be shown when Renderer or underlying component throws
+     */
+    errorComponent?: React.ComponentClass<ErrorComponentProps> | React.FC<ErrorComponentProps>;
+    /**
+     * Override to indicate missing component situations. Would be shown when BYOC component is not registered
+     * or ComponentName is missing
+     */
+    missingComponentComponent?: React.ComponentClass<MissingComponentProps> | React.FC<MissingComponentProps>;
+};
+export type BYOCServerWrapperProps = BYOCComponentProps & {
+    rendering: ComponentRendering;
+};
+/**
+ * Props for BYOCComponent.
+ * @public
+ */
+export type BYOCComponentProps = BYOCComponentClientProps & BYOCServerProps;
+export type ErrorComponentProps = {
+    [prop: string]: unknown;
+    error?: Error;
+};
+/**
+ * Params from a Sitecore FEaaS rendering
+ * @public
+ */
+export type FEaaSComponentParams = {
+    LibraryId?: string;
+    ComponentId?: string;
+    ComponentVersion?: string;
+    ComponentRevision?: RevisionType;
+    ComponentHostName?: string;
+    ComponentInstanceId?: string;
+    ComponentDataOverride?: string;
+    ComponentHTMLOverride?: string;
+    styles?: string;
+    RenderingIdentifier?: string;
+};
+export type RevisionType = number | 'staged' | 'published' | 'saved';
+export type FEaaSServerWrapperProps = FEaaSComponentProps & {
+    rendering?: ComponentRendering;
+    page?: Page;
+};
+/**
+ * The FEaaS component props.
+ * @public
+ */
+export type FEaaSComponentProps = FEaaSComponentServerProps & FEaaSComponentClientProps;
+/**
+ * FEaaS props for server rendering.
+ */
+export type FEaaSComponentServerProps = {
+    /**
+     * HTML template for presentation rendered inside the component
+     */
+    template?: string;
+    /**
+     * Default revision to be fetched. Should be 'staged' for editing/preview. Can be overriden by params.ComponentRevision
+     */
+    revisionFallback?: RevisionType;
+    /**
+     * Fetched data from server component props for server rendering, based on rendering params.
+     */
+    fetchedData?: FEAAS.DataScopes;
+};
+/**
+ * FEaaS props for client side component. Should be used as fallback when server props are not provided.
+ * Would also be passed on server to avoid hydration issues
+ */
+export type FEaaSComponentClientProps = {
+    /**
+     * parameters from Sitecore's FEAAS component
+     */
+    params?: FEaaSComponentParams;
+    /**
+     * field data from component's datasource
+     */
+    fields?: ComponentFields;
+};
+//# sourceMappingURL=models.d.ts.map

package/types/components/FEaaS/models.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../../src/components/FEaaS/models.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACxF,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,eAAO,MAAM,4BAA4B,iBAAiB,CAAC;AAC3D,eAAO,MAAM,8BAA8B,mBAAmB,CAAC;AAC/D,eAAO,MAAM,2BAA2B,gBAAgB,CAAC;AACzD,eAAO,MAAM,6BAA6B,kBAAkB,CAAC;AAC7D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,mBAAmB,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAC3F;;;OAGG;IACH,yBAAyB,CAAC,EACtB,KAAK,CAAC,cAAc,CAAC,qBAAqB,CAAC,GAC3C,KAAK,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG;IACxD,SAAS,EAAE,kBAAkB,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,eAAe,CAAC;AAE5E,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,YAAY,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,CAAC;AAErE,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG;IAC1D,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,yBAAyB,GAAG,yBAAyB,CAAC;AAExF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B,CAAC"}

package/types/components/FieldMetadata.d.ts

@@ -1,17 +1,18 @@
-import React, { JSX } from 'react';
-interface FieldMetadataProps {
-    metadata: {
-        [key: string]: unknown;
-    };
-    children: React.ReactNode;
-}
-/**
- * The component which renders field metadata markup
- * @param {FieldMetadataProps} props the props of the component
- * @returns metadata markup wrapped around children
- */
-export declare const FieldMetadata: {
-    (props: FieldMetadataProps): JSX.Element;
-    displayName: string;
-};
-export {};
+import React, { JSX } from 'react';
+interface FieldMetadataProps {
+    metadata: {
+        [key: string]: unknown;
+    };
+    children: React.ReactNode;
+}
+/**
+ * The component which renders field metadata markup
+ * @param {FieldMetadataProps} props the props of the component
+ * @returns metadata markup wrapped around children
+ */
+export declare const FieldMetadata: {
+    (props: FieldMetadataProps): JSX.Element;
+    displayName: string;
+};
+export {};
+//# sourceMappingURL=FieldMetadata.d.ts.map

package/types/components/FieldMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FieldMetadata.d.ts","sourceRoot":"","sources":["../../src/components/FieldMetadata.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAGnC,UAAU,kBAAkB;IAC1B,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACrC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa;YAAW,kBAAkB,GAAG,GAAG,CAAC,OAAO;;CAiBpE,CAAC"}

package/types/components/File.d.ts

@@ -1,18 +1,28 @@
-import React from 'react';
-export interface FileFieldValue {
-    [propName: string]: unknown;
-    src?: string;
-    title?: string;
-    displayName?: string;
-}
-export interface FileField {
-    value: FileFieldValue;
-}
-export interface FileProps {
-    [attributeName: string]: unknown;
-    /** The file field data. */
-    field: FileFieldValue | FileField;
-    /** HTML attributes that will be appended to the rendered <a /> tag. */
-    children?: React.ReactNode;
-}
-export declare const File: React.FC<FileProps>;
+import React from 'react';
+export interface FileFieldValue {
+    [propName: string]: unknown;
+    src?: string;
+    title?: string;
+    displayName?: string;
+}
+/**
+ * The interface for the File field.
+ * @public
+ */
+export interface FileField {
+    value: FileFieldValue;
+}
+export interface FileProps {
+    [attributeName: string]: unknown;
+    /** The file field data. */
+    field: FileFieldValue | FileField;
+    /** HTML attributes that will be appended to the rendered <a /> tag. */
+    children?: React.ReactNode;
+}
+/**
+ * The File component.
+ * @param {FileProps} props component props
+ * @public
+ */
+export declare const File: React.FC<FileProps>;
+//# sourceMappingURL=File.d.ts.map

package/types/components/File.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../src/components/File.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,WAAW,cAAc;IAC7B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,2BAA2B;IAC3B,KAAK,EAAE,cAAc,GAAG,SAAS,CAAC;IAClC,uEAAuE;IACvE,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;;;GAIG;AACH,eAAO,MAAM,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,SAAS,CAoBpC,CAAC"}

package/types/components/Form.d.ts

@@ -1,29 +1,35 @@
-import React from 'react';
-import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
-/**
- * Mock function to replace the form module functions for `testing` purposes.
- * @param {any} formModule - The form module to mock
- */
-export declare const mockFormModule: (formModule: any) => void;
-/**
- * Shape of the Form component rendering data.
- * FormId is the rendering parameter that specifies the ID of the Sitecore Form to render.
- */
-export type FormProps = {
-    rendering: ComponentRendering;
-    params: {
-        /**
-         * The ID of the Sitecore Form to render.
-         */
-        FormId: string;
-        /**
-         * CSS class to apply to the form
-         */
-        styles?: string;
-        /**
-         * The unique identifier of the rendering.
-         */
-        RenderingIdentifier?: string;
-    };
-};
-export declare const Form: ({ params, rendering }: FormProps) => React.JSX.Element;
+import React from 'react';
+import { ComponentRendering } from '@sitecore-content-sdk/core/layout';
+/**
+ * Mock function to replace the form module functions for `testing` purposes.
+ * @param {any} formModule - The form module to mock
+ */
+export declare const mockFormModule: (formModule: any) => void;
+/**
+ * Shape of the Form component rendering data.
+ * FormId is the rendering parameter that specifies the ID of the Sitecore Form to render.
+ */
+export type FormProps = {
+    rendering: ComponentRendering;
+    params: {
+        /**
+         * The ID of the Sitecore Form to render.
+         */
+        FormId: string;
+        /**
+         * CSS class to apply to the form
+         */
+        styles?: string;
+        /**
+         * The unique identifier of the rendering.
+         */
+        RenderingIdentifier?: string;
+    };
+};
+/**
+ * The Form component.
+ * @param {FormProps} props incoming props
+ * @public
+ */
+export declare const Form: ({ params, rendering }: FormProps) => React.JSX.Element;
+//# sourceMappingURL=Form.d.ts.map

package/types/components/Form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Form.d.ts","sourceRoot":"","sources":["../../src/components/Form.tsx"],"names":[],"mappings":"AACA,OAAO,KAAsC,MAAM,OAAO,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAOvE;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,YAAY,GAAG,SAI7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,MAAM,EAAE;QACN;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,IAAI,GAAI,uBAAuB,SAAS,sBAwDpD,CAAC"}

package/types/components/HiddenRendering.d.ts

@@ -1,2 +1,3 @@
-import React from 'react';
-export declare const HiddenRendering: () => React.JSX.Element;
+import React from 'react';
+export declare const HiddenRendering: () => React.JSX.Element;
+//# sourceMappingURL=HiddenRendering.d.ts.map

package/types/components/HiddenRendering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HiddenRendering.d.ts","sourceRoot":"","sources":["../../src/components/HiddenRendering.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAgB1B,eAAO,MAAM,eAAe,yBAK3B,CAAC"}

package/types/components/Image.d.ts

@@ -1,48 +1,70 @@
-import React from 'react';
-import { EditableFieldProps } from './sharedTypes';
-import { FieldMetadata } from '@sitecore-content-sdk/core/layout';
-export interface ImageFieldValue {
-    [attributeName: string]: unknown;
-    src?: string;
-}
-export interface ImageField {
-    value?: ImageFieldValue;
-}
-export interface ImageSizeParameters {
-    [attr: string]: string | number | undefined;
-    /** Fixed width of the image */
-    w?: number;
-    /** Fixed height of the image */
-    h?: number;
-    /** Max width of the image */
-    mw?: number;
-    /** Max height of the image */
-    mh?: number;
-    /** Ignore aspect ratio */
-    iar?: 1 | 0;
-    /** Allow stretch */
-    as?: 1 | 0;
-    /** Image scale. Defaults to 1.0 */
-    sc?: number;
-}
-export interface ImageProps extends EditableFieldProps<ImageProps> {
-    [attributeName: string]: unknown;
-    /** Image field data (consistent with other field types) */
-    field?: (ImageField | ImageFieldValue) & FieldMetadata;
-    /**
-     * Parameters that will be attached to Sitecore media URLs
-     */
-    imageParams?: {
-        [paramName: string]: string | number;
-    };
-    srcSet?: ImageSizeParameters[];
-    /**
-     * Custom regexp that finds media URL prefix that will be replaced by `/-/jssmedia` or `/~/jssmedia`.
-     * @example
-     * /\/([-~]{1})assets\//i
-     * /-assets/website -> /-/jssmedia/website
-     * /~assets/website -> /~/jssmedia/website
-     */
-    mediaUrlPrefix?: RegExp;
-}
-export declare const Image: React.FC<ImageProps>;
+import React from 'react';
+import { EditableFieldProps } from './sharedTypes';
+import { FieldMetadata } from '@sitecore-content-sdk/core/layout';
+/**
+ * The interface for the Image field value.
+ * @public
+ */
+export interface ImageFieldValue {
+    [attributeName: string]: unknown;
+    src?: string;
+}
+/**
+ * The interface for the Image field.
+ * @public
+ */
+export interface ImageField {
+    value?: ImageFieldValue;
+}
+/**
+ * The interface for the Image size parameters.
+ * @public
+ */
+export interface ImageSizeParameters {
+    [attr: string]: string | number | undefined;
+    /** Fixed width of the image */
+    w?: number;
+    /** Fixed height of the image */
+    h?: number;
+    /** Max width of the image */
+    mw?: number;
+    /** Max height of the image */
+    mh?: number;
+    /** Ignore aspect ratio */
+    iar?: 1 | 0;
+    /** Allow stretch */
+    as?: 1 | 0;
+    /** Image scale. Defaults to 1.0 */
+    sc?: number;
+}
+/**
+ * The interface for the Image component props.
+ * @public
+ */
+export interface ImageProps extends EditableFieldProps<ImageProps> {
+    [attributeName: string]: unknown;
+    /** Image field data (consistent with other field types) */
+    field?: (ImageField | ImageFieldValue) & FieldMetadata;
+    /**
+     * Parameters that will be attached to Sitecore media URLs
+     */
+    imageParams?: {
+        [paramName: string]: string | number;
+    };
+    srcSet?: ImageSizeParameters[];
+    /**
+     * Custom regexp that finds media URL prefix that will be replaced by `/-/jssmedia` or `/~/jssmedia`.
+     * @example
+     * /\/([-~]{1})assets\//i
+     * /-assets/website -> /-/jssmedia/website
+     * /~assets/website -> /~/jssmedia/website
+     */
+    mediaUrlPrefix?: RegExp;
+}
+/**
+ * The Image component.
+ * @param {ImageProps} props component props
+ * @public
+ */
+export declare const Image: React.FC<ImageProps>;
+//# sourceMappingURL=Image.d.ts.map

package/types/components/Image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Image.d.ts","sourceRoot":"","sources":["../../src/components/Image.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAGlE;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC;CAEd;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAC5C,+BAA+B;IAC/B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,6BAA6B;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0BAA0B;IAC1B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACZ,oBAAoB;IACpB,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACX,mCAAmC;IACnC,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,kBAAkB,CAAC,UAAU,CAAC;IAChE,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,2DAA2D;IAC3D,KAAK,CAAC,EAAE,CAAC,UAAU,GAAG,eAAe,CAAC,GAAG,aAAa,CAAC;IAEvD;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;KACtC,CAAC;IAEF,MAAM,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE/B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAGzB;AAmCD;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CA+BtC,CAAC"}

package/types/components/Link.d.ts

@@ -1,27 +1,45 @@
-import React, { RefAttributes } from 'react';
-import { FieldMetadata } from '@sitecore-content-sdk/core/layout';
-import { EditableFieldProps } from './sharedTypes';
-export interface LinkFieldValue {
-    [attributeName: string]: unknown;
-    href?: string;
-    className?: string;
-    class?: string;
-    title?: string;
-    target?: string;
-    text?: string;
-    anchor?: string;
-    querystring?: string;
-    linktype?: string;
-}
-export interface LinkField {
-    value: LinkFieldValue;
-}
-export type LinkProps = EditableFieldProps<LinkProps> & React.AnchorHTMLAttributes<HTMLAnchorElement> & RefAttributes<HTMLAnchorElement> & {
-    /** The link field data. */
-    field: (LinkField | LinkFieldValue) & FieldMetadata;
-    /**
-     * Displays a link text ('description' in Sitecore) even when children exist
-     */
-    showLinkTextWithChildrenPresent?: boolean;
-};
-export declare const Link: React.FC<LinkProps>;
+import React, { RefAttributes } from 'react';
+import { FieldMetadata } from '@sitecore-content-sdk/core/layout';
+import { EditableFieldProps } from './sharedTypes';
+/**
+ * The interface for the Link field value.
+ * @public
+ */
+export interface LinkFieldValue {
+    [attributeName: string]: unknown;
+    href?: string;
+    className?: string;
+    class?: string;
+    title?: string;
+    target?: string;
+    text?: string;
+    anchor?: string;
+    querystring?: string;
+    linktype?: string;
+}
+/**
+ * The interface for the Link field.
+ * @public
+ */
+export interface LinkField {
+    value: LinkFieldValue;
+}
+/**
+ * The interface for the Link component props.
+ * @public
+ */
+export type LinkProps = EditableFieldProps<LinkProps> & React.AnchorHTMLAttributes<HTMLAnchorElement> & RefAttributes<HTMLAnchorElement> & {
+    /** The link field data. */
+    field: (LinkField | LinkFieldValue) & FieldMetadata;
+    /**
+     * Displays a link text ('description' in Sitecore) even when children exist
+     */
+    showLinkTextWithChildrenPresent?: boolean;
+};
+/**
+ * The Link component.
+ * @param {LinkProps} props component props
+ * @public
+ */
+export declare const Link: React.FC<LinkProps>;
+//# sourceMappingURL=Link.d.ts.map

package/types/components/Link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Link.d.ts","sourceRoot":"","sources":["../../src/components/Link.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,EAAE,aAAa,EAAc,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,aAAa,EAAqB,MAAM,mCAAmC,CAAC;AAIrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,cAAc,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,GACnD,KAAK,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,GAC7C,aAAa,CAAC,iBAAiB,CAAC,GAAG;IACjC,2BAA2B;IAC3B,KAAK,EAAE,CAAC,SAAS,GAAG,cAAc,CAAC,GAAG,aAAa,CAAC;IAEpD;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;CAC3C,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,SAAS,CAoDpC,CAAC"}