@idos-network/issuer 1.0.0-rc.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 idOS Network
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# idOS Issuer JavaScript SDK
+
+See [Issuer guide](../../docs/guide-issuer.md)
+
+
+## Developing the SDK locally
+
+Run:
+```bash
+pnpm dev
+```
+
+This will start the compiler in watch mode that will rebuild every time any of the source files are changed.
+
+You can also create a production build by running the following command in the root folder of the SDK package:
+
+```bash
+pnpm build
+```

package/dist/index.d.ts

@@ -0,0 +1,205 @@
+import nacl, { SignKeyPair } from "tweetnacl";
+
+//#region ../@core/src/types/index.d.ts
+
+type idOSUser = {
+  id: string;
+  recipient_encryption_public_key: string;
+};
+type idOSCredential = {
+  id: string;
+  user_id: string;
+  issuer_auth_public_key: string;
+  original_id?: string;
+  public_notes: string;
+  content: string;
+  encryptor_public_key: string;
+};
+type idOSWallet = {
+  id: string;
+  user_id: string;
+  address: string;
+  wallet_type: string;
+  message: string;
+  public_key: string;
+  signature: string;
+};
+type idOSUserAttribute = {
+  id: string;
+  attribute_key: string;
+  value: string;
+  user_id?: string;
+};
+type idOSGrant = {
+  id: string;
+  ag_owner_user_id: string;
+  ag_grantee_wallet_identifier: string;
+  data_id: string;
+  locked_until: string;
+  content_hash?: string;
+}; //#endregion
+//#region ../@core/src/kwil-actions/credentials.d.ts
+
+interface EditCredentialAsIssuerParams {
+  public_notes_id: string;
+  public_notes: string;
+} //#endregion
+//#region src/services/credential.service.d.ts
+
+/**
+* Edits the public notes of an idOSCredential if the signer is a permissioned issuer.
+* This is how a credential is edited (modified) by a permissioned issuer.
+*/
+type BaseCredentialParams = {
+  id?: string;
+  userId: string;
+  publicNotes: string;
+  plaintextContent: Uint8Array;
+  recipientEncryptionPublicKey: Uint8Array;
+};
+type DelegatedWriteGrantBaseParams = Omit<BaseCredentialParams, "userId">;
+type DelegatedWriteGrantParams = {
+  id: string;
+  ownerWalletIdentifier: string;
+  consumerWalletIdentifier: string;
+  issuerPublicKey: string;
+  accessGrantTimelock: string;
+  notUsableBefore: string;
+  notUsableAfter: string;
+  signature: string;
+};
+
+//#endregion
+//#region src/services/credentials-builder.service.d.ts
+interface CredentialFields {
+  id: string;
+  /* Level of KYC verification performed (e.g., basic, intermediate, advanced). */
+  level: string;
+  /* @default Date.now() */
+  issued?: Date;
+  /* Date the credential was approved. */
+  approvedAt?: Date;
+  /* Date the credential was revoked. */
+  expirationDate?: Date;
+}
+interface CredentialResidentialAddress {
+  /* Street address. */
+  street: string;
+  /* House number. */
+  houseNumber?: string;
+  /* Additional address information (e.g., apartment number). */
+  additionalAddressInfo?: string;
+  /* Locality (e.g., city, town). */
+  city: string;
+  /* Postal code. */
+  postalCode: string;
+  /* Country. */
+  country: string;
+}
+interface CredentialSubject {
+  /* ID(unique credential)	Unique identifier for the credential itself. */
+  id: string;
+  /* Given name of the individual. */
+  firstName: string;
+  /* Surname of the individual. */
+  familyName: string;
+  /* Family name at birth (e.g., maiden name). */
+  maidenName?: string;
+  /* Unique identifier issued by a government authority (e.g., SSN, Tax ID). */
+  governmentId?: string;
+  /* Type of government identifier (e.g., Social Security Number, Tax ID, etc.). */
+  governmentIdType?: string;
+  /* Date of birth of the individual. */
+  dateOfBirth: Date;
+  /* City and state/province of birth. */
+  placeOfBirth: string;
+  /* Country that issued the identity document. */
+  idDocumentCountry: string;
+  /* ID Document Number	Unique number on the identity document. */
+  idDocumentNumber: string;
+  /* ID Document Type	Type of identity document(e.g., Passport, Driver's License, National ID). */
+  idDocumentType: string;
+  /* ID Document Date of Issue	Date the identity document was issued. */
+  idDocumentDateOfIssue: Date;
+  /* ID Document Date of Expiry	Expiration date of the identity document - if applicable. */
+  idDocumentDateOfExpiry?: Date;
+  /* ID Document Front File	File or URL representing the front of the identity document. */
+  idDocumentFrontFile: Buffer;
+  /* ID Document Back File	File or URL representing the back of the identity document - if applicable. */
+  idDocumentBackFile?: Buffer;
+  /* (ID Document) Selfie File	File or URL of a selfie with the identity document for verification purposes. */
+  selfieFile: Buffer;
+  /* Residential Address	Full residential address of the individual - if applicable. */
+  residentialAddress?: CredentialResidentialAddress;
+  /* Residential Address Proof Category	Type of document provided to verify the address(e.g., utility bill, bank statement). */
+  residentialAddressProofCategory?: string;
+  /* Residential Address Proof Date Of Issue	Date the address proof document was issued. */
+  residentialAddressProofDateOfIssue?: Date;
+  /* Residential Address Proof File	File or URL of the document provided as address proof. */
+  residentialAddressProofFile?: Buffer;
+}
+interface CredentialsIssuerConfig {
+  /* Issuers id */
+  id: string;
+  /* Issuer of the credential (URL). */
+  controller: string;
+  /* Issuer's private key in multibase format. */
+  privateKeyMultibase: string;
+  /* Issuer's public key in multibase format. */
+  publicKeyMultibase: string;
+} //#endregion
+//#region src/services/grant.service.d.ts
+type CreateAccessGrantFromDAGParams = {
+  dag_data_id: string;
+  dag_owner_wallet_identifier: string;
+  dag_grantee_wallet_identifier: string;
+  dag_signature: string;
+  dag_locked_until: number;
+  dag_content_hash: string;
+};
+
+//#endregion
+//#region src/services/user.service.d.ts
+type CreateProfileReqParams = Omit<idOSUser, "id"> & {
+  id?: string;
+};
+type UpsertWalletReqParams = Omit<idOSWallet, "id"> & {
+  id?: string;
+};
+type CreateWalletReqParams = Omit<UpsertWalletReqParams, "user_id"> & {
+  id?: string;
+};
+
+//#endregion
+//#region src/index.d.ts
+type CreateIssuerParams = {
+  chainId?: string;
+  nodeUrl: string;
+  signingKeyPair: SignKeyPair;
+  encryptionSecretKey: Uint8Array;
+};
+declare class idOSIssuer {
+  #private;
+  static init(params: CreateIssuerParams): Promise<idOSIssuer>;
+  private constructor();
+  // User Service facade methods
+  hasProfile(userAddress: string): Promise<boolean>;
+  createUserProfile(params: CreateProfileReqParams): Promise<idOSUser>;
+  upsertWalletAsInserter(params: UpsertWalletReqParams): Promise<idOSWallet>;
+  createUser(user: CreateProfileReqParams, wallet: CreateWalletReqParams): Promise<[idOSUser, idOSWallet]>;
+  createCredentialByDelegatedWriteGrant(credentialParams: DelegatedWriteGrantBaseParams, delegatedWriteGrant: DelegatedWriteGrantParams, consumerEncryptionPublicKey?: Uint8Array): Promise<{
+    originalCredential: Omit<idOSCredential, "user_id">;
+    copyCredential: Omit<idOSCredential, "user_id">;
+  }>;
+  editCredentialAsIssuer(publicNotesId: string, publicNotes: string): Promise<EditCredentialAsIssuerParams | null>;
+  getCredentialIdByContentHash(contentHash: string): Promise<string | null>;
+  getSharedCredential(id: string): Promise<idOSCredential | null>;
+  createAccessGrantFromDAG(params: CreateAccessGrantFromDAGParams): Promise<CreateAccessGrantFromDAGParams | null>;
+  buildCredentials(fields: CredentialFields, subject: CredentialSubject, issuer: CredentialsIssuerConfig): Promise<any>;
+  // biome-ignore lint/suspicious/noExplicitAny: Using `any` to avoid type errors.
+  buildDocumentLoader(): any;
+}
+
+//#endregion
+export { idOSCredential, idOSGrant, idOSIssuer, idOSUser, idOSUserAttribute, idOSWallet };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["message: Extract<IsleNodeMessage, { type: T }>","kwilClient: KwilActionClient","id: string","content_hash: string","params: GetAccessGrantByCredentialIdParams","params: EditCredentialAsIssuerParams","userId: string","params: CreateCredentialByDelegatedWriteGrantParams","credential: ShareableCredential","params: CreateCredentialCopyParams","kwilClient: KwilActionClient","signingKeyPair: nacl.SignKeyPair","encryptionSecretKey: Uint8Array","credentialParams: DelegatedWriteGrantBaseParams","delegatedWriteGrant: DelegatedWriteGrantParams","consumerEncryptionPublicKey?: Uint8Array","publicNotesId: string","publicNotes: string","contentHash: string","id: string","fields: CredentialFields","subject: CredentialSubject","issuer: CredentialsIssuerConfig","kwilClient: KwilActionClient","encryptionSecretKey: Uint8Array","params: CreateAccessGrantFromDAGParams","getCredentialIdByContentHash: (contentHash: string) => Promise<string | null>","contentHash: string","getSharedCredential: (id: string) => Promise<idOSCredential | null>","id: string","kwilClient: KwilActionClient","userAddress: string","params: CreateProfileReqParams","params: UpsertWalletReqParams","user: CreateProfileReqParams","wallet: CreateWalletReqParams","params: CreateIssuerParams","userAddress: string","params: CreateProfileReqParams","params: UpsertWalletReqParams","user: CreateProfileReqParams","wallet: CreateWalletReqParams","credentialParams: DelegatedWriteGrantBaseParams","delegatedWriteGrant: DelegatedWriteGrantParams","consumerEncryptionPublicKey?: Uint8Array","publicNotesId: string","publicNotes: string","contentHash: string","id: string","params: CreateAccessGrantFromDAGParams","fields: CredentialFields","subject: CredentialSubject","issuer: CredentialsIssuerConfig"],"sources":["../../@core/src/types/index.ts","../../@core/src/kwil-actions/credentials.ts","../src/services/credential.service.ts","../src/services/credentials-builder.service.ts","../src/services/grant.service.ts","../src/services/user.service.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;;AAwCY,KAhCA,QAAA,GAgCA;EAOZ,EAAA,EAAY,MAAA;;;KAlCA,cAAA;ECoDZ,EAAA,EAAiB,MAAA;;;;EC9BjB,YAAY,EAAA,MAAA;EAAA,OAAA,EAAA,MAAA;EAAA,oBAIQ,EAAA,MAAA;CAAA;AAMR,KFfA,UAAA,GEeA;;;;ECnCZ,WAAiB,EAAA,MAAA;EAAA,OAAA,EAAA,MAAA;EAAA,UAON,EAAA,MAAA;EAAA,SAGI,EAAA,MAAA;CAAA;AAGI,KHiBP,iBAAA,GGjBO;EAGnB,EAAA,EAAiB,MAAA;EAoBjB,aAAiB,EAAA,MAAA;EAAA,KAAA,EAAA,MAAA;EAAA,OAoBF,CAAA,EAAA,MAAA;CAAA;AAkBY,KHrCf,SAAA,GGqCe;EAAA,EAAA,EAAA,MAGJ;EAAA,gBAGA,EAAA,MAAA;EAAA,4BAGT,EAAA,MAAA;EAAA,OAGS,EAAA,MAAA;EAAA,YAMgB,EAAA,MAAA;EAAA,YAGP,CAAA,EAAA,MAAA;AAAA,CAAA,CAAA;;;AD9DpB,UDsBK,4BAAA,CCtBL;EAAA,eAAqC,EAAA,MAAA;EAAA,YAAL,EAAA,MAAA;AAAA,CAAA;;;AAE5C;;;;AFhCY,KEsBA,oBAAA,GFtBA;EAiBZ,EAAA,CAAY,EAAA,MAAA;EAUZ,MAAY,EAAA,MAAA;EAOZ,WAAY,EAAA,MAAA;oBERQ;gCACY;;ADyBf,KCtBL,6BAAA,GAAgC,IDsB3B,CCtBgC,oBDsBhC,EAAA,QAAA,CAAA;KCpBL,yBAAA;;;EAVZ,wBAAY,EAAA,MAAA;EAAA,eAAA,EAAA,MAAA;EAAA,mBAIQ,EAAA,MAAA;EAAA,eACY,EAAA,MAAA;EAAA,cAAA,EAAA,MAAA;EAGhC,SAAY,EAAA,MAAA;CAAA;;;;UCjCK,gBAAA;;;EHFjB,KAAY,EAAA,MAAA;EAKZ;EAiBA,MAAY,CAAA,EGbD,IHaC;EAUZ;EAOA,UAAY,CAAA,EG3BG,IH2BH;;mBGxBO;;AF0CF,UEvCA,4BAAA,CFuCA;;;;EC9BjB,WAAY,CAAA,EAAA,MAAA;EAAA;EAAA,qBAIQ,CAAA,EAAA,MAAA;EAAA;EACY,IAAA,EAAA,MAAA;EAGhC;EAAY,UAAA,EAAA,MAAA;EAAA;EAAqC,OAAL,EAAA,MAAA;AAAA;AAEhC,UCCK,iBAAA,CDDL;;;;ECnCZ,SAAiB,EAAA,MAAA;EAAA;EAAA,UAON,EAAA,MAAA;EAAA;EAGI,UAGI,CAAA,EAAA,MAAA;EAAA;EAGnB,YAAiB,CAAA,EAAA,MAAA;EAoBjB;EAAiB,gBAAA,CAAA,EAAA,MAAA;EAAA;EAoBF,WAeU,EAfV,IAeU;EAAA;EAGE,YAGJ,EAAA,MAAA;EAAA;EAGA,iBAGT,EAAA,MAAA;EAAA;EAGS,gBAMgB,EAAA,MAAA;EAAA;EAGP,cAAA,EAAA,MAAA;EAGhC;yBA3ByB;;2BAGE;ECzE3B;uBD4EuB;;uBAGA;EElFvB;EAAY,UAAA,EFqFE,MErFF;EAAA;EAA8B,kBAAL,CAAA,EFwFd,4BExFc;EAAA;EAIrC,+BAAY,CAAA,EAAA,MAAA;EAAA;EAAA,kCAA6B,CAAA,EF0FF,IE1FE;EAAA;EAAL,2BAAA,CAAA,EF6FJ,ME7FI;AAIpC;AAAY,UF4FK,uBAAA,CE5FL;EAAA;EAA6B,EAAA,EAAA,MAAL;EAAA;;;;ECcH;EAE5B,kBAAA,EAAA,MAAA;CAAA;;KFrBO,8BAAA;;EJHZ,2BAAY,EAAA,MAAA;EAKZ,6BAAY,EAAA,MAAA;EAiBZ,aAAY,EAAA,MAAA;EAUZ,gBAAY,EAAA,MAAA;EAOZ,gBAAY,EAAA,MAAA;;;;;KKvCA,sBAAA,GAAyB,KAAK;ELA1C,EAAA,CAAY,EAAA,MAAA;AAKZ,CAAA;AAiBY,KKlBA,qBAAA,GAAwB,ILkBxB,CKlB6B,ULkB7B,EAAA,IAAA,CAAA,GAAA;EAUZ,EAAA,CAAY,EAAA,MAAA;AAOZ,CAAA;KK/BY,qBAAA,GAAwB,KAAK;;;;;;AL+BzC,KMfK,kBAAA,GNeO;;;kBMZM;EL8BlB,mBAAiB,EK7BM,UL6BN;;cK1BJ,UAAA;;EJJb,OAAY,IAAA,CAAA,MAAA,EIUgB,kBJVhB,CAAA,EIUqC,OJVrC,CIU6C,UJV7C,CAAA;EAAA,QAAA,WAAA,CAAA;EAAA;EAIQ,UACY,CAAA,WAAA,EAAA,MAAA,CAAA,EIwCS,OJxCT,CAAA,OAAA,CAAA;EAAA,iBAAA,CAAA,MAAA,EI4CE,sBJ5CF,CAAA,EI4C2B,OJ5C3B,CI4CmC,QJ5CnC,CAAA;EAGhC,sBAAY,CAAA,MAAA,EI6C2B,qBJ7C3B,CAAA,EI6CmD,OJ7CnD,CI6C2D,UJ7C3D,CAAA;EAAA,UAAA,CAAA,IAAA,EIkDF,sBJlDE,EAAA,MAAA,EImDA,qBJnDA,CAAA,EIoDP,OJpDO,CAAA,CIoDE,QJpDF,EIoDY,UJpDZ,CAAA,CAAA;EAAA,qCAAqC,CAAA,gBAAA,EIyD3B,6BJzD2B,EAAA,mBAAA,EI0DxB,yBJ1DwB,EAAA,2BAAA,CAAA,EI2Df,UJ3De,CAAA,EI4D5C,OJ5D4C,CAAA;IAAA,kBAAL,EI6DpB,IJ7DoB,CI6Df,cJ7De,EAAA,SAAA,CAAA;IAAA,cAAA,EI8DxB,IJ9DwB,CI8DnB,cJ9DmB,EAAA,SAAA,CAAA;EAE5C,CAAA,CAAA;sEIwEK,QAAQ;qDAI8C;mCAIlB,QAAQ;EHnHjD,wBAAiB,CAAA,MAAA,EGwHL,8BHxHK,CAAA,EGyHZ,OHzHY,CGyHJ,8BHzHI,GAAA,IAAA,CAAA;EAAA,gBAAA,CAAA,MAAA,EGkIL,gBHlIK,EAAA,OAAA,EGmIJ,iBHnII,EAAA,MAAA,EGoIL,uBHpIK,CAAA,EGsIZ,OHtIY,CAAA,GAAA,CAAA;EAAA;EAON,mBAGI,CAAA,CAAA,EAAA,GAAA"}