@rundit-sdk/embed 0.0.1

package/AGENTS.md

@@ -0,0 +1,68 @@
+# AI Guide for @rundit-sdk/embed
+
+This package is generated for agentic and human consumers.
+
+
+
+## Initialization
+
+```ts
+import { createEmbedClient, routeManifest } from '@rundit-sdk/embed'
+
+const client = createEmbedClient({
+  baseUrl: 'https://test.rundit.com/api/v1/sdk',
+  token: '<embed token>',
+})
+
+console.log(routeManifest)
+```
+
+## Guidance
+
+- Prefer namespace methods on the client instead of constructing URLs manually
+- Use `routeManifest` or `ai-manifest.json` to discover available calls programmatically
+- Pass required path ids as strings or numbers
+- Positions endpoints require a `currency` query value
+- Response ids are strings; preserve them as returned when passing them between calls
+
+## companies
+
+- companies.getOne: Get one company available to the SDK consumer
+  - Call: `client.companies.getOne('123')`
+  - Returns: `CompaniesGetOneResponse`
+  - Params: path: id (string)
+- companies.getAll: List companies available to the SDK consumer
+  - Call: `client.companies.getAll()`
+  - Returns: `CompaniesGetAllResponse`
+
+## companyGroups
+
+- companyGroups.getAll: List company groups available to the SDK consumer
+  - Call: `client.companyGroups.getAll()`
+  - Returns: `CompanyGroupsGetAllResponse`
+- companyGroups.getOne: Get one company group available to the SDK consumer
+  - Call: `client.companyGroups.getOne('123')`
+  - Returns: `CompanyGroupsGetOneResponse`
+  - Params: path: id (string)
+
+## positions
+
+- positions.getCompanyPositions: Get positions for one company
+  - Call: `client.positions.getCompanyPositions('123', { currency: 'USD' })`
+  - Returns: `PositionsGetCompanyPositionsResponse`
+  - Params: path: id (string); query: companyGroupId? (number), currency (string), date? (string)
+- positions.getPortfolioPositions: Get portfolio positions
+  - Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
+  - Returns: `PositionsGetPortfolioPositionsResponse`
+  - Params: query: companyGroupIds? (number[]), currency (string), date? (string)
+
+## transactions
+
+- transactions.getCompanyTransactions: Get transactions for one company
+  - Call: `client.transactions.getCompanyTransactions('123', { companyGroupIds: [123] })`
+  - Returns: `TransactionsGetCompanyTransactionsResponse`
+  - Params: path: id (string); query: companyGroupIds? (number[])
+- transactions.getTransactions: Get transactions for multiple companies
+  - Call: `client.transactions.getTransactions({ companyGroupIds: [123] })`
+  - Returns: `TransactionsGetTransactionsResponse`
+  - Params: query: companyGroupIds? (number[]), companyIds? (number[])

package/README.md

