diff --git a/build-dist.sh b/build-dist.sh
index 2f28cae..ac0812a 100755
--- a/build-dist.sh
+++ b/build-dist.sh
@@ -1,8 +1,9 @@
-mkdir ./dist/esm
+mkdir -p ./dist/esm
cat >dist/esm/index.js <<!EOF
import cjsModule from "../index.js";
export const exportActorProfile = cjsModule.exportActorProfile;
export const importActorProfile = cjsModule.importActorProfile;
+export const validateExportStream = cjsModule.validateExportStream;
!EOF
cat >dist/esm/package.json <<!EOF
diff --git a/out/test-export-2024-01-01.tar b/out/test-export-2024-01-01.tar
index 12c6772..46bc866 100644
Binary files a/out/test-export-2024-01-01.tar and b/out/test-export-2024-01-01.tar differ
diff --git a/package.json b/package.json
index 38e5b79..037872e 100644
--- a/package.json
+++ b/package.json
@@ -32,6 +32,7 @@
"./package.json": "./package.json"
},
"dependencies": {
+ "stream": "^0.0.3",
"tar-stream": "^3.1.7",
"yaml": "^2.5.1"
},
diff --git a/src/index.ts b/src/index.ts
index fc7e808..90f90b1 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -4,7 +4,7 @@
import * as tar from 'tar-stream'
import { type Pack } from 'tar-stream'
import YAML from 'yaml'
-import { Readable } from 'stream'
+import { type Readable } from 'stream'
export interface ActorProfileOptions {
actorProfile?: any
@@ -178,14 +178,21 @@ export async function exportActorProfile({
}
}
-export async function importActorProfile(tarBuffer: Buffer): Promise<any> {
+/**
+ * Imports an ActivityPub profile from a .tar archive stream.
+ * @param tarStream - A ReadableStream containing the .tar archive.
+ * @returns A promise that resolves to the parsed profile data.
+ */
+export async function importActorProfile(
+ tarStream: Readable
+): Promise<Record<string, any>> {
const extract = tar.extract()
const result: Record<string, any> = {}
return await new Promise((resolve, reject) => {
extract.on('entry', (header, stream, next) => {
+ const fileName = header.name
let content = ''
- console.log(`Extracting file: ${header.name}`)
stream.on('data', (chunk) => {
content += chunk.toString()
@@ -193,42 +200,34 @@ export async function importActorProfile(tarBuffer: Buffer): Promise<any> {
stream.on('end', () => {
try {
- if (header.name.endsWith('.json')) {
- result[header.name] = JSON.parse(content)
- } else if (
- header.name.endsWith('.yaml') ||
- header.name.endsWith('.yml')
- ) {
- result[header.name] = YAML.parse(content)
- } else if (header.name.endsWith('.csv')) {
- result[header.name] = content
+ if (fileName.endsWith('.json')) {
+ result[fileName] = JSON.parse(content)
+ } else if (fileName.endsWith('.yaml') || fileName.endsWith('.yml')) {
+ result[fileName] = YAML.parse(content)
+ } else if (fileName.endsWith('.csv')) {
+ result[fileName] = content
}
- console.log(`Successfully parsed: ${header.name}`)
- } catch (error) {
- console.error(`Error processing file ${header.name}:`, error)
- reject(error)
+ } catch (error: any) {
+ reject(new Error(`Error processing file ${fileName}: ${error}`))
}
next()
})
- stream.on('error', (error) => {
- console.error(`Stream error on file ${header.name}:`, error)
- reject(error)
+ stream.on('error', (error: any) => {
+ reject(new Error(`Stream error on file ${fileName}: ${error}`))
})
})
extract.on('finish', () => {
- console.log('Extraction complete', result)
resolve(result)
})
extract.on('error', (error) => {
- console.error('Error during extraction:', error)
- reject(error)
+ reject(new Error(`Error during extraction: ${error}`))
})
- const stream = Readable.from(tarBuffer)
- stream.pipe(extract)
+ // Pipe the ReadableStream into the extractor
+ tarStream.pipe(extract)
})
}
@@ -254,3 +253,5 @@ function addMediaFile(
lastModified: new Date().toISOString()
}
}
+
+export * from './verify'
diff --git a/src/verify.ts b/src/verify.ts
new file mode 100644
index 0000000..f47e943
--- /dev/null
+++ b/src/verify.ts
@@ -0,0 +1,89 @@
+import * as tar from 'tar-stream'
+import { type Readable } from 'stream'
+import YAML from 'yaml'
+
+/**
+ * Validates the structure and content of an exported ActivityPub tarball.
+ * @param tarStream - A ReadableStream containing the .tar archive.
+ * @returns A promise that resolves to an object with `valid` (boolean) and `errors` (string[]).
+ */
+export async function validateExportStream(
+ tarStream: Readable
+): Promise<{ valid: boolean; errors: string[] }> {
+ console.log('Validating export stream...')
+ const extract = tar.extract()
+ const errors: string[] = []
+ const requiredFiles = [
+ 'manifest.yaml', // or 'manifest.yml'
+ 'activitypub/actor.json',
+ 'activitypub/outbox.json'
+ ].map((file) => file.toLowerCase()) // Normalize to lowercase for consistent comparison
+ const foundFiles = new Set<string>()
+
+ return await new Promise((resolve) => {
+ extract.on('entry', (header, stream, next) => {
+ const fileName = header.name.toLowerCase() // Normalize file name
+ foundFiles.add(fileName)
+
+ let content = ''
+ stream.on('data', (chunk) => {
+ content += chunk.toString()
+ })
+
+ stream.on('end', () => {
+ try {
+ // Validate JSON files
+ if (fileName.endsWith('.json')) {
+ JSON.parse(content) // Throws an error if content is not valid JSON
+ }
+
+ // Validate manifest file
+ if (fileName === 'manifest.yaml' || fileName === 'manifest.yml') {
+ const manifest = YAML.parse(content)
+ if (!manifest['ubc-version']) {
+ errors.push('Manifest is missing required field: ubc-version')
+ }
+ if (!manifest.contents?.activitypub) {
+ errors.push(
+ 'Manifest is missing required field: contents.activitypub'
+ )
+ }
+ }
+ } catch (error: any) {
+ errors.push(`Error processing file ${fileName}: ${error.message}`)
+ }
+ next()
+ })
+
+ stream.on('error', (error) => {
+ errors.push(`Stream error on file ${fileName}: ${error.message}`)
+ next()
+ })
+ })
+
+ extract.on('finish', () => {
+ // Check if all required files are present
+ for (const file of requiredFiles) {
+ if (!foundFiles.has(file)) {
+ errors.push(`Missing required file: ${file}`)
+ }
+ }
+
+ resolve({
+ valid: errors.length === 0,
+ errors
+ })
+ })
+
+ extract.on('error', (error) => {
+ errors.push(`Error during extraction: ${error.message}`)
+ resolve({
+ valid: false,
+ errors
+ })
+ })
+
+ // Pipe the ReadableStream into the extractor
+ tarStream.pipe(extract)
+ })
+}
diff --git a/test/fixtures/account2.tar b/test/fixtures/account2.tar
deleted file mode 100644
index 47e8cca..0000000
Binary files a/test/fixtures/account2.tar and /dev/null differ
diff --git a/test/fixtures/tarball-samples/invalid-actor.tar b/test/fixtures/tarball-samples/invalid-actor.tar
new file mode 100644
index 0000000..4c2553c
Binary files /dev/null and b/test/fixtures/tarball-samples/invalid-actor.tar differ
diff --git a/test/fixtures/tarball-samples/invalid-manifest.tar b/test/fixtures/tarball-samples/invalid-manifest.tar
new file mode 100644
index 0000000..fb10d1a
Binary files /dev/null and b/test/fixtures/tarball-samples/invalid-manifest.tar differ
diff --git a/test/fixtures/tarball-samples/missing-actor.tar b/test/fixtures/tarball-samples/missing-actor.tar
new file mode 100644
index 0000000..64ac15b
Binary files /dev/null and b/test/fixtures/tarball-samples/missing-actor.tar differ
diff --git a/test/fixtures/tarball-samples/missing-manifest.tar b/test/fixtures/tarball-samples/missing-manifest.tar
new file mode 100644
index 0000000..824bf88
Binary files /dev/null and b/test/fixtures/tarball-samples/missing-manifest.tar differ
diff --git a/test/fixtures/tarball-samples/missing-outbox.tar b/test/fixtures/tarball-samples/missing-outbox.tar
new file mode 100644
index 0000000..95b56e7
Binary files /dev/null and b/test/fixtures/tarball-samples/missing-outbox.tar differ
diff --git a/test/fixtures/tarball-samples/valid-export.tar b/test/fixtures/tarball-samples/valid-export.tar
new file mode 100644
index 0000000..7825814
Binary files /dev/null and b/test/fixtures/tarball-samples/valid-export.tar differ
diff --git a/test/index.spec.ts b/test/index.spec.ts
index 97a4228..ce805f6 100644
--- a/test/index.spec.ts
+++ b/test/index.spec.ts
@@ -5,6 +5,7 @@ import { exportActorProfile, importActorProfile } from '../src'
import { outbox } from './fixtures/outbox'
import { actorProfile } from './fixtures/actorProfile'
import { expect } from 'chai'
+import { Readable } from 'node:stream'
describe('exportActorProfile', () => {
it('calls function', async () => {
@@ -35,13 +36,16 @@ describe('exportActorProfile', () => {
describe('importActorProfile', () => {
it('extracts and verifies contents from account2.tar', async () => {
// Load the tar file as a buffer
- const tarBuffer = fs.readFileSync('test/fixtures/account2.tar')
+ const tarBuffer = fs.readFileSync(
+ 'test/fixtures/tarball-samples/valid-export.tar'
+ )
// Use the importActorProfile function to parse the tar contents
- const importedData = await importActorProfile(tarBuffer)
+ const tarStream = Readable.from(tarBuffer)
+ const importedData = await importActorProfile(tarStream)
// Log or inspect the imported data structure
- console.log('Imported Data:', importedData)
+ // console.log('Imported Data:', importedData)
// Example assertions to check specific files and content
expect(importedData).to.have.property('activitypub/actor.json')
diff --git a/test/verify.spec.ts b/test/verify.spec.ts
new file mode 100644
index 0000000..5de6e4a
--- /dev/null
+++ b/test/verify.spec.ts
@@ -0,0 +1,76 @@
+import { expect } from 'chai'
+import { readFileSync } from 'fs'
+import { validateExportStream } from '../dist'
+import { Readable } from 'stream'
+
+describe('validateExportStream', () => {
+ it('should validate a valid tarball', async () => {
+ // Load a valid tarball (e.g., exported-profile-valid.tar)
+ const tarBuffer = readFileSync(
+ 'test/fixtures/tarball-samples/valid-export.tar'
+ )
+ const tarStream = Readable.from(tarBuffer)
+ const result = await validateExportStream(tarStream)
+ console.log('🚀 ~ it ~ valid result:', result)
+
+ expect(result.valid).to.be.true
+ expect(result.errors).to.be.an('array').that.is.empty
+ })
+
+ it('should fail if manifest.yaml is missing', async () => {
+ // Load a tarball with missing manifest.yaml
+ const tarBuffer = readFileSync(
+ 'test/fixtures/tarball-samples/missing-manifest.tar'
+ )
+ const tarStream = Readable.from(tarBuffer)
+ const result = await validateExportStream(tarStream)
+ console.log('🚀 ~ it ~ miss mani result:', result)
+
+ expect(result.valid).to.be.false
+ })
+
+ it('should fail if actor.json is missing', async () => {
+ // Load a tarball with missing actor.json
+ const tarBuffer = readFileSync(
+ 'test/fixtures/tarball-samples/missing-actor.tar'
+ )
+ const tarStream = Readable.from(tarBuffer)
+ const result = await validateExportStream(tarStream)
+
+ expect(result.valid).to.be.false
+ console.log(JSON.stringify(result.errors))
+ })
+
+ it('should fail if outbox.json is missing', async () => {
+ // Load a tarball with missing outbox.json
+ const tarBuffer = readFileSync(
+ 'test/fixtures/tarball-samples/missing-outbox.tar'
+ )
+ const tarStream = Readable.from(tarBuffer)
+ const result = await validateExportStream(tarStream)
+
+ expect(result.valid).to.be.false
+ })
+
+ it('should fail if actor.json contains invalid JSON', async () => {
+ // Load a tarball with invalid JSON in actor.json
+ const tarBuffer = readFileSync(
+ 'test/fixtures/tarball-samples/invalid-actor.tar'
+ )
+ const tarStream = Readable.from(tarBuffer)
+ const result = await validateExportStream(tarStream)
+
+ expect(result.valid).to.be.false
+ })
+
+ it('should fail if manifest.yaml is invalid', async () => {
+ // Load a tarball with invalid manifest.yaml
+ const tarBuffer = readFileSync(
+ 'test/fixtures/tarball-samples/invalid-manifest.tar'
+ )
+ const tarStream = Readable.from(tarBuffer)
+ const result = await validateExportStream(tarStream)
+
+ expect(result.valid).to.be.false
+ })
+})