@partium/js-sdk 16.0.0 → 16.2.0

package/part-list/services/part-list.service.d.ts

@@ -0,0 +1,107 @@
+// Copyright © 2022-2026 Partium, Inc. DBA Partium
+import { Observable } from 'rxjs';
+import { BaseService } from '../../core';
+import { PartListSearchSummaryResponse } from '../models/part-list-search-summary-response';
+import { AddPartsToPartListRequest } from '../models/add-parts-to-part-list-request';
+import { AddPartsToPartListResponse } from '../models/add-parts-to-part-list-response';
+import { RemovePartsFromPartListRequest } from '../models/remove-parts-from-part-list-request';
+import { RemovePartsFromPartListResponse } from '../models/remove-parts-from-part-list-response';
+import { AddAllSearchSessionPartsToPartListRequest } from '../models/add-all-search-session-parts-to-part-list-request';
+import { AddAllSearchSessionPartsToPartListResponse } from '../models/add-all-search-session-parts-to-part-list-response';
+import { RemoveAllSearchSessionPartsFromPartListRequest } from '../models/remove-all-search-session-parts-from-part-list-request';
+import { RemoveAllSearchSessionPartsFromPartListResponse } from '../models/remove-all-search-session-parts-from-part-list-response';
+import { CreateSelectionRequest } from '../models/create-selection-request';
+import { CreateSelectionResponse } from '../models/create-selection-response';
+import { CreateCollectionFromFileRequest } from '../models/create-collection-from-file-request';
+import { CreateCollectionFromFileResponse } from '../models/create-collection-from-file-response';
+import { CheckWhichPartsInPartListRequest } from '../models/check-which-parts-in-part-list-request';
+import { CheckWhichPartsInPartListResponse } from '../models/check-which-parts-in-part-list-response';
+import { EmptyPartListRequest } from '../models/empty-part-list-request';
+import { EmptyPartListResponse } from '../models/empty-part-list.response';
+/**
+ * Service for creating and managing part-lists. A part-list can be created either as a
+ * selection (`createSelection`) or as a collection from an uploaded file
+ * (`createCollectionFromFile`); every other operation applies to a part-list regardless
+ * of how it was created.
+ */
+export interface PartListService {
+    /**
+     * Create a new selection (a part-list).
+     *
+     * @returns An Observable that emits the response
+     */
+    createSelection(request: CreateSelectionRequest): Observable<CreateSelectionResponse>;
+    /**
+     * Create a new collection (a part-list) from a file of part-ids.
+     *
+     * @param request - The request containing the file to upload.
+     * @returns An Observable that emits the response
+     */
+    createCollectionFromFile(request: CreateCollectionFromFileRequest): Observable<CreateCollectionFromFileResponse>;
+    /**
+     * Add parts to the given part-list.
+     *
+     * @param partListId - The part-list id.
+     * @param request - The request containing the part ids to add.
+     * @returns An Observable that emits the response
+     */
+    addPartsToPartList(partListId: string, request: AddPartsToPartListRequest): Observable<AddPartsToPartListResponse>;
+    /**
+     * Remove parts from the given part-list.
+     *
+     * @param partListId - The part-list id.
+     * @param request - The request containing the part ids to remove.
+     * @returns An Observable that emits the response
+     */
+    removePartsFromPartList(partListId: string, request: RemovePartsFromPartListRequest): Observable<RemovePartsFromPartListResponse>;
+    /**
+     * Add all parts from the connected search session to the given part-list.
+     *
+     * @param partListId - The part-list id.
+     * @param request - The request containing the search session id to add the parts to.
+     * @returns An Observable that emits the response
+     */
+    addAllSearchSessionPartsToPartList(partListId: string, request: AddAllSearchSessionPartsToPartListRequest): Observable<AddAllSearchSessionPartsToPartListResponse>;
+    /**
+     * Remove all parts from the connected search session from the given part-list.
+     *
+     * @param partListId - The part-list id.
+     * @param request - The request containing the search session id to remove the parts from.
+     * @returns An Observable that emits the response
+     */
+    removeAllSearchSessionPartsFromPartList(partListId: string, request: RemoveAllSearchSessionPartsFromPartListRequest): Observable<RemoveAllSearchSessionPartsFromPartListResponse>;
+    /**
+     * Empty the given part-list.
+     *
+     * @param partListId - The part-list id.
+     * @returns An Observable that emits the response
+     */
+    emptyPartList(partListId: string, request: EmptyPartListRequest): Observable<EmptyPartListResponse>;
+    /**
+     * Get the add and remove parts count for the given part-list.
+     *
+     * @param partListId - The part-list id.
+     * @returns An Observable that emits the add and remove parts count.
+     */
+    getSearchSummary(partListId: string): Observable<PartListSearchSummaryResponse>;
+    /**
+     * Given part ids (e.g. from search), returns which of them are already in the part-list.
+     *
+     * @param partListId - The part-list id.
+     * @param request - Part ids to check.
+     */
+    checkWhichPartsInPartList(partListId: string, request: CheckWhichPartsInPartListRequest): Observable<CheckWhichPartsInPartListResponse>;
+}
+export declare class PartListServiceImpl extends BaseService implements PartListService {
+    private httpsService;
+    onCreate(): void;
+    createSelection(request: CreateSelectionRequest): Observable<CreateSelectionResponse>;
+    createCollectionFromFile(request: CreateCollectionFromFileRequest): Observable<CreateCollectionFromFileResponse>;
+    addPartsToPartList(partListId: string, request: AddPartsToPartListRequest): Observable<AddPartsToPartListResponse>;
+    removePartsFromPartList(partListId: string, request: RemovePartsFromPartListRequest): Observable<RemovePartsFromPartListResponse>;
+    addAllSearchSessionPartsToPartList(partListId: string, request: AddAllSearchSessionPartsToPartListRequest): Observable<AddAllSearchSessionPartsToPartListResponse>;
+    removeAllSearchSessionPartsFromPartList(partListId: string, request: RemoveAllSearchSessionPartsFromPartListRequest): Observable<RemoveAllSearchSessionPartsFromPartListResponse>;
+    emptyPartList(partListId: string, request: EmptyPartListRequest): Observable<EmptyPartListResponse>;
+    getSearchSummary(partListId: string): Observable<PartListSearchSummaryResponse>;
+    checkWhichPartsInPartList(partListId: string, request: CheckWhichPartsInPartListRequest): Observable<CheckWhichPartsInPartListResponse>;
+}

