@autonomys/auto-drive 1.2.1 → 1.2.3

package/README.md

@@ -20,14 +20,22 @@ yarn add @autonomys/auto-drive
 
 ### How to use it?
 
+To interact with the Auto-Drive API, you'll need to create an API key. Follow these steps:
+
+- Go to [Auto-Drive](https://ai3.storage) and login with your preffered SSO.
+- Once you're logged in, click on the profile section in the left sidebar menu.
+- In the profile section, click on 'Create API Key'
+- Read the modal message and click on generate
+
 ### How to upload a file from filepath? (Not available in browser)
 
 Here is an example of how to use the `uploadFileFromFilepath` method to upload a file with optional encryption and compression:
 
 ```typescript
 import { uploadFileFromFilepath,createAutoDriveApi } from '@autonomys/auto-drive'
+import { NetworkId } from '@autonomys/auto-utils'
 
-const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
+const api = createAutoDriveApi({ apiKey: 'your-api-key', network: NetworkId.TAURUS }) // Initialize your API instance with API key
 const filePath = 'path/to/your/file.txt' // Specify the path to your file
 const options = {
   password: 'your-encryption-password', // Optional: specify a password for encryption
@@ -47,8 +55,9 @@ console.log(`The file is uploaded and its cid is ${cid}`)
 
 ```typescript
 import { uploadFileFromInput, createAutoDriveApi } from '@autonomys/auto-drive'
+import { NetworkId } from '@autonomys/auto-utils'
 
-const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
+const api = createAutoDriveApi({ apiKey: 'your-api-key', network: NetworkId.TAURUS }) // Initialize your API instance with API key
 
 // e.g Get File from object from HTML event
 const file: File = e.target.value // Substitute with your file
@@ -81,8 +90,9 @@ You could upload any file that could be represented in that way. For example, up
 
 ```typescript
 import { createAutoDriveApi, uploadFile } from '@autonomys/auto-drive'
+import { NetworkId } from '@autonomys/auto-utils'
 
-const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
+const api = createAutoDriveApi({ apiKey: 'your-api-key', network: NetworkId.TAURUS }) // Initialize your API instance with API key
 const buffer = Buffer.from(...);
 const genericFile = {
   read: async function *() {
@@ -112,8 +122,9 @@ console.log(`The file is uploaded and its cid is ${cid}`)
 
 ```ts
 import { createAutoDriveApi, uploadFolderFromFolderPath } from '@autonomys/auto-drive'
+import { NetworkId } from '@autonomys/auto-utils'
 
-const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
+const api = createAutoDriveApi({ apiKey: 'your-api-key', network: NetworkId.TAURUS }) // Initialize your API instance with API key
 const folderPath = 'path/to/your/folder' // Specify the path to your folder
 
 const options = {
@@ -138,8 +149,9 @@ Here is an example of how to use the `downloadFile` method to download a file fr
 
 ```typescript
 import { createAutoDriveApi, downloadFile } from '@autonomys/auto-drive'
+import { NetworkId } from '@autonomys/auto-utils'
 
-const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
+const api = createAutoDriveApi({ apiKey: 'your-api-key', network: NetworkId.TAURUS }) // Initialize your API instance with API key
 
 try {
   const cid = '..'
@@ -160,8 +172,9 @@ Here is an example of how to use the `getRoots` method to retrieve the root dire
 
 ```typescript
 import { createAutoDriveApi, apiCalls, Scope } from '@autonomys/auto-drive'
+import { NetworkId } from '@autonomys/auto-utils'
 
-const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
+const api = createAutoDriveApi({ apiKey: 'your-api-key', network: NetworkId.TAURUS }) // Initialize your API instance with API key
 
 try {
   const myFiles = await apiCalls.getRoots(api, {

package/dist/api/connection.d.ts

@@ -1,3 +1,4 @@
+import { AutoDriveNetwork } from './networks';
 export interface AutoDriveApi {
     sendRequest: (relativeUrl: string, request: Partial<Request>, body?: BodyInit) => Promise<Response>;
 }
@@ -7,9 +8,17 @@ export declare enum OAuthProvider {
 }
 export type ApiKeyAuthProvider = 'apikey';
 export type AuthProvider = ApiKeyAuthProvider | 'oauth';
-export declare const createAutoDriveApi: ({ provider, apiKey, url, }: {
+type ConnectionOptions = {
     provider?: AuthProvider;
-    apiKey: string;
-    url?: string;
-}) => AutoDriveApi;
+    apiKey?: string;
+    url?: null;
+    network: AutoDriveNetwork;
+} | {
+    provider?: AuthProvider;
+    apiKey?: string;
+    url: string;
+    network?: null;
+};
+export declare const createAutoDriveApi: ({ provider, apiKey, url, network, }: ConnectionOptions) => AutoDriveApi;
+export {};
 //# sourceMappingURL=connection.d.ts.map

package/dist/api/connection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../src/api/connection.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,CACX,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,EACzB,IAAI,CAAC,EAAE,QAAQ,KACZ,OAAO,CAAC,QAAQ,CAAC,CAAA;CACvB;AAED,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAA;AACzC,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,OAAO,CAAA;AAEvD,eAAO,MAAM,kBAAkB,+BAI5B;IACD,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,KAAG,YAiBH,CAAA"}
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../src/api/connection.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAA2B,MAAM,YAAY,CAAA;AAEtE,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,CACX,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,EACzB,IAAI,CAAC,EAAE,QAAQ,KACZ,OAAO,CAAC,QAAQ,CAAC,CAAA;CACvB;AAED,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAA;AACzC,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,OAAO,CAAA;AAEvD,KAAK,iBAAiB,GAClB;IACE,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,gBAAgB,CAAA;CAC1B,GACD;IACE,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EAAE,IAAI,CAAA;CACf,CAAA;AAEL,eAAO,MAAM,kBAAkB,wCAK5B,iBAAiB,KAAG,YAmBtB,CAAA"}

package/dist/api/connection.js

@@ -10,18 +10,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createAutoDriveApi = exports.OAuthProvider = void 0;
+const networks_1 = require("./networks");
 var OAuthProvider;
 (function (OAuthProvider) {
     OAuthProvider["GOOGLE"] = "google";
     OAuthProvider["DISCORD"] = "discord";
 })(OAuthProvider || (exports.OAuthProvider = OAuthProvider = {}));
-const createAutoDriveApi = ({ provider = 'apikey', apiKey, url = 'https://demo.auto-drive.autonomys.xyz/api', }) => {
+const createAutoDriveApi = ({ provider = 'apikey', apiKey, url = null, network, }) => {
+    const baseUrl = !network ? url : (0, networks_1.getNetworkUrl)(network);
     return {
         sendRequest: (relativeUrl, request, body) => __awaiter(void 0, void 0, void 0, function* () {
             var _a;
             const headers = new Headers(Object.assign(Object.assign({}, Object.fromEntries(((_a = request.headers) === null || _a === void 0 ? void 0 : _a.entries()) || [])), { 'x-auth-provider': provider, Authorization: `Bearer ${apiKey}` }));
             const fullRequest = Object.assign(Object.assign({}, request), { headers: new Headers(headers), body });
-            return fetch(`${url}${relativeUrl}`, fullRequest);
+            return fetch(`${baseUrl}${relativeUrl}`, fullRequest);
         }),
     };
 };

package/dist/api/networks.d.ts

@@ -0,0 +1,7 @@
+export type AutoDriveNetwork = keyof typeof networks;
+export declare const networks: {
+    taurus: string;
+    mainnet: string;
+};
+export declare const getNetworkUrl: (networkId: AutoDriveNetwork) => string;
+//# sourceMappingURL=networks.d.ts.map

package/dist/api/networks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"networks.d.ts","sourceRoot":"","sources":["../../src/api/networks.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG,MAAM,OAAO,QAAQ,CAAA;AAEpD,eAAO,MAAM,QAAQ;;;CAGyB,CAAA;AAE9C,eAAO,MAAM,aAAa,cAAe,gBAAgB,WAMxD,CAAA"}

package/dist/api/networks.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNetworkUrl = exports.networks = void 0;
+const auto_utils_1 = require("@autonomys/auto-utils");
+exports.networks = {
+    [auto_utils_1.NetworkId.TAURUS]: 'https://demo.auto-drive.autonomys.xyz/api',
+    [auto_utils_1.NetworkId.MAINNET]: 'https://mainnet.auto-drive.autonomys.xyz/api',
+};
+const getNetworkUrl = (networkId) => {
+    if (!exports.networks[networkId]) {
+        throw new Error(`Network ${networkId} not found`);
+    }
+    return exports.networks[networkId];
+};
+exports.getNetworkUrl = getNetworkUrl;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@autonomys/auto-drive",
   "packageManager": "yarn@4.2.2",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -42,12 +42,12 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@autonomys/auto-dag-data": "^1.2.1",
+    "@autonomys/auto-dag-data": "^1.2.3",
     "jszip": "^3.10.1",
     "mime-types": "^2.1.35",
     "process": "^0.11.10",
     "stream": "^0.0.3",
     "zod": "^3.23.8"
   },
-  "gitHead": "72285a024adcc7681ec59fabd1f061a6e40aeb09"
+  "gitHead": "53cf74430ba08ed3b8f38ccc2fcee7b373a7934c"
 }

package/src/api/connection.ts

@@ -1,3 +1,6 @@
+import { NetworkId } from '@autonomys/auto-utils'
+import { AutoDriveNetwork, getNetworkUrl, networks } from './networks'
+
 export interface AutoDriveApi {
   sendRequest: (
     relativeUrl: string,
@@ -14,15 +17,28 @@ export enum OAuthProvider {
 export type ApiKeyAuthProvider = 'apikey'
 export type AuthProvider = ApiKeyAuthProvider | 'oauth'
 
+type ConnectionOptions =
+  | {
+      provider?: AuthProvider
+      apiKey?: string
+      url?: null
+      network: AutoDriveNetwork
+    }
+  | {
+      provider?: AuthProvider
+      apiKey?: string
+      url: string
+      network?: null
+    }
+
 export const createAutoDriveApi = ({
   provider = 'apikey',
   apiKey,
-  url = 'https://demo.auto-drive.autonomys.xyz/api',
-}: {
-  provider?: AuthProvider
-  apiKey: string
-  url?: string
-}): AutoDriveApi => {
+  url = null,
+  network,
+}: ConnectionOptions): AutoDriveApi => {
+  const baseUrl = !network ? url : getNetworkUrl(network)
+
   return {
     sendRequest: async (relativeUrl: string, request: Partial<Request>, body?: BodyInit) => {
       const headers = new Headers({
@@ -36,7 +52,7 @@ export const createAutoDriveApi = ({
         body,
       }
 
-      return fetch(`${url}${relativeUrl}`, fullRequest)
+      return fetch(`${baseUrl}${relativeUrl}`, fullRequest)
     },
   }
 }

package/src/api/networks.ts

@@ -0,0 +1,16 @@
+import { NetworkId } from '@autonomys/auto-utils'
+
+export type AutoDriveNetwork = keyof typeof networks
+
+export const networks = {
+  [NetworkId.TAURUS]: 'https://demo.auto-drive.autonomys.xyz/api',
+  [NetworkId.MAINNET]: 'https://mainnet.auto-drive.autonomys.xyz/api',
+} satisfies Partial<Record<NetworkId, string>>
+
+export const getNetworkUrl = (networkId: AutoDriveNetwork) => {
+  if (!networks[networkId]) {
+    throw new Error(`Network ${networkId} not found`)
+  }
+
+  return networks[networkId]
+}