Merge branch 'develop' into release/v4.0.0

js/credentials/credential/credential.d.ts

@@ -1,6 +1,7 @@
 import { ICredentialAttrs, IClaimSection } from './types';
-import { BaseMetadata, ContextEntry } from 'cred-types-jolocom-core';
+import { BaseMetadata } from 'cred-types-jolocom-core';
 import { ISignedCredCreationArgs } from '../signedCredential/types';
+import { JsonLdContext } from '../../linkedData/types';
 export declare class Credential {
     private '_@context';
     private _id;
@@ -11,7 +12,7 @@ export declare class Credential {
     claim: IClaimSection;
     type: string[];
     name: string;
-    context: ContextEntry[];
+    context: JsonLdContext;
     static create<T extends BaseMetadata>({ metadata, claim, subject, }: ISignedCredCreationArgs<T>): Credential;
     static fromJSON(json: ICredentialAttrs): Credential;
     toJSON(): ICredentialAttrs;

js/credentials/credential/types.d.ts

@@ -1,12 +1,12 @@
-import { ContextEntry, ClaimInterface } from 'cred-types-jolocom-core';
+import { ClaimInterface } from 'cred-types-jolocom-core';
+import { JsonLdObject } from '../../linkedData/types';
 declare type ClaimType = string | number | boolean | {};
 export declare type ClaimEntry = ClaimType | ClaimInterface;
 export interface IClaimSection {
     id?: string;
     [x: string]: ClaimEntry;
 }
-export interface ICredentialAttrs {
-    '@context': ContextEntry[];
+export interface ICredentialAttrs extends JsonLdObject {
     type: string[];
     name?: string;
     claim: ClaimEntry;

js/credentials/signedCredential/signedCredential.d.ts

@@ -2,8 +2,9 @@
 import 'reflect-metadata';
 import { ISignedCredCreationArgs, ISignedCredentialAttrs } from './types';
 import { IDigestable, ILinkedDataSignature } from '../../linkedDataSignature/types';
-import { BaseMetadata, ContextEntry } from 'cred-types-jolocom-core';
+import { BaseMetadata } from 'cred-types-jolocom-core';
 import { IClaimSection } from '../credential/types';
+import { JsonLdContext } from '../../linkedData/types';
 import { ISigner } from '../../registries/types';
 interface IIssInfo {
     keyId: string;
@@ -19,7 +20,7 @@ export declare class SignedCredential implements IDigestable {
     private _issued;
     private _expires?;
     private _proof;
-    context: ContextEntry[];
+    context: JsonLdContext;
     id: string;
     issuer: string;
     issued: Date;
@@ -34,7 +35,6 @@ export declare class SignedCredential implements IDigestable {
     static create<T extends BaseMetadata>(credentialOptions: ISignedCredCreationArgs<T>, issInfo: IIssInfo, expires?: Date): Promise<SignedCredential>;
     private prepareSignature;
     digest(): Promise<Buffer>;
-    private normalize;
     static fromJSON(json: ISignedCredentialAttrs): SignedCredential;
     toJSON(): ISignedCredentialAttrs;
 }

js/credentials/signedCredential/types.d.ts

@@ -1,13 +1,12 @@
 import { ICredentialAttrs, IClaimSection } from '../credential/types';
-import { ILinkedDataSignatureAttrs } from '../../linkedDataSignature/types';
 import { BaseMetadata } from 'cred-types-jolocom-core';
-export interface ISignedCredentialAttrs extends ICredentialAttrs {
+import { SignedJsonLdObject } from '../../linkedData/types';
+export interface ISignedCredentialAttrs extends SignedJsonLdObject, ICredentialAttrs {
     id: string;
     issuer: string;
     issued: string;
     expires?: string;
     claim: IClaimSection;
-    proof: ILinkedDataSignatureAttrs;
 }
 export interface ISignedCredCreationArgs<T extends BaseMetadata> {
     metadata: T;

js/identity/didDocument/didDocument.d.ts

@@ -2,7 +2,7 @@
 import { IDidDocumentAttrs } from './types';
 import { AuthenticationSection, PublicKeySection, ServiceEndpointsSection } from './sections';
 import { ISigner } from '../../registries/types';
-import { ContextEntry } from 'cred-types-jolocom-core';
+import { JsonLdContext } from '../../linkedData/types';
 import { ILinkedDataSignature, IDigestable } from '../../linkedDataSignature/types';
 export declare class DidDocument implements IDigestable {
     private _id;
@@ -12,7 +12,7 @@ export declare class DidDocument implements IDigestable {
     private _created;
     private _proof;
     private '_@context';
-    context: ContextEntry[];
+    context: JsonLdContext;
     did: string;
     authentication: AuthenticationSection[];
     publicKey: PublicKeySection[];
@@ -28,7 +28,6 @@ export declare class DidDocument implements IDigestable {
     static fromPublicKey(publicKey: Buffer): DidDocument;
     private prepareSignature;
     digest(): Promise<Buffer>;
-    normalize(): Promise<string>;
     toJSON(): IDidDocumentAttrs;
     static fromJSON(json: IDidDocumentAttrs): DidDocument;
 }

js/identity/didDocument/sections/types.d.ts

@@ -1,13 +1,14 @@
-export interface IPublicKeySectionAttrs {
+import { JsonLdObject } from '../../../linkedData/types';
+export interface IPublicKeySectionAttrs extends JsonLdObject {
     id: string;
     type: string;
     publicKeyHex: string;
 }
-export interface IAuthenticationSectionAttrs {
+export interface IAuthenticationSectionAttrs extends JsonLdObject {
     publicKey: string;
     type: string;
 }
-export interface IServiceEndpointSectionAttrs {
+export interface IServiceEndpointSectionAttrs extends JsonLdObject {
     id: string;
     type: string;
     serviceEndpoint: string;

js/identity/didDocument/types.d.ts

@@ -1,12 +1,9 @@
 import { IPublicKeySectionAttrs, IAuthenticationSectionAttrs, IServiceEndpointSectionAttrs } from './sections/types';
-import { ILinkedDataSignatureAttrs } from '../../linkedDataSignature/types';
-import { ContextEntry } from 'cred-types-jolocom-core';
-export interface IDidDocumentAttrs {
-    '@context': ContextEntry[];
+import { SignedJsonLdObject } from '../../linkedData/types';
+export interface IDidDocumentAttrs extends SignedJsonLdObject {
     id: string;
     authentication: IAuthenticationSectionAttrs[];
     publicKey: IPublicKeySectionAttrs[];
     service: IServiceEndpointSectionAttrs[];
     created: string;
-    proof: ILinkedDataSignatureAttrs;
 }

js/linkedData/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { ILinkedDataSignatureAttrs } from '../linkedDataSignature/types';
+import { IRegistry } from '../registries/types';
+import { JsonLdObject, SignedJsonLdObject, JsonLdContext } from './types';
+export declare const normalizeJsonLd: ({ ["@context"]: _, ...data }: JsonLdObject, context: JsonLdContext) => Promise<any>;
+export declare const normalizeLdProof: ({ signatureValue, id, type, ...toNormalize }: ILinkedDataSignatureAttrs, context: JsonLdContext) => Promise<string>;
+export declare const digestJsonLd: ({ proof, ["@context"]: _, ...data }: SignedJsonLdObject, context: JsonLdContext) => Promise<Buffer>;
+export declare const validateJsonLd: (json: SignedJsonLdObject, customRegistry?: IRegistry) => Promise<boolean>;

js/linkedData/types.d.ts

@@ -0,0 +1,12 @@
+import { ILinkedDataSignatureAttrs } from '../linkedDataSignature/types';
+import { ContextEntry } from 'cred-types-jolocom-core';
+declare type JsonLdPrimitive = string | number | boolean | JsonLdObject | JsonLdObject[];
+export declare type JsonLdContext = ContextEntry | ContextEntry[];
+export interface JsonLdObject {
+    '@context'?: JsonLdContext;
+    [key: string]: JsonLdPrimitive | JsonLdPrimitive[];
+}
+export interface SignedJsonLdObject extends JsonLdObject {
+    proof: ILinkedDataSignatureAttrs;
+}
+export {};

js/linkedDataSignature/types.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { JsonLdObject } from '../linkedData/types';
 export interface ISerializable {
     toJSON: () => {};
 }
@@ -16,7 +17,7 @@ export interface IDigestable {
         keyId: string;
     };
 }
-export interface ILinkedDataSignatureAttrs {
+export interface ILinkedDataSignatureAttrs extends JsonLdObject {
     type: string;
     created: string;
     creator: string;

js/utils/contexts.d.ts

@@ -1,3 +1,105 @@
-import { ContextEntry } from 'cred-types-jolocom-core';
-export declare const defaultContext: ContextEntry[];
-export declare const defaultContextIdentity: ContextEntry[];
+export declare const defaultContext: {
+    id: string;
+    type: string;
+    cred: string;
+    schema: string;
+    dc: string;
+    xsd: string;
+    sec: string;
+    Credential: string;
+    issuer: {
+        '@id': string;
+        '@type': string;
+    };
+    issued: {
+        '@id': string;
+        '@type': string;
+    };
+    claim: {
+        '@id': string;
+        '@type': string;
+    };
+    credential: {
+        '@id': string;
+        '@type': string;
+    };
+    expires: {
+        '@id': string;
+        '@type': string;
+    };
+    proof: {
+        '@id': string;
+        '@type': string;
+    };
+    EcdsaKoblitzSignature2016: string;
+    created: {
+        '@id': string;
+        '@type': string;
+    };
+    creator: {
+        '@id': string;
+        '@type': string;
+    };
+    domain: string;
+    nonce: string;
+    signatureValue: string;
+}[];
+export declare const defaultContextIdentity: {
+    id: string;
+    type: string;
+    dc: string;
+    rdfs: string;
+    schema: string;
+    sec: string;
+    didv: string;
+    xsd: string;
+    AuthenticationSuite: string;
+    CryptographicKey: string;
+    LinkedDataSignature2016: string;
+    authentication: string;
+    created: {
+        '@id': string;
+        '@type': string;
+    };
+    creator: {
+        '@id': string;
+        '@type': string;
+    };
+    digestAlgorithm: string;
+    digestValue: string;
+    domain: string;
+    entity: string;
+    expires: {
+        '@id': string;
+        '@type': string;
+    };
+    name: string;
+    nonce: string;
+    normalizationAlgorithm: string;
+    owner: {
+        '@id': string;
+        '@type': string;
+    };
+    privateKey: {
+        '@id': string;
+        '@type': string;
+    };
+    proof: string;
+    proofAlgorithm: string;
+    proofType: string;
+    proofValue: string;
+    publicKey: {
+        '@id': string;
+        '@type': string;
+        '@container': string;
+    };
+    publicKeyHex: string;
+    requiredProof: string;
+    revoked: {
+        '@id': string;
+        '@type': string;
+    };
+    signature: string;
+    signatureAlgorithm: string;
+    signatureValue: string;
+}[];

js/vaultedKeyProvider/softwareProvider.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { IDigestable } from '../linkedDataSignature/types';
-import { IVaultedKeyProvider, IKeyDerivationArgs } from './types';
+import { IKeyDerivationArgs, IVaultedKeyProvider } from './types';
 export interface EncryptedData {
     keys: EncryptedKey[];
     data: string;
@@ -26,8 +26,8 @@ export declare class SoftwareKeyProvider implements IVaultedKeyProvider {
     static verifyDigestable(publicKey: Buffer, toVerify: IDigestable): Promise<boolean>;
     private static encrypt;
     private static decrypt;
-    encryptHybrid(data: object, derivationArgs: IKeyDerivationArgs): Promise<string>;
-    decryptHybrid(encryptedData: EncryptedData, derivationArg: IKeyDerivationArgs): Promise<string>;
+    encryptHybrid(data: object, derivationArgs: IKeyDerivationArgs): Promise<EncryptedData>;
+    decryptHybrid(encryptedData: EncryptedData, derivationArg: IKeyDerivationArgs): Promise<object>;
     private stringifyEncryptedData;
     private parseEncryptedData;
     private static normalizePassword;