-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
219 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| // | ||
| // 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 { describe, it, jest, expect, beforeEach } from "@jest/globals"; | ||
| import type { getVerifiableCredential } from "@inrupt/solid-client-vc"; | ||
| import { fetch } from "@inrupt/universal-fetch"; | ||
| import { getAccessRequest } from "./getAccessRequest"; | ||
| import { mockAccessGrantVc, mockAccessRequestVc } from "../util/access.mock"; | ||
| import type { getSessionFetch } from "../../common/util/getSessionFetch"; | ||
|
|
||
| jest.mock("../../common/util/getSessionFetch"); | ||
| jest.mock("@inrupt/solid-client-vc", () => { | ||
| const vcModule = jest.requireActual("@inrupt/solid-client-vc") as any; | ||
| return { | ||
| ...vcModule, | ||
| getVerifiableCredential: jest.fn(), | ||
| }; | ||
| }); | ||
|
|
||
| describe("getAccessRequest", () => { | ||
| let mockedFetch: jest.MockedFunction<typeof fetch>; | ||
| let embeddedFetch: jest.Mocked<{ getSessionFetch: typeof getSessionFetch }>; | ||
| let vcModule: jest.Mocked<{ | ||
| getVerifiableCredential: typeof getVerifiableCredential; | ||
| }>; | ||
| beforeEach(() => { | ||
| mockedFetch = jest.fn(fetch); | ||
| embeddedFetch = jest.requireMock("../../common/util/getSessionFetch"); | ||
| embeddedFetch.getSessionFetch.mockResolvedValueOnce(mockedFetch); | ||
| vcModule = jest.requireMock("@inrupt/solid-client-vc"); | ||
| vcModule.getVerifiableCredential.mockResolvedValue(mockAccessRequestVc()); | ||
| }); | ||
|
|
||
| it("uses the default fetch if none is provided", async () => { | ||
| await getAccessRequest("https://some.vc"); | ||
| expect(vcModule.getVerifiableCredential).toHaveBeenCalledWith( | ||
| "https://some.vc", | ||
| { | ||
| fetch: mockedFetch, | ||
| } | ||
| ); | ||
| }); | ||
|
|
||
| it("uses the provided fetch if any", async () => { | ||
| await getAccessRequest("https://some.vc", { | ||
| fetch: mockedFetch, | ||
| }); | ||
| expect(vcModule.getVerifiableCredential).toHaveBeenCalledWith( | ||
| "https://some.vc", | ||
| { | ||
| fetch: mockedFetch, | ||
| } | ||
| ); | ||
| }); | ||
|
|
||
| it("returns the fetched VC and the redirect URL", async () => { | ||
| // Check that both URL strings and objects are supported. | ||
| const accessRequestFromString = await getAccessRequest("https://some.vc"); | ||
| const accessRequestFromUrl = await getAccessRequest( | ||
| new URL("https://some.vc") | ||
| ); | ||
|
|
||
| expect(accessRequestFromString).toStrictEqual(accessRequestFromUrl); | ||
| expect(accessRequestFromString).toStrictEqual(mockAccessRequestVc()); | ||
| }); | ||
|
|
||
| it("throws if the fetched VC is not an Access Request", async () => { | ||
| vcModule.getVerifiableCredential.mockResolvedValueOnce(mockAccessGrantVc()); | ||
| await expect(getAccessRequest("https://some.vc")).rejects.toThrow(); | ||
| }); | ||
|
|
||
| it("normalizes equivalent JSON-LD VCs", async () => { | ||
| const normalizedAccessRequest = mockAccessRequestVc(); | ||
| // The server returns an equivalent JSON-LD with a different frame: | ||
| vcModule.getVerifiableCredential.mockResolvedValueOnce({ | ||
| ...normalizedAccessRequest, | ||
| credentialSubject: { | ||
| ...normalizedAccessRequest.credentialSubject, | ||
| hasConsent: { | ||
| ...normalizedAccessRequest.credentialSubject.hasConsent, | ||
| // The 1-value array is replaced by the literal value. | ||
| forPersonalData: | ||
| normalizedAccessRequest.credentialSubject.hasConsent | ||
| .forPersonalData[0], | ||
| mode: normalizedAccessRequest.credentialSubject.hasConsent.mode[0], | ||
| }, | ||
| }, | ||
| }); | ||
| const accessRequest = await getAccessRequest("https://some.vc"); | ||
| expect(accessRequest).toStrictEqual(mockAccessRequestVc()); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,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 { UrlString } from "@inrupt/solid-client"; | ||
| import { getVerifiableCredential } from "@inrupt/solid-client-vc"; | ||
| import { isAccessRequest } from "../guard/isAccessRequest"; | ||
| import type { AccessRequest } from "../type/AccessRequest"; | ||
| import { getSessionFetch } from "../../common/util/getSessionFetch"; | ||
| import { normalizeAccessRequest } from "../request/issueAccessRequest"; | ||
|
|
||
| /** | ||
| * Fetch the Access Request from the given URL. | ||
| * | ||
| * @param url The URL of the Access Request. | ||
| * @param options Optional properties to customise the behaviour: | ||
| * - fetch: an authenticated fetch function. If not provided, the default session | ||
| * from @inrupt/solid-client-authn-browser will be used if available. | ||
| * @returns An Access Request. | ||
| * @since 0.5.0 | ||
| */ | ||
| export async function getAccessRequest( | ||
| url: UrlString | URL, | ||
| options: { fetch?: typeof fetch } = {} | ||
| ): Promise<AccessRequest> { | ||
| const accessRequest = normalizeAccessRequest( | ||
| await getVerifiableCredential(url.toString(), { | ||
| fetch: options.fetch ?? (await getSessionFetch(options)), | ||
| }) | ||
| ); | ||
|
|
||
| if (!isAccessRequest(accessRequest)) { | ||
| throw new Error( | ||
| `${JSON.stringify(accessRequest)} is not an Access Request` | ||
| ); | ||
| } | ||
| return accessRequest; | ||
| } | ||
|
|
||
| export default getAccessRequest; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
058c19fThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
solid-client-access-grants-js – ./
solid-client-access-grants-js-inrupt.vercel.app
solid-client-access-grants-js-git-main-inrupt.vercel.app
solid-client-access-grants-js.vercel.app