@partium/js-sdk 13.0.0

package/find/models/search-result-status.d.ts

@@ -0,0 +1,33 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+export declare enum SEARCH_RESULT_STATUS {
+    CREATED = "created",
+    RUNNING = "running",
+    FINISHED = "finished"
+}
+export declare enum ASYNC_TAG_STATUS {
+    PENDING = "pending",
+    RECEIVED = "received",
+    WILL_NOT_RECEIVE = "will-not-receive"
+}
+export declare enum ASYNC_RESULT_STATUS {
+    PENDING = "pending",
+    RECEIVED = "received",
+    WILL_NOT_RECEIVE = "will-not-receive"
+}
+export declare enum SMART_FILTERS_STATUS {
+    PENDING = "pending",
+    RECEIVED = "received",
+    WILL_NOT_RECEIVE = "will-not-receive"
+}
+/**
+ * Status of a search session.
+ *
+ * @deprecated with the new search, the SDK will not save the status of a search-session anymore. This has to be managed on the Application level.
+ */
+export declare class SearchResultStatus {
+    status: SEARCH_RESULT_STATUS;
+    asyncTagsStatus: ASYNC_TAG_STATUS;
+    asyncResultsStatus: ASYNC_RESULT_STATUS;
+    asyncSmartFiltersStatus: SMART_FILTERS_STATUS;
+    constructor(init?: Partial<SearchResultStatus>);
+}

package/find/models/search-result-status.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var SEARCH_RESULT_STATUS,ASYNC_TAG_STATUS,ASYNC_RESULT_STATUS,SMART_FILTERS_STATUS;Object.defineProperty(exports,"__esModule",{value:!0}),exports.SearchResultStatus=exports.SMART_FILTERS_STATUS=exports.ASYNC_RESULT_STATUS=exports.ASYNC_TAG_STATUS=exports.SEARCH_RESULT_STATUS=void 0,function(S){S.CREATED="created",S.RUNNING="running",S.FINISHED="finished"}(SEARCH_RESULT_STATUS||(exports.SEARCH_RESULT_STATUS=SEARCH_RESULT_STATUS={})),function(S){S.PENDING="pending",S.RECEIVED="received",S.WILL_NOT_RECEIVE="will-not-receive"}(ASYNC_TAG_STATUS||(exports.ASYNC_TAG_STATUS=ASYNC_TAG_STATUS={})),function(S){S.PENDING="pending",S.RECEIVED="received",S.WILL_NOT_RECEIVE="will-not-receive"}(ASYNC_RESULT_STATUS||(exports.ASYNC_RESULT_STATUS=ASYNC_RESULT_STATUS={})),function(S){S.PENDING="pending",S.RECEIVED="received",S.WILL_NOT_RECEIVE="will-not-receive"}(SMART_FILTERS_STATUS||(exports.SMART_FILTERS_STATUS=SMART_FILTERS_STATUS={}));var SearchResultStatus=function(S){Object.assign(this,S)};exports.SearchResultStatus=SearchResultStatus;

package/find/models/search-session-log-object.d.ts

@@ -0,0 +1,16 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+export declare enum SEARCH_SESSION_LOG_OBJECT_TYPE {
+    QUESTION = "question",
+    CODE = "code",// TODO remove when Schadcodes are handled in a generic way
+    FEEDBACK = "feedback"
+}
+/**
+ * Object that is used for logging information to the search-session that does not directly
+ * affect the search-results. It's purpose is to allow us to interpret previous search-sessions,
+ * in order to retrain the system. An example for this is user-feedback to searches.
+ */
+export declare class SearchSessionLogObject {
+    type: string;
+    options: object;
+    constructor(init?: Partial<SearchSessionLogObject>);
+}

package/find/models/search-session-log-object.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var SEARCH_SESSION_LOG_OBJECT_TYPE;Object.defineProperty(exports,"__esModule",{value:!0}),exports.SearchSessionLogObject=exports.SEARCH_SESSION_LOG_OBJECT_TYPE=void 0,function(e){e.QUESTION="question",e.CODE="code",e.FEEDBACK="feedback"}(SEARCH_SESSION_LOG_OBJECT_TYPE||(exports.SEARCH_SESSION_LOG_OBJECT_TYPE=SEARCH_SESSION_LOG_OBJECT_TYPE={}));var SearchSessionLogObject=function(e){Object.assign(this,e)};exports.SearchSessionLogObject=SearchSessionLogObject;

