@autonomys/auto-files 1.5.11 → 1.5.13

package/README.md

@@ -1 +1,298 @@
-# auto-files
+# Auto Files
+
+A TypeScript client library for interacting with the Auto Files service API.
+
+## Installation
+
+```bash
+npm install @autonomys/auto-files
+```
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+```
+
+### File Operations
+
+#### Get File
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+
+try {
+  const fileStream = await api.getFile('your-file-cid', {
+    retriesPerFetch: 3,
+    onProgress: (progress) => {
+      console.log(`Download progress: ${progress * 100}%`)
+    },
+    ignoreCache: false,
+  })
+
+  // Handle the file stream
+  fileStream.pipe(process.stdout)
+} catch (error) {
+  console.error('Error downloading file:', error)
+}
+```
+
+#### Get Chunked File
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+
+try {
+  const file = await api.getChunkedFile('your-file-cid', {
+    retriesPerFetch: 3,
+    onProgress: (progress) => {
+      console.log(`Download progress: ${progress * 100}%`)
+    },
+  })
+
+  console.log(`File size: ${file.length} bytes`)
+  console.log(`Compression: ${file.compression ? 'Yes' : 'No'}`)
+  console.log(`Encryption: ${file.encryption ? 'Yes' : 'No'}`)
+
+  // Handle the file data stream
+  file.data.pipe(process.stdout)
+} catch (error) {
+  console.error('Error downloading chunked file:', error)
+}
+```
+
+#### Check File Cache Status
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+
+try {
+  const isCached = await api.isFileCached('your-file-cid')
+  console.log(`File is cached: ${isCached}`)
+} catch (error) {
+  console.error('Error checking file cache status:', error)
+}
+```
+
+#### Get Node
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+
+try {
+  const nodeData = await api.getNode('your-node-cid')
+  console.log(`Node data size: ${nodeData.byteLength} bytes`)
+} catch (error) {
+  console.error('Error fetching node:', error)
+}
+```
+
+### Moderation Operations
+
+#### Ban a File
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+
+try {
+  await api.banFile('your-file-cid')
+  console.log('File banned successfully')
+} catch (error) {
+  console.error('Error banning file:', error)
+}
+```
+
+#### Unban a File
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+
+try {
+  await api.unbanFile('your-file-cid')
+  console.log('File unbanned successfully')
+} catch (error) {
+  console.error('Error unbanning file:', error)
+}
+```
+
+#### Get Banned Files
+
+```typescript
+import { createAutoFilesApi } from '@autonomys/auto-files'
+
+const api = createAutoFilesApi('https://api.autofiles.com', 'your-api-secret')
+
+try {
+  const bannedFiles = await api.getBannedFiles(1, 10)
+  console.log(`Found ${bannedFiles.length} banned files`)
+
+  for (const cid of bannedFiles) {
+    console.log(`CID: ${cid}`)
+  }
+} catch (error) {
+  console.error('Error fetching banned files:', error)
+}
+```
+
+## API Reference
+
+### `createAutoFilesApi(baseUrl: string, apiSecret: string)`
+
+Creates an API client instance.
+
+**Parameters:**
+
+- `baseUrl` - The base URL of the Auto Files API
+- `apiSecret` - The API secret key for authentication
+
+**Returns:** An object containing methods to interact with the API
+
+### File Methods
+
+#### `getFile(cid: string, options?: GetFileOptions)`
+
+Fetches a complete file from the API.
+
+**Parameters:**
+
+- `cid` - The content identifier of the file
+- `options` - Optional configuration
+  - `retriesPerFetch` - Number of retry attempts (default: 3)
+  - `onProgress` - Progress callback function (0-1)
+  - `ignoreCache` - Whether to ignore cache (default: false)
+
+**Returns:** Promise<Readable> - File data stream
+
+#### `getChunkedFile(cid: string, options?: GetChunkedFileOptions)`
+
+Fetches a complete file with metadata.
+
+**Parameters:**
+
+- `cid` - The content identifier of the file
+- `options` - Optional configuration
+  - `retriesPerFetch` - Number of retry attempts (default: 3)
+  - `onProgress` - Progress callback function (0-1)
+
+**Returns:** Promise<FetchedFile> - File with metadata and data stream
+
+#### `isFileCached(cid: string)`
+
+Checks if a file is cached on the gateway.
+
+**Parameters:**
+
+- `cid` - The content identifier of the file
+
+**Returns:** Promise<boolean> - Whether the file is cached
+
+#### `getNode(cid: string)`
+
+Fetches a specific node from the API.
+
+**Parameters:**
+
+- `cid` - The CID of the node
+
+**Returns:** Promise<ArrayBuffer> - Node data
+
+### Moderation Methods
+
+#### `banFile(cid: string)`
+
+Bans a file by sending a request to the moderation service.
+
+**Parameters:**
+
+- `cid` - The content identifier of the file to ban
+
+**Returns:** Promise<void>
+
+#### `unbanFile(cid: string)`
+
+Unbans a file by sending a request to the moderation service.
+
+**Parameters:**
+
+- `cid` - The content identifier of the file to unban
+
+**Returns:** Promise<void>
+
+#### `getBannedFiles(page?: number, limit?: number)`
+
+Gets a list of banned files with pagination support.
+
+**Parameters:**
+
+- `page` - The page number for pagination (default: 1)
+- `limit` - The number of files per page (default: 10)
+
+**Returns:** Promise<BannedFilesResponse>
+
+## Types
+
+### `FetchedFile`
+
+```typescript
+interface FetchedFile {
+  length: bigint
+  compression: CompressionOptions | undefined
+  encryption: EncryptionOptions | undefined
+  data: Readable
+}
+```
+
+### `BannedFile`
+
+```typescript
+interface BannedFile {
+  cid: string
+  bannedAt: string
+  reason?: string
+  bannedBy?: string
+}
+```
+
+### `BannedFilesResponse`
+
+```typescript
+interface BannedFilesResponse {
+  bannedFiles: BannedFile[]
+  totalCount?: number
+  page?: number
+  limit?: number
+}
+```
+
+## Error Handling
+
+All methods throw errors when API requests fail. Errors include HTTP status codes and descriptive messages.
+
+```typescript
+try {
+  await api.banFile('invalid-cid')
+} catch (error) {
+  console.error('Error:', error.message)
+  // Example: "Error banning file: 400 Bad Request"
+}
+```
+
+## License
+
+This project is licensed under the MIT License.

package/dist/api.d.ts

@@ -24,6 +24,10 @@ export declare const createAutoFilesApi: (baseUrl: string, apiSecret: string) =>
         onProgress?: (progress: number) => void;
     }) => Promise<FetchedFile>;
     getNode: (cid: string) => Promise<ArrayBuffer>;
+    banFile: (cid: string) => Promise<void>;
+    unbanFile: (cid: string) => Promise<void>;
+    getBannedFiles: (page?: number, limit?: number) => Promise<string[]>;
+    isFileBanned: (cid: string) => Promise<boolean>;
 };
 export {};
 //# sourceMappingURL=api.d.ts.map

package/dist/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEjC,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,kBAAkB,GAAG,SAAS,CAAA;IAC3C,UAAU,EAAE,iBAAiB,GAAG,SAAS,CAAA;IACzC,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,EAAE,WAAW,MAAM;mBAmJ5D,MAAM,kDAKR;QACD,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;QACvC,WAAW,CAAC,EAAE,OAAO,CAAA;KACtB;wBA5C8B,MAAM;0BAlDhC,MAAM,qCAIR;QAAE,eAAe,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,KACvE,OAAO,CAAC,WAAW,CAAC;mBAzBK,MAAM,KAAG,OAAO,CAAC,WAAW,CAAC;CAgI1D,CAAA"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAGjC,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,kBAAkB,GAAG,SAAS,CAAA;IAC3C,UAAU,EAAE,iBAAiB,GAAG,SAAS,CAAA;IACzC,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,EAAE,WAAW,MAAM;mBAmJ5D,MAAM,kDAKR;QACD,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;QACvC,WAAW,CAAC,EAAE,OAAO,CAAA;KACtB;wBA5C8B,MAAM;0BAlDhC,MAAM,qCAIR;QAAE,eAAe,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,KACvE,OAAO,CAAC,WAAW,CAAC;mBAzBK,MAAM,KAAG,OAAO,CAAC,WAAW,CAAC;mBAqI7B,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;qBAqBpB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;4BAsBhB,MAAM,UAAa,MAAM,KAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;wBAiBrD,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;CAqB3D,CAAA"}

package/dist/api.js

@@ -151,6 +151,80 @@ const createAutoFilesApi = (baseUrl, apiSecret) => {
         });
         return file.data;
     });
-    return { getFile, isFileCached, getChunkedFile, getNode };
+    /**
+     * Bans a file by sending a request to the moderation service
+     * @param cid - The content identifier of the file to ban
+     * @returns A Promise that resolves when the file has been successfully banned
+     * @throws Error if the ban operation fails
+     */
+    const banFile = (cid) => __awaiter(void 0, void 0, void 0, function* () {
+        const response = yield authFetch(`${baseUrl}/moderation/${cid}/ban`, {
+            method: 'POST',
+        });
+        if (!response.ok) {
+            throw new Error(`Error banning file: ${response.status} ${response.statusText}`);
+        }
+        const result = yield response.json();
+        if (!result.success) {
+            throw new Error(`Failed to ban file: ${result.message || 'Unknown error'}`);
+        }
+    });
+    /**
+     * Unbans a file by sending a request to the moderation service
+     * @param cid - The content identifier of the file to unban
+     * @returns A Promise that resolves when the file has been successfully unbanned
+     * @throws Error if the unban operation fails
+     */
+    const unbanFile = (cid) => __awaiter(void 0, void 0, void 0, function* () {
+        const response = yield authFetch(`${baseUrl}/moderation/${cid}/unban`, {
+            method: 'POST',
+        });
+        if (!response.ok) {
+            throw new Error(`Error unbanning file: ${response.status} ${response.statusText}`);
+        }
+        const result = yield response.json();
+        if (!result.success) {
+            throw new Error(`Failed to unban file: ${result.message || 'Unknown error'}`);
+        }
+    });
+    /**
+     * Gets a list of banned files with pagination support
+     * @param page - The page number for pagination (optional, defaults to 1)
+     * @param limit - The number of files per page (optional, defaults to 10)
+     * @returns A Promise that resolves to an array of CIDs
+     * @throws Error if the request fails
+     */
+    const getBannedFiles = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (page = 1, limit = 10) {
+        const response = yield authFetch(`${baseUrl}/moderation/banned?page=${page}&limit=${limit}`);
+        if (!response.ok) {
+            throw new Error(`Error fetching banned files: ${response.status} ${response.statusText}`);
+        }
+        const result = yield response.json();
+        return result.bannedFiles;
+    });
+    /**
+     * Checks if a file is banned by querying the moderation service
+     * @param cid - The content identifier of the file to check
+     * @returns A Promise that resolves to true if the file is banned, false otherwise
+     * @throws Error if the status check fails
+     */
+    const isFileBanned = (cid) => __awaiter(void 0, void 0, void 0, function* () {
+        const response = yield authFetch(`${baseUrl}/moderation/${cid}/status`);
+        if (!response.ok) {
+            throw new Error(`Error checking file ban status: ${response.status} ${response.statusText}`);
+        }
+        const result = yield response.json();
+        return result.isBanned;
+    });
+    return {
+        getFile,
+        isFileCached,
+        getChunkedFile,
+        getNode,
+        banFile,
+        unbanFile,
+        getBannedFiles,
+        isFileBanned,
+    };
 };
 exports.createAutoFilesApi = createAutoFilesApi;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autonomys/auto-files",
-  "version": "1.5.11",
+  "version": "1.5.13",
   "packageManager": "yarn@4.7.0",
   "scripts": {
     "build": "tsc"
@@ -21,7 +21,7 @@
     }
   },
   "dependencies": {
-    "@autonomys/auto-drive": "^1.5.11"
+    "@autonomys/auto-drive": "^1.5.13"
   },
-  "gitHead": "d23aab1111c5acf2388bf5e8e4f92c5eb8ba972a"
+  "gitHead": "ed410d97d09e708002b35264bf9f80faccc10d3b"
 }