/
getAclServerResourceInfo.ts
56 lines (54 loc) · 2.35 KB
/
getAclServerResourceInfo.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
//
// Copyright Inrupt Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
// Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
import type { WithServerResourceInfo } from "../interfaces";
import type { DefaultOptions } from "../acp/type/DefaultOptions";
import { getResourceInfo } from "../resource/resource";
/**
* Retrieve the Server Resource Info of Resource expressing access control over
* another resource it is linked to. It applies in both ACP and WAC contexts:
* the Access Control Resource is discovered consistently using a Link header
* with `rel=acl`.
*
* @param {WithServerResourceInfo} resource The Resource for which ACL we want
* to retrieve the Server Resource Info.
* @param {DefaultOptions} options
* @returns The Server Resource Info if available, null otherwise.
* @since 1.19.0
*/
export async function getAclServerResourceInfo(
resource: WithServerResourceInfo,
options?: DefaultOptions,
): Promise<WithServerResourceInfo | null> {
if (typeof resource.internal_resourceInfo.aclUrl !== "string") {
return null;
}
try {
return await getResourceInfo(
resource.internal_resourceInfo.aclUrl,
options,
);
} catch {
// A WAC-governed resource may have a link to a non-existant ACL (by design).
// The absence of an ACL at the target URL is a useful information that is
// used by the universal API to pick between ACR and WAC.
return null;
}
}