@cooperation/vc-storage 1.0.0 → 1.0.1

package/README.md

@@ -1,136 +1,109 @@
-# Trust Storage Library
+# @cooperation/vc-storage
 
-Store your files using up to three strategies. Currently, we offer the GoogleDriveStorage class, which is designed for storing files in Google Drive. Stay tuned for additional methods coming soon 😊
+**Version**: 1.0.0
 
-## Installation
-
-To install the Trust Storage library, you can use either npm or yarn. Run one of the following commands in your project directory:
-
-```bash
-npm install trust_storage
-```
-
-or
-
-```bash
-yarn add trust_storage
-```
-
-## Usage
-
-To use the `GoogleDriveStorage` class in your application, you need to pass an access token that has appropriate permissions for Google Drive operations. You can generate an access token by following these steps:
-
-1. Visit the [OAuth 2.0 Playground](https://developers.google.com/oauthplayground/).
-2. Enter the scope: `https://www.googleapis.com/auth/drive`.
-3. Copy the accessToken and pass it to the `GoogleDriveStorage` class.
-
-The `GoogleDriveStorage` class includes two methods:
-
-- `createFolder()`: It is designed to create a new folder in Google Drive.
-- `uploadFile()`: Ensure that the necessary folder has been created or identified where the file will be stored.
-
-## Notes
-
-- This library is a demonstration tool for uploading files to Google Drive.
-
-### Your First Code Contribution
-
-1. Clone the repository.
-2. Run yarn or npm install to install dependencies.
-3. Create a new branch for your feature or bugfix.
-4. Make your changes.
-5. Commit your changes and push your branch to your fork.
-6. Open a pull request.
-
-### Pull Requests
-
-When you're ready to submit your pull request:
-
-1. Ensure your work is aligned with the project's coding standards.
-2. Fill out the pull request template.
-3. Include a clear and detailed description of the changes.
-4. Link any related issues.
-5. Wait for review and address any feedback.
-
-## Development Workflow
-
-### Setup
+## Overview
 
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/yourusername/your-repo-name.git
-   ```
-2. Navigate to the project directory:
-   ```bash
-   cd your-repo-name
-   ```
-3. Install dependencies:
-   ```bash
-   npm install
-   ```
+`@cooperation/vc-storage` is a TypeScript library that allows you to sign and store Verifiable Credentials (VCs) in various storage strategies. This library provides flexibility and security by allowing you to choose where your VCs are stored, whether on cloud services like Google Drive, on your local device, or in your digital wallet. Support for Dropbox and wallet storage is currently under development.
 
-Certainly! Here is the provided text rewritten in `.md` format:
+## Features
 
-````markdown
-## Publishing Flow
+- **Sign and Store VCs**: Securely sign your Verifiable Credentials and store them in your preferred storage medium.
+- **Google Drive Integration**: Seamlessly store your VCs on Google Drive.
+- **Local Device Storage**: Store your VCs directly on your device.
+- **Future Integrations**:
+  - **Wallet Storage**: Integration for storing VCs directly in your digital wallet (under development).
+  - **Dropbox Storage**: Integration for storing VCs in Dropbox (under development).
 
-If you want to publish a new version of the package, please follow these steps:
-
-### Request Access
-
-Ask for access to publish the package in the Slack. Mention the version and any significant changes.
-
-### Update Version
-
-Ensure you update the version in `package.json` according to [Semantic Versioning](https://semver.org/). You can do this manually or using the npm command:
-
-```bash
-npm version [patch|minor|major]
-```
-````
-
-### Ensure Tests Pass
-
-Run all tests to make sure they are passing:
-
-```bash
-npm test
-```
-
-### Build the Project
+## Installation
 
-Build the project to ensure all changes are compiled:
+You can install this package via npm:
 
 ```bash
-npm run build
+npm install @cooperation/vc-storage
 ```
 
-### Commit and Push
-
-Commit and push your changes to the main branch:
+## Usage
 
-```bash
-git add .
-git commit -m "Prepare for release vX.Y.Z"
-git push origin main
+### Basic Example
+
+Here’s how you can use the `@cooperation/vc-storage` library to sign and store your VCs:
+
+```typescript
+import { saveToGoogleDrive, CredentialEngine, GoogleDriveStorage } from '@cooperation/vc-storage';
+
+const accessToken = 'your-google-drive-access-token';
+const credentialEngine = new CredentialEngine();
+const storage = new GoogleDriveStorage(accessToken);
+
+async function main(useWallet = false, walletAddress = '') {
+	const formData = {
+		expirationDate: '2025-12-31T23:59:59Z',
+		fullName: 'John Doe',
+		duration: '1 year',
+		criteriaNarrative: 'This is a narrative',
+		achievementDescription: 'This is an achievement',
+		achievementName: 'Achievement Name',
+		portfolio: [
+			{ name: 'Portfolio 1', url: 'https://example.com/portfolio1' },
+			{ name: 'Portfolio 2', url: 'https://example.com/portfolio2' },
+		],
+		evidenceLink: 'https://example.com/evidence',
+		evidenceDescription: 'This is an evidence description',
+		credentialType: 'Credential Type',
+	};
+
+	let didDocument, keyPair;
+
+	// Step 1: Create DID based on the selected method
+	if (useWallet && walletAddress) {
+		({ didDocument, keyPair } = await credentialEngine.createWalletDID(walletAddress));
+	} else {
+		({ didDocument, keyPair } = await credentialEngine.createDID());
+	}
+
+	await saveToGoogleDrive(storage, { ...didDocument, keyPair }, 'DID');
+
+	const issuerDid = didDocument.id;
+
+	// Step 2: Create an Unsigned VC
+	const unsignedVC = await credentialEngine.createUnsignedVC(formData, issuerDid);
+	await saveToGoogleDrive(storage, unsignedVC, 'UnsignedVC');
+	console.log('Unsigned VC:', unsignedVC);
+
+	// Step 3: Sign the VC
+	try {
+		const signedVC = await credentialEngine.signVC(unsignedVC, keyPair);
+		await saveToGoogleDrive(storage, signedVC, 'VC');
+		console.log('Signed VC:', signedVC);
+	} catch (error) {
+		console.error('Error during VC signing:', error);
+	}
+
+	// Retrieve all stored claims
+	const claims = await storage.getAllClaims();
+	console.log('Stored Claims:', claims);
+}
+
+// Example usage:
+// 1. For Google Drive storage with standard DID creation
+main().catch(console.error);
+
+// 2. For Google Drive storage with wallet-based DID creation
+// main(true, 'your-wallet-address').catch(console.error);
 ```
 
-### Login to npm
+### Available Storage Strategies
 
-If you are not already logged in, log in to npm using your credentials:
+1. **Google Drive**: Store your VCs on Google Drive.
+2. **Local Device**: Store your VCs on your local device.
+3. **Wallet Storage**: (Under Development) Store your VCs directly in your digital wallet.
+4. **Dropbox**: (Under Development) Store your VCs in Dropbox.
 
-```bash
-npm login
-```
-
-### Publish the Package
-
-Once you have access and everything is set, publish the package:
+## Contributing
 
-```bash
-npm publish
-```
+Contributions are welcome! Please feel free to submit a Pull Request or open an Issue for any bugs or feature requests.
 
-### Notify Team
+## License
 
-Inform the team in the Slack channel that the new version has been published.
+This project is licensed under the ISC License.

package/dist/models/GoogleDriveStorage.js

@@ -140,21 +140,56 @@ export class GoogleDriveStorage {
         return claims;
     }
     async getAllSessions() {
-        const rootFolders = await this.findFolders();
-        const credentialsFolder = rootFolders.find((f) => f.name === 'Credentials');
-        if (!credentialsFolder)
-            return [];
-        const credentialsFolderId = credentialsFolder.id;
-        const subfolders = await this.findFolders(credentialsFolderId);
-        const sessionsFolder = subfolders.find((f) => f.name === 'Sessions');
-        if (!sessionsFolder)
-            return [];
-        const sessions = await this.fetcher({
-            method: 'GET',
-            headers: {},
-            url: `https://www.googleapis.com/drive/v3/files?q='${sessionsFolder.id}' in parents and trashed=false&fields=files(id,name,mimeType,parents)`,
-        });
-        return sessions;
+        try {
+            // Find all root folders
+            const rootFolders = await this.fetcher({
+                method: 'GET',
+                headers: {},
+                url: `https://www.googleapis.com/drive/v3/files?q='root' in parents and mimeType='application/vnd.google-apps.folder'&trashed=false&fields=files(id,name)`,
+            });
+            console.log('🚀 ~ GoogleDriveStorage ~ getAllSessions ~ rootFolders:', rootFolders);
+            // Find the "Credentials" folder
+            const credentialsFolder = rootFolders.files.find((f) => f.name === 'Credentials');
+            if (!credentialsFolder) {
+                return []; // Return an empty array if "Credentials" folder is not found
+            }
+            const credentialsFolderId = credentialsFolder.id;
+            // Find subfolders within the "Credentials" folder
+            const subfolders = await this.fetcher({
+                method: 'GET',
+                headers: {},
+                url: `https://www.googleapis.com/drive/v3/files?q='${credentialsFolderId}' in parents and mimeType='application/vnd.google-apps.folder'&trashed=false&fields=files(id,name)`,
+            });
+            const sessionsFolder = subfolders.files.find((f) => f.name === 'SESSIONs');
+            if (!sessionsFolder) {
+                return []; // Return an empty array if "SESSIONs" folder is not found
+            }
+            // Fetch all session files inside the "SESSIONs" folder
+            const sessions = await this.fetcher({
+                method: 'GET',
+                headers: {},
+                url: `https://www.googleapis.com/drive/v3/files?q='${sessionsFolder.id}' in parents and trashed=false&fields=files(id,name,mimeType,parents)`,
+            });
+            const sessionFiles = sessions.files;
+            // Fetch the content of each session file
+            const sessionContents = await Promise.all(sessionFiles.map(async (file) => {
+                // Fetch file content
+                const content = await this.fetcher({
+                    method: 'GET',
+                    headers: {},
+                    url: `https://www.googleapis.com/drive/v3/files/${file.id}?alt=media`,
+                });
+                return {
+                    content,
+                };
+            }));
+            console.log('🚀 ~ GoogleDriveStorage ~ getAllSessions ~ sessionContents:', sessionContents);
+            return sessionContents; // Return the list of files with their content
+        }
+        catch (error) {
+            console.error('Error getting session contents:', error);
+            return []; // Return an empty array on error
+        }
     }
     async delete(id) {
         try {

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

@@ -12,6 +12,6 @@ export declare class GoogleDriveStorage {
     findFolders: (id?: string) => Promise<any[]>;
     findLastFile: (folderId: string) => Promise<any>;
     getAllClaims(): Promise<any>;
-    getAllSessions(): Promise<any>;
+    getAllSessions(): Promise<any[]>;
     delete(id: string): Promise<any>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@cooperation/vc-storage",
 	"type": "module",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Sign and store your verifiable credentials.",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",