@binsky/passman-client-ts 0.1.0-7

package/lib/Model/Credential.d.ts

@@ -0,0 +1,173 @@
+import NextcloudServer from "./NextcloudServer";
+import Vault from "./Vault";
+import { CredentialInterface } from "../Interfaces/Credential/CredentialInterface";
+import { EncryptedCredentialInterface } from "../Interfaces/Credential/EncryptedCredentialInterface";
+import { CustomFieldInterface } from "../Interfaces/Credential/CustomFieldInterface";
+import { TagInterface } from "../Interfaces/Credential/TagInterface";
+import { IconInterface } from "../Interfaces/Credential/IconInterface";
+import { FileInterface } from "../Interfaces/File/FileInterface";
+import { FileUploadResponseInterface } from "../Interfaces/File/FileUploadResponseInterface";
+import { RevisionInterface } from "../Interfaces/Revision/RevisionInterface";
+import { OTPConfigInterface } from "../Interfaces/Credential/OTPConfigInterface";
+import { ACLInterface } from "../Interfaces/ShareService/ACLInterface";
+export default class Credential {
+    protected vault: Vault;
+    protected server: NextcloudServer;
+    ENCRYPTED_FIELDS: string[];
+    protected encryptedData: EncryptedCredentialInterface;
+    private decryptedDataCache;
+    sharedCredentialEncryptionKey: string;
+    private foundUnspecifiedEncryptionError;
+    overwriteVaultKey: string | undefined;
+    constructor(vault: Vault, server: NextcloudServer, encryptedData?: EncryptedCredentialInterface);
+    private initializeAllFields;
+    /**
+     * Save new credential on the server.
+     * The current credential object will be updated with the server response data if possible.
+     */
+    save(): Promise<void | EncryptedCredentialInterface>;
+    /**
+     * Update / edit an existing credential on the server.
+     * The current credential object will be updated with the server response data if possible.
+     */
+    update(): Promise<void | EncryptedCredentialInterface>;
+    /**
+     * Refresh the local credential data based on the server, using the credentials guid.
+     * It is not supported to do that for credentials, shared with us.
+     */
+    refresh(): Promise<void | EncryptedCredentialInterface>;
+    /**
+     * Destroys the credential on the server and removes itself from its local vault.
+     */
+    destroy(): Promise<void | Response>;
+    clearDecryptedDataCache(): void;
+    /**
+     * Create a credential object based on its encrypted data.
+     * @param data
+     * @param vault
+     * @param server
+     */
+    static fromData(data: EncryptedCredentialInterface, vault: Vault, server: NextcloudServer): Promise<Credential>;
+    /**
+     * Create a credential object based on its guid. This will fetch the current credential data from the server.
+     * @param guid
+     * @param vault
+     * @param server
+     */
+    static fromGuid(guid: string, vault: Vault, server: NextcloudServer): Promise<Credential>;
+    getRevisions(): Promise<void | RevisionInterface[]>;
+    /**
+     * Update credential (encryptedData store) with the new values, if they have changed.
+     * This does not update the servers credential instance.
+     * @param decryptedCredentialData
+     */
+    updateData(decryptedCredentialData: CredentialInterface): void;
+    exportData(): CredentialInterface;
+    /**
+     * Creates a local 100% clone of the current credential.
+     */
+    clone(): Credential;
+    /**
+     * Check whether the credential has a valid shared_key.
+     * If true, it is a credential, that's encrypted with the decrypted shared_key field content.
+     */
+    hasValidSharedKey(): boolean;
+    /**
+     * Creates a local 100% clone of the current credential and re-encrypts it with the given key.
+     */
+    reEncryptAsClone(newVaultKey: string): Credential;
+    private getFieldEncryptionKey;
+    /**
+     * Returns (json parsed) field data and decrypt / caches it if required.
+     *
+     * @param property key of ILEncryptedCredential
+     * @private
+     */
+    private getCacheDecryptFieldData;
+    /**
+     * Pass the plain field data so that it can be stored stringified and encrypted.
+     *
+     * @param property
+     * @param data
+     * @private
+     */
+    private setEncryptFieldData;
+    downloadFile(file: FileInterface, directDownload?: boolean): Promise<string>;
+    /**
+     * Takes plain file data, encrypts and uploads it.
+     * This method does *not* add the file to the local credential files list!
+     * Adding it to the files list as well as a call to save() or update() is required to associate the file persistent with the credential.
+     * @param plainFile
+     */
+    encryptUploadFile(plainFile: FileInterface): Promise<void | FileUploadResponseInterface>;
+    /**
+     * Deletes the given file from the server.
+     * This method does *not* delete the file from the local credential files list!
+     * @param file
+     */
+    deleteFile(file: FileInterface): Promise<void | FileUploadResponseInterface>;
+    getVaultGuid(): string;
+    getEncrypted(): EncryptedCredentialInterface;
+    hasUnspecifiedEncryptionError(): boolean;
+    get credential_id(): number;
+    set credential_id(value: number);
+    get guid(): string;
+    set guid(value: string);
+    get user_id(): string;
+    set user_id(value: string);
+    get vault_id(): number;
+    set vault_id(value: number);
+    get label(): string;
+    set label(value: string);
+    get description(): string;
+    set description(value: string);
+    get tags(): TagInterface[];
+    set tags(value: TagInterface[]);
+    get email(): string;
+    set email(value: string);
+    get username(): string;
+    set username(value: string);
+    get password(): string;
+    set password(value: string);
+    get url(): string;
+    set url(value: string);
+    get files(): FileInterface[];
+    set files(value: FileInterface[]);
+    get custom_fields(): CustomFieldInterface[];
+    set custom_fields(value: CustomFieldInterface[]);
+    get otp(): OTPConfigInterface;
+    set otp(value: OTPConfigInterface);
+    get compromised(): boolean;
+    set compromised(value: boolean);
+    /**
+     * This special field is not encrypted, if it only contains a null value.
+     */
+    get shared_key(): string | null;
+    /**
+     * This special field is not encrypted, if it only contains a null value.
+     * @param value
+     */
+    set shared_key(value: string | null);
+    get favicon(): string;
+    set favicon(value: string);
+    get icon(): IconInterface | null;
+    set icon(value: IconInterface | null);
+    get renew_interval(): number | null;
+    set renew_interval(value: number | null);
+    get expire_time(): number;
+    set expire_time(value: number);
+    get delete_time(): number;
+    set delete_time(value: number);
+    get hidden(): boolean;
+    set hidden(value: boolean);
+    get created(): number;
+    set created(value: number);
+    get changed(): number;
+    set changed(value: number);
+    get set_share_key(): boolean;
+    set set_share_key(value: boolean);
+    get skip_revision(): boolean;
+    set skip_revision(value: boolean);
+    get acl(): ACLInterface;
+    set acl(value: ACLInterface);
+}