@everysk/apps-sdk 0.1.0-beta.0

package/src/theme/index.ts

@@ -0,0 +1,15 @@
+// The MUI theme shared by every Everysk app. Re-exported from the package root — not its own
+// subpath, since its dependencies are required peers that npm installs with the SDK anyway.
+//
+// It carries no Tailwind and no AG Grid import: the grid theme lives behind
+// `@everysk/apps-sdk/ag-grid`, with the rest of the optional grid layer, so nothing here makes
+// the package depend on AG Grid.
+
+export { ThemeProvider } from "./ThemeProvider";
+export { getTheme, getBrandTheme, getDefaultTheme } from "./themes";
+export { EveryskLightTheme } from "./themes/EveryskLight";
+export { EveryskDarkTheme } from "./themes/EveryskDark";
+export { DefaultLightTheme } from "./themes/DefaultLight";
+export { DefaultDarkTheme } from "./themes/DefaultDark";
+export { MidnightEmberTheme } from "./themes/MidnightEmber";
+export { components } from "./overrides";

package/src/theme/overrides/index.ts

@@ -0,0 +1,31 @@
+import type { Components, Theme } from "@mui/material/styles";
+
+import type { } from '@mui/x-date-pickers/themeAugmentation';
+
+import { MuiCssBaseline } from "./muiCssBaseline";
+import { MuiDatePicker } from "./muiDatePicker";
+import { MuiTextField } from "./muiTextField";
+import { MuiFormControl } from "./muiFormControl";
+import { MuiSelect } from "./muiSelect";
+import { MuiSvgIcon } from "./muiSvgIcon";
+import { MuiToggleButton } from "./muiToggleButton";
+import { MuiToggleButtonGroup } from "./muiToggleButtonGroup";
+import { MuiIconButton } from "./muiIconButton";
+import { MuiButton } from "./muiButton";
+
+/**
+ * Shared MUI component overrides applied by every theme (light, dark and branded).
+ * They read `theme.palette.mode`, so the same set works for any palette.
+ */
+export const components: Components<Omit<Theme, "components">> = {
+    MuiCssBaseline,
+    MuiDatePicker,
+    MuiTextField,
+    MuiSelect,
+    MuiFormControl,
+    MuiSvgIcon,
+    MuiToggleButton,
+    MuiToggleButtonGroup,
+    MuiButton,
+    MuiIconButton,
+};

package/src/theme/overrides/muiButton.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from '@mui/material/styles';
+
+export const MuiButton: Components<Theme>['MuiButton'] = {
+    defaultProps: {
+        size: 'small',
+    },
+};

package/src/theme/overrides/muiCssBaseline.ts

@@ -0,0 +1,35 @@
+import * as colors from "@mui/material/colors";
+import type { Theme } from "@mui/material/styles";
+
+export const MuiCssBaseline = {
+    styleOverrides: (theme: Theme) => ({
+        "*::-webkit-scrollbar": {
+            width: 8,
+            height: 8,
+        },
+        "*::-webkit-scrollbar-thumb": {
+            borderRadius: 10,
+            backgroundColor: '#959595'
+
+        },
+        "*::-webkit-scrollbar-thumb:hover ": {
+            backgroundColor: '#959595'
+        },
+        "*:hover::-webkit-scrollbar-thumb": {
+            backgroundColor: '#959595'
+        },
+
+        "*::-webkit-scrollbar-thumb:active": {
+            backgroundColor: theme.palette.primary.main
+        },
+
+        "*::-moz-selection": {
+            color: (theme.palette.mode === "dark" ? colors.common.black : colors.common.white),
+            backgroundColor: theme.palette.primary.main
+        },
+        "*::selection": {
+            color: (theme.palette.mode === "dark") ? colors.common.black : colors.common.white,
+            backgroundColor: theme.palette.primary.main
+        }
+    })
+}

package/src/theme/overrides/muiDatePicker.ts

@@ -0,0 +1,5 @@
+export const MuiDatePicker = {
+    defaultProps: {
+        slotProps: { textField: { size: 'small' as const } },
+    },
+};

package/src/theme/overrides/muiFormControl.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from "@mui/material/styles";
+
+export const MuiFormControl: Components<Theme>["MuiFormControl"] = {
+    defaultProps: {
+        size: 'small',
+    },
+};

