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

package/dist/esm/layout/utils.js

@@ -1,102 +1,109 @@
-/**
- * @param {ComponentRendering | Fields} renderingOrFields the rendering or fields object to extract the field from
- * @param {string} fieldName the name of the field to extract
- * @param {T} [defaultValue] the default value to return if the field is not defined
- * @returns {Field | T} the field value or the default value if the field is not defined
- */
-// eslint-disable-next-line no-redeclare
-export function getFieldValue(renderingOrFields, fieldName, defaultValue) {
-    if (!renderingOrFields || !fieldName) {
-        return defaultValue;
-    }
-    const fields = renderingOrFields;
-    const field = fields[fieldName];
-    if (field && typeof field.value !== 'undefined') {
-        return field.value;
-    }
-    const rendering = renderingOrFields;
-    if (!rendering.fields ||
-        !rendering.fields[fieldName] ||
-        typeof rendering.fields[fieldName].value === 'undefined') {
-        return defaultValue;
-    }
-    return rendering.fields[fieldName].value;
-}
-/**
- * Gets rendering definitions in a given child placeholder under a current rendering.
- * @param {ComponentRendering} rendering
- * @param {string} placeholderName
- * @returns {ComponentRendering[]} child placeholder
- */
-export function getChildPlaceholder(rendering, placeholderName) {
-    if (!rendering ||
-        !placeholderName ||
-        !rendering.placeholders ||
-        !rendering.placeholders[placeholderName]) {
-        return [];
-    }
-    return rendering.placeholders[placeholderName];
-}
-/**
- * Returns a regular expression pattern for a dynamic placeholder name.
- * @param {string} placeholder Placeholder name with a dynamic segment (e.g. 'main-{*}')
- * @returns Regular expression pattern for the dynamic segment
- */
-export const getDynamicPlaceholderPattern = (placeholder) => {
-    return new RegExp(`^${placeholder.replace(/\{\*\}+/i, '\\d+')}$`);
-};
-/**
- * Checks if the placeholder name is dynamic.
- * @param {string} placeholder Placeholder name
- * @returns True if the placeholder name is dynamic
- */
-export const isDynamicPlaceholder = (placeholder) => placeholder.indexOf('{*}') !== -1;
-/**
- * The default value for an empty Date field.
- * This value is defined as a default one by .NET
- */
-export const EMPTY_DATE_FIELD_VALUE = '0001-01-01T00:00:00Z';
-/**
- * Determines if the passed in field object's value is empty.
- * @param {GenericFieldValue | Partial<Field>} field the field object.
- * Partial<T> type is used here because _field.value_ could be required or optional for the different field types
- */
-export function isFieldValueEmpty(field) {
-    const isImageFieldEmpty = (fieldValue) => !fieldValue.src;
-    const isFileFieldEmpty = (fieldValue) => !fieldValue.src;
-    const isLinkFieldEmpty = (fieldValue) => !fieldValue.href;
-    const isDateFieldEmpty = (fieldValue) => {
-        if (typeof fieldValue === 'string') {
-            return fieldValue === EMPTY_DATE_FIELD_VALUE;
-        }
-        else {
-            return !(typeof (fieldValue === null || fieldValue === void 0 ? void 0 : fieldValue.getMonth) === 'function' &&
-                !isNaN(fieldValue === null || fieldValue === void 0 ? void 0 : fieldValue.getMonth()));
-        }
-    };
-    const isEmpty = (fieldValue) => {
-        if (fieldValue === null || fieldValue === undefined) {
-            return true;
-        }
-        if (typeof fieldValue === 'object') {
-            return (isImageFieldEmpty(fieldValue) &&
-                isFileFieldEmpty(fieldValue) &&
-                isLinkFieldEmpty(fieldValue) &&
-                isDateFieldEmpty(fieldValue));
-        }
-        else if (typeof fieldValue === 'number' || typeof fieldValue === 'boolean') {
-            // Avoid returning true for 0 and false values
-            return false;
-        }
-        else {
-            return !fieldValue || isDateFieldEmpty(fieldValue);
-        }
-    };
-    if (!field)
-        return true;
-    const dynamicField = field;
-    if (dynamicField.value !== undefined) {
-        return isEmpty(dynamicField.value);
-    }
-    return isEmpty(field);
-}
+/**
+ * @param {ComponentRendering | Fields} renderingOrFields the rendering or fields object to extract the field from
+ * @param {string} fieldName the name of the field to extract
+ * @param {T} [defaultValue] the default value to return if the field is not defined
+ * @returns {Field | T} the field value or the default value if the field is not defined
+ * @public
+ */
+// eslint-disable-next-line no-redeclare
+export function getFieldValue(renderingOrFields, fieldName, defaultValue) {
+    if (!renderingOrFields || !fieldName) {
+        return defaultValue;
+    }
+    const fields = renderingOrFields;
+    const field = fields[fieldName];
+    if (field && typeof field.value !== 'undefined') {
+        return field.value;
+    }
+    const rendering = renderingOrFields;
+    if (!rendering.fields ||
+        !rendering.fields[fieldName] ||
+        typeof rendering.fields[fieldName].value === 'undefined') {
+        return defaultValue;
+    }
+    return rendering.fields[fieldName].value;
+}
+/**
+ * Gets rendering definitions in a given child placeholder under a current rendering.
+ * @param {ComponentRendering} rendering
+ * @param {string} placeholderName
+ * @returns {ComponentRendering[]} child placeholder
+ * @public
+ */
+export function getChildPlaceholder(rendering, placeholderName) {
+    if (!rendering ||
+        !placeholderName ||
+        !rendering.placeholders ||
+        !rendering.placeholders[placeholderName]) {
+        return [];
+    }
+    return rendering.placeholders[placeholderName];
+}
+/**
+ * Returns a regular expression pattern for a dynamic placeholder name.
+ * @param {string} placeholder Placeholder name with a dynamic segment (e.g. 'main-{*}')
+ * @returns Regular expression pattern for the dynamic segment
+ * @internal
+ */
+export const getDynamicPlaceholderPattern = (placeholder) => {
+    return new RegExp(`^${placeholder.replace(/\{\*\}+/i, '\\d+')}$`);
+};
+/**
+ * Checks if the placeholder name is dynamic.
+ * @param {string} placeholder Placeholder name
+ * @returns True if the placeholder name is dynamic
+ * @internal
+ */
+export const isDynamicPlaceholder = (placeholder) => placeholder.indexOf('{*}') !== -1;
+/**
+ * The default value for an empty Date field.
+ * This value is defined as a default one by .NET
+ * @internal
+ */
+export const EMPTY_DATE_FIELD_VALUE = '0001-01-01T00:00:00Z';
+/**
+ * Determines if the passed in field object's value is empty.
+ * @param {GenericFieldValue | Partial<Field>} field the field object.
+ * Partial<T> type is used here because _field.value_ could be required or optional for the different field types
+ * @returns True if the field value is empty
+ * @public
+ */
+export function isFieldValueEmpty(field) {
+    if (!field)
+        return true;
+    const isImageFieldEmpty = (fieldValue) => !fieldValue.src;
+    const isFileFieldEmpty = (fieldValue) => !fieldValue.src;
+    const isLinkFieldEmpty = (fieldValue) => !fieldValue.href;
+    const isDateFieldEmpty = (fieldValue) => {
+        if (typeof fieldValue === 'string') {
+            return fieldValue === EMPTY_DATE_FIELD_VALUE;
+        }
+        else {
+            return !(typeof (fieldValue === null || fieldValue === void 0 ? void 0 : fieldValue.getMonth) === 'function' &&
+                !isNaN(fieldValue === null || fieldValue === void 0 ? void 0 : fieldValue.getMonth()));
+        }
+    };
+    const isEmpty = (fieldValue) => {
+        if (fieldValue === null || fieldValue === undefined) {
+            return true;
+        }
+        if (typeof fieldValue === 'object') {
+            return (isImageFieldEmpty(fieldValue) &&
+                isFileFieldEmpty(fieldValue) &&
+                isLinkFieldEmpty(fieldValue) &&
+                isDateFieldEmpty(fieldValue));
+        }
+        else if (typeof fieldValue === 'number' || typeof fieldValue === 'boolean') {
+            // Avoid returning true for 0 and false values
+            return false;
+        }
+        else {
+            return !fieldValue || isDateFieldEmpty(fieldValue);
+        }
+    };
+    const dynamicField = field;
+    if (dynamicField.value !== undefined) {
+        return isEmpty(dynamicField.value);
+    }
+    return isEmpty(field);
+}

