@camunda8/sdk 8.4.0 → 8.4.1

package/dist/modeler/lib/ModelerAPIClient.d.ts

@@ -0,0 +1,210 @@
+import { CamundaPlatform8Configuration, DeepPartial } from '../../lib';
+import { IOAuthProvider } from '../../oauth';
+import * as Dto from './ModelerDto';
+export declare class ModelerApiClient {
+    private userAgentString;
+    private oAuthProvider;
+    private rest;
+    constructor(options?: {
+        config?: DeepPartial<CamundaPlatform8Configuration>;
+        oAuthProvider?: IOAuthProvider;
+    });
+    private getHeaders;
+    private decodeResponseOrThrow;
+    /**
+     * Adds a new collaborator to a project or modifies the permission level of an existing collaborator.
+     * Note: Only users that are part of the authorized organization (see GET /api/v1/info) and logged in to Web Modeler at least once can be added to a project.
+     */
+    addCollaborator(req: Dto.CreateCollaboratorDto): Promise<null>;
+    /**
+     * Searches for collaborators.
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     * page specifies the page number to return.
+     * size specifies the number of items per page. The default value is 10.
+     */
+    searchCollaborators(req: Dto.PubSearchDtoProjectCollaboratorDto): Promise<Dto.PubSearchResultDtoProjectCollaboratorDto>;
+    deleteCollaborator({ email, projectId, }: {
+        projectId: string;
+        email: string;
+    }): Promise<null>;
+    /**
+     * This endpoint creates a file.
+     *
+     * To create a file, specify projectId and/or folderId:
+     *
+     * When only folderId is given, the file will be created in that folder. The folder can be in any project of the same organization.
+     *
+     * When projectId is given and folderId is either null or omitted altogether, the file will be created in the root of the project.
+     *
+     * When projectId and folderId are both given, they must be consistent - i.e. the folder is in the project.
+     *
+     * For connector templates, the following constraints apply:
+     *
+     * The value of content.$schema will be replaced with https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json and validated against it.
+     *
+     * The value of name takes precedence over content.name. In case of mismatch, the latter will be adjusted to match the former automatically.
+     *
+     * The value of content.id will be replaced with the file id generated by Web Modeler.
+     *
+     * The value of content.version is managed by Web Modeler and will be updated automatically.
+     *
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     */
+    createFile(req: Dto.CreateFileDto): Promise<Dto.FileMetadataDto>;
+    /**
+     * Retrieves a file.
+     *
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an
+     * escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping
+     * facilitates the processing of path-like structures within file and folder names.
+     *
+     * Does this throw if it is not found?
+     */
+    getFile(fileId: string): Promise<Dto.FileDto>;
+    /**
+     * Deletes a file.
+     * Note: Deleting a file will also delete other resources attached to the file (comments, call activity/business rule task links, milestones and shares) which might have side-effects. Deletion of resources is recursive and cannot be undone.
+     */
+    deleteFile(fileId: string): Promise<null>;
+    /**
+     * Updates the content, name, or location of a file, or all at the same time.
+     *
+     * To move a file, specify projectId and/or folderId:
+     * When only folderId is given, the file will be moved to that folder. The folder can be in another project of the same organization.
+     * When projectId is given and folderId is either null or omitted altogether, the file will be moved to the root of the project.
+     * When projectId and folderId are both given, they must be consistent - i.e. the new parent folder is in the new project.
+     * The field revision holds the current revision of the file. This is used for detecting and preventing concurrent modifications.
+     * For connector templates, the following constraints apply:
+     * The value of content.$schema is not updatable.
+     * The value of content.name can only be changed via name.
+     * The value of content.id is not updatable.
+     * The value of content.version is managed by Web Modeler and will be updated automatically.
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     */
+    updateFile(fileId: string, update: Dto.UpdateFileDto): Promise<Dto.FileMetadataDto>;
+    /**
+     * Searches for files.
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     *
+     * Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
+     *
+     * You can use suffixes to match date ranges:
+     *
+     * Modifier	Description
+     * ||/y	Within a year
+     * ||/M	Within a month
+     * ||/w	Within a week
+     * ||/d	Within a day
+     * ||/h	Within an hour
+     * ||/m	Within a minute
+     * ||/s	Within a second
+     *
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     *
+     * page specifies the page number to return.
+     * size specifies the number of items per page. The default value is 10.
+     *
+     * Note: The simplePath transform any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     */
+    searchFiles(req: Dto.PubSearchDtoFileMetadataDto): Promise<Dto.PubSearchResultDtoFileMetadataDto>;
+    /**
+     *
+     * Creates a new folder.
+     *
+     * When only parentId is given, the folder will be created in that folder. The folder can be in any project of the same organization.
+     *
+     * When projectId is given and parentId is either null or omitted altogether, the folder will be created in the root of the project.
+     *
+     * When projectId and parentId are both given, they must be consistent - i.e. the parent folder is in the project.
+     */
+    createFolder(req: Dto.CreateFolderDto): Promise<Dto.FolderMetadataDto>;
+    getFolder(folderId: string): Promise<Dto.FolderDto>;
+    /**
+     *
+     * Deletes an empty folder. A folder is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.
+     */
+    deleteFolder(folderId: string): Promise<null>;
+    /**
+     * Updates the name or location of a folder, or both at the same time.
+     *
+     * To move a folder, specify projectId and/or parentId:
+     *
+     * When only parentId is given, the file will be moved to that folder. The folder must keep in the same organization.
+     *
+     * When projectId is given and parentId is either null or omitted altogether, the file will be moved to the root of the project.
+     *
+     * When projectId and parentId are both given, they must be consistent - i.e. the new parent folder is in the new project.
+     */
+    updateFolder(folderId: string, update: Dto.UpdateFolderDto): Promise<Dto.FolderMetadataDto>;
+    getInfo(): Promise<Dto.InfoDto>;
+    createMilestone(req: Dto.CreateMilestoneDto): Promise<Dto.MilestoneMetadataDto>;
+    getMilestone(milestoneId: string): Promise<Dto.MilestoneDto>;
+    /**
+     * Deletion of resources is recursive and cannot be undone.
+     */
+    deleteMilestone(milestoneId: string): Promise<string | null>;
+    /**
+     * Returns a link to a visual comparison between two milestones where the milestone referenced by milestone1Id acts as a baseline to compare the milestone referenced by milestone2Id against.
+     */
+    getMilestoneComparison(milestone1Id: string, milestone2Id: string): Promise<string>;
+    /**
+     * Searches for milestones.
+     *
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     *
+     * Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
+     *
+     * You can use suffixes to match date ranges:
+     *
+     * Modifier	Description
+     * ||/y	Within a year
+     * ||/M	Within a month
+     * ||/w	Within a week
+     * ||/d	Within a day
+     * ||/h	Within an hour
+     * ||/m	Within a minute
+     * ||/s	Within a second
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     *
+     * page specifies the page number to return.
+     *
+     * size specifies the number of items per page. The default value is 10.
+     */
+    searchMilestones(req: Dto.PubSearchDtoMilestoneMetadataDto): Promise<Dto.PubSearchResultDtoMilestoneMetadataDto>;
+    /**
+     * Creates a new project. This project will be created without any collaborators, so it will not be visible in the UI by default. To assign collaborators, use `addCollaborator()`.
+     */
+    createProject(name: string): Promise<Dto.ProjectMetadataDto>;
+    getProject(projectId: string): Promise<Dto.ProjectDto>;
+    /**
+     * This endpoint deletes an empty project. A project is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.
+     */
+    deleteProject(projectId: string): Promise<string | null>;
+    renameProject(projectId: string, name: string): Promise<Dto.ProjectMetadataDto>;
+    /**
+     * Searches for projects.
+     *
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     *
+     * Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
+     *
+     * You can use suffixes to match date ranges:
+     *
+     * Modifier	Description
+     * ||/y	Within a year
+     * ||/M	Within a month
+     * ||/w	Within a week
+     * ||/d	Within a day
+     * ||/h	Within an hour
+     * ||/m	Within a minute
+     * ||/s	Within a second
+     *
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     *
+     * page specifies the page number to return.
+     *
+     * size specifies the number of items per page. The default value is 10.
+     */
+    searchProjects(req: Dto.PubSearchDtoProjectMetadataDto): Promise<Dto.PubSearchResultDtoProjectMetadataDto>;
+}

