@inrupt/solid-client
Version:
Make your web apps work with Solid Pods.
93 lines (92 loc) • 7.8 kB
TypeScript
/**
* Copyright 2020 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.
*/
export { isContainer, isRawData, getSourceUrl, getSourceIri, getContentType, getResourceInfo, getPodOwner, isPodOwner, FetchError, } from "./resource/resource";
export { getFile, deleteFile, saveFileInContainer, overwriteFile, } from "./resource/file";
export { createSolidDataset, getSolidDataset, saveSolidDatasetAt, deleteSolidDataset, createContainerAt, saveSolidDatasetInContainer, createContainerInContainer, deleteContainer, getContainedResourceUrlAll, solidDatasetAsMarkdown, changeLogAsMarkdown, } from "./resource/solidDataset";
export { mockSolidDatasetFrom, mockContainerFrom, mockFileFrom, mockFetchError, } from "./resource/mock";
export { getThing, getThingAll, setThing, removeThing, createThing, isThing, asUrl, asIri, thingAsMarkdown, ThingExpectedError, } from "./thing/thing";
export { getUrl, getIri, getBoolean, getDatetime, getDecimal, getInteger, getStringWithLocale, getStringNoLocale, getUrlAll, getIriAll, getBooleanAll, getDatetimeAll, getDecimalAll, getIntegerAll, getStringWithLocaleAll, getStringByLocaleAll, getStringNoLocaleAll, getLiteral, getNamedNode, getTerm, getLiteralAll, getNamedNodeAll, getTermAll, } from "./thing/get";
export { addUrl, addIri, addBoolean, addDatetime, addDecimal, addInteger, addStringWithLocale, addStringNoLocale, addLiteral, addNamedNode, addTerm, } from "./thing/add";
export { setUrl, setIri, setBoolean, setDatetime, setDecimal, setInteger, setStringWithLocale, setStringNoLocale, setLiteral, setNamedNode, setTerm, } from "./thing/set";
export { removeAll, removeUrl, removeIri, removeBoolean, removeDatetime, removeDecimal, removeInteger, removeStringWithLocale, removeStringNoLocale, removeLiteral, removeNamedNode, } from "./thing/remove";
export { mockThingFrom } from "./thing/mock";
export { hasAcl, hasFallbackAcl, getFallbackAcl, hasResourceAcl, getResourceAcl, getSolidDatasetWithAcl, getFileWithAcl, getResourceInfoWithAcl, createAcl, createAclFromFallbackAcl, saveAclFor, deleteAclFor, hasAccessibleAcl, WithAccessibleAcl, WithAcl, WithFallbackAcl, WithResourceAcl, AclDataset, AclRule as internal_AclRule, Access, } from "./acl/acl";
export { AgentAccess, getAgentAccess, getAgentAccessAll, getAgentResourceAccess, getAgentResourceAccessAll, setAgentResourceAccess, getAgentDefaultAccess, getAgentDefaultAccessAll, setAgentDefaultAccess, } from "./acl/agent";
export { getGroupAccess, getGroupAccessAll, getGroupResourceAccess, getGroupResourceAccessAll, getGroupDefaultAccess, getGroupDefaultAccessAll, setGroupDefaultAccess, setGroupResourceAccess, } from "./acl/group";
export { getPublicAccess, getPublicResourceAccess, getPublicDefaultAccess, setPublicResourceAccess, setPublicDefaultAccess, } from "./acl/class";
export { addMockResourceAclTo, addMockFallbackAclTo } from "./acl/mock";
export { Url, Iri, UrlString, IriString, WebId, SolidDataset, Thing, ThingPersisted, ThingLocal, LocalNode, hasResourceInfo, hasServerResourceInfo, WithResourceInfo, WithChangeLog, UploadRequestInit, SolidClientError, } from "./interfaces";
/**
* 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.
* @deprecated Replaced by [[acp_v2]].
*/
export { acp_v1 } from "./acp/v1";
/**
* 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.
* @deprecated Replaced by [[acp_v3]].
*/
export { acp_v2 } from "./acp/v2";
/**
* 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.
* @deprecated Please import directly from the "acp/*" modules.
*/
export { acp_v3 } from "./acp/v3";
/**
* This API is still experimental, and subject to change. It builds on top of both
* ACP and ACL, aiming at being adaptable to any Access Control system that may be
* implemented in Solid. That is why it is purely Resource-centric: the library
* discovers metadata associated to the Resource itself, and calls the appropriate
* underlying API to deal with the Access Control in place for the target Resource.
*
* As it is still under development, the following export is *only* intended for experimentation
* by early adopters, and is not recommended yet for production applications. Because
* of this, all of the Access-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.
*
* Note that the following object is exposed to be available for environments not
* supporting export maps. For developers using Node 12+, Webpack 5+, or any tool
* or environment with support for export maps, we recommend you import these
* functions directly from @inrupt/solid-client/access/universal.
* @deprecated Please import directly from the "access/universal" module.
*/
export * as access from "./access/universal";