@hahnpro/hpc-api 2025.3.10 → 2025.4.1-beta.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @hahnpro/hpc-api
 
+## 2025.4.0
+
+### Major Changes
+
+- Restructured the whole package
+- Moved many interfaces to prevent duplication and to make them accessible for other packages
+- Added an organization administration API service to manage organizations administration and separate it from the normal organization calls.
+- Fixed an issue where the organization resources API sse observables did not use the correct base url.
+
 ## 2025.3.9
 
 - Updated Content Interface and Task Interface, Added `addElementToProperty` and `removeElementToProperty` mehtods to Asset API service

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2025.3.10",
+  "version": "2025.4.1-beta.1",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {
@@ -8,11 +8,13 @@
     "url": "https://hahnpro.com"
   },
   "dependencies": {
+    "@microsoft/fetch-event-source": "2.0.1",
     "axios": "1.12.2",
     "eventsource": "4.0.0",
     "jose": "5.10.0",
     "jwt-decode": "4.0.0",
     "p-queue": "6.6.2",
+    "rxjs": "7.8.2",
     "ts-mixer": "6.0.4",
     "tslib": "2.8.1"
   },

package/src/index.d.ts

@@ -1,19 +1,5 @@
+export * from './lib/interfaces';
+export * from './lib/services';
 export * from './lib/api';
-export type * from './lib/interfaces';
-export * from './lib/content.interface';
-export * from './lib/data.interface';
-export * from './lib/data.service';
-export * from './lib/endpoint.interface';
-export * from './lib/flow.interface';
-export * from './lib/flow-deployment.interface';
-export * from './lib/flow-function.interface';
-export * from './lib/http.service';
 export * from './lib/mock';
-export * from './lib/notification.interface';
-export * from './lib/organization.interface';
-export * from './lib/schema.interface';
-export * from './lib/secret.interface';
-export * from './lib/task.interface';
-export * from './lib/vault.interface';
-export * from './lib/task.service';
 export * from './lib/utils';

package/src/index.js

@@ -1,21 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/interfaces"), exports);
+tslib_1.__exportStar(require("./lib/services"), exports);
 tslib_1.__exportStar(require("./lib/api"), exports);
-tslib_1.__exportStar(require("./lib/content.interface"), exports);
-tslib_1.__exportStar(require("./lib/data.interface"), exports);
-tslib_1.__exportStar(require("./lib/data.service"), exports);
-tslib_1.__exportStar(require("./lib/endpoint.interface"), exports);
-tslib_1.__exportStar(require("./lib/flow.interface"), exports);
-tslib_1.__exportStar(require("./lib/flow-deployment.interface"), exports);
-tslib_1.__exportStar(require("./lib/flow-function.interface"), exports);
-tslib_1.__exportStar(require("./lib/http.service"), exports);
 tslib_1.__exportStar(require("./lib/mock"), exports);
-tslib_1.__exportStar(require("./lib/notification.interface"), exports);
-tslib_1.__exportStar(require("./lib/organization.interface"), exports);
-tslib_1.__exportStar(require("./lib/schema.interface"), exports);
-tslib_1.__exportStar(require("./lib/secret.interface"), exports);
-tslib_1.__exportStar(require("./lib/task.interface"), exports);
-tslib_1.__exportStar(require("./lib/vault.interface"), exports);
-tslib_1.__exportStar(require("./lib/task.service"), exports);
 tslib_1.__exportStar(require("./lib/utils"), exports);

package/src/lib/api-base.d.ts

@@ -1,6 +1,6 @@
-import { HttpClient } from './http.service';
+import { HttpClientService } from './services';
 export declare class APIBase {
-    protected readonly httpClient: HttpClient;
+    protected readonly httpClient: HttpClientService;
     protected readonly basePath: string;
-    constructor(httpClient: HttpClient, basePath: string);
+    constructor(httpClient: HttpClientService, basePath: string);
 }

package/src/lib/api.d.ts

@@ -1,22 +1,6 @@
-import { AlertService } from './alert.service';
-import { ContentService } from './content.service';
-import { EndpointService } from './endpoint.service';
-import { FlowDeploymentService } from './flow-deployment.service';
-import { FlowFunctionService } from './flow-function.service';
-import { FlowModuleService } from './flow-module.service';
-import { FlowService } from './flow.service';
-import { HttpClient } from './http.service';
-import { NotificationRuleService } from './notification-rule.service';
-import { NotificationService } from './notification.service';
-import { OrganizationService } from './organization.service';
-import { ProxyService } from './proxy.service';
-import { SecretService } from './secret.service';
-import { AiService, AssetService, AssetTypesService, EventService, LabelService, SearchService, TimeSeriesService } from './services';
-import { TaskService } from './task.service';
-import { UserService } from './user.service';
-import { VaultService } from './vault.service';
+import { AiService, AlertService, AssetService, AssetTypesService, ContentService, EndpointService, EventService, FlowDeploymentService, FlowFunctionService, FlowModuleService, FlowService, HttpClientService, LabelService, NotificationRuleService, NotificationService, OrganizationsAdministrationService, OrganizationsResourcesService, OrganizationsService, ProxyService, SearchService, SecretService, TaskService, TimeSeriesService, UserService, VaultService } from './services';
 export declare class API {
-    readonly httpClient?: HttpClient;
+    readonly httpClient?: HttpClientService;
     ai: AiService;
     alerts: AlertService;
     assets: AssetService;
@@ -29,7 +13,9 @@ export declare class API {
     flowFunctions: FlowFunctionService;
     flowModules: FlowModuleService;
     labels: LabelService;
-    organizations: OrganizationService;
+    organizations: OrganizationsService;
+    organizationsAdministration: OrganizationsAdministrationService;
+    organizationsResources: OrganizationsResourcesService;
     proxy: ProxyService;
     search: SearchService;
     secrets: SecretService;
@@ -39,7 +25,8 @@ export declare class API {
     vault: VaultService;
     notifications: NotificationService;
     notificationRules: NotificationRuleService;
-    constructor(httpClient?: HttpClient, context?: {
+    constructor(httpClient?: HttpClientService, context?: {
         tokenSubject?: string;
+        activeOrg?: string;
     });
 }

package/src/lib/api.js

@@ -1,23 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API = void 0;
-const alert_service_1 = require("./alert.service");
-const content_service_1 = require("./content.service");
-const endpoint_service_1 = require("./endpoint.service");
-const flow_deployment_service_1 = require("./flow-deployment.service");
-const flow_function_service_1 = require("./flow-function.service");
-const flow_module_service_1 = require("./flow-module.service");
-const flow_service_1 = require("./flow.service");
-const http_service_1 = require("./http.service");
-const notification_rule_service_1 = require("./notification-rule.service");
-const notification_service_1 = require("./notification.service");
-const organization_service_1 = require("./organization.service");
-const proxy_service_1 = require("./proxy.service");
-const secret_service_1 = require("./secret.service");
 const services_1 = require("./services");
-const task_service_1 = require("./task.service");
-const user_service_1 = require("./user.service");
-const vault_service_1 = require("./vault.service");
 class API {
     constructor(httpClient, context) {
         this.httpClient = httpClient;
@@ -39,30 +23,40 @@ class API {
             if (!secret) {
                 throw new Error('"API_BASE_URL", "API_USER", "AUTH_REALM" and "AUTH_SECRET" environment variables must be set');
             }
-            this.httpClient = new http_service_1.HttpClient(apiUrl, authUrl, realm, client, secret, context?.tokenSubject);
+            this.httpClient = new services_1.HttpClientService({
+                baseURL: apiUrl,
+                authBaseURL: authUrl,
+                realm,
+                clientId: client,
+                clientSecret: secret,
+                tokenSubject: context?.tokenSubject,
+                activeOrg: context?.activeOrg,
+            });
         }
         this.ai = new services_1.AiService(this.httpClient);
-        this.alerts = new alert_service_1.AlertService(this.httpClient);
+        this.alerts = new services_1.AlertService(this.httpClient);
         this.assets = new services_1.AssetService(this.httpClient);
         this.assetTypes = new services_1.AssetTypesService(this.httpClient);
-        this.contents = new content_service_1.ContentService(this.httpClient);
-        this.endpoints = new endpoint_service_1.EndpointService(this.httpClient);
+        this.contents = new services_1.ContentService(this.httpClient);
+        this.endpoints = new services_1.EndpointService(this.httpClient);
         this.events = new services_1.EventService(this.httpClient);
-        this.flows = new flow_service_1.FlowService(this.httpClient);
-        this.flowDeployments = new flow_deployment_service_1.FlowDeploymentService(this.httpClient);
-        this.flowFunctions = new flow_function_service_1.FlowFunctionService(this.httpClient);
-        this.flowModules = new flow_module_service_1.FlowModuleService(this.httpClient);
+        this.flows = new services_1.FlowService(this.httpClient);
+        this.flowDeployments = new services_1.FlowDeploymentService(this.httpClient);
+        this.flowFunctions = new services_1.FlowFunctionService(this.httpClient);
+        this.flowModules = new services_1.FlowModuleService(this.httpClient);
         this.labels = new services_1.LabelService(this.httpClient);
-        this.organizations = new organization_service_1.OrganizationService(this.httpClient);
-        this.proxy = new proxy_service_1.ProxyService(this.httpClient);
+        this.organizations = new services_1.OrganizationsService(this.httpClient);
+        this.organizationsAdministration = new services_1.OrganizationsAdministrationService(this.httpClient);
+        this.organizationsResources = new services_1.OrganizationsResourcesService(this.httpClient);
+        this.proxy = new services_1.ProxyService(this.httpClient);
         this.search = new services_1.SearchService(this.httpClient);
-        this.secrets = new secret_service_1.SecretService(this.httpClient);
-        this.tasks = new task_service_1.TaskService(this.httpClient);
+        this.secrets = new services_1.SecretService(this.httpClient);
+        this.tasks = new services_1.TaskService(this.httpClient);
         this.timeSeries = new services_1.TimeSeriesService(this.httpClient);
-        this.users = new user_service_1.UserService(this.httpClient);
-        this.vault = new vault_service_1.VaultService(this.httpClient);
-        this.notifications = new notification_service_1.NotificationService(this.httpClient);
-        this.notificationRules = new notification_rule_service_1.NotificationRuleService(this.httpClient);
+        this.users = new services_1.UserService(this.httpClient);
+        this.vault = new services_1.VaultService(this.httpClient);
+        this.notifications = new services_1.NotificationService(this.httpClient);
+        this.notificationRules = new services_1.NotificationRuleService(this.httpClient);
     }
 }
 exports.API = API;

package/src/lib/interfaces/ai.interface.d.ts

@@ -1,4 +1,4 @@
-import { Owner } from './resource.interface';
+import { Owner } from '.';
 export interface AiAssistant {
     id: string;
     agent?: string;

package/src/lib/{alert.interface.d.ts → interfaces/alert.interface.d.ts}

@@ -1,4 +1,4 @@
-import { Author, Owner } from './interfaces';
+import { Author, Owner } from '.';
 export interface Alert {
     id?: string;
     name: string;

package/src/lib/interfaces/asset.interface.d.ts

@@ -1,5 +1,4 @@
-import { Content } from '../content.interface';
-import { Author, Owner } from './resource.interface';
+import { Author, Content, Owner } from '.';
 export interface AssetType {
     id?: string;
     name: string;

package/src/lib/{content.interface.d.ts → interfaces/content.interface.d.ts}

@@ -1,5 +1,4 @@
-import { Author, Owner } from './interfaces';
-import { Storage } from './storage.interface';
+import { Author, Owner, Storage } from '.';
 export interface Content {
     id?: string;
     fileId: string;

package/src/lib/{data.interface.d.ts → interfaces/data.interface.d.ts}

@@ -1,6 +1,6 @@
-import { TokenOption } from './http.service';
+import { TokenOption } from '.';
 export interface Paginated<T> {
-    docs: T;
+    docs: T[];
     total: number;
     limit: number;
     page?: number;
@@ -29,8 +29,8 @@ export interface DataInterface<T> {
     getOne(id: string, options?: TokenOption & {
         [key: string]: any;
     }): Promise<T>;
-    getMany(params?: RequestParameter, options?: TokenOption): Promise<Paginated<T[]>>;
-    getManyFiltered(filter: Filter, params?: RequestParameter, options?: TokenOption): Promise<Paginated<T[]>>;
+    getMany(params?: RequestParameter, options?: TokenOption): Promise<Paginated<T>>;
+    getManyFiltered(filter: Filter, params?: RequestParameter, options?: TokenOption): Promise<Paginated<T>>;
     updateOne(id: string, dto: any, options?: TokenOption & {
         [key: string]: any;
     }): Promise<T>;

package/src/lib/interfaces/event.interface.d.ts

@@ -1,4 +1,4 @@
-import { Author, Owner, Resource } from './resource.interface';
+import { Author, Owner, Resource } from '.';
 export interface Event extends Resource {
     data?: Record<string, any>;
     assetRef?: string;

package/src/lib/{flow-deployment.interface.d.ts → interfaces/flow-deployment.interface.d.ts}

@@ -1,6 +1,4 @@
-import { FlowDiagram, FlowDto } from './flow.interface';
-import { Resource } from './interfaces';
-import { Storage } from './storage.interface';
+import { FlowDiagram, FlowDto, Resource, Storage } from '.';
 export interface FlowDeployment extends Resource {
     flow: string | FlowDto;
     diagram: string | FlowDiagram;

package/src/lib/{flow-module.interface.d.ts → interfaces/flow-module.interface.d.ts}

@@ -1,4 +1,4 @@
-import { Artifact } from './storage.interface';
+import { Artifact } from '.';
 export interface FlowModule {
     name: string;
     description?: string;

package/src/lib/{flow.interface.d.ts → interfaces/flow.interface.d.ts}

@@ -1,6 +1,4 @@
-import { FlowDeployment } from './flow-deployment.interface';
-import { Resource } from './interfaces';
-import { JsonSchemaForm } from './schema.interface';
+import { FlowDeployment, JsonSchemaForm, Resource } from '.';
 export interface FlowDto extends Resource {
     diagram: string | FlowDiagram;
     deployments?: string[] | FlowDeployment[];

package/src/lib/interfaces/http.interface.d.ts

@@ -0,0 +1,13 @@
+import { AxiosRequestConfig } from 'axios';
+export type TokenOption = {
+    token?: string;
+};
+export type Config = TokenOption & AxiosRequestConfig;
+export interface Issuer {
+    issuer: string;
+    token_endpoint: string;
+    grant_types_supported: string[];
+    token_endpoint_auth_methods_supported: string[];
+    token_endpoint_auth_signing_alg?: string;
+    token_endpoint_auth_signing_alg_values_supported: string[];
+}

package/src/lib/interfaces/index.d.ts

@@ -1,7 +1,29 @@
-export type { Resource, ResourceReference, Owner, OwnerType, Author } from './resource.interface';
-export type { AiAssistant, AssistantMessage, Message, SpeechToken, SystemMessage, Thread, ThreadPopulated, ToolMessage, UserMessage, } from './ai.interface';
-export type { Asset, AssetRevision, AssetType, AssetTypeRevision, Attachment, EventCause, EventLevelOverride, Template, } from './asset.interface';
-export type { Event, EventLevel, CreateEventDto } from './event.interface';
-export type { Label, CreateLabelDto, UpdateLabelDto } from './label.interface';
-export type { TimeSeries, TimeSeriesBucket, TimeSeriesCondition, TimeSeriesValue, TS_GROUPS } from './timeseries.interface';
-export type { SearchOptions, SearchResult, SearchSortOption, SortableField } from './search.interface';
+export { AiAssistant, AssistantMessage, Message, SpeechToken, SystemMessage, Thread, ThreadPopulated, ToolMessage, UserMessage, } from './ai.interface';
+export { Alert, AlertCondition, AlertLevel, AlertType, TimeSeriesReference } from './alert.interface';
+export { Asset, AssetTypeRevision, AssetRevision, AssetType, Attachment, EventCause, EventLevelOverride, Template, RemoveFromProperty, AddToProperty, } from './asset.interface';
+export { ReturnType, Content, ContentAnalysis } from './content.interface';
+export { Filter, Paginated, RequestParameter, DataInterface, instanceOfTimePeriod } from './data.interface';
+export { Endpoint, EndpointLog, NotificationPayload } from './endpoint.interface';
+export { Event, EventLevel, CreateEventDto } from './event.interface';
+export { FlowDto, FlowDiagram, FlowRevision, DashboardItem } from './flow.interface';
+export { FlowDeployment, FlowDeploymentMetrics, FlowLog, FlowDeploymentStatistic, FlowModel, FlowModelElement, Metrics, FlowConnection, Stats, StatsValues, } from './flow-deployment.interface';
+export { FlowFunctionDto, FlowFunctionRevision } from './flow-function.interface';
+export { FlowModule } from './flow-module.interface';
+export { TokenOption, Issuer, Config } from './http.interface';
+export { InvitationRepresentation } from './invitation-representation.interface';
+export { KeycloakProfile } from './keycloak-profile.interface';
+export { Label, CreateLabelDto, UpdateLabelDto } from './label.interface';
+export { NotificationType, Notification } from './notification.interface';
+export { TagRule, NotificationRule, StatusRule } from './notification-rule.interface';
+export { Organization, OrganizationCreateDto, OrganizationData, OrganizationDataKind, OrganizationDomain, OrganizationName, OrganizationRolesAdjustment, OrganizationSearchQuery, SubscriptionType, UserWithOrgRoles, } from './organization.interface';
+export { OrganizationRoleRepresentation } from './organization-role-representation.interface';
+export { OrganizationResourcesProgress, OrganizationResourcesProgressDto, OrganizationResourcesProgressErrorDto, } from './organizations-resources.interface';
+export { Author, Owner, OwnerType, Resource, ResourceReference } from './resource.interface';
+export { JsonSchema, JsonSchemaArray, JsonSchemaForm, JsonSchemaType, JsonSchemaTypeName } from './schema.interface';
+export { SearchOptions, SearchResult, SearchSortOption, SortableField } from './search.interface';
+export { Secret } from './secret.interface';
+export { FileType, Artifact, Storage, StorageProvider } from './storage.interface';
+export { Task, LogbookEntry, LogbookEntryDto } from './task.interface';
+export { TimeSeries, TimeSeriesBucket, TimeSeriesCondition, TimeSeriesValue, TS_GROUPS } from './timeseries.interface';
+export { Permission, Application, TableSetting, TableSettingProfile, UserSettings } from './user-settings.interface';
+export { VaultSecret } from './vault.interface';

package/src/lib/interfaces/index.js

@@ -1,2 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OwnerType = exports.instanceOfTimePeriod = exports.ContentAnalysis = exports.ReturnType = exports.AlertType = exports.AlertLevel = void 0;
+var alert_interface_1 = require("./alert.interface");
+Object.defineProperty(exports, "AlertLevel", { enumerable: true, get: function () { return alert_interface_1.AlertLevel; } });
+Object.defineProperty(exports, "AlertType", { enumerable: true, get: function () { return alert_interface_1.AlertType; } });
+var content_interface_1 = require("./content.interface");
+Object.defineProperty(exports, "ReturnType", { enumerable: true, get: function () { return content_interface_1.ReturnType; } });
+Object.defineProperty(exports, "ContentAnalysis", { enumerable: true, get: function () { return content_interface_1.ContentAnalysis; } });
+var data_interface_1 = require("./data.interface");
+Object.defineProperty(exports, "instanceOfTimePeriod", { enumerable: true, get: function () { return data_interface_1.instanceOfTimePeriod; } });
+var resource_interface_1 = require("./resource.interface");
+Object.defineProperty(exports, "OwnerType", { enumerable: true, get: function () { return resource_interface_1.OwnerType; } });

package/src/lib/interfaces/invitation-representation.interface.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Phase Two Admin REST API
+ * This is a REST API reference for the Phase Two Keycloak custom resources. These are extensions to the standard [Keycloak Admin REST API](https://www.keycloak.org/docs-api/17.0/rest-api/index.html).  ### Base URI format Paths specified in the documentation are relative to the the base URI. - Format: `https://<host>:<port>/auth/realms` - Example: `https://app.phasetwo.io/auth/realms`  ### Authentication Authentication is achieved by using the `Authentication: Bearer <token>` header in all requests. This is either the access token received from a normal authentication, or by a request directly to the OpenID Connect token endpoint.  It is recommended that you use a Keycloak Admin Client, such as [this one for Javascript](https://github.com/keycloak/keycloak-nodejs-admin-client), as they take care of authentication, getting an access token, and refreshing it when it expires.  #### Client credentials grant example ``` POST /auth/realms/test-realm/protocol/openid-connect/token Host: app.phasetwo.io Accept: application/json Content-type: application/x-www-form-urlencoded  grant_type=client_credentials&client_id=admin-cli&client_secret=fd649804-3a74-4d69-acaa-8f065c6b7da1 ```  #### Password grant example ``` POST /auth/realms/test-realm/protocol/openid-connect/token Host: app.phasetwo.io Accept: application/json Content-type: application/x-www-form-urlencoded  grant_type=password&username=uname@foo.com&password=pwd123AZY&client_id=admin-cli ```  ### SDKs Modern API libraries are available for several common languages. These are available as open source at the links below, or you can choose to generate your own using our [OpenAPI spec file](https://raw.githubusercontent.com/p2-inc/phasetwo-docs/master/openapi.yaml).  | Language | Library | | --- | --- | | Java (and other JVM langs) | https://github.com/p2-inc/phasetwo-java | | JavaScript/TypeScript | https://github.com/p2-inc/phasetwo-js | | Python | https://github.com/p2-inc/phasetwo-python |
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface InvitationRepresentation
+ */
+export interface InvitationRepresentation {
+    /**
+     *
+     * @type {string}
+     * @memberof InvitationRepresentation
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InvitationRepresentation
+     */
+    email?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InvitationRepresentation
+     */
+    inviterId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof InvitationRepresentation
+     */
+    organizationId?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof InvitationRepresentation
+     */
+    roles?: Array<string>;
+}

package/src/lib/interfaces/keycloak-profile.interface.d.ts

@@ -0,0 +1,12 @@
+export interface KeycloakProfile {
+    id?: string;
+    username?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    enabled?: boolean;
+    emailVerified?: boolean;
+    totp?: boolean;
+    createdTimestamp?: number;
+    attributes?: Record<string, unknown>;
+}

package/src/lib/interfaces/label.interface.d.ts

@@ -1,4 +1,4 @@
-import { Author, Owner } from './resource.interface';
+import { Author, Owner } from '.';
 export interface Label {
     id: string;
     name: string;

package/src/lib/{notification-rule.interface.d.ts → interfaces/notification-rule.interface.d.ts}

@@ -1,4 +1,4 @@
-import { Author, Owner } from './interfaces';
+import { Author, Owner } from '.';
 export interface NotificationRule {
     id?: string;
     name: string;

package/src/lib/interfaces/organization-role-representation.interface.d.ts

@@ -0,0 +1,37 @@
+/**
+ * COPIED FROM:
+ * Phase Two Admin REST API
+ * This is a REST API reference for the Phase Two Keycloak custom resources. These are extensions to the standard [Keycloak Admin REST API](https://www.keycloak.org/docs-api/17.0/rest-api/index.html).  ### Base URI format Paths specified in the documentation are relative to the the base URI. - Format: `https://<host>:<port>/auth/realms` - Example: `https://app.phasetwo.io/auth/realms`  ### Authentication Authentication is achieved by using the `Authentication: Bearer <token>` header in all requests. This is either the access token received from a normal authentication, or by a request directly to the OpenID Connect token endpoint.  It is recommended that you use a Keycloak Admin Client, such as [this one for Javascript](https://github.com/keycloak/keycloak-nodejs-admin-client), as they take care of authentication, getting an access token, and refreshing it when it expires.  #### Client credentials grant example ``` POST /auth/realms/test-realm/protocol/openid-connect/token Host: app.phasetwo.io Accept: application/json Content-type: application/x-www-form-urlencoded  grant_type=client_credentials&client_id=admin-cli&client_secret=fd649804-3a74-4d69-acaa-8f065c6b7da1 ```  #### Password grant example ``` POST /auth/realms/test-realm/protocol/openid-connect/token Host: app.phasetwo.io Accept: application/json Content-type: application/x-www-form-urlencoded  grant_type=password&username=uname@foo.com&password=pwd123AZY&client_id=admin-cli ```  ### SDKs Modern API libraries are available for several common languages. These are available as open source at the links below, or you can choose to generate your own using our [OpenAPI spec file](https://raw.githubusercontent.com/p2-inc/phasetwo-docs/master/openapi.yaml).  | Language | Library | | --- | --- | | Java (and other JVM langs) | https://github.com/p2-inc/phasetwo-java | | JavaScript/TypeScript | https://github.com/p2-inc/phasetwo-js | | Python | https://github.com/p2-inc/phasetwo-python |
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface OrganizationRoleRepresentation
+ */
+export interface OrganizationRoleRepresentation {
+    /**
+     *
+     * @type {string}
+     * @memberof OrganizationRoleRepresentation
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrganizationRoleRepresentation
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrganizationRoleRepresentation
+     */
+    description?: string;
+}

package/src/lib/interfaces/organization.interface.d.ts

@@ -0,0 +1,74 @@
+import { Author, InvitationRepresentation, KeycloakProfile, OrganizationRoleRepresentation } from '.';
+export interface Organization {
+    id?: string;
+    name: string;
+    description?: string;
+    realm?: string;
+    domains?: string[];
+    logo?: string;
+    addressLine?: string;
+    zipCode?: string;
+    city?: string;
+    phoneNumber?: string;
+    website?: string;
+    vat?: string;
+    certificates?: string[];
+    services?: string[];
+    subscriptionId?: string;
+    previousSubscriptions?: string[];
+    assetId?: string;
+    verified?: boolean;
+    deletionRequested?: boolean;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    createdBy?: Author;
+    updatedBy?: Author;
+}
+export interface OrganizationCreateDto {
+    name: string;
+    description?: string;
+    domains?: string[];
+    logo?: string;
+    addressLine?: string;
+    zipCode?: string;
+    city?: string;
+    phoneNumber?: string;
+    vat?: string;
+    assetId?: string;
+    certificates?: string[];
+    services?: string[];
+    subscriptionId?: string;
+    previousSubscriptions?: string[];
+    deletionRequested?: boolean;
+}
+export interface OrganizationData {
+    members: KeycloakProfile[];
+    invitations: InvitationRepresentation[];
+    roles: OrganizationRoleRepresentation[];
+    userRoles: OrganizationRoleRepresentation[];
+    domains: OrganizationDomain[];
+}
+export type OrganizationDataKind = 'members' | 'invitations' | 'roles' | 'domains' | 'userRoles';
+export interface OrganizationDomain {
+    domainName: string;
+    recordKey?: string;
+    recordValue?: string;
+    verified: boolean;
+}
+export interface OrganizationName {
+    id: string;
+    name?: string;
+    isDeleted?: boolean;
+}
+export interface OrganizationRolesAdjustment {
+    grantRoles?: string[];
+    revokeRoles?: string[];
+}
+export interface OrganizationSearchQuery {
+    name?: string;
+}
+export interface UserWithOrgRoles {
+    username: string;
+    orgRoles: string[];
+}
+export type SubscriptionType = 'dev' | 'free' | 'inactive' | 'pro';

package/src/lib/interfaces/organizations-resources.interface.d.ts

@@ -0,0 +1,9 @@
+export type OrganizationResourcesProgress = OrganizationResourcesProgressDto | OrganizationResourcesProgressErrorDto;
+export interface OrganizationResourcesProgressDto {
+    step: string;
+    stepNumber: number;
+    maxSteps: number;
+}
+export interface OrganizationResourcesProgressErrorDto {
+    message: string;
+}

package/src/lib/interfaces/secret.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/lib/interfaces/storage.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/lib/{task.interface.d.ts → interfaces/task.interface.d.ts}

@@ -1,4 +1,4 @@
-import { Author } from './interfaces/resource.interface';
+import { Author } from '.';
 export interface Task {
     id: string;
     name: string;
@@ -21,24 +21,26 @@ export interface Task {
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
+    logbookSchema?: string;
 }
 export interface LogbookEntry {
-    id: string;
+    id?: string;
     taskId: string;
-    date: string;
+    date: Date;
     duration: number;
-    materials: {
+    materials?: {
         name: string;
         quantity: number;
     }[];
     comment?: string;
     source: 'manual' | 'voice' | 'automatic';
-    createdBy: Author;
-    createdAt: string;
-    updatedAt: string;
+    createdBy?: Author;
+    createdAt?: string;
+    updatedAt?: string;
+    data?: Record<string, unknown>;
 }
 export interface LogbookEntryDto {
-    date: string;
+    date: Date;
     duration: number;
     materials: {
         name: string;
@@ -48,4 +50,5 @@ export interface LogbookEntryDto {
     source?: 'manual' | 'voice' | 'automatic';
     taskId: string;
     createdBy?: Author;
+    data?: Record<string, unknown>;
 }

package/src/lib/interfaces/task.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });