UNPKG

@inrupt/solid-client

Version:

Make your web apps work with Solid Pods.

73 lines (71 loc) 5.05 kB
export { getFileWithAccessDatasets, getFileWithAcr, getLinkedAcrUrl, getReferencedPolicyUrlAll, getResourceInfoWithAccessDatasets, getResourceInfoWithAcr, getSolidDatasetWithAccessDatasets, getSolidDatasetWithAcr, hasAccessibleAcr, isAcpControlled, saveAcrFor } from './acp.mjs'; export { hasLinkedAcr, removeAcrPolicyUrlAll, removeMemberAcrPolicyUrlAll, removeMemberPolicyUrlAll, removePolicyUrlAll } from './control.mjs'; export { addAcrPolicyUrl } from './policy/addAcrPolicyUrl.mjs'; export { addMemberAcrPolicyUrl } from './policy/addMemberAcrPolicyUrl.mjs'; export { addMemberPolicyUrl } from './policy/addMemberPolicyUrl.mjs'; export { addPolicyUrl } from './policy/addPolicyUrl.mjs'; export { getAcrPolicyUrlAll } from './policy/getAcrPolicyUrlAll.mjs'; export { getMemberAcrPolicyUrlAll } from './policy/getMemberAcrPolicyUrlAll.mjs'; export { getMemberPolicyUrlAll } from './policy/getMemberPolicyUrlAll.mjs'; export { getPolicyUrlAll } from './policy/getPolicyUrlAll.mjs'; export { removeAcrPolicyUrl } from './policy/removeAcrPolicyUrl.mjs'; export { removeMemberAcrPolicyUrl } from './policy/removeMemberAcrPolicyUrl.mjs'; export { removeMemberPolicyUrl } from './policy/removeMemberPolicyUrl.mjs'; export { removePolicyUrl } from './policy/removePolicyUrl.mjs'; export { setResourcePolicy } from './policy/setResourcePolicy.mjs'; export { createPolicy, createResourcePolicyFor, getAllowModesV2 as getAllowModes, getDenyModesV2 as getDenyModes, getPolicy, getPolicyAll, getResourceAcrPolicy, getResourceAcrPolicyAll, getResourcePolicy, getResourcePolicyAll, removePolicy, removeResourceAcrPolicy, removeResourcePolicy, setAllowModesV2 as setAllowModes, setDenyModesV2 as setDenyModes, setPolicy } from './policy.mjs'; export { addAgent, addAllOfMatcherUrl, addAnyOfMatcherUrl, addClient, addNoneOfMatcherUrl, createMatcher, createResourceMatcherFor, getAgentAll, getAllOfMatcherUrlAll, getAnyOfMatcherUrlAll, getClientAll, getMatcher, getMatcherAll, getNoneOfMatcherUrlAll, getResourceMatcher, getResourceMatcherAll, hasAuthenticated, hasCreator, hasPublic, removeAgent, removeAllOfMatcherUrl, removeAnyOfMatcherUrl, removeAuthenticated, removeClient, removeCreator, removeMatcher, removeNoneOfMatcherUrl, removePublic, removeResourceMatcher, setAgent, setAllOfMatcherUrl, setAnyOfMatcherUrl, setAuthenticated, setCreator, setMatcher, setNoneOfMatcherUrl, setPublic, setResourceMatcher } from './matcher.mjs'; export { addMockAcrTo, mockAcrFor } from './mock.mjs'; export { getVcAccess } from './util/getVcAccess.mjs'; export { setVcAccess } from './util/setVcAccess.mjs'; // 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. // /** * :::{admonition} Experimental API * :class: important * * The Access Control Policies proposal has not yet been reviewed for inclusion in the Solid spec. * To enable early experimentation, solid-client exposes a low-level API. However, this API can and * will include breaking changes in non-major releases. Additionally, for most applications, a * higher-level API that is planned will be more applicable. * * Thus, the following export is *only* intended for experimentation by early adopters, and is not * recommended for production applications. Because of this, all ACP-related API's are exported on a * single object, which does not facilitate tree-shaking: if you use one ACP-related API, all of * them will be included in your bundle. * * For more information see: [Tutorial: Managing * Access](https://docs.inrupt.com/sdk/javascript-sdktutorial/manage-access/) * ::: * * This module supports Inrupt's ESS 2.0 ACP implementation. * * This module can be imported as an object from the main package, which results * in tree-shaking not being supported (so all the exported APIs will likely end * up in your bundle). This import style is used for environments such as nextjs * or create-react-app. * * ```typescript * import { acp_ess_2 } from "@inrupt/solid-client"; * ``` * * @packageDocumentation * @module acp_ess_2 */