@adaptabletools/adaptable-cjs 17.0.0-canary.1

package/src/PredefinedConfig/Common/Fdc3Context.d.ts

@@ -0,0 +1,226 @@
+import { Chart, ChatInitSettings, Contact, ContactList, Context, Country, Currency, Email, Instrument, InstrumentList, Nothing, Organization, Portfolio, Position, TimeRange, Valuation, ContextTypes } from '@finos/fdc3';
+/**
+ * FDC3 (2.0) Standard Context Types supported by AdapTable
+ */
+export type Fdc3StandardContextType = ChartContextType | ChatInitSettingsContextType | ContactContextType | ContactListContextType | CountryContextType | CurrencyContextType | EmailContextType | InstrumentContextType | InstrumentListContextType | OrganizationContextType | PortfolioContextType | PositionContextType | TimeRangeContextType | ValuationContextType | NothingContextType;
+/**
+ * Type for FDC3 Custom Context
+ */
+export type Fdc3CustomContextType = string;
+/**
+ * Type for FDC3 Contexts (can be Standard or Custom)
+ */
+export type Fdc3ContextType = Fdc3StandardContextType | Fdc3CustomContextType;
+export declare const ChartContextKey = "fdc3.chart";
+/**
+ * Type for FDC3 Chart Context
+ */
+export type ChartContextType = typeof ChartContextKey;
+export declare const ChatInitSettingsContextKey = "fdc3.chat.initSettings";
+/**
+ * Type for FDC3 Chart Init Settings Context
+ */
+export type ChatInitSettingsContextType = typeof ChatInitSettingsContextKey;
+export declare const ContactContextKey = "fdc3.contact";
+/**
+ * Type for FDC3 Contact Context
+ */
+export type ContactContextType = typeof ContactContextKey;
+export declare const ContactListContextKey = "fdc3.contactList";
+/**
+ * Type for FDC3 Contact List Context
+ */
+export type ContactListContextType = typeof ContactListContextKey;
+export declare const CountryContextKey = "fdc3.country";
+/**
+ * Type for FDC3 Country Context
+ */
+export type CountryContextType = typeof CountryContextKey;
+export declare const CurrencyContextKey = "fdc3.currency";
+/**
+ * Type for FDC3 Currency Context
+ */
+export type CurrencyContextType = typeof CurrencyContextKey;
+export declare const EmailContextKey = "fdc3.email";
+/**
+ * Type for FDC3 Email Context
+ */
+export type EmailContextType = typeof EmailContextKey;
+export declare const InstrumentContextKey = "fdc3.instrument";
+/**
+ * Type for FDC3 Instrument Context
+ */
+export type InstrumentContextType = typeof InstrumentContextKey;
+export declare const InstrumentListContextKey = "fdc3.instrumentList";
+/**
+ * Type for FDC3 Instrument List Context
+ */
+export type InstrumentListContextType = typeof InstrumentListContextKey;
+export declare const OrganizationContextKey = "fdc3.organization";
+/**
+ * Type for FDC3 Organization Context
+ */
+export type OrganizationContextType = typeof OrganizationContextKey;
+export declare const PortfolioContextKey = "fdc3.portfolio";
+/**
+ * Type for FDC3 Portfolio Context
+ */
+export type PortfolioContextType = typeof PortfolioContextKey;
+export declare const PositionContextKey = "fdc3.position";
+/**
+ * Type for FDC3 Position Context
+ */
+export type PositionContextType = typeof PositionContextKey;
+export declare const TimeRangeContextKey = "fdc3.timerange";
+/**
+ * Type for FDC3 Time Range Context
+ */
+export type TimeRangeContextType = typeof TimeRangeContextKey;
+export declare const ValuationContextKey = "fdc3.valuation";
+/**
+ * Type for FDC3 Valuation Context
+ */
+export type ValuationContextType = typeof ValuationContextKey;
+export declare const NothingContextKey = "fdc3.nothing";
+/**
+ * Type for FDC3 Nothing Context
+ */
+export type NothingContextType = typeof NothingContextKey;
+/**
+ * FDC3 (2.0) Contexts
+ */
+export type Fdc3StandardContext = ChartContext | ChatInitSettingsContext | ContactContext | ContactListContext | CountryContext | CurrencyContext | EmailContext | InstrumentContext | InstrumentListContext | OrganizationContext | PortfolioContext | PositionContext | TimeRangeContext | ValuationContext | NothingContext;
+/**
+ * FDC3 (2.0) Custom Context
+ */
+export type Fdc3CustomContext = Context;
+/**
+ * FDC3 (2.0) Generic Context (Standard or Custom)
+ */
+export type Fdc3Context = Fdc3StandardContext | Fdc3CustomContext;
+export type TypedFdc3Context<CONTEXT, TYPE extends Fdc3StandardContextType> = CONTEXT & {
+    type: TYPE;
+};
+/**
+ * FDC3 2.0 Chart Context
+ */
+export type ChartContext = TypedFdc3Context<Chart, ContextTypes.Chart>;
+/**
+ * FDC3 2.0 Chat Context
+ */
+export type ChatInitSettingsContext = TypedFdc3Context<ChatInitSettings, ContextTypes.ChatInitSettings>;
+/**
+ * FDC3 2.0 Contact Context
+ */
+export type ContactContext = TypedFdc3Context<Contact, ContextTypes.Contact>;
+/**
+ * FDC3 2.0 Contact List Context
+ */
+export type ContactListContext = TypedFdc3Context<ContactList, ContextTypes.ContactList>;
+/**
+ * FDC3 2.0 Country Context
+ */
+export type CountryContext = TypedFdc3Context<Country, ContextTypes.Country>;
+/**
+ * FDC3 2.0 Currency Context
+ */
+export type CurrencyContext = TypedFdc3Context<Currency, ContextTypes.Currency>;
+/**
+ * FDC3 2.0 Email Context
+ */
+export type EmailContext = TypedFdc3Context<Email, ContextTypes.Email>;
+/**
+ * FDC3 2.0 Instrument Context
+ */
+export type InstrumentContext = TypedFdc3Context<Instrument, ContextTypes.Instrument>;
+/**
+ * FDC3 2.0 Instrument List Context
+ */
+export type InstrumentListContext = TypedFdc3Context<InstrumentList, ContextTypes.InstrumentList>;
+/**
+ * FDC3 2.0 Organization Context
+ */
+export type OrganizationContext = TypedFdc3Context<Organization, ContextTypes.Organization>;
+/**
+ * FDC3 2.0 Portfolio Context
+ */
+export type PortfolioContext = TypedFdc3Context<Portfolio, ContextTypes.Portfolio>;
+/**
+ * FDC3 2.0 Position Context
+ */
+export type PositionContext = TypedFdc3Context<Position, ContextTypes.Position>;
+/**
+ * FDC3 2.0 Time Range Context
+ */
+export type TimeRangeContext = TypedFdc3Context<TimeRange, ContextTypes.TimeRange>;
+/**
+ * FDC3 2.0 Valuation Context
+ */
+export type ValuationContext = TypedFdc3Context<Valuation, ContextTypes.Valuation>;
+/**
+ * FDC3 2.0 Nothing Context
+ */
+export type NothingContext = TypedFdc3Context<Nothing, ContextTypes.Nothing>;
+export declare const ContextConfiguration: {
+    readonly "fdc3.chart": {
+        readonly label: "Chart";
+        readonly icon: "pie-chart";
+    };
+    readonly "fdc3.chat.initSettings": {
+        readonly label: "ChatInitSettings";
+        readonly icon: "chat";
+    };
+    readonly "fdc3.contact": {
+        readonly label: "Contact";
+        readonly icon: "badge";
+    };
+    readonly "fdc3.contactList": {
+        readonly label: "ContactList";
+        readonly icon: "badge";
+    };
+    readonly "fdc3.country": {
+        readonly label: "Country";
+        readonly icon: "flag";
+    };
+    readonly "fdc3.currency": {
+        readonly label: "Currency";
+        readonly icon: "dollar";
+    };
+    readonly "fdc3.email": {
+        readonly label: "Email";
+        readonly icon: "mail";
+    };
+    readonly "fdc3.instrument": {
+        readonly label: "Instrument";
+        readonly icon: "money";
+    };
+    readonly "fdc3.instrumentList": {
+        readonly label: "InstrumentList";
+        readonly icon: "money";
+    };
+    readonly "fdc3.organization": {
+        readonly label: "Organization";
+        readonly icon: "organisation";
+    };
+    readonly "fdc3.portfolio": {
+        readonly label: "Portfolio";
+        readonly icon: "building";
+    };
+    readonly "fdc3.position": {
+        readonly label: "Position";
+        readonly icon: "building";
+    };
+    readonly "fdc3.timerange": {
+        readonly label: "TimeRange";
+        readonly icon: "date-range";
+    };
+    readonly "fdc3.valuation": {
+        readonly label: "Valuation";
+        readonly icon: "equation";
+    };
+    readonly "fdc3.nothing": {
+        readonly label: "Nothing";
+        readonly icon: "fdc3";
+    };
+};
+export declare const StandardContextTypes: Fdc3StandardContextType[];

