@oumla/sdk 0.0.3 → 0.0.4

package/dist/index.mjs

@@ -61,12 +61,10 @@ var Base = class {
     this.baseUrl = configs.baseUrl || "https://sandbox.oumla.com";
     this.env = configs.env || "testnet";
   }
-  /**
-   *
-   * A generic method to make requests to the Oumla API.
-   * Keep it simple for now, could be enhanced later.
-   *
-   */
+  // Add this method to get custom headers
+  getCustomHeaders() {
+    return {};
+  }
   httpRequest(args) {
     return __async(this, null, function* () {
       var _a;
@@ -75,13 +73,13 @@ var Base = class {
       }
       const paginationOpts = args.pagination ? `?skip=${args.pagination.skip || 0}&take=${args.pagination.take || 10}` : "";
       const URL2 = `${this.baseUrl}${args.path}${paginationOpts}`;
+      const headers = __spreadValues(__spreadValues({
+        "x-api-key": `Bearer ${this.apiKey}`,
+        "Content-Type": "application/json"
+      }, this.getCustomHeaders()), args.headers);
       const config = {
-        headers: {
-          "x-api-key": `Bearer ${this.apiKey}`,
-          "Content-Type": "application/json"
-        },
-        method: args.method || void 0,
-        // GET is the default in fetch
+        headers,
+        method: args.method || "GET",
         body: args.body ? JSON.stringify(args.body) : void 0
       };
       const res = yield fetch(URL2, config);
@@ -3745,7 +3743,7 @@ var z = /* @__PURE__ */ Object.freeze({
 });
 
 // src/schemas.ts
-var NetworkSchema = z.enum(["BTC", "ETH"]);
+var NetworkSchema = z.enum(["BTC", "ETH", "tBTC", "tETH"]);
 var ProfileTypeSchema = z.enum(["User", "Department", "Merchant"]);
 var GetWalletsSchema = z.object({
   reference: z.string()
@@ -3779,7 +3777,8 @@ var GetTransactionsSchema = z.object({
 }).partial();
 var GenerateAddressSchema = z.object({
   network: NetworkSchema,
-  reference: z.string()
+  reference: z.string(),
+  clientShare: z.string()
 });
 var GetAddressesSchema = z.object({
   baseUrl: z.string(),
@@ -3811,7 +3810,8 @@ var CreateTransactionSchema = z.object({
   to: z.string(),
   amount: z.number(),
   from: z.array(z.string()),
-  network: NetworkSchema
+  network: NetworkSchema,
+  clientShare: z.string()
 });
 var GetOrganizationSchema = z.object({
   baseUrl: z.string(),
@@ -3823,335 +3823,155 @@ var GetOrganizationDashboardSchema = z.object({
 });
 
 // src/client.ts
-var Oumla = class extends Base {
-  constructor(configs) {
-    super(configs);
-  }
-  /**
-   *
-   * Generate a wallet for a profile
-   *
-   * @param {string} args.reference - The reference of the profile
-   * @param {string} args.network - The network to generate a wallet for
-   *
-   * @example
-   * ``` ts
-   *
-   * const wallet = await client.generateWallet({
-   * reference: 'PROFILE_REFERENCE',
-   * network: 'BTC',
-   * });
-   *
-   * ```
-   *
-   * @returns {Types.TGenerateWalletResponse} - The generated wallet or an error
-   *
-   */
-  generateWallet(args) {
-    return __async(this, null, function* () {
-      return yield this.httpRequest({
-        method: "POST",
-        path: "/api/v1/wallets/generate",
-        body: args,
-        schema: GenerateWalletSchema
-      });
+var _Oumla = class extends Base {
+  // 1 hour
+  constructor(opts) {
+    super({
+      apiKey: opts.apiKey,
+      baseUrl: opts.baseUrl,
+      env: opts.env
     });
-  }
-  /**
-   *
-   * Get wallets for an organization
-   *
-   * @param {string} args.reference - The reference of the profile
-   * @param {Types.TPagination} [pagination] - Pagination options
-   *
-   * @example
-   * ``` ts
-   *
-   * const wallets = await client.getWallets({
-   * skip: 0,
-   * take: 3,
-   * });
-   *
-   * ```
-   *
-   * @returns {Types.TGetWalletsResponse} - The wallets for the organization
-   *
-   */
-  getWallets(args, pagination) {
-    return __async(this, null, function* () {
-      if (args == null ? void 0 : args.reference) {
-        return yield this.httpRequest({
-          path: `/api/v1/wallets/profile/${args.reference}`,
+    // Update this with each release
+    this.lastUpdateCheck = 0;
+    this.UPDATE_CHECK_INTERVAL = 60 * 60 * 1e3;
+    this.wallets = {
+      generate: (args) => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/wallets/generate",
+          method: "POST",
+          body: args,
+          schema: GenerateWalletSchema
+        });
+      }),
+      get: (args, pagination) => __async(this, null, function* () {
+        const path = (args == null ? void 0 : args.reference) ? `/api/v1/wallets/profile/${args.reference}` : "/api/v1/wallets/organization";
+        return this.httpRequest({
+          path,
+          method: "GET",
           pagination
         });
-      } else {
-        return yield this.httpRequest({
-          path: "/api/v1/wallets/organization",
+      })
+    };
+    this.addresses = {
+      generate: (args) => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/address/generate",
+          method: "POST",
+          body: args,
+          schema: GenerateAddressSchema
+        });
+      }),
+      get: (args, pagination) => __async(this, null, function* () {
+        const path = (args == null ? void 0 : args.reference) ? `/api/v1/addresses/${args.reference}` : "/api/v1/addresses/organization";
+        return this.httpRequest({
+          path,
+          method: "GET",
           pagination
         });
-      }
-    });
-  }
-  /**
-   *
-   * Generate an address for a profile
-   *
-   * @param {string} args.reference - The reference of the profile
-   * @param {string} args.network - The network to generate an address for
-   *
-   * @example
-   * ``` ts
-   *
-   * const address = await client.generateAddress({
-   * reference: 'PROFILE_REFERENCE',
-   * network: 'BTC',
-   * });
-   *
-   * ```
-   *
-   * @returns {Types.TGenerateAddressResponse} - The generated address
-   */
-  generateAddress(args) {
-    return __async(this, null, function* () {
-      return yield this.httpRequest({
-        method: "POST",
-        path: "/api/v1/address/generate",
-        body: args,
-        schema: GenerateAddressSchema
-      });
-    });
-  }
-  /**
-   *
-   * Get addresses
-   *
-   * @param {string} args.reference - The reference of the profile, Optional
-   * @param {Types.TPagination} [pagination] - Pagination options
-   * @example
-   * ``` ts
-   *
-   * const addresses = await client.getAddresses({
-   * reference: 'PROFILE_REFERENCE',
-   * },
-   *  {
-   * skip: 0,
-   * take: 3,
-   * }
-   * );
-   *
-   * ```
-   *
-   * @returns {Types.TGetProfileAddressesResponse} - The addresses for the profile
-   */
-  getAddresses(args, pagination) {
-    return __async(this, null, function* () {
-      if (args == null ? void 0 : args.reference) {
-        return yield this.httpRequest({
-          path: `/api/v1/addresses/${args.reference}`,
+      })
+    };
+    this.profiles = {
+      create: (args) => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/profiles",
+          method: "POST",
+          body: args,
+          schema: CreateProfileSchema
+        });
+      }),
+      get: (pagination) => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/profiles",
+          method: "GET",
           pagination
         });
-      } else {
-        return yield this.httpRequest({
-          path: "/api/v1/addresses/organization",
+      })
+    };
+    this.organization = {
+      get: () => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/organizations",
+          method: "GET"
+        });
+      }),
+      volume: () => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/statistics/organization/volume",
+          method: "GET"
+        });
+      }),
+      insights: () => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/statistics/organization/insights",
+          method: "GET"
+        });
+      })
+    };
+    this.transactions = {
+      create: (args) => __async(this, null, function* () {
+        return this.httpRequest({
+          path: "/api/v1/withdraw/address",
+          method: "POST",
+          body: args,
+          schema: CreateTransactionSchema
+        });
+      }),
+      get: (args, pagination) => __async(this, null, function* () {
+        let path = "/api/v1/transactions/organization";
+        if (args == null ? void 0 : args.address) {
+          path = `/api/v1/transactions/address/${args.address}`;
+        } else if (args == null ? void 0 : args.wallet) {
+          path = `/api/v1/transactions/wallet/${args.wallet}`;
+        } else if (args == null ? void 0 : args.reference) {
+          path = `/api/v1/transactions/profile/${args.reference}`;
+        }
+        return this.httpRequest({
+          path,
+          method: "GET",
           pagination
         });
-      }
-    });
-  }
-  /**
-   *
-   * Get the organization's information
-   *
-   * @example
-   * ``` ts
-   *
-   * const organization = await client.getOrganization();
-   *
-   * ```
-   *
-   * @returns {Types.TGetOrganizationResponse} - The organization's information
-   */
-  getOrganization() {
-    return __async(this, null, function* () {
-      return yield this.httpRequest({
-        path: "/api/v1/organizations"
-      });
-    });
-  }
-  /**
-   *
-   * Create a profile
-   *
-   * @param {string} args.reference - The reference of the profile
-   * @param {Types.TCreateProfileArgs['type']} args.type - The type of the profile
-   *
-   * @example
-   * ``` ts
-   *
-   * const profile = await client.createProfile({
-   * reference: 'PROFILE_REFERENCE',
-   * type: 'User',
-   * });
-   *
-   * ```
-   *
-   * @returns {Types.TCreateProfileResponse} - The created profile
-   */
-  createProfile(args) {
-    return __async(this, null, function* () {
-      return yield this.httpRequest({
-        method: "POST",
-        path: "/api/v1/profiles",
-        body: args,
-        schema: CreateProfileSchema
-      });
-    });
-  }
-  /**
-   *
-   *  Get the profiles for an organization
-   *
-   * @param {Types.TPagination} [pagination] - Pagination options
-   *
-   * @example
-   * ``` ts
-   *
-   * const profiles = await client.getProfiles({
-   * skip: 0,
-   * take: 3,
-   * });
-   *
-   * ```
-   *
-   * @returns {Types.TGetProfilesResponse} - The profiles for the organization
-   */
-  getProfiles(pagination) {
-    return __async(this, null, function* () {
-      return yield this.httpRequest({
-        path: "/api/v1/profiles",
-        pagination
-      });
-    });
+      })
+    };
+    this.apiKey = opts.apiKey;
+    this.baseUrl = opts.baseUrl || "https://api.oumla.com";
+    this.env = opts.env || "testnet";
+    this.initialize();
   }