package/find/models/search-status/cv-search-status.d.ts

@@ -0,0 +1,20 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { Asset } from '../../models/assets/asset';
+export type ImageCropArea = {
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+};
+/**
+ * The CV-related parameters of a search session.
+ *
+ * @deprecated with the new search, the SDK will not save the status of a search-session anymore. This has to be managed on the Application level.
+ */
+export declare class CVSearchStatus {
+    assetId: string;
+    cvImage: Asset;
+    cropArea: ImageCropArea;
+    wasStarted(): boolean;
+    setImage(newImage: Asset): void;
+}

package/find/models/search-status/cv-search-status.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.CVSearchStatus=void 0;var CVSearchStatus=function(){function t(){}return t.prototype.wasStarted=function(){return!!this.assetId},t.prototype.setImage=function(t){this.cvImage=t,this.assetId=null==t?void 0:t.referenceId},t}();exports.CVSearchStatus=CVSearchStatus;

package/find/models/search-status/search-filter-status.d.ts

@@ -0,0 +1,33 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { AssemblyHierarchyNode } from '../../../data';
+import { SearchFilter } from '../search-filter';
+/**
+ * The filter-related parameters of a search session.
+ *
+ * @deprecated with the new search, the SDK will not save the status of a search-session anymore. This has to be managed on the Application level.
+ */
+export declare class SearchFilterStatus {
+    /**
+     * search filters of the current search
+     */
+    filters: Array<SearchFilter>;
+    /**
+     * search filters of the current search as a map
+     */
+    filtersMap: {
+        [filterKey: string]: SearchFilter;
+    };
+    /**
+     * hierarchy filter-nodes that were implicitly added by another filter, but should be explicitly excluded
+     * @deprecated user instead an IncludeExcludeFilter
+     */
+    excludedHierarchyNodes: {
+        [id: string]: AssemblyHierarchyNode;
+    };
+    /**
+     * Determines if the filters are not empty.
+     *
+     * @returns boolean
+     */
+    wasStarted(): boolean;
+}

package/find/models/search-status/search-filter-status.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.SearchFilterStatus=void 0;var SearchFilterStatus=function(){function t(){this.filters=[],this.filtersMap={},this.excludedHierarchyNodes={}}return t.prototype.wasStarted=function(){return!(0===Object.keys(this.excludedHierarchyNodes).length&&0===this.filters.length)},t}();exports.SearchFilterStatus=SearchFilterStatus;

package/find/models/search-status/search-status.d.ts

@@ -0,0 +1,34 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { Part } from '../../../data/models/part';
+import { TextSearchStatus } from './text-search-status';
+import { CVSearchStatus } from './cv-search-status';
+import { SearchFilterStatus } from './search-filter-status';
+import { TagSearchStatus } from './tag-search-status';
+import { SearchResultStatus } from '../search-result-status';
+type SearchModalities = 'text' | 'cv' | 'filter' | 'tag';
+/**
+ * The current status of a search-session.
+ *
+ * @deprecated with the new search, the SDK will not save the status of a search-session anymore. This has to be managed on the Application level.
+ */
+export declare class SearchStatus {
+    searchSessionID: string;
+    searchDomainId: string;
+    searchLanguage: string;
+    textSearchStatus: TextSearchStatus;
+    cvSearchStatus: CVSearchStatus;
+    filterStatus: SearchFilterStatus;
+    tagSearchStatus: TagSearchStatus;
+    curResultList: Array<Part>;
+    searchResultStatus: SearchResultStatus;
+    constructor(searchDomainId?: string);
+    /**
+     * Determine if some search modality has started.
+     * If provided an array of SearchModalities, only those would be checked.
+     *
+     *
+     * @returns boolean
+     */
+    wasStarted(modalities?: SearchModalities[]): boolean;
+}
+export {};