package/src/PredefinedConfig/Common/Fdc3Context.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardContextTypes = exports.ContextConfiguration = exports.NothingContextKey = exports.ValuationContextKey = exports.TimeRangeContextKey = exports.PositionContextKey = exports.PortfolioContextKey = exports.OrganizationContextKey = exports.InstrumentListContextKey = exports.InstrumentContextKey = exports.EmailContextKey = exports.CurrencyContextKey = exports.CountryContextKey = exports.ContactListContextKey = exports.ContactContextKey = exports.ChatInitSettingsContextKey = exports.ChartContextKey = void 0;
+exports.ChartContextKey = 'fdc3.chart';
+exports.ChatInitSettingsContextKey = 'fdc3.chat.initSettings';
+exports.ContactContextKey = 'fdc3.contact';
+exports.ContactListContextKey = 'fdc3.contactList';
+exports.CountryContextKey = 'fdc3.country';
+exports.CurrencyContextKey = 'fdc3.currency';
+exports.EmailContextKey = 'fdc3.email';
+exports.InstrumentContextKey = 'fdc3.instrument';
+exports.InstrumentListContextKey = 'fdc3.instrumentList';
+exports.OrganizationContextKey = 'fdc3.organization';
+exports.PortfolioContextKey = 'fdc3.portfolio';
+exports.PositionContextKey = 'fdc3.position';
+exports.TimeRangeContextKey = 'fdc3.timerange';
+exports.ValuationContextKey = 'fdc3.valuation';
+exports.NothingContextKey = 'fdc3.nothing';
+exports.ContextConfiguration = {
+    [exports.ChartContextKey]: {
+        label: 'Chart',
+        icon: 'pie-chart',
+    },
+    [exports.ChatInitSettingsContextKey]: {
+        label: 'ChatInitSettings',
+        icon: 'chat',
+    },
+    [exports.ContactContextKey]: {
+        label: 'Contact',
+        icon: 'badge',
+    },
+    [exports.ContactListContextKey]: {
+        label: 'ContactList',
+        icon: 'badge',
+    },
+    [exports.CountryContextKey]: {
+        label: 'Country',
+        icon: 'flag',
+    },
+    [exports.CurrencyContextKey]: {
+        label: 'Currency',
+        icon: 'dollar',
+    },
+    [exports.EmailContextKey]: {
+        label: 'Email',
+        icon: 'mail',
+    },
+    [exports.InstrumentContextKey]: {
+        label: 'Instrument',
+        icon: 'money',
+    },
+    [exports.InstrumentListContextKey]: {
+        label: 'InstrumentList',
+        icon: 'money',
+    },
+    [exports.OrganizationContextKey]: {
+        label: 'Organization',
+        icon: 'organisation',
+    },
+    [exports.PortfolioContextKey]: {
+        label: 'Portfolio',
+        icon: 'building',
+    },
+    [exports.PositionContextKey]: {
+        label: 'Position',
+        icon: 'building',
+    },
+    [exports.TimeRangeContextKey]: {
+        label: 'TimeRange',
+        icon: 'date-range',
+    },
+    [exports.ValuationContextKey]: {
+        label: 'Valuation',
+        icon: 'equation',
+    },
+    [exports.NothingContextKey]: {
+        label: 'Nothing',
+        icon: 'fdc3',
+    },
+};
+exports.StandardContextTypes = Object.keys(exports.ContextConfiguration);

