next-drupal/dist/drupal-FEHAxoLF.d.ts

Helpers for Next.js + Drupal.

import { J as JsonApiError, a as JsonApiLinks } from './jsonapi-errors-kdi3GZQy.js';

interface JsonApiResponse extends Record<string, any> {
    jsonapi?: {
        version: string;
        meta: Record<string, any>[];
    };
    data: Record<string, any>[];
    errors: JsonApiError[];
    meta: {
        count: number;
        [key: string]: any;
    };
    links?: JsonApiLinks;
    included?: Record<string, any>[];
}
interface JsonApiResourceBodyRelationship {
    data: {
        type: string;
        id: string;
    };
}
interface JsonApiCreateResourceBody {
    data: {
        type?: string;
        attributes?: Record<string, any>;
        relationships?: Record<string, JsonApiResourceBodyRelationship>;
    };
}
interface JsonApiCreateFileResourceBody {
    data: {
        type?: string;
        attributes: {
            type: string;
            field: string;
            filename: string;
            file: Buffer;
        };
    };
}
interface JsonApiUpdateResourceBody {
    data: {
        type?: string;
        id?: string;
        attributes?: Record<string, any>;
        relationships?: Record<string, JsonApiResourceBodyRelationship>;
    };
}
interface JsonApiResource extends Record<string, any> {
    id: string;
    type: string;
    langcode: string;
    status: boolean;
}
interface JsonApiResourceWithPath extends JsonApiResource {
    path: DrupalPathAlias;
}

interface DrupalBlock extends JsonApiResource {
    info: string;
}
interface DrupalFile extends JsonApiResource {
    drupal_internal__fid: string;
    changed: string;
    created: string;
    filename: string;
    uri: {
        value: string;
        url: string;
    };
    filesize: number;
    filemime: string;
    resourceIdObjMeta?: DrupalFileMeta;
}
interface DrupalFileMeta {
    alt?: string;
    title?: string;
    width: number;
    height: number;
}
interface DrupalMedia extends JsonApiResource {
    drupal_internal__mid: string;
    drupal_internal__vid: string;
    changed: string;
    created: string;
    name: string;
}
interface DrupalMenuItem {
    description: string;
    enabled: boolean;
    expanded: boolean;
    id: DrupalMenuItemId;
    menu_name: string;
    meta: Record<string, unknown>;
    options: Record<string, unknown>;
    parent: DrupalMenuItemId;
    provider: string;
    route: {
        name: string;
        parameters: Record<string, unknown>;
    };
    title: string;
    type: string;
    url: string;
    weight: string;
    items?: DrupalMenuItem[];
}
type DrupalMenuItemId = string;
interface DrupalNode extends JsonApiResourceWithPath {
    drupal_internal__nid: number;
    drupal_internal__vid: number;
    changed: string;
    created: string;
    title: string;
    default_langcode: boolean;
    sticky: boolean;
}
interface DrupalParagraph extends JsonApiResource {
    drupal_internal__id: number;
    drupal_internal__revision_id: number;
}
type DrupalPathAlias = {
    alias: string;
    pid: number;
    langcode: string;
};
interface DrupalSearchApiJsonApiResponse extends JsonApiResponse {
    meta: JsonApiResponse["meta"] & {
        facets?: DrupalSearchApiFacet[];
    };
}
interface DrupalSearchApiFacet {
    id: string;
    label?: string;
    path?: string;
    terms?: {
        url: string;
        values: {
            value: string;
            label: string;
            active?: boolean;
            count?: number;
        };
    }[];
}
interface DrupalTaxonomyTerm extends JsonApiResourceWithPath {
    drupal_internal__tid: string;
    changed: string;
    default_langcode: boolean;
    name: string;
    description: string;
    weight: number;
}
interface DrupalTranslatedPath {
    resolved: string;
    isHomePath: boolean;
    entity: {
        canonical: string;
        type: string;
        bundle: string;
        id: string;
        uuid: string;
        langcode?: string;
        path?: string;
    };
    label?: string;
    jsonapi?: {
        individual: string;
        resourceName: string;
        pathPrefix: string;
        basePath: string;
        entryPoint: string;
    };
    meta?: Record<string, unknown>;
    redirect?: {
        from: string;
        to: string;
        status: string;
    }[];
}
interface DrupalUser extends JsonApiResourceWithPath {
    drupal_internal__uid: string;
    changed: string;
    created: string;
    default_langcode: boolean;
    name: string;
}
interface DrupalView<T = Record<string, any>[]> {
    id: string;
    results: T;
    meta: JsonApiResponse["meta"];
    links: JsonApiResponse["links"];
}

export type { DrupalFile as D, JsonApiResource as J, JsonApiCreateResourceBody as a, JsonApiCreateFileResourceBody as b, JsonApiUpdateResourceBody as c, DrupalTranslatedPath as d, JsonApiResponse as e, DrupalMenuItem as f, DrupalView as g, DrupalMenuItemId as h, DrupalPathAlias as i, DrupalBlock as j, DrupalFileMeta as k, DrupalMedia as l, DrupalNode as m, DrupalParagraph as n, DrupalSearchApiJsonApiResponse as o, DrupalSearchApiFacet as p, DrupalTaxonomyTerm as q, DrupalUser as r, JsonApiResourceBodyRelationship as s, JsonApiResourceWithPath as t };