@rundit-sdk/client 0.2.0 → 0.3.0-rc.13

package/dist/index.js

@@ -21,10 +21,35 @@ const routeManifest = {
       "path": "/companies",
       "summary": "List companies available to the SDK consumer",
       "description": null,
-      "exampleCall": "client.companies.getAll()",
+      "exampleCall": "client.companies.getAll({ limit: 123 })",
       "responseType": "CompaniesGetAllResponse",
       "pathParams": [],
-      "queryParams": []
+      "queryParams": [
+        {
+          "name": "limit",
+          "required": false,
+          "type": "number",
+          "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+        },
+        {
+          "name": "cursor",
+          "required": false,
+          "type": "string",
+          "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+        },
+        {
+          "name": "companyIds",
+          "required": false,
+          "type": "number[]",
+          "description": "Restrict results to these company identifiers"
+        },
+        {
+          "name": "companyGroupIds",
+          "required": false,
+          "type": "number[]",
+          "description": "Restrict results to companies that belong to any of these company groups"
+        }
+      ]
     }
   },
   "companyGroups": {
@@ -33,10 +58,29 @@ const routeManifest = {
       "path": "/company-groups",
       "summary": "List company groups available to the SDK consumer",
       "description": null,
-      "exampleCall": "client.companyGroups.getAll()",
+      "exampleCall": "client.companyGroups.getAll({ limit: 123 })",
       "responseType": "CompanyGroupsGetAllResponse",
       "pathParams": [],
-      "queryParams": []
+      "queryParams": [
+        {
+          "name": "limit",
+          "required": false,
+          "type": "number",
+          "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+        },
+        {
+          "name": "cursor",
+          "required": false,
+          "type": "string",
+          "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+        },
+        {
+          "name": "companyGroupIds",
+          "required": false,
+          "type": "number[]",
+          "description": "Restrict results to these company group identifiers"
+        }
+      ]
     },
     "getOne": {
       "method": "GET",
@@ -72,10 +116,22 @@ const routeManifest = {
       ],
       "queryParams": [
         {
-          "name": "companyGroupId",
+          "name": "limit",
           "required": false,
           "type": "number",
-          "description": "Optional company group identifier to filter by"
+          "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+        },
+        {
+          "name": "cursor",
+          "required": false,
+          "type": "string",
+          "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+        },
+        {
+          "name": "companyGroupIds",
+          "required": false,
+          "type": "number[]",
+          "description": "Optional list of company group identifiers to filter the position breakdown"
         },
         {
           "name": "currency",
@@ -106,6 +162,12 @@ const routeManifest = {
           "type": "number[]",
           "description": "Optional list of company group identifiers to filter the portfolio positions"
         },
+        {
+          "name": "companyIds",
+          "required": false,
+          "type": "number[]",
+          "description": "Optional list of company identifiers to narrow the aggregation to"
+        },
         {
           "name": "currency",
           "required": true,
@@ -127,7 +189,7 @@ const routeManifest = {
       "path": "/transactions/companies/:id",
       "summary": "Get transactions for one company",
       "description": null,
-      "exampleCall": "client.transactions.getCompanyTransactions(123, { companyGroupIds: [123] })",
+      "exampleCall": "client.transactions.getCompanyTransactions(123, { limit: 123 })",
       "responseType": "TransactionsGetCompanyTransactionsResponse",
       "pathParams": [
         {
@@ -137,11 +199,35 @@ const routeManifest = {
         }
       ],
       "queryParams": [
+        {
+          "name": "limit",
+          "required": false,
+          "type": "number",
+          "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+        },
+        {
+          "name": "cursor",
+          "required": false,
+          "type": "string",
+          "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+        },
         {
           "name": "companyGroupIds",
           "required": false,
           "type": "number[]",
           "description": "Optional company group identifiers to filter transactions by"
+        },
+        {
+          "name": "types",
+          "required": false,
+          "type": "(\"Auction\" | \"ConvertibleNote\" | \"ConvertToEquity\" | \"Dividend\" | \"EquityInvestment\" | \"EquityReceived\" | \"Extend\" | \"FutureEquityAgreement\" | \"Insolvency\" | \"IPO\" | \"LimitedAuction\" | \"OptionsReceived\" | \"OtherExit\" | \"OtherInvestment\" | \"OtherRealization\" | \"Payback\" | \"Proprietary\" | \"TradeSale\" | \"ValuationChange\" | \"WriteOff\")[]",
+          "description": "Restrict results to these transaction types"
+        },
+        {
+          "name": "priorTo",
+          "required": false,
+          "type": "string",
+          "description": "Exclude transactions on or after this ISO 8601 date (cut-off filter)"
         }
       ]
     },
@@ -150,16 +236,40 @@ const routeManifest = {
       "path": "/transactions",
       "summary": "Get transactions for multiple companies",
       "description": null,
-      "exampleCall": "client.transactions.getTransactions({ companyGroupIds: [123] })",
+      "exampleCall": "client.transactions.getTransactions({ limit: 123 })",
       "responseType": "TransactionsGetTransactionsResponse",
       "pathParams": [],
       "queryParams": [
+        {
+          "name": "limit",
+          "required": false,
+          "type": "number",
+          "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+        },
+        {
+          "name": "cursor",
+          "required": false,
+          "type": "string",
+          "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+        },
         {
           "name": "companyGroupIds",
           "required": false,
           "type": "number[]",
           "description": "Optional company group identifiers to filter transactions by"
         },
+        {
+          "name": "types",
+          "required": false,
+          "type": "(\"Auction\" | \"ConvertibleNote\" | \"ConvertToEquity\" | \"Dividend\" | \"EquityInvestment\" | \"EquityReceived\" | \"Extend\" | \"FutureEquityAgreement\" | \"Insolvency\" | \"IPO\" | \"LimitedAuction\" | \"OptionsReceived\" | \"OtherExit\" | \"OtherInvestment\" | \"OtherRealization\" | \"Payback\" | \"Proprietary\" | \"TradeSale\" | \"ValuationChange\" | \"WriteOff\")[]",
+          "description": "Restrict results to these transaction types"
+        },
+        {
+          "name": "priorTo",
+          "required": false,
+          "type": "string",
+          "description": "Exclude transactions on or after this ISO 8601 date (cut-off filter)"
+        },
         {
           "name": "companyIds",
           "required": false,
@@ -168,8 +278,102 @@ const routeManifest = {
         }
       ]
     }
+  },
+  "metrics": {
+    "getTypes": {
+      "method": "GET",
+      "path": "/metrics/types",
+      "summary": "List metric types available to the SDK consumer",
+      "description": "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry includes a numeric id and a human-readable name suitable for display or LLM context.",
+      "exampleCall": "client.metrics.getTypes()",
+      "responseType": "MetricsGetTypesResponse",
+      "pathParams": [],
+      "queryParams": []
+    },
+    "search": {
+      "method": "POST",
+      "path": "/metrics",
+      "summary": "Read metric values for accessible companies, grouped by company",
+      "description": "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Filter by company, company group, metric type, timeframe, and date range to narrow the response.",
+      "exampleCall": "client.metrics.search({})",
+      "responseType": "MetricsSearchResponse",
+      "pathParams": [],
+      "queryParams": []
+    }
+  },
+  "companyReports": {
+    "list": {
+      "method": "GET",
+      "path": "/company-reports",
+      "summary": "List published company reports accessible to the caller (metadata only)",
+      "description": "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids and reporting period (timeframe + date range).",
+      "exampleCall": "client.companyReports.list({ limit: 123 })",
+      "responseType": "CompanyReportsListResponse",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "limit",
+          "required": false,
+          "type": "number",
+          "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
+        },
+        {
+          "name": "cursor",
+          "required": false,
+          "type": "string",
+          "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
+        },
+        {
+          "name": "companyIds",
+          "required": false,
+          "type": "number[]",
+          "description": "Restrict results to these companies. Defaults to all companies the caller can access."
+        },
+        {
+          "name": "companyGroupIds",
+          "required": false,
+          "type": "number[]",
+          "description": "Restrict to companies that belong to any of these company groups."
+        },
+        {
+          "name": "timeframe",
+          "required": false,
+          "type": "\"Month\" | \"Quarter\" | \"Year\"",
+          "description": "Restrict to a reporting period granularity (Month, Quarter, Year)."
+        },
+        {
+          "name": "from",
+          "required": false,
+          "type": "string",
+          "description": "Lower bound for the reporting period date (ISO 8601, inclusive)."
+        },
+        {
+          "name": "to",
+          "required": false,
+          "type": "string",
+          "description": "Upper bound for the reporting period date (ISO 8601, inclusive)."
+        }
+      ]
+    },
+    "getOne": {
+      "method": "GET",
+      "path": "/company-reports/:id",
+      "summary": "Fetch the full content of a single company report",
+      "description": "Returns the report metadata plus structured sections (text/markdown/image) and attachments with pre-signed URLs. Returns 404 if the report does not exist and 403 if the caller cannot access it under their role-based permissions.",
+      "exampleCall": "client.companyReports.getOne(123)",
+      "responseType": "CompanyReportsGetOneResponse",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "number",
+          "description": "Report identifier"
+        }
+      ],
+      "queryParams": []
+    }
   }
 }
+const defaultBaseUrl = "https://api.rundit.com/api/v2/sdk"
 
 export class RunditSdkError extends Error {
   constructor(message, details) {
@@ -257,7 +461,7 @@ async function parseResponse(response) {
 
 function createRequester(options) {
   const fetchImplementation = resolveFetch(options.fetch)
-  const baseUrl = normalizeBaseUrl(options.baseUrl)
+  const baseUrl = normalizeBaseUrl(options.baseUrl || defaultBaseUrl)
   const shouldBypassNgrokBrowserWarning = shouldSendNgrokBypassHeader(baseUrl)
   const defaultHeaders = {
     Accept: 'application/json',
@@ -266,58 +470,76 @@ function createRequester(options) {
     "X-API-Key": options.apiKey,
   }
 
-  return async ({ method, path, pathParams, query, signal }) => {
+  return async ({ method, path, pathParams, query, body, signal }) => {
     const url = appendQueryString(baseUrl + interpolatePath(path, pathParams), query)
+    const hasBody = body !== undefined && body !== null
+    const requestHeaders = hasBody ? { ...defaultHeaders, 'Content-Type': 'application/json' } : defaultHeaders
+
     const response = await fetchImplementation(url, {
       method,
-      headers: defaultHeaders,
+      headers: requestHeaders,
+      body: hasBody ? JSON.stringify(body) : undefined,
       signal,
     })
 
-    const body = await parseResponse(response)
+    const responseBody = await parseResponse(response)
 
     if (!response.ok) {
       throw new RunditSdkError(`Rundit request failed with status ${response.status}`, {
         status: response.status,
-        body,
+        body: responseBody,
       })
     }
 
-    return body
+    return responseBody
   }
 }
 
 function createCompaniesNamespace(request) {
   return {
-    getOne: (id, init = {}) => request({ method: "GET", path: "/companies/:id", pathParams: { id }, query: undefined, signal: init.signal }),
-    getAll: (init = {}) => request({ method: "GET", path: "/companies", pathParams: undefined, query: undefined, signal: init.signal }),
+    getOne: (id, init = {}) => request({ method: "GET", path: "/companies/:id", pathParams: { id }, query: undefined, body: undefined, signal: init.signal }),
+    getAll: (query = {}, init = {}) => request({ method: "GET", path: "/companies", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
   }
 }
 
 function createCompanyGroupsNamespace(request) {
   return {
-    getAll: (init = {}) => request({ method: "GET", path: "/company-groups", pathParams: undefined, query: undefined, signal: init.signal }),
-    getOne: (id, init = {}) => request({ method: "GET", path: "/company-groups/:id", pathParams: { id }, query: undefined, signal: init.signal }),
+    getAll: (query = {}, init = {}) => request({ method: "GET", path: "/company-groups", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
+    getOne: (id, init = {}) => request({ method: "GET", path: "/company-groups/:id", pathParams: { id }, query: undefined, body: undefined, signal: init.signal }),
   }
 }
 
 function createPositionsNamespace(request) {
   return {
-    getCompanyPositions: (id, query = {}, init = {}) => request({ method: "GET", path: "/positions/companies/:id", pathParams: { id }, query: query, signal: init.signal }),
-    getPortfolioPositions: (query = {}, init = {}) => request({ method: "GET", path: "/positions/portfolio", pathParams: undefined, query: query, signal: init.signal }),
+    getCompanyPositions: (id, query = {}, init = {}) => request({ method: "GET", path: "/positions/companies/:id", pathParams: { id }, query: query, body: undefined, signal: init.signal }),
+    getPortfolioPositions: (query = {}, init = {}) => request({ method: "GET", path: "/positions/portfolio", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
   }
 }
 
 function createTransactionsNamespace(request) {
   return {
-    getCompanyTransactions: (id, query = {}, init = {}) => request({ method: "GET", path: "/transactions/companies/:id", pathParams: { id }, query: query, signal: init.signal }),
-    getTransactions: (query = {}, init = {}) => request({ method: "GET", path: "/transactions", pathParams: undefined, query: query, signal: init.signal }),
+    getCompanyTransactions: (id, query = {}, init = {}) => request({ method: "GET", path: "/transactions/companies/:id", pathParams: { id }, query: query, body: undefined, signal: init.signal }),
+    getTransactions: (query = {}, init = {}) => request({ method: "GET", path: "/transactions", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
+  }
+}
+
+function createMetricsNamespace(request) {
+  return {
+    getTypes: (init = {}) => request({ method: "GET", path: "/metrics/types", pathParams: undefined, query: undefined, body: undefined, signal: init.signal }),
+    search: (body, init = {}) => request({ method: "POST", path: "/metrics", pathParams: undefined, query: undefined, body: body, signal: init.signal }),
+  }
+}
+
+function createCompanyReportsNamespace(request) {
+  return {
+    list: (query = {}, init = {}) => request({ method: "GET", path: "/company-reports", pathParams: undefined, query: query, body: undefined, signal: init.signal }),
+    getOne: (id, init = {}) => request({ method: "GET", path: "/company-reports/:id", pathParams: { id }, query: undefined, body: undefined, signal: init.signal }),
   }
 }
 
 export function createClient(options) {
-  if (!options || typeof options.baseUrl !== 'string' || options.baseUrl.length === 0) {
-    throw new Error('options.baseUrl is required')
+  if (!options || typeof options !== 'object') {
+    throw new Error('options is required')
   }
 
   if (!options.apiKey) {
@@ -331,6 +553,8 @@ export function createClient(options) {
     companyGroups: createCompanyGroupsNamespace(request),
     positions: createPositionsNamespace(request),
     transactions: createTransactionsNamespace(request),
+    metrics: createMetricsNamespace(request),
+    companyReports: createCompanyReportsNamespace(request),
   }
 }