/
getAgentAccess.ts
66 lines (62 loc) · 3.08 KB
/
getAgentAccess.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
57
58
59
60
61
62
63
64
65
66
//
// 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 { AccessModes, UrlString, WebId } from "../interfaces";
import type { DefaultOptions } from "../acp/type/DefaultOptions";
import { getResourceInfo } from "../resource/resource";
import { getAgentAccess as getAgentAccessAcp } from "../acp/util/getAgentAccess";
import { getAgentAccess as getAgentAccessWac } from "../access/wac";
import { getResourceAcr } from "../acp/util/getResourceAcr";
/**
* Get an overview of what access is defined for a given Agent.
*
* This function works with Solid Pods that implement either the Web Access
* Control spec or the Access Control Policies proposal, with some caveats:
*
* - If access to the given Resource has been set using anything other than the
* functions in this module, it is possible that it has been set in a way that
* prevents this function from reliably reading access.
* - It will only return access specified explicitly for the given Agent within
* the ACL linked to the resource. If additional restrictions or external
* resources are used, those will not be reflected in the return value of this
* function.
* - It will only return access specified explicitly for the given Resource.
* In other words, if the Resource is a Container, the returned Access may not
* apply to contained Resources.
* - If the current user does not have permission to view access for the given
* Resource, this function will resolve to `null`.
*
* @param resourceUrl URL of the Resource you want to read the access for.
* @param webId WebID of the Agent you want to get the access for.
* @param options Default Options such as a fetch function.
* @since 1.19.0
*/
export async function getAgentAccess(
resourceUrl: UrlString,
webId: WebId,
options?: DefaultOptions,
): Promise<AccessModes | null> {
const resourceInfo = await getResourceInfo(resourceUrl, options);
const acr = await getResourceAcr(resourceInfo, options);
if (acr === null) {
return getAgentAccessWac(resourceInfo, webId, options);
}
return getAgentAccessAcp(acr, webId);
}