@partium/js-sdk 13.0.0

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@partium/js-sdk",
+  "version": "13.0.0",
+  "author": "Partium Inc.",
+  "license": "(c) Partium Inc. 2020-2025. All rights reserved.",
+  "description": "SDK to provide Partium-Search features to JavaScript based applications.",
+  "typings": "index.d.ts",
+  "directories": {
+    "doc": "docs"
+  },
+  "scripts": {
+    "extract-package-version": "cd ../publish/scripts && node extract-package-version.js",
+    "test": "jest",
+    "test-compact": "jest 2>&1 | grep -E 'FAIL|●|Tests:|Test Suites:' | grep -v '● Console'"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.int.partium.io:partium/js-partium-sdk.git"
+  },
+  "dependencies": {
+    "@ua-parser-js/pro-enterprise": "~2.0.0-beta.3",
+    "axios": "~1.7.7",
+    "axios-observable": "~2.0.0",
+    "base-64": "~1.0.0",
+    "idb-keyval": "~6.2.1",
+    "jwt-decode": "~4.0.0",
+    "lodash": "~4.17.21",
+    "query-string": "~7.1.3",
+    "rxjs": "~7.8.1",
+    "tslib": "~2.7.0"
+  },
+  "devDependencies": {
+    "@types/jest": "~29.5.12",
+    "@types/lodash": "~4.17.7",
+    "jest": "~29.7.0",
+    "jest-environment-jsdom": "~29.7.0",
+    "jest-jasmine2": "~29.7.0",
+    "jest-junit": "~16.0.0",
+    "jest-mock-axios": "~4.7.3",
+    "rimraf": "~6.0.1",
+    "ts-jest": "~29.2.5",
+    "ts-node": "~10.9.2",
+    "typescript": "~5.5.4"
+  }
+}

package/user-data/index.d.ts

@@ -0,0 +1,5 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+export * from './models/part-with-nullable';
+export * from './models/request-list/request-list';
+export * from './services/request-list/request-list.service';
+export * from './services/favorite/favorite.service';