@@ -0,0 +1,123 @@
+# @rundit-sdk/embed
+
+Public Rundit embed SDK for iframe and embedded module consumers.
+
+
+
+## Install
+
+```bash
+npm install @rundit-sdk/embed
+```
+
+## Usage
+
+```ts
+import { createEmbedClient } from '@rundit-sdk/embed'
+
+const client = createEmbedClient({
+  baseUrl: 'https://test.rundit.com/api/v1/sdk',
+  token: '<embed token>',
+})
+
+await client.companies.getOne('123')
+```
+
+## AI Quickstart
+
+- Use namespace methods such as `client.companies.getAll()` or `client.positions.getPortfolioPositions({ currency: 'USD' })`
+- Inspect `routeManifest` at runtime for a machine-readable map of method paths, parameters, and response types
+- Read `AGENTS.md` or `ai-manifest.json` in this package for AI-focused usage guidance
+- Response DTO identifiers are returned as strings even when the underlying backend ids are numeric
+
+
+## Methods
+
+## companies
+
+### `companies.getOne`
+
+Get one company available to the SDK consumer
+
+- Call: `client.companies.getOne('123')`
+- HTTP: `GET /companies/:id`
+- Returns: `CompaniesGetOneResponse`
+- Params: path: id (string)
+
+### `companies.getAll`
+
+List companies available to the SDK consumer
+
+- Call: `client.companies.getAll()`
+- HTTP: `GET /companies`
+- Returns: `CompaniesGetAllResponse`
+
+## companyGroups
+
+### `companyGroups.getAll`
+
+List company groups available to the SDK consumer
+
+- Call: `client.companyGroups.getAll()`
+- HTTP: `GET /company-groups`
+- Returns: `CompanyGroupsGetAllResponse`
+
+### `companyGroups.getOne`
+
+Get one company group available to the SDK consumer
+
+- Call: `client.companyGroups.getOne('123')`
+- HTTP: `GET /company-groups/:id`
+- Returns: `CompanyGroupsGetOneResponse`
+- Params: path: id (string)
+
+## positions
+
+### `positions.getCompanyPositions`
+
+Get positions for one company
+
+- Call: `client.positions.getCompanyPositions('123', { currency: 'USD' })`
+- HTTP: `GET /positions/companies/:id`
+- Returns: `PositionsGetCompanyPositionsResponse`
+- Params: path: id (string); query: companyGroupId? (number), currency (string), date? (string)
+
+### `positions.getPortfolioPositions`
+
+Get portfolio positions
+
+- Call: `client.positions.getPortfolioPositions({ currency: 'USD' })`
+- HTTP: `GET /positions/portfolio`
+- Returns: `PositionsGetPortfolioPositionsResponse`
+- Params: query: companyGroupIds? (number[]), currency (string), date? (string)
+
+## transactions
+
+### `transactions.getCompanyTransactions`
+
+Get transactions for one company
+
+- Call: `client.transactions.getCompanyTransactions('123', { companyGroupIds: [123] })`
+- HTTP: `GET /transactions/companies/:id`
+- Returns: `TransactionsGetCompanyTransactionsResponse`
+- Params: path: id (string); query: companyGroupIds? (number[])
+
+### `transactions.getTransactions`
+
+Get transactions for multiple companies
+
+- Call: `client.transactions.getTransactions({ companyGroupIds: [123] })`
+- HTTP: `GET /transactions`
+- Returns: `TransactionsGetTransactionsResponse`
+- Params: query: companyGroupIds? (number[]), companyIds? (number[])
+
+## TypeScript
+
+- This package ships generated `.d.ts` files
+- Public DTOs, response aliases, and query parameter types are generated from `sdk-packages/openapi/sdk.openapi.json`
+- Generated methods and query types include JSDoc summaries for editor and agent consumption
+
+## Notes
+
+- This package is generated from `sdk-packages/openapi/sdk.openapi.json`
+- Do not edit files under `dist/` manually

package/ai-manifest.json

