@twin.org/auditable-item-graph-models 0.0.1-next.7 → 0.0.1-next.9

package/dist/types/models/IAuditableItemGraphCredential.d.ts

@@ -1,34 +0,0 @@
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-/**
- * The data stored immutably for the graph in a verifiable credential.
- */
-export interface IAuditableItemGraphCredential {
-    /**
-     * JSON-LD Context.
-     */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
-    /**
-     * JSON-LD Type.
-     */
-    type: typeof AuditableItemGraphTypes.Credential;
-    /**
-     * The date/time of when the changeset was created.
-     */
-    dateCreated: string;
-    /**
-     * The user identity that created the changes.
-     */
-    userIdentity: string;
-    /**
-     * The signature for the changeset.
-     */
-    signature: string;
-    /**
-     * The signature for the changeset.
-     */
-    hash: string;
-    /**
-     * The integrity data for this changeset, encrypted.
-     */
-    integrity?: string;
-}

package/dist/types/models/IAuditableItemGraphVerification.d.ts

@@ -1,29 +0,0 @@
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { AuditableItemGraphVerificationState } from "./auditableItemGraphVerificationState";
-/**
- * Interface describing an auditable item graph verification.
- */
-export interface IAuditableItemGraphVerification {
-    /**
-     * JSON-LD Context.
-     */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
-    /**
-     * JSON-LD Type.
-     */
-    type: typeof AuditableItemGraphTypes.Verification;
-    /**
-     * The date/time of the verification.
-     */
-    dateCreated: string;
-    /**
-     * The state of the verification.
-     */
-    state: AuditableItemGraphVerificationState;
-    /**
-     * The state properties.
-     */
-    stateProperties?: {
-        [id: string]: unknown;
-    };
-}

package/dist/types/models/auditableItemGraphVerificationState.d.ts

@@ -1,37 +0,0 @@
-/**
- * The state of the verification.
- */
-export declare const AuditableItemGraphVerificationState: {
-    /**
-     * OK.
-     */
-    readonly Ok: "ok";
-    /**
-     * The stored hash does not matched the calculated one.
-     */
-    readonly HashMismatch: "hashMismatch";
-    /**
-     * The signature verification failed.
-     */
-    readonly SignatureNotVerified: "signatureNotVerified";
-    /**
-     * The credential in the immutable storage was revoked.
-     */
-    readonly CredentialRevoked: "credentialRevoked";
-    /**
-     * Immutable hash mismatch.
-     */
-    readonly ImmutableHashMismatch: "immutableHashMismatch";
-    /**
-     * Immutable signature mismatch.
-     */
-    readonly ImmutableSignatureMismatch: "immutableSignatureMismatch";
-    /**
-     * Integrity data mismatch.
-     */
-    readonly IntegrityDataMismatch: "integrityDataMismatch";
-};
-/**
- * The state of the verification.
- */
-export type AuditableItemGraphVerificationState = (typeof AuditableItemGraphVerificationState)[keyof typeof AuditableItemGraphVerificationState];

package/docs/reference/interfaces/IAuditableItemGraphCredential.md

@@ -1,59 +0,0 @@
-# Interface: IAuditableItemGraphCredential
-
-The data stored immutably for the graph in a verifiable credential.
-
-## Properties
-
-### @context
-
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
-
-JSON-LD Context.
-
-***
-
-### type
-
-> **type**: `"AuditableItemGraphPatchCredential"`
-
-JSON-LD Type.
-
-***
-
-### dateCreated
-
-> **dateCreated**: `string`
-
-The date/time of when the changeset was created.
-
-***
-
-### userIdentity
-
-> **userIdentity**: `string`
-
-The user identity that created the changes.
-
-***
-
-### signature
-
-> **signature**: `string`
-
-The signature for the changeset.
-
-***
-
-### hash
-
-> **hash**: `string`
-
-The signature for the changeset.
-
-***
-
-### integrity?
-
-> `optional` **integrity**: `string`
-
-The integrity data for this changeset, encrypted.

package/docs/reference/interfaces/IAuditableItemGraphVerification.md

@@ -1,47 +0,0 @@
-# Interface: IAuditableItemGraphVerification
-
-Interface describing an auditable item graph verification.
-
-## Properties
-
-### @context
-
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
-
-JSON-LD Context.
-
-***
-
-### type
-
-> **type**: `"AuditableItemGraphVerification"`
-
-JSON-LD Type.
-
-***
-
-### dateCreated
-
-> **dateCreated**: `string`
-
-The date/time of the verification.
-
-***
-
-### state
-
-> **state**: [`AuditableItemGraphVerificationState`](../type-aliases/AuditableItemGraphVerificationState.md)
-
-The state of the verification.
-
-***
-
-### stateProperties?
-
-> `optional` **stateProperties**: `object`
-
-The state properties.
-
-#### Index Signature
-
- \[`id`: `string`\]: `unknown`

package/docs/reference/type-aliases/AuditableItemGraphVerificationState.md

@@ -1,5 +0,0 @@
-# Type Alias: AuditableItemGraphVerificationState
-
-> **AuditableItemGraphVerificationState**: *typeof* [`AuditableItemGraphVerificationState`](../variables/AuditableItemGraphVerificationState.md)\[keyof *typeof* [`AuditableItemGraphVerificationState`](../variables/AuditableItemGraphVerificationState.md)\]
-
-The state of the verification.

package/docs/reference/variables/AuditableItemGraphVerificationState.md

@@ -1,49 +0,0 @@
-# Variable: AuditableItemGraphVerificationState
-
-> `const` **AuditableItemGraphVerificationState**: `object`
-
-The state of the verification.
-
-## Type declaration
-
-### Ok
-
-> `readonly` **Ok**: `"ok"` = `"ok"`
-
-OK.
-
-### HashMismatch
-
-> `readonly` **HashMismatch**: `"hashMismatch"` = `"hashMismatch"`
-
-The stored hash does not matched the calculated one.
-
-### SignatureNotVerified
-
-> `readonly` **SignatureNotVerified**: `"signatureNotVerified"` = `"signatureNotVerified"`
-
-The signature verification failed.
-
-### CredentialRevoked
-
-> `readonly` **CredentialRevoked**: `"credentialRevoked"` = `"credentialRevoked"`
-
-The credential in the immutable storage was revoked.
-
-### ImmutableHashMismatch
-
-> `readonly` **ImmutableHashMismatch**: `"immutableHashMismatch"` = `"immutableHashMismatch"`
-
-Immutable hash mismatch.
-
-### ImmutableSignatureMismatch
-
-> `readonly` **ImmutableSignatureMismatch**: `"immutableSignatureMismatch"` = `"immutableSignatureMismatch"`
-
-Immutable signature mismatch.
-
-### IntegrityDataMismatch
-
-> `readonly` **IntegrityDataMismatch**: `"integrityDataMismatch"` = `"integrityDataMismatch"`
-
-Integrity data mismatch.