@nebulateam/jarvis-sdk 0.0.0-stage → 5.57.9

package/dist/app/jarvis-shell.d.ts

@@ -0,0 +1,79 @@
+import { ExternalContextMenuEntry, JarvisConfigurationResponseMessage, JarvisExternalMessageKind, JarvisNotification } from "./jarvis-shell.models";
+/**
+ * Lets a component embedded in Jarvis (iframe or web component) talk to the Jarvis host:
+ * navigation, toasts, dialogs, context menus and subscriptions to Jarvis events.
+ *
+ * Call {@link JarvisShell.init} before anything else: it loads the host configuration and capabilities.
+ * @example
+ * const shell = new JarvisShell();
+ * shell.init((jarvis, configuration) => {
+ *     jarvis.showToast('Hello', `Welcome ${configuration?.user.fullName}`, 'info');
+ * });
+ */
+export declare class JarvisShell {
+    private _targetOrigin;
+    private INIT_ERROR_MESSAGE;
+    private subscriptions;
+    private dialogCallbacks;
+    private contextMenuCallbacks;
+    private configuration;
+    private tempConfigSubscription;
+    private htmlElement;
+    constructor();
+    private reactToMessage;
+    /**
+     * Asks the host for its configuration and capabilities; call it once on startup.
+     * @param onLoaded invoked when the host answers, with the configuration (user, capabilities, events)
+     * @param htmlElement for web components, the element used to dispatch the messages to Jarvis
+     */
+    init(onLoaded: (jarvis: JarvisShell, configuration: null | JarvisConfigurationResponseMessage) => void, htmlElement?: HTMLElement | null): void;
+    /**
+     * Subscribes to a Jarvis event (e.g. "WorkTask.Updated"); the supported events are listed in the configuration.
+     * @param event the event name, prefixed by its model
+     * @param callback invoked for every notification of the event
+     */
+    on: (event: string, callback: (notification: JarvisNotification) => void) => void;
+    private getConfiguration;
+    /** Opens the detail of a Jarvis entity. @param id the Jarvis id of the entity */
+    openDetail(id: string): void;
+    /**
+     * Navigates the host to a url.
+     * @param url the url to open
+     * @param openNewTab opens the url in a new tab
+     * @param external true for addresses outside Jarvis, opened as they are
+     */
+    navigate(url: string, openNewTab: boolean, external: boolean): void;
+    /**
+     * Navigates the host to a Jarvis entity.
+     * @param id the Jarvis id of the entity
+     * @param parentId the parent entity (e.g. the workspace of a work task, the dataset of an item)
+     * @param openNewTab opens the entity in a new tab
+     */
+    navigateById(id: string, parentId: string, openNewTab: boolean): void;
+    /** Shows a toast message in the host. */
+    showToast: (title: string, message: string, kind: "error" | "warning" | "success" | "info") => void;
+    /**
+     * Shows a confirmation dialog in the host.
+     * @param callback receives true when the user confirms
+     */
+    showDialog: (dialog: {
+        kind: "yesNo" | "okCancel";
+        subtitle: string;
+        title: string;
+        body: string;
+        isDanger?: boolean;
+    }, callback: (response: boolean) => void) => void;
+    /**
+     * Shows a context menu in the host at the given position.
+     * @param callback receives the selected action id and its context data
+     */
+    showContextMenu: (mouseEvent: {
+        x: number;
+        y: number;
+    }, menuEntries: ExternalContextMenuEntry[], callback: (actionId: string, contextData: any) => void) => void;
+    /** Sends a raw message to the host; prefer the specific methods. */
+    sendMessage(msg: {
+        kind: JarvisExternalMessageKind;
+        data: any;
+    }): void;
+}

package/dist/app/jarvis-shell.models.d.ts

