@octostar/platform-types 0.0.1 → 0.0.2-alpha.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Oleksandr Korzhov
+Copyright (c) 2024 Octostar Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/platform-types.d.ts

@@ -109,7 +109,7 @@ export declare type Behaviour = {
 };
 
 /** List of operators that require another operand that is a single value */
-declare const BINARY_OPERATORS: readonly ["==", "!=", ">", "<", ">=", "<=", "ILIKE", "LIKE", "REGEX", "TEMPORAL_RANGE"];
+declare const BINARY_OPERATORS: readonly ["==", "!=", ">", "<", ">=", "<=", "ILIKE", "LIKE", "REGEX", "IN_POLYGON", "TEMPORAL_RANGE"];
 
 /** An operator that requires another operand that is a single value */
 declare type BinaryOperator = typeof BINARY_OPERATORS[number];
@@ -193,7 +193,7 @@ export declare type ConnectedEntity = Entity & {
     concept_name: string;
 };
 
-export declare type ContextMenuGroup = 'add' | 'addto' | 'edit' | 'transform' | 'general' | 'open' | 'danger' | 'tags';
+export declare type ContextMenuGroup = 'add' | 'addto' | 'edit' | 'transform' | 'general' | 'open' | 'danger' | 'tags' | 'relations';
 
 export declare type ContextMenuLabels = {
     [group in ContextMenuGroup]?: string;
@@ -224,10 +224,30 @@ export declare type ContextMenuRequest = (ActionContext & {
 };
 
 export declare type CreateEntityFormProps = {
-    os_workspace: string;
+    os_workspace?: string;
     concept?: string;
 };
 
+export declare type CreateLinkChartFn = (params: CreateLinkChartParams) => Promise<void>;
+
+export declare type CreateLinkChartParams = {
+    path?: string;
+    name: string;
+    nodes?: Entity[];
+    edges?: EdgeSpec[];
+    draft?: boolean;
+    os_workspace?: string;
+};
+
+export declare type CreateRelationsDialogProps = {
+    source?: Entity;
+    os_workspace?: string;
+    target?: FocusListItem;
+    createRecord?: boolean;
+    relationName?: string;
+    defaultTargetConcept?: string;
+};
+
 export declare type CustomEventListener<L> = (payload: L) => void;
 
 export declare type CustomTemplate = TemplateMetadata & {
@@ -613,7 +633,7 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     setActiveWorkspace: (workspace: string | undefined) => Promise<void>;
     closeWorkspace: (ws: WorkspaceIdentifier) => Promise<void>;
     copy: (source: WorkspaceItem, target: WorkspaceItem) => Promise<WorkspaceItem[]>;
-    listAllWorkspaces: () => Promise<WorkspaceItem[]>;
+    listAllWorkspaces: (permissions?: WorkspacePermissionValue) => Promise<WorkspaceItem[]>;
     /**
      * This might not be enough, add a listener to {@link Desktop.onOpenWorkspacesChanged} to keep getting updated.
      * In react components, prefer {@link useDesktopWorkspaces} hook.
@@ -653,6 +673,8 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     getFilesTree: (workspace_or_folder: WorkspaceItem, options?: FileTreeOptions) => Promise<WorkspaceItem[]>;
     open(records: Entity | Entity[], options?: DesktopActionOptions): Promise<void>;
     delete: (item: WorkspaceRecordIdentifier | WorkspaceRecordIdentifier[], recurse?: boolean) => Promise<void>;
+    delete_workspace_records: (workspace_id: string) => Promise<void>;
+    delete_local_concept_records: (workspace_id: string, base_concept: string) => Promise<void>;
     searchXperience: (options?: SearchXperienceProps) => Promise<Entity[]>;
     showTab: (props: ShowTabProps) => Promise<void>;
     closeTab: (props: ShowTabProps) => Promise<void>;
@@ -665,6 +687,7 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
     showConfirm: (props: OsConfirmProps) => Promise<OS_CONFIRM_MODAL_RESPONSE>;
     showFileUpload: (folder: WorkspaceItem) => Promise<WorkspaceItem[]>;
     showCreateEntityForm: (props: CreateEntityFormProps) => Promise<OsWorkspaceEntity[]>;
+    showCreateRelationsDialog: (props: CreateRelationsDialogProps) => Promise<void>;
     getPasteContext: (options: PasteContextOptions) => Promise<Entity[]>;
     showModalTemplate: (props: ModalTemplateProps) => Promise<void>;
     addComment: (about: Entity, comment: AddCommentParams) => Promise<Entity>;
@@ -675,9 +698,14 @@ export declare interface Desktop extends DesktopSettings, WorkspaceChangeEmitter
         [os_workspace: string]: WorkspacePermission;
     }>;
     getUser: () => Promise<UserProfile>;
-    deployApp: (app: WorkspaceItem) => Promise<WorkspaceItem>;
+    deployApp: (app: WorkspaceItem, initialSecrets?: {
+        [key: string]: string;
+    }) => Promise<WorkspaceItem>;
     undeployApp: (app: WorkspaceItem) => Promise<WorkspaceItem>;
     whoami: () => Promise<Whoami>;
+    getFocusList: () => Promise<FocusListItem[]>;
+    addToFocusList: (entities: Entity[], type?: 'single' | 'group', tabName?: string) => Promise<FocusListItem[]>;
+    removeFromFocusList: (entities: Entity[], type?: 'single' | 'group', tabName?: string) => Promise<FocusListItem[]>;
 }
 
 export declare type DesktopAction = (context: DesktopActionContext) => any;
@@ -835,6 +863,10 @@ export declare type ExportOptions = {
     filename?: string;
 };
 
+export declare type ExtrasApi = {
+    createLinkChart: CreateLinkChartFn;
+};
+
 declare type FileCode = {
     file: string;
 };
@@ -859,6 +891,13 @@ declare type FilterReference = string | {
     ['require_all']: FilterReference[];
 };
 
+export declare type FocusListItem = {
+    entity: Entity;
+    count: number;
+    tabName?: string;
+    type?: 'single';
+} | NamedEntityGroup;
+
 export declare type FolderPasteOptions = {
     folders?: boolean;
     files?: boolean;
@@ -960,7 +999,6 @@ declare interface IGlobalAttributes {
     borderMinSize?: number;
     borderSize?: number;
     enableEdgeDock?: boolean;
-    enableRotateBorderIcons?: boolean;
     enableUseVisibility?: boolean;
     legacyOverflowMenu?: boolean;
     marginInsets?: IInsets;
@@ -971,7 +1009,6 @@ declare interface IGlobalAttributes {
     tabBorderWidth?: number;
     tabClassName?: string;
     tabCloseType?: ICloseType;
-    tabContentClassName?: string;
     tabDragSpeed?: number;
     tabEnableClose?: boolean;
     tabEnableDrag?: boolean;
@@ -989,7 +1026,6 @@ declare interface IGlobalAttributes {
     tabSetEnableDrag?: boolean;
     tabSetEnableDrop?: boolean;
     tabSetEnableMaximize?: boolean;
-    tabSetEnableSingleTabStretch?: boolean;
     tabSetEnableTabStrip?: boolean;
     tabSetHeaderHeight?: number;
     tabSetMarginInsets?: IInsets;
@@ -1033,6 +1069,8 @@ declare interface IJsonTabSetNode extends ITabSetAttributes {
 export declare type ImportZipOptions = {
     overwrite?: boolean;
     target?: string;
+    include_content?: boolean;
+    include_dashboards?: boolean | 'if_missing';
 };
 
 export declare interface Inheritance {
@@ -1060,8 +1098,6 @@ declare interface ITabAttributes {
     closeType?: ICloseType;
     component?: string;
     config?: any;
-    contentClassName?: string;
-    tabsetClassName?: string;
     enableClose?: boolean;
     enableDrag?: boolean;
     enableFloat?: boolean;
@@ -1089,7 +1125,6 @@ declare interface ITabSetAttributes {
     enableDrag?: boolean;
     enableDrop?: boolean;
     enableMaximize?: boolean;
-    enableSingleTabStretch?: boolean;
     enableTabStrip?: boolean;
     headerHeight?: number;
     height?: number;
@@ -1104,8 +1139,6 @@ declare interface ITabSetAttributes {
     type: "tabset";
     weight?: number;
     width?: number;
-    maximized?: boolean;
-    active?: boolean;
 }
 
 declare interface ItemSharedProps {
@@ -1224,7 +1257,6 @@ declare class Model {
     getRoot(): RowNode;
     isRootOrientationVertical(): boolean;
     isUseVisibility(): boolean;
-    isEnableRotateBorderIcons(): boolean;
     /**
      * Gets the
      * @returns {BorderSet|*}
@@ -1240,12 +1272,6 @@ declare class Model {
      * @param id the id to find
      */
     getNodeById(id: string): Node_2 | undefined;
-    /**
-     * Finds the first/top left tab set of the given node.
-     * @param node The top node you want to begin searching from, deafults to the root node
-     * @returns The first Tab Set
-     */
-    getFirstTabSet(node?: Node_2): Node_2;
     /**
      * Update the node tree by performing the given action,
      * Actions should be generated via static methods on the Actions class
@@ -1278,6 +1304,13 @@ declare class Model {
     toString(): string;
 }
 
+export declare type NamedEntityGroup = {
+    entity_label: string;
+    query: ConceptFilter;
+    count: number;
+    type: 'group';
+};
+
 declare abstract class Node_2 {
     getId(): string;
     getModel(): Model;
@@ -2371,7 +2404,7 @@ export declare interface Ontology {
     getConceptForEntity: (entity: Entity) => Promise<Concept | undefined>;
     getRelationshipsForEntity: (entity: Entity) => Promise<Relationship[]>;
     sendQuery: (query: string, options?: SendQueryOptions) => Promise<QueryResponse>;
-    sendQueryT: <T>(query: string, options?: SendQueryOptions) => Promise<T[]>;
+    sendQueryT: <T>(query: string, options?: SendQueryOptions, force_refresh?: boolean) => Promise<T[]>;
     getSysInheritance(): Promise<Inheritance[]>;
     subscribe: <T>(entity: Entity, callback: Callback<T>) => Promise<Unsubscribe>;
     consistentUUID: (name: string, namespace?: string) => Promise<string>;
@@ -4299,7 +4332,7 @@ declare class Rect {
     constructor(x: number, y: number, width: number, height: number);
     static fromElement(element: Element): Rect;
     clone(): Rect;
-    equals(rect: Rect | null | undefined): boolean;
+    equals(rect: Rect): boolean;
     getBottom(): number;
     getRight(): number;
     getCenter(): {
@@ -10627,7 +10660,6 @@ declare interface SubMenuType extends ItemSharedProps {
     onMouseLeave?: MenuHoverEventHandler;
     popupClassName?: string;
     popupOffset?: number[];
-    popupStyle?: React_2.CSSProperties;
     onClick?: MenuClickEventHandler;
     onTitleClick?: (info: MenuTitleInfo) => void;
     onTitleMouseEnter?: MenuHoverEventHandler;
@@ -10725,8 +10757,6 @@ declare class TabNode extends Node_2 implements IDraggable {
     isEnableDrag(): boolean;
     isEnableRename(): boolean;
     getClassName(): string | undefined;
-    getContentClassName(): string | undefined;
-    getTabSetClassName(): string | undefined;
     isEnableRenderOnDemand(): boolean;
     toJson(): IJsonTabNode;
 }
@@ -10757,7 +10787,6 @@ declare class TabSetNode extends Node_2 implements IDraggable, IDropTarget {
     isEnableDivide(): boolean;
     isEnableMaximize(): boolean;
     isEnableClose(): boolean;
-    isEnableSingleTabStretch(): boolean;
     canMaximize(): boolean;
     isEnableTabStrip(): boolean;
     isAutoSelectTab(): boolean;
@@ -12808,6 +12837,7 @@ export declare type Whoami = {
     email: string | null;
     os_jwt: string;
     username: string;
+    timbr_roles: string[];
 };
 
 export declare type WithProgressBarOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octostar/platform-types",
-  "version": "0.0.1",
+  "version": "0.0.2-alpha.0",
   "description": "Types for the API exposed by Octostar platform to third parties",
   "keywords": [
     "octostar",
@@ -29,7 +29,7 @@
     "antd": "^4.24.8",
     "antd5": "npm:antd@^5.10.3",
     "csstype": "^3.1.3",
-    "flexlayout-react": "^0.7.15",
+    "flexlayout-react": "github:Octostarco/flexlayout-react#multi-window-drag-drop",
     "rc-menu": "^9.8.2",
     "rimraf": "^5.0.5"
   },
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0b301a354cbacd253d138bcb828888ac4df82120"
+  "gitHead": "3c66984cab2d4035b09eec776c871937a5ec8b18"
 }