package/part-list/services/part-list.service.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2026 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 o(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(o.prototype=r.prototype,new o)}}(),__decorate=this&&this.__decorate||function(t,e,r,o){var c,i=arguments.length,n=i<3?e:null===o?o=Object.getOwnPropertyDescriptor(e,r):o;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)n=Reflect.decorate(t,e,r,o);else for(var s=t.length-1;s>=0;s--)(c=t[s])&&(n=(i<3?c(n):i>3?c(e,r,n):c(e,r))||n);return i>3&&n&&Object.defineProperty(e,r,n),n};Object.defineProperty(exports,"__esModule",{value:!0}),exports.PartListServiceImpl=void 0;var core_1=require("../../core"),PartListServiceImpl=function(t){function e(){return null!==t&&t.apply(this,arguments)||this}return __extends(e,t),e.prototype.onCreate=function(){this.httpsService=this.serviceProvider.getService(core_1.HttpsService)},e.prototype.createSelection=function(t){return this.httpsService.post("selections",t,[],core_1.BACKEND_SERVICE.PART_LIST)},e.prototype.createCollectionFromFile=function(t){var e=this;return(0,core_1.guardMultipartUpload)(t.file,(function(){return(0,core_1.postPFileMultipartRequest)(e.httpsService,{url:"collections",file:t.file,fieldName:"file",backend:core_1.BACKEND_SERVICE.PART_LIST})}))},e.prototype.addPartsToPartList=function(t,e){return this.httpsService.post("".concat(t,"/parts/add"),e,[],core_1.BACKEND_SERVICE.PART_LIST)},e.prototype.removePartsFromPartList=function(t,e){return this.httpsService.post("".concat(t,"/parts/remove"),e,[],core_1.BACKEND_SERVICE.PART_LIST)},e.prototype.addAllSearchSessionPartsToPartList=function(t,e){return this.httpsService.post("".concat(t,"/search/add"),e,[],core_1.BACKEND_SERVICE.PART_LIST)},e.prototype.removeAllSearchSessionPartsFromPartList=function(t,e){return this.httpsService.post("".concat(t,"/search/remove"),e,[],core_1.BACKEND_SERVICE.PART_LIST)},e.prototype.emptyPartList=function(t,e){return this.httpsService.post("".concat(t,"/parts/empty"),e,[],core_1.BACKEND_SERVICE.PART_LIST)},e.prototype.getSearchSummary=function(t){return this.httpsService.get("".concat(t,"/search/summary"),[],core_1.BACKEND_SERVICE.PART_LIST)},e.prototype.checkWhichPartsInPartList=function(t,e){return this.httpsService.post("".concat(t,"/parts/check"),e,[],core_1.BACKEND_SERVICE.PART_LIST)},e=__decorate([(0,core_1.InjectionIdentifier)("PartListService")],e)}(core_1.BaseService);exports.PartListServiceImpl=PartListServiceImpl;