package/src/PredefinedConfig/Common/Fdc3Intent.d.ts

@@ -0,0 +1,89 @@
+export declare const StartCallIntent = "StartCall";
+export declare const StartChatIntent = "StartChat";
+export declare const StartEmailIntent = "StartEmail";
+export declare const ViewAnalysisIntent = "ViewAnalysis";
+export declare const ViewChartIntent = "ViewChart";
+export declare const ViewContactIntent = "ViewContact";
+export declare const ViewHoldingsIntent = "ViewHoldings";
+export declare const ViewInstrumentIntent = "ViewInstrument";
+export declare const ViewInteractionsIntent = "ViewInteractions";
+export declare const ViewNewsIntent = "ViewNews";
+export declare const ViewOrdersIntent = "ViewOrders";
+export declare const ViewProfileIntent = "ViewProfile";
+export declare const ViewQuoteIntent = "ViewQuote";
+export declare const ViewResearchIntent = "ViewResearch";
+export declare const Fdc3IntentConfiguration: {
+    readonly StartCall: {
+        readonly contexts: readonly ["fdc3.contact", "fdc3.contactList", "fdc3.nothing"];
+        readonly icon: "call";
+    };
+    readonly StartChat: {
+        readonly contexts: readonly ["fdc3.contact", "fdc3.contactList", "fdc3.chat.initSettings", "fdc3.nothing"];
+        readonly icon: "chat";
+    };
+    readonly StartEmail: {
+        readonly contexts: readonly ["fdc3.email"];
+        readonly icon: "mail";
+    };
+    readonly ViewAnalysis: {
+        readonly contexts: readonly ["fdc3.instrument", "fdc3.organization", "fdc3.portfolio", "fdc3.nothing"];
+        readonly icon: "spark-line";
+    };
+    readonly ViewChart: {
+        readonly contexts: readonly ["fdc3.chart", "fdc3.instrument", "fdc3.instrumentList", "fdc3.portfolio", "fdc3.position", "fdc3.nothing"];
+        readonly icon: "pie-chart";
+    };
+    readonly ViewContact: {
+        readonly contexts: readonly ["fdc3.contact", "fdc3.nothing"];
+        readonly icon: "person";
+    };
+    readonly ViewHoldings: {
+        readonly contexts: readonly ["fdc3.instrument", "fdc3.instrumentList", "fdc3.organization", "fdc3.nothing"];
+        readonly icon: "building";
+    };
+    readonly ViewInstrument: {
+        readonly contexts: readonly ["fdc3.instrument", "fdc3.nothing"];
+        readonly icon: "money";
+    };
+    readonly ViewInteractions: {
+        readonly contexts: readonly ["fdc3.contact", "fdc3.instrument", "fdc3.organization", "fdc3.nothing"];
+        readonly icon: "interactions";
+    };
+    readonly ViewNews: {
+        readonly contexts: readonly ["fdc3.country", "fdc3.instrument", "fdc3.instrumentList", "fdc3.organization", "fdc3.portfolio", "fdc3.nothing"];
+        readonly icon: "news";
+    };
+    readonly ViewOrders: {
+        readonly contexts: readonly ["fdc3.contact", "fdc3.instrument", "fdc3.organization", "fdc3.nothing"];
+        readonly icon: "order";
+    };
+    readonly ViewProfile: {
+        readonly contexts: readonly ["fdc3.contact", "fdc3.organization", "fdc3.nothing"];
+        readonly icon: "badge";
+    };
+    readonly ViewQuote: {
+        readonly contexts: readonly ["fdc3.instrument", "fdc3.nothing"];
+        readonly icon: "quote";
+    };
+    readonly ViewResearch: {
+        readonly contexts: readonly ["fdc3.contact", "fdc3.instrument", "fdc3.organization", "fdc3.nothing"];
+        readonly icon: "science";
+    };
+};
+export declare const Fdc3StandardIntents: ("StartCall" | "StartChat" | "StartEmail" | "ViewAnalysis" | "ViewChart" | "ViewContact" | "ViewHoldings" | "ViewInstrument" | "ViewInteractions" | "ViewNews" | "ViewOrders" | "ViewProfile" | "ViewQuote" | "ViewResearch")[];
+/**
+ * All FDC3 standard intents
+ */
+export type Fdc3StandardIntentType = typeof Fdc3StandardIntents[number];
+/**
+ * Custom FDC3 intent
+ */
+export type Fdc3CustomIntentType = string;
+/**
+ * Generic FDC3 intent (standard or custom)
+ */
+export type Fdc3IntentType = Fdc3StandardIntentType | Fdc3CustomIntentType;
+/**
+ * Valid context for a given FDC3 intent
+ */
+export type CompatibleContext<F extends Fdc3StandardIntentType> = typeof Fdc3IntentConfiguration[F]['contexts'][number];