@@ -0,0 +1,204 @@
+/** Identifier that marks a message as addressed to (or coming from) Jarvis. */
+export declare const JARVIS_COMMAND_EVENT_ID = "JARVIS_EVENT";
+/** Each possible kind of message exchanged between the embedded component and Jarvis */
+export declare enum JarvisExternalMessageKind {
+    Navigate = "navigate",
+    NavigateById = "navigateById",
+    ReloadById = "reloadById",
+    OpenDetail = "openDetail",
+    ShowToast = "showToast",
+    ShowDialog = "showDialog",
+    ShowDialogResponse = "showDialogResponse",
+    Subscription = "subscription",
+    Notification = "notification",
+    GetConfiguration = "getConfiguration",
+    ConfigurationResponse = "configurationResponse",
+    ShowContextMenu = "showContextMenu",
+    ShowContextMenuResponse = "showContextMenuResponse",
+    DeleteItem = "deleteItem",
+    CloneItem = "cloneItem",
+    EditItem = "editItem"
+}
+export interface JarvisExternalMessage {
+    id: typeof JARVIS_COMMAND_EVENT_ID;
+    kind: JarvisExternalMessageKind;
+    data: JarvisNavigateExternalMessage | JarvisNavigateByIdExternalMessage | JarvisReloadByIdExternalMessage | JarvisOpenDetailExternalMessage | JarvisSubscriptionMessage | JarvisNotificationMessage | JarvisShowToastExternalMessage | JarvisGetConfigurationMessage | JarvisConfigurationResponseMessage | JarvisShowDialogMessage | JarvisShowDialogResponseMessage | JarvisShowContextMenuMessage | JarvisShowContextMenuResponseMessage | JarvisDeleteItemMessage | JarvisCloneItemMessage | JarvisEditItemMessage;
+}
+export interface JarvisNavigateExternalMessage {
+    /** The url to navigate to */
+    url: string;
+    /** If we should navigate in another tab */
+    openNewTab: boolean;
+    /**
+     * If the url we navigate to is an external address
+     * so we should navigate to it without modifying it
+     */
+    external: boolean;
+}
+export interface JarvisOpenDetailExternalMessage {
+    /** Id of the entity in Jarvis */
+    id: string;
+}
+export interface JarvisNavigateByIdExternalMessage {
+    /** Id of the entity in Jarvis */
+    id: string;
+    /**
+     * Parent of the entity in Jarvis, needed to correctly open
+     * stuff like worktask inside workspaces or dataset details
+     */
+    parentId: string;
+    /** If we should navigate in another tab */
+    openNewTab: boolean;
+}
+export interface JarvisReloadByIdExternalMessage {
+    /** Id of the entity in Jarvis */
+    id: string;
+}
+export interface JarvisShowToastExternalMessage {
+    /** The title of the toast */
+    title: string;
+    /** The text to be displayed in the toast */
+    message: string;
+    /** The kind of toast to show */
+    kind: "error" | "warning" | "success" | "info";
+}
+export interface JarvisSubscriptionMessage {
+    event: string;
+}
+export interface JarvisNotificationMessage {
+    notification: JarvisNotification;
+}
+export interface JarvisGetConfigurationMessage {
+}
+export interface JarvisConfigurationResponseMessage {
+    user: JarvisUserConfiguration;
+    capabilities: JarvisExternalMessageKind[];
+    events: {
+        [model: string]: string[];
+    };
+}
+export interface JarvisShowDialogMessage {
+    id: string;
+    kind: "yesNo" | "okCancel";
+    subtitle: string;
+    title: string;
+    body?: string;
+    isDanger?: boolean;
+}
+export interface JarvisShowDialogResponseMessage {
+    id: string;
+    response: boolean;
+}
+export interface JarvisUserConfiguration {
+    userId?: string | undefined;
+    emailAddress?: string | undefined;
+    firstName?: string | undefined;
+    middleName?: string | undefined;
+    lastName?: string | undefined;
+    fullName?: string | undefined;
+    mobilePhone?: string | undefined;
+    crmUserId?: string | undefined;
+    crmUserEnabled: boolean;
+    plmUserId?: string | undefined;
+    plmUserEnabled: boolean;
+    profileId?: string | undefined;
+    language?: string | undefined;
+}
+export interface JarvisNotification {
+    id: number;
+    event: string;
+    model: string;
+    action: string;
+    modelId: any;
+    data: any;
+    extraData?: any;
+}
+export interface JarvisCustomEvent extends Event {
+    detail: JarvisExternalMessage;
+}
+/**
+ * The message that will be sent from the iframe to show a context menu in JARVIS
+ * at the specified position
+ */
+export interface JarvisShowContextMenuMessage {
+    /** A unique identifier for the request */
+    requestId: string;
+    /** The x and y position of the context menu */
+    x: number;
+    y: number;
+    /** The entries that will be shown in the context menu */
+    entries: ExternalContextMenuEntry[];
+}
+/** An entry in the context menu */
+export interface ExternalContextMenuEntry {
+    /** A unique identifier for the action */
+    actionId: string;
+    /** The icon tha will be shown next to the label */
+    icon?: string;
+    /** The label of the action */
+    label: string;
+    /** The tooltip of the action */
+    tooltip: string;
+    /** If the action is disabled */
+    isDisabled?: boolean;
+    /** If the action should be shown in red, i.e. it will perform a destructive action */
+    isDanger?: boolean;
+    /** If this is not an action, but a header */
+    isHeader?: boolean;
+    /** If the action is custom, i.e. it will be handled by the iframe */
+    isCustom?: boolean;
+    /**
+     * The action that will be performed by JARVIS if the user selects this entry
+     * If isCustom is true, this will be ignored
+     */
+    jarvisAction?: JarvisExternalContextMenuAction;
+    /** The id of the element that the action will be performed on, if this is not a custom action */
+    jarvisActionElementId?: string | string[];
+    /**
+     * The context data that will be sent back to the iframe if the user selects this entry
+     * This is helpful to provide the iframe with the necessary data to perform the action
+     * for custom actions
+     */
+    contextData?: any;
+}
+/**
+ * The possible actions that can be performed by the context menu
+ * They will be shown only if the context we are in provides them
+ */
+export declare enum JarvisExternalContextMenuAction {
+    /** Open the entity */
+    Open = "open",
+    /** Edit the entity/entities */
+    Edit = "edit",
+    /** Delete the entity */
+    Delete = "delete",
+    /** Clone the entity */
+    Clone = "clone"
+}
+/**
+ * The response message that will be sent back to the iframe after the user
+ * has selected an action from the context menu
+ */
+export interface JarvisShowContextMenuResponseMessage {
+    /** The unique identifier of the request this message is a response to */
+    requestId: string;
+    /** The action that the user has selected */
+    actionId: string;
+    /** The context data that was provided by the context menu */
+    contextData?: any;
+}
+/** The message that will be sent from the iframe to delete an item (or multiple items) in JARVIS */
+export interface JarvisDeleteItemMessage {
+    /** Id of the entity (or identities) in Jarvis */
+    id: string | string[];
+}
+/** The message that will be sent from the iframe to clone an item in JARVIS */
+export interface JarvisCloneItemMessage {
+    /** Id of the entity in Jarvis */
+    id: string;
+}
+/** The message that will be sent from the iframe to edit an item (or multiple items) in JARVIS */
+export interface JarvisEditItemMessage {
+    /** Id of the entity (or identities) in Jarvis */
+    id: string | string[];
+}

package/dist/app/public-api.client.extension.d.ts

@@ -0,0 +1,22 @@
+export declare class JarvisApiBase {
+    private readonly config;
+    protected constructor(config: JarvisApiConfig);
+    protected transformOptions: (options: RequestInit) => Promise<RequestInit>;
+}
+export declare class JarvisApiBaseClient {
+    constructor();
+}
+/**
+ * Configuration class needed in base class.
+ * The config is provided to the API client at initialization time.
+ * API clients inherit from #AuthorizedApiBase and provide the config.
+ */
+export declare class JarvisApiConfig {
+    jarvisToken: string;
+    jarvisCallInfoHeader?: string | undefined;
+    /**
+     * Returns a valid value for the Authorization header.
+     * Used to dynamically inject the current auth header and call info header.
+     */
+    constructor(jarvisToken: string, jarvisCallInfoHeader?: string | undefined);
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './app/jarvis-client';
+export * from './app/jarvis-shell';
+export * from './app/jarvis-shell.models';
+export * from './app/automation-client';
+export * from './app/automation-client.models';
+export * from './app/jarvis-public-api-v2.client';