package/src/theme/overrides/muiIconButton.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from '@mui/material/styles';
+
+export const MuiIconButton: Components<Theme>['MuiIconButton'] = {
+    defaultProps: {
+        size: 'small',
+    },
+};

package/src/theme/overrides/muiSelect.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from "@mui/material/styles";
+
+export const MuiSelect: Components<Theme>["MuiSelect"] = {
+    defaultProps: {
+        size: 'small',
+    },
+}

package/src/theme/overrides/muiSvgIcon.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from "@mui/material/styles";
+
+export const MuiSvgIcon: Components<Theme>["MuiSvgIcon"] = {
+    defaultProps: {
+        fontSize: 'small',
+    },
+}

package/src/theme/overrides/muiTextField.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from "@mui/material/styles";
+
+export const MuiTextField: Components<Theme>["MuiTextField"] = {
+    defaultProps: {
+        size: "small",
+    },
+};

package/src/theme/overrides/muiToggleButton.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from '@mui/material/styles';
+
+export const MuiToggleButton: Components<Theme>['MuiToggleButton'] = {
+    defaultProps: {
+        size: 'small',
+    },
+};

package/src/theme/overrides/muiToggleButtonGroup.ts

@@ -0,0 +1,7 @@
+import type { Components, Theme } from '@mui/material/styles';
+
+export const MuiToggleButtonGroup: Components<Theme>['MuiToggleButtonGroup'] = {
+    defaultProps: {
+        size: 'small',
+    },
+};

package/src/theme/themes/DefaultDark.ts

@@ -0,0 +1,14 @@
+import { createTheme, type Theme } from "@mui/material/styles";
+
+import { components } from "@/theme/overrides";
+
+/**
+ * Neutral dark theme. Uses MUI's default palette (no brand color) plus the
+ * shared component overrides — a clean starting point each app can customize.
+ */
+export const DefaultDarkTheme: Theme = createTheme({
+    palette: {
+        mode: "dark",
+    },
+    components,
+});

package/src/theme/themes/DefaultLight.ts

@@ -0,0 +1,14 @@
+import { createTheme, type Theme } from "@mui/material/styles";
+
+import { components } from "@/theme/overrides";
+
+/**
+ * Neutral light theme. Uses MUI's default palette (no brand color) plus the
+ * shared component overrides — a clean starting point each app can customize.
+ */
+export const DefaultLightTheme: Theme = createTheme({
+    palette: {
+        mode: "light",
+    },
+    components,
+});

package/src/theme/themes/EveryskDark.ts

@@ -0,0 +1,62 @@
+import { createTheme, type Theme } from "@mui/material/styles";
+
+import { components } from "@/theme/overrides";
+
+/**
+ * Everysk Dark — the theme every Everysk app runs with.
+ *
+ * Apps are embedded in the Everysk platform, which is dark, so this is the palette the brand
+ * orange is tuned for: `#FF9933` reaches ~8:1 on `background.paper`, which is what lets it be
+ * `primary.main` here. MUI paints text, borders and focus rings with `primary.main`, not only
+ * fills, so a colour only survives that role if it is readable as text — the reason
+ * `EveryskLight` cannot use the same orange.
+ *
+ * Status colours are the lighter variants a dark surface needs, and every one of them carries
+ * the near-black `contrastText`, so a filled chip reads as dark text on colour.
+ */
+export const EveryskDarkTheme: Theme = createTheme({
+    palette: {
+        mode: "dark",
+        primary: {
+            main: "#FF9933",
+            light: "#FFB866",
+            dark: "#EA580C",
+            contrastText: "#0B1120",
+        },
+        secondary: {
+            main: "#94A3B8",
+            light: "#CBD5E1",
+            dark: "#64748B",
+            contrastText: "#0B1120",
+        },
+        success: {
+            main: "#4ADE80",
+            contrastText: "#0B1120",
+        },
+        warning: {
+            main: "#FBBF24",
+            contrastText: "#0B1120",
+        },
+        error: {
+            main: "#F87171",
+            contrastText: "#0B1120",
+        },
+        info: {
+            main: "#38BDF8",
+            contrastText: "#0B1120",
+        },
+        background: {
+            default: "#0B1120",
+            paper: "#131C2E",
+        },
+        text: {
+            primary: "#F8FAFC",
+            secondary: "#94A3B8",
+        },
+        divider: "rgba(148, 163, 184, 0.24)",
+    },
+    shape: {
+        borderRadius: 8,
+    },
+    components,
+});