package/src/PredefinedConfig/Common/Fdc3Intent.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fdc3StandardIntents = exports.Fdc3IntentConfiguration = exports.ViewResearchIntent = exports.ViewQuoteIntent = exports.ViewProfileIntent = exports.ViewOrdersIntent = exports.ViewNewsIntent = exports.ViewInteractionsIntent = exports.ViewInstrumentIntent = exports.ViewHoldingsIntent = exports.ViewContactIntent = exports.ViewChartIntent = exports.ViewAnalysisIntent = exports.StartEmailIntent = exports.StartChatIntent = exports.StartCallIntent = void 0;
+const Fdc3Context_1 = require("./Fdc3Context");
+exports.StartCallIntent = 'StartCall';
+exports.StartChatIntent = 'StartChat';
+exports.StartEmailIntent = 'StartEmail';
+exports.ViewAnalysisIntent = 'ViewAnalysis';
+exports.ViewChartIntent = 'ViewChart';
+exports.ViewContactIntent = 'ViewContact';
+exports.ViewHoldingsIntent = 'ViewHoldings';
+exports.ViewInstrumentIntent = 'ViewInstrument';
+exports.ViewInteractionsIntent = 'ViewInteractions';
+exports.ViewNewsIntent = 'ViewNews';
+exports.ViewOrdersIntent = 'ViewOrders';
+exports.ViewProfileIntent = 'ViewProfile';
+exports.ViewQuoteIntent = 'ViewQuote';
+exports.ViewResearchIntent = 'ViewResearch';
+exports.Fdc3IntentConfiguration = {
+    [exports.StartCallIntent]: {
+        contexts: [Fdc3Context_1.ContactContextKey, Fdc3Context_1.ContactListContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'call',
+    },
+    [exports.StartChatIntent]: {
+        contexts: [
+            Fdc3Context_1.ContactContextKey,
+            Fdc3Context_1.ContactListContextKey,
+            Fdc3Context_1.ChatInitSettingsContextKey,
+            Fdc3Context_1.NothingContextKey,
+        ],
+        icon: 'chat',
+    },
+    [exports.StartEmailIntent]: {
+        contexts: [Fdc3Context_1.EmailContextKey],
+        icon: 'mail',
+    },
+    [exports.ViewAnalysisIntent]: {
+        contexts: [
+            Fdc3Context_1.InstrumentContextKey,
+            Fdc3Context_1.OrganizationContextKey,
+            Fdc3Context_1.PortfolioContextKey,
+            Fdc3Context_1.NothingContextKey,
+        ],
+        icon: 'spark-line',
+    },
+    [exports.ViewChartIntent]: {
+        contexts: [
+            Fdc3Context_1.ChartContextKey,
+            Fdc3Context_1.InstrumentContextKey,
+            Fdc3Context_1.InstrumentListContextKey,
+            Fdc3Context_1.PortfolioContextKey,
+            Fdc3Context_1.PositionContextKey,
+            Fdc3Context_1.NothingContextKey,
+        ],
+        icon: 'pie-chart',
+    },
+    [exports.ViewContactIntent]: {
+        contexts: [Fdc3Context_1.ContactContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'person',
+    },
+    [exports.ViewHoldingsIntent]: {
+        contexts: [
+            Fdc3Context_1.InstrumentContextKey,
+            Fdc3Context_1.InstrumentListContextKey,
+            Fdc3Context_1.OrganizationContextKey,
+            Fdc3Context_1.NothingContextKey,
+        ],
+        icon: 'building',
+    },
+    [exports.ViewInstrumentIntent]: {
+        contexts: [Fdc3Context_1.InstrumentContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'money',
+    },
+    [exports.ViewInteractionsIntent]: {
+        contexts: [Fdc3Context_1.ContactContextKey, Fdc3Context_1.InstrumentContextKey, Fdc3Context_1.OrganizationContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'interactions',
+    },
+    [exports.ViewNewsIntent]: {
+        contexts: [
+            Fdc3Context_1.CountryContextKey,
+            Fdc3Context_1.InstrumentContextKey,
+            Fdc3Context_1.InstrumentListContextKey,
+            Fdc3Context_1.OrganizationContextKey,
+            Fdc3Context_1.PortfolioContextKey,
+            Fdc3Context_1.NothingContextKey,
+        ],
+        icon: 'news',
+    },
+    [exports.ViewOrdersIntent]: {
+        contexts: [Fdc3Context_1.ContactContextKey, Fdc3Context_1.InstrumentContextKey, Fdc3Context_1.OrganizationContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'order',
+    },
+    [exports.ViewProfileIntent]: {
+        contexts: [Fdc3Context_1.ContactContextKey, Fdc3Context_1.OrganizationContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'badge',
+    },
+    [exports.ViewQuoteIntent]: {
+        contexts: [Fdc3Context_1.InstrumentContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'quote',
+    },
+    [exports.ViewResearchIntent]: {
+        contexts: [Fdc3Context_1.ContactContextKey, Fdc3Context_1.InstrumentContextKey, Fdc3Context_1.OrganizationContextKey, Fdc3Context_1.NothingContextKey],
+        icon: 'science',
+    },
+};
+exports.Fdc3StandardIntents = Object.keys(exports.Fdc3IntentConfiguration);

package/src/PredefinedConfig/Common/FilterActionOnDataChange.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set
+ */
+export interface FilterActionOnDataChange {
+    /**
+     * When to re-apply Filters: 'Always', 'Never' or 'Throttle'
+     */
+    applyFilter: 'Always' | 'Never' | 'Throttle';
+    /**
+     * Delay in ms (when `applyFilter` is set to 'Throttle')
+     */
+    throttleDelay?: number;
+}

package/src/PredefinedConfig/Common/FilterActionOnDataChange.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/Common/FormContext.d.ts

@@ -0,0 +1,11 @@
+import { AdaptableFormData } from '../../types';
+import { BaseContext } from './BaseContext';
+/**
+ * Context supplied to Buttons that appear in an Adaptable Form
+ */
+export interface FormContext extends BaseContext {
+    /**
+     * Adaptable Form Data
+     */
+    formData: AdaptableFormData;
+}

package/src/PredefinedConfig/Common/FormContext.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/PredefinedConfig/Common/GridFilter.d.ts

@@ -0,0 +1,10 @@
+import { SuspendableObject } from '../../types';
+/**
+ * Defines a Grid Filter (essentially a Boolean Expression)
+ */
+export interface GridFilter extends SuspendableObject {
+    /**
+     * The (boolean) Expression to run
+     */
+    Expression?: string;
+}

package/src/PredefinedConfig/Common/GridFilter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });