UNPKG

1.39 kBTypeScriptView Raw
1import { CollectionProp, DefaultElements, EntityMetaSysProps, KeyValueMap, MakeRequest, MetadataProps } from '../common-types';
2import { ContentfulEntryApi } from '../create-entry-api';
3import { AssetProps } from './asset';
4export declare type EntryProps<T = KeyValueMap> = {
5 sys: EntityMetaSysProps;
6 metadata?: MetadataProps;
7 fields: T;
8};
9export declare type CreateEntryProps<TFields = KeyValueMap> = Omit<EntryProps<TFields>, 'sys'>;
10export interface EntryReferenceProps extends CollectionProp<EntryProps> {
11 includes?: {
12 Entry?: EntryProps[];
13 Asset?: AssetProps[];
14 };
15}
16export declare type EntryReferenceOptionsProps = {
17 /**
18 * @deprecated use `include` param instead
19 */
20 maxDepth?: number;
21 include?: number;
22};
23export interface Entry extends EntryProps, DefaultElements<EntryProps>, ContentfulEntryApi {
24}
25/**
26 * @private
27 * @param makeRequest - function to make requests via an adapter
28 * @param data - Raw entry data
29 * @return Wrapped entry data
30 */
31export declare function wrapEntry(makeRequest: MakeRequest, data: EntryProps): Entry;
32/**
33 * Data is also mixed in with link getters if links exist and includes were requested
34 * @private
35 */
36export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap>>;