@cooperation/vc-storage 1.0.33 → 1.0.40

package/dist/models/WASStorage.js

@@ -0,0 +1,71 @@
+import { StorageClient } from '@wallet.storage/fetch-client';
+import { WAS_BASE_URL } from '../../app.config.js';
+export class LCWStorage {
+    static storageClient;
+    signer;
+    zcap;
+    spaceId;
+    constructor({ signer, zcap, spaceId }) {
+        this.signer = signer;
+        this.zcap = zcap;
+        this.spaceId = spaceId;
+    }
+    getStorageClient() {
+        if (!LCWStorage.storageClient) {
+            LCWStorage.storageClient = new StorageClient(new URL(WAS_BASE_URL));
+        }
+        return LCWStorage.storageClient;
+    }
+    getResource(key) {
+        const space = this.getStorageClient().space({
+            signer: this.signer,
+            id: this.spaceId,
+        });
+        return space.resource(key);
+    }
+    async add(key, value) {
+        const resource = this.getResource(key);
+        const blob = new Blob([JSON.stringify(value)], {
+            type: 'application/json',
+        });
+        const res = await resource.put(blob, {
+            signer: this.signer,
+        });
+        if (!res.ok) {
+            throw new Error(`Failed to add resource. Status: ${res.status}`);
+        }
+        return res;
+    }
+    async read(key) {
+        const resource = this.getResource(key);
+        const res = await resource.get({ signer: this.signer });
+        if (!res.ok) {
+            if (res.status === 404)
+                return null;
+            throw new Error(`Failed to read resource. Status: ${res.status}`);
+        }
+        return await res.json();
+    }
+    async update(key, value) {
+        return this.add(key, value); // Overwrite = update
+    }
+    async delete(key) {
+        const resource = this.getResource(key);
+        const res = await resource.delete({ signer: this.signer });
+        if (!res.ok && res.status !== 404) {
+            throw new Error(`Failed to delete resource. Status: ${res.status}`);
+        }
+        return true;
+    }
+    async list() {
+        // const space = this.getStorageClient().space({
+        //   signer: this.signer,
+        //   id: this.spaceId as `urn:uuid:${string}`,
+        // });
+        // const res = await space.resources().list({ signer: this.signer });
+        // if (!res.ok) {
+        //   throw new Error(`Failed to list resources. Status: ${res.status}`);
+        // }
+        // return await res.json(); // Should contain list of resource IDs or summaries
+    }
+}

package/dist/scripts/test-was.js

