@mashkovd/pelican-vue 0.2.0 → 0.3.1

package/README.md

@@ -65,13 +65,27 @@ in `quasar.config.js`.
 
 | prop             | type                              | default          | notes                                    |
 | ---------------- | --------------------------------- | ---------------- | ---------------------------------------- |
-| `apiBase`        | `string` (required)               | —                | Base URL of the pelican proxy            |
+| `apiBase`        | `string` (required)               | —                | Base URL of the pelican proxy. Used for live per-strategy data (`/api/strategies/{id}`, `/stats`, `/signals/*`) and — unless `catalogBase` is set — for the catalog as well. |
+| `catalogBase`    | `string`                          | `apiBase`        | Optional separate origin for the static catalog (`/api/strategies-full` and `/progress`). Point at a Cloudflare Worker fronting the R2 bucket to serve the catalog from the edge. When set, the component skips the partial-load polling loop and fetches the catalog in a single request. |
 | `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                            |
 
+### Two-origin example (proxy + edge)
+
+```vue
+<PelicanLibertexSocial
+  api-base="https://labs-pelican-proxy.mctl.ai"
+  catalog-base="https://pelican-catalog-worker.example.workers.dev"
+/>
+```
+
+The 5 MB catalog comes from the Worker (edge-cached, no auth, fast).
+Per-strategy live calls — `/api/strategies/{id}`, stats, signals — still go
+through the pelican-proxy, which holds the OIDC token.
+
 ## Emits
 
 | event              | payload                                                                | when                              |

package/dist/index.d.ts

@@ -20,6 +20,14 @@ pageSize: number;
 
 declare type __VLS_Props = {
     apiBase: string;
+    /**
+     * Optional separate origin for the *static* catalog endpoints
+     * (`/api/strategies-full` and `/api/strategies-full/progress`). When set,
+     * the catalog is fetched from this URL — typically a Cloudflare Worker
+     * fronting an R2 bucket — while live per-strategy data continues to go
+     * through `apiBase`.
+     */
+    catalogBase?: string;
     theme?: ThemeMode;
     defaultSort?: SortKey;
     defaultFilters?: Partial<FiltersState>;