scrivito/src/scrivito_sdk/realm/assert_valid_extract_text_attributes.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 { ArgumentError } from 'scrivito_sdk/common';
import { BasicTypeInfo, CmsAttributeType } from 'scrivito_sdk/models';
import { Schema } from './schema';

const ATTRIBUTE_TYPES_WHITELIST = ['string', 'html', 'widget', 'widgetlist'];

export function assertValidObjExtractTextAttributes(schema: Schema): void {
  schema.extractTextAttributes().forEach((attribute) => {
    if (attribute.substring(0, 5) === 'blob:') {
      return assertValidBinaryAttribute(schema, attribute);
    }
    assertValidExtractTextAttribute(attribute, schema.attribute(attribute));
  });
}

export function assertValidWidgetExtractTextAttributes(schema: Schema): void {
  schema.extractTextAttributes().forEach((attribute) => {
    if (attribute.substring(0, 5) === 'blob:') {
      throw new ArgumentError(
        `Invalid value for "extractTextAttributes": ${attribute} is not supported.`
      );
    }
    assertValidExtractTextAttribute(attribute, schema.attribute(attribute));
  });
}

function assertValidBinaryAttribute(
  schema: Schema,
  extractTextAttribute: string
): void {
  if (extractTextAttribute === 'blob:text') {
    if (schema.isBinary()) return;

    throw new ArgumentError(
      'Invalid value for "extractTextAttributes": blob:text is only supported for binary objs.'
    );
  }

  throw new ArgumentError(
    `Invalid value for "extractTextAttributes": ${extractTextAttribute} is not supported.`
  );
}

function assertValidExtractTextAttribute(
  attribute: string,
  definition: BasicTypeInfo<CmsAttributeType> | undefined
): void {
  if (!definition) {
    throw new ArgumentError(
      `Invalid value for "extractTextAttributes": Attribute ${attribute} is not defined.`
    );
  }

  const [attributeType] = definition;
  if (ATTRIBUTE_TYPES_WHITELIST.includes(attributeType)) return;

  throw new ArgumentError(
    `Invalid value for "extractTextAttributes": Attribute ${attribute} of type ${attributeType} is not supported.`
  );
}