@ignos/api-client 20261026.324.1 → 20261027.326.1-alpha

package/lib/ignosportal-api.d.ts

@@ -2999,6 +2999,10 @@ export interface IInspectSchemaCreatorClient {
     drawing to derive it from.
      */
     getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
+    /**
+     * Replaces the page grids; the response is the whole state with recomputed sheet zones.
+     */
+    saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto>;
     /**
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
@@ -3006,7 +3010,7 @@ export interface IInspectSchemaCreatorClient {
      */
     requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
     /**
-     * Stamps the creator state's balloons onto the schema's drawing PDF and
+     * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
     returns a temporary download link.
      */
     exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
@@ -3045,6 +3049,11 @@ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implem
      */
     getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
     protected processGetSchemaCreatorXmlGeometry(response: Response): Promise<SchemaCreatorXmlGeometryDto[]>;
+    /**
+     * Replaces the page grids; the response is the whole state with recomputed sheet zones.
+     */
+    saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto>;
+    protected processSaveSchemaCreatorGrids(response: Response): Promise<SchemaCreatorStateDto>;
     /**
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
@@ -3053,7 +3062,7 @@ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implem
     requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
     protected processRequestSchemaCreatorDocumentParse(response: Response): Promise<SchemaCreatorStateDto>;
     /**
-     * Stamps the creator state's balloons onto the schema's drawing PDF and
+     * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
     returns a temporary download link.
      */
     exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
@@ -9577,6 +9586,7 @@ export interface ImaSpecificationLiteDto {
 export interface SchemaCreatorStateDto {
     settings: SchemaCreatorSettingsDto;
     elements: SchemaCreatorElementDto[];
+    grids?: SchemaCreatorPageGridDto[];
     documentParseStatus?: SchemaCreatorDocumentParseStatusDto | null;
     isAutoGenerated?: boolean;
     createdBy?: SchemaCreatorAuditInfoDto | null;
@@ -9631,6 +9641,7 @@ export interface SchemaCreatorSizeDto {
 }
 export interface SchemaCreatorElementValuesDto {
     reference: number;
+    sheetZone?: string | null;
     group?: string | null;
     unit?: UnitOfMeasureDto | null;
     nominal?: number | null;
@@ -9664,6 +9675,18 @@ export interface SchemaCreatorAuditInfoDto {
     userId: string;
     userFullName?: string | null;
 }
+export interface SchemaCreatorPageGridDto {
+    pageIndex: number;
+    rows: number;
+    columns: number;
+    startValue: number;
+    order: SchemaCreatorGridOrderDto;
+    fontSize: number;
+    labelPlacement?: SchemaCreatorGridLabelPlacementDto;
+    frame: SchemaCreatorRectDto;
+}
+export type SchemaCreatorGridOrderDto = "Ascending" | "Descending";
+export type SchemaCreatorGridLabelPlacementDto = "Inside" | "Outside";
 export interface SchemaCreatorDocumentParseStatusDto {
     inProgress: boolean;
     attempt?: SchemaCreatorParseAttemptDto | null;

package/lib/ignosportal-api.js

@@ -25296,6 +25296,51 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Replaces the page grids; the response is the whole state with recomputed sheet zones.
+     */
+    saveSchemaCreatorGrids(schemaVersionId, grids) {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/grids";
+        if (schemaVersionId === undefined || schemaVersionId === null)
+            throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
+        url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(grids);
+        let options_ = {
+            body: content_,
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "Accept": "application/json"
+            }
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response) => {
+            return this.processSaveSchemaCreatorGrids(_response);
+        });
+    }
+    processSaveSchemaCreatorGrids(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
     /**
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
@@ -25341,7 +25386,7 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase {
         return Promise.resolve(null);
     }
     /**
-     * Stamps the creator state's balloons onto the schema's drawing PDF and
+     * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
     returns a temporary download link.
      */
     exportSchemaCreatorDrawing(schemaVersionId) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ignos/api-client",
-  "version": "20261026.324.1",
+  "version": "20261027.326.1-alpha",
   "description": "IGNOS API Client",
   "type": "module",
   "main": "lib/index.js",

package/src/ignosportal-api.ts

@@ -26676,6 +26676,11 @@ export interface IInspectSchemaCreatorClient {
      */
     getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
 
+    /**
+     * Replaces the page grids; the response is the whole state with recomputed sheet zones.
+     */
+    saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto>;
+
     /**
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
@@ -26684,7 +26689,7 @@ export interface IInspectSchemaCreatorClient {
     requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
 
     /**
-     * Stamps the creator state's balloons onto the schema's drawing PDF and
+     * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
     returns a temporary download link.
      */
     exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
@@ -26887,6 +26892,51 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IIn
         return Promise.resolve<SchemaCreatorXmlGeometryDto[]>(null as any);
     }
 
+    /**
+     * Replaces the page grids; the response is the whole state with recomputed sheet zones.
+     */
+    saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto> {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/grids";
+        if (schemaVersionId === undefined || schemaVersionId === null)
+            throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
+        url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
+        url_ = url_.replace(/[?&]$/, "");
+
+        const content_ = JSON.stringify(grids);
+
+        let options_: RequestInit = {
+            body: content_,
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "Accept": "application/json"
+            }
+        };
+
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response: Response) => {
+            return this.processSaveSchemaCreatorGrids(_response);
+        });
+    }
+
+    protected processSaveSchemaCreatorGrids(response: Response): Promise<SchemaCreatorStateDto> {
+        const status = response.status;
+        let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+            let result200: any = null;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver) as SchemaCreatorStateDto;
+            return result200;
+            });
+        } else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve<SchemaCreatorStateDto>(null as any);
+    }
+
     /**
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
@@ -26931,7 +26981,7 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IIn
     }
 
     /**
-     * Stamps the creator state's balloons onto the schema's drawing PDF and
+     * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
     returns a temporary download link.
      */
     exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto> {
@@ -39798,6 +39848,7 @@ export interface ImaSpecificationLiteDto {
 export interface SchemaCreatorStateDto {
     settings: SchemaCreatorSettingsDto;
     elements: SchemaCreatorElementDto[];
+    grids?: SchemaCreatorPageGridDto[];
     documentParseStatus?: SchemaCreatorDocumentParseStatusDto | null;
     isAutoGenerated?: boolean;
     createdBy?: SchemaCreatorAuditInfoDto | null;
@@ -39863,6 +39914,7 @@ export interface SchemaCreatorSizeDto {
 
 export interface SchemaCreatorElementValuesDto {
     reference: number;
+    sheetZone?: string | null;
     group?: string | null;
     unit?: UnitOfMeasureDto | null;
     nominal?: number | null;
@@ -39903,6 +39955,21 @@ export interface SchemaCreatorAuditInfoDto {
     userFullName?: string | null;
 }
 
+export interface SchemaCreatorPageGridDto {
+    pageIndex: number;
+    rows: number;
+    columns: number;
+    startValue: number;
+    order: SchemaCreatorGridOrderDto;
+    fontSize: number;
+    labelPlacement?: SchemaCreatorGridLabelPlacementDto;
+    frame: SchemaCreatorRectDto;
+}
+
+export type SchemaCreatorGridOrderDto = "Ascending" | "Descending";
+
+export type SchemaCreatorGridLabelPlacementDto = "Inside" | "Outside";
+
 export interface SchemaCreatorDocumentParseStatusDto {
     inProgress: boolean;
     attempt?: SchemaCreatorParseAttemptDto | null;