IF Commons GitHub

logical/props

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0003-anyfs-serve-logical FR-005

The properties of a resource and the multistatus that lists them. The live properties are the ones a store knows: the type, the length, the time, the entity tag (the revision, quoted), the content type, the name and the locks. A property a caller asks for and the server has not is answered 404 in its own part of the answer, as the protocol says. Dead properties are not stored: a request to set one is 403.

import { propfindRequest } from "./props.ts";
propfindRequest("").kind; // "ok": no body asks for every property

Source: commons/anyfs-serve/src/logical/props.ts

4 of 10 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

PropfindRequesttypeno test imports it
type PropfindRequest = { readonly kind: "allprop" } | { readonly kind: "propname" } | { readonly kind: "prop"; readonly names: readonly QName[] };

What a PROPFIND asks for: every property, the names of the properties, or a list of properties.

ResourceFactstypeno test imports it
type ResourceFacts = {
  readonly path: PosixPath;
  readonly collection: boolean;
  readonly size?: number;
  /** The revision, unquoted. */
  readonly etag?: string;
  /** An ISO instant. */
  readonly modified?: string;
  readonly locks: readonly Lock[];
};

What the server knows of a resource when it answers.

propfindRequestfunction
function propfindRequest(body: string, limits?: XmlLimits | undefined): Result<PropfindRequest, string>

The request of a PROPFIND body, or why it is not one. An empty body asks for every property.

Imported by 14 tests of the run (14 passed, 0 failed): the library's results

LIVE_PROPSconstno test imports it
const LIVE_PROPS: readonly string[]

The names of the live properties, in the order a listing shows them.

lockElementfunctionno test imports it
function lockElement(l: Lock, base?: string | undefined): XmlElement

The lock as the element a client reads it as.

propResponsefunction
function propResponse(facts: ResourceFacts, request: PropfindRequest, base: string): XmlElement

One response of a multistatus for a resource and a request.

Imported by 14 tests of the run (14 passed, 0 failed): the library's results

statusResponsefunctionno test imports it
function statusResponse(path: PosixPath, collection: boolean, status: 200 | 201 | 204 | 206 | 207 | 304 | 400 | 401 | 403 | 404 | 405 | 409 | 412 | 413 | 414 | 415 | 416 | 423 | 424 | 500 | 501 | 502 | 503, base: string): XmlElement

A response that names a resource and a status only: what a failed part of COPY, MOVE or DELETE says.

multistatusfunction
function multistatus(responses: readonly XmlElement[]): XmlElement

A multistatus of responses.

Imported by 14 tests of the run (14 passed, 0 failed): the library's results

ProppatchRequesttypeno test imports it
type ProppatchRequest = { readonly set: readonly QName[]; readonly remove: readonly QName[] };

What a PROPPATCH body asks: the names of the properties it sets and removes.

proppatchRequestfunction
function proppatchRequest(body: string, limits: XmlLimits): Result<ProppatchRequest, string>

The request of a PROPPATCH body, or why it is not one.

Imported by 14 tests of the run (14 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.