package/user-data/index.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,i){void 0===i&&(i=t);var o=Object.getOwnPropertyDescriptor(r,t);o&&!("get"in o?!r.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,i,o)}:function(e,r,t,i){void 0===i&&(i=t),e[i]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./models/part-with-nullable"),exports),__exportStar(require("./models/request-list/request-list"),exports),__exportStar(require("./services/request-list/request-list.service"),exports),__exportStar(require("./services/favorite/favorite.service"),exports);

package/user-data/models/part-with-nullable.d.ts

@@ -0,0 +1,5 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { Part } from "../../data/models/part";
+export type PartWithNullable = {
+    [K in keyof Part]?: Part[K];
+};

package/user-data/models/part-with-nullable.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/user-data/models/request-list/request-list.d.ts

@@ -0,0 +1,16 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { APIObject } from "../../../core/models/api-object";
+import { PartWithNullable } from "../part-with-nullable";
+export interface IRequestedPart extends PartWithNullable {
+    quantity?: number;
+}
+export declare class RequestList extends APIObject {
+    list: Array<IRequestedPart>;
+    constructor(init?: Partial<RequestList>);
+    updateQuantity(partId: string, quantity: number): void;
+    updateRequestList(update?: Partial<RequestList>): void;
+    static fromAPIResponse(requestedPartList: Array<{
+        quantity: number;
+        part_id: string;
+    }>): RequestList;
+}

package/user-data/models/request-list/request-list.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var t=function(n,e){return t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,n){t.__proto__=n}||function(t,n){for(var e in n)Object.prototype.hasOwnProperty.call(n,e)&&(t[e]=n[e])},t(n,e)};return function(n,e){if("function"!=typeof e&&null!==e)throw new TypeError("Class extends value "+String(e)+" is not a constructor or null");function r(){this.constructor=n}t(n,e),n.prototype=null===e?Object.create(e):(r.prototype=e.prototype,new r)}}(),__assign=this&&this.__assign||function(){return __assign=Object.assign||function(t){for(var n,e=1,r=arguments.length;e<r;e++)for(var i in n=arguments[e])Object.prototype.hasOwnProperty.call(n,i)&&(t[i]=n[i]);return t},__assign.apply(this,arguments)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.RequestList=void 0;var api_object_1=require("../../../core/models/api-object"),RequestList=function(t){function n(n){var e=t.call(this)||this;return e.list=[],Object.assign(e,n),e}return __extends(n,t),n.prototype.updateQuantity=function(t,n){!!this.list.find((function(n){return t===n.partiumId}))&&(this.list=this.list.map((function(e){return e.partiumId===t?__assign(__assign({},e),{quantity:n}):e})))},n.prototype.updateRequestList=function(t){Object.assign(this,t)},n.fromAPIResponse=function(t){return new n({list:t.map((function(t){return{quantity:t.quantity,partiumId:t.part_id}}))})},n}(api_object_1.APIObject);exports.RequestList=RequestList;

package/user-data/services/favorite/favorite.service.d.ts

@@ -0,0 +1,45 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { Observable } from 'rxjs';
+import { BaseLoginInitService, EventContext, Organization, PartiumConfig, ServiceProvider } from '../../../core';
+interface FavoriteEventContext extends EventContext {
+    organizationId?: string;
+    searchSessionId?: string;
+}
+export interface FavoriteService {
+    /**
+     * Fetches the list of favorites.
+     *
+     * @returns Observable with an array of Partium part ids that resolves
+     * with the request to the backend.
+     */
+    getFavoriteList(): Observable<Array<string>>;
+    /**
+     * Adds a part to the list of favorites via the parts Partium-ID
+     *
+     * @param partId the part partId to save as Favorite
+     * @returns Observable with an array of Partium part ids that resolves
+     * with the request to the backend.
+     */
+    addToFavorites(partId: string, favoriteEventContext?: FavoriteEventContext): Observable<Array<string>>;
+    /**
+     * Removes a part to the list of favorites via the parts Partium-ID
+     *
+     * @param partId the part partId to be removed from the Favorites
+     * @returns Observable with an array of Partium part ids that resolves
+     * with the request to the backend.
+     */
+    removeFromFavorites(partId: string, favoriteEventContext?: FavoriteEventContext): Observable<Array<string>>;
+}
+export declare class FavoriteServiceImpl extends BaseLoginInitService implements FavoriteService {
+    private httpsService;
+    private logService;
+    private maxFavoritesLength;
+    constructor(serviceProvider: ServiceProvider);
+    init(config: PartiumConfig, userEmail: string, currentOrganization$: Observable<Organization>): Observable<void>;
+    onCreate(): void;
+    private dispatchLogService;
+    getFavoriteList(): Observable<Array<string>>;
+    addToFavorites(partId: string, favoriteEventContext?: FavoriteEventContext): Observable<Array<string>>;
+    removeFromFavorites(partId: string, favoriteEventContext?: FavoriteEventContext): Observable<Array<string>>;
+}
+export {};

package/user-data/services/favorite/favorite.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 o(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(o.prototype=r.prototype,new o)}}(),__decorate=this&&this.__decorate||function(e,t,r,o){var i,n=arguments.length,c=n<3?t:null===o?o=Object.getOwnPropertyDescriptor(t,r):o;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)c=Reflect.decorate(e,t,r,o);else for(var s=e.length-1;s>=0;s--)(i=e[s])&&(c=(n<3?i(c):n>3?i(t,r,c):i(t,r))||c);return n>3&&c&&Object.defineProperty(t,r,c),c},__spreadArray=this&&this.__spreadArray||function(e,t,r){if(r||2===arguments.length)for(var o,i=0,n=t.length;i<n;i++)!o&&i in t||(o||(o=Array.prototype.slice.call(t,0,i)),o[i]=t[i]);return e.concat(o||Array.prototype.slice.call(t))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.FavoriteServiceImpl=void 0;var rxjs_1=require("rxjs"),operators_1=require("rxjs/operators"),core_1=require("../../../core"),FavoriteServiceImpl=function(e){function t(t){var r=e.call(this,t)||this;return r.logService=t.getService(core_1.LogServiceImpl),r}return __extends(t,e),t.prototype.init=function(t,r,o){return e.prototype.init.call(this,t,r,o),this.maxFavoritesLength=t.favoritePartsMaxPartLength,console.log("Favorites Service - init: maxFavoritesLength: ",this.maxFavoritesLength),(0,rxjs_1.of)(void 0)},t.prototype.onCreate=function(){this.httpsService=this.serviceProvider.getService(core_1.HttpsService)},t.prototype.dispatchLogService=function(e,t,r){var o=new core_1.EventLog({version:core_1.EVENTLOG_VERSIONS.V_2_0_0,organizationId:null==r?void 0:r.organizationId,interface:(null==r?void 0:r.eventInterface)||core_1.INTERFACE.API_ACCESS,event:e,data:{partiumId:t,searchSessionId:null==r?void 0:r.searchSessionId}});this.logService.logEvent(o).subscribe((function(){}),(function(e){console.log("Error while sending log event: ",e)}))},t.prototype.getFavoriteList=function(){return this.httpsService.get("favorites",null,core_1.BACKEND_SERVICE.USER_DATA)},t.prototype.addToFavorites=function(e,t){var r=this;return this.getFavoriteList().pipe((0,operators_1.switchMap)((function(o){if(!o.includes(e)){var i=__spreadArray([],o,!0);return i.unshift(e),i=i.splice(0,r.maxFavoritesLength),r.httpsService.post("favorites",i,null,core_1.BACKEND_SERVICE.USER_DATA).pipe((0,operators_1.tap)((function(){r.dispatchLogService(core_1.EVENT.FAVORITES_ADD,e,t)})))}return console.log("Nothing added - already part of favorites"),(0,rxjs_1.of)(o)})))},t.prototype.removeFromFavorites=function(e,t){var r=this;return this.getFavoriteList().pipe((0,operators_1.switchMap)((function(o){var i=o.indexOf(e);if(i>-1){var n=__spreadArray([],o,!0);return n.splice(i,1),r.httpsService.post("favorites",n,null,core_1.BACKEND_SERVICE.USER_DATA).pipe((0,operators_1.tap)((function(){r.dispatchLogService(core_1.EVENT.FAVORITES_REMOVE,e,t)})))}return console.log("Nothing was removed - did not exist"),(0,rxjs_1.of)(o)})))},t=__decorate([(0,core_1.InjectionIdentifier)("FavoriteService")],t)}(core_1.BaseLoginInitService);exports.FavoriteServiceImpl=FavoriteServiceImpl;

package/user-data/services/request-list/request-list.service.d.ts

@@ -0,0 +1,97 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { IRequestedPart } from '../../models/request-list/request-list';
+import { Observable } from 'rxjs';
+import { EventContext } from '../../../core/models/log';
+import { BaseService } from '../../../core/services/base.service';
+import { LogService } from '../../../core/services/log.service';
+import { ServiceProvider } from '../../../core/services/service-provider';
+import { SearchService } from '../../../find';
+interface RequestListEventContext extends EventContext {
+    organizationId?: string;
+    searchSessionId?: string;
+}
+/**
+ * Service that provides functionality for creating and updating the request list.
+ * It allows to add, remove and edit requested parts from the request list
+ */
+export interface RequestListService {
+    /**
+     * Updates the request list when new quantities are added to any of the request
+     * list items is edited.
+     *
+     * @param requestedParts An array of type IRequestedPart of all the requested
+     * parts in the list
+     * @param updatedPart the part that is going to be added to the list
+     * @param requestListEventContext (optional) RequestListEventContext object to add the missing data that will be logged using the log format V2
+     * @returns Observable with an array of the parts that resolves with the request
+     * to the backend.
+     */
+    updateRequestList(requestedParts: Array<IRequestedPart>, updatedPart: IRequestedPart, requestListEventContext?: RequestListEventContext): Observable<Array<IRequestedPart>>;
+    /**
+     * Adds a new part to the request list.
+     *
+     * @param requestedParts An array of type IRequestedPart of all the requested
+     * parts in the list
+     * @param addedPart the part that is going to be added to the list
+     * @param requestListEventContext (optional) RequestListEventContext object to add the missing data that will be logged using the log format V2
+     * @returns Observable with an array of the parts that resolves with the request
+     * to the backend.
+     */
+    addPart(requestedParts: Array<IRequestedPart>, addedPart: IRequestedPart, requestListEventContext?: RequestListEventContext): Observable<Array<IRequestedPart>>;
+    /**
+     * Fetches the parts of the request list.
+     *
+     * @returns Observable with an array of the parts that resolves with the request
+     * to the backend.
+     */
+    getRequestList(): Observable<Array<IRequestedPart>>;
+    /**
+     * Resets the requests list to an empty array of parts.
+     * @param requestListEventContext (optional) RequestListEventContext object to add the missing data that will be logged using the log format V2
+     * @returns Observable with an array of empty the parts that resolves with the
+     * request to the backend.
+     */
+    resetList(requestListEventContext?: RequestListEventContext): Observable<Array<IRequestedPart>>;
+    /**
+     * Deletes one part from the requestedList.
+     *
+     * @param partiumId the id of the part that is going to be removed
+     * @param requestListEventContext (optional) RequestListEventContext object to add the missing data that will be logged using the log format V2
+     * @returns Observable with a boolean
+     */
+    deletePart(partiumId: string, requestListEventContext?: RequestListEventContext): Observable<boolean>;
+    /**
+     * Saves a group of parts in the requestList.
+     *
+     * @param updatedParts An array of type IRequestedPart of all the requested parts
+     * that are going to be added to the list.
+     * @param requestListEventContext (optional) RequestListEventContext object to add the missing data that will be logged using the log format V2
+     * @returns Observable with an array of  the request list of the saved parts.
+     */
+    saveRequestList(updatedParts: IRequestedPart[], requestListEventContext?: RequestListEventContext): Observable<Array<IRequestedPart>>;
+}
+export declare class RequestListServiceImpl extends BaseService implements RequestListService {
+    private httpsService;
+    protected logService: LogService;
+    protected searchService: SearchService;
+    constructor(serviceProvider: ServiceProvider);
+    onCreate(): void;
+    saveRequestList(updatedParts: IRequestedPart[], requestListEventContext: any): Observable<Array<IRequestedPart>>;
+    updateRequestList(requestedParts: Array<IRequestedPart>, updatedPart: IRequestedPart, requestListEventContext?: RequestListEventContext): Observable<Array<IRequestedPart>>;
+    addPart(requestedParts: Array<IRequestedPart>, addedPart: IRequestedPart, requestListEventContext?: RequestListEventContext): Observable<Array<IRequestedPart>>;
+    getRequestList(): Observable<Array<IRequestedPart>>;
+    /**
+     * Resets the requests list to an empty array of parts.
+     */
+    resetList(requestListEventContext?: RequestListEventContext): Observable<Array<IRequestedPart>>;
+    /**
+     * DELETE a part from request-list without send entire list to update
+     */
+    deletePart(partiumId: string, requestListEventContext?: RequestListEventContext): Observable<boolean>;
+    /**
+     * Post a requestList to the server to be stored in the cloud.
+     */
+    private postRequestList;
+    private dispatchLogService;
+}
+export {};

package/user-data/services/request-list/request-list.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 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,s=arguments.length,n=s<3?t:null===i?i=Object.getOwnPropertyDescriptor(t,r):i;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(e,t,r,i);else for(var c=e.length-1;c>=0;c--)(o=e[c])&&(n=(s<3?o(n):s>3?o(t,r,n):o(t,r))||n);return s>3&&n&&Object.defineProperty(t,r,n),n},__spreadArray=this&&this.__spreadArray||function(e,t,r){if(r||2===arguments.length)for(var i,o=0,s=t.length;o<s;o++)!i&&o in t||(i||(i=Array.prototype.slice.call(t,0,o)),i[o]=t[o]);return e.concat(i||Array.prototype.slice.call(t))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.RequestListServiceImpl=void 0;var request_list_1=require("../../models/request-list/request-list"),operators_1=require("rxjs/operators"),log_1=require("../../../core/models/log"),injection_identifier_1=require("../../../core/decorators/injection-identifier"),https_service_interface_1=require("../../../core/services/http/https.service.interface"),base_service_1=require("../../../core/services/base.service"),log_service_1=require("../../../core/services/log.service"),RequestListServiceImpl=function(e){function t(t){return e.call(this,t)||this}return __extends(t,e),t.prototype.onCreate=function(){this.httpsService=this.serviceProvider.getService(https_service_interface_1.HttpsService),this.logService=this.serviceProvider.getService(log_service_1.LogServiceImpl)},t.prototype.saveRequestList=function(e,t){var r=this,i=e.map((function(e){return{partiumId:e.partiumId,quantity:e.quantity}}));return this.postRequestList(e).pipe((0,operators_1.tap)((function(){return r.dispatchLogService(log_1.EVENT.SHOPPING_CART_UPDATE,{list:__spreadArray([],i,!0)},t)})))},t.prototype.updateRequestList=function(e,t,r){var i=e.map((function(e){return e.partiumId===t.partiumId?{partiumId:e.partiumId,quantity:t.quantity}:e}));return this.addPart(i,t,r)},t.prototype.addPart=function(e,t,r){var i=this,o=!!e.find((function(e){return e.partiumId===t.partiumId})),s=o?e:__spreadArray(__spreadArray([],e,!0),[t],!1),n=o?t.quantity:1;return this.postRequestList(s).pipe((0,operators_1.tap)((function(){i.dispatchLogService(log_1.EVENT.SHOPPING_CART_ADD_PART,{partiumId:t.partiumId,quantity:n,searchSessionId:null==r?void 0:r.searchSessionId},r)})))},t.prototype.getRequestList=function(){return this.httpsService.get("request-list",null,https_service_interface_1.BACKEND_SERVICE.USER_DATA).pipe((0,operators_1.map)((function(e){return request_list_1.RequestList.fromAPIResponse(e).list})))},t.prototype.resetList=function(e){var t=this;return this.postRequestList([]).pipe((0,operators_1.tap)((function(){return t.dispatchLogService(log_1.EVENT.SHOPPING_CART_REMOVE_ALL_PARTS,{},e)})),(0,operators_1.catchError)((function(e){console.log("Reset list log error",e)})))},t.prototype.deletePart=function(e,t){var r=this;return this.httpsService.delete("request-list/items/".concat(e),null,[],https_service_interface_1.BACKEND_SERVICE.USER_DATA).pipe((0,operators_1.tap)((function(){return r.dispatchLogService(log_1.EVENT.SHOPPING_CART_REMOVE_PART,{partiumId:e},t)})),(0,operators_1.map)((function(){return!0})))},t.prototype.postRequestList=function(e){var t=e.map((function(e){return{quantity:e.quantity,part_id:e.partiumId}}));return this.httpsService.post("request-list",t,[],https_service_interface_1.BACKEND_SERVICE.USER_DATA).pipe((0,operators_1.map)((function(e){return request_list_1.RequestList.fromAPIResponse(e).list})))},t.prototype.dispatchLogService=function(e,t,r){this.logService.logEvent(new log_1.EventLog({version:log_1.EVENTLOG_VERSIONS.V_2_0_0,organizationId:null==r?void 0:r.organizationId,interface:(null==r?void 0:r.eventInterface)||log_1.INTERFACE.API_ACCESS,event:e,data:t})).subscribe((function(){}),(function(e){console.log("Error while sending log event: ",e)}))},t=__decorate([(0,injection_identifier_1.InjectionIdentifier)("RequestListService")],t)}(base_service_1.BaseService);exports.RequestListServiceImpl=RequestListServiceImpl;