@craftercms/studio-ui/utils/model.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import ContentInstance from '../models/ContentInstance';
import LookupTable from '../models/LookupTable';
import { ModelHierarchyMap } from './content';
export declare function prop(model: ContentInstance, propName: string): string;
export declare function value(model: ContentInstance, fieldId: string, newValue?: unknown): any;
export declare function extractCollection(model: ContentInstance, fieldId: string, index: string | number): string[];
export declare function extractCollectionItem(model: ContentInstance, fieldId: string, index: string | number): any;
export declare function getContentTypeId(model: ContentInstance): string;
export declare function isEmbedded(model: ContentInstance): boolean;
export declare function extractCollectionPiece(model: ContentInstance, fieldId: string, index: string | number): any;
export declare function isInheritedField(model: ContentInstance, fieldId: string): boolean;
export declare function getModelIdFromInheritedField(
  model: ContentInstance,
  fieldId: string,
  modelIdByPath: LookupTable<string>
): string;
export declare function findParentModelId(
  modelId: string,
  hierarchyDescriptorLookup: ModelHierarchyMap,
  models: LookupTable<ContentInstance>
): string;