package/src/theme/themes/EveryskLight.ts

@@ -0,0 +1,68 @@
+import { createTheme, type Theme } from "@mui/material/styles";
+
+import { components } from "@/theme/overrides";
+
+/**
+ * Everysk Light — the light twin of {@link EveryskDarkTheme}.
+ *
+ * Nothing ships with it today (apps are pinned to dark, matching the platform), but it is kept
+ * in sync so a light surface is one call away, and because it is where the one non-obvious rule
+ * in the brand palette lives:
+ *
+ * **The brand orange cannot be `primary.main` on a light surface.** `#FF9933` reaches only ~2:1
+ * on white — far below the 4.5:1 a label needs — and MUI uses `primary.main` for text, borders
+ * and focus rings, not only fills. So the roles split: `main` is the deeper `#C2410C` (~5.2:1 on
+ * white, AA for labels, headings and focus rings) and the brand orange moves to `light`, where
+ * it is only ever a fill.
+ *
+ * Status colours follow the same reasoning and switch to their darker variants.
+ *
+ * Rule for anything added later: a colour added to one brand theme is added to both, with its
+ * contrast checked against that theme's own `background.paper`.
+ */
+export const EveryskLightTheme: Theme = createTheme({
+    palette: {
+        mode: "light",
+        primary: {
+            main: "#C2410C",
+            light: "#FF9933",
+            dark: "#9A3412",
+            contrastText: "#FFFFFF",
+        },
+        secondary: {
+            main: "#475569",
+            light: "#64748B",
+            dark: "#334155",
+            contrastText: "#FFFFFF",
+        },
+        success: {
+            main: "#15803D",
+            contrastText: "#FFFFFF",
+        },
+        warning: {
+            main: "#B45309",
+            contrastText: "#FFFFFF",
+        },
+        error: {
+            main: "#B91C1C",
+            contrastText: "#FFFFFF",
+        },
+        info: {
+            main: "#0369A1",
+            contrastText: "#FFFFFF",
+        },
+        background: {
+            default: "#F8FAFC",
+            paper: "#FFFFFF",
+        },
+        text: {
+            primary: "#0F172A",
+            secondary: "#475569",
+        },
+        divider: "rgba(15, 23, 42, 0.12)",
+    },
+    shape: {
+        borderRadius: 8,
+    },
+    components,
+});

package/src/theme/themes/MidnightEmber.ts

@@ -0,0 +1,30 @@
+import { createTheme, type Theme } from "@mui/material/styles";
+
+import { components } from "@/theme/overrides";
+
+export const MidnightEmberTheme: Theme = createTheme({
+    palette: {
+        mode: 'dark',
+        primary: {
+            main: '#F97316',
+            dark: '#EA580C',
+            light: '#FDBA74',
+            contrastText: '#020617',
+        },
+        secondary: {
+            main: '#94A3B8',
+            dark: '#64748B',
+            light: '#CBD5F5',
+            contrastText: '#020617',
+        },
+        background: {
+            default: '#020617',
+            paper: '#0B1120',
+        },
+        text: {
+            primary: '#F9FAFB',
+        },
+        divider: 'rgba(148, 163, 184, 0.25)'
+    },
+    components,
+});

package/src/theme/themes/index.ts

@@ -0,0 +1,35 @@
+import type { PaletteMode, Theme } from "@mui/material/styles";
+
+import { DefaultLightTheme } from "./DefaultLight";
+import { DefaultDarkTheme } from "./DefaultDark";
+import { EveryskLightTheme } from "./EveryskLight";
+import { EveryskDarkTheme } from "./EveryskDark";
+import { MidnightEmberTheme } from "./MidnightEmber";
+
+const themes: Map<string, Theme> = new Map<string, Theme>([
+    ["Everysk Light", EveryskLightTheme],
+    ["Everysk Dark", EveryskDarkTheme],
+    ["Default Light", DefaultLightTheme],
+    ["Default Dark", DefaultDarkTheme],
+    ["Midnight Ember", MidnightEmberTheme],
+]);
+
+/**
+ * Returns a named theme from the catalog, falling back to the default light theme.
+ */
+export const getTheme = (name?: string): Theme => themes.get(name ?? "") ?? DefaultLightTheme;
+
+/**
+ * Returns the branded Everysk theme for the given palette mode.
+ *
+ * This is what `ThemeProvider` mounts — apps run on the brand palette, not the neutral one.
+ */
+export const getBrandTheme = (mode: PaletteMode): Theme =>
+    mode === "dark" ? EveryskDarkTheme : EveryskLightTheme;
+
+/**
+ * Returns the neutral default theme for the given palette mode: MUI's own palette plus the
+ * shared overrides. A starting point for anything that should not carry the brand colour.
+ */
+export const getDefaultTheme = (mode: PaletteMode): Theme =>
+    mode === "dark" ? DefaultDarkTheme : DefaultLightTheme;

