alcaeus-model
Version:
rdfine models for Alcaeus, Hydra client
74 lines • 8.28 kB
TypeScript
import type { Constructor, RdfResource } from '@tpluscode/rdfine';
import type { RdfResourceCore } from '@tpluscode/rdfine/RdfResource';
import type { DatasetCore } from '@rdfjs/types';
import type { Resource } from '@rdfine/hydra';
import type { HydraClient, HydraResponse } from 'alcaeus-core';
import type * as Supported from './Mixins/Operation.js';
export interface RuntimeOperation extends Supported.Operation {
/**
* Gets the title of the operation
*/
invoke<T extends RdfResourceCore = Resource>(body?: BodyInit, headers?: HeadersInit): Promise<HydraResponse<DatasetCore, T>>;
/**
* Gets the resource on which the operation will be invoked
*/
target: RdfResource;
}
export declare function createMixin(client: HydraClient, target: RdfResource): <Base extends Constructor<Supported.Operation>>(Resource: Base) => {
new (...input: any[]): {
readonly target: RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
invoke<T extends RdfResourceCore<any> = Resource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(body?: BodyInit, headers?: HeadersInit): Promise<HydraResponse<DatasetCore, T>>;
description: string | undefined;
expects: (Resource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Resource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/hydra").Class<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Class<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>)[];
expectsHeader: import("@rdfine/hydra").HeaderSpecification<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
expectsHeaderLiteral: string | undefined;
method: string | undefined;
possibleStatus: import("@rdfine/hydra").Status<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
returns: Resource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Resource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/hydra").Class<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Class<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
returnsHeader: import("@rdfine/hydra").HeaderSpecification<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
returnsHeaderLiteral: string | undefined;
title: string | undefined;
requiresInput: boolean;
readonly operations: 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: RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
}[];
getCollections(filter?: import("./Mixins/MemberAssertion.js").MemberAssertionPattern): RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[];
getOperationsDeep(condition?: import("./CoreMixins/OperationFinder.js").RecursiveStopConditions): RuntimeOperation[];
findOperations(...criteria: import("./CoreMixins/OperationFinder.js").Criteria[]): RuntimeOperation[];
findOperationsDeep(stopCondition: import("./CoreMixins/OperationFinder.js").RecursiveStopConditions, ...moreCriteria: import("./CoreMixins/OperationFinder.js").Criteria[]): RuntimeOperation[];
load?<T extends RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(headers?: HeadersInit): Promise<HydraResponse<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<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
readonly pointer: import("clownface").GraphPointer<import("@tpluscode/rdfine").ResourceIdentifier, DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
readonly unionGraphPointer: import("clownface").MultiPointer<import("@tpluscode/rdfine").ResourceIdentifier, DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
readonly _graphId: import("@rdfjs/types").Quad_Graph;
readonly _parent?: RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined;
readonly isAnonymous: boolean;
equals(other: RdfResource | import("@tpluscode/rdfine").ResourceIdentifier | import("clownface").GraphPointer | undefined | null): boolean;
hasType(type: string | import("@rdfjs/types").NamedNode): boolean;
get<T extends RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> = RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(property: string | import("@rdfjs/types").NamedNode): T;
get<T extends RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> = RdfResource<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 RdfResource<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> = RdfResource<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 RdfResourceCore = /*elided*/ any>(): import("@tpluscode/rdfine/lib/toJSON").Jsonified<RdfResource<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, DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>;
_create<T extends RdfResourceCore<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>(term: import("clownface").GraphPointer<import("@rdfjs/types").Term, 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<DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>, T> | undefined): T & import("@tpluscode/rdfine").ResourceIndexer<RdfResource<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;
} & Base;
//# sourceMappingURL=Operation.d.ts.map