@hahnpro/hpc-api 2026.9.13 → 2026.10.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2026.9.13",
+  "version": "2026.10.2",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {

package/src/index.d.ts

@@ -1,6 +1,5 @@
 export * from './lib/api';
 export * from './lib/constants';
-export * from './lib/crm.constants';
 export * from './lib/interfaces';
 export * from './lib/mock';
 export * from './lib/services';

package/src/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./lib/api"), exports);
 tslib_1.__exportStar(require("./lib/constants"), exports);
-tslib_1.__exportStar(require("./lib/crm.constants"), exports);
 tslib_1.__exportStar(require("./lib/interfaces"), exports);
 tslib_1.__exportStar(require("./lib/mock"), exports);
 tslib_1.__exportStar(require("./lib/services"), exports);

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

@@ -0,0 +1,3 @@
+export { ACTIVE_ORG_ID_HEADER } from './active-org-id-header.constants';
+export { type CrmDealReminderRule, type CrmDealReminderStage, CRM_DEAL_REMINDER_RULES, CRM_DEAL_REMINDER_SCHEMA_MARKER, buildCrmMeetingSourceId, buildCrmMeetingParticipantSourceId, CRM_ASSET_TYPE_IDS, CRM_ASSET_TYPE_NAMES, CRM_ASSET_TYPES, PUBLIC_EMAIL_PROVIDERS, } from './crm.constants';
+export { PUBLIC_PERMISSION } from './permissions.constants';

package/src/lib/constants/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PUBLIC_PERMISSION = exports.PUBLIC_EMAIL_PROVIDERS = exports.CRM_ASSET_TYPES = exports.CRM_ASSET_TYPE_NAMES = exports.CRM_ASSET_TYPE_IDS = exports.buildCrmMeetingParticipantSourceId = exports.buildCrmMeetingSourceId = exports.CRM_DEAL_REMINDER_SCHEMA_MARKER = exports.CRM_DEAL_REMINDER_RULES = exports.ACTIVE_ORG_ID_HEADER = void 0;
+var active_org_id_header_constants_1 = require("./active-org-id-header.constants");
+Object.defineProperty(exports, "ACTIVE_ORG_ID_HEADER", { enumerable: true, get: function () { return active_org_id_header_constants_1.ACTIVE_ORG_ID_HEADER; } });
+var crm_constants_1 = require("./crm.constants");
+Object.defineProperty(exports, "CRM_DEAL_REMINDER_RULES", { enumerable: true, get: function () { return crm_constants_1.CRM_DEAL_REMINDER_RULES; } });
+Object.defineProperty(exports, "CRM_DEAL_REMINDER_SCHEMA_MARKER", { enumerable: true, get: function () { return crm_constants_1.CRM_DEAL_REMINDER_SCHEMA_MARKER; } });
+Object.defineProperty(exports, "buildCrmMeetingSourceId", { enumerable: true, get: function () { return crm_constants_1.buildCrmMeetingSourceId; } });
+Object.defineProperty(exports, "buildCrmMeetingParticipantSourceId", { enumerable: true, get: function () { return crm_constants_1.buildCrmMeetingParticipantSourceId; } });
+Object.defineProperty(exports, "CRM_ASSET_TYPE_IDS", { enumerable: true, get: function () { return crm_constants_1.CRM_ASSET_TYPE_IDS; } });
+Object.defineProperty(exports, "CRM_ASSET_TYPE_NAMES", { enumerable: true, get: function () { return crm_constants_1.CRM_ASSET_TYPE_NAMES; } });
+Object.defineProperty(exports, "CRM_ASSET_TYPES", { enumerable: true, get: function () { return crm_constants_1.CRM_ASSET_TYPES; } });
+Object.defineProperty(exports, "PUBLIC_EMAIL_PROVIDERS", { enumerable: true, get: function () { return crm_constants_1.PUBLIC_EMAIL_PROVIDERS; } });
+var permissions_constants_1 = require("./permissions.constants");
+Object.defineProperty(exports, "PUBLIC_PERMISSION", { enumerable: true, get: function () { return permissions_constants_1.PUBLIC_PERMISSION; } });

package/src/lib/constants/permissions.constants.d.ts

@@ -0,0 +1 @@
+export declare const PUBLIC_PERMISSION = "public";

package/src/lib/constants/permissions.constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PUBLIC_PERMISSION = void 0;
+exports.PUBLIC_PERMISSION = 'public';

package/src/lib/interfaces/authz/feature.interface.d.ts

@@ -1,5 +1,4 @@
 import type { Audited } from './audited.interface';
-import type { CapabilityBundle } from './capability-bundle.interface';
 import type { LocalizedText, LocalizedTextPatch } from './localized-text.interface';
 export declare enum FeatureId {
     ALERTS = "alerts",
@@ -40,6 +39,3 @@ export interface Feature extends Audited<string>, Omit<CreateFeature, 'id' | 'de
     readonly id: FeatureId;
     description: LocalizedText | null;
 }
-export interface FeatureWithCapabilityBundles extends Feature {
-    capabilityBundles: CapabilityBundle[];
-}

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

@@ -4,17 +4,19 @@ export type { CreateCapabilityBundle, UpdateCapabilityBundle, CapabilityBundle }
 export type { CreateCapabilityBundleCapability, CapabilityBundleCapability } from './capability-bundle-capability.interface';
 export type { CreateCapability, UpdateCapability, Capability } from './capability.interface';
 export type { CreateOrgGroup, UpdateOrgGroup, OrgGroup } from './org-group.interface';
-export type { CreateFeature, UpdateFeature, Feature, FeatureWithCapabilityBundles } from './feature.interface';
+export type { CreateFeature, UpdateFeature, Feature } from './feature.interface';
 export type { CreateFeatureCapability, FeatureCapability } from './feature-capability.interface';
 export type { CreateOrgGroupCapability, OrgGroupCapability } from './org-group-capability.interface';
 export type { CreateOrgGroupCapabilityBundle, OrgGroupCapabilityBundle } from './org-group-capability-bundle.interface';
 export type { CreateOrgGroupMember, OrgGroupMember } from './org-group-member.interface';
-export type { CreateOrgSubscription, UpdateOrgSubscription, OrgSubscription } from './org-subscription.interface';
+export type { CreateOrgSubscription, UpdateOrgSubscription, OrgSubscription, OrgSubscriptionSqlSort } from './org-subscription.interface';
 export type { SqlPagination, SqlPaginationResult } from './sql-pagination.interface';
-export type { CreatePlan, UpdatePlan, Plan as AuthzPlan, PlanWithFeaturesAndCapabilityBundles } from './plan.interface';
+export type { CreatePlan, UpdatePlan, Plan as AuthzPlan } from './plan.interface';
 export type { CreatePlanFeature, PlanFeature } from './plan-feature.interface';
 export type { CreateServiceAccountCapability, ServiceAccountCapability } from './service-account-capability.interface';
 export type { CreateServiceAccountCapabilityBundle, ServiceAccountCapabilityBundle } from './service-account-capability-bundle.interface';
+export type { LocalizedPermission } from './localized-permission.interface';
+export type { SqlSort, SqlSortDirection } from './sql-sort.interface';
 export { CapabilityId, CapabilityType, CapabilityAction, CapabilityScope } from './capability.interface';
 export { CapabilityBundleId } from './capability-bundle.interface';
 export { FeatureId } from './feature.interface';

package/src/lib/interfaces/authz/localized-permission.interface.d.ts

@@ -0,0 +1,5 @@
+import type { LocalizedText } from './localized-text.interface';
+export interface LocalizedPermission {
+    translations: LocalizedText | string;
+    value: string;
+}

package/src/lib/interfaces/authz/localized-permission.interface.js

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

package/src/lib/interfaces/authz/org-subscription.interface.d.ts

@@ -1,5 +1,9 @@
 import type { Audited } from './audited.interface';
 import type { PlanId } from './plan.interface';
+import type { SqlSort, SqlSortDirection } from './sql-sort.interface';
+export interface OrgSubscriptionSqlSort extends SqlSort {
+    status?: SqlSortDirection;
+}
 export declare enum OrgSubscriptionStatus {
     ACTIVE = "active",
     CANCELLED = "cancelled"

package/src/lib/interfaces/authz/plan.interface.d.ts

@@ -1,5 +1,4 @@
 import type { Audited } from './audited.interface';
-import type { FeatureWithCapabilityBundles } from './feature.interface';
 import type { LocalizedText, LocalizedTextPatch } from './localized-text.interface';
 export declare enum PlanId {
     DEFAULT = "default",
@@ -23,6 +22,3 @@ export interface Plan extends Audited<string>, Omit<CreatePlan, 'id' | 'descript
     readonly id: PlanId;
     description: LocalizedText | null;
 }
-export interface PlanWithFeaturesAndCapabilityBundles extends Plan {
-    features: FeatureWithCapabilityBundles[];
-}

package/src/lib/interfaces/authz/sql-sort.interface.d.ts

@@ -0,0 +1,4 @@
+export type SqlSortDirection = 'ASC' | 'DESC';
+export interface SqlSort {
+    updatedAt?: SqlSortDirection;
+}

package/src/lib/interfaces/authz/sql-sort.interface.js

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

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

@@ -140,3 +140,13 @@ export interface KnowledgeRevision {
         state: KnowledgePage['state'];
     };
 }
+export interface KnowledgeRevisionSummary {
+    revision: number;
+    title: string;
+    updatedBy: Author;
+    updatedAt: string;
+}
+export interface KnowledgeRevisionList {
+    docs: KnowledgeRevisionSummary[];
+    nextCursor?: string;
+}

package/src/lib/mock/authz/authorization.mock.service.d.ts

@@ -1,4 +1,4 @@
-import { Capability, CapabilityBundle, CapabilityId, Permission, SqlPagination, TokenOption } from '../../interfaces';
+import type { Capability, CapabilityBundle, CapabilityId, LocalizedPermission, SqlPagination, TokenOption } from '../../interfaces';
 import { APIBaseMock } from '../../mock/api-base.mock';
 import { AuthorizationService } from '../../services/authz/authorization.service';
 export declare class AuthorizationMockService extends APIBaseMock<never> implements AuthorizationService {
@@ -6,5 +6,5 @@ export declare class AuthorizationMockService extends APIBaseMock<never> impleme
     getOrgCapabilitiesForActiveSubscription(sqlPagination?: SqlPagination, options?: TokenOption): Promise<Capability[]>;
     getOrgCapabilityBundlesForActiveSubscription(sqlPagination?: SqlPagination, options?: TokenOption): Promise<CapabilityBundle[]>;
     getCapabilitiesForUsersActiveOrg(options?: TokenOption): Promise<CapabilityId[]>;
-    getPermissionsForUsersActiveOrg(options?: TokenOption): Promise<Permission[]>;
+    getPermissionsForUsersActiveOrg(options?: TokenOption): Promise<LocalizedPermission[]>;
 }

package/src/lib/mock/authz/plans.mock.service.d.ts

@@ -4,5 +4,5 @@ export declare class PlansMockService extends APIBaseMock<never> implements Plan
     constructor();
     getPlans(..._args: Parameters<PlansService['getPlans']>): ReturnType<PlansService['getPlans']>;
     getPlanById(..._args: Parameters<PlansService['getPlanById']>): ReturnType<PlansService['getPlanById']>;
-    getPlanDetailsById(..._args: Parameters<PlansService['getPlanDetailsById']>): ReturnType<PlansService['getPlanDetailsById']>;
+    getPlanFeaturesByPlanId(..._args: Parameters<PlansService['getPlanFeaturesByPlanId']>): ReturnType<PlansService['getPlanFeaturesByPlanId']>;
 }