@@ -0,0 +1,61 @@
+import { Ed25519Signer } from '@did.coop/did-key-ed25519';
+import { v4 as uuidv4 } from 'uuid';
+import { LCWStorage } from '../models/WASStorage.js';
+import { StorageClient } from '@wallet.storage/fetch-client';
+import { WAS_BASE_URL } from '../../app.config.js';
+async function main() {
+    const appDidSigner = await Ed25519Signer.generate();
+    console.log('Signer:', appDidSigner);
+    const spaceUUID = uuidv4();
+    const spaceId = `urn:uuid:${spaceUUID}`;
+    console.log('Space ID:', spaceId);
+    const storage = new StorageClient(new URL(WAS_BASE_URL));
+    const space = storage.space({
+        signer: appDidSigner,
+        id: spaceId,
+    });
+    const spaceObject = {
+        id: spaceId,
+        controller: appDidSigner.id.split('#')[0],
+    };
+    console.log('Creating space with object:', spaceObject);
+    const spaceObjectBlob = new Blob([JSON.stringify(spaceObject)], { type: 'application/json' });
+    // Create the space
+    const response = await space.put(spaceObjectBlob, {
+        signer: appDidSigner,
+    });
+    console.log('🚀 ~ main ~ response:', response);
+    console.log('Space PUT response:', {
+        status: response.status,
+        ok: response.ok,
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to initialize space. Status: ${response.status}`);
+    }
+    // Store the signer for future connections
+    const signerJson = await appDidSigner.toJSON();
+    console.log('Signer JSON:', signerJson);
+    const lcwStorage = new LCWStorage({ signer: appDidSigner, zcap: {}, spaceId });
+    const res = await lcwStorage.add('test', { test: 'test' });
+    if (res.ok) {
+        console.log('Record added successfully');
+    }
+    else {
+        console.error('Failed to add record');
+    }
+    const res2 = await lcwStorage.read('test');
+    if (res2) {
+        console.log('Record read successfully');
+    }
+    else {
+        console.error('Failed to read record');
+    }
+    const res3 = await lcwStorage.update('test', { test: 'test2' });
+    if (res3.ok) {
+        console.log('Record updated successfully');
+    }
+    else {
+        console.error('Failed to update record');
+    }
+}
+main();

package/dist/types/index.d.ts

@@ -1,6 +1,8 @@
 export * from './models/GoogleDriveStorage.js';
 export * from './models/CredentialEngine.js';
 export * from './utils/google.js';
-export * from './utils/presentation.js';
 export * from './models/Resume.js';
 export * from './models/ResumeVC.js';
+export * from './models/WASStorage.js';
+export * from './utils/createWASSpace.js';
+export * from './utils/getOrCreateAppDID.js';

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

@@ -1,8 +1,8 @@
-import { DidDocument, KeyPair, FormDataI, RecommendationFormDataI, VerifiableCredential } from '../../types/credential.js';
+import { DidDocument, KeyPair, FormDataI, RecommendationFormDataI, VerifiableCredential, EmploymentFormDataI, PerformanceReviewFormDataI, VolunteeringFormDataI } from '../../types/credential.js';
 import { GoogleDriveStorage } from './GoogleDriveStorage.js';
 interface SignPropsI {
-    data: FormDataI | RecommendationFormDataI;
-    type: 'VC' | 'RECOMMENDATION';
+    data: FormDataI | RecommendationFormDataI | EmploymentFormDataI | VolunteeringFormDataI | PerformanceReviewFormDataI;
+    type: 'VC' | 'RECOMMENDATION' | 'EMPLOYMENT' | 'VOLUNTEERING' | 'PERFORMANCE_REVIEW';
     keyPair: KeyPair;
     issuerId: string;
     vcFileId?: string;
@@ -50,7 +50,7 @@ export declare class CredentialEngine {
     }>;
     /**
      * Sign a Verifiable Credential (VC)
-     * @param {'VC' | 'RECOMMENDATION'} type - The signature type.
+     * @param {'VC' | 'RECOMMENDATION' | 'EMPLOYMENT' | 'VOLUNTEERING' | 'PERFORMANCE_REVIEW'} type - The signature type.
      * @param {string} issuerId - The ID of the issuer [currently we put it as the did id]
      * @param {KeyPair} keyPair - The key pair to use for signing.
      * @param {FormDataI | RecommendationFormDataI} formData - The form data to include in the VC.
@@ -59,6 +59,9 @@ export declare class CredentialEngine {
      * @throws Will throw an error if VC signing fails.
      */
     signVC({ data, type, keyPair, issuerId, vcFileId }: SignPropsI): Promise<any>;
+    signEmploymentCredential(data: EmploymentFormDataI, keyPair: KeyPair, issuerId: string): Promise<any>;
+    signVolunteeringCredential(data: VolunteeringFormDataI, keyPair: KeyPair, issuerId: string): Promise<any>;
+    signPerformanceReviewCredential(data: PerformanceReviewFormDataI, keyPair: KeyPair, issuerId: string): Promise<any>;
     /**
      * Verify a Verifiable Credential (VC)
      * @param {object} credential - The Verifiable Credential to verify.

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

@@ -3,70 +3,64 @@ type FileType = 'KEYPAIRs' | 'VCs' | 'SESSIONs' | 'DIDs' | 'RECOMMENDATIONs' | '
  * @class GoogleDriveStorage
  * @description Class to interact with Google Drive API
  * @param accessToken - Access token to authenticate with Google Drive API
- * @method createFolder - Create a new folder in Google Drive
- * @method save - Save data to Google Drive
- * @method addCommentToFile - Add a comment to a file in Google Drive
- * @method addCommenterRoleToFile - Add commenter role to a file in Google Drive
+ * @method saveFile - Save a file to Google Drive
  * @method retrieve - Retrieve a file from Google Drive
- * @method findFolders - Find folders in Google Drive
- * @method findLastFile - Find the last file in a folder
- * @method getAllVCs - Get all verifiable credentials from Google Drive
- * @method getAllSessions - Get all sessions from Google Drive
+ * @method createFolder - Create a new folder in Google Drive
+ * @method getOrCreateMediaFolder - Get the ID of the MEDIAs folder
+ * @method uploadBinaryFile - Upload a binary file to Google Drive
+ * @method updateFileData - Update the data of a file
+ * @method updateRelationsFile - Update the relations file
  * @method delete - Delete a file from Google Drive
+ * @method checkEmailExists - Check if an email VC exists and return its content
+ * @method findFolders - Find folders in Google Drive
+ * @method findFolderFiles - Find files in a folder
  */
 export declare class GoogleDriveStorage {
     private accessToken;
-    folderCache: any;
-    private fileIdsCache;
-    private updateFileIdsJson;
+    static folderCache: any;
+    private static fileIdsCache;
     constructor(accessToken: string);
+    private updateFileIdsJson;
     private fetcher;
     private getFileContent;
     private searchFiles;
+    private getOrCreateMediaFolder;
+    findFolderFiles(folderId: string): Promise<any[]>;
     createFolder({ folderName, parentFolderId }: {
         folderName: string;
         parentFolderId: string;
     }): Promise<any>;
-    getMediaFolderId(): Promise<any>;
+    /**
+     * Get the ID of the MEDIAs folder (public wrapper for getOrCreateMediaFolder)
+     * @returns The folder ID for the MEDIAs folder
+     */
+    getMediaFolderId(): Promise<string>;
     uploadBinaryFile({ file }: {
         file: File;
     }): Promise<any>;
-    saveFile({ data, folderId }: {
+    saveFile({ data, folderId, fileId }: {
         data: any;
-        folderId: string;
+        folderId?: string;
+        fileId?: string;
     }): Promise<any>;
-    /**
-     * Get file from google drive by id
-     * @param id
-     * @returns file content
-     */
     retrieve(id: string): Promise<{
         data: any;
         id: string;
     } | null>;
-    /**
-     * Get folder by folderId, if folderId == null you will have them all
-     * @param folderId [Optional]
-     * @returns
-     */
     findFolders(folderId?: string): Promise<any[]>;
-    /**
-     * Get all files content for the specified type ('KEYPAIRs' | 'VCs' | 'SESSIONs' | 'DIDs' | 'RECOMMENDATIONs')
-     * @param type
-     * @returns
-     */
     getAllFilesByType(type: FileType): Promise<any[]>;
+    updateFileData(fileId: string, data: {
+        fileName: string;
+    }): Promise<any>;
     /**
-     * Update the name of a file in Google Drive
+     * Update the content of an existing file in Google Drive
      * @param fileId - The ID of the file to update
-     * @param newFileName - The new name for the file
-     * @returns The updated file metadata, including the new name
+     * @param data - The new content for the file
+     * @returns The updated file metadata
      */
-    updateFileName(fileId: string, newFileName: string): Promise<any>;
-    findFileByName(name: string): Promise<any>;
-    findFilesUnderFolder(folderId: string): Promise<any[]>;
-    updateFileData(fileId: string, data: {
-        fileName: string;
+    updateFileContent({ fileId, data }: {
+        fileId: string;
+        data: any;
     }): Promise<any>;
     getFileParents(fileId: string): Promise<any>;
     updateRelationsFile({ relationsFileId, recommendationFileId }: {
@@ -76,25 +70,7 @@ export declare class GoogleDriveStorage {
     createRelationsFile({ vcFolderId }: {
         vcFolderId: string;
     }): Promise<any>;
-    updateResumeRelation({ authorFolderId, draftFileId, signedFileId, }: {
-        authorFolderId: string;
-        draftFileId: string;
-        signedFileId: string;
-    }): Promise<any>;
-    /**
-     * Delete file by id
-     * @param id
-     * @returns
-     */
     delete(id: string): Promise<any>;
-    update(fileId: string, data: any): Promise<any>;
-    getFileIdsFromAppDataFolder(): Promise<any>;
-    getAllFilesData(): Promise<any>;
-    /**
-     * Check if an email VC exists and return its content
-     * @param email - The email address to check
-     * @returns {Promise<{data: any, id: string} | null>} - The email VC content and ID if exists, null otherwise
-     */
     checkEmailExists(email: string): Promise<{
         data: any;
         id: string;

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

@@ -1,4 +1,4 @@
-import { GoogleDriveStorage } from './GoogleDriveStorage.js';
+import { GoogleDriveStorage } from './GoogleDriveStorage';
 export declare const resumeFolderTypes: {
     root: string;
     nonSigned: string;
@@ -14,9 +14,10 @@ export declare class StorageHandler {
 }
 export declare class Resume extends StorageHandler {
     constructor(storage: GoogleDriveStorage);
-    saveResume({ resume, type }: {
+    saveResume({ resume, type, id }: {
         resume: any;
         type: 'sign' | 'unsigned';
+        id?: string;
     }): Promise<any>;
     find(): Promise<{
         signed: any[];

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

@@ -0,0 +1,30 @@
+export declare class LCWStorage {
+    private static storageClient;
+    private signer;
+    private zcap;
+    private spaceId;
+    constructor({ signer, zcap, spaceId }: {
+        signer: any;
+        zcap: any;
+        spaceId: string;
+    });
+    private getStorageClient;
+    private getResource;
+    add(key: string, value: any): Promise<{
+        ok: boolean;
+        headers: [string, string][];
+        status: number;
+        blob(): Promise<import("buffer").Blob>;
+        json(): Promise<unknown>;
+    }>;
+    read(key: string): Promise<unknown>;
+    update(key: string, value: any): Promise<{
+        ok: boolean;
+        headers: [string, string][];
+        status: number;
+        blob(): Promise<import("buffer").Blob>;
+        json(): Promise<unknown>;
+    }>;
+    delete(key: string): Promise<boolean>;
+    list(): Promise<void>;
+}

package/dist/types/scripts/test-was.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/context.d.ts

@@ -104,6 +104,79 @@ export declare const inlineResumeContext: {
         Resume: string;
     };
 };
+export declare const employmentCredentialContext: {
+    '@context': {
+        '@vocab': string;
+        fullName: string;
+        persons: string;
+        credentialName: string;
+        credentialDuration: string;
+        credentialDescription: string;
+        portfolio: {
+            '@id': string;
+            '@container': string;
+        };
+        name: string;
+        url: string;
+        evidenceLink: string;
+        evidenceDescription: string;
+        company: string;
+        role: string;
+    };
+};
+export declare const volunteeringCredentialContext: {
+    '@context': {
+        '@vocab': string;
+        fullName: string;
+        persons: string;
+        volunteerWork: string;
+        volunteerOrg: string;
+        volunteerDescription: string;
+        skillsGained: {
+            '@id': string;
+            '@container': string;
+        };
+        duration: string;
+        volunteerDates: string;
+        portfolio: {
+            '@id': string;
+            '@container': string;
+        };
+        name: string;
+        url: string;
+        evidenceLink: string;
+        evidenceDescription: string;
+    };
+};
+export declare const performanceReviewCredentialContext: {
+    '@context': {
+        '@vocab': string;
+        fullName: string;
+        persons: string;
+        employeeName: string;
+        employeeJobTitle: string;
+        company: string;
+        role: string;
+        reviewStartDate: string;
+        reviewEndDate: string;
+        reviewDuration: string;
+        jobKnowledgeRating: string;
+        teamworkRating: string;
+        initiativeRating: string;
+        communicationRating: string;
+        overallRating: string;
+        reviewComments: string;
+        goalsNext: string;
+        portfolio: {
+            '@id': string;
+            '@container': string;
+        };
+        name: string;
+        url: string;
+        evidenceLink: string;
+        evidenceDescription: string;
+    };
+};
 declare const localOBContext: {
     '@context': {
         '@protected': boolean;

package/dist/types/utils/createWASSpace.d.ts

@@ -0,0 +1,9 @@
+import { Ed25519Signer } from '@did.coop/did-key-ed25519';
+/**
+ * Create a new WAS space
+ * @returns {Promise<{ signer: InstanceType<typeof Ed25519Signer>; spaceId: `urn:uuid:${string}` }>}
+ */
+export declare function createSpace(): Promise<{
+    signer: InstanceType<typeof Ed25519Signer>;
+    spaceId: `urn:uuid:${string}`;
+}>;

package/dist/types/utils/credential.d.ts

@@ -1,4 +1,4 @@
-import { KeyPair, DidDocument, FormDataI, RecommendationCredential, Credential, RecommendationFormDataI, VerifiableCredential } from '../../types/credential';
+import { KeyPair, DidDocument, FormDataI, RecommendationCredential, Credential, RecommendationFormDataI, VerifiableCredential, EmploymentFormDataI, VolunteeringFormDataI, PerformanceReviewFormDataI } from '../../types';
 /**
  * Create a DID document using the provided key pair.
  * @param {KeyPair} keyPair - The key pair used to create the DID document.
@@ -34,6 +34,176 @@ export declare function generateUnsignedRecommendation({ vcId, recommendation, i
     recommendation: RecommendationFormDataI;
     issuerDid: string;
 }): RecommendationCredential;
+/**
+ * Generate an unsigned Employment Credential.
+ */
+export declare function generateUnsignedEmployment({ formData, issuerDid }: {
+    formData: EmploymentFormDataI;
+    issuerDid: string;
+}): {
+    '@context': (string | {
+        '@vocab': string;
+        fullName: string;
+        persons: string;
+        credentialName: string;
+        credentialDuration: string;
+        credentialDescription: string;
+        portfolio: {
+            '@id': string;
+            '@container': string;
+        };
+        name: string;
+        url: string;
+        evidenceLink: string;
+        evidenceDescription: string;
+        company: string;
+        role: string;
+    })[];
+    id: string;
+    type: string[];
+    issuer: {
+        id: string;
+        type: string[];
+    };
+    issuanceDate: string;
+    credentialSubject: {
+        type: string[];
+        fullName: string;
+        persons: string;
+        credentialName: string;
+        credentialDuration: string;
+        credentialDescription: string;
+        portfolio: {
+            name: string;
+            url: string;
+        }[];
+        evidenceLink: string;
+        evidenceDescription: string;
+        company: string;
+        role: string;
+    };
+};
+/**
+ * Generate an unsigned Volunteering Credential.
+ */
+export declare function generateUnsignedVolunteering({ formData, issuerDid }: {
+    formData: VolunteeringFormDataI;
+    issuerDid: string;
+}): {
+    '@context': (string | {
+        '@vocab': string;
+        fullName: string;
+        persons: string;
+        volunteerWork: string;
+        volunteerOrg: string;
+        volunteerDescription: string;
+        skillsGained: {
+            '@id': string;
+            '@container': string;
+        };
+        duration: string;
+        volunteerDates: string;
+        portfolio: {
+            '@id': string;
+            '@container': string;
+        };
+        name: string;
+        url: string;
+        evidenceLink: string;
+        evidenceDescription: string;
+    })[];
+    id: string;
+    type: string[];
+    issuer: {
+        id: string;
+        type: string[];
+    };
+    issuanceDate: string;
+    credentialSubject: {
+        type: string[];
+        fullName: string;
+        persons: string;
+        volunteerWork: string;
+        volunteerOrg: string;
+        volunteerDescription: string;
+        skillsGained: string[];
+        duration: string;
+        volunteerDates: string;
+        portfolio: {
+            name: string;
+            url: string;
+        }[];
+        evidenceLink: string;
+        evidenceDescription: string;
+    };
+};
+/**
+ * Generate an unsigned Performance Review Credential.
+ */
+export declare function generateUnsignedPerformanceReview({ formData, issuerDid }: {
+    formData: PerformanceReviewFormDataI;
+    issuerDid: string;
+}): {
+    '@context': (string | {
+        '@vocab': string;
+        fullName: string;
+        persons: string;
+        employeeName: string;
+        employeeJobTitle: string;
+        company: string;
+        role: string;
+        reviewStartDate: string;
+        reviewEndDate: string;
+        reviewDuration: string;
+        jobKnowledgeRating: string;
+        teamworkRating: string;
+        initiativeRating: string;
+        communicationRating: string;
+        overallRating: string;
+        reviewComments: string;
+        goalsNext: string;
+        portfolio: {
+            '@id': string;
+            '@container': string;
+        };
+        name: string;
+        url: string;
+        evidenceLink: string;
+        evidenceDescription: string;
+    })[];
+    id: string;
+    type: string[];
+    issuer: {
+        id: string;
+        type: string[];
+    };
+    issuanceDate: string;
+    credentialSubject: {
+        type: string[];
+        fullName: string;
+        persons: string;
+        employeeName: string;
+        employeeJobTitle: string;
+        company: string;
+        role: string;
+        reviewStartDate: string;
+        reviewEndDate: string;
+        reviewDuration: string;
+        jobKnowledgeRating: string;
+        teamworkRating: string;
+        initiativeRating: string;
+        communicationRating: string;
+        overallRating: string;
+        reviewComments: string;
+        goalsNext: string;
+        portfolio: {
+            name: string;
+            url: string;
+        }[];
+        evidenceLink: string;
+        evidenceDescription: string;
+    };
+};
 /**
  * Extracts the keypair from a Verifiable Credential
  * @param {Object} credential - The signed Verifiable Credential

package/dist/types/utils/getOrCreateAppDID.d.ts

@@ -0,0 +1,11 @@
+import { Ed25519VerificationKey2020 } from '@digitalbazaar/ed25519-verification-key-2020';
+export interface AppInstanceKeyPair {
+    controller: string;
+    id: string;
+    publicKeyMultibase: string;
+    privateKeyMultibase: string;
+}
+export declare function getOrCreateAppInstanceDid(): Promise<{
+    did: string;
+    keyPair: Ed25519VerificationKey2020;
+}>;

package/dist/types/utils/google.d.ts

@@ -1,4 +1,4 @@
-import { GoogleDriveStorage } from '../models/GoogleDriveStorage.js';
+import { GoogleDriveStorage } from '../models/GoogleDriveStorage';
 export type FileType = 'VC' | 'DID' | 'SESSION' | 'RECOMMENDATION' | 'KEYPAIR';
 interface SaveToGooglePropsI {
     storage: GoogleDriveStorage;