package/find/models/search-status/search-status.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.SearchStatus=void 0;var text_search_status_1=require("./text-search-status"),cv_search_status_1=require("./cv-search-status"),search_filter_status_1=require("./search-filter-status"),tag_search_status_1=require("./tag-search-status"),search_result_status_1=require("../search-result-status"),SearchStatus=function(){function t(t){this.searchDomainId=t,this.searchLanguage=null,this.textSearchStatus=new text_search_status_1.TextSearchStatus,this.cvSearchStatus=new cv_search_status_1.CVSearchStatus,this.filterStatus=new search_filter_status_1.SearchFilterStatus,this.tagSearchStatus=new tag_search_status_1.TagSearchStatus,this.curResultList=[],this.searchResultStatus=new search_result_status_1.SearchResultStatus({status:search_result_status_1.SEARCH_RESULT_STATUS.CREATED})}return t.prototype.wasStarted=function(t){var s=this;return(t||["text","cv","filter","tag"]).some((function(t){switch(t){case"text":return s.textSearchStatus.wasStarted();case"cv":return s.cvSearchStatus.wasStarted();case"filter":return s.filterStatus.wasStarted();case"tag":return s.tagSearchStatus.wasStarted()}return!1}))},t}();exports.SearchStatus=SearchStatus;

package/find/models/search-status/tag-search-status.d.ts

@@ -0,0 +1,16 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { SearchTag } from '../search-tag';
+/**
+ * The available and included Search-Tags of a search session.
+ *
+ * @deprecated with the new search, the SDK will not save the status of a search-session anymore. This has to be managed on the Application level.
+ */
+export declare class TagSearchStatus {
+    proposedSearchTags: SearchTag[];
+    /**
+     * Determines if currently there is a tag in the search.
+     *
+     * @returns boolean
+     */
+    wasStarted(): boolean;
+}

package/find/models/search-status/tag-search-status.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TagSearchStatus=void 0;var TagSearchStatus=function(){function t(){}return t.prototype.wasStarted=function(){return this.proposedSearchTags&&this.proposedSearchTags.length>0},t}();exports.TagSearchStatus=TagSearchStatus;

package/find/models/search-status/text-search-status.d.ts

@@ -0,0 +1,15 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TextSearchQueries } from "../../services/search/text-search.service";
+import { TextSearchConfig } from "../text-search-config";
+/**
+ * The Text-search-related parameters of a search session.
+ *
+ * @deprecated with the new search, the SDK will not save the status of a search-session anymore. This has to be managed on the Application level.
+ */
+export declare class TextSearchStatus {
+    /** @deprecated use searchQueries instead */
+    searchQuery: string;
+    searchQueries: TextSearchQueries;
+    searchConfig: TextSearchConfig;
+    wasStarted(): boolean;
+}

package/find/models/search-status/text-search-status.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchStatus=void 0;var TextSearchStatus=function(){function t(){}return t.prototype.wasStarted=function(){return!!this.searchQuery||Object.values(this.searchQueries).some((function(t){return t}))},t}();exports.TextSearchStatus=TextSearchStatus;

package/find/models/search-tag.d.ts

@@ -0,0 +1,12 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+/**
+ * Search-Tags, that can be applied to a search-session.
+ * @deprecated will not be supported anymore in the future
+ */
+export declare class SearchTag {
+    value: string;
+    score?: number;
+    type?: string;
+    isAsync?: boolean;
+    constructor(init?: Partial<SearchTag>);
+}

package/find/models/search-tag.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.SearchTag=void 0;var SearchTag=function(e){this.isAsync=!1,Object.assign(this,e)};exports.SearchTag=SearchTag;

package/find/models/smart-filter.d.ts

@@ -0,0 +1,25 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { APIObject } from '../../core';
+export interface SmartFilterFromAPI {
+    label: string;
+    /** @deprecated only needed for old find-API */
+    name: string;
+    values: {
+        value: string;
+        count: number;
+    }[];
+}
+export declare class SmartFilterValue {
+    name: string;
+    partCount: number;
+    constructor(init?: Partial<SmartFilterValue>);
+}
+/**
+ * Smart Filters can be applied to search session.
+ */
+export declare class SmartFilter extends APIObject {
+    filterName: string;
+    filterValues: SmartFilterValue[];
+    constructor(init?: Partial<SmartFilter>);
+    static fromAPIResponse(apiResponse: SmartFilterFromAPI): SmartFilter;
+}

