bruce-models 7.1.80 → 7.1.82

package/dist/types/entity/entity-type-relation.d.ts

@@ -0,0 +1,68 @@
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+import { EntityType } from "./entity-type";
+/**
+ * Describes the "Entity Type Relation" concept within Nextspace.
+ * An Entity Type Relation registers a relationship that may exist between entities of two specified Entity Types.
+ */
+export declare namespace EntityTypeRelation {
+    /**
+     * Describes an Entity Type Relation record.
+     */
+    interface IRelation extends EntityType.IEntityTypeRelation {
+    }
+    /**
+     * Gets a single Entity Type Relation record.
+     * This calls: GET entityType/{entityType_id}/relation/{entity_type_relation_id}
+     */
+    function Get(params: {
+        api?: BruceApi.Api;
+        entityTypeId: string;
+        entityTypeRelationId: string | number;
+        req?: Api.IReqParams;
+    }): Promise<{
+        relation: IRelation;
+    }>;
+    /**
+     * Gets Entity Type Relation records for the specified Entity Type.
+     * This calls: GET entityType/{entityType_id}/relations
+     */
+    function GetList(params: {
+        api?: BruceApi.Api;
+        entityTypeId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        relations: IRelation[];
+    }>;
+    /**
+     * Creates or updates an Entity Type Relation record.
+     * This calls: POST entityType/{entityType_id}/relation/{entity_type_relation_id}
+     */
+    function Update(params: {
+        api?: BruceApi.Api;
+        entityTypeId: string;
+        relation: IRelation;
+        entityTypeRelationId?: string | number;
+        req?: Api.IReqParams;
+    }): Promise<{
+        relation: IRelation;
+    }>;
+    /**
+     * Deletes an Entity Type Relation record.
+     * This calls: DELETE entityType/{entityType_id}/relation/{entity_type_relation_id}
+     */
+    function Delete(params: {
+        api?: BruceApi.Api;
+        entityTypeId: string;
+        entityTypeRelationId: string | number;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    /**
+     * Returns cache identifier for an Entity Type Relation record.
+     */
+    function GetCacheKey(entityTypeId: string, entityTypeRelationId: string | number): string;
+    /**
+     * Returns cache identifier for the list of Entity Type Relation records for an Entity Type.
+     */
+    function GetListCacheKey(entityTypeId: string): string;
+}

package/dist/types/entity/entity-type.d.ts

@@ -151,7 +151,7 @@ export declare namespace EntityType {
         };
         Result?: any;
         ExportResult?: any;
-        EntityTypeOntology?: any;
+        EntityTypeOntology?: IEntityTypeOntology;
         Warnings?: string[];
         Errors?: string[];
         [key: string]: any;
@@ -165,7 +165,7 @@ export declare namespace EntityType {
         tempFileUrl?: string;
         clientFileId?: string;
         clientFileUrl?: string;
-        entityTypeOntology?: any;
+        entityTypeOntology?: IEntityTypeOntology;
         warnings?: string[];
         errors?: string[];
         raw: IExportOntologyRawRes | null;
@@ -212,6 +212,33 @@ export declare namespace EntityType {
         Notes?: string;
         [key: string]: any;
     }
+    /**
+     * Describes an Entity Type Relation record.
+     */
+    interface IEntityTypeRelation {
+        ID?: number;
+        "A.EntityType.ID"?: string;
+        "B.EntityType.ID"?: string;
+        "EntityRelationType.ID"?: string;
+        "A.ForeignKey.AttributePath"?: string;
+        "B.ForeignKey.AttributePath"?: string;
+        "A.Cardinality.Min"?: number;
+        "A.Cardinality.Max"?: number;
+        "B.Cardinality.Min"?: number;
+        "B.Cardinality.Max"?: number;
+        EntityRelationType?: any;
+        EntityTypeA?: IType;
+        EntityTypeB?: IType;
+        [key: string]: any;
+    }
+    /**
+     * Entity Type ontology payload.
+     */
+    interface IEntityTypeOntology {
+        EntityType?: IType[];
+        EntityTypeRelation?: IEntityTypeRelation[];
+        [key: string]: any;
+    }
     /**
      * Entity Type-level mapping returned by the AI optimisation endpoint.
      */
@@ -231,7 +258,7 @@ export declare namespace EntityType {
      */
     interface IAISuggestOntologyOptimisationSuggestedOntology {
         EntityType?: IAISuggestOntologyOptimisationSuggestedEntityType[];
-        EntityTypeRelation?: any[];
+        EntityTypeRelation?: IEntityTypeRelation[];
         [key: string]: any;
     }
     /**
@@ -296,8 +323,7 @@ export declare namespace EntityType {
      * Suggested relation item returned in the pending-action result.
      * This endpoint may evolve, so unknown fields are preserved.
      */
-    interface ISuggestedRelation {
-        [key: string]: any;
+    interface ISuggestedRelation extends IEntityTypeRelation {
     }
     /**
      * Normalized pending-action result payload produced by FindSuggestedRelations.

package/dist/types/export/entity-export.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Shared Entity export request shapes.
+ */
+export declare namespace EntityExport {
+    /**
+     * Optional explicit column selection shared by CSV and XLSX Entity exports.
+     *
+     * If omitted, Bruce API exports columns from the Entity Type Data Schema.
+     */
+    interface IColumnSettings {
+        Columns: IColumn[];
+    }
+    interface IColumn {
+        AttributePath: string;
+        ColumnTitle: string;
+    }
+}

package/dist/types/export/export-csv.d.ts

@@ -0,0 +1,39 @@
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+import { EntityExport } from "./entity-export";
+export declare namespace ExportCsv {
+    interface IExportParams {
+        BruceEntityType: string;
+        OrderBy?: string;
+        SortOrder?: Api.ESortOrderStr | Api.ESortOrder | string;
+        Filter?: string;
+        LODType?: string;
+        ZIP?: boolean;
+        ColumnSettings?: EntityExport.IColumnSettings;
+    }
+    interface IExportEntitiesParams {
+        EntityIDs: string[];
+        ColumnSettings?: EntityExport.IColumnSettings;
+        [key: string]: any;
+    }
+    /**
+     * Exports CSV for Entities selected by Filter.
+     * This calls: GET entities/ExportCSV
+     */
+    function Export(params: {
+        api?: BruceApi.Api;
+        fileExport: IExportParams;
+        req?: Api.IReqParams;
+    }): Promise<any>;
+    /**
+     * Exports CSV for a provided list of Entity IDs.
+     * This calls: POST entities/ExportCSV/{entityType_ID}
+     */
+    function ExportEntities(params: {
+        api?: BruceApi.Api;
+        entityTypeId: string;
+        fileExport: IExportEntitiesParams;
+        zip?: boolean;
+        req?: Api.IReqParams;
+    }): Promise<any>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "7.1.80",
+    "version": "7.1.82",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",