package/src/types/anyRecord.ts

@@ -0,0 +1,4 @@
+export type AnyRecord = {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    [key: string]: any
+}

package/src/types/datastore.ts

@@ -0,0 +1,33 @@
+import type { AnyRecord } from "./anyRecord";
+import type { EntitySingleResponse, EntityListResponse, DeleteEntityResponse } from "./entityQuery";
+
+export type DatastoreRow = string | number | null;
+export type DatastoreData = DatastoreRow[][];
+
+export type Datastore = {
+    updated?: number,
+    created?: number,
+
+    id: string,
+    name: string,
+    date?: string,
+    version?: string,
+    description?: string,
+
+    tags?: string[],
+    link_uid?: string,
+    workspace: string,
+    data: DatastoreData,
+    date_time: string,
+    level?: string,
+}
+
+export type DatastoreWithRows = Omit<Datastore, "data"> & {
+    data: AnyRecord[];
+};
+
+export type DatastoreSingleResponse = EntitySingleResponse<"datastore", Datastore>;
+
+export type DatastoreListResponse = EntityListResponse<"datastores", Datastore>;
+
+export type DeleteDatastoreResponse = DeleteEntityResponse<"datastores">;

package/src/types/entityQuery.ts

@@ -0,0 +1,64 @@
+import type { UseQueryOptions } from "@tanstack/react-query";
+import type { AnyRecord } from "./anyRecord";
+
+export type FilterOperator = "=" | ">" | ">=" | "<" | "<=" | "!=";
+
+export type FilterExpression =
+  | [field: string, value: unknown]
+  | [field: string, op: FilterOperator, value: unknown];
+
+export type FilterClause = {
+  field: string;
+  value: unknown;
+  op?: FilterOperator;
+}
+
+export type BaseQueryParams = {
+  order: string[];
+  projection?: string;
+}
+
+export type EntityQueryParams = BaseQueryParams & {
+  filters: FilterClause[];
+  pageSize?: number;
+  pageToken?: string;
+}
+
+export type QueryObject = BaseQueryParams & {
+  filters: FilterExpression[];
+  page_size?: number;
+  page_token?: string;
+};
+
+export type EntityQueryOptions<TQueryFnData, TData = TQueryFnData> = Omit<UseQueryOptions<TQueryFnData, Error, TData>,"queryKey" | "queryFn">;
+
+export type FetchEntityParams<TData = AnyRecord, TSelected = TData> = {
+  id: string;
+  workspace: string;
+  queryOptions?: EntityQueryOptions<TData, TSelected>;
+};
+
+export type FetchEntitiesParams<TData = AnyRecord, QO = EntityQueryOptions<TData>> = {
+    filters?: FilterClause[];
+    order?: string[];
+    projection?: string;
+    queryOptions?: QO;
+};
+
+
+export type EntityDefaultResponse = {
+    next_page_token: string | null;
+}
+
+export type EntitySingleResponse<K extends string, T> = EntityDefaultResponse & Record<K, T>;
+
+export type EntityListResponse<K extends string, T> = EntityDefaultResponse & Record<K, T[]>;
+
+export type DeleteEntityDefaultResponse = {
+  id:string,
+  name:string,
+  deleted:boolean
+}
+
+export type DeleteEntityResponse<K extends string, T = DeleteEntityDefaultResponse> = Record<K, T[]>;
+  

package/src/types/file.ts

