@oarepo/invenio-vue/library/invenio/types.d.ts

Vue 3 library for handling invenio REST

import { Http, HttpError, HttpLoadOptions, HttpOptions } from '../http';
import { Ref } from "vue";
import { SWRVCache } from "swrv";
import { NullableProps } from "../types";
export interface JsonType {
    [key: string]: string | null | number | boolean | JsonType;
}
declare enum JsonDateTimeBrand {
}
export declare type JsonDateTime = string & JsonDateTimeBrand;
export declare type FacetDefinition = JsonType;
export declare type FacetDefinitions = Record<string, FacetDefinition>;
export declare type Facet = JsonType;
export interface InvenioCollectionRecord<CollectionRecord> {
    metadata: CollectionRecord;
    links: {
        self: string;
        [key: string]: string;
    };
    revision: number;
    created: JsonDateTime;
    updated: JsonDateTime;
    id: string;
}
export declare type InvenioCollectionRecordList<CollectionRecord> = Array<InvenioCollectionRecord<CollectionRecord>>;
export interface PaginatedInvenioCollection<CollectionRecord> {
    hits: {
        hits: InvenioCollectionRecord<CollectionRecord>[];
        total: number | {
            value: number;
            relation: "eq" | "gte";
        };
    };
    links: {
        "self": "string";
        "next": "string";
        "previous": "string";
    };
    aggregations: any;
}
export interface InvenioCollectionHttpOptions {
    facets: FacetDefinition[];
    filters: any[];
}
/**
 * options on invenio collection
 */
export declare type InvenioCollectionOptions<CollectionRecord, ErrorType extends HttpError> = {
    /**
     * a function that transforms a record. Can be used to implement custom logic on the record
     * before it is returned.
     *
     * @param record                  record to be shown
     */
    recordTransformer?: (record: InvenioCollectionRecord<CollectionRecord>, opts: {
        options: InvenioCollectionOptions<CollectionRecord, ErrorType>;
        collection: InvenioCollectionComposable<CollectionRecord, ErrorType>;
    }) => InvenioCollectionRecord<CollectionRecord>;
    /**
     * a function that transforms facets after they were fetched from the server
     *
     * @param facets                  facets
     */
    facetsTransformer?: (facets: Record<string, Facet>, opts: {
        options: InvenioCollectionOptions<CollectionRecord, ErrorType>;
        collection: InvenioCollectionComposable<CollectionRecord, ErrorType>;
    }) => Record<string, Facet>;
    /**
     * a function that transforms a facet definition. Can be used to add types to facets,
     * their labels etc.
     *
     * @param facetDefinition
     * @param opts
     */
    facetDefinitionTransformer?: (facetDefinitions: FacetDefinitions, opts: {
        options: InvenioCollectionOptions<CollectionRecord, ErrorType>;
        collection: InvenioCollectionComposable<CollectionRecord, ErrorType>;
    }) => FacetDefinitions;
    optionsCache?: SWRVCache<any>;
} & HttpOptions<PaginatedInvenioCollection<CollectionRecord>, ErrorType>;
export interface InvenioCollectionComposable<CollectionRecord, ErrorType extends HttpError> {
    load: (opts?: HttpLoadOptions) => void;
    loadFacets: (opts: HttpLoadOptions & {
        selectedFacets: string[];
    }) => void | Promise<any>;
    records: Ref<InvenioCollectionRecordList<CollectionRecord>>;
    stale: Ref<boolean>;
    loading: Ref<boolean>;
    loaded: Ref<boolean>;
    pages: Ref<number>;
    page: Ref<number>;
    pageSize: Ref<number>;
    recordsCount: Ref<number>;
    recordsCountString: Ref<string>;
    facetDefinitions: Ref<FacetDefinitions>;
    http: Http<PaginatedInvenioCollection<CollectionRecord>, ErrorType>;
    httpOptions: Http<InvenioCollectionHttpOptions, ErrorType>;
    httpFacets: Http<PaginatedInvenioCollection<CollectionRecord>, ErrorType>;
    setUrl: (url: string) => void;
}
export interface InvenioRecord<RecordMetadata> {
    metadata: RecordMetadata;
}
export declare type InvenioRecordOptions<Record, ErrorType extends HttpError> = {} & HttpOptions<InvenioRecord<Record>, ErrorType>;
export interface InvenioRecordComposable<RecordMetadata, ErrorType extends HttpError> {
    http: Http<InvenioRecord<RecordMetadata>, ErrorType>;
    metadata: Ref<RecordMetadata | undefined>;
    setUrl: (url: string) => void;
    createModel: () => Ref<NullableProps<RecordMetadata>>;
    releaseModel: () => void;
}
export {};