altair-graphql-core 7.2.4 → 7.3.3

package/build/ai/constants.d.ts

@@ -0,0 +1,12 @@
+export declare const maxTotalSessionTokens = 50000;
+export declare const maxTotalChars: number;
+export declare const maxMessageTokens = 300;
+export declare const maxMessageChars: number;
+export declare const maxSdlTokens = 4096;
+export declare const maxSdlChars: number;
+export declare const maxGraphqlQueryTokens = 1000;
+export declare const maxGraphqlQueryChars: number;
+export declare const maxGraphqlVariablesTokens = 150;
+export declare const maxGraphqlVariablesChars: number;
+export declare const responseMaxTokens = 1000;
+//# sourceMappingURL=constants.d.ts.map

package/build/ai/constants.js

@@ -0,0 +1,14 @@
+// https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
+const avgCharsPerToken = 5; // assumed average characters per token
+export const maxTotalSessionTokens = 50000;
+export const maxTotalChars = maxTotalSessionTokens * avgCharsPerToken;
+export const maxMessageTokens = 300;
+export const maxMessageChars = maxMessageTokens * avgCharsPerToken;
+export const maxSdlTokens = 4096;
+export const maxSdlChars = maxSdlTokens * avgCharsPerToken;
+export const maxGraphqlQueryTokens = 1000;
+export const maxGraphqlQueryChars = maxGraphqlQueryTokens * avgCharsPerToken;
+export const maxGraphqlVariablesTokens = 150;
+export const maxGraphqlVariablesChars = maxGraphqlVariablesTokens * avgCharsPerToken;
+export const responseMaxTokens = 1000;
+//# sourceMappingURL=constants.js.map

package/build/ai/types.d.ts