@@ -0,0 +1,32 @@
+import type { EntitySingleResponse, EntityListResponse, DeleteEntityResponse } from "./entityQuery";
+
+/**
+ * A file stored in a workspace.
+ *
+ * Named EveryskFile, not File: everything the SDK exports now shares one entry point, and a
+ * type called `File` there would shadow the DOM's `File` for anyone who imported it —
+ * silently, and only where it matters.
+ */
+export type EveryskFile = {
+    id: string;
+    workspace: string;
+    name: string;
+    description?: string;
+    content_type: string;
+    url?: string;
+    hash?: string;
+    date?: string;
+    date_time?: string;
+    created?: number;
+    updated?: number;
+    version: string;
+    link_uid: string | null;
+    data: string | null;
+    tags?: string[];
+}
+
+export type FileSingleResponse = EntitySingleResponse<"file", EveryskFile>;
+
+export type FileListResponse = EntityListResponse<"files", EveryskFile>;
+
+export type DeleteFileResponse = DeleteEntityResponse<"files">;

package/src/types/portfolio.ts

@@ -0,0 +1,81 @@
+import type { DeleteEntityResponse, EntityListResponse, EntitySingleResponse } from "./entityQuery";
+
+export type Security = {
+  instrument_type: string | null;
+  coupon: unknown | null;
+  issue_price: unknown | null;
+  display: string | null;
+  asset_subclass: string | null;
+  market_value: number | null;
+  rate: unknown | null;
+  book: unknown | null;
+  symbol: string | null;
+  percent_index: unknown | null;
+  settlement: unknown | null;
+  issuer_type: unknown | null;
+  label: string | null;
+  accounting: unknown | null;
+  market_price: number | null;
+  hash: string | null;
+  extra_data: unknown | null;
+  multiplier: number | null;
+  option_type: unknown | null;
+  error_type: string | null;
+  exchange: string | null;
+  premium: unknown | null;
+  fx_rate: number | null;
+  ticker: string | null;
+  status: string | null;
+  currency: string | null;
+  operation: unknown | null;
+  comparable: string | null;
+  market_value_in_base: number | null;
+  issuer: unknown | null;
+  unrealized_pl_in_base: number | null;
+  unrealized_pl: number | null;
+  instrument_class: string | null;
+  issue_date: unknown | null;
+  series: unknown | null;
+  quantity: number | null;
+  id: string | null;
+  cost_price: number | null;
+  isin: string | null;
+  strike: unknown | null;
+  asset_class: string | null;
+  look_through_reference: unknown | null;
+  return_date: unknown | null;
+  underlying: unknown | null;
+  maturity_date: unknown | null;
+  previous_quantity: number | null;
+  warranty: unknown | null;
+  name: string | null;
+  error_message: string | null;
+  indexer: unknown | null;
+  trader: unknown | null;
+  trade_id: unknown | null;
+};
+
+export type Portfolio = {
+    id:string;
+    name?:string;
+    description?:string;
+    base_currency:string;
+    securities:Security[];
+    nlv?:number;
+    date:string;
+    date_time?:string;
+    tags?:string[];
+    workspace:string;
+    created?:number;
+    updated?:number;
+    version?:string;
+    link_uid?:string|null;
+    level?:string|null;
+    check_securities?:boolean;
+}
+
+export type PortfolioSingleResponse = EntitySingleResponse<"portfolio", Portfolio>;
+
+export type PortfolioListResponse = EntityListResponse<"portfolios", Portfolio>;
+
+export type DeletePortfolioResponse = DeleteEntityResponse<"portfolios">;

package/src/types/profile.ts

@@ -0,0 +1,39 @@
+/**
+ * Profile — the logged user, as returned by `GET /api/profile`.
+ *
+ * The endpoint resolves the user from the session, so there is no id to ask for: an app always
+ * gets the profile of whoever is using it.
+ */
+export interface Profile {
+    email: string;
+    user_type: string;
+    region: string;
+    company_name: string;
+    first_name: string;
+    last_name: string;
+    phone: string;
+    address: string;
+    billing_email: string;
+    time_zone: string;
+    company_logo: string;
+    user_role: string;
+    skin_theme: string;
+    account_deletion_requested: boolean;
+    // The backend type of these three is not confirmed yet, so they stay permissive: narrow them
+    // here (and in DEV_PROFILE) once the first consumer needs a concrete type.
+    asset: unknown;
+    owner: unknown;
+    auto_refresh: unknown;
+    [key: string]: unknown;
+}
+
+/**
+ * ProfileResponse — the endpoint's envelope.
+ *
+ * It does not follow `EntitySingleResponse`: `/api/profile` is not a queryable entity, so the
+ * payload carries a `status` and no `next_page_token`.
+ */
+export type ProfileResponse = {
+    status: string;
+    profile: Profile;
+};