package/src/lib/mock/authz/plans.mock.service.js

@@ -12,7 +12,7 @@ class PlansMockService extends api_base_mock_1.APIBaseMock {
     getPlanById(..._args) {
         throw new Error('Method not implemented.');
     }
-    getPlanDetailsById(..._args) {
+    getPlanFeaturesByPlanId(..._args) {
         throw new Error('Method not implemented.');
     }
 }

package/src/lib/mock/knowledge.mock.service.d.ts

@@ -1,4 +1,4 @@
-import { type ConfirmKnowledge, type CreateKnowledge, type KnowledgeBacklinkQuery, type KnowledgeBatch, type KnowledgeHome, type KnowledgeList, type KnowledgePage, type KnowledgeQuery, type KnowledgeRevision, type KnowledgeVersion, type UpdateKnowledge } from '../interfaces';
+import { type ConfirmKnowledge, type CreateKnowledge, type KnowledgeBacklinkQuery, type KnowledgeBatch, type KnowledgeHome, type KnowledgeList, type KnowledgePage, type KnowledgeQuery, type KnowledgeRevision, type KnowledgeRevisionList, type KnowledgeVersion, type UpdateKnowledge } from '../interfaces';
 import { KnowledgeService } from '../services/knowledge.service';
 export declare class KnowledgeMockService extends KnowledgeService {
     data: KnowledgePage[];
@@ -15,6 +15,7 @@ export declare class KnowledgeMockService extends KnowledgeService {
     getHome(query?: KnowledgeQuery): Promise<KnowledgeHome>;
     getBacklinks(query: KnowledgeBacklinkQuery): Promise<KnowledgeList>;
     getRelated(id: string, query?: Pick<KnowledgeQuery, 'cursor' | 'limit'>): Promise<KnowledgeList>;
+    getRevisions(id: string, query?: Pick<KnowledgeQuery, 'cursor' | 'limit'>): Promise<KnowledgeRevisionList>;
     getRevision(id: string, revision: number): Promise<KnowledgeRevision>;
     readBatch(ids: string[]): Promise<KnowledgeBatch>;
     private check;

package/src/lib/mock/knowledge.mock.service.js

@@ -90,6 +90,20 @@ class KnowledgeMockService extends knowledge_service_1.KnowledgeService {
             (outgoing.includes(item.id) ||
                 item.links.some((link) => link.target.resourceType === interfaces_1.ResourceType.KNOWLEDGE && link.target.id === id))), query);
     }
+    async getRevisions(id, query = {}) {
+        const current = this.page(id);
+        const before = query.cursor ? Number(query.cursor) : current.revision + 1;
+        const limit = query.limit || 20;
+        const docs = [];
+        for (let revision = before - 1; revision >= 1 && docs.length < limit; revision--) {
+            const page = this.revisions.get(`${id}:${revision}`);
+            if (page) {
+                docs.push({ revision, title: page.title, updatedBy: structuredClone(page.updatedBy), updatedAt: page.updatedAt });
+            }
+        }
+        const last = docs[docs.length - 1]?.revision ?? 1;
+        return { docs, ...(last > 1 ? { nextCursor: String(last) } : {}) };
+    }
     async getRevision(id, revision) {
         const current = this.page(id);
         const page = this.revisions.get(`${id}:${revision}`);
@@ -131,6 +145,7 @@ class KnowledgeMockService extends knowledge_service_1.KnowledgeService {
         if (staleAfter !== undefined) {
             page.staleAfter = staleAfter || undefined;
         }
+        page.updatedAt = new Date().toISOString();
         if (this.content(page) !== before) {
             page.revision++;
             this.remember(page);

package/src/lib/services/authz/authorization.service.d.ts

@@ -1,10 +1,10 @@
 import { APIBase } from '../../api-base';
-import type { Capability, CapabilityBundle, CapabilityId, Permission, SqlPagination, TokenOption } from '../../interfaces';
+import type { Capability, CapabilityBundle, CapabilityId, LocalizedPermission, SqlPagination, TokenOption } from '../../interfaces';
 import { HttpClientService } from '../http-client.service';
 export declare class AuthorizationService extends APIBase {
     constructor(httpClient: HttpClientService);
     getOrgCapabilitiesForActiveSubscription(sqlPagination?: SqlPagination, options?: TokenOption): Promise<Capability[]>;
     getOrgCapabilityBundlesForActiveSubscription(sqlPagination?: SqlPagination, options?: TokenOption): Promise<CapabilityBundle[]>;
     getCapabilitiesForUsersActiveOrg(options?: TokenOption): Promise<CapabilityId[]>;
-    getPermissionsForUsersActiveOrg(options?: TokenOption): Promise<Permission[]>;
+    getPermissionsForUsersActiveOrg(options?: TokenOption): Promise<LocalizedPermission[]>;
 }

package/src/lib/services/authz/org-subscription.service.d.ts

@@ -1,8 +1,8 @@
 import { APIBase } from '../../api-base';
-import type { OrgSubscription, SqlPagination, SqlPaginationResult, TokenOption } from '../../interfaces';
+import type { OrgSubscription, OrgSubscriptionSqlSort, SqlPagination, SqlPaginationResult, TokenOption } from '../../interfaces';
 import { HttpClientService } from '../http-client.service';
 export declare class OrgSubscriptionService extends APIBase {
     constructor(httpClient: HttpClientService);
-    getOrgSubscriptionsByOrgId(sqlPagination?: SqlPagination, options?: TokenOption): Promise<SqlPaginationResult<OrgSubscription>>;
+    getOrgSubscriptionsByOrgId(sqlPagination?: SqlPagination, sort?: OrgSubscriptionSqlSort, options?: TokenOption): Promise<SqlPaginationResult<OrgSubscription>>;
     getOrgSubscriptionById(orgSubscriptionId: string, options?: TokenOption): Promise<OrgSubscription>;
 }

package/src/lib/services/authz/org-subscription.service.js

@@ -6,8 +6,8 @@ class OrgSubscriptionService extends api_base_1.APIBase {
     constructor(httpClient) {
         super(httpClient, '/authz/org-subscriptions');
     }
-    getOrgSubscriptionsByOrgId(sqlPagination = {}, options = {}) {
-        return this.httpClient.get(this.basePath, { ...options, params: sqlPagination });
+    getOrgSubscriptionsByOrgId(sqlPagination = {}, sort = {}, options = {}) {
+        return this.httpClient.get(this.basePath, { ...options, params: { ...sqlPagination, ...sort } });
     }
     getOrgSubscriptionById(orgSubscriptionId, options = {}) {
         return this.httpClient.get(`${this.basePath}/${orgSubscriptionId}`, options);

package/src/lib/services/authz/plans.service.d.ts

@@ -1,9 +1,9 @@
 import { APIBase } from '../../api-base';
-import type { AuthzPlan as Plan, PlanId, PlanWithFeaturesAndCapabilityBundles, SqlPagination, SqlPaginationResult, TokenOption } from '../../interfaces';
+import type { Feature, AuthzPlan as Plan, PlanId, SqlPagination, SqlPaginationResult, TokenOption } from '../../interfaces';
 import { HttpClientService } from '../http-client.service';
 export declare class PlansService extends APIBase {
     constructor(httpClient: HttpClientService);
     getPlans(sqlPagination?: SqlPagination, options?: TokenOption): Promise<SqlPaginationResult<Plan>>;
     getPlanById(planId: PlanId, options?: TokenOption): Promise<Plan>;
-    getPlanDetailsById(planId: PlanId, options?: TokenOption): Promise<PlanWithFeaturesAndCapabilityBundles>;
+    getPlanFeaturesByPlanId(planId: PlanId, sqlPagination?: SqlPagination, options?: TokenOption): Promise<SqlPaginationResult<Feature>>;
 }

package/src/lib/services/authz/plans.service.js

@@ -12,8 +12,11 @@ class PlansService extends api_base_1.APIBase {
     getPlanById(planId, options = {}) {
         return this.httpClient.get(`${this.basePath}/${planId}`, options);
     }
-    getPlanDetailsById(planId, options = {}) {
-        return this.httpClient.get(`${this.basePath}/${planId}/details`, options);
+    getPlanFeaturesByPlanId(planId, sqlPagination = {}, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${planId}/features`, {
+            ...options,
+            params: sqlPagination,
+        });
     }
 }
 exports.PlansService = PlansService;

package/src/lib/services/knowledge.service.d.ts

@@ -1,5 +1,5 @@
 import { APIBase } from '../api-base';
-import type { Config, ConfirmKnowledge, CreateKnowledge, KnowledgeBacklinkQuery, KnowledgeBatch, KnowledgeHome, KnowledgeList, KnowledgePage, KnowledgeQuery, KnowledgeRevision, KnowledgeVersion, UpdateKnowledge } from '../interfaces';
+import type { Config, ConfirmKnowledge, CreateKnowledge, KnowledgeBacklinkQuery, KnowledgeBatch, KnowledgeHome, KnowledgeList, KnowledgePage, KnowledgeQuery, KnowledgeRevision, KnowledgeRevisionList, KnowledgeVersion, UpdateKnowledge } from '../interfaces';
 import { HttpClientService } from './http-client.service';
 export declare class KnowledgeService extends APIBase {
     constructor(httpClient: HttpClientService);
@@ -9,6 +9,7 @@ export declare class KnowledgeService extends APIBase {
     getHome(query?: KnowledgeQuery, options?: Config): Promise<KnowledgeHome>;
     getBacklinks(query: KnowledgeBacklinkQuery, options?: Config): Promise<KnowledgeList>;
     getRelated(id: string, query?: Pick<KnowledgeQuery, 'cursor' | 'limit'>, options?: Config): Promise<KnowledgeList>;
+    getRevisions(id: string, query?: Pick<KnowledgeQuery, 'cursor' | 'limit'>, options?: Config): Promise<KnowledgeRevisionList>;
     getRevision(id: string, revision: number, options?: Config): Promise<KnowledgeRevision>;
     readBatch(ids: string[], options?: Config): Promise<KnowledgeBatch>;
     updateOne(id: string, dto: UpdateKnowledge, options?: Config): Promise<KnowledgePage>;

package/src/lib/services/knowledge.service.js

@@ -24,6 +24,9 @@ class KnowledgeService extends api_base_1.APIBase {
     getRelated(id, query = {}, options = {}) {
         return this.httpClient.get(`${this.basePath}/${encodeURIComponent(id)}/related`, { ...options, params: query });
     }
+    getRevisions(id, query = {}, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${encodeURIComponent(id)}/revisions`, { ...options, params: query });
+    }
     getRevision(id, revision, options = {}) {
         return this.httpClient.get(`${this.basePath}/${encodeURIComponent(id)}/revisions/${revision}`, options);
     }

package/src/lib/services/organizations.service.d.ts

@@ -95,9 +95,10 @@ export declare class OrganizationsService extends APIBase {
      *
      * @param {string} id - organization id
      * @param {string} kinds - array of requested data types ( selection of: ['members', 'invitations', 'roles', 'domains', 'userRoles'])
+     * @param {TokenOption} options - Optional token option
      * @returns{Promise<OrganizationData>} organizationData (only selected kinds are returned)
      */
-    getOrganizationData(id: string, kinds?: OrganizationDataKind[]): Promise<OrganizationData>;
+    getOrganizationData(id: string, kinds?: OrganizationDataKind[], options?: TokenOption): Promise<OrganizationData>;
     /**
      * Returns the member with the provided id
      *

package/src/lib/services/organizations.service.js

@@ -131,11 +131,12 @@ class OrganizationsService extends api_base_1.APIBase {
      *
      * @param {string} id - organization id
      * @param {string} kinds - array of requested data types ( selection of: ['members', 'invitations', 'roles', 'domains', 'userRoles'])
+     * @param {TokenOption} options - Optional token option
      * @returns{Promise<OrganizationData>} organizationData (only selected kinds are returned)
      */
-    getOrganizationData(id, kinds = []) {
+    getOrganizationData(id, kinds = [], options = {}) {
         const params = kinds.length > 0 ? { kinds: kinds.join(',') } : {};
-        return this.httpClient.get(`${this.basePath}/${id}/data`, { params });
+        return this.httpClient.get(`${this.basePath}/${id}/data`, { params, ...options });
     }
     /**
      * Returns the member with the provided id