package/dist/esm/media/index.js

@@ -1,2 +1,2 @@
-import * as mediaApi from './media-api';
-export { mediaApi };
+import * as mediaApi from './media-api';
+export { mediaApi };

package/dist/esm/media/media-api.js

@@ -1,86 +1,90 @@
-import URL from 'url-parse';
-// finds the Sitecore media URL prefix
-const mediaUrlPrefixRegex = /\/([-~]{1})\/media\//i;
-/**
- * Get required query string params which should be merged with user params
- * @param {object} qs layout service parsed query string
- * @returns {object} requiredParams
- */
-export const getRequiredParams = (qs) => {
-    const { rev, db, la, vs, ts } = qs;
-    return { rev, db, la, vs, ts };
-};
-/**
- * Replace `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
- * Can use `mediaUrlPrefix` in order to use a custom prefix.
- * @param {string} url The URL to replace the media URL prefix in
- * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
- * @returns {string} The URL with the media URL prefix replaced
- */
-export const replaceMediaUrlPrefix = (url, mediaUrlPrefix = mediaUrlPrefixRegex) => {
-    const parsed = URL(url, {}, true);
-    const match = mediaUrlPrefix.exec(parsed.pathname);
-    if (match && match.length > 1) {
-        // regex will provide us with /-/ or /~/ type
-        parsed.set('pathname', parsed.pathname.replace(mediaUrlPrefix, `/${match[1]}/jssmedia/`));
-    }
-    return parsed.toString();
-};
-/**
- * Prepares a Sitecore media URL with `params` for use by the Content SDK media handler.
- * This is done by replacing `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
- * Provided `params` are used as the querystring parameters for the media URL.
- * Can use `mediaUrlPrefix` in order to use a custom prefix.
- * If no `params` are sent, the original media URL is returned.
- * @param {string} url The URL to prepare
- * @param {object} [params] The querystring parameters to use
- * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
- * @returns {string} The prepared URL
- */
-export const updateImageUrl = (url, params, mediaUrlPrefix = mediaUrlPrefixRegex) => {
-    if (!params || Object.keys(params).length === 0) {
-        // if params aren't supplied, no need to run it through Content SDK media handler
-        return url;
-    }
-    // polyfill node `global` in browser to workaround https://github.com/unshiftio/url-parse/issues/150
-    if (typeof window !== 'undefined' && !window.global) {
-        window.global = {};
-    }
-    const parsed = URL(replaceMediaUrlPrefix(url, mediaUrlPrefix), {}, true);
-    const requiredParams = getRequiredParams(parsed.query);
-    const query = Object.assign({}, params);
-    Object.entries(requiredParams).forEach(([key, param]) => {
-        if (param) {
-            query[key] = param;
-        }
-    });
-    parsed.set('query', query);
-    return parsed.toString();
-};
-/**
- * Receives an array of `srcSet` parameters that are iterated and used as parameters to generate
- * a corresponding set of updated Sitecore media URLs via @see updateImageUrl. The result is a comma-delimited
- * list of media URLs with respective dimension parameters.
- * @example
- * // returns '/ipsum.jpg?h=1000&w=1000 1000w, /ipsum.jpg?mh=250&mw=250 250w'
- * getSrcSet('/ipsum.jpg', [{ h: 1000, w: 1000 }, { mh: 250, mw: 250 } ])
- * More information about `srcSet`: {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img}
- * @param {string} url The URL to prepare
- * @param {Array} srcSet The array of parameters to use
- * @param {object} [imageParams] The querystring parameters to use
- * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
- * @returns {string} The prepared URL
- */
-export const getSrcSet = (url, srcSet, imageParams, mediaUrlPrefix) => {
-    return srcSet
-        .map((params) => {
-        const newParams = Object.assign(Object.assign({}, imageParams), params);
-        const imageWidth = newParams.w || newParams.mw;
-        if (!imageWidth) {
-            return null;
-        }
-        return `${updateImageUrl(url, newParams, mediaUrlPrefix)} ${imageWidth}w`;
-    })
-        .filter((value) => value)
-        .join(', ');
-};
+import URL from 'url-parse';
+// finds the Sitecore media URL prefix
+const mediaUrlPrefixRegex = /\/([-~]{1})\/media\//i;
+/**
+ * Get required query string params which should be merged with user params
+ * @param {object} qs layout service parsed query string
+ * @returns {object} requiredParams
+ * @public
+ */
+export const getRequiredParams = (qs) => {
+    const { rev, db, la, vs, ts } = qs;
+    return { rev, db, la, vs, ts };
+};
+/**
+ * Replace `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
+ * Can use `mediaUrlPrefix` in order to use a custom prefix.
+ * @param {string} url The URL to replace the media URL prefix in
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The URL with the media URL prefix replaced
+ * @public
+ */
+export const replaceMediaUrlPrefix = (url, mediaUrlPrefix = mediaUrlPrefixRegex) => {
+    const parsed = URL(url, {}, true);
+    const match = mediaUrlPrefix.exec(parsed.pathname);
+    if (match && match.length > 1) {
+        // regex will provide us with /-/ or /~/ type
+        parsed.set('pathname', parsed.pathname.replace(mediaUrlPrefix, `/${match[1]}/jssmedia/`));
+    }
+    return parsed.toString();
+};
+/**
+ * Prepares a Sitecore media URL with `params` for use by the Content SDK media handler.
+ * This is done by replacing `/~/media` or `/-/media` with `/~/jssmedia` or `/-/jssmedia`, respectively.
+ * Provided `params` are used as the querystring parameters for the media URL.
+ * Can use `mediaUrlPrefix` in order to use a custom prefix.
+ * If no `params` are sent, the original media URL is returned.
+ * @param {string} url The URL to prepare
+ * @param {object} [params] The querystring parameters to use
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The prepared URL
+ * @public
+ */
+export const updateImageUrl = (url, params, mediaUrlPrefix = mediaUrlPrefixRegex) => {
+    if (!params || Object.keys(params).length === 0) {
+        // if params aren't supplied, no need to run it through Content SDK media handler
+        return url;
+    }
+    // polyfill node `global` in browser to workaround https://github.com/unshiftio/url-parse/issues/150
+    if (typeof window !== 'undefined' && !window.global) {
+        window.global = {};
+    }
+    const parsed = URL(replaceMediaUrlPrefix(url, mediaUrlPrefix), {}, true);
+    const requiredParams = getRequiredParams(parsed.query);
+    const query = Object.assign({}, params);
+    Object.entries(requiredParams).forEach(([key, param]) => {
+        if (param) {
+            query[key] = param;
+        }
+    });
+    parsed.set('query', query);
+    return parsed.toString();
+};
+/**
+ * Receives an array of `srcSet` parameters that are iterated and used as parameters to generate
+ * a corresponding set of updated Sitecore media URLs via @see updateImageUrl. The result is a comma-delimited
+ * list of media URLs with respective dimension parameters.
+ * @example
+ * // returns '/ipsum.jpg?h=1000&w=1000 1000w, /ipsum.jpg?mh=250&mw=250 250w'
+ * getSrcSet('/ipsum.jpg', [{ h: 1000, w: 1000 }, { mh: 250, mw: 250 } ])
+ * More information about `srcSet`: {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img}
+ * @param {string} url The URL to prepare
+ * @param {Array} srcSet The array of parameters to use
+ * @param {object} [imageParams] The querystring parameters to use
+ * @param {RegExp} [mediaUrlPrefix] The regex to match the media URL prefix
+ * @returns {string} The prepared URL
+ * @public
+ */
+export const getSrcSet = (url, srcSet, imageParams, mediaUrlPrefix) => {
+    return srcSet
+        .map((params) => {
+        const newParams = Object.assign(Object.assign({}, imageParams), params);
+        const imageWidth = newParams.w || newParams.mw;
+        if (!imageWidth) {
+            return null;
+        }
+        return `${updateImageUrl(url, newParams, mediaUrlPrefix)} ${imageWidth}w`;
+    })
+        .filter((value) => value)
+        .join(', ');
+};

package/dist/esm/models.js

@@ -1 +1 @@
-export {};
+export {};