diff --git a/apps/passport-client/new-components/screens/Home/NewHomeScreen.tsx b/apps/passport-client/new-components/screens/Home/NewHomeScreen.tsx index 7b27129e10..9a453ae52d 100644 --- a/apps/passport-client/new-components/screens/Home/NewHomeScreen.tsx +++ b/apps/passport-client/new-components/screens/Home/NewHomeScreen.tsx @@ -44,6 +44,7 @@ import { ChevronLeftIcon, ChevronRightIcon } from "@heroicons/react/16/solid"; import { isEmailPCD } from "@pcd/email-pcd"; import { PCDGetRequest } from "@pcd/passport-interface"; import { Spacer } from "@pcd/passport-ui"; +import { isPODEmailPCD } from "@pcd/pod-email-pcd"; import { isSemaphoreIdentityPCD } from "@pcd/semaphore-identity-pcd"; import { ReactElement, @@ -195,8 +196,12 @@ export const NewHomeScreen = (): ReactElement => { const noPods = collection .getAll() - .filter((pcd) => !isEmailPCD(pcd) && !isSemaphoreIdentityPCD(pcd)) - .length === 0; + .filter( + (pcd) => + !isEmailPCD(pcd) && + !isSemaphoreIdentityPCD(pcd) && + !isPODEmailPCD(pcd) + ).length === 0; const orientation = useOrientation(); const isLandscape = diff --git a/apps/passport-client/new-components/screens/Home/NoUpcomingTicketsState.tsx b/apps/passport-client/new-components/screens/Home/NoUpcomingTicketsState.tsx index 47878e09e6..f4424e9c95 100644 --- a/apps/passport-client/new-components/screens/Home/NoUpcomingTicketsState.tsx +++ b/apps/passport-client/new-components/screens/Home/NoUpcomingTicketsState.tsx @@ -1,4 +1,5 @@ import { isEmailPCD } from "@pcd/email-pcd"; +import { isPODEmailPCD } from "@pcd/pod-email-pcd"; import { isSemaphoreIdentityPCD } from "@pcd/semaphore-identity-pcd"; import { ReactElement, @@ -9,6 +10,10 @@ import { } from "react"; import { useSearchParams } from "react-router-dom"; import styled from "styled-components"; +import { ZappButton } from "../../../components/screens/ZappScreens/ZappButton"; +import { ZappButtonsContainer } from "../../../components/screens/ZappScreens/ZappButtonsContainer"; +import { ZappFullScreen } from "../../../components/screens/ZappScreens/ZappFullScreen"; +import { appConfig } from "../../../src/appConfig"; import { useDispatch, usePCDCollection, useSelf } from "../../../src/appHooks"; import { BANNER_HEIGHT, MAX_WIDTH_SCREEN } from "../../../src/sharedConstants"; import { nextFrame } from "../../../src/util"; @@ -16,10 +21,6 @@ import { PodsCollectionList } from "../../shared/Modals/PodsCollectionBottomModa import { Typography } from "../../shared/Typography"; import { hideScrollCSS, replaceDotWithSlash } from "../../shared/utils"; import { ScrollIndicator } from "./ScrollIndicator"; -import { ZappButtonsContainer } from "../../../components/screens/ZappScreens/ZappButtonsContainer"; -import { ZappButton } from "../../../components/screens/ZappScreens/ZappButton"; -import { appConfig } from "../../../src/appConfig"; -import { ZappFullScreen } from "../../../components/screens/ZappScreens/ZappFullScreen"; const EMPTY_CARD_CONTAINER_HEIGHT = 220; const EmptyCardContainer = styled.div<{ longVersion: boolean }>` @@ -124,8 +125,12 @@ export const NoUpcomingEventsState = ({ const noPods = pods .getAll() - .filter((pcd) => !isEmailPCD(pcd) && !isSemaphoreIdentityPCD(pcd)) - .length === 0; + .filter( + (pcd) => + !isEmailPCD(pcd) && + !isSemaphoreIdentityPCD(pcd) && + !isPODEmailPCD(pcd) + ).length === 0; useLayoutEffect(() => { // Restore scroll position when list is shown again diff --git a/apps/passport-client/new-components/shared/Modals/PodsCollectionBottomModal.tsx b/apps/passport-client/new-components/shared/Modals/PodsCollectionBottomModal.tsx index 2078f33684..48c8a133ec 100644 --- a/apps/passport-client/new-components/shared/Modals/PodsCollectionBottomModal.tsx +++ b/apps/passport-client/new-components/shared/Modals/PodsCollectionBottomModal.tsx @@ -2,6 +2,7 @@ import { isEdDSAFrogPCD } from "@pcd/eddsa-frog-pcd"; import { isEdDSATicketPCD } from "@pcd/eddsa-ticket-pcd"; import { isEmailPCD } from "@pcd/email-pcd"; import { PCD } from "@pcd/pcd-types"; +import { isPODEmailPCD } from "@pcd/pod-email-pcd"; import { getImageUrlEntry, getDisplayOptions as getPodDisplayOptions, @@ -57,7 +58,7 @@ const filterOverlappingEdDSATickets = ( ) .map((eddsa) => eddsa.id); - const noEmails = pcds.filter((p) => !isEmailPCD(p)); + const noEmails = pcds.filter((p) => !isEmailPCD(p) && !isPODEmailPCD(p)); return noEmails.filter((pcd) => !overlapping.includes(pcd.id)); }; @@ -67,6 +68,8 @@ const getPcdName = (pcd: PCD): string => { return pcd.claim.ticket.eventName + " - " + pcd.claim.ticket.ticketName; case isEmailPCD(pcd): return pcd.claim.emailAddress; + case isPODEmailPCD(pcd): + return pcd.claim.podEntries.emailAddress.value; case isPODPCD(pcd): return getPodDisplayOptions(pcd).header ?? pcd.id; case isEdDSAFrogPCD(pcd): diff --git a/apps/passport-client/package.json b/apps/passport-client/package.json index 4e09e16590..2678f19bcd 100644 --- a/apps/passport-client/package.json +++ b/apps/passport-client/package.json @@ -47,6 +47,8 @@ "@pcd/pcd-collection": "0.15.0", "@pcd/pcd-types": "0.15.0", "@pcd/pod": "0.5.0", + "@pcd/pod-email-pcd": "0.1.0", + "@pcd/pod-email-pcd-ui": "0.1.0", "@pcd/pod-pcd": "0.5.0", "@pcd/pod-pcd-ui": "0.5.0", "@pcd/pod-ticket-pcd": "0.5.0", diff --git a/apps/passport-client/src/pcdPackages.ts b/apps/passport-client/src/pcdPackages.ts index d388416009..1919dfed9a 100644 --- a/apps/passport-client/src/pcdPackages.ts +++ b/apps/passport-client/src/pcdPackages.ts @@ -9,6 +9,7 @@ import { MessagePCDPackage } from "@pcd/message-pcd"; import { requestLogToServer } from "@pcd/passport-interface"; import { PCDCollection } from "@pcd/pcd-collection"; import { PCD, PCDPackage, SerializedPCD } from "@pcd/pcd-types"; +import { PODEmailPCDPackage } from "@pcd/pod-email-pcd"; import { PODPCDPackage } from "@pcd/pod-pcd"; import { PODTicketPCDPackage } from "@pcd/pod-ticket-pcd"; import { RSAImagePCDPackage } from "@pcd/rsa-image-pcd"; @@ -98,6 +99,7 @@ async function loadPackages(): Promise { PODPCDPackage, PODTicketPCDPackage, GPCPCDPackage, + PODEmailPCDPackage, UnknownPCDPackage ]; } diff --git a/apps/passport-client/src/pcdRenderers.ts b/apps/passport-client/src/pcdRenderers.ts index 819d8c4620..e4c47f511a 100644 --- a/apps/passport-client/src/pcdRenderers.ts +++ b/apps/passport-client/src/pcdRenderers.ts @@ -15,6 +15,8 @@ import { HaLoNoncePCDUI } from "@pcd/halo-nonce-pcd-ui"; import { MessagePCDTypeName } from "@pcd/message-pcd"; import { MessagePCDUI } from "@pcd/message-pcd-ui"; import { PCD, PCDUI } from "@pcd/pcd-types"; +import { PODEmailPCDTypeName } from "@pcd/pod-email-pcd"; +import { PODEmailPCDUI } from "@pcd/pod-email-pcd-ui"; import { PODPCDTypeName } from "@pcd/pod-pcd"; import { PODPCDUI } from "@pcd/pod-pcd-ui"; import { PODTicketPCDTypeName } from "@pcd/pod-ticket-pcd"; @@ -55,6 +57,7 @@ const renderablePCDs = [ PODPCDTypeName, PODTicketPCDTypeName, GPCPCDTypeName, + PODEmailPCDTypeName, UnknownPCDTypeName ] as const; @@ -80,5 +83,6 @@ export const pcdRenderers: { [PODPCDTypeName]: PODPCDUI, [PODTicketPCDTypeName]: PODTicketPCDUI, [GPCPCDTypeName]: GPCPCDUI, + [PODEmailPCDTypeName]: PODEmailPCDUI, [UnknownPCDTypeName]: UnknownPCDUI }; diff --git a/apps/passport-client/tsconfig.json b/apps/passport-client/tsconfig.json index 8607c23f8e..19b94382db 100644 --- a/apps/passport-client/tsconfig.json +++ b/apps/passport-client/tsconfig.json @@ -105,6 +105,12 @@ { "path": "../../packages/lib/pod" }, + { + "path": "../../packages/pcd/pod-email-pcd" + }, + { + "path": "../../packages/ui/pod-email-pcd-ui" + }, { "path": "../../packages/pcd/pod-pcd" }, diff --git a/apps/passport-server/package.json b/apps/passport-server/package.json index 8146638515..ea48e7fcc5 100644 --- a/apps/passport-server/package.json +++ b/apps/passport-server/package.json @@ -33,6 +33,7 @@ "@pcd/pcd-collection": "0.15.0", "@pcd/pcd-types": "0.15.0", "@pcd/pod": "0.5.0", + "@pcd/pod-email-pcd": "0.1.0", "@pcd/pod-pcd": "0.5.0", "@pcd/pod-ticket-pcd": "0.5.0", "@pcd/podbox-shared": "0.4.0", diff --git a/apps/passport-server/src/services/issuanceService.ts b/apps/passport-server/src/services/issuanceService.ts index 2863dc5b72..ca828f2cbc 100644 --- a/apps/passport-server/src/services/issuanceService.ts +++ b/apps/passport-server/src/services/issuanceService.ts @@ -11,7 +11,7 @@ import { ITicketData, TicketCategory } from "@pcd/eddsa-ticket-pcd"; -import { EmailPCD, EmailPCDPackage } from "@pcd/email-pcd"; +import { EmailPCD, EmailPCDPackage, isEmailPCD } from "@pcd/email-pcd"; import { getHash } from "@pcd/passport-crypto"; import { Credential, @@ -44,7 +44,10 @@ import { PCDPermissionType } from "@pcd/pcd-collection"; import { ArgumentTypeName, SerializedPCD } from "@pcd/pcd-types"; +import { encodePublicKey } from "@pcd/pod"; +import { PODEmailPCD, PODEmailPCDPackage } from "@pcd/pod-email-pcd"; import { RSAImagePCDPackage } from "@pcd/rsa-image-pcd"; +import { IdentityV3, v3tov4Identity } from "@pcd/semaphore-identity-pcd"; import { RollbarService } from "@pcd/server-shared"; import { ONE_HOUR_MS } from "@pcd/util"; import { ZKEdDSAEventTicketPCDPackage } from "@pcd/zk-eddsa-event-ticket-pcd"; @@ -189,7 +192,11 @@ export class IssuanceService { type: PCDActionType.ReplaceInFolder, folder: "Email", pcds: await Promise.all( - pcds.map((pcd) => EmailPCDPackage.serialize(pcd)) + pcds.map((pcd) => + isEmailPCD(pcd) + ? EmailPCDPackage.serialize(pcd) + : PODEmailPCDPackage.serialize(pcd) + ) ) }); }); @@ -584,7 +591,7 @@ export class IssuanceService { private async issueEmailPCDs( client: PoolClient, credential: VerifiedCredential - ): Promise { + ): Promise<(EmailPCD | PODEmailPCD)[]> { return traced("IssuanceService", "issueEmailPCDs", async (span) => { const user = await this.checkUserExists(client, credential); @@ -598,33 +605,59 @@ export class IssuanceService { span?.setAttribute("emails", user.emails); } - return Promise.all( + const pcds = await Promise.all( user.emails.map((email) => { const stableId = "attested-email-" + email; - return EmailPCDPackage.prove({ - privateKey: { - value: this.eddsaPrivateKey, - argumentType: ArgumentTypeName.String - }, - id: { - value: stableId, - argumentType: ArgumentTypeName.String - }, - emailAddress: { - value: email, - argumentType: ArgumentTypeName.String - }, - semaphoreId: { - value: user.commitment, - argumentType: ArgumentTypeName.String - }, - semaphoreV4Id: { - value: user.semaphore_v4_pubkey ?? undefined, - argumentType: ArgumentTypeName.String - } - }); + const stablePodId = "pod-attested-email-" + email; + return Promise.all([ + EmailPCDPackage.prove({ + privateKey: { + value: this.eddsaPrivateKey, + argumentType: ArgumentTypeName.String + }, + id: { + value: stableId, + argumentType: ArgumentTypeName.String + }, + emailAddress: { + value: email, + argumentType: ArgumentTypeName.String + }, + semaphoreId: { + value: user.commitment, + argumentType: ArgumentTypeName.String + }, + semaphoreV4Id: { + value: user.semaphore_v4_pubkey ?? undefined, + argumentType: ArgumentTypeName.String + } + }), + PODEmailPCDPackage.prove({ + id: { + value: stablePodId, + argumentType: ArgumentTypeName.String + }, + privateKey: { + value: this.eddsaPrivateKey, + argumentType: ArgumentTypeName.String + }, + emailAddress: { + value: email, + argumentType: ArgumentTypeName.String + }, + semaphoreV4PublicKey: { + value: + user.semaphore_v4_pubkey ?? + encodePublicKey( + v3tov4Identity(new IdentityV3(user.commitment)).publicKey + ), + argumentType: ArgumentTypeName.String + } + }) + ]); }) ); + return pcds.flat(); }); } diff --git a/apps/passport-server/test/email-feed.spec.ts b/apps/passport-server/test/email-feed.spec.ts index 5fd6b17c32..220c48ad31 100644 --- a/apps/passport-server/test/email-feed.spec.ts +++ b/apps/passport-server/test/email-feed.spec.ts @@ -5,8 +5,10 @@ import { requestPollFeed } from "@pcd/passport-interface"; import { PCDActionType, isReplaceInFolderAction } from "@pcd/pcd-collection"; +import { encodePublicKey } from "@pcd/pod"; +import { PODEmailPCDPackage, PODEmailPCDTypeName } from "@pcd/pod-email-pcd"; import { Identity } from "@semaphore-protocol/identity"; -import { expect } from "chai"; +import { assert, expect } from "chai"; import "mocha"; import { step } from "mocha-steps"; import MockDate from "mockdate"; @@ -75,8 +77,9 @@ describe("attested email feed functionality", function () { const action = pollFeedResult?.value?.actions?.[1]; expectToExist(action, isReplaceInFolderAction); expect(action.type).to.eq(PCDActionType.ReplaceInFolder); - expect(action.pcds.length).to.eq(1); + expect(action.pcds.length).to.eq(2); expect(action.pcds[0].type).to.eq(EmailPCDTypeName); + expect(action.pcds[1].type).to.eq(PODEmailPCDTypeName); // Check that the PCD contains the expected email address const deserializedPCD = await EmailPCDPackage.deserialize( @@ -87,10 +90,29 @@ describe("attested email feed functionality", function () { // Check that the PCD verifies expect(await EmailPCDPackage.verify(deserializedPCD)).to.be.true; + const serverPublicKey = + await application.services.issuanceService?.getEdDSAPublicKey(); + assert(serverPublicKey, "Server public key should exist"); + // Check the public key expect(deserializedPCD.proof.eddsaPCD.claim.publicKey).to.deep.eq( - await application.services.issuanceService?.getEdDSAPublicKey() + serverPublicKey + ); + + // Check the PODEmailPCD + const podEmailPCD = await PODEmailPCDPackage.deserialize( + action.pcds[1].pcd ); + expect(podEmailPCD.claim.podEntries.emailAddress.value).to.eq(testEmail); + expect(podEmailPCD.claim.signerPublicKey).to.deep.eq( + encodePublicKey([ + BigInt(`0x${serverPublicKey[0]}`), + BigInt(`0x${serverPublicKey[1]}`) + ]) + ); + + // Check that the PODEmailPCD verifies + expect(await PODEmailPCDPackage.verify(podEmailPCD)).to.be.true; } ); }); diff --git a/apps/passport-server/test/generic-issuance/pipelines/pretix/pretixPipelineMultiEmail.spec.ts b/apps/passport-server/test/generic-issuance/pipelines/pretix/pretixPipelineMultiEmail.spec.ts index 24e375fa3e..5548b90d7e 100644 --- a/apps/passport-server/test/generic-issuance/pipelines/pretix/pretixPipelineMultiEmail.spec.ts +++ b/apps/passport-server/test/generic-issuance/pipelines/pretix/pretixPipelineMultiEmail.spec.ts @@ -10,8 +10,10 @@ import { requestRemoveUserEmail } from "@pcd/passport-interface"; import { PCDActionType, isReplaceInFolderAction } from "@pcd/pcd-collection"; +import { encodePublicKey } from "@pcd/pod"; +import { PODEmailPCDPackage, PODEmailPCDTypeName } from "@pcd/pod-email-pcd"; import { Identity } from "@semaphore-protocol/identity"; -import { expect } from "chai"; +import { assert, expect } from "chai"; import "mocha"; import { step } from "mocha-steps"; import * as MockDate from "mockdate"; @@ -764,25 +766,51 @@ async function testGetEmailPCDs( const action = pollFeedResult?.value?.actions?.[1]; expectToExist(action, isReplaceInFolderAction); expect(action.type).to.eq(PCDActionType.ReplaceInFolder); - expect(action.pcds.length).to.eq(expectedEmails.length); + // the feed issues both POD and non-POD email PCDs, so we expect 2 PCDs for each email + expect(action.pcds.length).to.eq(expectedEmails.length * 2); const result: EmailPCD[] = []; + const serverPublicKey = + await giBackend.services.issuanceService?.getEdDSAPublicKey(); + assert(serverPublicKey, "Server public key should exist"); + for (const pcd of action.pcds) { - expect(pcd.type).to.eq(EmailPCDTypeName); + expect(pcd.type).to.be.oneOf([EmailPCDTypeName, PODEmailPCDTypeName]); - // Check that the PCD contains the expected email address - const deserializedPCD = await EmailPCDPackage.deserialize(pcd.pcd); - expect(expectedEmails).to.include(deserializedPCD.claim.emailAddress); - result.push(deserializedPCD); + if (pcd.type === EmailPCDTypeName) { + // Check that the PCD contains the expected email address + const deserializedPCD = await EmailPCDPackage.deserialize(pcd.pcd); + expect(expectedEmails).to.include(deserializedPCD.claim.emailAddress); + result.push(deserializedPCD); - // Check that the PCD verifies - expect(await EmailPCDPackage.verify(deserializedPCD)).to.be.true; + // Check that the PCD verifies + expect(await EmailPCDPackage.verify(deserializedPCD)).to.be.true; - // Check the public key - expect(deserializedPCD.proof.eddsaPCD.claim.publicKey).to.deep.eq( - await giBackend.services.issuanceService?.getEdDSAPublicKey() - ); + // Check the public key + expect(deserializedPCD.proof.eddsaPCD.claim.publicKey).to.deep.eq( + serverPublicKey + ); + } else { + // Check the PODEmailPCD + const podEmailPCD = await PODEmailPCDPackage.deserialize(pcd.pcd); + expect(podEmailPCD.claim.signerPublicKey).to.deep.eq( + encodePublicKey([ + BigInt(`0x${serverPublicKey[0]}`), + BigInt(`0x${serverPublicKey[1]}`) + ]) + ); + expect(expectedEmails).to.include( + podEmailPCD.claim.podEntries.emailAddress.value + ); + /** + * @todo right now the POD Email PCDs aren't used for anything, so we don't + * return them here. When we do, we should push them into the result array. + */ + + // Check that the PODEmailPCD verifies + expect(await PODEmailPCDPackage.verify(podEmailPCD)).to.be.true; + } } return result; diff --git a/apps/passport-server/tsconfig.json b/apps/passport-server/tsconfig.json index 86179c2c76..62241d42b3 100644 --- a/apps/passport-server/tsconfig.json +++ b/apps/passport-server/tsconfig.json @@ -59,6 +59,9 @@ { "path": "../../packages/lib/pod" }, + { + "path": "../../packages/pcd/pod-email-pcd" + }, { "path": "../../packages/pcd/pod-pcd" }, diff --git a/packages/pcd/pod-email-pcd/.eslintrc.js b/packages/pcd/pod-email-pcd/.eslintrc.js new file mode 100644 index 0000000000..dac5168f48 --- /dev/null +++ b/packages/pcd/pod-email-pcd/.eslintrc.js @@ -0,0 +1,4 @@ +module.exports = { + extends: ["@pcd/eslint-config-custom"], + root: true, +}; diff --git a/packages/pcd/pod-email-pcd/.gitignore b/packages/pcd/pod-email-pcd/.gitignore new file mode 100644 index 0000000000..eac8df2616 --- /dev/null +++ b/packages/pcd/pod-email-pcd/.gitignore @@ -0,0 +1,5 @@ +*.js +*.ts.map +!.eslintrc.js +dist +*.tsbuildinfo \ No newline at end of file diff --git a/packages/pcd/pod-email-pcd/LICENSE b/packages/pcd/pod-email-pcd/LICENSE new file mode 100644 index 0000000000..671274c0b8 --- /dev/null +++ b/packages/pcd/pod-email-pcd/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2023 0xPARC Foundation + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/packages/pcd/pod-email-pcd/package.json b/packages/pcd/pod-email-pcd/package.json new file mode 100644 index 0000000000..072553601a --- /dev/null +++ b/packages/pcd/pod-email-pcd/package.json @@ -0,0 +1,47 @@ +{ + "name": "@pcd/pod-email-pcd", + "private": false, + "version": "0.1.0", + "license": "GPL-3.0-or-later", + "main": "./dist/cjs/src/index.js", + "module": "./dist/esm/src/index.js", + "types": "./dist/types/src/index.d.ts", + "exports": { + ".": { + "types": "./dist/types/src/index.d.ts", + "import": "./dist/esm/src/index.js", + "require": "./dist/cjs/src/index.js" + } + }, + "files": [ + "dist", + "./README.md", + "./LICENSE" + ], + "scripts": { + "lint": "eslint \"**/*.ts{,x}\"", + "build": "tsc -b tsconfig.cjs.json tsconfig.esm.json", + "typecheck": "yarn tsc --noEmit", + "prepublishOnly": "yarn clean && yarn build", + "test": "ts-mocha --type-check --config ../../../.mocharc.js --exit 'test/**/*.spec.ts'", + "clean": "rm -rf dist node_modules *.tsbuildinfo" + }, + "dependencies": { + "@pcd/pcd-types": "0.15.0", + "@pcd/pod": "0.5.0" + }, + "devDependencies": { + "@pcd/eslint-config-custom": "0.15.0", + "@pcd/tsconfig": "0.15.0", + "@types/chai": "^4.3.5", + "@types/mocha": "^10.0.1", + "@zk-kit/eddsa-poseidon": "^1.1.0", + "eslint": "^8.57.0", + "mocha": "^10.2.0", + "ts-mocha": "^10.0.0", + "typescript": "^5.3.3" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/pcd/pod-email-pcd/src/PODEmailPCD.ts b/packages/pcd/pod-email-pcd/src/PODEmailPCD.ts new file mode 100644 index 0000000000..93ea4b4d15 --- /dev/null +++ b/packages/pcd/pod-email-pcd/src/PODEmailPCD.ts @@ -0,0 +1,84 @@ +import type { PCD, StringArgument } from "@pcd/pcd-types"; +import type { + PODEdDSAPublicKeyValue, + PODEntries, + PODStringValue +} from "@pcd/pod"; + +export const PODEmailPCDTypeName = "pod-email-pcd"; + +export type PODEmailPCDArgs = { + /** + * The signer's EdDSA private key. This is a 32-byte value used to sign the + * message. See {@link @pcd/pod!decodePrivateKey} in `@pcd/pod` if you need + * to manipulate or convert this value. + */ + privateKey: StringArgument; + + /** + * The verified email address + */ + emailAddress: StringArgument; + + /** + * The signer's semaphore v4 public key + * See {@link @pcd/pod!encodePublicKey} for details of the string format. + */ + semaphoreV4PublicKey: StringArgument; + + /** + * A unique string identifying the PCD + */ + id: StringArgument; +}; + +/** + * A concrete POD value which indicates that this is an email POD. + */ +interface EmailPODTypeValue extends PODStringValue { + value: "zupass.email"; +} + +/** + * The POD entries which must be present in a PODEmailPCD. + * By extending `PODEntries`, we allow for additional entries beyond those + * required by the email POD. + */ +export interface PODEmailPCDRequiredEntries extends PODEntries { + emailAddress: PODStringValue; + semaphoreV4PublicKey: PODEdDSAPublicKeyValue; + pod_type: EmailPODTypeValue; +} + +/** + * The claim for a PODEmailPCD. + * + * We include the `podEntries` field to allow for extensions to the POD in the + * future. The type indicates that certain entries are required, but does not + * indicate that there are no additional entries. + * + * Because our PCD includes the full set of entries, it is always possible to + * reconstruct the POD that was used to produce the signature, even if other + * logic changes. + */ +export interface PODEmailPCDClaim { + podEntries: PODEmailPCDRequiredEntries; + signerPublicKey: string; +} + +export interface PODEmailPCDProof { + signature: string; +} + +export class PODEmailPCD implements PCD { + type = PODEmailPCDTypeName; + claim: PODEmailPCDClaim; + proof: PODEmailPCDProof; + id: string; + + constructor(id: string, claim: PODEmailPCDClaim, proof: PODEmailPCDProof) { + this.id = id; + this.claim = claim; + this.proof = proof; + } +} diff --git a/packages/pcd/pod-email-pcd/src/PODEmailPCDPackage.ts b/packages/pcd/pod-email-pcd/src/PODEmailPCDPackage.ts new file mode 100644 index 0000000000..c6fb9b3ac5 --- /dev/null +++ b/packages/pcd/pod-email-pcd/src/PODEmailPCDPackage.ts @@ -0,0 +1,221 @@ +import { DisplayOptions, PCDPackage, SerializedPCD } from "@pcd/pcd-types"; +import { POD, PODEntries } from "@pcd/pod"; +import { + PODEmailPCD, + PODEmailPCDArgs, + PODEmailPCDClaim, + PODEmailPCDProof, + PODEmailPCDRequiredEntries, + PODEmailPCDTypeName +} from "./PODEmailPCD"; + +/** + * Loads POD values from a PODEmailPCD. + * + * @param pcd - The PODEmailPCD to load. + * @returns The POD. + */ +function loadPOD(pcd: PODEmailPCD): POD { + return POD.load( + pcd.claim.podEntries, + pcd.proof.signature, + pcd.claim.signerPublicKey + ); +} + +/** + * Creates a PODEmailPCD from the given arguments. + * + * @param args - The arguments for the PODEmailPCD. + * @returns The PODEmailPCD. + */ +export async function prove(args: PODEmailPCDArgs): Promise { + if (!args.privateKey.value) { + throw new Error("missing private key"); + } + + if (!args.emailAddress.value) { + throw new Error("missing email value"); + } + + if (!args.semaphoreV4PublicKey.value) { + throw new Error("missing semaphore v4 public key"); + } + + const podEntries: PODEmailPCDRequiredEntries = { + emailAddress: { + type: "string", + value: args.emailAddress.value + }, + semaphoreV4PublicKey: { + type: "eddsa_pubkey", + value: args.semaphoreV4PublicKey.value + }, + pod_type: { + type: "string", + value: "zupass.email" + } + }; + + const pod = POD.sign(podEntries, args.privateKey.value); + + // The POD signature is used as the ID if no ID is provided. + const id = args.id.value ?? pod.signature; + + return new PODEmailPCD( + id, + { + podEntries, + signerPublicKey: pod.signerPublicKey + }, + { + signature: pod.signature + } + ); +} + +/** + * Verifies a PODEmailPCD. + * + * This checks that the required entries are present and valid, then verifies + * the POD signature. + * + * @param pcd - The PODEmailPCD to verify. + * @returns Whether the PODEmailPCD is valid. + */ +export async function verify(pcd: PODEmailPCD): Promise { + try { + checkPODEntries(pcd.claim.podEntries); + } catch (e) { + return false; + } + + return loadPOD(pcd).verifySignature(); +} + +/** + * Serializes a PODEmailPCD. + * + * @param pcd - The PODEmailPCD to serialize. + * @returns The serialized PODEmailPCD. + */ +export async function serialize( + pcd: PODEmailPCD +): Promise> { + return { + type: PODEmailPCDTypeName, + pcd: JSON.stringify({ + id: pcd.id, + pod: loadPOD(pcd).toJSON() + }) + }; +} + +/** + * Checks that the required entries are present and valid. + * + * This is used both to check the entries when creating a PODEmailPCD and to + * check the entries when deserializing a PODEmailPCD. + * + * Note that this does not ensure that there are no additional entries. This allows + * for compatibility with future extensions to the POD. + * + * @param podEntries - The POD entries to check. + * @returns Whether the POD entries are valid. + * @throws If the POD entries are invalid. + */ +function checkPODEntries( + podEntries: PODEntries +): podEntries is PODEntries & PODEmailPCDRequiredEntries { + if (!podEntries.emailAddress) { + throw new TypeError("emailAddress entry is missing"); + } + + if (!podEntries.semaphoreV4PublicKey) { + throw new TypeError("semaphoreV4PublicKey entry is missing"); + } + + if (!podEntries.pod_type) { + throw new TypeError("pod_type entry is missing"); + } + + if (typeof podEntries.emailAddress.value !== "string") { + throw new TypeError("emailAddress entry is not a string"); + } + + if (podEntries.semaphoreV4PublicKey.type !== "eddsa_pubkey") { + throw new TypeError( + "semaphoreV4PublicKey entry is not an eddsa public key" + ); + } + + if ( + podEntries.pod_type.type !== "string" || + podEntries.pod_type.value !== "zupass.email" + ) { + throw new TypeError( + "pod_type entry is not a string with value 'zupass.email'" + ); + } + + return true; +} + +/** + * Deserializes a PODEmailPCD. + * + * @param serialized - The serialized PODEmailPCD. + * @returns The deserialized PODEmailPCD. + * @throws If the deserialized PODEmailPCD is invalid. + */ +export async function deserialize(serialized: string): Promise { + const wrapper = JSON.parse(serialized); + const pod = POD.fromJSON(wrapper.pod); + const podEntries = pod.content.asEntries(); + + if (!checkPODEntries(podEntries)) { + // This will never throw because `checkPODEntries` will either throw an + // error or return true. However, it is necessary to include this for + //the type checker. + throw new Error("invalid pod entries"); + } + + return new PODEmailPCD( + wrapper.id, + { + podEntries: podEntries, + signerPublicKey: pod.signerPublicKey + }, + { signature: pod.signature } + ); +} + +/** + * Gets the display options for a PODEmailPCD. + * + * @param pcd - The PODEmailPCD to get the display options for. + * @returns The display options. + */ +export function getDisplayOptions(pcd: PODEmailPCD): DisplayOptions { + return { + header: "Verified Email", + displayName: pcd.claim.podEntries.emailAddress.value + }; +} + +/** + * The PCD package for PODEmailPCD. + */ +export const PODEmailPCDPackage: PCDPackage< + PODEmailPCDClaim, + PODEmailPCDProof, + PODEmailPCDArgs, + undefined +> = { + name: PODEmailPCDTypeName, + getDisplayOptions, + prove, + verify, + serialize, + deserialize +}; diff --git a/packages/pcd/pod-email-pcd/src/index.ts b/packages/pcd/pod-email-pcd/src/index.ts new file mode 100644 index 0000000000..a1c333a785 --- /dev/null +++ b/packages/pcd/pod-email-pcd/src/index.ts @@ -0,0 +1,3 @@ +export * from "./PODEmailPCD"; +export * from "./PODEmailPCDPackage"; +export * from "./utils"; diff --git a/packages/pcd/pod-email-pcd/src/utils.ts b/packages/pcd/pod-email-pcd/src/utils.ts new file mode 100644 index 0000000000..f25815a368 --- /dev/null +++ b/packages/pcd/pod-email-pcd/src/utils.ts @@ -0,0 +1,6 @@ +import { PCD } from "@pcd/pcd-types"; +import { PODEmailPCD, PODEmailPCDTypeName } from "./PODEmailPCD"; + +export function isPODEmailPCD(pcd: PCD): pcd is PODEmailPCD { + return pcd.type === PODEmailPCDTypeName; +} diff --git a/packages/pcd/pod-email-pcd/test/pod-email-pcd.spec.ts b/packages/pcd/pod-email-pcd/test/pod-email-pcd.spec.ts new file mode 100644 index 0000000000..6a0121bfe1 --- /dev/null +++ b/packages/pcd/pod-email-pcd/test/pod-email-pcd.spec.ts @@ -0,0 +1,149 @@ +import { ArgumentTypeName } from "@pcd/pcd-types"; +import { decodePrivateKey, encodePublicKey } from "@pcd/pod"; +import { derivePublicKey } from "@zk-kit/eddsa-poseidon"; +import { expect } from "chai"; +import crypto from "crypto"; +import "mocha"; +import { PODEmailPCD } from "../src/PODEmailPCD"; +import { PODEmailPCDPackage } from "../src/PODEmailPCDPackage"; + +function generateRandomHex(byteLength: number): string { + const randomBytes = crypto.randomBytes(byteLength); + return randomBytes.toString("hex"); +} + +function generateKeyPair(): { privateKey: string; publicKey: string } { + const privateKey = generateRandomHex(32); + const publicKey = encodePublicKey( + derivePublicKey(decodePrivateKey(privateKey)) + ); + return { privateKey, publicKey }; +} + +describe("POD Email PCD should work", function () { + let podEmailPCD: PODEmailPCD; + let stableEmailPCD: PODEmailPCD; + + const prvKey = generateKeyPair().privateKey; + const emailAddress = "user@test.com"; + const semaphoreV4PublicKey = generateKeyPair().publicKey; + const otherEmail = "someuser@example.com"; + const otherSemaphoreV4PublicKey = generateKeyPair().publicKey; + const stableId = "pod-attested-email-" + otherEmail; + + this.beforeAll(async () => { + podEmailPCD = await PODEmailPCDPackage.prove({ + emailAddress: { + value: emailAddress, + argumentType: ArgumentTypeName.String + }, + semaphoreV4PublicKey: { + value: semaphoreV4PublicKey, + argumentType: ArgumentTypeName.String + }, + privateKey: { + value: prvKey, + argumentType: ArgumentTypeName.String + }, + id: { + value: undefined, + argumentType: ArgumentTypeName.String + } + }); + }); + + it("should reflect prove args", async function () { + expect(podEmailPCD.claim.podEntries.emailAddress.type).to.eq("string"); + expect(podEmailPCD.claim.podEntries.emailAddress.value).to.eq(emailAddress); + expect(podEmailPCD.claim.podEntries.semaphoreV4PublicKey.type).to.eq( + "eddsa_pubkey" + ); + expect(podEmailPCD.claim.podEntries.semaphoreV4PublicKey.value).to.eq( + semaphoreV4PublicKey + ); + + expect(podEmailPCD.claim.podEntries.pod_type.type).to.eq("string"); + expect(podEmailPCD.claim.podEntries.pod_type.value).to.eq("zupass.email"); + expect(podEmailPCD.id).to.not.be.empty; + }); + + it("should be able to create and verify a signed email", async function () { + expect(await PODEmailPCDPackage.verify(podEmailPCD)).to.be.true; + }); + + it("should be possible to serialize and deserialize the pcd", async function () { + const serialized = await PODEmailPCDPackage.serialize(podEmailPCD); + const deserialized = await PODEmailPCDPackage.deserialize(serialized.pcd); + expect(deserialized).to.deep.eq(podEmailPCD); + }); + + it("should accept stable ID", async function () { + stableEmailPCD = await PODEmailPCDPackage.prove({ + emailAddress: { + value: otherEmail, + argumentType: ArgumentTypeName.String + }, + semaphoreV4PublicKey: { + value: otherSemaphoreV4PublicKey, + argumentType: ArgumentTypeName.String + }, + privateKey: { + value: prvKey, + argumentType: ArgumentTypeName.String + }, + id: { + value: stableId, + argumentType: ArgumentTypeName.String + } + }); + + expect(stableEmailPCD.id).to.eq(stableId); + expect(stableEmailPCD.claim.podEntries.emailAddress.value).to.eq( + otherEmail + ); + expect(stableEmailPCD.claim.podEntries.semaphoreV4PublicKey.value).to.eq( + otherSemaphoreV4PublicKey + ); + + const serialized = await PODEmailPCDPackage.serialize(stableEmailPCD); + const deserialized = await PODEmailPCDPackage.deserialize(serialized.pcd); + expect(deserialized).to.deep.eq(stableEmailPCD); + }); + + it("should be identical with same stable ID", async function () { + const stableEmailPCD2 = await PODEmailPCDPackage.prove({ + emailAddress: { + value: otherEmail, + argumentType: ArgumentTypeName.String + }, + semaphoreV4PublicKey: { + value: otherSemaphoreV4PublicKey, + argumentType: ArgumentTypeName.String + }, + privateKey: { + value: prvKey, + argumentType: ArgumentTypeName.String + }, + id: { + value: stableId, + argumentType: ArgumentTypeName.String + } + }); + + expect(stableEmailPCD2.id).to.eq(stableId); + expect(stableEmailPCD2.claim.podEntries.emailAddress.value).to.eq( + otherEmail + ); + expect(stableEmailPCD2.claim.podEntries.semaphoreV4PublicKey.value).to.eq( + otherSemaphoreV4PublicKey + ); + expect(stableEmailPCD2).to.deep.eq(stableEmailPCD); + + const serialized1 = await PODEmailPCDPackage.serialize(stableEmailPCD); + const serialized2 = await PODEmailPCDPackage.serialize(stableEmailPCD2); + expect(serialized1).to.deep.eq(serialized2); + const deserialized1 = await PODEmailPCDPackage.deserialize(serialized1.pcd); + const deserialized2 = await PODEmailPCDPackage.deserialize(serialized2.pcd); + expect(deserialized2).to.deep.eq(deserialized1); + }); +}); diff --git a/packages/pcd/pod-email-pcd/tsconfig.cjs.json b/packages/pcd/pod-email-pcd/tsconfig.cjs.json new file mode 100644 index 0000000000..37f35bc2d6 --- /dev/null +++ b/packages/pcd/pod-email-pcd/tsconfig.cjs.json @@ -0,0 +1,20 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "dist/cjs", + "module": "CommonJS", + "tsBuildInfoFile": "./tsconfig.cjs.tsbuildinfo" + }, + // For CJS/ESM builds, do not include test files + "include": ["src", "artifacts/*.json"], + // DO NOT MODIFY MANUALLY BEYOND THIS POINT + // References are automatically maintained by `yarn fix-references` + "references": [ + { + "path": "../../lib/pcd-types/tsconfig.cjs.json" + }, + { + "path": "../../lib/pod/tsconfig.cjs.json" + } + ] +} diff --git a/packages/pcd/pod-email-pcd/tsconfig.esm.json b/packages/pcd/pod-email-pcd/tsconfig.esm.json new file mode 100644 index 0000000000..f3a6c67757 --- /dev/null +++ b/packages/pcd/pod-email-pcd/tsconfig.esm.json @@ -0,0 +1,20 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "dist/esm", + "module": "ESNext", + "tsBuildInfoFile": "./tsconfig.esm.tsbuildinfo" + }, + // For CJS/ESM builds, do not include test files + "include": ["src", "artifacts/*.json"], + // DO NOT MODIFY MANUALLY BEYOND THIS POINT + // References are automatically maintained by `yarn fix-references` + "references": [ + { + "path": "../../lib/pcd-types/tsconfig.esm.json" + }, + { + "path": "../../lib/pod/tsconfig.esm.json" + } + ] +} diff --git a/packages/pcd/pod-email-pcd/tsconfig.json b/packages/pcd/pod-email-pcd/tsconfig.json new file mode 100644 index 0000000000..d92cf82558 --- /dev/null +++ b/packages/pcd/pod-email-pcd/tsconfig.json @@ -0,0 +1,33 @@ +{ + "extends": "@pcd/tsconfig/ts-library.json", + "compilerOptions": { + "lib": [ + "dom" + ], + "outDir": "dist", + "declarationDir": "dist/types", + // Include all source files, including tests + "rootDir": "." + }, + // Some artifact-including packages need to import a JSON file + "include": [ + "src", + "test", + "artifacts/*.json" + ], + "exclude": [ + "dist", + "build", + "node_modules" + ], + // DO NOT MODIFY MANUALLY BEYOND THIS POINT + // References are automatically maintained by `yarn fix-references` + "references": [ + { + "path": "../../lib/pcd-types" + }, + { + "path": "../../lib/pod" + } + ] +} diff --git a/packages/pcd/pod-email-pcd/turbo.json b/packages/pcd/pod-email-pcd/turbo.json new file mode 100644 index 0000000000..c8f0ef2b40 --- /dev/null +++ b/packages/pcd/pod-email-pcd/turbo.json @@ -0,0 +1,16 @@ +{ + "extends": ["//"], + "tasks": { + "build": { + "dependsOn": ["^build"], + "inputs": ["$TURBO_DEFAULT$", "src/**", "test/**"], + "outputs": ["dist/**", "*.tsbuildinfo"], + "cache": true + }, + "test": { + "cache": true, + "dependsOn": ["build", "^gen-test-artifacts"], + "inputs": ["$TURBO_DEFAULT$", "test/**"] + } + } +} diff --git a/packages/pcd/pod-email-pcd/typedoc.json b/packages/pcd/pod-email-pcd/typedoc.json new file mode 100644 index 0000000000..35fed2c958 --- /dev/null +++ b/packages/pcd/pod-email-pcd/typedoc.json @@ -0,0 +1,3 @@ +{ + "entryPoints": ["src/index.ts"] +} diff --git a/packages/ui/pod-email-pcd-ui/.eslintrc.js b/packages/ui/pod-email-pcd-ui/.eslintrc.js new file mode 100644 index 0000000000..dac5168f48 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/.eslintrc.js @@ -0,0 +1,4 @@ +module.exports = { + extends: ["@pcd/eslint-config-custom"], + root: true, +}; diff --git a/packages/ui/pod-email-pcd-ui/.gitignore b/packages/ui/pod-email-pcd-ui/.gitignore new file mode 100644 index 0000000000..eac8df2616 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/.gitignore @@ -0,0 +1,5 @@ +*.js +*.ts.map +!.eslintrc.js +dist +*.tsbuildinfo \ No newline at end of file diff --git a/packages/ui/pod-email-pcd-ui/LICENSE b/packages/ui/pod-email-pcd-ui/LICENSE new file mode 100644 index 0000000000..671274c0b8 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2023 0xPARC Foundation + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/packages/ui/pod-email-pcd-ui/package.json b/packages/ui/pod-email-pcd-ui/package.json new file mode 100644 index 0000000000..0a515aa4e9 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/package.json @@ -0,0 +1,42 @@ +{ + "name": "@pcd/pod-email-pcd-ui", + "private": false, + "version": "0.1.0", + "license": "GPL-3.0-or-later", + "main": "./dist/cjs/src/index.js", + "module": "./dist/esm/src/index.js", + "types": "./dist/types/src/index.d.ts", + "exports": { + ".": { + "types": "./dist/types/src/index.d.ts", + "import": "./dist/esm/src/index.js", + "require": "./dist/cjs/src/index.js" + } + }, + "files": [ + "dist", + "./README.md", + "./LICENSE" + ], + "scripts": { + "lint": "eslint \"**/*.ts{,x}\"", + "build": "tsc -b tsconfig.cjs.json tsconfig.esm.json", + "typecheck": "yarn tsc --noEmit", + "prepublishOnly": "yarn clean && yarn build", + "clean": "rm -rf dist node_modules *.tsbuildinfo" + }, + "dependencies": { + "@pcd/passport-ui": "0.15.0", + "@pcd/pcd-types": "0.15.0", + "@pcd/pod-email-pcd": "0.1.0" + }, + "devDependencies": { + "@pcd/eslint-config-custom": "0.15.0", + "@pcd/tsconfig": "0.15.0", + "eslint": "^8.57.0", + "typescript": "^5.3.3" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/ui/pod-email-pcd-ui/src/CardBody.tsx b/packages/ui/pod-email-pcd-ui/src/CardBody.tsx new file mode 100644 index 0000000000..d578cc0f91 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/src/CardBody.tsx @@ -0,0 +1,58 @@ +import { styled } from "@pcd/passport-ui"; +import { PCDUI } from "@pcd/pcd-types"; +import { PODEmailPCD } from "@pcd/pod-email-pcd"; + +export const PODEmailPCDUI: PCDUI = { + renderCardBody: PODEmailCardBody +}; + +function PODEmailCardBody({ pcd }: { pcd: PODEmailPCD }): JSX.Element { + const emailAddress = pcd.claim.podEntries.emailAddress.value; + if (!emailAddress) return <>; + const [username, domain] = emailAddress.split("@"); + + return ( + + + + {username} + @{domain} +
+ + + + ); +} + +const Container = styled.span` + padding: 16px; + overflow: hidden; + width: 100%; +`; + +const EmailInfo = styled.div` + margin-top: 8px; + display: flex; + justify-content: center; + align-items: center; + flex-direction: column; +`; + +const EmailWrapper = styled.div` + display: flex; + max-width: 80%; + overflow: hidden; +`; + +const Username = styled.span` + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; + flex: 1; + min-width: 0; +`; + +const Domain = styled.span` + flex-shrink: 0; + margin-left: -1px; +`; diff --git a/packages/ui/pod-email-pcd-ui/src/index.ts b/packages/ui/pod-email-pcd-ui/src/index.ts new file mode 100644 index 0000000000..3eda2d6bb7 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/src/index.ts @@ -0,0 +1 @@ +export * from "./CardBody"; diff --git a/packages/ui/pod-email-pcd-ui/tsconfig.cjs.json b/packages/ui/pod-email-pcd-ui/tsconfig.cjs.json new file mode 100644 index 0000000000..ca5d286aa5 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/tsconfig.cjs.json @@ -0,0 +1,23 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "dist/cjs", + "module": "CommonJS", + "tsBuildInfoFile": "./tsconfig.cjs.tsbuildinfo" + }, + // For CJS/ESM builds, do not include test files + "include": ["src", "artifacts/*.json"], + // DO NOT MODIFY MANUALLY BEYOND THIS POINT + // References are automatically maintained by `yarn fix-references` + "references": [ + { + "path": "../../lib/passport-ui/tsconfig.cjs.json" + }, + { + "path": "../../lib/pcd-types/tsconfig.cjs.json" + }, + { + "path": "../../pcd/pod-email-pcd/tsconfig.cjs.json" + } + ] +} diff --git a/packages/ui/pod-email-pcd-ui/tsconfig.esm.json b/packages/ui/pod-email-pcd-ui/tsconfig.esm.json new file mode 100644 index 0000000000..cb9dd04a6a --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/tsconfig.esm.json @@ -0,0 +1,23 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "dist/esm", + "module": "ESNext", + "tsBuildInfoFile": "./tsconfig.esm.tsbuildinfo" + }, + // For CJS/ESM builds, do not include test files + "include": ["src", "artifacts/*.json"], + // DO NOT MODIFY MANUALLY BEYOND THIS POINT + // References are automatically maintained by `yarn fix-references` + "references": [ + { + "path": "../../lib/passport-ui/tsconfig.esm.json" + }, + { + "path": "../../lib/pcd-types/tsconfig.esm.json" + }, + { + "path": "../../pcd/pod-email-pcd/tsconfig.esm.json" + } + ] +} diff --git a/packages/ui/pod-email-pcd-ui/tsconfig.json b/packages/ui/pod-email-pcd-ui/tsconfig.json new file mode 100644 index 0000000000..910882e435 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/tsconfig.json @@ -0,0 +1,36 @@ +{ + "extends": "@pcd/tsconfig/ts-library.json", + "compilerOptions": { + "lib": [ + "dom" + ], + "outDir": "dist", + "declarationDir": "dist/types", + // Include all source files, including tests + "rootDir": "." + }, + // Some artifact-including packages need to import a JSON file + "include": [ + "src", + "test", + "artifacts/*.json" + ], + "exclude": [ + "dist", + "build", + "node_modules" + ], + // DO NOT MODIFY MANUALLY BEYOND THIS POINT + // References are automatically maintained by `yarn fix-references` + "references": [ + { + "path": "../../lib/passport-ui" + }, + { + "path": "../../lib/pcd-types" + }, + { + "path": "../../pcd/pod-email-pcd" + } + ] +} diff --git a/packages/ui/pod-email-pcd-ui/turbo.json b/packages/ui/pod-email-pcd-ui/turbo.json new file mode 100644 index 0000000000..c8f0ef2b40 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/turbo.json @@ -0,0 +1,16 @@ +{ + "extends": ["//"], + "tasks": { + "build": { + "dependsOn": ["^build"], + "inputs": ["$TURBO_DEFAULT$", "src/**", "test/**"], + "outputs": ["dist/**", "*.tsbuildinfo"], + "cache": true + }, + "test": { + "cache": true, + "dependsOn": ["build", "^gen-test-artifacts"], + "inputs": ["$TURBO_DEFAULT$", "test/**"] + } + } +} diff --git a/packages/ui/pod-email-pcd-ui/typedoc.json b/packages/ui/pod-email-pcd-ui/typedoc.json new file mode 100644 index 0000000000..35fed2c958 --- /dev/null +++ b/packages/ui/pod-email-pcd-ui/typedoc.json @@ -0,0 +1,3 @@ +{ + "entryPoints": ["src/index.ts"] +} diff --git a/tsconfig.cjs.json b/tsconfig.cjs.json index 76a80c4de3..af23840c65 100644 --- a/tsconfig.cjs.json +++ b/tsconfig.cjs.json @@ -87,6 +87,9 @@ { "path": "packages/pcd/obj-pcd/tsconfig.cjs.json" }, + { + "path": "packages/pcd/pod-email-pcd/tsconfig.cjs.json" + }, { "path": "packages/pcd/pod-pcd/tsconfig.cjs.json" }, @@ -153,6 +156,9 @@ { "path": "packages/ui/message-pcd-ui/tsconfig.cjs.json" }, + { + "path": "packages/ui/pod-email-pcd-ui/tsconfig.cjs.json" + }, { "path": "packages/ui/pod-pcd-ui/tsconfig.cjs.json" }, diff --git a/tsconfig.esm.json b/tsconfig.esm.json index 65fda24a60..cf229107bd 100644 --- a/tsconfig.esm.json +++ b/tsconfig.esm.json @@ -87,6 +87,9 @@ { "path": "packages/pcd/obj-pcd/tsconfig.esm.json" }, + { + "path": "packages/pcd/pod-email-pcd/tsconfig.esm.json" + }, { "path": "packages/pcd/pod-pcd/tsconfig.esm.json" }, @@ -153,6 +156,9 @@ { "path": "packages/ui/message-pcd-ui/tsconfig.esm.json" }, + { + "path": "packages/ui/pod-email-pcd-ui/tsconfig.esm.json" + }, { "path": "packages/ui/pod-pcd-ui/tsconfig.esm.json" },