@@ -0,0 +1,22 @@
+export interface ISession {
+    id: string;
+    userId: string;
+    title: string;
+    isActive: boolean;
+}
+export interface IMessage {
+    id: string;
+    sessionId: string;
+    message: string;
+    role: 'USER' | 'ASSISTANT';
+}
+export interface ISendMessageDto {
+    message: string;
+    sdl?: string;
+    graphqlQuery?: string;
+    graphqlVariables?: string;
+}
+export interface IRateMessageDto {
+    rating: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/ai/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/cjs/ai/constants.d.ts

@@ -0,0 +1,12 @@
+export declare const maxTotalSessionTokens = 50000;
+export declare const maxTotalChars: number;
+export declare const maxMessageTokens = 300;
+export declare const maxMessageChars: number;
+export declare const maxSdlTokens = 4096;
+export declare const maxSdlChars: number;
+export declare const maxGraphqlQueryTokens = 1000;
+export declare const maxGraphqlQueryChars: number;
+export declare const maxGraphqlVariablesTokens = 150;
+export declare const maxGraphqlVariablesChars: number;
+export declare const responseMaxTokens = 1000;
+//# sourceMappingURL=constants.d.ts.map

package/build/cjs/ai/constants.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.responseMaxTokens = exports.maxGraphqlVariablesChars = exports.maxGraphqlVariablesTokens = exports.maxGraphqlQueryChars = exports.maxGraphqlQueryTokens = exports.maxSdlChars = exports.maxSdlTokens = exports.maxMessageChars = exports.maxMessageTokens = exports.maxTotalChars = exports.maxTotalSessionTokens = void 0;
+// https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
+const avgCharsPerToken = 5; // assumed average characters per token
+exports.maxTotalSessionTokens = 50000;
+exports.maxTotalChars = exports.maxTotalSessionTokens * avgCharsPerToken;
+exports.maxMessageTokens = 300;
+exports.maxMessageChars = exports.maxMessageTokens * avgCharsPerToken;
+exports.maxSdlTokens = 4096;
+exports.maxSdlChars = exports.maxSdlTokens * avgCharsPerToken;
+exports.maxGraphqlQueryTokens = 1000;
+exports.maxGraphqlQueryChars = exports.maxGraphqlQueryTokens * avgCharsPerToken;
+exports.maxGraphqlVariablesTokens = 150;
+exports.maxGraphqlVariablesChars = exports.maxGraphqlVariablesTokens * avgCharsPerToken;
+exports.responseMaxTokens = 1000;
+//# sourceMappingURL=constants.js.map

package/build/cjs/ai/types.d.ts

@@ -0,0 +1,22 @@
+export interface ISession {
+    id: string;
+    userId: string;
+    title: string;
+    isActive: boolean;
+}
+export interface IMessage {
+    id: string;
+    sessionId: string;
+    message: string;
+    role: 'USER' | 'ASSISTANT';
+}
+export interface ISendMessageDto {
+    message: string;
+    sdl?: string;
+    graphqlQuery?: string;
+    graphqlVariables?: string;
+}
+export interface IRateMessageDto {
+    rating: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/cjs/ai/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/cjs/plugin/context/context.interface.d.ts

@@ -8,6 +8,7 @@ import { AltairUiAction, AltairUiActionLocation } from '../ui-action';
 export interface CreatePanelOptions {
     title?: string;
     location?: AltairPanelLocation;
+    width?: number;
 }
 export interface CreateActionOptions {
     title: string;

package/build/cjs/plugin/panel.d.ts

@@ -1,4 +1,5 @@
 import { PluginParentEngine } from './v3/parent-engine';
+import { SafeHtml } from '@angular/platform-browser';
 export declare enum AltairPanelLocation {
     HEADER = "header",
     SIDEBAR = "sidebar",
@@ -12,9 +13,12 @@ export declare class AltairPanel {
     element: HTMLElement;
     location: AltairPanelLocation;
     engine?: PluginParentEngine | undefined;
+    iconUrl?: string | undefined;
+    iconSvg?: SafeHtml | undefined;
     id: string;
     isActive: boolean;
-    constructor(title: string, element: HTMLElement, location: AltairPanelLocation, engine?: PluginParentEngine | undefined);
+    constructor(title: string, element: HTMLElement, location: AltairPanelLocation, engine?: PluginParentEngine | undefined, iconUrl?: string | undefined, iconSvg?: SafeHtml | undefined);
+    setActive(isActive: boolean): void;
     destroy(): void;
 }
 //# sourceMappingURL=panel.d.ts.map

package/build/cjs/plugin/panel.js

@@ -14,14 +14,19 @@ var AltairPanelLocation;
 class AltairPanel {
     constructor(title, element, location, 
     // TODO: Making this optional for now for backward compatibility. This should be required for v3 plugins.
-    engine) {
+    engine, iconUrl, iconSvg) {
         this.title = title;
         this.element = element;
         this.location = location;
         this.engine = engine;
+        this.iconUrl = iconUrl;
+        this.iconSvg = iconSvg;
         this.id = (0, uuid_1.v4)();
         this.isActive = false;
     }
+    setActive(isActive) {
+        this.isActive = isActive;
+    }
     destroy() {
         this.element = null;
     }

package/build/cjs/plugin/v3/context.d.ts

@@ -1,7 +1,16 @@
+import { IMessage, ISendMessageDto, ISession } from '../../ai/types';
 import { ICustomTheme } from '../../theme';
+import { IPlan, IAvailableCredits } from '../../types/state/account.interfaces';
 import { ExportWindowState } from '../../types/state/window.interfaces';
 import { CreateActionOptions, CreatePanelOptions, PluginWindowState } from '../context/context.interface';
 import { PluginEvent, PluginEventCallback } from '../event/event.interfaces';
+export interface PluginUserInfo {
+    loggedIn: boolean;
+    name: string;
+    email: string;
+    avatar: string;
+    plan?: IPlan;
+}
 export interface PluginV3Context {
     /**
      * Returns data about a window (tab) in the app
@@ -75,5 +84,14 @@ export interface PluginV3Context {
      * Enable a theme in the app
      */
     enableTheme(name: string, darkMode?: boolean): Promise<void>;
+    getUserInfo(): Promise<PluginUserInfo | undefined>;
+    getAvailableCredits(): Promise<IAvailableCredits | undefined>;
+    getActiveAiSession(): Promise<ISession | undefined>;
+    createAiSession(): Promise<ISession | undefined>;
+    getAiSessionMessages(sessionId: string): Promise<IMessage[] | undefined>;
+    sendMessageToAiSession(sessionId: string, message: ISendMessageDto): Promise<{
+        response: string;
+    } | undefined>;
+    rateAiSessionMessage(sessionId: string, messageId: string, rating: number): Promise<IMessage | undefined>;
 }
 //# sourceMappingURL=context.d.ts.map

package/build/cjs/plugin/v3/frame-engine.js

@@ -105,6 +105,27 @@ class PluginFrameEngine {
             enableTheme: (...args) => {
                 return this.worker.request('enableTheme', ...args);
             },
+            getUserInfo: async () => {
+                return this.worker.request('getUserInfo');
+            },
+            getAvailableCredits: async () => {
+                return this.worker.request('getAvailableCredits');
+            },
+            createAiSession: async (...args) => {
+                return this.worker.request('createAiSession', ...args);
+            },
+            getActiveAiSession: async (...args) => {
+                return this.worker.request('getActiveAiSession', ...args);
+            },
+            getAiSessionMessages: async (...args) => {
+                return this.worker.request('getAiSessionMessages', ...args);
+            },
+            sendMessageToAiSession: async (...args) => {
+                return this.worker.request('sendMessageToAiSession', ...args);
+            },
+            rateAiSessionMessage: async (...args) => {
+                return this.worker.request('rateAiSessionMessage', ...args);
+            },
         };
         this.ctx = ctx;
         return ctx;

package/build/cjs/plugin/v3/manifest.d.ts

@@ -8,7 +8,16 @@ interface PluginJsEntry {
     scripts: string[];
     styles: string[];
 }
-type PluginEntry = PluginHtmlEntry | PluginJsEntry;
+export type PluginEntry = PluginHtmlEntry | PluginJsEntry;
+interface PluginIconImage {
+    type: 'image';
+    url: string;
+}
+interface PluginIconSvg {
+    type: 'svg';
+    src: string;
+}
+export type PluginIcon = PluginIconImage | PluginIconSvg;
 export interface PluginV3Manifest {
     /**
      * Version of manifest (should be 3). It is a control measure for variations in the plugin versions
@@ -46,6 +55,14 @@ export interface PluginV3Manifest {
      * Name of the author of the plugin
      */
     author?: string;
+    /**
+     * The minimum version of Altair that the plugin is compatible with. This is useful for when the plugin uses features that are only available in a certain version of Altair
+     */
+    minimum_altair_version?: string;
+    /**
+     * The icon of the plugin. It can be an image or an SVG
+     */
+    icon?: PluginIcon;
 }
 export {};
 //# sourceMappingURL=manifest.d.ts.map

package/build/cjs/plugin/v3/parent-worker.d.ts

@@ -6,6 +6,7 @@ interface BasePluginParentWorkerOptions {
     instanceType?: InstanceType;
     additionalParams?: Record<string, string>;
     additionalSandboxAttributes?: string[];
+    width?: number;
 }
 interface PluginParentWorkerOptionsWithScripts extends BasePluginParentWorkerOptions {
     type: 'scripts';

package/build/cjs/plugin/v3/parent-worker.js

@@ -22,6 +22,10 @@ class PluginParentWorker extends worker_1.EvaluatorWorker {
             iframe.style.width = '100%';
             iframe.style.height = '100%';
             iframe.style.border = 'none';
+            iframe.style.display = 'block'; // fixes issue with vertical scrollbar appearing https://stackoverflow.com/a/9131632/3929126
+            if ('width' in this.opts && this.opts.width) {
+                iframe.style.minWidth = `${this.opts.width}px`;
+            }
         }
         else {
             iframe.style.display = 'none';

package/build/cjs/types/state/account.interfaces.d.ts

@@ -26,6 +26,11 @@ export interface IPlanInfo {
     currency: string;
     interval: string;
 }
+export interface IAvailableCredits {
+    fixed: number;
+    monthly: number;
+    total: number;
+}
 export interface AccountState {
     loggedIn: boolean;
     accessToken: string;
@@ -37,6 +42,7 @@ export interface AccountState {
     stats?: Stats;
     plan?: IPlan;
     planInfos?: IPlanInfo[];
+    availableCredits?: IAvailableCredits;
 }
 export declare class TeamId extends ValueObject<string> {
 }

package/build/cjs/utils/logger.js

@@ -11,6 +11,9 @@ const createLogger = (environment) => {
     if (!environment.production) {
         loglevel_1.default.setLevel('TRACE');
     }
+    else {
+        loglevel_1.default.setLevel('ERROR');
+    }
     const PREVIOUS_VERSION_KEY = 'altair__debug_previous_version';
     const CURRENT_VERSION_KEY = 'altair__debug_current_version';
     const previousVersion = () => localStorage.getItem(PREVIOUS_VERSION_KEY);
@@ -38,6 +41,9 @@ const createLogger = (environment) => {
                 console.groupEnd();
                 loglevel_1.default.setLevel('TRACE');
             }
+            else {
+                loglevel_1.default.setLevel('ERROR');
+            }
             window._ALTAIR__ENABLE_DEBUG_MODE__ = value;
         },
     });

package/build/plugin/context/context.interface.d.ts

@@ -8,6 +8,7 @@ import { AltairUiAction, AltairUiActionLocation } from '../ui-action';
 export interface CreatePanelOptions {
     title?: string;
     location?: AltairPanelLocation;
+    width?: number;
 }
 export interface CreateActionOptions {
     title: string;

package/build/plugin/panel.d.ts

@@ -1,4 +1,5 @@
 import { PluginParentEngine } from './v3/parent-engine';
+import { SafeHtml } from '@angular/platform-browser';
 export declare enum AltairPanelLocation {
     HEADER = "header",
     SIDEBAR = "sidebar",
@@ -12,9 +13,12 @@ export declare class AltairPanel {
     element: HTMLElement;
     location: AltairPanelLocation;
     engine?: PluginParentEngine | undefined;
+    iconUrl?: string | undefined;
+    iconSvg?: SafeHtml | undefined;
     id: string;
     isActive: boolean;
-    constructor(title: string, element: HTMLElement, location: AltairPanelLocation, engine?: PluginParentEngine | undefined);
+    constructor(title: string, element: HTMLElement, location: AltairPanelLocation, engine?: PluginParentEngine | undefined, iconUrl?: string | undefined, iconSvg?: SafeHtml | undefined);
+    setActive(isActive: boolean): void;
     destroy(): void;
 }
 //# sourceMappingURL=panel.d.ts.map

package/build/plugin/panel.js

@@ -11,14 +11,19 @@ export var AltairPanelLocation;
 export class AltairPanel {
     constructor(title, element, location, 
     // TODO: Making this optional for now for backward compatibility. This should be required for v3 plugins.
-    engine) {
+    engine, iconUrl, iconSvg) {
         this.title = title;
         this.element = element;
         this.location = location;
         this.engine = engine;
+        this.iconUrl = iconUrl;
+        this.iconSvg = iconSvg;
         this.id = uuid();
         this.isActive = false;
     }
+    setActive(isActive) {
+        this.isActive = isActive;
+    }
     destroy() {
         this.element = null;
     }

package/build/plugin/v3/context.d.ts

@@ -1,7 +1,16 @@
+import { IMessage, ISendMessageDto, ISession } from '../../ai/types';
 import { ICustomTheme } from '../../theme';
+import { IPlan, IAvailableCredits } from '../../types/state/account.interfaces';
 import { ExportWindowState } from '../../types/state/window.interfaces';
 import { CreateActionOptions, CreatePanelOptions, PluginWindowState } from '../context/context.interface';
 import { PluginEvent, PluginEventCallback } from '../event/event.interfaces';
+export interface PluginUserInfo {
+    loggedIn: boolean;
+    name: string;
+    email: string;
+    avatar: string;
+    plan?: IPlan;
+}
 export interface PluginV3Context {
     /**
      * Returns data about a window (tab) in the app
@@ -75,5 +84,14 @@ export interface PluginV3Context {
      * Enable a theme in the app
      */
     enableTheme(name: string, darkMode?: boolean): Promise<void>;
+    getUserInfo(): Promise<PluginUserInfo | undefined>;
+    getAvailableCredits(): Promise<IAvailableCredits | undefined>;
+    getActiveAiSession(): Promise<ISession | undefined>;
+    createAiSession(): Promise<ISession | undefined>;
+    getAiSessionMessages(sessionId: string): Promise<IMessage[] | undefined>;
+    sendMessageToAiSession(sessionId: string, message: ISendMessageDto): Promise<{
+        response: string;
+    } | undefined>;
+    rateAiSessionMessage(sessionId: string, messageId: string, rating: number): Promise<IMessage | undefined>;
 }
 //# sourceMappingURL=context.d.ts.map

package/build/plugin/v3/frame-engine.js

@@ -102,6 +102,27 @@ export class PluginFrameEngine {
             enableTheme: (...args) => {
                 return this.worker.request('enableTheme', ...args);
             },
+            getUserInfo: async () => {
+                return this.worker.request('getUserInfo');
+            },
+            getAvailableCredits: async () => {
+                return this.worker.request('getAvailableCredits');
+            },
+            createAiSession: async (...args) => {
+                return this.worker.request('createAiSession', ...args);
+            },
+            getActiveAiSession: async (...args) => {
+                return this.worker.request('getActiveAiSession', ...args);
+            },
+            getAiSessionMessages: async (...args) => {
+                return this.worker.request('getAiSessionMessages', ...args);
+            },
+            sendMessageToAiSession: async (...args) => {
+                return this.worker.request('sendMessageToAiSession', ...args);
+            },
+            rateAiSessionMessage: async (...args) => {
+                return this.worker.request('rateAiSessionMessage', ...args);
+            },
         };
         this.ctx = ctx;
         return ctx;

package/build/plugin/v3/manifest.d.ts

@@ -8,7 +8,16 @@ interface PluginJsEntry {
     scripts: string[];
     styles: string[];
 }
-type PluginEntry = PluginHtmlEntry | PluginJsEntry;
+export type PluginEntry = PluginHtmlEntry | PluginJsEntry;
+interface PluginIconImage {
+    type: 'image';
+    url: string;
+}
+interface PluginIconSvg {
+    type: 'svg';
+    src: string;
+}
+export type PluginIcon = PluginIconImage | PluginIconSvg;
 export interface PluginV3Manifest {
     /**
      * Version of manifest (should be 3). It is a control measure for variations in the plugin versions
@@ -46,6 +55,14 @@ export interface PluginV3Manifest {
      * Name of the author of the plugin
      */
     author?: string;
+    /**
+     * The minimum version of Altair that the plugin is compatible with. This is useful for when the plugin uses features that are only available in a certain version of Altair
+     */
+    minimum_altair_version?: string;
+    /**
+     * The icon of the plugin. It can be an image or an SVG
+     */
+    icon?: PluginIcon;
 }
 export {};
 //# sourceMappingURL=manifest.d.ts.map

package/build/plugin/v3/parent-worker.d.ts

@@ -6,6 +6,7 @@ interface BasePluginParentWorkerOptions {
     instanceType?: InstanceType;
     additionalParams?: Record<string, string>;
     additionalSandboxAttributes?: string[];
+    width?: number;
 }
 interface PluginParentWorkerOptionsWithScripts extends BasePluginParentWorkerOptions {
     type: 'scripts';

package/build/plugin/v3/parent-worker.js

@@ -19,6 +19,10 @@ export class PluginParentWorker extends EvaluatorWorker {
             iframe.style.width = '100%';
             iframe.style.height = '100%';
             iframe.style.border = 'none';
+            iframe.style.display = 'block'; // fixes issue with vertical scrollbar appearing https://stackoverflow.com/a/9131632/3929126
+            if ('width' in this.opts && this.opts.width) {
+                iframe.style.minWidth = `${this.opts.width}px`;
+            }
         }
         else {
             iframe.style.display = 'none';

package/build/types/state/account.interfaces.d.ts

@@ -26,6 +26,11 @@ export interface IPlanInfo {
     currency: string;
     interval: string;
 }
+export interface IAvailableCredits {
+    fixed: number;
+    monthly: number;
+    total: number;
+}
 export interface AccountState {
     loggedIn: boolean;
     accessToken: string;
@@ -37,6 +42,7 @@ export interface AccountState {
     stats?: Stats;
     plan?: IPlan;
     planInfos?: IPlanInfo[];
+    availableCredits?: IAvailableCredits;
 }
 export declare class TeamId extends ValueObject<string> {
 }

package/build/utils/logger.js

@@ -5,6 +5,9 @@ export const createLogger = (environment) => {
     if (!environment.production) {
         loglevel.setLevel('TRACE');
     }
+    else {
+        loglevel.setLevel('ERROR');
+    }
     const PREVIOUS_VERSION_KEY = 'altair__debug_previous_version';
     const CURRENT_VERSION_KEY = 'altair__debug_current_version';
     const previousVersion = () => localStorage.getItem(PREVIOUS_VERSION_KEY);
@@ -32,6 +35,9 @@ export const createLogger = (environment) => {
                 console.groupEnd();
                 loglevel.setLevel('TRACE');
             }
+            else {
+                loglevel.setLevel('ERROR');
+            }
             window._ALTAIR__ENABLE_DEBUG_MODE__ = value;
         },
     });

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "altair-graphql-core",
   "description": "Several of the core logic for altair graphql client",
-  "version": "7.2.4",
+  "version": "7.3.3",
   "author": "Samuel Imolorhe <altair@sirmuel.design> (https://sirmuel.design)",
   "bugs": "https://github.com/altair-graphql/altair/issues",
   "dependencies": {
+    "@angular/platform-browser": "17.0.8",
     "@apollo/client": "3.3.20",
     "abab": "2.0.6",
     "actioncable": "5.2.6",
@@ -34,8 +35,10 @@
     "@angular/common": "17.0.8",
     "@jest/globals": "^29.7.0",
     "@types/actioncable": "^5.2.5",
+    "@types/color-name": "^1.1.4",
     "@types/crypto-js": "^4.0.1",
     "@types/jest": "^29.5.12",
+    "@types/json-bigint": "^1.0.1",
     "@types/node": "^14.14.41",
     "@types/uuid": "^9.0.5",
     "@typescript-eslint/eslint-plugin": "^7.4.0",
@@ -76,5 +79,5 @@
     "test": "jest"
   },
   "types": "./build/index.d.ts",
-  "gitHead": "99ad41572f40136876cff51027eca0e575092441"
+  "gitHead": "2891694162b28e2b394ae6f984de8e7fc1b15a3f"
 }