Skip to main content

Upgrading

In this section, you will find all information about deprecated features and breaking changes, which will help you when upgrading the Partium SDK to a new version.

v 12.0​

Breaking changes​

  • Header of all functions in LocalStorageService interface extended with keyPrefixParams to decide whether or not to prefix key with certain params
  • Local-storage-keys prefixed by default with org-name and user email
  • Locally stored previous parts will be reset once
  • Locally stored recent text searches will be reset once
  • OrganizationFromAPI changed
  • OrganizationConfig.UILanguagesEnabled removed
  • OrganizationConfig.searchModalities removed
  • Organization.createdAt removed
  • Organization.updatedAt removed
  • SessionStatusService.getOrganizationUpdatedAt removed

Deprecations​

  • Deprecated OrganizationConfig.defaultLanguage
  • Deprecated OrganizationConfig.availableLanguages
  • Deprecated OrganizationConfig.assemblyNavigationEnabled
  • Deprecated OrganizationConfig.trackingEnabled
  • Deprecated OrganizationConfig.codeScannerEnabled
  • Deprecated OrganizationConfig.hybridTextSearchEnabled
  • Deprecated Organization.searchDomainId
  • Deprecated SessionStatusService.getSearchDomainId

v 11.0​

Breaking changes​

  • Major update of typescript to version 5
  • Major dependency- and peer-dependency update of js-partium-sdk, cordova-partium-sdk, react-native-partium-sdk

v 10.11​

Breaking changes​

  • HttpsClientService and FileTransferService constructors now receive an additional parameter: knownBaseUrls.

    It is used to restrict outgoing traffic and set by default to PartiumConfig.partiumApiBaseUrl, PartiumConfig.partiumLoginUrl, windows.net, amazonaws.com, and cloudfront.net upon Partium.init.

    If you have custom implementations for those services please check whether you are affected or not.

    If you need to enable a different set of provider base URLs, check the docs.

v 10.0​

Breaking changes​

  • HttpsService init method requires additional parameter for Partium-API base URL
  • Replaced NewSearchInput, ContinueSearchInput and ResponseSearchInput in performSearch with SearchInput
  • Partium.customerServiceAssistance.sendCSARequest now requires SearchOutput if search-status should be included in request

Deprecations​

  • Deprecated description attribute in Part model
  • Deprecated Partium.customerServiceAssistance.getHierarchyFilterNodesForUI
  • Deprecated SearchTag

v 9.0​

Breaking changes​

  • Updated default find-API from version 3 to 4
  • Renamed beBaseUrl in PartiumConfig to findBeBaseUrl
  • Deleted DocumentService
  • Deleted FeedbackService
  • Removed apiKey authentication via b64-encoded user+password from Oauth-authentication
  • Changed structure of SearchInput
  • Changed functionality of Partium.search.performSearch

Deprecations​

  • Deprecated all search-functions in Partium.search, except the new Partium.search.performSearch
  • Deprecated SearchFilter and all it’s descendants

v 8.0.​

Breaking changes​

  • Major update of rxjs to version 7 and typescript to version 4
  • Major dependency- and peer-dependency update of multiple SDK dependencies

v 7.0​

Breaking changes​

  • Introduced new parameter ocrBeBaseUrl in PartiumConfig

v 6.1​

Deprecations​

  • FeedbackService is now deprecated, use EventLogs instead.

v 6.0​

Breaking changes​

  • Renamed exported Baseclass "SerializableAPIObject" to "APIObject"
  • recent parts are now only stored via their part-ids, additional part-info must be loaded from backend
  • "PaginatedList" does not provide attribute "dataSource" anymore
  • All models of type SerializableAPIObject or SerializableObject don't provide serialize and deserialize function anymore
  • CachingService was deleted
  • PaginatedRequestServices do not return cached results anymore, only results from backend
  • AssemblyHierarchyNodeService.getAssemblyHierarchyRootNodes does not take "cachingStrategy" as parameter anymore
  • AssemblyHierarchyNodeService.getAssemblyHierarchyNodesByParentId does not take "cachingStrategy" as parameter anymore
  • AssemblyHierarchyNodeService.searchAssemblyHierarchyNodesByText does not take "cachingStrategy" as parameter anymore
  • AssemblyHierarchyNodeService.getAssemblyHierarchyNodes does not take "cachingStrategy" as parameter anymore
  • CustomerServiceAssistanceService.getCSARequests does not take "cachingStrategy" as parameter anymore
  • CustomerServiceAssistanceService.getCSARequest does not take "ignoreCache" as parameter anymore
  • FilterService.getFilterKeys does not take "cachingStrategy" as parameter anymore
  • FilterService.getFilterOptions does not take "cachingStrategy" as parameter anymore
  • FilterService.searchFilterKeys does not take "cachingStrategy" as parameter anymore
  • FilterService.searchFilterOptions does not take "cachingStrategy" as parameter anymore
  • FilterService.getPartsByAssemblyHierarchyNodeId does not take "cachingStrategy" as parameter anymore

v 5.12​

Deprecations​

  • LogEvent is now deprecated. Use EventLog instead, which requires different parameters.

v 5.5​

Deprecations​

  • PartAttributeService is now deprecated. Part-Attributes can only be fetched directly with a part, by fetching a single part via getPart.

v 5.3​

Deprecations​

  • Documents are now deprecated

v 5.1​

Deprecations​

  • Temporary text search
  • Text-search flow with temporary- and persisted search is deprecated and replaced with new approach

v 5.0​

Breaking changes​

  • Renamed “Project” to “Organization”, as well as all according functions, as “getProjects” to “getOrganizations”. The projectId was replaced with the searchDomainId.
  • When generating assets, the searchDomainId is also required from now on. This is relevant for the following method: Partium.asset.generateAsset (The searchDomainId can be retrieved from the users Organization, which can be fetched by Partium.getOrganizations)

v 4.1​

Deprecations​

  • The Search-Filter type CategoryFilter is now deprecated, use KvpHardFilter instead

v 3.12​

Breaking changes​

  • The dataOrigin of parts was replaced with DATA_ORIGIN.PARTIAL, in case they are retrieved from search-results. Previously this was DATA_ORIGIN.SEARCH_RESULT

Deprecations​

  • Deprecated parts DATA_ORIGIN.SEARCH_RESULT, use now DATA_ORIGIN.PARTIAL instead, which has the same meaning, but can be reused in other similar cases, where a part-object does not contain all data, but only partial data.

v 3.11​

Deprecations​

  • Partium.search.logToSearchSession()

v 3.9​

Breaking changes​

  • Introduced new parameter csaBeBaseUrl in PartiumConfig
  • Introduced new parameter logBeBaseUrl in PartiumConfig
  • Behavior of adding and removing SearchFilters