@partium/js-sdk 13.0.0

package/core/services/backend-status.service.d.ts

@@ -0,0 +1,46 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { BaseService } from "./base.service";
+import { Observable } from "rxjs";
+import { ServiceProvider } from "./service-provider";
+/**
+ * Service that provides functionality for contacting the Status-Backend to check
+ * the current status of the Partium-Backend and if the SDKs version is compatible
+ * with the Backend.
+ */
+export declare class BackendStatusService extends BaseService {
+    private httpsClientService;
+    private deviceStatusService;
+    private statusEndpoint;
+    private connectivityCheckFallback;
+    private appVersion;
+    private language;
+    private timeout;
+    constructor(serviceProvider: ServiceProvider);
+    onCreate(): void;
+    /**
+     * Initializes the status service
+     *
+     * @param appVersion The version of the current application
+     * @param language The desired language of the response message
+     * @param statusEndpoint The status service to check for planned downtimes, availability and compatibilitiy
+     * @param connectivityCheckFallback The endpoint that should be invoked to thest if an internet connection is available. This is example.com as default
+     * @param timeout The timeout in milliseconds, used by all http requests. It defaults to 3 seconds
+     */
+    init(appVersion: string, language: string, statusEndpoint: string, connectivityCheckFallback?: string, timeout?: number): void;
+    /**
+     * Check the compatibility of the app and the backend.
+     * Resolves if compatible, throws error if incompatible.
+     * Displays according error to the user if incompatible.
+     */
+    checkCompatibility(): Observable<unknown>;
+    /**
+     * Check the availability of the backend.
+     * Resolves if compatible, throws error if incompatible.
+     * Displays according error to the user if incompatible.
+     */
+    checkAvailability(): Observable<unknown>;
+    /**
+     * Checks the configuration
+     */
+    private validateConfiguration;
+}

package/core/services/backend-status.service.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var t=function(e,r){return t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,e){t.__proto__=e}||function(t,e){for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&(t[r]=e[r])},t(e,r)};return function(e,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function i(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(i.prototype=r.prototype,new i)}}(),__decorate=this&&this.__decorate||function(t,e,r,i){var o,n=arguments.length,c=n<3?e:null===i?i=Object.getOwnPropertyDescriptor(e,r):i;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)c=Reflect.decorate(t,e,r,i);else for(var s=t.length-1;s>=0;s--)(o=t[s])&&(c=(n<3?o(c):n>3?o(e,r,c):o(e,r))||c);return n>3&&c&&Object.defineProperty(e,r,c),c};Object.defineProperty(exports,"__esModule",{value:!0}),exports.BackendStatusService=void 0;var base_service_1=require("./base.service"),rxjs_1=require("rxjs"),error_1=require("../models/error"),operators_1=require("rxjs/operators"),https_client_service_interface_1=require("./http/https-client/https-client.service.interface"),injection_identifier_1=require("../decorators/injection-identifier"),device_status_service_interface_1=require("./device-status.service.interface"),BackendStatusService=function(t){function e(e){return t.call(this,e)||this}return __extends(e,t),e.prototype.onCreate=function(){this.httpsClientService=this.serviceProvider.getService(https_client_service_interface_1.HttpsClientService),this.deviceStatusService=this.serviceProvider.getService(device_status_service_interface_1.DeviceStatusService)},e.prototype.init=function(t,e,r,i,o){void 0===i&&(i="https://example.com"),void 0===o&&(o=3e3),this.appVersion=t,this.language=e,this.statusEndpoint=r,this.connectivityCheckFallback=i,this.timeout=o},e.prototype.checkCompatibility=function(){var t=this;return this.validateConfiguration(),this.httpsClientService.get("".concat(this.statusEndpoint,"/compatibility?appVersion=").concat(this.appVersion,"&appName=js-partium-sdk")).pipe((0,operators_1.timeout)(this.timeout),(0,operators_1.mergeMap)((function(t){return t.requiresUpdate?(0,rxjs_1.throwError)(new error_1.SdkError(error_1.SDK_ERROR_CODES.SDK_OUTDATED,t.appDownloadLink)):(0,rxjs_1.of)(!0)})),(0,operators_1.catchError)((function(e){return t.checkAvailability().pipe((0,operators_1.map)((function(t){throw e})))})))},e.prototype.checkAvailability=function(){var t=this;return this.validateConfiguration(),(0,rxjs_1.from)(this.deviceStatusService.isConnectionAvailable()).pipe((0,operators_1.mergeMap)((function(e){if(!e)throw new error_1.SdkError(error_1.SDK_ERROR_CODES.NO_INTERNET,null);return t.httpsClientService.get("".concat(t.statusEndpoint,"/status?language=").concat(t.language)).pipe((0,operators_1.timeout)(t.timeout),(0,operators_1.mergeMap)((function(t){if(t.isUp)return(0,rxjs_1.of)(!0);throw new error_1.SdkError(error_1.SDK_ERROR_CODES.BACKEND_DOWN,t.message)})),(0,operators_1.catchError)((function(e){return e instanceof error_1.SdkError&&e.code===error_1.SDK_ERROR_CODES.BACKEND_DOWN?(0,rxjs_1.throwError)(e):t.httpsClientService.get(t.connectivityCheckFallback).pipe((0,operators_1.timeout)(t.timeout),(0,operators_1.map)((function(){throw new error_1.SdkError(error_1.SDK_ERROR_CODES.STATUS_BACKEND_DOWN,{})})),(0,operators_1.catchError)((function(t){return t instanceof error_1.SdkError&&(t.code===error_1.SDK_ERROR_CODES.BACKEND_DOWN||t.code===error_1.SDK_ERROR_CODES.STATUS_BACKEND_DOWN)?(0,rxjs_1.throwError)(t):(0,rxjs_1.throwError)(new error_1.SdkError(error_1.SDK_ERROR_CODES.NO_INTERNET,t))})))})))})))},e.prototype.validateConfiguration=function(){if(!this.appVersion)throw new Error("Invalid configuration: appVersion is ".concat(this.appVersion));if(!this.language)throw new Error("Invalid configuration: language is ".concat(this.language));if(!this.statusEndpoint)throw new Error("Invalid configuration: statusEndpoint is ".concat(this.statusEndpoint));if(!this.connectivityCheckFallback)throw new Error("Invalid configuration: statusEndpoint is ".concat(this.connectivityCheckFallback));if("number"!=typeof this.timeout)throw new Error("Invalid configuration: timeout is ".concat(this.timeout," of type ").concat(typeof this.timeout))},e=__decorate([(0,injection_identifier_1.InjectionIdentifier)("BackendStatusService")],e)}(base_service_1.BaseService);exports.BackendStatusService=BackendStatusService;