package/find/models/smart-filter.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 n(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.SmartFilter=exports.SmartFilterValue=void 0;var core_1=require("../../core"),SmartFilterValue=function(t){Object.assign(this,t)};exports.SmartFilterValue=SmartFilterValue;var SmartFilter=function(t){function e(e){var r=t.call(this)||this;return Object.assign(r,e),r}return __extends(e,t),e.fromAPIResponse=function(t){return new e({filterName:t.label||t.name,filterValues:t.values.map((function(t){return new SmartFilterValue({name:t.value,partCount:t.count})}))})},e}(core_1.APIObject);exports.SmartFilter=SmartFilter;

package/find/models/tagable/i18n-tagable.d.ts

@@ -0,0 +1,10 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TagableBase } from "./tagable-base";
+import { FormattedString } from "../../../core";
+/**
+ * Models that derive from this class can be displayed as tags
+ */
+export declare abstract class I18nTagable extends TagableBase {
+    protected abstract getText(languageCode: string): string;
+    getTextFormattedStrings(languageCode: string): Array<FormattedString>;
+}

package/find/models/tagable/i18n-tagable.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 n(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.I18nTagable=void 0;var tagable_base_1=require("./tagable-base"),I18nTagable=function(t){function e(){return null!==t&&t.apply(this,arguments)||this}return __extends(e,t),e.prototype.getTextFormattedStrings=function(t){return this.formattedStrings||(this.formattedStrings=this.getFormattedStrings(this.getText(t))),this.formattedStrings},e}(tagable_base_1.TagableBase);exports.I18nTagable=I18nTagable;

package/find/models/tagable/tagable-base.d.ts

@@ -0,0 +1,11 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { FormattedString } from "../../../core";
+/**
+ * Models that derive from this class can be displayed as tags
+ */
+export declare abstract class TagableBase {
+    abstract getCssClassName(): string;
+    abstract getId(): string;
+    protected formattedStrings: Array<FormattedString>;
+    protected getFormattedStrings(text: string): Array<FormattedString>;
+}

package/find/models/tagable/tagable-base.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TagableBase=void 0;var core_1=require("../../../core"),TagableBase=function(){function e(){}return e.prototype.getFormattedStrings=function(e){return e.split("***").map((function(e,t){var r=new core_1.FormattedString;return r.text=e,r.fontWeight=t%2==1?"bold":"normal",r}))},e}();exports.TagableBase=TagableBase;

package/find/models/tagable/tagable.d.ts

@@ -0,0 +1,10 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TagableBase } from "./tagable-base";
+import { FormattedString } from "../../../core";
+/**
+ * Models that derive from this class can be displayed as tags
+ */
+export declare abstract class Tagable extends TagableBase {
+    protected abstract getText(): string;
+    getTextFormattedStrings(): Array<FormattedString>;
+}

