scrivito/src/scrivito_sdk/data/find_widget_placement.ts

Scrivito is a professional, yet easy to use SaaS Enterprise Content Management Service, built for digital agencies and medium to large businesses. It is completely maintenance-free, cost-effective, and has unprecedented performance and security.

import {
  AttributeJson,
  ExistentObjJson,
  WidgetJson,
  isWidgetAttributeJson,
  isWidgetlistAttributeJson,
} from 'scrivito_sdk/client';
import { isSystemAttribute } from 'scrivito_sdk/common';

export interface WidgetPlacement {
  attributeName: string;
  attributeType: 'widgetlist' | 'widget';
  index: number;
  parentWidgetId?: string;
}

export function findWidgetPlacement(
  objData: ExistentObjJson,
  widgetId: string
): WidgetPlacement | undefined {
  let placement = findWidgetPlacementIn(objData, widgetId);

  if (placement) return placement;

  const widgetPool = objData._widget_pool;
  if (!widgetPool) return placement;

  Object.keys(widgetPool).find((parentWidgetId) => {
    const parentWidgetData = widgetPool[parentWidgetId];
    if (parentWidgetData) {
      placement = findWidgetPlacementIn(parentWidgetData, widgetId);

      if (placement) {
        placement.parentWidgetId = parentWidgetId;

        return true;
      }
    }
    return false;
  });

  return placement;
}

function findWidgetPlacementIn(
  objOrWidgetData: ExistentObjJson | WidgetJson,
  widgetId: string
): WidgetPlacement | undefined {
  let placement;

  Object.keys(objOrWidgetData).find((attributeName) => {
    const jsonValue = objOrWidgetData[attributeName];
    if (!jsonValue) return false;

    if (isSystemAttribute(attributeName)) return false;

    // Typescript cannot know that once blank and system attribute entries
    // are excluded, what's left must be a custom attribute entry, and the
    // cast is therefore safe.
    const attributeJson = jsonValue as AttributeJson;

    if (
      !isWidgetAttributeJson(attributeJson) &&
      !isWidgetlistAttributeJson(attributeJson)
    ) {
      return false;
    }

    const attributeValue = attributeJson[1];

    if (Array.isArray(attributeValue)) {
      const widgetIds = attributeJson[1];
      if (!widgetIds) return false;

      const index = widgetIds.indexOf(widgetId);

      if (index !== -1) {
        placement = { attributeName, attributeType: 'widgetlist', index };
        return true;
      }
    } else {
      if (widgetId === attributeValue) {
        placement = { attributeName, attributeType: 'widget', index: 0 };
        return true;
      }
    }

    return false;
  });

  return placement;
}