package/core/services/base-login-init.service.d.ts

@@ -0,0 +1,32 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { Observable } from "rxjs";
+import { Organization, PartiumConfig } from "..";
+import { BaseService } from "./base.service";
+/**
+ * Base class for all services that need to successfully initialize during login of the user.
+ *
+ * The init-function of Services outside the core-module can not directly be initialized,
+ * because this would lead to circular dependencies.
+ * To still allow Services to have a mandatory init-phase during login, they can be
+ * registered to be initialized during login-phase.
+ */
+export declare abstract class BaseLoginInitService extends BaseService {
+    protected config: PartiumConfig;
+    protected userEmail: string;
+    protected currentOrganization$: Observable<Organization>;
+    /**
+     * Initialization function of the service.
+     * When registered, this function will be called during login process, which can only
+     * finish successfully if this init function resolves without error.
+     *
+     * Throw an error to cancel login process.
+     *
+     * Method should be overridden by child-class
+     *
+     * @param config the PartiumConfig is passed to allow initializations using the config
+     * @param userEmail the current users eMail address
+     * @param currentOrganization$ Observable that always emits when the current organization changes
+     * @returns Observable that resolves when the initialization of the service is successful
+     */
+    init(config: PartiumConfig, userEmail: string, currentOrganization$: Observable<Organization>): Observable<void>;
+}

package/core/services/base-login-init.service.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var e=function(t,r){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])},e(t,r)};return function(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.BaseLoginInitService=void 0;var rxjs_1=require("rxjs"),base_service_1=require("./base.service"),BaseLoginInitService=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return __extends(t,e),t.prototype.init=function(e,t,r){return this.config=e,this.userEmail=t,this.currentOrganization$=r,(0,rxjs_1.of)(void 0)},t}(base_service_1.BaseService);exports.BaseLoginInitService=BaseLoginInitService;

package/core/services/base.service.d.ts

@@ -0,0 +1,31 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { ServiceProvider } from "./service-provider";
+export declare type BaseServiceClass<S extends BaseService> = {
+    new (ServiceProvider: any, ...initArgs: any[]): S;
+};
+/**
+ * Base class for all services.
+ *
+ * Singleton instance will be managed via ServiceProvider.
+ * @Injectable-decorator makes sure that the serviceProvider can address
+ * the class by it's name, even after the code is uglified.
+ */
+export declare abstract class BaseService {
+    protected serviceProvider: ServiceProvider;
+    constructor(serviceProvider: ServiceProvider);
+    /**
+     * Function that is called after the service has been instantiated and all serviceProvider.useService()-Calls
+     * are finished. This function can be overridden if needed, it will be mainly used for service-injection to
+     * get references to other base-services.
+     */
+    onCreate(): void;
+    /**
+     * Returns the name of the class as it should be used for Service-injection.
+     * This function should not be overwritten by child-classes, it will be replaced
+     * by the decorator.
+     * This is required, because class.name can not be used after uglifying the code.
+     *
+     * @returns unique name used for service-injection
+     */
+    static getInjectionIdentifierName(): string;
+}

package/core/services/base.service.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.BaseService=void 0;var BaseService=function(){function e(e){this.serviceProvider=e}return e.prototype.onCreate=function(){},e.getInjectionIdentifierName=function(){throw new Error("Class can not be used for Service-Injection. Add InjectionIdentifier-decorator if you want to do so.")},e}();exports.BaseService=BaseService;

package/core/services/device-status.service.interface.d.ts

