@ignos/api-client 20261027.327.1 → 20261028.329.1-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3014,6 +3014,10 @@ export interface IInspectSchemaCreatorClient {
3014
3014
  drawing to derive it from.
3015
3015
  */
3016
3016
  getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
3017
+ /**
3018
+ * Replaces the page grids; the response is the whole state with recomputed sheet zones.
3019
+ */
3020
+ saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto>;
3017
3021
  /**
3018
3022
  * Starts a full drawing AI parse: clears every element and locks the
3019
3023
  schema for every viewer until it completes. If one is already in
@@ -3021,7 +3025,7 @@ export interface IInspectSchemaCreatorClient {
3021
3025
  */
3022
3026
  requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
3023
3027
  /**
3024
- * Stamps the creator state's balloons onto the schema's drawing PDF and
3028
+ * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
3025
3029
  returns a temporary download link.
3026
3030
  */
3027
3031
  exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
@@ -3060,6 +3064,11 @@ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implem
3060
3064
  */
3061
3065
  getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
3062
3066
  protected processGetSchemaCreatorXmlGeometry(response: Response): Promise<SchemaCreatorXmlGeometryDto[]>;
3067
+ /**
3068
+ * Replaces the page grids; the response is the whole state with recomputed sheet zones.
3069
+ */
3070
+ saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto>;
3071
+ protected processSaveSchemaCreatorGrids(response: Response): Promise<SchemaCreatorStateDto>;
3063
3072
  /**
3064
3073
  * Starts a full drawing AI parse: clears every element and locks the
3065
3074
  schema for every viewer until it completes. If one is already in
@@ -3068,7 +3077,7 @@ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implem
3068
3077
  requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
3069
3078
  protected processRequestSchemaCreatorDocumentParse(response: Response): Promise<SchemaCreatorStateDto>;
3070
3079
  /**
3071
- * Stamps the creator state's balloons onto the schema's drawing PDF and
3080
+ * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
3072
3081
  returns a temporary download link.
3073
3082
  */
3074
3083
  exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
@@ -9600,6 +9609,7 @@ export interface ImaSpecificationLiteDto {
9600
9609
  export interface SchemaCreatorStateDto {
9601
9610
  settings: SchemaCreatorSettingsDto;
9602
9611
  elements: SchemaCreatorElementDto[];
9612
+ grids?: SchemaCreatorPageGridDto[];
9603
9613
  documentParseStatus?: SchemaCreatorDocumentParseStatusDto | null;
9604
9614
  isAutoGenerated?: boolean;
9605
9615
  createdBy?: SchemaCreatorAuditInfoDto | null;
@@ -9612,6 +9622,7 @@ export interface SchemaCreatorSettingsDto {
9612
9622
  tolerance?: GeneralToleranceDto;
9613
9623
  balloonSize?: number;
9614
9624
  transparentBalloons?: boolean;
9625
+ gridOnMarkedDrawing?: boolean;
9615
9626
  }
9616
9627
  export type SchemaCreatorUnitOfMeasureDto = "Millimeter" | "Inch" | "Mixed";
9617
9628
  export type GeneralToleranceDto = "NotSet" | "Fine" | "Medium" | "Coarse" | "VeryCoarse";
@@ -9654,6 +9665,7 @@ export interface SchemaCreatorSizeDto {
9654
9665
  }
9655
9666
  export interface SchemaCreatorElementValuesDto {
9656
9667
  reference: number;
9668
+ sheetZone?: string | null;
9657
9669
  group?: string | null;
9658
9670
  unit?: UnitOfMeasureDto | null;
9659
9671
  nominal?: number | null;
@@ -9687,6 +9699,20 @@ export interface SchemaCreatorAuditInfoDto {
9687
9699
  userId: string;
9688
9700
  userFullName?: string | null;
9689
9701
  }
9702
+ export interface SchemaCreatorPageGridDto {
9703
+ pageIndex: number;
9704
+ rows: number;
9705
+ columns: number;
9706
+ columnStartValue: number;
9707
+ columnOrder: SchemaCreatorGridOrderDto;
9708
+ rowStartValue: number;
9709
+ rowOrder: SchemaCreatorGridOrderDto;
9710
+ fontSize: number;
9711
+ labelPlacement?: SchemaCreatorGridLabelPlacementDto;
9712
+ frame: SchemaCreatorRectDto;
9713
+ }
9714
+ export type SchemaCreatorGridOrderDto = "Ascending" | "Descending";
9715
+ export type SchemaCreatorGridLabelPlacementDto = "Inside" | "Outside";
9690
9716
  export interface SchemaCreatorDocumentParseStatusDto {
9691
9717
  inProgress: boolean;
9692
9718
  attempt?: SchemaCreatorParseAttemptDto | null;
@@ -25380,6 +25380,51 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase {
25380
25380
  }
25381
25381
  return Promise.resolve(null);
25382
25382
  }
25383
+ /**
25384
+ * Replaces the page grids; the response is the whole state with recomputed sheet zones.
25385
+ */
25386
+ saveSchemaCreatorGrids(schemaVersionId, grids) {
25387
+ let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/grids";
25388
+ if (schemaVersionId === undefined || schemaVersionId === null)
25389
+ throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
25390
+ url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
25391
+ url_ = url_.replace(/[?&]$/, "");
25392
+ const content_ = JSON.stringify(grids);
25393
+ let options_ = {
25394
+ body: content_,
25395
+ method: "PUT",
25396
+ headers: {
25397
+ "Content-Type": "application/json",
25398
+ "Accept": "application/json"
25399
+ }
25400
+ };
25401
+ return this.transformOptions(options_).then(transformedOptions_ => {
25402
+ return this.http.fetch(url_, transformedOptions_);
25403
+ }).then((_response) => {
25404
+ return this.processSaveSchemaCreatorGrids(_response);
25405
+ });
25406
+ }
25407
+ processSaveSchemaCreatorGrids(response) {
25408
+ const status = response.status;
25409
+ let _headers = {};
25410
+ if (response.headers && response.headers.forEach) {
25411
+ response.headers.forEach((v, k) => _headers[k] = v);
25412
+ }
25413
+ ;
25414
+ if (status === 200) {
25415
+ return response.text().then((_responseText) => {
25416
+ let result200 = null;
25417
+ result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
25418
+ return result200;
25419
+ });
25420
+ }
25421
+ else if (status !== 200 && status !== 204) {
25422
+ return response.text().then((_responseText) => {
25423
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
25424
+ });
25425
+ }
25426
+ return Promise.resolve(null);
25427
+ }
25383
25428
  /**
25384
25429
  * Starts a full drawing AI parse: clears every element and locks the
25385
25430
  schema for every viewer until it completes. If one is already in
@@ -25425,7 +25470,7 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase {
25425
25470
  return Promise.resolve(null);
25426
25471
  }
25427
25472
  /**
25428
- * Stamps the creator state's balloons onto the schema's drawing PDF and
25473
+ * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
25429
25474
  returns a temporary download link.
25430
25475
  */
25431
25476
  exportSchemaCreatorDrawing(schemaVersionId) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ignos/api-client",
3
- "version": "20261027.327.1",
3
+ "version": "20261028.329.1-alpha",
4
4
  "description": "IGNOS API Client",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
@@ -26768,6 +26768,11 @@ export interface IInspectSchemaCreatorClient {
26768
26768
  */
26769
26769
  getSchemaCreatorXmlGeometry(schemaVersionId: string): Promise<SchemaCreatorXmlGeometryDto[]>;
26770
26770
 
26771
+ /**
26772
+ * Replaces the page grids; the response is the whole state with recomputed sheet zones.
26773
+ */
26774
+ saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto>;
26775
+
26771
26776
  /**
26772
26777
  * Starts a full drawing AI parse: clears every element and locks the
26773
26778
  schema for every viewer until it completes. If one is already in
@@ -26776,7 +26781,7 @@ export interface IInspectSchemaCreatorClient {
26776
26781
  requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
26777
26782
 
26778
26783
  /**
26779
- * Stamps the creator state's balloons onto the schema's drawing PDF and
26784
+ * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
26780
26785
  returns a temporary download link.
26781
26786
  */
26782
26787
  exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
@@ -26979,6 +26984,51 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IIn
26979
26984
  return Promise.resolve<SchemaCreatorXmlGeometryDto[]>(null as any);
26980
26985
  }
26981
26986
 
26987
+ /**
26988
+ * Replaces the page grids; the response is the whole state with recomputed sheet zones.
26989
+ */
26990
+ saveSchemaCreatorGrids(schemaVersionId: string, grids: SchemaCreatorPageGridDto[]): Promise<SchemaCreatorStateDto> {
26991
+ let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/grids";
26992
+ if (schemaVersionId === undefined || schemaVersionId === null)
26993
+ throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
26994
+ url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
26995
+ url_ = url_.replace(/[?&]$/, "");
26996
+
26997
+ const content_ = JSON.stringify(grids);
26998
+
26999
+ let options_: RequestInit = {
27000
+ body: content_,
27001
+ method: "PUT",
27002
+ headers: {
27003
+ "Content-Type": "application/json",
27004
+ "Accept": "application/json"
27005
+ }
27006
+ };
27007
+
27008
+ return this.transformOptions(options_).then(transformedOptions_ => {
27009
+ return this.http.fetch(url_, transformedOptions_);
27010
+ }).then((_response: Response) => {
27011
+ return this.processSaveSchemaCreatorGrids(_response);
27012
+ });
27013
+ }
27014
+
27015
+ protected processSaveSchemaCreatorGrids(response: Response): Promise<SchemaCreatorStateDto> {
27016
+ const status = response.status;
27017
+ let _headers: any = {}; if (response.headers && response.headers.forEach) { response.headers.forEach((v: any, k: any) => _headers[k] = v); };
27018
+ if (status === 200) {
27019
+ return response.text().then((_responseText) => {
27020
+ let result200: any = null;
27021
+ result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver) as SchemaCreatorStateDto;
27022
+ return result200;
27023
+ });
27024
+ } else if (status !== 200 && status !== 204) {
27025
+ return response.text().then((_responseText) => {
27026
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
27027
+ });
27028
+ }
27029
+ return Promise.resolve<SchemaCreatorStateDto>(null as any);
27030
+ }
27031
+
26982
27032
  /**
26983
27033
  * Starts a full drawing AI parse: clears every element and locks the
26984
27034
  schema for every viewer until it completes. If one is already in
@@ -27023,7 +27073,7 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IIn
27023
27073
  }
27024
27074
 
27025
27075
  /**
27026
- * Stamps the creator state's balloons onto the schema's drawing PDF and
27076
+ * Stamps the creator state's grids and balloons onto the schema's drawing PDF and
27027
27077
  returns a temporary download link.
27028
27078
  */
27029
27079
  exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto> {
@@ -39900,6 +39950,7 @@ export interface ImaSpecificationLiteDto {
39900
39950
  export interface SchemaCreatorStateDto {
39901
39951
  settings: SchemaCreatorSettingsDto;
39902
39952
  elements: SchemaCreatorElementDto[];
39953
+ grids?: SchemaCreatorPageGridDto[];
39903
39954
  documentParseStatus?: SchemaCreatorDocumentParseStatusDto | null;
39904
39955
  isAutoGenerated?: boolean;
39905
39956
  createdBy?: SchemaCreatorAuditInfoDto | null;
@@ -39913,6 +39964,7 @@ export interface SchemaCreatorSettingsDto {
39913
39964
  tolerance?: GeneralToleranceDto;
39914
39965
  balloonSize?: number;
39915
39966
  transparentBalloons?: boolean;
39967
+ gridOnMarkedDrawing?: boolean;
39916
39968
  }
39917
39969
 
39918
39970
  export type SchemaCreatorUnitOfMeasureDto = "Millimeter" | "Inch" | "Mixed";
@@ -39965,6 +40017,7 @@ export interface SchemaCreatorSizeDto {
39965
40017
 
39966
40018
  export interface SchemaCreatorElementValuesDto {
39967
40019
  reference: number;
40020
+ sheetZone?: string | null;
39968
40021
  group?: string | null;
39969
40022
  unit?: UnitOfMeasureDto | null;
39970
40023
  nominal?: number | null;
@@ -40005,6 +40058,23 @@ export interface SchemaCreatorAuditInfoDto {
40005
40058
  userFullName?: string | null;
40006
40059
  }
40007
40060
 
40061
+ export interface SchemaCreatorPageGridDto {
40062
+ pageIndex: number;
40063
+ rows: number;
40064
+ columns: number;
40065
+ columnStartValue: number;
40066
+ columnOrder: SchemaCreatorGridOrderDto;
40067
+ rowStartValue: number;
40068
+ rowOrder: SchemaCreatorGridOrderDto;
40069
+ fontSize: number;
40070
+ labelPlacement?: SchemaCreatorGridLabelPlacementDto;
40071
+ frame: SchemaCreatorRectDto;
40072
+ }
40073
+
40074
+ export type SchemaCreatorGridOrderDto = "Ascending" | "Descending";
40075
+
40076
+ export type SchemaCreatorGridLabelPlacementDto = "Inside" | "Outside";
40077
+
40008
40078
  export interface SchemaCreatorDocumentParseStatusDto {
40009
40079
  inProgress: boolean;
40010
40080
  attempt?: SchemaCreatorParseAttemptDto | null;