-  /**
-   *
-   * Get the volume for an organization
-   *
-   * @example
-   * ``` ts
-   *
-   * const volume = await client.getVolume();
-   *
-   * ```
-   *
-   * @returns {Types.TGetVolumeResponse} - The volume of the organization
-   */
-  getVolume() {
+  initialize() {
     return __async(this, null, function* () {
-      return yield this.httpRequest({
-        path: "/api/v1/statistics/organization/volume"
-      });
+      yield this.checkForUpdates();
     });
   }
-  /**
-   *
-   * Get the insights for an organization
-   *
-   * @example
-   * ``` ts
-   *
-   * const insights = await client.getInsights();
-   *
-   * ```
-   *
-   * @returns {Types.TGetInsightsResponse} - The insights of the organization
-   */
-  getInsights() {
-    return __async(this, null, function* () {
-      return yield this.httpRequest({
-        path: "/api/v1/statistics/organization/insights"
-      });
-    });
+  getCustomHeaders() {
+    return {
+      "x-sdk-version": _Oumla.CURRENT_VERSION
+    };
   }
-  /**
-   *
-   * Get the all the transactions or transactions for an address, wallet or reference
-   *
-   * By providing more than one option, only one will be used.
-   *
-   * @param {string} [args.address] - The address to get transactions for
-   * @param {string} [args.wallet] - The wallet to get transactions for
-   * @param {string} [args.reference] - The reference to get transactions for
-   * @param {Types.TPagination} [pagination] - Pagination options
-   *
-   * @example
-   * ``` ts
-   *
-   * const transactionsByAddress = await client.getTransactions({
-   * address: 'ADDRESS',
-   * });
-   *
-   * ```
-   *
-   * @returns {Types.TGetTransactionsResponse} - The transactions
-   *
-   */
-  getTransactions(args, pagination) {
+  checkForUpdates() {
     return __async(this, null, function* () {
-      if (args == null ? void 0 : args.address) {
-        return yield this.httpRequest({
-          path: `/api/v1/transactions/address/${args.address}`,
-          pagination
-        });
-      } else if (args == null ? void 0 : args.wallet) {
-        return yield this.httpRequest({
-          path: `/api/v1/transactions/wallet/${args.wallet}`,
-          pagination
-        });
-      } else if (args == null ? void 0 : args.reference) {
-        return yield this.httpRequest({
-          path: `/api/v1/transactions/profile/${args.reference}`,
-          pagination
-        });
-      } else {
-        return yield this.httpRequest({
-          path: "/api/v1/transactions/organization",
-          pagination
+      const now = Date.now();
+      if (now - this.lastUpdateCheck < this.UPDATE_CHECK_INTERVAL) {
+        return;
+      }
+      try {
+        const response = yield this.httpRequest({
+          path: "/api/v1/sdk-version",
+          method: "GET"
         });
+        if (response.latestVersion !== _Oumla.CURRENT_VERSION) {
+          console.log(
+            `A new version (${response.latestVersion}) of the Oumla SDK is available. Please update.`
+          );
+        }
+        this.lastUpdateCheck = now;
+      } catch (error) {
+        console.error("Failed to check for updates:", error);
       }
     });
   }
-  /**
-   * create transaction
-   *
-   * @param  args.from - the address or addresses to transfer from
-   * @param  args.to - The desired address to transfer to
-   * @param  args.amount - The amount to transfer
-   *
-   * @example
-   *
-   * ``` ts
-   *
-   * const transfer = await client.transfer({
-   * from: '0x...',
-   * to: '0x...',
-   * reference: '0x...',
-   * amount: 100,
-   * });
-   *
-   * ```
-   */
-  createTransaction(args) {
-    return __async(this, null, function* () {
-      return yield this.httpRequest({
-        method: "POST",
-        path: "/api/v1/withdraw/address",
-        body: args,
-        schema: CreateTransactionSchema
-      });
-    });
-  }
 };
+var Oumla = _Oumla;
+Oumla.CURRENT_VERSION = "1.0.0";
 
 // src/types.ts
 var ProfileType = /* @__PURE__ */ ((ProfileType2) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oumla/sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Oumla SDK is the fastest way to integrate with blockchain networks",
   "private": false,
   "main": "dist/index.js",
@@ -9,8 +9,6 @@
   "devDependencies": {
     "@changesets/cli": "^2.27.1",
     "@types/node": "^18.14.0",
-    "@types/superagent": "^4.1.18",
-    "superagent": "^8.1.2",
     "tsup": "^6.7.0",
     "typescript": "5.0.4",
     "vitest": "^1.1.3",