@ignos/api-client 20261020.315.1 → 20261022.317.1-alpha

package/lib/ignosportal-api.d.ts

@@ -2989,6 +2989,10 @@ export interface IInspectSchemaCreatorClient {
      */
     createSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
     updateSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
+    /**
+     * Saves only what changed; the response is the whole state with server-derived values.
+     */
+    applySchemaCreatorChanges(schemaVersionId: string, changes: SchemaCreatorChangesDto): Promise<SchemaCreatorStateDto>;
     /**
      * Geometry only (no values), derived from the schema's retained
     InspectionXpert XML - used to seed a not-yet-created state with real
@@ -3000,8 +3004,9 @@ export interface IInspectSchemaCreatorClient {
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
     progress, returns that instead of starting a second one.
+     * @param applyInPortal (optional) The client relies on Portal applying the result and enforcing its deadline.
      */
-    requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
+    requestSchemaCreatorDocumentParse(schemaVersionId: string, applyInPortal: boolean | undefined): Promise<SchemaCreatorStateDto>;
     /**
      * Stamps the creator state's balloons onto the schema's drawing PDF and
     returns a temporary download link.
@@ -3009,10 +3014,12 @@ export interface IInspectSchemaCreatorClient {
     exportSchemaCreatorDrawing(schemaVersionId: string): Promise<DownloadDto>;
     /**
      * Starts an async snip resolve; the result is delivered through the
-    SchemaCreatorSnipResolved SignalR notification.
+    SchemaCreatorSnipResolved SignalR notification, or SchemaCreatorRegionResolved when the snip
+    held several elements.
+     * @param applyInPortal (optional) The client relies on Portal applying the result, its deadline and region parse.
      * @param image (optional)
      */
-    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void>;
+    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, applyInPortal: boolean | undefined, image: FileParameter | null | undefined): Promise<void>;
 }
 export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implements IInspectSchemaCreatorClient {
     private http;
@@ -3030,6 +3037,11 @@ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implem
     protected processCreateSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
     updateSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
     protected processUpdateSchemaCreatorState(response: Response): Promise<SchemaCreatorStateDto>;
+    /**
+     * Saves only what changed; the response is the whole state with server-derived values.
+     */
+    applySchemaCreatorChanges(schemaVersionId: string, changes: SchemaCreatorChangesDto): Promise<SchemaCreatorStateDto>;
+    protected processApplySchemaCreatorChanges(response: Response): Promise<SchemaCreatorStateDto>;
     /**
      * Geometry only (no values), derived from the schema's retained
     InspectionXpert XML - used to seed a not-yet-created state with real
@@ -3042,8 +3054,9 @@ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implem
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
     progress, returns that instead of starting a second one.
+     * @param applyInPortal (optional) The client relies on Portal applying the result and enforcing its deadline.
      */
-    requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
+    requestSchemaCreatorDocumentParse(schemaVersionId: string, applyInPortal: boolean | undefined): Promise<SchemaCreatorStateDto>;
     protected processRequestSchemaCreatorDocumentParse(response: Response): Promise<SchemaCreatorStateDto>;
     /**
      * Stamps the creator state's balloons onto the schema's drawing PDF and
@@ -3053,10 +3066,12 @@ export declare class InspectSchemaCreatorClient extends AuthorizedApiBase implem
     protected processExportSchemaCreatorDrawing(response: Response): Promise<DownloadDto>;
     /**
      * Starts an async snip resolve; the result is delivered through the
-    SchemaCreatorSnipResolved SignalR notification.
+    SchemaCreatorSnipResolved SignalR notification, or SchemaCreatorRegionResolved when the snip
+    held several elements.
+     * @param applyInPortal (optional) The client relies on Portal applying the result, its deadline and region parse.
      * @param image (optional)
      */
-    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void>;
+    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, applyInPortal: boolean | undefined, image: FileParameter | null | undefined): Promise<void>;
     protected processRequestSchemaCreatorSnipParse(response: Response): Promise<void>;
 }
 export interface IMeasurementFormSchemasAdminClient {
@@ -9641,6 +9656,7 @@ export interface SchemaCreatorElementValuesDto {
     canCopy: boolean;
     visibleToCustomer: boolean;
     isDocumentedExternally: boolean;
+    hiddenOnDrawing?: boolean;
 }
 export type UnitOfMeasureDto = "Millimeter" | "Inch";
 export type ToleranceSourceDto = "FitDesignation" | "GeneralTolerance";
@@ -9676,6 +9692,13 @@ export interface SchemaCreatorXmlGeometryDto {
     balloon: SchemaCreatorPointDto;
     pageIndex: number;
 }
+export interface SchemaCreatorChangesDto {
+    upserts?: SchemaCreatorElementDto[];
+    deletes?: string[];
+    order?: string[] | null;
+    settings?: SchemaCreatorSettingsDto | null;
+    recalculateGeneralTolerances?: boolean;
+}
 export interface MeasurementFormSchemaDto {
     id: string;
     versionId: number;

package/lib/ignosportal-api.js

@@ -25248,6 +25248,51 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Saves only what changed; the response is the whole state with server-derived values.
+     */
+    applySchemaCreatorChanges(schemaVersionId, changes) {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate";
+        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(changes);
+        let options_ = {
+            body: content_,
+            method: "PATCH",
+            headers: {
+                "Content-Type": "application/json",
+                "Accept": "application/json"
+            }
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.http.fetch(url_, transformedOptions_);
+        }).then((_response) => {
+            return this.processApplySchemaCreatorChanges(_response);
+        });
+    }
+    processApplySchemaCreatorChanges(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);
+    }
     /**
      * Geometry only (no values), derived from the schema's retained
     InspectionXpert XML - used to seed a not-yet-created state with real
@@ -25297,12 +25342,17 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase {
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
     progress, returns that instead of starting a second one.
+     * @param applyInPortal (optional) The client relies on Portal applying the result and enforcing its deadline.
      */
