@mashkovd/pelican-vue 0.2.0

package/README.md

@@ -0,0 +1,100 @@
+# @mashkovd/pelican-vue
+
+Vue 3 component for browsing Libertex Social copy-trading strategies via a
+[`pelican-libertex-social`](../README.md) proxy. Drop it into any Vue 3 app
+that can reach a running proxy (the proxy handles OIDC token refresh and
+upstream rate-limiting; this component only consumes its REST surface).
+
+A live proxy is hosted at `https://labs-pelican-proxy.mctl.ai` — point
+`api-base` at it to skip running your own.
+
+## Install
+
+```sh
+npm install @mashkovd/pelican-vue
+```
+
+`vue@^3.4` is a peer dependency — make sure it's already in your host app.
+
+## Use
+
+```vue
+<script setup lang="ts">
+import { PelicanLibertexSocial } from '@mashkovd/pelican-vue';
+import '@mashkovd/pelican-vue/style.css';
+</script>
+
+<template>
+  <PelicanLibertexSocial api-base="https://labs-pelican-proxy.mctl.ai" />
+</template>
+```
+
+That's it. The component handles everything else — fetching the catalog,
+filters, sort, lazy enrichment, trade panels, theme toggle.
+
+### CORS / dev-server proxy
+
+If your host app and the Pelican proxy live on different origins, the
+browser will block the cross-origin fetch unless the proxy explicitly
+allows your origin (it does not, by default).
+
+The cleanest workaround is to proxy `/api` through your own dev/prod
+server:
+
+```ts
+// vite.config.ts
+export default defineConfig({
+  server: {
+    proxy: {
+      '/api': 'https://labs-pelican-proxy.mctl.ai',
+    },
+  },
+});
+```
+
+…and pass an empty `api-base` so the component issues relative requests:
+
+```vue
+<PelicanLibertexSocial api-base="" />
+```
+
+For Nuxt, declare a `routeRules` proxy. For Quasar, set `devServer.proxy`
+in `quasar.config.js`.
+
+## Props
+
+| prop             | type                              | default          | notes                                    |
+| ---------------- | --------------------------------- | ---------------- | ---------------------------------------- |
+| `apiBase`        | `string` (required)               | —                | Base URL of the pelican proxy            |
+| `theme`          | `'auto' \| 'dark' \| 'light'`     | `'auto'`         | Persists in `localStorage['pelican-theme']` |
+| `defaultSort`    | `SortKey`                         | `'return-desc'`  | One of 20 sort modes                     |
+| `defaultFilters` | `Partial<FiltersState>`           | `{}`             | Initial filter values                    |
+| `locale`         | `string`                          | `'en-US'`        | Used for number/date formatting          |
+| `pageSize`       | `number`                          | `20`             | Rows per page                            |
+
+## Emits
+
+| event              | payload                                                                | when                              |
+| ------------------ | ---------------------------------------------------------------------- | --------------------------------- |
+| `update:theme`     | `'auto' \| 'dark' \| 'light'`                                          | User cycled the theme toggle      |
+| `select-strategy`  | `Strategy`                                                             | A row was expanded                |
+| `error`            | `{ code: 'no_token' \| 'fetch_failed' \| 'http_error' \| string, message }` | Network / proxy error             |
+
+## Slots
+
+- `#brand` — replace the default header/brand block.
+- `#empty` — replace the empty-state copy when filters match nothing.
+- `#row-actions` — append controls to each row (`{ strategy }` slot scope).
+
+## Dev
+
+```sh
+cd vue
+npm install
+npm run dev      # Vite playground at :5173, proxies /api → :8787
+npm run build    # produces dist/ (ESM + UMD + style.css + .d.ts)
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,162 @@
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { DefineComponent } from 'vue';
+import { PublicProps } from 'vue';
+
+declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+error: (err: PelicanError) => any;
+"update:theme": (m: ThemeMode) => any;
+"select-strategy": (s: Strategy) => any;
+}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
+onError?: ((err: PelicanError) => any) | undefined;
+"onUpdate:theme"?: ((m: ThemeMode) => any) | undefined;
+"onSelect-strategy"?: ((s: Strategy) => any) | undefined;
+}>, {
+locale: string;
+theme: ThemeMode;
+defaultSort: SortKey;
+pageSize: number;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
+
+declare type __VLS_Props = {
+    apiBase: string;
+    theme?: ThemeMode;
+    defaultSort?: SortKey;
+    defaultFilters?: Partial<FiltersState>;
+    columns?: ColumnKey[];
+    locale?: string;
+    pageSize?: number;
+};
+
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        brand?(_: {}): any;
+        empty?(_: {}): any;
+        'row-actions'?(_: {
+            strategy: Strategy;
+        }): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+
+declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+export declare type ColumnKey = 'name' | 'spark' | 'return' | 'copiers' | 'aum' | 'dd' | 'age' | 'balance' | 'fee' | 'link';
+
+export declare function defaultFilters(): FiltersState;
+
+export declare interface FiltersState {
+    risk: Set<RiskLevel>;
+    retMin: number | null;
+    retMax: number | null;
+    ddMax: number | null;
+    aumMin: number | null;
+    copiersMin: number | null;
+    ageMin: number | null;
+    tradesMin: number | null;
+    winrateMin: number | null;
+    feeMax: number | null;
+    balanceMin: number | null;
+    balanceMax: number | null;
+    search: string;
+}
+
+export declare interface HistoryPoint {
+    Timestamp: string;
+    AccountReturn: number;
+}
+
+export declare interface MarketSlice {
+    n: string;
+    c: number;
+}
+
+export declare interface PelicanError extends Error {
+    code: 'no_token' | 'fetch_failed' | 'http_error';
+    status?: number;
+}
+
+export declare const PelicanLibertexSocial: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+
+export declare interface ProgressResponse {
+    ready: boolean;
+    building: boolean;
+    loaded: number;
+    total: number;
+    built_at: number | null;
+    schedule?: string;
+}
+
+export declare type RiskLevel = 'Low' | 'Medium' | 'High' | 'Unsuitable';
+
+export declare type SignalKind = 'open' | 'closed';
+
+export declare const SORT_KEYS: readonly ["return-desc", "return-asc", "copiers-desc", "copiers-asc", "aum-desc", "aum-asc", "dd-asc", "dd-desc", "fee-asc", "fee-desc", "age-desc", "age-asc", "balance-desc", "balance-asc", "winrate-desc", "winrate-asc", "trades-desc", "trades-asc", "monthly-desc", "monthly-asc"];
+
+export declare const SORT_LABELS: Record<SortKey, string>;
+
+export declare const SORT_TOGGLE: Record<SortColumn, [SortKey, SortKey]>;
+
+export declare type SortColumn = 'return' | 'copiers' | 'aum' | 'dd' | 'fee' | 'age' | 'balance';
+
+export declare type SortKey = (typeof SORT_KEYS)[number];
+
+export declare interface Strategy {
+    Id: number;
+    Name: string | null;
+    ImageUploaded?: boolean | null;
+    Profile: StrategyProfile | null;
+    NumCopiers: number | null;
+    Fee: number | null;
+    RiskProfile: RiskLevel | null;
+    IsSimulated: boolean;
+    IsEnabled: boolean | null;
+    Inception: string | null;
+    Currency: string | null;
+    Return: number | null;
+    MaxDD: number | null;
+    RealisedPnl: number | null;
+    UnrealisedPnl: number | null;
+    History: HistoryPoint[];
+    TradesTotal: number;
+    Wins: number;
+    Losses: number;
+    Markets: MarketSlice[];
+    AccountBalance: number | null;
+    CopiersAUM: number | null;
+    MonthlyProfit: number | null;
+    YearlyProfit: number | null;
+    _stats?: boolean;
+    _meta?: boolean;
+    _enrichAttempted?: boolean;
+}
+
+declare interface StrategyProfile {
+    Id?: number | string;
+    Name?: string | null;
+}
+
+export declare type ThemeMode = 'auto' | 'dark' | 'light';
+
+export declare interface Trade {
+    Id?: number;
+    MarketName?: string;
+    OpenTimestamp?: string;
+    CloseTimestamp?: string | null;
+    Direction?: 'Buy' | 'Sell' | string;
+    Pnl?: number;
+    Volume?: number;
+    Multiplier?: number;
+    OpenPrice?: number;
+    ClosePrice?: number;
+}
+
+export { }