package/find/models/tagable/tagable.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 n(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.Tagable=void 0;var tagable_base_1=require("./tagable-base"),Tagable=function(t){function e(){return null!==t&&t.apply(this,arguments)||this}return __extends(e,t),e.prototype.getTextFormattedStrings=function(){return this.formattedStrings||(this.formattedStrings=this.getFormattedStrings(this.getText())),this.formattedStrings},e}(tagable_base_1.TagableBase);exports.Tagable=Tagable;

package/find/models/text-search-config.d.ts

@@ -0,0 +1,57 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+/**
+ * @deprecated Since temporary-search is deprecated, this config is also not needed anymore.
+ */
+export declare enum SEARCH_DOMAINS {
+    PART = "entity",
+    /** using SEARCH_DOMAINS.DOCUMENT will not lead to any results, because this feature was removed from the backend */
+    DOCUMENT = "document"
+}
+/**
+ * @deprecated Since temporary-search is deprecated, this config is also not needed anymore.
+ */
+export declare enum SEARCH_TYPE {
+    FUZZY = "fuzzy",
+    EXACT = "exact"
+}
+/**
+ * Types of possible temporary search results
+ *
+ * @deprecated Since temporary-search is deprecated, this config is also not needed anymore.
+ */
+export declare enum TEMPORARY_SEARCH_TYPE {
+    RECENT_SEARCH_QUERIES = 0,
+    /** @deprecated quick text search is deprecated and will be replaced in the future */
+    QUICK_TEXT_SEARCH = 1
+}
+/**
+ * Search-configuration for a text search.
+ * Allows overriding text search default behavior
+ *
+ * @deprecated Since temporary-search is deprecated, this config is also not needed anymore.
+ */
+export declare class TextSearchConfig {
+    /**
+     * Quicktext search - domains to search in
+     */
+    domains: SEARCH_DOMAINS[];
+    /**
+     * Quicktext limit - how many items the result should max contain
+     */
+    limit: number;
+    /**
+     * Quicktext search - search type to use
+     */
+    searchType: SEARCH_TYPE;
+    /**
+     * Quicktext fuzziness -
+     * configuration-parameter only used for search-type FUZZY. Specify a number or AUTO:[low],[high] (<low = fuzziness 0, low..high = fuzziness 1, >=high = fuzziness 2)
+     */
+    fuzziness: string;
+    /**
+     * defines the temporary search types to use for the temporary text search.
+     * this affects what kind of search is performed and the temporary text search results.
+     */
+    temporarySearch: TEMPORARY_SEARCH_TYPE[];
+    constructor(init?: Partial<TextSearchConfig>);
+}

package/find/models/text-search-config.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var SEARCH_DOMAINS,SEARCH_TYPE,TEMPORARY_SEARCH_TYPE;Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchConfig=exports.TEMPORARY_SEARCH_TYPE=exports.SEARCH_TYPE=exports.SEARCH_DOMAINS=void 0,function(E){E.PART="entity",E.DOCUMENT="document"}(SEARCH_DOMAINS||(exports.SEARCH_DOMAINS=SEARCH_DOMAINS={})),function(E){E.FUZZY="fuzzy",E.EXACT="exact"}(SEARCH_TYPE||(exports.SEARCH_TYPE=SEARCH_TYPE={})),function(E){E[E.RECENT_SEARCH_QUERIES=0]="RECENT_SEARCH_QUERIES",E[E.QUICK_TEXT_SEARCH=1]="QUICK_TEXT_SEARCH"}(TEMPORARY_SEARCH_TYPE||(exports.TEMPORARY_SEARCH_TYPE=TEMPORARY_SEARCH_TYPE={}));var TextSearchConfig=function(E){this.domains=[SEARCH_DOMAINS.PART,SEARCH_DOMAINS.DOCUMENT],this.limit=200,this.searchType=SEARCH_TYPE.FUZZY,this.fuzziness="AUTO:5,9",this.temporarySearch=[TEMPORARY_SEARCH_TYPE.QUICK_TEXT_SEARCH,TEMPORARY_SEARCH_TYPE.RECENT_SEARCH_QUERIES],Object.assign(this,E)};exports.TextSearchConfig=TextSearchConfig;

package/find/models/text-search-manipulator.d.ts

@@ -0,0 +1,46 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TextSearchResultItem } from "./text-search-result-item/text-search-result-item";
+import { SdkError } from "../../core";
+/**
+ * The Text-Search can have different result-types, like parts or documents.
+ * It is possible to also have results of a type that is unknown to the Partium SDK.
+ * By default, these items will be of type TextSearchResultItemUnknown, when they are leaving the SDK.
+ * It is possible to implement the tetSearchResultManipulatorFunction to intersect this action and
+ * manipulate, replace or remove result-items. This allows the user of the SDK to add new types
+ * and replace the Unknown-Objects with objects of these new types.
+ *
+ * @deprecated this feature will not be supported anymore in the future.
+ */
+export declare abstract class TextSearchManipulator {
+    /**
+     * Method that can be overridden to process the text-search-result.
+     * This is currently needed for DB Schadcodes, maybe it will not be needed in the future anymore
+     * and can then be removed.
+     *
+     * The default method does nothing
+     */
+    abstract textSearchResultManipulatorFunction(res: {
+        query: string;
+        result?: Array<TextSearchResultItem>;
+        error?: SdkError;
+    }): Promise<{
+        query: string;
+        result?: Array<TextSearchResultItem>;
+        error?: SdkError;
+    }>;
+}
+/**
+ * The default implementation of the TextSearchManipulator does not do any changes to the
+ * search-result. It will just forward it with the unknown object type.
+ */
+export declare class TextSearchManipulatorDoNothing extends TextSearchManipulator {
+    textSearchResultManipulatorFunction(res: {
+        query: string;
+        result?: Array<TextSearchResultItem>;
+        error?: SdkError;
+    }): Promise<{
+        query: string;
+        result?: Array<TextSearchResultItem>;
+        error?: SdkError;
+    }>;
+}