package/dist/modeler/lib/ModelerAPIClient.js

@@ -0,0 +1,417 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelerApiClient = void 0;
+const debug_1 = __importDefault(require("debug"));
+const got_1 = __importDefault(require("got"));
+const lib_1 = require("../../lib");
+const debug = (0, debug_1.default)('camunda:modeler');
+const API_VERSION = 'v1';
+class ModelerApiClient {
+    constructor(options) {
+        const config = lib_1.CamundaEnvironmentConfigurator.mergeConfigWithEnvironment(options?.config ?? {});
+        const modelerApiUrl = config.CAMUNDA_MODELER_BASE_URL ?? 'https://modeler.cloud.camunda.io/api';
+        this.oAuthProvider =
+            options?.oAuthProvider ?? (0, lib_1.constructOAuthProvider)(config);
+        this.userAgentString = (0, lib_1.createUserAgentString)(config);
+        const prefixUrl = `${modelerApiUrl}/${API_VERSION}`;
+        const certificateAuthority = (0, lib_1.GetCertificateAuthority)(config);
+        this.rest = got_1.default.extend({
+            prefixUrl,
+            https: {
+                certificateAuthority,
+            },
+            responseType: 'json',
+            hooks: {
+                beforeError: [
+                    (error) => {
+                        const { request } = error;
+                        if (request) {
+                            debug(`Error in request to ${request.options.url.href}`);
+                            debug(`Request headers: ${JSON.stringify(request.options.headers)}`);
+                            debug(`Error: ${error.code} - ${error.message}`);
+                            // Attach more contextual information to the error object
+                            error.message += ` (request to ${request.options.url.href})`;
+                        }
+                        return error;
+                    },
+                ],
+            },
+        });
+        debug(`baseUrl: ${prefixUrl}`);
+    }
+    async getHeaders() {
+        const token = await this.oAuthProvider.getToken('MODELER');
+        const auth = `Bearer ${token}`;
+        const headers = {
+            'content-type': 'application/json',
+            authorization: auth,
+            'user-agent': this.userAgentString,
+            accept: '*/*',
+        };
+        debug(auth);
+        return headers;
+    }
+    decodeResponseOrThrow(res) {
+        if (res.statusCode === 200) {
+            return res.body;
+        }
+        // 204: No Content
+        if (res.statusCode === 204) {
+            return null;
+        }
+        const err = new Error(res.statusMessage);
+        err.code = res.statusCode;
+        throw err;
+    }
+    /**
+     * Adds a new collaborator to a project or modifies the permission level of an existing collaborator.
+     * Note: Only users that are part of the authorized organization (see GET /api/v1/info) and logged in to Web Modeler at least once can be added to a project.
+     */
+    async addCollaborator(req) {
+        const headers = await this.getHeaders();
+        return got_1.default
+            .put(`collaborators`, {
+            headers,
+            body: JSON.stringify(req),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Searches for collaborators.
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     * page specifies the page number to return.
+     * size specifies the number of items per page. The default value is 10.
+     */
+    async searchCollaborators(req) {
+        const headers = await this.getHeaders();
+        return got_1.default
+            .post(`collaborators/search`, {
+            headers,
+            body: JSON.stringify(req),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    async deleteCollaborator({ email, projectId, }) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .delete(`project/${projectId}collaborators/${email}`, {
+            headers,
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    /**
+     * This endpoint creates a file.
+     *
+     * To create a file, specify projectId and/or folderId:
+     *
+     * When only folderId is given, the file will be created in that folder. The folder can be in any project of the same organization.
+     *
+     * When projectId is given and folderId is either null or omitted altogether, the file will be created in the root of the project.
+     *
+     * When projectId and folderId are both given, they must be consistent - i.e. the folder is in the project.
+     *
+     * For connector templates, the following constraints apply:
+     *
+     * The value of content.$schema will be replaced with https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json and validated against it.
+     *
+     * The value of name takes precedence over content.name. In case of mismatch, the latter will be adjusted to match the former automatically.
+     *
+     * The value of content.id will be replaced with the file id generated by Web Modeler.
+     *
+     * The value of content.version is managed by Web Modeler and will be updated automatically.
+     *
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     */
+    async createFile(req) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .post(`files`, {
+            headers,
+            body: JSON.stringify(req),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Retrieves a file.
+     *
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an
+     * escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping
+     * facilitates the processing of path-like structures within file and folder names.
+     *
+     * Does this throw if it is not found?
+     */
+    async getFile(fileId) {
+        const headers = await this.getHeaders();
+        return this.rest(`files/${fileId}`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Deletes a file.
+     * Note: Deleting a file will also delete other resources attached to the file (comments, call activity/business rule task links, milestones and shares) which might have side-effects. Deletion of resources is recursive and cannot be undone.
+     */
+    async deleteFile(fileId) {
+        const headers = await this.getHeaders();
+        return this.rest(`files/${fileId}`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Updates the content, name, or location of a file, or all at the same time.
+     *
+     * To move a file, specify projectId and/or folderId:
+     * When only folderId is given, the file will be moved to that folder. The folder can be in another project of the same organization.
+     * When projectId is given and folderId is either null or omitted altogether, the file will be moved to the root of the project.
+     * When projectId and folderId are both given, they must be consistent - i.e. the new parent folder is in the new project.
+     * The field revision holds the current revision of the file. This is used for detecting and preventing concurrent modifications.
+     * For connector templates, the following constraints apply:
+     * The value of content.$schema is not updatable.
+     * The value of content.name can only be changed via name.
+     * The value of content.id is not updatable.
+     * The value of content.version is managed by Web Modeler and will be updated automatically.
+     * Note: The simplePath transforms any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     */
+    async updateFile(fileId, update) {
+        const headers = await this.getHeaders();
+        return this.rest(`files/${fileId}`, {
+            headers,
+            body: JSON.stringify(update),
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Searches for files.
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     *
+     * Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
+     *
+     * You can use suffixes to match date ranges:
+     *
+     * Modifier	Description
+     * ||/y	Within a year
+     * ||/M	Within a month
+     * ||/w	Within a week
+     * ||/d	Within a day
+     * ||/h	Within an hour
+     * ||/m	Within a minute
+     * ||/s	Within a second
+     *
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     *
+     * page specifies the page number to return.
+     * size specifies the number of items per page. The default value is 10.
+     *
+     * Note: The simplePath transform any occurrences of slashes ("/") in file and folder names into an escape sequence consisting of a backslash followed by a slash ("\/"). This form of escaping facilitates the processing of path-like structures within file and folder names.
+     */
+    async searchFiles(req) {
+        const headers = await this.getHeaders();
+        return this.rest(`files/search`, {
+            headers,
+            body: JSON.stringify(req),
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     *
+     * Creates a new folder.
+     *
+     * When only parentId is given, the folder will be created in that folder. The folder can be in any project of the same organization.
+     *
+     * When projectId is given and parentId is either null or omitted altogether, the folder will be created in the root of the project.
+     *
+     * When projectId and parentId are both given, they must be consistent - i.e. the parent folder is in the project.
+     */
+    async createFolder(req) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .post(`folders`, {
+            headers,
+            body: JSON.stringify(req),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    async getFolder(folderId) {
+        const headers = await this.getHeaders();
+        return this.rest(`folders/${folderId}`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     *
+     * Deletes an empty folder. A folder is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.
+     */
+    async deleteFolder(folderId) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .delete(`folders/${folderId}`, {
+            headers,
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Updates the name or location of a folder, or both at the same time.
+     *
+     * To move a folder, specify projectId and/or parentId:
+     *
+     * When only parentId is given, the file will be moved to that folder. The folder must keep in the same organization.
+     *
+     * When projectId is given and parentId is either null or omitted altogether, the file will be moved to the root of the project.
+     *
+     * When projectId and parentId are both given, they must be consistent - i.e. the new parent folder is in the new project.
+     */
+    async updateFolder(folderId, update) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .patch(`folders/${folderId}`, {
+            headers,
+            body: JSON.stringify(update),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    async getInfo() {
+        const headers = await this.getHeaders();
+        return this.rest(`info`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    async createMilestone(req) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .post(`milestones`, {
+            headers,
+            body: JSON.stringify(req),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    async getMilestone(milestoneId) {
+        const headers = await this.getHeaders();
+        return this.rest(`milestones/${milestoneId}`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Deletion of resources is recursive and cannot be undone.
+     */
+    async deleteMilestone(milestoneId) {
+        const headers = await this.getHeaders();
+        return this.rest(`milestones/${milestoneId}`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Returns a link to a visual comparison between two milestones where the milestone referenced by milestone1Id acts as a baseline to compare the milestone referenced by milestone2Id against.
+     */
+    async getMilestoneComparison(milestone1Id, milestone2Id) {
+        const headers = await this.getHeaders();
+        return this.rest(`milestones/compare/${milestone1Id}...${milestone2Id}`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Searches for milestones.
+     *
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     *
+     * Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
+     *
+     * You can use suffixes to match date ranges:
+     *
+     * Modifier	Description
+     * ||/y	Within a year
+     * ||/M	Within a month
+     * ||/w	Within a week
+     * ||/d	Within a day
+     * ||/h	Within an hour
+     * ||/m	Within a minute
+     * ||/s	Within a second
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     *
+     * page specifies the page number to return.
+     *
+     * size specifies the number of items per page. The default value is 10.
+     */
+    async searchMilestones(req) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .post(`milestones/search`, {
+            headers,
+            body: JSON.stringify(req),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Creates a new project. This project will be created without any collaborators, so it will not be visible in the UI by default. To assign collaborators, use `addCollaborator()`.
+     */
+    async createProject(name) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .post(`projects`, {
+            headers,
+            body: JSON.stringify({ name }),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    async getProject(projectId) {
+        const headers = await this.getHeaders();
+        return this.rest(`projects/${projectId}`, {
+            headers,
+        }).then(this.decodeResponseOrThrow);
+    }
+    /**
+     * This endpoint deletes an empty project. A project is considered empty if there are no files in it. Deletion of resources is recursive and cannot be undone.
+     */
+    async deleteProject(projectId) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .delete(`projects/${projectId}`, {
+            headers,
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    async renameProject(projectId, name) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .patch(`projects/${projectId}`, {
+            headers,
+            body: JSON.stringify({ name }),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+    /**
+     * Searches for projects.
+     *
+     * filter specifies which fields should match. Only items that match the given fields will be returned.
+     *
+     * Note: Date fields need to be specified in a format compatible with java.time.ZonedDateTime; for example 2023-09-20T11:31:20.206801604Z.
+     *
+     * You can use suffixes to match date ranges:
+     *
+     * Modifier	Description
+     * ||/y	Within a year
+     * ||/M	Within a month
+     * ||/w	Within a week
+     * ||/d	Within a day
+     * ||/h	Within an hour
+     * ||/m	Within a minute
+     * ||/s	Within a second
+     *
+     * sort specifies by which fields and direction (ASC/DESC) the result should be sorted.
+     *
+     * page specifies the page number to return.
+     *
+     * size specifies the number of items per page. The default value is 10.
+     */
+    async searchProjects(req) {
+        const headers = await this.getHeaders();
+        return this.rest
+            .post(`projects/search`, {
+            headers,
+            body: JSON.stringify(req),
+        })
+            .then(this.decodeResponseOrThrow);
+    }
+}
+exports.ModelerApiClient = ModelerApiClient;
+//# sourceMappingURL=ModelerAPIClient.js.map

package/dist/modeler/lib/ModelerAPIClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelerAPIClient.js","sourceRoot":"","sources":["../../../src/modeler/lib/ModelerAPIClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAqB;AACrB,8CAAmC;AAEnC,mCAOkB;AAKlB,MAAM,KAAK,GAAG,IAAA,eAAC,EAAC,iBAAiB,CAAC,CAAA;AAElC,MAAM,WAAW,GAAG,IAAI,CAAA;AAExB,MAAa,gBAAgB;IAK5B,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,MAAM,aAAa,GAClB,MAAM,CAAC,wBAAwB,IAAI,sCAAsC,CAAA;QAC1E,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,MAAM,SAAS,GAAG,GAAG,aAAa,IAAI,WAAW,EAAE,CAAA;QAEnD,MAAM,oBAAoB,GAAG,IAAA,6BAAuB,EAAC,MAAM,CAAC,CAAA;QAE5D,IAAI,CAAC,IAAI,GAAG,aAAG,CAAC,MAAM,CAAC;YACtB,SAAS;YACT,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,YAAY,EAAE,MAAM;YACpB,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,CAAC,KAAK,EAAE,EAAE;wBACT,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;wBACzB,IAAI,OAAO,EAAE,CAAC;4BACb,KAAK,CAAC,uBAAuB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;4BACxD,KAAK,CACJ,oBAAoB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAC7D,CAAA;4BACD,KAAK,CAAC,UAAU,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;4BAChD,yDAAyD;4BACzD,KAAK,CAAC,OAAO,IAAI,gBAAgB,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAA;wBAC7D,CAAC;wBACD,OAAO,KAAK,CAAA;oBACb,CAAC;iBACD;aACD;SACD,CAAC,CAAA;QACF,KAAK,CAAC,YAAY,SAAS,EAAE,CAAC,CAAA;IAC/B,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC1D,MAAM,IAAI,GAAG,UAAU,KAAK,EAAE,CAAA;QAC9B,MAAM,OAAO,GAAG;YACf,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,IAAI;YACnB,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;QACD,KAAK,CAAC,IAAI,CAAC,CAAA;QACX,OAAO,OAAO,CAAA;IACf,CAAC;IAEO,qBAAqB,CAAC,GAAqB;QAClD,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC,IAAI,CAAA;QAChB,CAAC;QACD,kBAAkB;QAClB,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAA;QACZ,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,aAAa,CAAgC,CAAA;QACvE,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,UAAU,CAAA;QACzB,MAAM,GAAG,CAAA;IACV,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,GAA8B;QACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,aAAG;aACR,GAAG,CAAC,eAAe,EAAE;YACrB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAkB,CAAA;IACpD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CACxB,GAA2C;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,aAAG;aACR,IAAI,CAAC,sBAAsB,EAAE;YAC7B,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC;aACD,IAAI,CACJ,IAAI,CAAC,qBAAqB,CAC+B,CAAA;IAC5D,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,EACxB,KAAK,EACL,SAAS,GAIT;QACA,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,WAAW,SAAS,iBAAiB,KAAK,EAAE,EAAE;YACrD,OAAO;SACP,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAkB,CAAA;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,UAAU,CAAC,GAAsB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,OAAO,EAAE;YACd,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAiC,CAAA;IACnE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc;QAC3B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,MAAM,EAAE,EAAE;YACnC,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAyB,CAAA;IAC5D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,MAAc;QAC9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,MAAM,EAAE,EAAE;YACnC,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAkB,CAAA;IACrD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,UAAU,CACf,MAAc,EACd,MAAyB;QAEzB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,MAAM,EAAE,EAAE;YACnC,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;SAC5B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAiC,CAAA;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,WAAW,CAChB,GAAoC;QAEpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YAChC,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC,CAAC,IAAI,CACN,IAAI,CAAC,qBAAqB,CACwB,CAAA;IACpD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,GAAwB;QAC1C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAmC,CAAA;IACrE,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,QAAgB;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,QAAQ,EAAE,EAAE;YACvC,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAA2B,CAAA;IAC9D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,QAAgB;QAClC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,WAAW,QAAQ,EAAE,EAAE;YAC9B,OAAO;SACP,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAkB,CAAA;IACpD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,YAAY,CACjB,QAAgB,EAChB,MAA2B;QAE3B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,KAAK,CAAC,WAAW,QAAQ,EAAE,EAAE;YAC7B,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;SAC5B,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAmC,CAAA;IACrE,CAAC;IAED,KAAK,CAAC,OAAO;QACZ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAyB,CAAA;IAC5D,CAAC;IAED,KAAK,CAAC,eAAe,CACpB,GAA2B;QAE3B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,YAAY,EAAE;YACnB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAsC,CAAA;IACxE,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,WAAmB;QACrC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,WAAW,EAAE,EAAE;YAC7C,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAA8B,CAAA;IACjE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,WAAmB;QACxC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,WAAW,EAAE,EAAE;YAC7C,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;IACpC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sBAAsB,CAC3B,YAAoB,EACpB,YAAoB;QAEpB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,YAAY,MAAM,YAAY,EAAE,EAAE;YACxE,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAoB,CAAA;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,gBAAgB,CACrB,GAAyC;QAEzC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC;aACD,IAAI,CACJ,IAAI,CAAC,qBAAqB,CAC6B,CAAA;IAC1D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;SAC9B,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAoC,CAAA;IACtE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,SAAiB;QACjC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,SAAS,EAAE,EAAE;YACzC,OAAO;SACP,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAA4B,CAAA;IAC/D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB;QACpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,YAAY,SAAS,EAAE,EAAE;YAChC,OAAO;SACP,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;IACnC,CAAC;IAED,KAAK,CAAC,aAAa,CAClB,SAAiB,EACjB,IAAY;QAEZ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,KAAK,CAAC,YAAY,SAAS,EAAE,EAAE;YAC/B,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;SAC9B,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAoC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,cAAc,CACnB,GAAuC;QAEvC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,iBAAiB,EAAE;YACxB,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;SACzB,CAAC;aACD,IAAI,CACJ,IAAI,CAAC,qBAAqB,CAC2B,CAAA;IACxD,CAAC;CACD;AA9dD,4CA8dC"}