You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
85 lines
2.8 KiB
85 lines
2.8 KiB
import { namedNode } from "@rdfjs/data-model";
|
|
import { guaranteeFetch } from "../../util/guaranteeFetch";
|
|
import { deleteResourceRdfFromContainer } from "../../util/rdfUtils";
|
|
import { UnexpectedResourceError } from "../results/error/ErrorResult";
|
|
import type { HttpErrorResultType } from "../results/error/HttpErrorResult";
|
|
import { UnexpectedHttpError } from "../results/error/HttpErrorResult";
|
|
import { HttpErrorResult } from "../results/error/HttpErrorResult";
|
|
import type { DeleteSuccess } from "../results/success/DeleteSuccess";
|
|
import type { DatasetRequestOptions } from "./requestOptions";
|
|
|
|
/**
|
|
* All possible return values for deleteResource
|
|
*/
|
|
export type DeleteResult = DeleteSuccess | DeleteResultError;
|
|
|
|
/**
|
|
* All possible errors that can be returned by deleteResource
|
|
*/
|
|
export type DeleteResultError = HttpErrorResultType | UnexpectedResourceError;
|
|
|
|
/**
|
|
* Deletes a resource on a Pod at a given URL.
|
|
*
|
|
* @param uri - The URI for the resource that should be deleted
|
|
* @param options - Options to provide a fetch function and a local dataset to
|
|
* update.
|
|
* @returns a DeleteResult
|
|
*
|
|
* @example
|
|
* `deleteResource` will send a request to a Solid Pod using the provided fetch
|
|
* function. A local dataset can also be provided. It will be updated with any
|
|
* new information from the delete.
|
|
*
|
|
* ```typescript
|
|
* import { deleteResource } from "@ldo/solid";
|
|
* import { createDataset } from "@ldo/dataset"
|
|
* import { fetch } from "@inrupt/solid-client-autn-js";
|
|
*
|
|
* const localDataset = createDataset();
|
|
* const result = await deleteResource(
|
|
* "https://example.com/container/someResource.ttl",
|
|
* { fetch, dataset: localDataset },
|
|
* );
|
|
* if (!result.isError) {
|
|
* // Do something
|
|
* }
|
|
* ```
|
|
*/
|
|
export async function deleteResource(
|
|
uri: string,
|
|
options?: DatasetRequestOptions,
|
|
): Promise<DeleteResult> {
|
|
try {
|
|
const fetch = guaranteeFetch(options?.fetch);
|
|
const response = await fetch(uri, {
|
|
method: "delete",
|
|
});
|
|
const errorResult = HttpErrorResult.checkResponse(uri, response);
|
|
if (errorResult) return errorResult;
|
|
|
|
// Specifically check for a 205. Annoyingly, the server will return 200 even
|
|
// if it hasn't been deleted when you're unauthenticated. 404 happens when
|
|
// the document never existed
|
|
if (response.status === 205 || response.status === 404) {
|
|
if (options?.dataset) {
|
|
options.dataset.deleteMatches(
|
|
undefined,
|
|
undefined,
|
|
undefined,
|
|
namedNode(uri),
|
|
);
|
|
deleteResourceRdfFromContainer(uri, options.dataset);
|
|
}
|
|
return {
|
|
isError: false,
|
|
type: "deleteSuccess",
|
|
uri,
|
|
resourceExisted: response.status === 205,
|
|
};
|
|
}
|
|
return new UnexpectedHttpError(uri, response);
|
|
} catch (err) {
|
|
return UnexpectedResourceError.fromThrown(uri, err);
|
|
}
|
|
}
|
|
|