prioritize-client 1.3.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Peter Michael Haller and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,90 @@
+# Prioritize TypeScript Client
+
+Official TypeScript/JavaScript client library for the
+[Prioritize](https://github.com/phaller222/Prioritize) REST API (`/api/v1`). It is **generated** from
+Prioritize's OpenAPI specification with [OpenAPI Generator](https://openapi-generator.tech/)
+(`typescript-fetch` generator) — the sources are never hand-written, so the client always matches the
+contract of the release it targets.
+
+- **Runtime:** the browser's `fetch` and Node.js 18+ (`fetch` is global there); no runtime dependencies.
+- **Client version tracks the API version:** a `1.x` client targets the `1.x` REST API.
+- **License:** Apache-2.0 (same as Prioritize).
+
+> **Status:** generated from the released **`1.3.0`** contract, which is what made resources reachable
+> over REST — the flat `GET /api/v1/resources`, `GET /api/v1/resources/{id}/values/latest`, the combined
+> `GET /api/v1/resources/status` and the resource-group listing. It is **not yet published to npm** —
+> build it locally (see [Building](#building)) or reference it via a local path.
+
+## Installation
+
+Once published:
+
+```bash
+npm install prioritize-client
+```
+
+Until then, from a local checkout:
+
+```bash
+npm install /path/to/prioritize-typescript-client   # after `npm run build`
+```
+
+## Usage
+
+Create a `Configuration`, point it at your Prioritize instance, add credentials, then call one of the
+per-tag API classes (`UsersApi`, `ProjectsApi`, `TasksApi`, `ResourcesApi`, `TelemetryRulesApi`,
+`DocumentsApi`, `SkillsApi`, …). Method names are `<tag><OperationId>`, e.g.
+`resourceGetAllResources()`, `resourceGetLatestValues({ id })`.
+
+### Basic auth (default / dev profile)
+
+```ts
+import { Configuration, ResourcesApi } from "prioritize-client";
+
+const config = new Configuration({
+  basePath: "http://localhost:8080", // the spec paths already carry /api/v1
+  username: "admin",
+  password: "p@ssword",
+});
+
+const resources = new ResourcesApi(config);
+
+// Flat list of every resource the caller may read
+const all = await resources.resourceGetAllResources();
+
+// Latest telemetry value per data point of a resource
+const values = await resources.resourceGetLatestValues({ id: all[0].id! });
+```
+
+### Bearer auth (Keycloak)
+
+```ts
+const config = new Configuration({
+  basePath: "https://prioritize.example.com",
+  accessToken: async () => myKeycloak.token!, // called per request
+});
+```
+
+## Building
+
+The generated npm package (`package.json`, `tsconfig*.json`, `src/`) is committed. To compile it:
+
+```bash
+npm install
+npm run build   # tsc -> dist/ (CommonJS) + dist/esm/ (ES modules)
+```
+
+## Regenerating from a new API release
+
+The client is spec-first. To retarget it at a newer Prioritize release, drop the released
+`docs/openapi.json` in and regenerate — the sources under `src/` are overwritten, the hand-maintained
+files (this README, `LICENSE`, `pom.xml`, `generate.sh`, `.gitignore`, `openapi/`) are preserved via
+`.openapi-generator-ignore`:
+
+```bash
+./generate.sh /path/to/Prioritize/docs/openapi.json
+```
+
+This uses the Maven-based OpenAPI Generator harness (`pom.xml`) — the only reason Maven is involved; it
+is not part of the published package. Remember to bump `npmVersion` in `pom.xml` to match the API
+release before regenerating.

package/dist/apis/CompaniesApi.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Prioritize API
+ * REST API of Prioritize, a resource, project and IoT orchestration platform. All endpoints live under /api/v1. From 1.0.0 on this REST surface is the stable public contract (SemVer); the Vaadin admin GUI and its @Route URLs are an implementation detail and NOT part of that promise. A few areas are marked \'experimental\' in their schema and may still change within the 1.x line.
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * Contact: peter.haller@prioritize-iot.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CompanyDTO, CompanyRequest } from '../models/index';
+export interface CompanyCreateRequest {
+    companyRequest: CompanyRequest;
+}
+export interface CompanyDeleteRequest {
+    id: number;
+}
+export interface CompanyFindByFilterRequest {
+    companyRequest: CompanyRequest;
+}
+export interface CompanyGetByIdRequest {
+    id: number;
+}
+export interface CompanyUpdateRequest {
+    id: number;
+    companyRequest: CompanyRequest;
+}
+/**
+ * CompaniesApi - interface
+ *
+ * @export
+ * @interface CompaniesApiInterface
+ */
+export interface CompaniesApiInterface {
+    /**
+     *
+     * @summary Create company
+     * @param {CompanyRequest} companyRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompaniesApiInterface
+     */
+    companyCreateRaw(requestParameters: CompanyCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyDTO>>;
+    /**
+     * Create company
+     */
+    companyCreate(requestParameters: CompanyCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyDTO>;
+    /**
+     *
+     * @summary Delete company
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompaniesApiInterface
+     */
+    companyDeleteRaw(requestParameters: CompanyDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete company
+     */
+    companyDelete(requestParameters: CompanyDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Find companies matching a filter
+     * @param {CompanyRequest} companyRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompaniesApiInterface
+     */
+    companyFindByFilterRaw(requestParameters: CompanyFindByFilterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CompanyDTO>>>;
+    /**
+     * Find companies matching a filter
+     */
+    companyFindByFilter(requestParameters: CompanyFindByFilterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CompanyDTO>>;
+    /**
+     *
+     * @summary Get all companies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompaniesApiInterface
+     */
+    companyGetAllCompaniesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CompanyDTO>>>;
+    /**
+     * Get all companies
+     */
+    companyGetAllCompanies(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CompanyDTO>>;
+    /**
+     *
+     * @summary Get company by id
+     * @param {number} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompaniesApiInterface
+     */
+    companyGetByIdRaw(requestParameters: CompanyGetByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyDTO>>;
+    /**
+     * Get company by id
+     */
+    companyGetById(requestParameters: CompanyGetByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyDTO>;
+    /**
+     *
+     * @summary Update company
+     * @param {number} id
+     * @param {CompanyRequest} companyRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CompaniesApiInterface
+     */
+    companyUpdateRaw(requestParameters: CompanyUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update company
+     */
+    companyUpdate(requestParameters: CompanyUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class CompaniesApi extends runtime.BaseAPI implements CompaniesApiInterface {
+    /**
+     * Create company
+     */
+    companyCreateRaw(requestParameters: CompanyCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyDTO>>;
+    /**
+     * Create company
+     */
+    companyCreate(requestParameters: CompanyCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyDTO>;
+    /**
+     * Delete company
+     */
+    companyDeleteRaw(requestParameters: CompanyDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete company
+     */
+    companyDelete(requestParameters: CompanyDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Find companies matching a filter
+     */
+    companyFindByFilterRaw(requestParameters: CompanyFindByFilterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CompanyDTO>>>;
+    /**
+     * Find companies matching a filter
+     */
+    companyFindByFilter(requestParameters: CompanyFindByFilterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CompanyDTO>>;
+    /**
+     * Get all companies
+     */
+    companyGetAllCompaniesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CompanyDTO>>>;
+    /**
+     * Get all companies
+     */
+    companyGetAllCompanies(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CompanyDTO>>;
+    /**
+     * Get company by id
+     */
+    companyGetByIdRaw(requestParameters: CompanyGetByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyDTO>>;
+    /**
+     * Get company by id
+     */
+    companyGetById(requestParameters: CompanyGetByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyDTO>;
+    /**
+     * Update company
+     */
+    companyUpdateRaw(requestParameters: CompanyUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update company
+     */
+    companyUpdate(requestParameters: CompanyUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}