alcaeus-model/Mixins/DocumentedResource.d.ts

rdfine models for Alcaeus, Hydra client

import type { Constructor } from '@tpluscode/rdfine';
import type { Resource } from '@rdfine/hydra';
declare module '@rdfine/hydra' {
    interface Resource {
        /**
             * Gets the value of either hydra:title or schema:title or rdfs:label property
             */
        title: string | undefined;
        /**
             * Gets the value of either hydra:description or schema:description or rdfs:comment property
             */
        description: string | undefined;
    }
}
export declare function DocumentedResourceMixin<TBase extends Constructor<Resource>>(Base: TBase): {
    new (...input: any[]): {
        __hydraTitle: string;
        __hydraDescription: string;
        __rdfsLabel: string;
        __rdfsComment: string;
        __schemaTitle: string;
        __schemaDescription: string;
        readonly description: string;
        readonly title: string;
        first: Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
        freetextQuery: string | undefined;
        last: Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
        next: Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
        operation: import("@rdfine/hydra").Operation<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
        previous: Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
        search: import("@rdfine/hydra").IriTemplate<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
        view: Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
        comment: string | undefined;
        isDefinedBy: import("@rdfine/rdfs").Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
        label: string | undefined;
        seeAlso: import("@rdfine/rdfs").Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
        readonly operations: import("../Operation.js").RuntimeOperation[];
        readonly apiDocumentation: import("@rdfine/hydra").ApiDocumentation | undefined;
        getProperties(options?: import("../CoreMixins/HydraResource.js").GetProperties): {
            supportedProperty: import("@rdfine/hydra").SupportedProperty;
            objects: any[];
        }[];
        getLinks(includeMissing?: boolean): {
            supportedProperty: import("@rdfine/hydra").SupportedProperty;
            resources: import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
        }[];
        getCollections(filter?: import("./MemberAssertion.js").MemberAssertionPattern): import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
        getOperationsDeep(condition?: import("../CoreMixins/OperationFinder.js").RecursiveStopConditions): import("../Operation.js").RuntimeOperation[];
        findOperations(...criteria: import("../CoreMixins/OperationFinder.js").Criteria[]): import("../Operation.js").RuntimeOperation[];
        findOperationsDeep(stopCondition: import("../CoreMixins/OperationFinder.js").RecursiveStopConditions, ...moreCriteria: import("../CoreMixins/OperationFinder.js").Criteria[]): import("../Operation.js").RuntimeOperation[];
        load?<T extends import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(headers?: HeadersInit): Promise<import("alcaeus-core").HydraResponse<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>, T>>;
        readonly env: import("@tpluscode/rdfine/environment").RdfineEnvironment;
        readonly id: import("@tpluscode/rdfine").ResourceIdentifier;
        readonly types: import("@tpluscode/rdfine/lib/TypeCollection").TypeCollection<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
        readonly pointer: import("clownface").GraphPointer<import("@tpluscode/rdfine").ResourceIdentifier, import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
        readonly unionGraphPointer: import("clownface").MultiPointer<import("@tpluscode/rdfine").ResourceIdentifier, import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
        readonly _graphId: import("@rdfjs/types").Quad_Graph;
        readonly _parent?: import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
        readonly isAnonymous: boolean;
        equals(other: import("@tpluscode/rdfine").RdfResource | import("@tpluscode/rdfine").ResourceIdentifier | import("clownface").GraphPointer | undefined | null): boolean;
        hasType(type: string | import("@rdfjs/types").NamedNode): boolean;
        get<T extends import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> = import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(property: string | import("@rdfjs/types").NamedNode): T;
        get<T extends import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> = import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): T | null;
        getArray<T extends import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> = import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): T[];
        getBoolean(property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): boolean;
        getString(property: string | import("@rdfjs/types").NamedNode): string;
        getString(property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): string | null;
        getNumber(property: string | import("@rdfjs/types").NamedNode): number | null;
        getNumber(property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): number | null;
        toJSON<T extends import("@tpluscode/rdfine/RdfResource").RdfResourceCore = /*elided*/ any>(): import("@tpluscode/rdfine/lib/toJSON").Jsonified<import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> & T>;
        _getObjects(property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): import("clownface").MultiPointer<import("@rdfjs/types").Term, import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
        _create<T extends import("@tpluscode/rdfine/RdfResource").RdfResourceCore<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(term: import("clownface").GraphPointer<import("@rdfjs/types").Term, import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>, mixins?: import("@tpluscode/rdfine/lib/ResourceFactory").Mixin[] | [Constructor, ...import("@tpluscode/rdfine/lib/ResourceFactory").Mixin[]], options?: import("@tpluscode/rdfine/lib/ResourceFactory").ResourceCreationOptions<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>, T> | undefined): T & import("@tpluscode/rdfine").ResourceIndexer<import("@tpluscode/rdfine").RdfResource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>;
        collection: import("@rdfine/hydra").Collection<Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>, import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
    };
    __mixins: import("@tpluscode/rdfine/lib/ResourceFactory").Mixin[];
    __properties: Map<string, import("@tpluscode/rdfine/lib/decorators/property/decoratorFactory").PropertyMeta>;
    __initializers: Map<string, unknown>;
    __ns?: import("@rdfjs/namespace").NamespaceBuilder;
} & TBase;
export declare namespace DocumentedResourceMixin {
    var appliesTo: import("@rdfjs/types").NamedNode<string> & import("@rdfjs/types").NamedNode<"http://www.w3.org/ns/hydra/core#Resource">;
}
//# sourceMappingURL=DocumentedResource.d.ts.map