@@ -0,0 +1,36 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { BaseService } from './base.service';
+import { DeviceInfo } from '..';
+/**
+ * Class that defines structure of a device-status-service implementation.
+ * It contains functions that give information about the device status,
+ * such as network-connectivity.
+ *
+ * An implementation of this service is required and has to be configured during
+ * the initialization phase of Partium.
+ *
+ * This class file is called interface, even though it is not an interface,
+ * but we need it to be a concrete class for the serviceProvider.
+ */
+export declare class DeviceStatusService extends BaseService {
+    /**
+     * Returns Promise that resolves with true if connection to a network is available.
+     * (Usually the internet, but for intranet-only systems it can also be only intranet)
+     *
+     * Method should be overridden by child-class
+     *
+     * @returns promise that resolves with true or false, depending on whether a
+     *          network-connection is available or not
+     */
+    isConnectionAvailable(): Promise<boolean>;
+    /**
+     * Returns Promise that resolves with a DeviceInfo object, containing
+     * information about the device and the installation.
+     * Used for logging.
+     *
+     * Method should be overridden by child-class
+     *
+     * @returns Promise that resolves with DeviceInfo
+     */
+    getDeviceInfo(): Promise<DeviceInfo>;
+}

package/core/services/device-status.service.interface.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var e=function(t,r){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])},e(t,r)};return function(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}(),__decorate=this&&this.__decorate||function(e,t,r,n){var o,i=arguments.length,c=i<3?t:null===n?n=Object.getOwnPropertyDescriptor(t,r):n;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)c=Reflect.decorate(e,t,r,n);else for(var a=e.length-1;a>=0;a--)(o=e[a])&&(c=(i<3?o(c):i>3?o(t,r,c):o(t,r))||c);return i>3&&c&&Object.defineProperty(t,r,c),c},__awaiter=this&&this.__awaiter||function(e,t,r,n){return new(r||(r=Promise))((function(o,i){function c(e){try{s(n.next(e))}catch(e){i(e)}}function a(e){try{s(n.throw(e))}catch(e){i(e)}}function s(e){var t;e.done?o(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(c,a)}s((n=n.apply(e,t||[])).next())}))},__generator=this&&this.__generator||function(e,t){var r,n,o,i,c={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:a(0),throw:a(1),return:a(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function a(a){return function(s){return function(a){if(r)throw new TypeError("Generator is already executing.");for(;i&&(i=0,a[0]&&(c=0)),c;)try{if(r=1,n&&(o=2&a[0]?n.return:a[0]?n.throw||((o=n.return)&&o.call(n),0):n.next)&&!(o=o.call(n,a[1])).done)return o;switch(n=0,o&&(a=[2&a[0],o.value]),a[0]){case 0:case 1:o=a;break;case 4:return c.label++,{value:a[1],done:!1};case 5:c.label++,n=a[1],a=[0];continue;case 7:a=c.ops.pop(),c.trys.pop();continue;default:if(!(o=c.trys,(o=o.length>0&&o[o.length-1])||6!==a[0]&&2!==a[0])){c=0;continue}if(3===a[0]&&(!o||a[1]>o[0]&&a[1]<o[3])){c.label=a[1];break}if(6===a[0]&&c.label<o[1]){c.label=o[1],o=a;break}if(o&&c.label<o[2]){c.label=o[2],c.ops.push(a);break}o[2]&&c.ops.pop(),c.trys.pop();continue}a=t.call(e,c)}catch(e){a=[6,e],n=0}finally{r=o=0}if(5&a[0])throw a[1];return{value:a[0]?a[1]:void 0,done:!0}}([a,s])}}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DeviceStatusService=void 0;var base_service_1=require("./base.service"),injection_identifier_1=require("../decorators/injection-identifier"),DeviceStatusService=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return __extends(t,e),t.prototype.isConnectionAvailable=function(){return __awaiter(this,void 0,void 0,(function(){return __generator(this,(function(e){throw new Error("In order to use the DeviceStatusService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")}))}))},t.prototype.getDeviceInfo=function(){return __awaiter(this,void 0,void 0,(function(){return __generator(this,(function(e){throw new Error("In order to use the DeviceStatusService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")}))}))},t=__decorate([(0,injection_identifier_1.InjectionIdentifier)("DeviceStatusService")],t)}(base_service_1.BaseService);exports.DeviceStatusService=DeviceStatusService;

package/core/services/file.service.interface.d.ts

@@ -0,0 +1,24 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { BaseService } from './base.service';
+import { PFileType, PFile } from '../models/p-file';
+/**
+ * Class that defines the structure for the FileService implementation.
+ *
+ * It contains functions for extract information about the assets.
+ */
+export declare class FileService extends BaseService {
+    /**
+     * Get file type of a file.
+     *
+     * @param pFile The file to get the type from.
+     * @returns Promise<PFileType> The type
+     */
+    getFileType(pFile: PFile): Promise<PFileType>;
+    /**
+     * Get dimensions of an image file.
+     *
+     * @param pFile The image file.
+     * @returns Promise<[number, number]> where first element is width and second one is height.
+     */
+    getImageDimensions(pFile: PFile): Promise<[number, number]>;
+}

package/core/services/file.service.interface.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var e=function(t,r){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])},e(t,r)};return function(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function i(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(i.prototype=r.prototype,new i)}}(),__decorate=this&&this.__decorate||function(e,t,r,i){var o,n=arguments.length,c=n<3?t:null===i?i=Object.getOwnPropertyDescriptor(t,r):i;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)c=Reflect.decorate(e,t,r,i);else for(var s=e.length-1;s>=0;s--)(o=e[s])&&(c=(n<3?o(c):n>3?o(t,r,c):o(t,r))||c);return n>3&&c&&Object.defineProperty(t,r,c),c};Object.defineProperty(exports,"__esModule",{value:!0}),exports.FileService=void 0;var base_service_1=require("./base.service"),injection_identifier_1=require("../decorators/injection-identifier"),FileService=function(e){function t(){return null!==e&&e.apply(this,arguments)||this}return __extends(t,e),t.prototype.getFileType=function(e){throw new Error("In order to use the FileService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},t.prototype.getImageDimensions=function(e){throw new Error("In order to use the FileService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},t=__decorate([(0,injection_identifier_1.InjectionIdentifier)("FileService")],t)}(base_service_1.BaseService);exports.FileService=FileService;

package/core/services/http/file-transfer/file-transfer.service.interface.d.ts

@@ -0,0 +1,57 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { ServiceProvider } from '../../service-provider';
+import { BaseService } from '../../base.service';
+import { Observable } from 'rxjs';
+import { PFile } from '../../../models/p-file';
+export declare enum TRANSFER_STATUS {
+    TRANSFERRING = 0,
+    TRANSFER_FINISHED = 1
+}
+export type UploadStatus = {
+    status: TRANSFER_STATUS;
+    progress: number;
+};
+export type DownloadStatus = {
+    status: TRANSFER_STATUS;
+    progress: number;
+    file: PFile;
+};
+/**
+ * Service interface for providing primitive file upload and download functionality.
+ * Based on the platform that is used, this service
+ * needs to be implemented accordingly.
+ *
+ * An implementation of this service is required and has to be configured during
+ * the initialization phase of Partium.
+ *
+ * This class file is called interface, even though it is not an interface,
+ * but we need it to be a concrete class for the serviceProvider.
+ */
+export declare class FileTransferService extends BaseService {
+    private readonly allowedDomains;
+    constructor(serviceProvider: ServiceProvider, knownBaseUrls: string[]);
+    protected validateIsKnownUrlOrCry(url: string): void;
+    /**
+     * Upload the given file to the given url and emit the upload status and progress during the
+     * upload-process.
+     *
+     * Method should be overridden by child-class
+     *
+     * @param fileToUpload can be any PFile type that should be uploaded (depending on platform),
+     *                     only the implementation of this interface needs to know how to deal with
+     *                     the upload
+     * @param uploadUrl    the target upload url (must be publicly available without authentication)
+     * @returns            Observable that emits the UploadStatus
+     */
+    uploadFile(fileToUpload: PFile, uploadUrl: string): Observable<UploadStatus>;
+    /**
+     * Download a file from the given url
+     *
+     * Method should be overridden by child-class
+     *
+     * @param url the download url (must be publicly available without authentication)
+     * @returns   Observable that emits the DownloadStatus and resolves with a PFile that wraps the
+     *            downloaded file in a platform-specific way
+     */
+    downloadFile(url: string): Observable<DownloadStatus>;
+}

package/core/services/http/file-transfer/file-transfer.service.interface.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var e=function(r,t){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,r){e.__proto__=r}||function(e,r){for(var t in r)Object.prototype.hasOwnProperty.call(r,t)&&(e[t]=r[t])},e(r,t)};return function(r,t){if("function"!=typeof t&&null!==t)throw new TypeError("Class extends value "+String(t)+" is not a constructor or null");function n(){this.constructor=r}e(r,t),r.prototype=null===t?Object.create(t):(n.prototype=t.prototype,new n)}}(),__decorate=this&&this.__decorate||function(e,r,t,n){var o,i=arguments.length,s=i<3?r:null===n?n=Object.getOwnPropertyDescriptor(r,t):n;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)s=Reflect.decorate(e,r,t,n);else for(var c=e.length-1;c>=0;c--)(o=e[c])&&(s=(i<3?o(s):i>3?o(r,t,s):o(r,t))||s);return i>3&&s&&Object.defineProperty(r,t,s),s},__spreadArray=this&&this.__spreadArray||function(e,r,t){if(t||2===arguments.length)for(var n,o=0,i=r.length;o<i;o++)!n&&o in r||(n||(n=Array.prototype.slice.call(r,0,o)),n[o]=r[o]);return e.concat(n||Array.prototype.slice.call(r))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.FileTransferService=exports.TRANSFER_STATUS=void 0;var TRANSFER_STATUS,base_service_1=require("../../base.service"),injection_identifier_1=require("../../../decorators/injection-identifier");!function(e){e[e.TRANSFERRING=0]="TRANSFERRING",e[e.TRANSFER_FINISHED=1]="TRANSFER_FINISHED"}(TRANSFER_STATUS||(exports.TRANSFER_STATUS=TRANSFER_STATUS={}));var FileTransferService=function(e){function r(r,t){var n=e.call(this,r)||this;return n.allowedDomains=__spreadArray(__spreadArray(["cloudfront.net","amazonaws.com","windows.net"],t.map((function(e){try{return new URL(e).host}catch(r){return e}})),!0),["FILE_URL","ASSET_URL"],!1).map((function(e){return e.toLowerCase().split(".")})),n}return __extends(r,e),r.prototype.validateIsKnownUrlOrCry=function(e){var r=e.toLowerCase();try{r=new URL(e).host}catch(e){}for(var t=0,n=this.allowedDomains;t<n.length;t++){var o=n[t],i=__spreadArray([],o,!0);do{if(r.endsWith(i.join(".")))return;i.shift()}while(i.length>2)}throw new Error("Trying to transfer files to/from unknown endpoint ".concat(e))},r.prototype.uploadFile=function(e,r){throw new Error("In order to use the FileTransferService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},r.prototype.downloadFile=function(e){throw new Error("In order to use the FileTransferService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},r=__decorate([(0,injection_identifier_1.InjectionIdentifier)("FileTransferService")],r)}(base_service_1.BaseService);exports.FileTransferService=FileTransferService;

package/core/services/http/https-client/https-client.service.interface.d.ts

@@ -0,0 +1,96 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { Observable } from 'rxjs';
+import { BaseService } from '../../base.service';
+import { ServiceProvider } from '../../service-provider';
+/**
+ * Https-Client-Service is an interface that should be implemented by the platform/framework
+ * that uses the JS-SDK. It should provide functions to do basic https-calls (like GET, POST, ...)
+ * to any web-service.
+ * Currently only GET, PATCH, POST are supported, but it could be extended
+ * easily.
+ *
+ * If you implement this service, make sure to throw the correct errors, if the request
+ * fails. (eg: SDK_ERROR_CODES.NO_INTERNET)
+ *
+ * An implementation of this service is required and has to be configured during
+ * the initialization phase of Partium.
+ *
+ * Note; We didn't implement this class as a real javascript interface to allow it to have
+ * some functionality already implemented. We could also not use an abstract class, because
+ * of the Service-Provider implementation that we use.
+ */
+export declare class HttpsClientService extends BaseService {
+    private readonly knownBaseUrls;
+    constructor(serviceProvider: ServiceProvider, knownBaseUrls: string[]);
+    protected validateIsKnownUrlOrCry(url: string): void;
+    /**
+     * Send GET request to a server.
+     *
+     * @param url       the full server url
+     * @param urlParams array of url parameters (as objects) which will be appended to the url <url>?p1=x&p2=y
+     * @param headers   object with the request headers
+     * @returns Observable that resolves with the request result
+     */
+    get(url: string, urlParams?: Array<Object>, headers?: Object): Observable<any>;
+    /**
+     * Send POST request to the server with the given url and content.
+     *
+     * @param url       the full server url
+     * @param data the data to be sent with the post request
+     * @param urlParams array of url parameters (as objects) which will be appended to the url <url>?p1=x&p2=y
+     * @param headers   object with the request headers
+     * @returns Observable that resolves with the request result
+     */
+    post(url: string, data: Object, urlParams?: Array<Object>, headers?: Object): Observable<any>;
+    /**
+     * Send PUT request to the server with the given url and content.
+     *
+     * @param url       the full server url
+     * @param data the data to be sent with the post request
+     * @param urlParams array of url parameters (as objects) which will be appended to the url <url>?p1=x&p2=y
+     * @param headers   object with the request headers
+     * @returns Observable that resolves with the request result
+     */
+    put(url: string, data: Object, urlParams?: Array<Object>, headers?: Object): Observable<any>;
+    /**
+     * Send PATCH request to the server with the given url and content.
+     *
+     * @param url       the full server url
+     * @param data the data to be sent with the patch request
+     * @param urlParams array of url parameters (as objects) which will be appended to the url <url>?p1=x&p2=y
+     * @param headers   object with the request headers
+     * @returns Observable that resolves with the request result
+     */
+    patch(url: string, data: Object, urlParams?: Array<Object>, headers?: Object): Observable<any>;
+    /**
+     * Send DELETE request to the server with the given url and content.
+     *
+     * @param url       the full server url
+     * @param urlParams array of url parameters (as objects) which will be appended to the url <url>?p1=x&p2=y
+     * @param headers   object with the request headers
+     * @returns Observable that resolves with the request result
+     */
+    delete(url: string, data?: Object, urlParams?: Array<Object>, headers?: Object): Observable<any>;
+    /**
+     * Add url parameters to the given url and return it as string.
+     * If one of the parameter already exists, it will be replaced with
+     * the new value.
+     * If an object of the array contains multiple params, all are added.
+     *
+     * @param url          the url to add the parameters to
+     * @param paramObjects array of objects with parameters that should be appended, eg: [{ pageNumber: 4 }]
+     * @returns            the given url with the appended parameters
+     */
+    protected addUrlParameters(url: string, paramObjects: Array<Object>): string;
+    /**
+     * Add an url parameter to the given url and return it as string.
+     * If the same parameter already exists, it will be replaced with
+     * the new value.
+     * If an object of the array contains multiple params, all are added.
+     *
+     * @param url         the url to add the parameter to
+     * @param paramObject the object with one or more params to append, eg: { pageNumber: 4 }
+     * @returns           the given url with the appended parameter
+     */
+    protected addUrlParameter(url: string, paramObject: Object): string;
+}

package/core/services/http/https-client/https-client.service.interface.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var e=function(t,r){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])},e(t,r)};return function(t,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function n(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}(),__decorate=this&&this.__decorate||function(e,t,r,n){var o,i=arguments.length,s=i<3?t:null===n?n=Object.getOwnPropertyDescriptor(t,r):n;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)s=Reflect.decorate(e,t,r,n);else for(var c=e.length-1;c>=0;c--)(o=e[c])&&(s=(i<3?o(s):i>3?o(t,r,s):o(t,r))||s);return i>3&&s&&Object.defineProperty(t,r,s),s};Object.defineProperty(exports,"__esModule",{value:!0}),exports.HttpsClientService=void 0;var injection_identifier_1=require("../../../decorators/injection-identifier"),general_helper_1=require("../../../utils/general-helper"),base_service_1=require("../../base.service"),HttpsClientService=function(e){function t(t,r){var n=e.call(this,t)||this;return n.knownBaseUrls=r.map((function(e){return e.toLowerCase()})),n}return __extends(t,e),t.prototype.validateIsKnownUrlOrCry=function(e){for(var t=e.toLowerCase(),r=0,n=this.knownBaseUrls;r<n.length;r++){var o=n[r];if(t.startsWith(o))return}throw new Error('The given URL is not a known service "'.concat(e,'".'))},t.prototype.get=function(e,t,r){throw new Error("In order to use the get HttpsClientService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},t.prototype.post=function(e,t,r,n){throw new Error("In order to use the post HttpsClientService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},t.prototype.put=function(e,t,r,n){throw new Error("In order to use the put HttpsClientService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},t.prototype.patch=function(e,t,r,n){throw new Error("In order to use the patch HttpsClientService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},t.prototype.delete=function(e,t,r,n){throw new Error("In order to use the delete HttpsClientService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},t.prototype.addUrlParameters=function(e,t){return(0,general_helper_1.addUrlParameters)(e,t)},t.prototype.addUrlParameter=function(e,t){return(0,general_helper_1.addUrlParameter)(e,t)},t=__decorate([(0,injection_identifier_1.InjectionIdentifier)("HttpsClientService")],t)}(base_service_1.BaseService);exports.HttpsClientService=HttpsClientService;

package/core/services/http/https.service.interface.d.ts

@@ -0,0 +1,164 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { BaseService } from '../base.service';
+import { Observable } from 'rxjs';
+import { AuthenticationConfig } from '../../models/auth-config';
+import { ServiceProvider } from '../service-provider';
+import { Organization } from '../../models/organization';
+export declare enum BACKEND_SERVICE {
+    PARTIUM = 0,
+    FIND = 1,
+    DATA = 2,
+    CSA = 3,
+    LOG = 4,
+    USER_DATA = 5,
+    OCR = 6,
+    MANAGEMENT = 7
+}
+/**
+ * Defines the structure of a https-service implementation, which
+ * is used for Partium-backend communication.
+ * This sdk provides different https-services, based on the authentication-
+ * method the user wants to use.
+ * By inheriting from this class and using serviceProvider.useService, a
+ * concrete implementation of a https-service can be chosen at runtime.
+ * This could be useful if for example a custom http-client should be used.
+ *
+ * An implementation of this service is required and has to be configured during
+ * the initialization phase of Partium.
+ *
+ * This class file is called interface, even though it is not an interface,
+ * but we need it to be a concrete class for the serviceProvider.
+ */
+export declare class HttpsService extends BaseService {
+    private httpsClientService;
+    private partiumApiBaseUrl;
+    private findBeBaseUrl;
+    private dataBeBaseUrl;
+    private csaBeBaseUrl;
+    private logBeBaseUrl;
+    private userDataBeBaseUrl;
+    private ocrBeBaseUrl;
+    private managementBeBaseUrl;
+    protected config: AuthenticationConfig;
+    private currentOrganization$;
+    constructor(serviceProvider: ServiceProvider);
+    onCreate(): void;
+    /**
+     * Initialize the https-service with configuration parameters.
+     *
+     * @param partiumApiBaseUrl: the public-api-backend base-url
+     * @param findBeBaseUrl: the partium-find-backend base-url
+     * @param dataBeBaseUrl: the partium-data-backend base-url
+     * @param csaBeBaseUrl: the partium-csa-backend base-url
+     * @param logBeBaseUrl: the partium-log-collector-backend base-url
+     * @param userDataBeBaseUrl: the partium-user-data-backend base-url
+     * @param ocrBeBaseUrl: the partium-ocr-backend base-url
+     * @param managementBeBaseUrl: the partium-management-backend base-url
+     * @param config the https service configuration
+     */
+    init(partiumApiBaseUrl: string, findBeBaseUrl: string, dataBeBaseUrl: string, csaBeBaseUrl: string, logBeBaseUrl: string, userDataBeBaseUrl: string, ocrBeBaseUrl: string, managementBeBaseUrl: string, config: AuthenticationConfig): Observable<void>;
+    /**
+     * Send GET request to the Partium-backend with the given relative url.
+     *
+     * @param url       the relative url
+     * @param urlParams array of url parameters (as objects) which will be appended to the url, eg: [{ p1: x }, { p2: y }] will become <url>?p1=x&p2=y
+     * @param beService to which backend-service should the request be sent (default FIND)
+     * @returns         Observable that resolves with the request result
+     */
+    get(url: string, urlParams?: Array<Object>, beService?: BACKEND_SERVICE): Observable<any>;
+    /**
+     * Send POST request to the Partium-backend with the given relative url and content.
+     *
+     * @param url  the relative url
+     * @param data the data to be sent with the post request
+     * @param urlParams array of url parameters (as objects) which will be appended to the url, eg: [{ p1: x }, { p2: y }] will become <url>?p1=x&p2=y
+     * @param beService to which backend-service should the request be sent (default FIND)
+     * @param headers object with custom headers to send with the request
+     * @returns    Observable that resolves with the request result
+     */
+    post(url: string, data: Object, urlParams?: Array<Object>, beService?: BACKEND_SERVICE, headers?: Object): Observable<any>;
+    /**
+     * Send PUT request to the Partium-backend with the given relative url and content.
+     *
+     * @param url  the relative url
+     * @param data the data to be sent with the post request
+     * @param urlParams array of url parameters (as objects) which will be appended to the url, eg: [{ p1: x }, { p2: y }] will become <url>?p1=x&p2=y
+     * @param beService to which backend-service should the request be sent (default FIND)
+     * @param headers object with custom headers to send with the request
+     * @returns    Observable that resolves with the request result
+     */
+    put(url: string, data: Object, urlParams?: Array<Object>, beService?: BACKEND_SERVICE, headers?: Object): Observable<any>;
+    /**
+     * Send PATCH request to the Partium-backend with the given relative url and content.
+     *
+     * @param url  the relative url
+     * @param data the data to be sent with the patch request
+     * @param urlParams array of url parameters (as objects) which will be appended to the url, eg: [{ p1: x }, { p2: y }] will become <url>?p1=x&p2=y
+     * @param beService to which backend-service should the request be sent (default FIND)
+     * @param headers object with custom headers to send with the request
+     * @returns    Observable that resolves with the request result
+     */
+    patch(url: string, data: Object, urlParams?: Array<Object>, beService?: BACKEND_SERVICE, headers?: Object): Observable<any>;
+    /**
+     * Send DELETE request to the Partium-backend with the given relative url and content.
+     *
+     * @param url  the relative url
+     * @param data the data to be sent with the delete request
+     * @param urlParams array of url parameters (as objects) which will be appended to the url, eg: [{ p1: x }, { p2: y }] will become <url>?p1=x&p2=y
+     * @param beService to which backend-service should the request be sent (default FIND)
+     * @returns    Observable that resolves with the request result
+     */
+    delete(url: string, data?: Object, urlParams?: Array<Object>, beService?: BACKEND_SERVICE): Observable<any>;
+    /**
+     * Set an observable that always holds the currently selected organization.
+     * This is needed, for adding the X-Partium-Data-Organization header to all requests.
+     *
+     * @param currentOrganization$ Observable that holds the current organization
+     */
+    setCurrentOrganization(currentOrganization$: Observable<Organization>): void;
+    /**
+     * Return whether a failed request should be retried or not.
+     * The default implementation here does not retry any requests.
+     * Any child class of this service can override this function to provide
+     * extended behavior.
+     */
+    protected retryWhen(errors: Observable<any>): Observable<any>;
+    /**
+     * Process an error received from the an http-request, by the HttpsClientService
+     * The default implementation here does nothing with the error, it only forwards
+     * it.
+     * Any child classes of this service can override this function to provide
+     * extended behavior.
+     */
+    protected processError(error: any): Observable<never>;
+    /**
+     * Creates the headers object needed for the https-requests.
+     * Since this parameters are different per authentication-method,
+     * they need to be set in a child-class of this interface.
+     *
+     * Method should be overridden by child-class
+     *
+     * @param options object with given header-parameters that will be extended with more parameters
+     * @returns the created headers object
+     */
+    protected createHeaders(options?: Object): Object;
+    /**
+     * Combine the given relative url with the Backends Base-url.
+     *
+     * @param relUrl the relative url
+     * @param beService to which backend-service should the request be sent (default FIND)
+     */
+    private createUrl;
+    /**
+   * This method calls the createHeaders method to generate the initial headers
+   * and then adds additional headers based on specific conditions.
+   *
+   * If externalUserId is configured and the backend service is not the log service,
+   * the X-Partium-ExternalUserId header is added to the headers object.
+   *
+   * @param options object with given header-parameters that will be extended with more parameters
+   * @param beService to which backend-service should the request be sent
+   * @returns the extended headers object
+     */
+    private configureHeaders;
+}

package/core/services/http/https.service.interface.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var e=function(r,t){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,r){e.__proto__=r}||function(e,r){for(var t in r)Object.prototype.hasOwnProperty.call(r,t)&&(e[t]=r[t])},e(r,t)};return function(r,t){if("function"!=typeof t&&null!==t)throw new TypeError("Class extends value "+String(t)+" is not a constructor or null");function n(){this.constructor=r}e(r,t),r.prototype=null===t?Object.create(t):(n.prototype=t.prototype,new n)}}(),__decorate=this&&this.__decorate||function(e,r,t,n){var o,i=arguments.length,s=i<3?r:null===n?n=Object.getOwnPropertyDescriptor(r,t):n;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)s=Reflect.decorate(e,r,t,n);else for(var c=e.length-1;c>=0;c--)(o=e[c])&&(s=(i<3?o(s):i>3?o(r,t,s):o(r,t))||s);return i>3&&s&&Object.defineProperty(r,t,s),s};Object.defineProperty(exports,"__esModule",{value:!0}),exports.HttpsService=exports.BACKEND_SERVICE=void 0;var BACKEND_SERVICE,base_service_1=require("../base.service"),rxjs_1=require("rxjs"),operators_1=require("rxjs/operators"),https_client_service_interface_1=require("./https-client/https-client.service.interface"),injection_identifier_1=require("../../decorators/injection-identifier");!function(e){e[e.PARTIUM=0]="PARTIUM",e[e.FIND=1]="FIND",e[e.DATA=2]="DATA",e[e.CSA=3]="CSA",e[e.LOG=4]="LOG",e[e.USER_DATA=5]="USER_DATA",e[e.OCR=6]="OCR",e[e.MANAGEMENT=7]="MANAGEMENT"}(BACKEND_SERVICE||(exports.BACKEND_SERVICE=BACKEND_SERVICE={}));var HttpsService=function(e){function r(r){return e.call(this,r)||this}return __extends(r,e),r.prototype.onCreate=function(){this.httpsClientService=this.serviceProvider.getService(https_client_service_interface_1.HttpsClientService)},r.prototype.init=function(e,r,t,n,o,i,s,c,a){return this.partiumApiBaseUrl=e,this.findBeBaseUrl=r,this.dataBeBaseUrl=t,this.csaBeBaseUrl=n,this.logBeBaseUrl=o,this.userDataBeBaseUrl=i,this.ocrBeBaseUrl=s,this.managementBeBaseUrl=c,this.config=a,(0,rxjs_1.of)(void 0)},r.prototype.get=function(e,r,t){var n=this;return(0,rxjs_1.defer)((function(){return n.configureHeaders({},t)})).pipe((0,operators_1.mergeMap)((function(o){return n.httpsClientService.get(n.createUrl(e,t),r,o)})),(0,operators_1.retryWhen)((function(e){return n.retryWhen(e)})),(0,operators_1.catchError)((function(e){return n.processError(e)})))},r.prototype.post=function(e,r,t,n,o){var i=this;return(0,rxjs_1.defer)((function(){return i.configureHeaders(o,n)})).pipe((0,operators_1.mergeMap)((function(o){return i.httpsClientService.post(i.createUrl(e,n),r,t,o)})),(0,operators_1.retryWhen)((function(e){return i.retryWhen(e)})),(0,operators_1.catchError)((function(e){return i.processError(e)})))},r.prototype.put=function(e,r,t,n,o){var i=this;return(0,rxjs_1.defer)((function(){return i.configureHeaders(o,n)})).pipe((0,operators_1.mergeMap)((function(o){return i.httpsClientService.put(i.createUrl(e,n),r,t,o)})),(0,operators_1.retryWhen)((function(e){return i.retryWhen(e)})),(0,operators_1.catchError)((function(e){return i.processError(e)})))},r.prototype.patch=function(e,r,t,n,o){var i=this;return(0,rxjs_1.defer)((function(){return i.configureHeaders(o,n)})).pipe((0,operators_1.mergeMap)((function(o){return i.httpsClientService.patch(i.createUrl(e,n),r,t,o)})),(0,operators_1.retryWhen)((function(e){return i.retryWhen(e)})),(0,operators_1.catchError)((function(e){return i.processError(e)})))},r.prototype.delete=function(e,r,t,n){var o=this;return(0,rxjs_1.defer)((function(){return o.configureHeaders({},n)})).pipe((0,operators_1.mergeMap)((function(i){return o.httpsClientService.delete(o.createUrl(e,n),r,t,i)})),(0,operators_1.retryWhen)((function(e){return o.retryWhen(e)})),(0,operators_1.catchError)((function(e){return o.processError(e)})))},r.prototype.setCurrentOrganization=function(e){this.currentOrganization$=e},r.prototype.retryWhen=function(e){return e.pipe((0,operators_1.mergeMap)((function(e){return(0,rxjs_1.throwError)(e)})))},r.prototype.processError=function(e){return(0,rxjs_1.throwError)(e)},r.prototype.createHeaders=function(e){throw new Error("In order to use the HttpsService, don't directly use this class, but one of it's descendants, by choosing a replacement with serviceProvider.useService().")},r.prototype.createUrl=function(e,r){for(void 0===r&&(r=BACKEND_SERVICE.FIND);e.startsWith("/");)e=e.substring(1);var t;switch(r){case BACKEND_SERVICE.PARTIUM:t=this.partiumApiBaseUrl;break;case BACKEND_SERVICE.DATA:t=this.dataBeBaseUrl;break;case BACKEND_SERVICE.CSA:t=this.csaBeBaseUrl;break;case BACKEND_SERVICE.LOG:t=this.logBeBaseUrl;break;case BACKEND_SERVICE.USER_DATA:t=this.userDataBeBaseUrl;break;case BACKEND_SERVICE.OCR:t=this.ocrBeBaseUrl;break;case BACKEND_SERVICE.MANAGEMENT:t=this.managementBeBaseUrl;break;case BACKEND_SERVICE.FIND:default:t=this.findBeBaseUrl}return[t,e].join("/")},r.prototype.configureHeaders=function(e,r){var t=this.createHeaders(e);return this.config.externalUserId&&r!==BACKEND_SERVICE.LOG&&(t["X-Partium-ExternalUserId"]=this.config.externalUserId),this.currentOrganization$?this.currentOrganization$.pipe((0,operators_1.first)(),(0,operators_1.map)((function(e){return(null==e?void 0:e.name)&&(t["X-Partium-Data-Organization"]=e.name),t}))):(0,rxjs_1.of)(t)},r=__decorate([(0,injection_identifier_1.InjectionIdentifier)("HttpsService")],r)}(base_service_1.BaseService);exports.HttpsService=HttpsService;