@sereel/sdk 0.1.5 → 0.2.0

package/dist/index.js

@@ -13,12 +13,18 @@ var SereelSdkError = class extends Error {
 };
 var InvalidConfigurationError = class extends SereelSdkError {
 };
+var NetworkError = class extends SereelSdkError {
+};
 var HttpError = class extends SereelSdkError {
 };
 var UnauthorizedError = class extends HttpError {
 };
+var ForbiddenError = class extends HttpError {
+};
 var NotFoundError = class extends HttpError {
 };
+var RateLimitError = class extends HttpError {
+};
 var ServerError = class extends HttpError {
 };
 var TimeoutError = class extends SereelSdkError {
@@ -123,14 +129,30 @@ function toHttpError(status, body) {
   if (status === 401) {
     return new UnauthorizedError(message, options);
   }
+  if (status === 403) {
+    return new ForbiddenError(message, options);
+  }
   if (status === 404) {
     return new NotFoundError(message, options);
   }
+  if (status === 429) {
+    return new RateLimitError(message, options);
+  }
   if (status >= 500) {
     return new ServerError(message, options);
   }
   return new HttpError(message, options);
 }
+function isAbortError(error) {
+  return error instanceof Error && (error.name === "AbortError" || error.constructor.name === "AbortError");
+}
+function wrapNetworkError(error) {
+  if (error instanceof NetworkError) {
+    return error;
+  }
+  const message = error instanceof Error ? error.message : typeof error === "string" ? error : "Network request failed.";
+  return new NetworkError(message, { cause: error });
+}
 async function requestJson(config, path, validate) {
   const { signal, cleanup } = createTimeoutSignal(config.timeoutMs);
   try {
@@ -148,16 +170,16 @@ async function requestJson(config, path, validate) {
     }
     return validate(body);
   } catch (error) {
-    if (error instanceof HttpError || error instanceof MalformedResponseError) {
+    if (error instanceof HttpError || error instanceof MalformedResponseError || error instanceof NetworkError) {
       throw error;
     }
-    if (error instanceof Error && error.name === "AbortError") {
+    if (isAbortError(error)) {
       throw new TimeoutError(
         `Request timed out after ${config.timeoutMs}ms.`,
         { cause: error }
       );
     }
-    throw error;
+    throw wrapNetworkError(error);
   } finally {
     cleanup();
   }
@@ -179,47 +201,237 @@ function isFiniteNumber(value) {
 function isBoolean(value) {
   return typeof value === "boolean";
 }
-function isProspectus(value) {
-  return isRecord(value) && isString(value.name) && isString(value.url);
+var ValidationContext = class {
+  failures = [];
+  check(condition, path, expected, received) {
+    if (!condition) {
+      this.failures.push({ path, expected, received });
+    }
+    return condition;
+  }
+};
+function asRecord(value) {
+  return isRecord(value) ? value : void 0;
 }
-function isTokenPartner(value) {
-  return isRecord(value) && isString(value.partner_name) && isString(value.partner_logo) && isString(value.partner_role);
+function isProspectus(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(isString(v.name), `${path}.name`, "string", v.name);
+  ctx.check(isString(v.url), `${path}.url`, "string", v.url);
+  return true;
 }
-function isRuleSummary(value) {
-  return isRecord(value) && isString(value.rule_address) && isString(value.rule_type);
+function isTokenPartner(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(
+    isString(v.partner_name),
+    `${path}.partner_name`,
+    "string",
+    v.partner_name
+  );
+  ctx.check(
+    isString(v.partner_logo),
+    `${path}.partner_logo`,
+    "string",
+    v.partner_logo
+  );
+  ctx.check(
+    isString(v.partner_role),
+    `${path}.partner_role`,
+    "string",
+    v.partner_role
+  );
+  return true;
 }
-function isRuleEngineSummary(value) {
-  return isRecord(value) && isString(value.name) && isString(value.rule_engine_address) && Array.isArray(value.rules) && value.rules.every(isRuleSummary);
+function isRuleSummary(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(
+    isString(v.rule_address),
+    `${path}.rule_address`,
+    "string",
+    v.rule_address
+  );
+  ctx.check(
+    isString(v.rule_type),
+    `${path}.rule_type`,
+    "string",
+    v.rule_type
+  );
+  return true;
 }
-function isSecurityDetails(value) {
-  if (!isRecord(value)) return false;
-  const hasRequiredStrings = isString(value.token_address) && isString(value.token_name) && isString(value.token_symbol) && isString(value.token_decimal) && isString(value.network_id) && isString(value.token_type) && isString(value.admin);
-  if (!hasRequiredStrings) return false;
-  if (!isNullableString(value.icon_url)) return false;
-  if (!isNullableString(value.created_at)) return false;
-  if (value.prospectus !== null && value.prospectus !== void 0) {
-    if (!isProspectus(value.prospectus)) return false;
-  }
-  if (value.partners !== null && value.partners !== void 0) {
-    if (!Array.isArray(value.partners) || !value.partners.every(isTokenPartner))
-      return false;
-  }
-  if (value.rule_engine !== null && value.rule_engine !== void 0) {
-    if (!isRuleEngineSummary(value.rule_engine)) return false;
+function isRuleEngineSummary(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(isString(v.name), `${path}.name`, "string", v.name);
+  ctx.check(
+    isString(v.rule_engine_address),
+    `${path}.rule_engine_address`,
+    "string",
+    v.rule_engine_address
+  );
+  const rulesOk = ctx.check(
+    Array.isArray(v.rules),
+    `${path}.rules`,
+    "array",
+    v.rules
+  );
+  if (rulesOk) {
+    v.rules.forEach(
+      (rule, i) => isRuleSummary(rule, ctx, `${path}.rules[${i}]`)
+    );
   }
   return true;
 }
-function isIssuerSummary(value) {
-  return isRecord(value) && isString(value.id) && isString(value.legal_name) && isNullableString(value.display_name) && isString(value.jurisdiction) && isNullableString(value.website) && isNullableString(value.logo_url);
+function isIssuerSummary(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(isString(v.id), `${path}.id`, "string", v.id);
+  ctx.check(
+    isString(v.legal_name),
+    `${path}.legal_name`,
+    "string",
+    v.legal_name
+  );
+  ctx.check(
+    isNullableString(v.display_name),
+    `${path}.display_name`,
+    "string | null",
+    v.display_name
+  );
+  ctx.check(
+    isString(v.jurisdiction),
+    `${path}.jurisdiction`,
+    "string",
+    v.jurisdiction
+  );
+  ctx.check(
+    isNullableString(v.website),
+    `${path}.website`,
+    "string | null",
+    v.website
+  );
+  ctx.check(
+    isNullableString(v.logo_url),
+    `${path}.logo_url`,
+    "string | null",
+    v.logo_url
+  );
+  return true;
 }
-function isNativeCurrency(value) {
-  return isRecord(value) && isString(value.symbol) && isString(value.name) && isFiniteNumber(value.decimals);
+function isNativeCurrency(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(isString(v.symbol), `${path}.symbol`, "string", v.symbol);
+  ctx.check(isString(v.name), `${path}.name`, "string", v.name);
+  ctx.check(
+    isFiniteNumber(v.decimals),
+    `${path}.decimals`,
+    "finite number",
+    v.decimals
+  );
+  return true;
 }
-function isNetworkDetails(value) {
-  return isRecord(value) && isString(value.network_id) && isString(value.name) && isString(value.family) && (isFiniteNumber(value.chain_id) || value.chain_id === null) && isNativeCurrency(value.native_currency) && isString(value.rpc_endpoint) && Array.isArray(value.explorer_urls) && value.explorer_urls.every(isString) && isBoolean(value.can_deploy_cmtat_token) && isBoolean(value.can_deploy_trex_token) && isBoolean(value.is_testnet) && isBoolean(value.is_supported);
+function isNetworkDetails(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(
+    isString(v.network_id),
+    `${path}.network_id`,
+    "string",
+    v.network_id
+  );
+  ctx.check(isString(v.name), `${path}.name`, "string", v.name);
+  ctx.check(isString(v.family), `${path}.family`, "string", v.family);
+  ctx.check(
+    isFiniteNumber(v.chain_id) || v.chain_id === null,
+    `${path}.chain_id`,
+    "number | null",
+    v.chain_id
+  );
+  isNativeCurrency(v.native_currency, ctx, `${path}.native_currency`);
+  ctx.check(
+    isString(v.rpc_endpoint),
+    `${path}.rpc_endpoint`,
+    "string",
+    v.rpc_endpoint
+  );
+  const explorerOk = ctx.check(
+    Array.isArray(v.explorer_urls),
+    `${path}.explorer_urls`,
+    "string[]",
+    v.explorer_urls
+  );
+  if (explorerOk) {
+    v.explorer_urls.forEach(
+      (url, i) => ctx.check(
+        isString(url),
+        `${path}.explorer_urls[${i}]`,
+        "string",
+        url
+      )
+    );
+  }
+  ctx.check(
+    isBoolean(v.is_testnet),
+    `${path}.is_testnet`,
+    "boolean",
+    v.is_testnet
+  );
+  return true;
 }
-function isFundConfig(value) {
-  return isRecord(value) && isString(value.nav_staleness_threshold) && isString(value.min_subscription) && isString(value.min_redemption) && isString(value.entry_fee_bps) && isString(value.exit_fee_bps) && isFiniteNumber(value.dealing_mode) && isString(value.redemption_gate_bps) && isString(value.protocol_subscription_fee_bps) && isString(value.protocol_fee_recipient) && isString(value.management_fee_bps_per_annum);
+function isFundConfig(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(
+    isString(v.nav_staleness_threshold),
+    `${path}.nav_staleness_threshold`,
+    "string",
+    v.nav_staleness_threshold
+  );
+  ctx.check(
+    isString(v.min_subscription),
+    `${path}.min_subscription`,
+    "string",
+    v.min_subscription
+  );
+  ctx.check(
+    isString(v.min_redemption),
+    `${path}.min_redemption`,
+    "string",
+    v.min_redemption
+  );
+  ctx.check(
+    isString(v.entry_fee_bps),
+    `${path}.entry_fee_bps`,
+    "string",
+    v.entry_fee_bps
+  );
+  ctx.check(
+    isString(v.exit_fee_bps),
+    `${path}.exit_fee_bps`,
+    "string",
+    v.exit_fee_bps
+  );
+  ctx.check(
+    isFiniteNumber(v.dealing_mode),
+    `${path}.dealing_mode`,
+    "finite number",
+    v.dealing_mode
+  );
+  ctx.check(
+    isString(v.redemption_gate_bps),
+    `${path}.redemption_gate_bps`,
+    "string",
+    v.redemption_gate_bps
+  );
+  ctx.check(
+    isString(v.management_fee_bps_per_annum),
+    `${path}.management_fee_bps_per_annum`,
+    "string",
+    v.management_fee_bps_per_annum
+  );
+  return true;
 }
 var ISSUANCE_STATUSES = /* @__PURE__ */ new Set([
   "OPEN",
@@ -228,30 +440,248 @@ var ISSUANCE_STATUSES = /* @__PURE__ */ new Set([
   "SETTLED",
   "CANCELLED"
 ]);
-function isIssuanceStatus(value) {
-  return isString(value) && ISSUANCE_STATUSES.has(value);
+function isIssuanceStatus(value, ctx, path) {
+  return ctx.check(
+    isString(value) && ISSUANCE_STATUSES.has(value),
+    path,
+    `one of ${[...ISSUANCE_STATUSES].join(", ")}`,
+    value
+  );
 }
-function isBookSummary(value) {
-  return isRecord(value) && (isString(value.id) || value.id === null) && isString(value.organization_id) && isNullableString(value.name) && isNullableString(value.book_type) && isString(value.token_address) && isString(value.fund_token) && isString(value.network_id) && isString(value.settlement_token) && isNullableString(value.factory_address) && isNullableString(value.deployment_txn_hash) && isString(value.order_book_address) && isString(value.fund_address) && isString(value.fund_id) && isString(value.initial_nav) && isFundConfig(value.fund_config) && isIssuanceStatus(value.status) && isNullableString(value.created_at) && isNullableString(value.updated_at);
+function isBookSummary(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(
+    isString(v.id) || v.id === null,
+    `${path}.id`,
+    "string | null",
+    v.id
+  );
+  ctx.check(
+    isString(v.organization_id),
+    `${path}.organization_id`,
+    "string",
+    v.organization_id
+  );
+  ctx.check(
+    isNullableString(v.name),
+    `${path}.name`,
+    "string | null",
+    v.name
+  );
+  ctx.check(
+    isNullableString(v.book_type),
+    `${path}.book_type`,
+    "string | null",
+    v.book_type
+  );
+  ctx.check(
+    isString(v.token_address),
+    `${path}.token_address`,
+    "string",
+    v.token_address
+  );
+  ctx.check(
+    isString(v.network_id),
+    `${path}.network_id`,
+    "string",
+    v.network_id
+  );
+  ctx.check(
+    isString(v.settlement_token),
+    `${path}.settlement_token`,
+    "string",
+    v.settlement_token
+  );
+  ctx.check(
+    isString(v.order_book_address),
+    `${path}.order_book_address`,
+    "string",
+    v.order_book_address
+  );
+  ctx.check(
+    isString(v.fund_address),
+    `${path}.fund_address`,
+    "string",
+    v.fund_address
+  );
+  ctx.check(
+    isString(v.fund_id),
+    `${path}.fund_id`,
+    "string",
+    v.fund_id
+  );
+  ctx.check(
+    isString(v.initial_nav),
+    `${path}.initial_nav`,
+    "string",
+    v.initial_nav
+  );
+  isFundConfig(v.fund_config, ctx, `${path}.fund_config`);
+  isIssuanceStatus(v.status, ctx, `${path}.status`);
+  ctx.check(
+    isNullableString(v.created_at),
+    `${path}.created_at`,
+    "string | null",
+    v.created_at
+  );
+  return true;
 }
-function isAssetRecord(value) {
-  return isRecord(value) && isSecurityDetails(value.security) && isIssuerSummary(value.issuer) && Array.isArray(value.books) && value.books.every(isBookSummary) && isNetworkDetails(value.network);
+function isSecurityDetails(value, ctx, path) {
+  const v = asRecord(value);
+  if (!ctx.check(v !== void 0, path, "object", value)) return false;
+  ctx.check(
+    isString(v.token_address),
+    `${path}.token_address`,
+    "string",
+    v.token_address
+  );
+  ctx.check(
+    isString(v.token_name),
+    `${path}.token_name`,
+    "string",
+    v.token_name
+  );
+  ctx.check(
+    isString(v.token_symbol),
+    `${path}.token_symbol`,
+    "string",
+    v.token_symbol
+  );
+  ctx.check(
+    isString(v.token_decimal),
+    `${path}.token_decimal`,
+    "string",
+    v.token_decimal
+  );
+  ctx.check(
+    isString(v.network_id),
+    `${path}.network_id`,
+    "string",
+    v.network_id
+  );
+  ctx.check(
+    isString(v.token_type),
+    `${path}.token_type`,
+    "string",
+    v.token_type
+  );
+  ctx.check(isString(v.admin), `${path}.admin`, "string", v.admin);
+  ctx.check(
+    isNullableString(v.icon_url),
+    `${path}.icon_url`,
+    "string | null",
+    v.icon_url
+  );
+  ctx.check(
+    isNullableString(v.created_at),
+    `${path}.created_at`,
+    "string | null",
+    v.created_at
+  );
+  if (v.prospectus !== null && v.prospectus !== void 0) {
+    isProspectus(v.prospectus, ctx, `${path}.prospectus`);
+  }
+  if (v.issuer !== null && v.issuer !== void 0) {
+    isIssuerSummary(v.issuer, ctx, `${path}.issuer`);
+  }
+  if (v.book !== null && v.book !== void 0) {
+    isBookSummary(v.book, ctx, `${path}.book`);
+  }
+  if (v.partners !== null && v.partners !== void 0) {
+    const partnersOk = ctx.check(
+      Array.isArray(v.partners),
+      `${path}.partners`,
+      "array",
+      v.partners
+    );
+    if (partnersOk) {
+      v.partners.forEach(
+        (partner, i) => isTokenPartner(partner, ctx, `${path}.partners[${i}]`)
+      );
+    }
+  }
+  if (v.rule_engine !== null && v.rule_engine !== void 0) {
+    isRuleEngineSummary(v.rule_engine, ctx, `${path}.rule_engine`);
+  }
+  isNetworkDetails(v.network, ctx, `${path}.network`);
+  if (v.trex_claim_topics !== null && v.trex_claim_topics !== void 0) {
+    const topicsOk = ctx.check(
+      Array.isArray(v.trex_claim_topics),
+      `${path}.trex_claim_topics`,
+      "number[]",
+      v.trex_claim_topics
+    );
+    if (topicsOk) {
+      v.trex_claim_topics.forEach(
+        (topic, i) => ctx.check(
+          isFiniteNumber(topic),
+          `${path}.trex_claim_topics[${i}]`,
+          "finite number",
+          topic
+        )
+      );
+    }
+  }
+  if (v.trex_issuers !== null && v.trex_issuers !== void 0) {
+    const issuersOk = ctx.check(
+      Array.isArray(v.trex_issuers),
+      `${path}.trex_issuers`,
+      "string[]",
+      v.trex_issuers
+    );
+    if (issuersOk) {
+      v.trex_issuers.forEach(
+        (issuer, i) => ctx.check(
+          isString(issuer),
+          `${path}.trex_issuers[${i}]`,
+          "string",
+          issuer
+        )
+      );
+    }
+  }
+  return true;
+}
+function buildValidationError(value, failures) {
+  const summary = failures.slice(0, 5).map(
+    (f) => `${f.path}: expected ${f.expected}, got ${JSON.stringify(f.received)}`
+  ).join("; ");
+  const message = failures.length > 5 ? `Received an invalid SDK response shape (${failures.length} issues). First 5: ${summary}` : `Received an invalid SDK response shape. ${summary}`;
+  return new MalformedResponseError(message, {
+    details: { failures: failures.slice(0, 20), value }
+  });
 }
 function validateSdkAssetsResponse(value) {
-  if (!isRecord(value) || !Array.isArray(value.data) || !isFiniteNumber(value.count) || !value.data.every(isAssetRecord)) {
-    throw new MalformedResponseError(
-      "Received an invalid SDK assets response shape.",
-      { details: value }
+  const ctx = new ValidationContext();
+  ctx.check(isRecord(value), "<root>", "object", value);
+  if (isRecord(value)) {
+    ctx.check(Array.isArray(value.data), "<root>.data", "array", value.data);
+    ctx.check(
+      isFiniteNumber(value.count),
+      "<root>.count",
+      "finite number",
+      value.count
     );
+    if (Array.isArray(value.data)) {
+      value.data.forEach(
+        (item, i) => isSecurityDetails(item, ctx, `<root>.data[${i}]`)
+      );
+    }
+  }
+  if (ctx.failures.length > 0) {
+    throw buildValidationError(value, ctx.failures);
   }
   return value;
 }
 function validateSdkAssetResponse(value) {
-  if (!isRecord(value) || !isAssetRecord(value.data)) {
-    throw new MalformedResponseError(
-      "Received an invalid SDK asset response shape.",
-      { details: value }
-    );
+  const ctx = new ValidationContext();
+  ctx.check(isRecord(value), "<root>", "object", value);
+  if (isRecord(value)) {
+    isSecurityDetails(value.data, ctx, "<root>.data");
+  }
+  if (ctx.failures.length > 0) {
+    throw buildValidationError(value, ctx.failures);
   }
   return value;
 }
@@ -291,10 +721,13 @@ function createClient(config) {
 }
 export {
   ENVIRONMENT_BASE_URLS,
+  ForbiddenError,
   HttpError,
   InvalidConfigurationError,
   MalformedResponseError,
+  NetworkError,
   NotFoundError,
+  RateLimitError,
   SereelSdkError,
   ServerError,
   TimeoutError,