@@ -0,0 +1,200 @@
+{
+  "packageName": "@rundit-sdk/embed",
+  "description": "Public Rundit embed SDK for iframe and embedded module consumers.",
+  "maturity": "active",
+  "placeholderNotice": null,
+  "factoryName": "createEmbedClient",
+  "initialization": {
+    "baseUrl": "https://test.rundit.com/api/v1/sdk",
+    "authOption": "token",
+    "authLabel": "embed token"
+  },
+  "guidance": {
+    "responseIdsAreStrings": true,
+    "runtimeManifestExport": "routeManifest",
+    "notes": [
+      "Use namespace methods instead of manual fetch calls",
+      "Positions endpoints require currency"
+    ]
+  },
+  "namespaces": {
+    "companies": [
+      {
+        "operation": "getOne",
+        "summary": "Get one company available to the SDK consumer",
+        "description": null,
+        "method": "GET",
+        "path": "/companies/:id",
+        "exampleCall": "client.companies.getOne('123')",
+        "responseType": "CompaniesGetOneResponse",
+        "pathParams": [
+          {
+            "name": "id",
+            "type": "string",
+            "description": "Company identifier"
+          }
+        ],
+        "queryParams": []
+      },
+      {
+        "operation": "getAll",
+        "summary": "List companies available to the SDK consumer",
+        "description": null,
+        "method": "GET",
+        "path": "/companies",
+        "exampleCall": "client.companies.getAll()",
+        "responseType": "CompaniesGetAllResponse",
+        "pathParams": [],
+        "queryParams": []
+      }
+    ],
+    "companyGroups": [
+      {
+        "operation": "getAll",
+        "summary": "List company groups available to the SDK consumer",
+        "description": null,
+        "method": "GET",
+        "path": "/company-groups",
+        "exampleCall": "client.companyGroups.getAll()",
+        "responseType": "CompanyGroupsGetAllResponse",
+        "pathParams": [],
+        "queryParams": []
+      },
+      {
+        "operation": "getOne",
+        "summary": "Get one company group available to the SDK consumer",
+        "description": null,
+        "method": "GET",
+        "path": "/company-groups/:id",
+        "exampleCall": "client.companyGroups.getOne('123')",
+        "responseType": "CompanyGroupsGetOneResponse",
+        "pathParams": [
+          {
+            "name": "id",
+            "type": "string",
+            "description": "Company group identifier"
+          }
+        ],
+        "queryParams": []
+      }
+    ],
+    "positions": [
+      {
+        "operation": "getCompanyPositions",
+        "summary": "Get positions for one company",
+        "description": null,
+        "method": "GET",
+        "path": "/positions/companies/:id",
+        "exampleCall": "client.positions.getCompanyPositions('123', { currency: 'USD' })",
+        "responseType": "PositionsGetCompanyPositionsResponse",
+        "pathParams": [
+          {
+            "name": "id",
+            "type": "string",
+            "description": "Company identifier"
+          }
+        ],
+        "queryParams": [
+          {
+            "name": "companyGroupId",
+            "required": false,
+            "type": "number",
+            "description": "Optional company group identifier to filter by"
+          },
+          {
+            "name": "currency",
+            "required": true,
+            "type": "string",
+            "description": "Reporting currency code"
+          },
+          {
+            "name": "date",
+            "required": false,
+            "type": "string",
+            "description": "Optional summary date in ISO format"
+          }
+        ]
+      },
+      {
+        "operation": "getPortfolioPositions",
+        "summary": "Get portfolio positions",
+        "description": null,
+        "method": "GET",
+        "path": "/positions/portfolio",
+        "exampleCall": "client.positions.getPortfolioPositions({ currency: 'USD' })",
+        "responseType": "PositionsGetPortfolioPositionsResponse",
+        "pathParams": [],
+        "queryParams": [
+          {
+            "name": "companyGroupIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Optional list of company group identifiers to filter the portfolio positions"
+          },
+          {
+            "name": "currency",
+            "required": true,
+            "type": "string",
+            "description": "Reporting currency code"
+          },
+          {
+            "name": "date",
+            "required": false,
+            "type": "string",
+            "description": "Optional summary date in ISO format"
+          }
+        ]
+      }
+    ],
+    "transactions": [
+      {
+        "operation": "getCompanyTransactions",
+        "summary": "Get transactions for one company",
+        "description": null,
+        "method": "GET",
+        "path": "/transactions/companies/:id",
+        "exampleCall": "client.transactions.getCompanyTransactions('123', { companyGroupIds: [123] })",
+        "responseType": "TransactionsGetCompanyTransactionsResponse",
+        "pathParams": [
+          {
+            "name": "id",
+            "type": "string",
+            "description": "Company identifier"
+          }
+        ],
+        "queryParams": [
+          {
+            "name": "companyGroupIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Optional company group identifiers to filter transactions by"
+          }
+        ]
+      },
+      {
+        "operation": "getTransactions",
+        "summary": "Get transactions for multiple companies",
+        "description": null,
+        "method": "GET",
+        "path": "/transactions",
+        "exampleCall": "client.transactions.getTransactions({ companyGroupIds: [123] })",
+        "responseType": "TransactionsGetTransactionsResponse",
+        "pathParams": [],
+        "queryParams": [
+          {
+            "name": "companyGroupIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Optional company group identifiers to filter transactions by"
+          },
+          {
+            "name": "companyIds",
+            "required": false,
+            "type": "number[]",
+            "description": "Optional company identifiers to filter transactions by"
+          }
+        ]
+      }
+    ]
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,234 @@
+export type PathParam = string | number
+
+export interface RequestOptions {
+  signal?: AbortSignal
+}
+
+export interface RunditSdkErrorDetails {
+  status: number
+  body: unknown
+}
+
+export declare class RunditSdkError extends Error {
+  status: number
+  body: unknown
+  constructor(message: string, details: RunditSdkErrorDetails)
+}
+
+export interface CreateEmbedClientOptions {
+  baseUrl: string
+  token: string
+  fetch?: typeof fetch
+  headers?: Record<string, string>
+}
+
+export interface SdkCompanyDto {
+  id: string
+  name: string
+  type?: string
+  legalName?: string
+  status?: string
+  websiteUrl?: string
+  companyGroupIds?: string[]
+}
+
+export interface SdkCompanyGroupDto {
+  id: string
+  name: string
+  currency?: string
+  companyIds?: string[]
+  companies?: SdkCompanyDto[]
+}
+
+export interface SdkCompanyReferenceDto {
+  id: string
+  name: string
+  type?: string
+}
+
+export interface SdkCompanyGroupReferenceDto {
+  id: string
+  name: string
+}
+
+export interface SdkPositionDto {
+  id: string
+  companyId: string
+  companyGroupId?: string
+  company?: SdkCompanyReferenceDto
+  companyGroup?: SdkCompanyGroupReferenceDto
+  units: number
+  fairValue?: number
+  ownership?: number
+  invested?: number
+  realized?: number
+  multiple?: number
+  investmentStatus?: string
+  currency: string
+  date: string
+}
+
+export interface SdkTransactionDto {
+  id: string
+  companyId: string
+  companyGroupId?: string
+  company?: SdkCompanyReferenceDto
+  companyGroup?: SdkCompanyGroupReferenceDto
+  type: string
+  name?: string
+  date: string
+  amount?: number
+  fairValue?: number
+  currency?: string
+  children?: SdkTransactionDto[]
+}
+
+export type CompaniesGetOneResponse = SdkCompanyDto
+
+export type CompaniesGetAllResponse = SdkCompanyDto[]
+
+export type CompanyGroupsGetAllResponse = SdkCompanyGroupDto[]
+
+export type CompanyGroupsGetOneResponse = SdkCompanyGroupDto
+
+export type PositionsGetCompanyPositionsResponse = SdkPositionDto[]
+
+export type PositionsGetPortfolioPositionsResponse = SdkPositionDto[]
+
+export type TransactionsGetCompanyTransactionsResponse = SdkTransactionDto[]
+
+export type TransactionsGetTransactionsResponse = SdkTransactionDto[]
+
+export interface PositionsGetCompanyPositionsQuery {
+  /**
+   * Optional company group identifier to filter by
+   */
+  companyGroupId?: number
+  /**
+   * Reporting currency code
+   */
+  currency: string
+  /**
+   * Optional summary date in ISO format
+   */
+  date?: string
+}
+
+export interface PositionsGetPortfolioPositionsQuery {
+  /**
+   * Optional list of company group identifiers to filter the portfolio positions
+   */
+  companyGroupIds?: number[]
+  /**
+   * Reporting currency code
+   */
+  currency: string
+  /**
+   * Optional summary date in ISO format
+   */
+  date?: string
+}
+
+export interface TransactionsGetCompanyTransactionsQuery {
+  /**
+   * Optional company group identifiers to filter transactions by
+   */
+  companyGroupIds?: number[]
+}
+
+export interface TransactionsGetTransactionsQuery {
+  /**
+   * Optional company group identifiers to filter transactions by
+   */
+  companyGroupIds?: number[]
+  /**
+   * Optional company identifiers to filter transactions by
+   */
+  companyIds?: number[]
+}
+
+export interface CompaniesNamespace {
+  /**
+   * Get one company available to the SDK consumer
+   * Parameters: path: id (string)
+   * Returns: CompaniesGetOneResponse
+   */
+  getOne(id: string, init?: RequestOptions): Promise<CompaniesGetOneResponse>
+  /**
+   * List companies available to the SDK consumer
+   * Returns: CompaniesGetAllResponse
+   */
+  getAll(init?: RequestOptions): Promise<CompaniesGetAllResponse>
+}
+
+export interface CompanyGroupsNamespace {
+  /**
+   * List company groups available to the SDK consumer
+   * Returns: CompanyGroupsGetAllResponse
+   */
+  getAll(init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
+  /**
+   * Get one company group available to the SDK consumer
+   * Parameters: path: id (string)
+   * Returns: CompanyGroupsGetOneResponse
+   */
+  getOne(id: string, init?: RequestOptions): Promise<CompanyGroupsGetOneResponse>
+}
+
+export interface PositionsNamespace {
+  /**
+   * Get positions for one company
+   * Parameters: path: id (string); query: companyGroupId? (number), currency (string), date? (string)
+   * Returns: PositionsGetCompanyPositionsResponse
+   */
+  getCompanyPositions(id: string, query?: PositionsGetCompanyPositionsQuery, init?: RequestOptions): Promise<PositionsGetCompanyPositionsResponse>
+  /**
+   * Get portfolio positions
+   * Parameters: query: companyGroupIds? (number[]), currency (string), date? (string)
+   * Returns: PositionsGetPortfolioPositionsResponse
+   */
+  getPortfolioPositions(query?: PositionsGetPortfolioPositionsQuery, init?: RequestOptions): Promise<PositionsGetPortfolioPositionsResponse>
+}
+
+export interface TransactionsNamespace {
+  /**
+   * Get transactions for one company
+   * Parameters: path: id (string); query: companyGroupIds? (number[])
+   * Returns: TransactionsGetCompanyTransactionsResponse
+   */
+  getCompanyTransactions(id: string, query?: TransactionsGetCompanyTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetCompanyTransactionsResponse>
+  /**
+   * Get transactions for multiple companies
+   * Parameters: query: companyGroupIds? (number[]), companyIds? (number[])
+   * Returns: TransactionsGetTransactionsResponse
+   */
+  getTransactions(query?: TransactionsGetTransactionsQuery, init?: RequestOptions): Promise<TransactionsGetTransactionsResponse>
+}
+
+export interface EmbedClient {
+  companies: CompaniesNamespace
+  companyGroups: CompanyGroupsNamespace
+  positions: PositionsNamespace
+  transactions: TransactionsNamespace
+}
+
+export declare function createEmbedClient(options: CreateEmbedClientOptions): EmbedClient
+
+export declare const routeManifest: {
+  companies: {
+    getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; description: null; exampleCall: "client.companies.getOne('123')"; responseType: "CompaniesGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+    getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; description: null; exampleCall: "client.companies.getAll()"; responseType: "CompaniesGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+  }
+  companyGroups: {
+    getAll: { method: "GET"; path: "/company-groups"; summary: "List company groups available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getAll()"; responseType: "CompanyGroupsGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+    getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one company group available to the SDK consumer"; description: null; exampleCall: "client.companyGroups.getOne('123')"; responseType: "CompanyGroupsGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+  }
+  positions: {
+    getCompanyPositions: { method: "GET"; path: "/positions/companies/:id"; summary: "Get positions for one company"; description: null; exampleCall: "client.positions.getCompanyPositions('123', { currency: 'USD' })"; responseType: "PositionsGetCompanyPositionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+    getPortfolioPositions: { method: "GET"; path: "/positions/portfolio"; summary: "Get portfolio positions"; description: null; exampleCall: "client.positions.getPortfolioPositions({ currency: 'USD' })"; responseType: "PositionsGetPortfolioPositionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+  }
+  transactions: {
+    getCompanyTransactions: { method: "GET"; path: "/transactions/companies/:id"; summary: "Get transactions for one company"; description: null; exampleCall: "client.transactions.getCompanyTransactions('123', { companyGroupIds: [123] })"; responseType: "TransactionsGetCompanyTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+    getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; description: null; exampleCall: "client.transactions.getTransactions({ companyGroupIds: [123] })"; responseType: "TransactionsGetTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
+  }
+}