UNPKG

alcaeus-model

Version:

rdfine models for Alcaeus, Hydra client

72 lines 9 kB
import type { Operation } from '@rdfine/hydra'; import type { Constructor } from '@tpluscode/rdfine'; declare module '@rdfine/hydra' { interface Operation { requiresInput: boolean; } } export type { Operation } from '@rdfine/hydra'; export declare function OperationMixin<TBase extends Constructor<Omit<Operation, 'requiresInput'>>>(Base: TBase): ((abstract new (...input: any[]) => { method: string; readonly requiresInput: boolean; readonly apiDocumentation: import("@rdfine/hydra").ApiDocumentation | undefined; description: string | undefined; expects: (import("@rdfine/hydra").Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/hydra").Class<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Class<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>)[]; expectsHeader: import("@rdfine/hydra").HeaderSpecification<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined; possibleStatus: import("@rdfine/hydra").Status<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>[]; returns: import("@rdfine/hydra").Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Resource<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/hydra").Class<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | import("@rdfine/rdfs").Class<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined; returnsHeader: import("@rdfine/hydra").HeaderSpecification<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>> | undefined; title: string | undefined; expectsHeaderLiteral: string | undefined; returnsHeaderLiteral: string | undefined; readonly operations: import("../Operation.js").RuntimeOperation[]; 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>>) | undefined; 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; <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; (property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): string | null; }; getNumber: { (property: string | import("@rdfjs/types").NamedNode): number | null; (property: string | import("@rdfjs/types").NamedNode, options?: import("@tpluscode/rdfine/RdfResource").GetOptions): number | null; }; toJSON: <T extends import("@tpluscode/rdfine/RdfResource").RdfResourceCore = Operation<import("@rdfjs/types").DatasetCore<import("@rdfjs/types").Quad, import("@rdfjs/types").Quad>>>() => 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>>>; }) & { __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 OperationMixin { var appliesTo: import("@rdfjs/types").NamedNode<string> & import("@rdfjs/types").NamedNode<"http://www.w3.org/ns/hydra/core#Operation">; } //# sourceMappingURL=Operation.d.ts.map