@flexemarkets/fm-sdk 0.0.0

package/dist/types.d.ts

@@ -0,0 +1,128 @@
+/** Flexemarkets domain models. */
+export interface Person {
+    id: number;
+    accountId: number;
+    firstName: string | null;
+    lastName: string | null;
+    email: string | null;
+    roles: string[];
+    accountOwner: boolean;
+    createdDate: string | null;
+    lastModifiedDate: string | null;
+}
+export interface Account {
+    id: number | null;
+    name: string | null;
+    description: string | null;
+    owner: Person | null;
+    approval: boolean;
+    approvalDescription: string | null;
+    createdDate: string | null;
+    lastModifiedDate: string | null;
+}
+export interface Token {
+    requestUrl: string | null;
+    person: Person | null;
+    account: Account | null;
+    token: string | null;
+}
+export interface Security {
+    marketId: number;
+    units: number;
+    availableUnits: number;
+    canBuy: boolean;
+    canSell: boolean;
+}
+export interface Holding {
+    marketplaceId: number;
+    sessionId: number;
+    allocationId: number;
+    ownerId: number;
+    name: string | null;
+    cash: number;
+    availableCash: number;
+    securities: Security[];
+}
+export declare function getSecurity(holding: Holding, marketId: number): Security;
+export declare function holdingUnits(holding: Holding): number[];
+export interface Market {
+    id: number;
+    marketplaceId: number;
+    name: string | null;
+    description: string | null;
+    symbol: string | null;
+    privateMarket: boolean;
+    priceMinimum: number;
+    priceMaximum: number;
+    priceTick: number;
+    unitMinimum: number;
+    unitMaximum: number;
+    unitTick: number;
+}
+export declare function priceRound(market: Market, price: number): number;
+export interface Marketplace {
+    id: number;
+    name: string | null;
+    description: string | null;
+    markets: Market[];
+}
+export declare const SESSION_STATE_INIT = "INIT";
+export declare const SESSION_STATE_OPEN = "OPEN";
+export declare const SESSION_STATE_PAUSED = "PAUSED";
+export declare const SESSION_STATE_CLOSED = "CLOSED";
+export interface Session {
+    marketplaceId: number;
+    allocationId: number;
+    id: number;
+    original: number;
+    state: string | null;
+    name: string | null;
+    description: string | null;
+    openDate: string | null;
+    closeDate: string | null;
+}
+export declare const ORDER_TYPE_LIMIT = "LIMIT";
+export declare const ORDER_TYPE_CANCEL = "CANCEL";
+export declare const ORDER_SIDE_BUY = "BUY";
+export declare const ORDER_SIDE_SELL = "SELL";
+export interface Order {
+    id: number;
+    original: number;
+    supplier: number;
+    consumer: number | null;
+    type: string | null;
+    side: string | null;
+    units: number;
+    price: number;
+    ownerId: number | null;
+    marketplaceId: number;
+    sessionId: number;
+    symbol: string | null;
+    marketId: number;
+    ownerTarget: string | null;
+    clientDescription: string | null;
+    createdDate: string | null;
+    lastModifiedDate: string | null;
+}
+export interface ClientConnection {
+    marketplaceId: number;
+    connectionId: number;
+    ownerId: number;
+    established: string | null;
+    terminated: string | null;
+    description: string | null;
+}
+export interface Version {
+    version: number;
+}
+export interface ApiRoot {
+    links: Record<string, string>;
+}
+export declare function getLink(root: ApiRoot, name: string): string | undefined;
+export interface ConflictFailure {
+    status: string | null;
+    error: string | null;
+    message: string | null;
+    path: string | null;
+    suggestedName: string | null;
+}

package/dist/types.js

@@ -0,0 +1,27 @@
+/** Flexemarkets domain models. */
+export function getSecurity(holding, marketId) {
+    const s = holding.securities.find((s) => s.marketId === marketId);
+    if (!s)
+        throw new Error(`Security for market ID ${marketId} not found.`);
+    return s;
+}
+export function holdingUnits(holding) {
+    return [...holding.securities]
+        .sort((a, b) => a.marketId - b.marketId)
+        .map((s) => s.units);
+}
+export function priceRound(market, price) {
+    return Math.min(Math.max(price - (price % market.priceTick), market.priceMinimum), market.priceMaximum);
+}
+export const SESSION_STATE_INIT = "INIT";
+export const SESSION_STATE_OPEN = "OPEN";
+export const SESSION_STATE_PAUSED = "PAUSED";
+export const SESSION_STATE_CLOSED = "CLOSED";
+export const ORDER_TYPE_LIMIT = "LIMIT";
+export const ORDER_TYPE_CANCEL = "CANCEL";
+export const ORDER_SIDE_BUY = "BUY";
+export const ORDER_SIDE_SELL = "SELL";
+export function getLink(root, name) {
+    return root.links[name];
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAmDlC,MAAM,UAAU,WAAW,CAAC,OAAgB,EAAE,QAAgB;IAC5D,MAAM,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;IAClE,IAAI,CAAC,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,aAAa,CAAC,CAAC;IACzE,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAgB;IAC3C,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;SAC3B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;SACvC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACzB,CAAC;AAiBD,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,KAAa;IACtD,OAAO,IAAI,CAAC,GAAG,CACb,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC,EACjE,MAAM,CAAC,YAAY,CACpB,CAAC;AACJ,CAAC;AASD,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAC7C,MAAM,CAAC,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AAc7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACxC,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAC1C,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,CAAC;AACpC,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AAuCtC,MAAM,UAAU,OAAO,CAAC,IAAa,EAAE,IAAY;IACjD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@flexemarkets/fm-sdk",
+  "version": "0.0.0",
+  "description": "Flexemarkets TypeScript SDK",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "ticker": "tsx src/ticker.ts",
+    "build": "tsc",
+    "check": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "flexemarkets",
+    "trading",
+    "api",
+    "sdk",
+    "websocket"
+  ],
+  "author": "Flexemarkets <support@flexemarkets.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flexemarkets/fm-sdk.git",
+    "directory": "sdks/typescript"
+  },
+  "bugs": {
+    "url": "https://github.com/flexemarkets/fm-sdk/issues"
+  },
+  "homepage": "https://github.com/flexemarkets/fm-sdk#readme",
+  "dependencies": {
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.13",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0"
+  }
+}