-    requestSchemaCreatorDocumentParse(schemaVersionId) {
-        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/parse-document";
+    requestSchemaCreatorDocumentParse(schemaVersionId, applyInPortal) {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/parse-document?";
         if (schemaVersionId === undefined || schemaVersionId === null)
             throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
         url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
+        if (applyInPortal === null)
+            throw new globalThis.Error("The parameter 'applyInPortal' cannot be null.");
+        else if (applyInPortal !== undefined)
+            url_ += "applyInPortal=" + encodeURIComponent("" + applyInPortal) + "&";
         url_ = url_.replace(/[?&]$/, "");
         let options_ = {
             method: "POST",
@@ -25382,17 +25432,23 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase {
     }
     /**
      * Starts an async snip resolve; the result is delivered through the
-    SchemaCreatorSnipResolved SignalR notification.
+    SchemaCreatorSnipResolved SignalR notification, or SchemaCreatorRegionResolved when the snip
+    held several elements.
+     * @param applyInPortal (optional) The client relies on Portal applying the result, its deadline and region parse.
      * @param image (optional)
      */
-    requestSchemaCreatorSnipParse(schemaVersionId, elementId, image) {
-        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/elements/{elementId}/parse-snip";
+    requestSchemaCreatorSnipParse(schemaVersionId, elementId, applyInPortal, image) {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/elements/{elementId}/parse-snip?";
         if (schemaVersionId === undefined || schemaVersionId === null)
             throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
         url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
         if (elementId === undefined || elementId === null)
             throw new globalThis.Error("The parameter 'elementId' must be defined.");
         url_ = url_.replace("{elementId}", encodeURIComponent("" + elementId));
+        if (applyInPortal === null)
+            throw new globalThis.Error("The parameter 'applyInPortal' cannot be null.");
+        else if (applyInPortal !== undefined)
+            url_ += "applyInPortal=" + encodeURIComponent("" + applyInPortal) + "&";
         url_ = url_.replace(/[?&]$/, "");
         const content_ = new FormData();
         if (image !== null && image !== undefined)

package/package.json

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

package/src/ignosportal-api.ts

@@ -26665,6 +26665,11 @@ export interface IInspectSchemaCreatorClient {
 
     updateSchemaCreatorState(schemaVersionId: string, state: SchemaCreatorStateDto): Promise<SchemaCreatorStateDto>;
 
+    /**
+     * Saves only what changed; the response is the whole state with server-derived values.
+     */
+    applySchemaCreatorChanges(schemaVersionId: string, changes: SchemaCreatorChangesDto): Promise<SchemaCreatorStateDto>;
+
     /**
      * Geometry only (no values), derived from the schema's retained
     InspectionXpert XML - used to seed a not-yet-created state with real
@@ -26677,8 +26682,9 @@ export interface IInspectSchemaCreatorClient {
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
     progress, returns that instead of starting a second one.
+     * @param applyInPortal (optional) The client relies on Portal applying the result and enforcing its deadline.
      */
-    requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto>;
+    requestSchemaCreatorDocumentParse(schemaVersionId: string, applyInPortal: boolean | undefined): Promise<SchemaCreatorStateDto>;
 
     /**
      * Stamps the creator state's balloons onto the schema's drawing PDF and
@@ -26688,10 +26694,12 @@ export interface IInspectSchemaCreatorClient {
 
     /**
      * Starts an async snip resolve; the result is delivered through the
-    SchemaCreatorSnipResolved SignalR notification.
+    SchemaCreatorSnipResolved SignalR notification, or SchemaCreatorRegionResolved when the snip
+    held several elements.
+     * @param applyInPortal (optional) The client relies on Portal applying the result, its deadline and region parse.
      * @param image (optional) 
      */
-    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void>;
+    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, applyInPortal: boolean | undefined, image: FileParameter | null | undefined): Promise<void>;
 }
 
 export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IInspectSchemaCreatorClient {
@@ -26836,6 +26844,51 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IIn
         return Promise.resolve<SchemaCreatorStateDto>(null as any);
     }
 
+    /**
+     * Saves only what changed; the response is the whole state with server-derived values.
+     */
+    applySchemaCreatorChanges(schemaVersionId: string, changes: SchemaCreatorChangesDto): Promise<SchemaCreatorStateDto> {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate";
+        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(changes);
+
+        let options_: RequestInit = {
+            body: content_,
+            method: "PATCH",
+            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.processApplySchemaCreatorChanges(_response);
+        });
+    }
+
+    protected processApplySchemaCreatorChanges(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);
+    }
+
     /**
      * Geometry only (no values), derived from the schema's retained
     InspectionXpert XML - used to seed a not-yet-created state with real
@@ -26884,12 +26937,17 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IIn
      * Starts a full drawing AI parse: clears every element and locks the
     schema for every viewer until it completes. If one is already in
     progress, returns that instead of starting a second one.
+     * @param applyInPortal (optional) The client relies on Portal applying the result and enforcing its deadline.
      */
-    requestSchemaCreatorDocumentParse(schemaVersionId: string): Promise<SchemaCreatorStateDto> {
-        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/parse-document";
+    requestSchemaCreatorDocumentParse(schemaVersionId: string, applyInPortal: boolean | undefined): Promise<SchemaCreatorStateDto> {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/parse-document?";
         if (schemaVersionId === undefined || schemaVersionId === null)
             throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
         url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
+        if (applyInPortal === null)
+            throw new globalThis.Error("The parameter 'applyInPortal' cannot be null.");
+        else if (applyInPortal !== undefined)
+            url_ += "applyInPortal=" + encodeURIComponent("" + applyInPortal) + "&";
         url_ = url_.replace(/[?&]$/, "");
 
         let options_: RequestInit = {
@@ -26967,17 +27025,23 @@ export class InspectSchemaCreatorClient extends AuthorizedApiBase implements IIn
 
     /**
      * Starts an async snip resolve; the result is delivered through the
-    SchemaCreatorSnipResolved SignalR notification.
+    SchemaCreatorSnipResolved SignalR notification, or SchemaCreatorRegionResolved when the snip
+    held several elements.
+     * @param applyInPortal (optional) The client relies on Portal applying the result, its deadline and region parse.
      * @param image (optional) 
      */
-    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, image: FileParameter | null | undefined): Promise<void> {
-        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/elements/{elementId}/parse-snip";
+    requestSchemaCreatorSnipParse(schemaVersionId: string, elementId: string, applyInPortal: boolean | undefined, image: FileParameter | null | undefined): Promise<void> {
+        let url_ = this.baseUrl + "/measurementforms/schemas/{schemaVersionId}/creatorstate/elements/{elementId}/parse-snip?";
         if (schemaVersionId === undefined || schemaVersionId === null)
             throw new globalThis.Error("The parameter 'schemaVersionId' must be defined.");
         url_ = url_.replace("{schemaVersionId}", encodeURIComponent("" + schemaVersionId));
         if (elementId === undefined || elementId === null)
             throw new globalThis.Error("The parameter 'elementId' must be defined.");
         url_ = url_.replace("{elementId}", encodeURIComponent("" + elementId));
+        if (applyInPortal === null)
+            throw new globalThis.Error("The parameter 'applyInPortal' cannot be null.");
+        else if (applyInPortal !== undefined)
+            url_ += "applyInPortal=" + encodeURIComponent("" + applyInPortal) + "&";
         url_ = url_.replace(/[?&]$/, "");
 
         const content_ = new FormData();
@@ -39873,6 +39937,7 @@ export interface SchemaCreatorElementValuesDto {
     canCopy: boolean;
     visibleToCustomer: boolean;
     isDocumentedExternally: boolean;
+    hiddenOnDrawing?: boolean;
 }
 
 export type UnitOfMeasureDto = "Millimeter" | "Inch";
@@ -39918,6 +39983,14 @@ export interface SchemaCreatorXmlGeometryDto {
     pageIndex: number;
 }
 
+export interface SchemaCreatorChangesDto {
+    upserts?: SchemaCreatorElementDto[];
+    deletes?: string[];
+    order?: string[] | null;
+    settings?: SchemaCreatorSettingsDto | null;
+    recalculateGeneralTolerances?: boolean;
+}
+
 export interface MeasurementFormSchemaDto {
     id: string;
     versionId: number;