Merge pull request #103 from ardriveapp/dev

PE-744: Release ArDrive Core v1.1.0

Author: fedellen

README.md

@@ -120,35 +120,6 @@ And finally, to view the detailed error messages in your terminal:
 yarn power-assert -g 'My test case'
 ```
 
-### VSCode/VSCodium integration:
-
--   Make sure to open ardrive-core.code-workspace
--   Install recomended extensions (
-
-arcanis.vscode-zipfs
-
-dbaeumer.vscode-eslint
-
-esbenp.prettier-vscode
-
-On repo main folder run: `yarn`
-
-Remember to use
-
-```
-yarn install --check-cache
-```
-
-for external PR
-
-## Package:
-
-Npm package:
-
-npm add ardrive-core-js
-
-[![Gitopia](https://img.shields.io/endpoint?style=&url=https://gitopia.org/mirror-badge.json)](gitopia-repo)
-
 [yarn-install]: https://yarnpkg.com/getting-started/install
 [nvm-install]: https://github.com/nvm-sh/nvm#installing-and-updating
 [wsl-install]: https://code.visualstudio.com/docs/remote/wsl

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ardrive-core-js",
-	"version": "1.0.5",
+	"version": "1.1.0",
 	"description": "ArDrive Core contains the essential back end application features to support the ArDrive CLI and Desktop apps, such as file management, Permaweb upload/download, wallet management and other common functions.",
 	"main": "./lib/exports.js",
 	"types": "./lib/exports.d.ts",

src/ardrive.ts

@@ -45,7 +45,8 @@ import {
 	UploadPublicFileParams,
 	UploadPrivateFileParams,
 	ArFSManifestResult,
-	UploadPublicManifestParams
+	UploadPublicManifestParams,
+	emptyManifestResult
 } from './types';
 import {
 	CommunityTipParams,
@@ -1034,7 +1035,7 @@ export class ArDrive extends ArDriveAnonymous {
 		const existingFileId = filesAndFolderNames.files.find((f) => f.fileName === destManifestName)?.fileId;
 		if (existingFileId && conflictResolution === skipOnConflicts) {
 			// Return empty result if there is an existing manifest and resolution is set to skip
-			return { ...emptyArFSResult, links: [] };
+			return emptyManifestResult;
 		}
 
 		const children = await this.listPublicFolder({
@@ -1082,6 +1083,7 @@ export class ArDrive extends ArDriveAnonymous {
 				[`${uploadFileResult.metaDataTrxId}`]: uploadFileResult.metaDataTrxReward,
 				[`${tipData.txId}`]: communityTipTrxReward
 			},
+			manifest: arweaveManifest.manifest,
 			links: arweaveManifest.getLinksOutput(uploadFileResult.dataTrxId)
 		});
 	}

src/types/ardrive_types.ts

@@ -38,6 +38,7 @@ export interface ArFSResult {
 }
 
 export interface ArFSManifestResult extends ArFSResult {
+	manifest: Manifest | Record<string, never>;
 	links: string[];
 }
 
@@ -47,6 +48,11 @@ export const emptyArFSResult: ArFSResult = {
 	fees: {}
 };
 
+export const emptyManifestResult: ArFSManifestResult = {
+	...emptyArFSResult,
+	manifest: {},
+	links: []
+};
 export interface MetaDataBaseCosts {
 	metaDataBaseReward: Winston;
 }

tests/integration/ardrive.int.test.ts

@@ -930,6 +930,7 @@ describe('ArDrive class - integrated', () => {
 				created: [],
 				tips: [],
 				fees: {},
+				manifest: {},
 				links: []
 			});
 		});
@@ -1176,8 +1177,8 @@ function assertUploadManifestExpectations(
 	expect(feeKeys[2]).to.equal(uploadTip.txId.toString());
 	expect(`${result.fees[uploadTip.txId.toString()]}`).to.equal(`${tipFee}`);
 
-	// Verify links are healthy
 	if (specialCharacters) {
+		// Verify links are healthy
 		expect(result.links.length).to.equal(4);
 		expect(result.links[0]).to.equal(`https://arweave.net/${result.created[0].dataTxId}`);
 		expect(result.links[1]).to.equal(
@@ -1189,7 +1190,24 @@ function assertUploadManifestExpectations(
 		expect(result.links[3]).to.equal(
 			`https://arweave.net/${result.created[0].dataTxId}/~!%40%23%24%25%5E%26*()_%2B%7B%7D%7C%5B%5D%3A%22%3B%3C%3E%3F%2C./%60/dwijqndjqwnjNJKNDKJANKDNJWNJIvmnbzxnmvbcxvbm%2Cuiqwerioeqwndjkla`
 		);
+
+		// Assert manifest shape
+		expect(result.manifest).to.deep.equal({
+			manifest: 'arweave/paths',
+			version: '0.1.0',
+			index: { path: '%&@*(%&(@*:">?{}[]' },
+			paths: {
+				'%&@*(%&(@*:">?{}[]': { id: '0000000000000000000000000000000000000000001' },
+				"~!@#$%^&*()_+{}|[]:\";<>?,./`/'/''_\\___''_'__/'___'''_/QWERTYUIOPASDFGHJKLZXCVBNM!@#$%^&*()_+{}:\">?":
+					// eslint-disable-next-line prettier/prettier
+					{ id: '0000000000000000000000000000000000000000003' },
+				'~!@#$%^&*()_+{}|[]:";<>?,./`/dwijqndjqwnjNJKNDKJANKDNJWNJIvmnbzxnmvbcxvbm,uiqwerioeqwndjkla': {
+					id: '0000000000000000000000000000000000000000002'
+				}
+			}
+		});
 	} else {
+		// Verify links are healthy
 		expect(result.links.length).to.equal(4);
 		expect(result.links[0]).to.equal(`https://arweave.net/${result.created[0].dataTxId}`);
 		expect(result.links[1]).to.equal(`https://arweave.net/${result.created[0].dataTxId}/file-in-root`);
@@ -1199,5 +1217,17 @@ function assertUploadManifestExpectations(
 		expect(result.links[3]).to.equal(
 			`https://arweave.net/${result.created[0].dataTxId}/parent-folder/file-in-parent`
 		);
+
+		// Assert manifest shape
+		expect(result.manifest).to.deep.equal({
+			manifest: 'arweave/paths',
+			version: '0.1.0',
+			index: { path: 'file-in-root' },
+			paths: {
+				'file-in-root': { id: '0000000000000000000000000000000000000000001' },
+				'parent-folder/child-folder/file-in-child': { id: '0000000000000000000000000000000000000000003' },
+				'parent-folder/file-in-parent': { id: '0000000000000000000000000000000000000000002' }
+			}
+		});
 	}
 }