package/find/models/text-search-manipulator.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var t=function(e,n){return t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,e){t.__proto__=e}||function(t,e){for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&(t[n]=e[n])},t(e,n)};return function(e,n){if("function"!=typeof n&&null!==n)throw new TypeError("Class extends value "+String(n)+" is not a constructor or null");function r(){this.constructor=e}t(e,n),e.prototype=null===n?Object.create(n):(r.prototype=n.prototype,new r)}}(),__awaiter=this&&this.__awaiter||function(t,e,n,r){return new(n||(n=Promise))((function(o,a){function i(t){try{c(r.next(t))}catch(t){a(t)}}function u(t){try{c(r.throw(t))}catch(t){a(t)}}function c(t){var e;t.done?o(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(i,u)}c((r=r.apply(t,e||[])).next())}))},__generator=this&&this.__generator||function(t,e){var n,r,o,a,i={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return a={next:u(0),throw:u(1),return:u(2)},"function"==typeof Symbol&&(a[Symbol.iterator]=function(){return this}),a;function u(u){return function(c){return function(u){if(n)throw new TypeError("Generator is already executing.");for(;a&&(a=0,u[0]&&(i=0)),i;)try{if(n=1,r&&(o=2&u[0]?r.return:u[0]?r.throw||((o=r.return)&&o.call(r),0):r.next)&&!(o=o.call(r,u[1])).done)return o;switch(r=0,o&&(u=[2&u[0],o.value]),u[0]){case 0:case 1:o=u;break;case 4:return i.label++,{value:u[1],done:!1};case 5:i.label++,r=u[1],u=[0];continue;case 7:u=i.ops.pop(),i.trys.pop();continue;default:if(!(o=i.trys,(o=o.length>0&&o[o.length-1])||6!==u[0]&&2!==u[0])){i=0;continue}if(3===u[0]&&(!o||u[1]>o[0]&&u[1]<o[3])){i.label=u[1];break}if(6===u[0]&&i.label<o[1]){i.label=o[1],o=u;break}if(o&&i.label<o[2]){i.label=o[2],i.ops.push(u);break}o[2]&&i.ops.pop(),i.trys.pop();continue}u=e.call(t,i)}catch(t){u=[6,t],r=0}finally{n=o=0}if(5&u[0])throw u[1];return{value:u[0]?u[1]:void 0,done:!0}}([u,c])}}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchManipulatorDoNothing=exports.TextSearchManipulator=void 0;var TextSearchManipulator=function(){};exports.TextSearchManipulator=TextSearchManipulator;var TextSearchManipulatorDoNothing=function(t){function e(){return null!==t&&t.apply(this,arguments)||this}return __extends(e,t),e.prototype.textSearchResultManipulatorFunction=function(t){return __awaiter(this,void 0,void 0,(function(){return __generator(this,(function(e){return[2,t]}))}))},e}(TextSearchManipulator);exports.TextSearchManipulatorDoNothing=TextSearchManipulatorDoNothing;

package/find/models/text-search-result-item/text-search-error.d.ts

@@ -0,0 +1,7 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { SdkError } from "../../../core";
+export declare class TextSearchError {
+    error: SdkError;
+    retryCallback?: () => void;
+    constructor(error: SdkError, retryCallback?: () => void);
+}

package/find/models/text-search-result-item/text-search-error.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchError=void 0;var TextSearchError=function(r,e){this.error=r,this.retryCallback=e};exports.TextSearchError=TextSearchError;

package/find/models/text-search-result-item/text-search-result-item-document.d.ts

@@ -0,0 +1,10 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TextSearchResultItem } from "./text-search-result-item";
+import { Document } from "../../../data";
+/**
+ * Text-search results of type document.
+ */
+export declare class TextSearchResultItemDocument extends TextSearchResultItem {
+    constructor(document: Document, score: number);
+    getText(languageCode: string): string;
+}

package/find/models/text-search-result-item/text-search-result-item-document.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 n(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchResultItemDocument=void 0;var text_search_result_item_1=require("./text-search-result-item"),TextSearchResultItemDocument=function(t){function e(e,r){return t.call(this,e,r)||this}return __extends(e,t),e.prototype.getText=function(t){return this.getValue().name},e}(text_search_result_item_1.TextSearchResultItem);exports.TextSearchResultItemDocument=TextSearchResultItemDocument;

package/find/models/text-search-result-item/text-search-result-item-part.d.ts

@@ -0,0 +1,12 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TextSearchResultItem } from "./text-search-result-item";
+import { Part } from "../../../data";
+/**
+ * Text-search results of type part.
+ *
+ * @deprecated not needed anymore
+ */
+export declare class TextSearchResultItemPart extends TextSearchResultItem {
+    constructor(part: Part, score: number);
+    getText(languageCode: string): string;
+}

package/find/models/text-search-result-item/text-search-result-item-part.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 n(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchResultItemPart=void 0;var text_search_result_item_1=require("./text-search-result-item"),TextSearchResultItemPart=function(t){function e(e,r){return t.call(this,e,r)||this}return __extends(e,t),e.prototype.getText=function(t){return this.getValue().name.getText(t)},e}(text_search_result_item_1.TextSearchResultItem);exports.TextSearchResultItemPart=TextSearchResultItemPart;

package/find/models/text-search-result-item/text-search-result-item-recent-query.d.ts

@@ -0,0 +1,10 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TextSearchResultItem } from "./text-search-result-item";
+/**
+ * Text-search results of type recent query.
+ * Recently sent text search query
+ */
+export declare class TextSearchResultItemRecentQuery extends TextSearchResultItem {
+    constructor(query: string, score: number);
+    getText(languageCode: string): string;
+}

package/find/models/text-search-result-item/text-search-result-item-recent-query.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 n(){this.constructor=e}t(e,r),e.prototype=null===r?Object.create(r):(n.prototype=r.prototype,new n)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchResultItemRecentQuery=void 0;var text_search_result_item_1=require("./text-search-result-item"),TextSearchResultItemRecentQuery=function(t){function e(e,r){return t.call(this,e,r)||this}return __extends(e,t),e.prototype.getText=function(t){return this.getValue()},e}(text_search_result_item_1.TextSearchResultItem);exports.TextSearchResultItemRecentQuery=TextSearchResultItemRecentQuery;

package/find/models/text-search-result-item/text-search-result-item-unknown.d.ts

@@ -0,0 +1,12 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+import { TextSearchResultItem } from "./text-search-result-item";
+/**
+ * This Unknown-type is used as an intermediate type for all results that can't be resolved by the SDK.
+ * The app using the SDK can replace these Unknown-Items over externalTempSearchResultManipulator with
+ * other TextSearchResultItem-Types
+ */
+export declare class TextSearchResultItemUnknown extends TextSearchResultItem {
+    domainType: any;
+    constructor(data: any, score: number, domainType: string);
+    getText(languageCode: string): string;
+}

package/find/models/text-search-result-item/text-search-result-item-unknown.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";var __extends=this&&this.__extends||function(){var t=function(e,n){return t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,e){t.__proto__=e}||function(t,e){for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&(t[n]=e[n])},t(e,n)};return function(e,n){if("function"!=typeof n&&null!==n)throw new TypeError("Class extends value "+String(n)+" is not a constructor or null");function r(){this.constructor=e}t(e,n),e.prototype=null===n?Object.create(n):(r.prototype=n.prototype,new r)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchResultItemUnknown=void 0;var text_search_result_item_1=require("./text-search-result-item"),TextSearchResultItemUnknown=function(t){function e(e,n,r){var o=t.call(this,e,n)||this;return o.domainType=r,o}return __extends(e,t),e.prototype.getText=function(t){return"unknown"},e}(text_search_result_item_1.TextSearchResultItem);exports.TextSearchResultItemUnknown=TextSearchResultItemUnknown;

package/find/models/text-search-result-item/text-search-result-item.d.ts

@@ -0,0 +1,16 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+export type TextSearchResultValue = any;
+/**
+ * The text-search can have result-items of different types, like parts or documents.
+ * This is the generic super-type of text-search result-items.
+ */
+export declare abstract class TextSearchResultItem {
+    abstract getText(languageCode: string): string;
+    private value;
+    score: number;
+    constructor(value: TextSearchResultValue, score: number);
+    /**
+     * Get the value of the search-result item, depends on the type
+     */
+    getValue(): TextSearchResultValue;
+}

package/find/models/text-search-result-item/text-search-result-item.js

@@ -0,0 +1,2 @@
+// Copyright © 2022-2025 Partium, Inc. DBA Partium
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TextSearchResultItem=void 0;var TextSearchResultItem=function(){function e(e,t){this.value=e,this.score=t}return e.prototype.getValue=function(){return this.value},e}();exports.TextSearchResultItem=TextSearchResultItem;