@partium/js-sdk 13.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (269) hide show
  1. package/LICENSE.txt +100 -0
  2. package/README.md +18 -0
  3. package/core/constants/constants.d.ts +12 -0
  4. package/core/constants/constants.js +2 -0
  5. package/core/decorators/injection-identifier.d.ts +10 -0
  6. package/core/decorators/injection-identifier.js +2 -0
  7. package/core/factories/paginated-request-service.factory.d.ts +22 -0
  8. package/core/factories/paginated-request-service.factory.js +2 -0
  9. package/core/index.d.ts +47 -0
  10. package/core/index.js +2 -0
  11. package/core/integration-defaults/http/fetch-api-http-error-helper.d.ts +16 -0
  12. package/core/integration-defaults/http/fetch-api-http-error-helper.js +2 -0
  13. package/core/integration-defaults/http/file-transfer/axios-file-transfer.service.d.ts +35 -0
  14. package/core/integration-defaults/http/file-transfer/axios-file-transfer.service.js +2 -0
  15. package/core/integration-defaults/http/file-transfer/fetch-api-file-transfer.service.d.ts +47 -0
  16. package/core/integration-defaults/http/file-transfer/fetch-api-file-transfer.service.js +2 -0
  17. package/core/integration-defaults/http/handle-axios-error-helper.d.ts +17 -0
  18. package/core/integration-defaults/http/handle-axios-error-helper.js +2 -0
  19. package/core/integration-defaults/http/https-client/axios-https-client.service.d.ts +83 -0
  20. package/core/integration-defaults/http/https-client/axios-https-client.service.js +2 -0
  21. package/core/integration-defaults/http/https-client/fetch-api-https-client.service.d.ts +85 -0
  22. package/core/integration-defaults/http/https-client/fetch-api-https-client.service.js +2 -0
  23. package/core/integration-defaults/http/js-oauth-keycloak-https.service.d.ts +8 -0
  24. package/core/integration-defaults/http/js-oauth-keycloak-https.service.js +2 -0
  25. package/core/integration-defaults/js-p-file.d.ts +8 -0
  26. package/core/integration-defaults/js-p-file.js +2 -0
  27. package/core/integration-defaults/session/js-oauth-api-key-session.service.d.ts +76 -0
  28. package/core/integration-defaults/session/js-oauth-api-key-session.service.js +2 -0
  29. package/core/integration-defaults/session/js-oauth-keycloak-auth-config.d.ts +28 -0
  30. package/core/integration-defaults/session/js-oauth-keycloak-auth-config.js +2 -0
  31. package/core/integration-defaults/session/js-oauth-keycloak-session.service.d.ts +82 -0
  32. package/core/integration-defaults/session/js-oauth-keycloak-session.service.js +2 -0
  33. package/core/integration-defaults/web-device-status.service.d.ts +24 -0
  34. package/core/integration-defaults/web-device-status.service.js +2 -0
  35. package/core/integration-defaults/web-file.service.d.ts +9 -0
  36. package/core/integration-defaults/web-file.service.js +2 -0
  37. package/core/integration-defaults/web-indexeddb.service.d.ts +19 -0
  38. package/core/integration-defaults/web-indexeddb.service.js +2 -0
  39. package/core/integration-defaults/web-local-storage.service.d.ts +157 -0
  40. package/core/integration-defaults/web-local-storage.service.js +2 -0
  41. package/core/models/api-object.d.ts +7 -0
  42. package/core/models/api-object.js +2 -0
  43. package/core/models/auth-config.d.ts +38 -0
  44. package/core/models/auth-config.js +2 -0
  45. package/core/models/device-info.d.ts +62 -0
  46. package/core/models/device-info.js +2 -0
  47. package/core/models/error.d.ts +70 -0
  48. package/core/models/error.js +2 -0
  49. package/core/models/formatted-string.d.ts +9 -0
  50. package/core/models/formatted-string.js +2 -0
  51. package/core/models/i18n-map.d.ts +34 -0
  52. package/core/models/i18n-map.js +2 -0
  53. package/core/models/i18n-string.d.ts +8 -0
  54. package/core/models/i18n-string.js +2 -0
  55. package/core/models/log.d.ts +130 -0
  56. package/core/models/log.js +2 -0
  57. package/core/models/organization.d.ts +121 -0
  58. package/core/models/organization.js +2 -0
  59. package/core/models/p-file.d.ts +17 -0
  60. package/core/models/p-file.js +2 -0
  61. package/core/models/paginated-list.d.ts +23 -0
  62. package/core/models/paginated-list.js +2 -0
  63. package/core/models/partium-config.d.ts +31 -0
  64. package/core/models/partium-config.js +2 -0
  65. package/core/models/user-token.d.ts +16 -0
  66. package/core/models/user-token.js +2 -0
  67. package/core/models/user.d.ts +48 -0
  68. package/core/models/user.js +2 -0
  69. package/core/services/backend-status.service.d.ts +46 -0
  70. package/core/services/backend-status.service.js +2 -0
  71. package/core/services/base-login-init.service.d.ts +32 -0
  72. package/core/services/base-login-init.service.js +2 -0
  73. package/core/services/base.service.d.ts +31 -0
  74. package/core/services/base.service.js +2 -0
  75. package/core/services/device-status.service.interface.d.ts +36 -0
  76. package/core/services/device-status.service.interface.js +2 -0
  77. package/core/services/file.service.interface.d.ts +24 -0
  78. package/core/services/file.service.interface.js +2 -0
  79. package/core/services/http/file-transfer/file-transfer.service.interface.d.ts +57 -0
  80. package/core/services/http/file-transfer/file-transfer.service.interface.js +2 -0
  81. package/core/services/http/https-client/https-client.service.interface.d.ts +96 -0
  82. package/core/services/http/https-client/https-client.service.interface.js +2 -0
  83. package/core/services/http/https.service.interface.d.ts +164 -0
  84. package/core/services/http/https.service.interface.js +2 -0
  85. package/core/services/http/oauth-https.service.d.ts +120 -0
  86. package/core/services/http/oauth-https.service.js +2 -0
  87. package/core/services/local-storage.service.interface.d.ts +221 -0
  88. package/core/services/local-storage.service.interface.js +2 -0
  89. package/core/services/log.service.d.ts +48 -0
  90. package/core/services/log.service.js +2 -0
  91. package/core/services/organization.service.d.ts +48 -0
  92. package/core/services/organization.service.js +2 -0
  93. package/core/services/paginated-request.service.d.ts +104 -0
  94. package/core/services/paginated-request.service.js +2 -0
  95. package/core/services/recent-parts.service.d.ts +59 -0
  96. package/core/services/recent-parts.service.js +2 -0
  97. package/core/services/service-provider.d.ts +58 -0
  98. package/core/services/service-provider.js +2 -0
  99. package/core/services/session/oauth-session.service.d.ts +76 -0
  100. package/core/services/session/oauth-session.service.js +2 -0
  101. package/core/services/session/session.service.interface.d.ts +138 -0
  102. package/core/services/session/session.service.interface.js +2 -0
  103. package/core/utils/general-helper.d.ts +35 -0
  104. package/core/utils/general-helper.js +2 -0
  105. package/data/index.d.ts +28 -0
  106. package/data/index.js +2 -0
  107. package/data/models/announcement.d.ts +30 -0
  108. package/data/models/announcement.js +2 -0
  109. package/data/models/assembly-hierarchy-node-breadcrumb.d.ts +10 -0
  110. package/data/models/assembly-hierarchy-node-breadcrumb.js +2 -0
  111. package/data/models/assembly-hierarchy-node.d.ts +16 -0
  112. package/data/models/assembly-hierarchy-node.js +2 -0
  113. package/data/models/attribute.d.ts +46 -0
  114. package/data/models/attribute.js +2 -0
  115. package/data/models/csa-request-search.d.ts +18 -0
  116. package/data/models/csa-request-search.js +2 -0
  117. package/data/models/csa-request-status.d.ts +16 -0
  118. package/data/models/csa-request-status.js +2 -0
  119. package/data/models/csa-request.d.ts +41 -0
  120. package/data/models/csa-request.js +2 -0
  121. package/data/models/document.d.ts +12 -0
  122. package/data/models/document.js +2 -0
  123. package/data/models/filter-key.d.ts +12 -0
  124. package/data/models/filter-key.js +2 -0
  125. package/data/models/filter-option-value.d.ts +18 -0
  126. package/data/models/filter-option-value.js +2 -0
  127. package/data/models/image.d.ts +36 -0
  128. package/data/models/image.js +2 -0
  129. package/data/models/inquiry.d.ts +32 -0
  130. package/data/models/inquiry.js +2 -0
  131. package/data/models/mounting-location.d.ts +32 -0
  132. package/data/models/mounting-location.js +2 -0
  133. package/data/models/multiple-expert-searches.d.ts +9 -0
  134. package/data/models/multiple-expert-searches.js +2 -0
  135. package/data/models/part-enrichment-data.d.ts +24 -0
  136. package/data/models/part-enrichment-data.js +2 -0
  137. package/data/models/part.d.ts +168 -0
  138. package/data/models/part.js +2 -0
  139. package/data/models/shopping-cart.d.ts +43 -0
  140. package/data/models/shopping-cart.js +2 -0
  141. package/data/services/announcement.service.d.ts +68 -0
  142. package/data/services/announcement.service.js +2 -0
  143. package/data/services/assembly-hierarchy-nodes.service.d.ts +113 -0
  144. package/data/services/assembly-hierarchy-nodes.service.js +2 -0
  145. package/data/services/csa-helper.service.d.ts +32 -0
  146. package/data/services/csa-helper.service.js +2 -0
  147. package/data/services/customer-service-assistance.service.d.ts +181 -0
  148. package/data/services/customer-service-assistance.service.js +2 -0
  149. package/data/services/filter.service.d.ts +97 -0
  150. package/data/services/filter.service.js +2 -0
  151. package/data/services/inquiry.service.d.ts +54 -0
  152. package/data/services/inquiry.service.js +2 -0
  153. package/data/services/part-attribute.service.d.ts +42 -0
  154. package/data/services/part-attribute.service.js +2 -0
  155. package/data/services/part-enrichment.service.d.ts +32 -0
  156. package/data/services/part-enrichment.service.js +2 -0
  157. package/data/services/part.service.d.ts +121 -0
  158. package/data/services/part.service.js +2 -0
  159. package/data/services/related-parts.service.d.ts +75 -0
  160. package/data/services/related-parts.service.js +2 -0
  161. package/data/services/shopping-cart.service.d.ts +150 -0
  162. package/data/services/shopping-cart.service.js +2 -0
  163. package/find/index.d.ts +35 -0
  164. package/find/index.js +2 -0
  165. package/find/models/assets/asset.d.ts +24 -0
  166. package/find/models/assets/asset.js +2 -0
  167. package/find/models/search-filter.d.ts +87 -0
  168. package/find/models/search-filter.js +2 -0
  169. package/find/models/search-input.d.ts +39 -0
  170. package/find/models/search-input.js +2 -0
  171. package/find/models/search-output.d.ts +10 -0
  172. package/find/models/search-output.js +2 -0
  173. package/find/models/search-result-status.d.ts +33 -0
  174. package/find/models/search-result-status.js +2 -0
  175. package/find/models/search-session-log-object.d.ts +16 -0
  176. package/find/models/search-session-log-object.js +2 -0
  177. package/find/models/search-status/cv-search-status.d.ts +20 -0
  178. package/find/models/search-status/cv-search-status.js +2 -0
  179. package/find/models/search-status/search-filter-status.d.ts +33 -0
  180. package/find/models/search-status/search-filter-status.js +2 -0
  181. package/find/models/search-status/search-status.d.ts +34 -0
  182. package/find/models/search-status/search-status.js +2 -0
  183. package/find/models/search-status/tag-search-status.d.ts +16 -0
  184. package/find/models/search-status/tag-search-status.js +2 -0
  185. package/find/models/search-status/text-search-status.d.ts +15 -0
  186. package/find/models/search-status/text-search-status.js +2 -0
  187. package/find/models/search-tag.d.ts +12 -0
  188. package/find/models/search-tag.js +2 -0
  189. package/find/models/smart-filter.d.ts +25 -0
  190. package/find/models/smart-filter.js +2 -0
  191. package/find/models/tagable/i18n-tagable.d.ts +10 -0
  192. package/find/models/tagable/i18n-tagable.js +2 -0
  193. package/find/models/tagable/tagable-base.d.ts +11 -0
  194. package/find/models/tagable/tagable-base.js +2 -0
  195. package/find/models/tagable/tagable.d.ts +10 -0
  196. package/find/models/tagable/tagable.js +2 -0
  197. package/find/models/text-search-config.d.ts +57 -0
  198. package/find/models/text-search-config.js +2 -0
  199. package/find/models/text-search-manipulator.d.ts +46 -0
  200. package/find/models/text-search-manipulator.js +2 -0
  201. package/find/models/text-search-result-item/text-search-error.d.ts +7 -0
  202. package/find/models/text-search-result-item/text-search-error.js +2 -0
  203. package/find/models/text-search-result-item/text-search-result-item-document.d.ts +10 -0
  204. package/find/models/text-search-result-item/text-search-result-item-document.js +2 -0
  205. package/find/models/text-search-result-item/text-search-result-item-part.d.ts +12 -0
  206. package/find/models/text-search-result-item/text-search-result-item-part.js +2 -0
  207. package/find/models/text-search-result-item/text-search-result-item-recent-query.d.ts +10 -0
  208. package/find/models/text-search-result-item/text-search-result-item-recent-query.js +2 -0
  209. package/find/models/text-search-result-item/text-search-result-item-unknown.d.ts +12 -0
  210. package/find/models/text-search-result-item/text-search-result-item-unknown.js +2 -0
  211. package/find/models/text-search-result-item/text-search-result-item.d.ts +16 -0
  212. package/find/models/text-search-result-item/text-search-result-item.js +2 -0
  213. package/find/services/asset.service.d.ts +160 -0
  214. package/find/services/asset.service.js +2 -0
  215. package/find/services/filter-uploaders/filter-uploader.d.ts +13 -0
  216. package/find/services/filter-uploaders/filter-uploader.js +2 -0
  217. package/find/services/filter-uploaders/update-filters-uploader.d.ts +17 -0
  218. package/find/services/filter-uploaders/update-filters-uploader.js +2 -0
  219. package/find/services/filter-uploaders/update-filters.model.d.ts +19 -0
  220. package/find/services/filter-uploaders/update-filters.model.js +2 -0
  221. package/find/services/search/cv-search.service.d.ts +103 -0
  222. package/find/services/search/cv-search.service.js +2 -0
  223. package/find/services/search/recent-text-search-queries.service.d.ts +89 -0
  224. package/find/services/search/recent-text-search-queries.service.js +2 -0
  225. package/find/services/search/search-result.service.d.ts +142 -0
  226. package/find/services/search/search-result.service.js +2 -0
  227. package/find/services/search/search.service.d.ts +291 -0
  228. package/find/services/search/search.service.js +2 -0
  229. package/find/services/search/tag-search.service.d.ts +66 -0
  230. package/find/services/search/tag-search.service.js +2 -0
  231. package/find/services/search/text-search.service.d.ts +116 -0
  232. package/find/services/search/text-search.service.js +2 -0
  233. package/find/services/search-filter.service.d.ts +223 -0
  234. package/find/services/search-filter.service.js +2 -0
  235. package/find/utils/search-helper.d.ts +14 -0
  236. package/find/utils/search-helper.js +2 -0
  237. package/gen/sdk-version.d.ts +2 -0
  238. package/gen/sdk-version.js +2 -0
  239. package/index.d.ts +121 -0
  240. package/index.js +2 -0
  241. package/management/index.d.ts +5 -0
  242. package/management/index.js +2 -0
  243. package/management/models/api-key-list-response.d.ts +10 -0
  244. package/management/models/api-key-list-response.js +2 -0
  245. package/management/models/api-key-type.d.ts +5 -0
  246. package/management/models/api-key-type.js +2 -0
  247. package/management/models/api-key.d.ts +4 -0
  248. package/management/models/api-key.js +2 -0
  249. package/management/services/api-key.service.d.ts +39 -0
  250. package/management/services/api-key.service.js +2 -0
  251. package/ocr/index.d.ts +4 -0
  252. package/ocr/index.js +2 -0
  253. package/ocr/models/detect-response.d.ts +5 -0
  254. package/ocr/models/detect-response.js +2 -0
  255. package/ocr/models/detected-text-entry.d.ts +5 -0
  256. package/ocr/models/detected-text-entry.js +2 -0
  257. package/ocr/services/ocr.service.d.ts +36 -0
  258. package/ocr/services/ocr.service.js +2 -0
  259. package/package.json +45 -0
  260. package/user-data/index.d.ts +5 -0
  261. package/user-data/index.js +2 -0
  262. package/user-data/models/part-with-nullable.d.ts +5 -0
  263. package/user-data/models/part-with-nullable.js +2 -0
  264. package/user-data/models/request-list/request-list.d.ts +16 -0
  265. package/user-data/models/request-list/request-list.js +2 -0
  266. package/user-data/services/favorite/favorite.service.d.ts +45 -0
  267. package/user-data/services/favorite/favorite.service.js +2 -0
  268. package/user-data/services/request-list/request-list.service.d.ts +97 -0
  269. package/user-data/services/request-list/request-list.service.js +2 -0
@@ -0,0 +1,70 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ export declare enum SDK_ERROR_CODES {
3
+ NO_INTERNET = "NO_INTERNET",// currently there is no internet connection available
4
+ COULD_NOT_REACH_SERVER = "COULD_NOT_REACH_SERVER",// the server could not be reached
5
+ UNKNOWN_HOST_ERROR = "UNKNOWN_HOST_ERROR",
6
+ BAD_REQUEST = "BAD_REQUEST",// http 400
7
+ FORBIDDEN = "FORBIDDEN",// http 403
8
+ NOT_FOUND = "NOT_FOUND",// http 404
9
+ UNPROCESSABLE_ENTITY = "UNPROCESSABLE_ENTITY",// http 422
10
+ INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",// http 500
11
+ NOT_IMPLEMENTED = "NOT_IMPLEMENTED",// http 501
12
+ BAD_GATEWAY = "BAD_GATEWAY",// http 502
13
+ SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",// http 503
14
+ GATEWAY_TIMEOUT = "GATEWAY_TIMEOUT",// http 504
15
+ INVALID_AUTH_CONFIG = "INVALID_AUTH_CONFIG",// auth configuration is not valid, eg unknown client-id for keycloak
16
+ USER_UNAUTHORIZED = "USER_UNAUTHORIZED",// when the user not authorzied to perform the desired request on the server
17
+ INVALID_API_KEY_FORMAT = "INVALID_API_KEY_FORMAT",// the provided API-Key has an invalid format
18
+ API_KEY_MISSING = "API_KEY_MISSING",// for api-key authentication, if the API-Key is missing
19
+ WRONG_AUTH_TYPE = "wrongAuthType",// wrong authentication type
20
+ NO_AUTHENTICATION_CONFIG_FOUND = "NO_AUTHENTICATION_CONFIG_FOUND",// no user found for given email address
21
+ INVALID_AUTHENTICATION = "INVALID_AUTHENTICATION",// login credentials are invalid, either username unknown or password wrong
22
+ VALIDATION_ERROR = "VALIDATION_ERROR",// an invalid email adress is entered
23
+ INVALID_LOGIN_CONFIG = "INVALID_LOGIN_CONFIG",// login configuration is not valid, eg missing api-key and active-session
24
+ UNKNOWN_ERROR = "UNKNOWN_ERROR",
25
+ NO_SEARCH_SESSION_ACTIVE = "NO_SEARCH_SESSION_ACTIVE",// we try to add some information to the current search session. but no search session is currently active
26
+ RESULT_UNDEFINED = "RESULT_UNDEFINED",// throws exception when search result is undefined. Initial state of search result is undefined, we reset to undefined when start new search.
27
+ INVALID_SEARCH_MODALITY_CONFIG = "INVALID_SEARCH_MODALITY_CONFIG",// the search modality that should have been added to search-session is not configured correctly
28
+ INVALID_MULTIPLE_IMAGE_SEARCHES = "INVALID_MULTIPLE_IMAGE_SEARCHES",// multiple image searches on same search session are not allowed
29
+ INVALID_SEARCH_LANGUAGE = "INVALID_SEARCH_LANGUAGE",// invalid language input when creating a search session or invalid search input for this language
30
+ GENERAL_SEARCH_ERROR = "GENERAL_SEARCH_ERROR",// an error occurred during the search-process, that is not closer specified
31
+ INVALID_ASSET_STATUS = "INVALID_ASSET_STATUS",// the asset state is not the expected one when a certain function is called
32
+ FILE_NOT_FOUND = "FILE_NOT_FOUND",// file to upload could not be found
33
+ CAPTURE_IMAGE_FAILED = "CAPTURE_IMAGE_FAILED",// capturing of an image with the camera has failed
34
+ LOADING_FROM_GALLERY_FAILED = "LOADING_FROM_GALLERY_FAILED",// loading an image/video from the local device failed
35
+ IMAGE_SEARCH_ERROR = "IMAGE_SEARCH_ERROR",// error while performing the image search
36
+ PICK_IMAGE_ABORTED_BY_USER = "PICK_IMAGE_ABORTED_BY_USER",// user aborted pick-image from gallery action
37
+ SEARCH_RESULT_TIMEOUT = "SEARCH_RESULT_TIMEOUT",// when polling took too long without resolving with a result (probably related to an issue in the backend)
38
+ TIMEOUT_ERROR = "TIMEOUT_ERROR",// timeout error happened in the backend
39
+ INTEGRATION_ERROR = "INTEGRATION_ERROR",// if this error occurs, this usually indicates that the SDK was not integrated properly.
40
+ INITIAL_ITEMS_NOT_YET_LOADED = "INITIAL_ITEMS_NOT_YET_LOADED",// the request for the first page of items has not yet finished
41
+ NO_MORE_ITEMS_AVAILABLE = "NO_MORE_ITEMS_AVAILABLE",// can't load more items, because the end of the list is reached
42
+ UNEXPECTED_API_VERSION = "UNEXPECTED_API_VERSION",// the function that was called can not be executed with the selected Backend-API version,
43
+ UNEXPECTED_SEARCH_VERSION = "UNEXPECTED_SEARCH_VERSION",// the search-function that was called can not be executed with the selected Backend-API version,
44
+ SSO_USER_CERT = "SSO_USER_CERT",
45
+ SSO_TOKEN_REFRESH = "SSO_TOKEN_REFRESH",
46
+ TOKEN_EXPIRED = "TOKEN_EXPIRED",
47
+ INVALID_TOKEN = "INVALID_TOKEN",
48
+ REFRESH_TOKEN_EXPIRED = "REFRESH_TOKEN_EXPIRED",// refresh token expired error
49
+ OAUTH_ERROR = "OAUTH_ERROR",// general error occured during oauth operations (e.g. during login/refresh, etc)
50
+ LOGIN_CANCELLED = "LOGIN_CANCELLED",// is not a real error, happens when the user cancels the login operation
51
+ LOGIN_ALREADY_IN_PROGRESS = "LOGIN_ALREADY_IN_PROGRESS",// this error occurs when multiple logins are attempted simultaniously (or also on multiple refreshes)
52
+ MISSING_STORAGE_ACCESS_PERMISSION = "MISSING_STORAGE_ACCESS_PERMISSION",// trying to access the device storage, but permission not granted
53
+ SDK_OUTDATED = "SDK_OUTDATED",// app/sdk version is outdated
54
+ BACKEND_DOWN = "BACKEND_DOWN",// partium-backend is down
55
+ STATUS_BACKEND_DOWN = "STATUS_BACKEND_DOWN",// status backend is down
56
+ INVALID_FILE_TYPE = "INVALID_FILE_TYPE",
57
+ INVALID_CROP_AREA = "INVALID_CROP_AREA",// invalid crop area
58
+ ORGANIZATION_NOT_FOUND = "ORGANIZATION_NOT_FOUND",// organization not found
59
+ NO_UPIS_FOUND = "NO_UPIS_FOUND"
60
+ }
61
+ /**
62
+ * Any error that is emitted within or by the Partium-SDK should be of type SdkError.
63
+ */
64
+ export declare class SdkError {
65
+ code: SDK_ERROR_CODES;
66
+ detail: Object;
67
+ private errorString;
68
+ constructor(code: SDK_ERROR_CODES, detail: Object, message?: string);
69
+ toString(): string;
70
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";var SDK_ERROR_CODES;Object.defineProperty(exports,"__esModule",{value:!0}),exports.SdkError=exports.SDK_ERROR_CODES=void 0,function(E){E.NO_INTERNET="NO_INTERNET",E.COULD_NOT_REACH_SERVER="COULD_NOT_REACH_SERVER",E.UNKNOWN_HOST_ERROR="UNKNOWN_HOST_ERROR",E.BAD_REQUEST="BAD_REQUEST",E.FORBIDDEN="FORBIDDEN",E.NOT_FOUND="NOT_FOUND",E.UNPROCESSABLE_ENTITY="UNPROCESSABLE_ENTITY",E.INTERNAL_SERVER_ERROR="INTERNAL_SERVER_ERROR",E.NOT_IMPLEMENTED="NOT_IMPLEMENTED",E.BAD_GATEWAY="BAD_GATEWAY",E.SERVICE_UNAVAILABLE="SERVICE_UNAVAILABLE",E.GATEWAY_TIMEOUT="GATEWAY_TIMEOUT",E.INVALID_AUTH_CONFIG="INVALID_AUTH_CONFIG",E.USER_UNAUTHORIZED="USER_UNAUTHORIZED",E.INVALID_API_KEY_FORMAT="INVALID_API_KEY_FORMAT",E.API_KEY_MISSING="API_KEY_MISSING",E.WRONG_AUTH_TYPE="wrongAuthType",E.NO_AUTHENTICATION_CONFIG_FOUND="NO_AUTHENTICATION_CONFIG_FOUND",E.INVALID_AUTHENTICATION="INVALID_AUTHENTICATION",E.VALIDATION_ERROR="VALIDATION_ERROR",E.INVALID_LOGIN_CONFIG="INVALID_LOGIN_CONFIG",E.UNKNOWN_ERROR="UNKNOWN_ERROR",E.NO_SEARCH_SESSION_ACTIVE="NO_SEARCH_SESSION_ACTIVE",E.RESULT_UNDEFINED="RESULT_UNDEFINED",E.INVALID_SEARCH_MODALITY_CONFIG="INVALID_SEARCH_MODALITY_CONFIG",E.INVALID_MULTIPLE_IMAGE_SEARCHES="INVALID_MULTIPLE_IMAGE_SEARCHES",E.INVALID_SEARCH_LANGUAGE="INVALID_SEARCH_LANGUAGE",E.GENERAL_SEARCH_ERROR="GENERAL_SEARCH_ERROR",E.INVALID_ASSET_STATUS="INVALID_ASSET_STATUS",E.FILE_NOT_FOUND="FILE_NOT_FOUND",E.CAPTURE_IMAGE_FAILED="CAPTURE_IMAGE_FAILED",E.LOADING_FROM_GALLERY_FAILED="LOADING_FROM_GALLERY_FAILED",E.IMAGE_SEARCH_ERROR="IMAGE_SEARCH_ERROR",E.PICK_IMAGE_ABORTED_BY_USER="PICK_IMAGE_ABORTED_BY_USER",E.SEARCH_RESULT_TIMEOUT="SEARCH_RESULT_TIMEOUT",E.TIMEOUT_ERROR="TIMEOUT_ERROR",E.INTEGRATION_ERROR="INTEGRATION_ERROR",E.INITIAL_ITEMS_NOT_YET_LOADED="INITIAL_ITEMS_NOT_YET_LOADED",E.NO_MORE_ITEMS_AVAILABLE="NO_MORE_ITEMS_AVAILABLE",E.UNEXPECTED_API_VERSION="UNEXPECTED_API_VERSION",E.UNEXPECTED_SEARCH_VERSION="UNEXPECTED_SEARCH_VERSION",E.SSO_USER_CERT="SSO_USER_CERT",E.SSO_TOKEN_REFRESH="SSO_TOKEN_REFRESH",E.TOKEN_EXPIRED="TOKEN_EXPIRED",E.INVALID_TOKEN="INVALID_TOKEN",E.REFRESH_TOKEN_EXPIRED="REFRESH_TOKEN_EXPIRED",E.OAUTH_ERROR="OAUTH_ERROR",E.LOGIN_CANCELLED="LOGIN_CANCELLED",E.LOGIN_ALREADY_IN_PROGRESS="LOGIN_ALREADY_IN_PROGRESS",E.MISSING_STORAGE_ACCESS_PERMISSION="MISSING_STORAGE_ACCESS_PERMISSION",E.SDK_OUTDATED="SDK_OUTDATED",E.BACKEND_DOWN="BACKEND_DOWN",E.STATUS_BACKEND_DOWN="STATUS_BACKEND_DOWN",E.INVALID_FILE_TYPE="INVALID_FILE_TYPE",E.INVALID_CROP_AREA="INVALID_CROP_AREA",E.ORGANIZATION_NOT_FOUND="ORGANIZATION_NOT_FOUND",E.NO_UPIS_FOUND="NO_UPIS_FOUND"}(SDK_ERROR_CODES||(exports.SDK_ERROR_CODES=SDK_ERROR_CODES={}));var SdkError=function(){function E(E,_,I){this.errorString="".concat(E," - ");try{this.errorString+=I||JSON.stringify(_)}catch(E){_.toString&&(this.errorString+=_.toString())}this.code=E,this.detail=_}return E.prototype.toString=function(){return this.errorString},E}();exports.SdkError=SdkError;
@@ -0,0 +1,9 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ /**
3
+ * Store string + formatting.
4
+ * Was used for delta-attribute-names and tags
5
+ */
6
+ export declare class FormattedString {
7
+ text: string;
8
+ fontWeight: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.FormattedString=void 0;var FormattedString=function(){};exports.FormattedString=FormattedString;
@@ -0,0 +1,34 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ /**
3
+ * internationalization object that contains a map with a generic value and some useful helper methods
4
+ */
5
+ export declare class i18nMap<T> {
6
+ protected readonly fallbackLanguage = "en";
7
+ protected map: Map<string, T>;
8
+ constructor(strings?: {
9
+ [name: string]: T;
10
+ });
11
+ /**
12
+ * checks if a value exists for provided language code
13
+ */
14
+ hasLanguage(code: string): boolean;
15
+ /**
16
+ * get all available languages
17
+ */
18
+ getAvailableLanguages(): string[];
19
+ /**
20
+ * returns the value in the following order of availability:
21
+ * returns the value of provided language code,
22
+ * or returns the value of fallbackLanguage
23
+ * or returns the next available value
24
+ * or returns undefined if no value
25
+ */
26
+ getValue(code: string): T;
27
+ getMap(): Map<string, T>;
28
+ /**
29
+ * returns the i18n map as object to e.g. allow for serialization
30
+ */
31
+ getAsObject(): {
32
+ [name: string]: T;
33
+ };
34
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.i18nMap=void 0;var i18nMap=function(){function t(t){var a=this;this.fallbackLanguage="en",this.map=new Map,t&&Object.keys(t).forEach((function(e){a.map.set(e,t[e])}))}return t.prototype.hasLanguage=function(t){return this.map.has(t)},t.prototype.getAvailableLanguages=function(){return Array.from(this.map.keys())},t.prototype.getValue=function(t){return this.map.has(t)?this.map.get(t):this.map.has(this.fallbackLanguage)?this.map.get(this.fallbackLanguage):this.map.values().next().value},t.prototype.getMap=function(){return this.map},t.prototype.getAsObject=function(){var t={};return this.map.forEach((function(a,e){return t[e]=a})),t},t}();exports.i18nMap=i18nMap;
@@ -0,0 +1,8 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ import { i18nMap } from "./i18n-map";
3
+ /**
4
+ * Object for storing i18n-able strings.
5
+ */
6
+ export declare class i18nString extends i18nMap<string> {
7
+ getText(code: string): string;
8
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";var __extends=this&&this.__extends||function(){var t=function(n,r){return t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,n){t.__proto__=n}||function(t,n){for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(t[r]=n[r])},t(n,r)};return function(n,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function e(){this.constructor=n}t(n,r),n.prototype=null===r?Object.create(r):(e.prototype=r.prototype,new e)}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.i18nString=void 0;var i18n_map_1=require("./i18n-map"),i18nString=function(t){function n(){return null!==t&&t.apply(this,arguments)||this}return __extends(n,t),n.prototype.getText=function(t){return this.getValue(t)},n}(i18n_map_1.i18nMap);exports.i18nString=i18nString;
@@ -0,0 +1,130 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ /**
3
+ * Defines the types of events for the front end applications.
4
+ * These values are used for the event-parameter in the log request.
5
+ */
6
+ export declare enum EVENT {
7
+ PART_COPY_ID = "part_copy_id",
8
+ PART_CONFIRMED_SEARCH = "part_confirmed_search",
9
+ PART_RELEVANCY_TO_SEARCH = "part_relevancy_to_search",
10
+ DEVICE_INFO = "device_info",
11
+ PART_DETAIL_ENTER = "part_detail_enter",
12
+ PART_DETAIL_LEAVE = "part_detail_leave",
13
+ PART_DETAIL_SET_RELATION = "parts_detail_set_relation",
14
+ PART_THUMBSUP = "part_thumbsup",
15
+ PART_THUMBSDOWN = "part_thumbsdown",
16
+ REQUEST_LIST_ADD_PART = "request_list_add_part",
17
+ REQUEST_LIST_DEL_PART = "request_list_del_part",
18
+ REQUEST_LIST_RESET_PARTS = "request_list_reset_parts",
19
+ REQUEST_LIST_SEND = "request_list_send",
20
+ REQUEST_LIST_UPDATE = "request_list_update",
21
+ REQUEST_LIST_ADD_PART_EXISTING = "request_list_add_part_existing",
22
+ ATTEMPT_UPLOAD_IMAGE_DIMENSIONS = "attempt_upload_image_dimensions",
23
+ CSA_FORM_ENTER_FROM_RESULTS = "csa_form_enter_from_results",
24
+ CSA_FORM_ENTER_FROM_PART_DETAILS = "csa_form_enter_from_part_details",
25
+ CSA_REQUEST_SEND = "csa_request_send",
26
+ CSA_CALL_EXPERT = "csa_call_expert",
27
+ CSA_EXPERT_CONFIRMS_PART = "csa_expert_confirms_part",
28
+ CSA_EXPERT_MARK_NOT_RESOLVED = "csa_expert_marks_not_resolved",
29
+ RECENT_SEARCH_QUERY_CLICKED = "recent_search_query_clicked",
30
+ SEARCH_TAG_USED = "search_tag_used",
31
+ REQUEST_LIST_EXPORTED = "request_list_exported",
32
+ CSA_EXPERT_OPENS_REQUEST = "csa_expert_opens_request",
33
+ LANGUAGE_CHANGE = "language_change",
34
+ USER_SESSION_INFO = "user_session_info",
35
+ CONFIRMED_ID_MATCHES_PART_TO_CONFIRM = "confirmed_id_matches_part_to_confirm",
36
+ SHOPPING_CART_EXPORTED = "shopping_cart_exported",
37
+ SHOPPING_CART_UPDATE = "shopping_cart_update",
38
+ SHOPPING_CART_REMOVE_ALL_PARTS = "shopping_cart_remove_all_parts",
39
+ SHOPPING_CART_REMOVE_PART = "shopping_cart_remove_part",
40
+ SHOPPING_CART_ADD_PART = "shopping_cart_add_part",
41
+ SHOPPING_CART_REQUEST_OFFER = "shopping_cart_request_offer",
42
+ FAVORITES_REMOVE = "favorites_remove_part",
43
+ FAVORITES_ADD = "favorites_add_part",
44
+ ECR_DETAILS_ENTER = "ecr_details_enter",
45
+ ECR_LIST = "ecr_list",
46
+ ECR_CALL = "ecr_call",
47
+ ECR_FORM_SUBMIT = "ecr_form_submit",
48
+ ECR_FORM_ENTER = "ecr_form_enter",
49
+ SEARCH_INPUT_CODE_SCANNING = "search_input_code_scanning",
50
+ SEARCH_INPUT_BOM_FILTER = "search_input_bom_filter",
51
+ SEARCH_INPUT_ATTRIBUTE_FILTERS = "search_input_attribute_filters",
52
+ SEARCH_INPUT_SEMANTIC_TAGS = "search_input_semantic_tags",
53
+ SEARCH_INPUT_SMART_FILTER_APPLIED = "search_input_smart_filter_applied",
54
+ SEARCH_RESULTS_STS = "search_results_sts",
55
+ SEARCH_RESULTS_VM = "search_results_vm",
56
+ SEARCH_RESULTS_HVT = "search_results_hvt",
57
+ SEARCH_RESULTS_SMMS_FLOW = "search_results_smms_flow",
58
+ SEARCH_RESULTS_FUSION = "search_results_fusion",
59
+ SEARCH_SESSION_CREATE = "search_session_create",
60
+ SEARCH_ASSISTANCE_OCR = "search_assistance_ocr",
61
+ INQUIRY_EXPORTED = "inquiry_exported",
62
+ EXPERT_OPENS_INQUIRY = "expert_opens_inquiry",
63
+ CSA_EXPERT_STARTS_EXPERT_SEARCH = "csa_expert_starts_expert_search",
64
+ CSA_INVITES_EXPERT = "csa_invites_expert"
65
+ }
66
+ export declare enum INTERFACE {
67
+ FIND_APP = "find_app",
68
+ API_ACCESS = "api_access",
69
+ AGENT_PORTAL_APP = "agent_portal_app",
70
+ ANALYTICS_APP = "analytics_app",
71
+ DATA_CLEANSING_APP = "data_cleansing_app",
72
+ GLOBAL_APP = "global_app"
73
+ }
74
+ export declare enum PARTIUM_CONTEXT {
75
+ SEARCH = "search",
76
+ RECENTLY_VIEWED_PARTS = "recently_viewed_parts",
77
+ FAVORITES = "favorites",
78
+ ECR = "ecr",
79
+ SHOPPING_CART = "shopping_cart",
80
+ DATA_CLEANSING = "data_cleansing",
81
+ ANALYTICS = "analytics",
82
+ DATA_INSIGHTS = "data_insights"
83
+ }
84
+ export declare enum OCR_CONTEXT {
85
+ TEXT_SEARCH = "text_search",
86
+ BOM_FILTER = "bom_filter"
87
+ }
88
+ export declare enum ECR_TYPE {
89
+ ASK_FOR_HELP = "ask_for_help",
90
+ ASK_FOR_CONFIRMATION = "ask_for_confirmation"
91
+ }
92
+ export declare enum EVENTLOG_VERSIONS {
93
+ V_1_0_0 = "1.0.0",
94
+ V_2_0_0 = "2.0.0"
95
+ }
96
+ export declare enum PART_RELEVANCY_LOG_TYPES {
97
+ MATCHES_SEARCH_EXACTLY = "matches_search_exactly",
98
+ BEST_MATCH = "best_match",
99
+ NOT_MATCH_BUT_RELATED = "not_match_but_related",
100
+ NEEDS_CHECK_ELSEWHERE = "needs_check_elsewhere",
101
+ NOT_RELEVANT = "not_relevant",
102
+ OTHER = "other"
103
+ }
104
+ export declare class EventLog {
105
+ version: string;
106
+ organizationId: string;
107
+ interface: INTERFACE;
108
+ event: EVENT;
109
+ externalUserId?: string;
110
+ data: object;
111
+ id?: string;
112
+ timestamp?: any;
113
+ constructor(init: EventLog);
114
+ }
115
+ export interface EventContext {
116
+ eventInterface?: INTERFACE;
117
+ }
118
+ export interface EventLogRequestBody {
119
+ version: string;
120
+ organization_id: string;
121
+ interface: INTERFACE;
122
+ event: EVENT;
123
+ external_user_id?: string;
124
+ data: object;
125
+ }
126
+ export interface EventLogRequestResponse {
127
+ event_id: string;
128
+ timestamp: string;
129
+ }
130
+ export declare const eventLogRequestResponseAdapter: (eventLog: EventLog) => (response: EventLogRequestResponse) => EventLog;
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";var EVENT,INTERFACE,PARTIUM_CONTEXT,OCR_CONTEXT,ECR_TYPE,EVENTLOG_VERSIONS,PART_RELEVANCY_LOG_TYPES,__assign=this&&this.__assign||function(){return __assign=Object.assign||function(_){for(var e,E=1,t=arguments.length;E<t;E++)for(var T in e=arguments[E])Object.prototype.hasOwnProperty.call(e,T)&&(_[T]=e[T]);return _},__assign.apply(this,arguments)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.eventLogRequestResponseAdapter=exports.EventLog=exports.PART_RELEVANCY_LOG_TYPES=exports.EVENTLOG_VERSIONS=exports.ECR_TYPE=exports.OCR_CONTEXT=exports.PARTIUM_CONTEXT=exports.INTERFACE=exports.EVENT=void 0,function(_){_.PART_COPY_ID="part_copy_id",_.PART_CONFIRMED_SEARCH="part_confirmed_search",_.PART_RELEVANCY_TO_SEARCH="part_relevancy_to_search",_.DEVICE_INFO="device_info",_.PART_DETAIL_ENTER="part_detail_enter",_.PART_DETAIL_LEAVE="part_detail_leave",_.PART_DETAIL_SET_RELATION="parts_detail_set_relation",_.PART_THUMBSUP="part_thumbsup",_.PART_THUMBSDOWN="part_thumbsdown",_.REQUEST_LIST_ADD_PART="request_list_add_part",_.REQUEST_LIST_DEL_PART="request_list_del_part",_.REQUEST_LIST_RESET_PARTS="request_list_reset_parts",_.REQUEST_LIST_SEND="request_list_send",_.REQUEST_LIST_UPDATE="request_list_update",_.REQUEST_LIST_ADD_PART_EXISTING="request_list_add_part_existing",_.ATTEMPT_UPLOAD_IMAGE_DIMENSIONS="attempt_upload_image_dimensions",_.CSA_FORM_ENTER_FROM_RESULTS="csa_form_enter_from_results",_.CSA_FORM_ENTER_FROM_PART_DETAILS="csa_form_enter_from_part_details",_.CSA_REQUEST_SEND="csa_request_send",_.CSA_CALL_EXPERT="csa_call_expert",_.CSA_EXPERT_CONFIRMS_PART="csa_expert_confirms_part",_.CSA_EXPERT_MARK_NOT_RESOLVED="csa_expert_marks_not_resolved",_.RECENT_SEARCH_QUERY_CLICKED="recent_search_query_clicked",_.SEARCH_TAG_USED="search_tag_used",_.REQUEST_LIST_EXPORTED="request_list_exported",_.CSA_EXPERT_OPENS_REQUEST="csa_expert_opens_request",_.LANGUAGE_CHANGE="language_change",_.USER_SESSION_INFO="user_session_info",_.CONFIRMED_ID_MATCHES_PART_TO_CONFIRM="confirmed_id_matches_part_to_confirm",_.SHOPPING_CART_EXPORTED="shopping_cart_exported",_.SHOPPING_CART_UPDATE="shopping_cart_update",_.SHOPPING_CART_REMOVE_ALL_PARTS="shopping_cart_remove_all_parts",_.SHOPPING_CART_REMOVE_PART="shopping_cart_remove_part",_.SHOPPING_CART_ADD_PART="shopping_cart_add_part",_.SHOPPING_CART_REQUEST_OFFER="shopping_cart_request_offer",_.FAVORITES_REMOVE="favorites_remove_part",_.FAVORITES_ADD="favorites_add_part",_.ECR_DETAILS_ENTER="ecr_details_enter",_.ECR_LIST="ecr_list",_.ECR_CALL="ecr_call",_.ECR_FORM_SUBMIT="ecr_form_submit",_.ECR_FORM_ENTER="ecr_form_enter",_.SEARCH_INPUT_CODE_SCANNING="search_input_code_scanning",_.SEARCH_INPUT_BOM_FILTER="search_input_bom_filter",_.SEARCH_INPUT_ATTRIBUTE_FILTERS="search_input_attribute_filters",_.SEARCH_INPUT_SEMANTIC_TAGS="search_input_semantic_tags",_.SEARCH_INPUT_SMART_FILTER_APPLIED="search_input_smart_filter_applied",_.SEARCH_RESULTS_STS="search_results_sts",_.SEARCH_RESULTS_VM="search_results_vm",_.SEARCH_RESULTS_HVT="search_results_hvt",_.SEARCH_RESULTS_SMMS_FLOW="search_results_smms_flow",_.SEARCH_RESULTS_FUSION="search_results_fusion",_.SEARCH_SESSION_CREATE="search_session_create",_.SEARCH_ASSISTANCE_OCR="search_assistance_ocr",_.INQUIRY_EXPORTED="inquiry_exported",_.EXPERT_OPENS_INQUIRY="expert_opens_inquiry",_.CSA_EXPERT_STARTS_EXPERT_SEARCH="csa_expert_starts_expert_search",_.CSA_INVITES_EXPERT="csa_invites_expert"}(EVENT||(exports.EVENT=EVENT={})),function(_){_.FIND_APP="find_app",_.API_ACCESS="api_access",_.AGENT_PORTAL_APP="agent_portal_app",_.ANALYTICS_APP="analytics_app",_.DATA_CLEANSING_APP="data_cleansing_app",_.GLOBAL_APP="global_app"}(INTERFACE||(exports.INTERFACE=INTERFACE={})),function(_){_.SEARCH="search",_.RECENTLY_VIEWED_PARTS="recently_viewed_parts",_.FAVORITES="favorites",_.ECR="ecr",_.SHOPPING_CART="shopping_cart",_.DATA_CLEANSING="data_cleansing",_.ANALYTICS="analytics",_.DATA_INSIGHTS="data_insights"}(PARTIUM_CONTEXT||(exports.PARTIUM_CONTEXT=PARTIUM_CONTEXT={})),function(_){_.TEXT_SEARCH="text_search",_.BOM_FILTER="bom_filter"}(OCR_CONTEXT||(exports.OCR_CONTEXT=OCR_CONTEXT={})),function(_){_.ASK_FOR_HELP="ask_for_help",_.ASK_FOR_CONFIRMATION="ask_for_confirmation"}(ECR_TYPE||(exports.ECR_TYPE=ECR_TYPE={})),function(_){_.V_1_0_0="1.0.0",_.V_2_0_0="2.0.0"}(EVENTLOG_VERSIONS||(exports.EVENTLOG_VERSIONS=EVENTLOG_VERSIONS={})),function(_){_.MATCHES_SEARCH_EXACTLY="matches_search_exactly",_.BEST_MATCH="best_match",_.NOT_MATCH_BUT_RELATED="not_match_but_related",_.NEEDS_CHECK_ELSEWHERE="needs_check_elsewhere",_.NOT_RELEVANT="not_relevant",_.OTHER="other"}(PART_RELEVANCY_LOG_TYPES||(exports.PART_RELEVANCY_LOG_TYPES=PART_RELEVANCY_LOG_TYPES={}));var EventLog=function(_){Object.assign(this,_)};exports.EventLog=EventLog;var eventLogRequestResponseAdapter=function(_){return function(e){return new EventLog(__assign(__assign({},_),{id:e.event_id,timestamp:new Date(e.timestamp)}))}};exports.eventLogRequestResponseAdapter=eventLogRequestResponseAdapter;
@@ -0,0 +1,121 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ import { APIObject } from './api-object';
3
+ export interface OrganizationFromAPI {
4
+ partiumId: string;
5
+ name: string;
6
+ displayName?: string;
7
+ requiresAdditionalAuthentication?: boolean;
8
+ config?: {
9
+ defaultSearchLanguage?: string;
10
+ availableSearchLanguages?: string[];
11
+ availableUiLanguages?: string[];
12
+ smmsLanguages?: string[];
13
+ ecr?: {
14
+ email?: string;
15
+ contactPhoneNumber?: string;
16
+ };
17
+ };
18
+ featureFlags?: {
19
+ assemblyNavigationEnabled?: boolean;
20
+ imageSearchEnabled?: boolean;
21
+ codeScannerEnabled?: boolean;
22
+ hybridTextSearchEnabled?: boolean;
23
+ ecrEnabled?: boolean;
24
+ trackingEnabled?: boolean;
25
+ enrichedPartMetadataEnabled?: boolean;
26
+ partRelationsEnabled?: boolean;
27
+ catalogOptimizationEnabled?: boolean;
28
+ };
29
+ ci?: {
30
+ format?: string;
31
+ theme?: 'dark' | 'light';
32
+ colors?: {
33
+ [id: string]: string;
34
+ };
35
+ assets?: {
36
+ [id: string]: string;
37
+ };
38
+ };
39
+ subOrgs?: OrganizationFromAPI[];
40
+ }
41
+ export declare enum THEME {
42
+ LIGHT = "light",
43
+ DARK = "dark"
44
+ }
45
+ /**
46
+ * Advanced configuration parameters for this organization
47
+ */
48
+ export declare class OrganizationConfig {
49
+ defaultSearchLanguage?: string;
50
+ /** @deprecated use defaultSearchLanguage instead */
51
+ defaultLanguage?: string;
52
+ availableSearchLanguages?: string[];
53
+ /** @deprecated use availableSearchLanguages instead */
54
+ availableLanguages?: string[];
55
+ availableUiLanguages?: string[];
56
+ smmsLanguages?: string[];
57
+ ecr?: {
58
+ email?: string;
59
+ contactPhoneNumber?: string;
60
+ };
61
+ /** @deprecated use OrganizationFeatureFlags.assemblyNavigationEnabled instead */
62
+ assemblyNavigationEnabled?: boolean;
63
+ /** @deprecated use OrganizationFeatureFlags.trackingEnabled instead */
64
+ trackingEnabled?: boolean;
65
+ /** @deprecated use OrganizationFeatureFlags.codeScannerEnabled instead */
66
+ codeScannerEnabled?: boolean;
67
+ /** @deprecated use OrganizationFeatureFlags.hybridTextSearchEnabled instead */
68
+ hybridTextSearchEnabled?: boolean;
69
+ /** @deprecated use OrganizationFeatureFlags.ecrEnabled instead */
70
+ csaEnabled?: boolean;
71
+ }
72
+ /**
73
+ * Feature flags for this organization
74
+ */
75
+ export declare class OrganizationFeatureFlags {
76
+ assemblyNavigationEnabled?: boolean;
77
+ imageSearchEnabled?: boolean;
78
+ codeScannerEnabled?: boolean;
79
+ hybridTextSearchEnabled?: boolean;
80
+ ecrEnabled?: boolean;
81
+ trackingEnabled?: boolean;
82
+ enrichedPartMetadataEnabled?: boolean;
83
+ partRelationsEnabled?: boolean;
84
+ catalogOptimizationEnabled?: boolean;
85
+ }
86
+ export declare class OrganizationCI {
87
+ format?: string;
88
+ theme?: THEME;
89
+ colors?: {
90
+ [id: string]: string;
91
+ };
92
+ assets?: {
93
+ [id: string]: string;
94
+ };
95
+ }
96
+ /**
97
+ * An Organization and its configuration data
98
+ */
99
+ export declare class Organization extends APIObject {
100
+ partiumId: string;
101
+ /** @deprecated not supported anymore, use partiumId or name instead */
102
+ searchDomainId?: string;
103
+ name: string;
104
+ displayName?: string;
105
+ requiresAdditionalAuthentication?: boolean;
106
+ config?: OrganizationConfig;
107
+ featureFlags?: OrganizationFeatureFlags;
108
+ ci?: OrganizationCI;
109
+ /** @deprecated use config.ecr instead */
110
+ csa?: {
111
+ emailAddress: string | null;
112
+ contactPhone: string | null;
113
+ };
114
+ subOrgs?: Organization[];
115
+ constructor(init?: Partial<Organization>);
116
+ static fromAPIResponse(organizationFromAPI: Partial<OrganizationFromAPI>): Organization;
117
+ private static mapOrgConfig;
118
+ private static mapFeatureFlags;
119
+ private static mapCI;
120
+ private static mapSubOrgs;
121
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";var __extends=this&&this.__extends||function(){var a=function(n,e){return a=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(a,n){a.__proto__=n}||function(a,n){for(var e in n)Object.prototype.hasOwnProperty.call(n,e)&&(a[e]=n[e])},a(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 i(){this.constructor=n}a(n,e),n.prototype=null===e?Object.create(e):(i.prototype=e.prototype,new i)}}(),__assign=this&&this.__assign||function(){return __assign=Object.assign||function(a){for(var n,e=1,i=arguments.length;e<i;e++)for(var o in n=arguments[e])Object.prototype.hasOwnProperty.call(n,o)&&(a[o]=n[o]);return a},__assign.apply(this,arguments)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Organization=exports.OrganizationCI=exports.OrganizationFeatureFlags=exports.OrganizationConfig=exports.THEME=void 0;var THEME,api_object_1=require("./api-object"),lodash_1=require("lodash");!function(a){a.LIGHT="light",a.DARK="dark"}(THEME||(exports.THEME=THEME={}));var OrganizationConfig=function(){};exports.OrganizationConfig=OrganizationConfig;var OrganizationFeatureFlags=function(){};exports.OrganizationFeatureFlags=OrganizationFeatureFlags;var OrganizationCI=function(){};exports.OrganizationCI=OrganizationCI;var Organization=function(a){function n(n){var e=a.call(this)||this;return Object.assign(e,n),e}return __extends(n,a),n.fromAPIResponse=function(a){var e,i,o,t,r=new n({partiumId:a.partiumId,searchDomainId:a.partiumId,name:a.name,displayName:a.displayName||a.name,requiresAdditionalAuthentication:a.requiresAdditionalAuthentication,config:this.mapOrgConfig(a),featureFlags:this.mapFeatureFlags(a),ci:this.mapCI(a),csa:{emailAddress:null===(i=null===(e=a.config)||void 0===e?void 0:e.ecr)||void 0===i?void 0:i.email,contactPhone:null===(t=null===(o=a.config)||void 0===o?void 0:o.ecr)||void 0===t?void 0:t.contactPhoneNumber}}),l=this.mapSubOrgs(a);return l&&(r.subOrgs=l),r},n.mapOrgConfig=function(a){var n,e,i,o,t,r,l,u,s,d,g,c,v,f,b,p,h,m;return{defaultSearchLanguage:((null===(n=a.config)||void 0===n?void 0:n.defaultSearchLanguage)||"").toLowerCase(),defaultLanguage:((null===(e=a.config)||void 0===e?void 0:e.defaultSearchLanguage)||"").toLowerCase(),availableSearchLanguages:((null===(i=a.config)||void 0===i?void 0:i.availableSearchLanguages)||[]).map((function(a){return a.toLowerCase()})),availableLanguages:((null===(o=a.config)||void 0===o?void 0:o.availableSearchLanguages)||[]).map((function(a){return a.toLowerCase()})),availableUiLanguages:((null===(r=null===(t=a.config)||void 0===t?void 0:t.availableUiLanguages)||void 0===r?void 0:r.length)>0?null===(l=a.config)||void 0===l?void 0:l.availableUiLanguages:(null===(u=a.config)||void 0===u?void 0:u.availableSearchLanguages)||[]).map((function(a){return a.toLowerCase()})),smmsLanguages:((null===(s=a.config)||void 0===s?void 0:s.smmsLanguages)||[]).map((function(a){return a.toLowerCase()})),ecr:{email:null===(g=null===(d=a.config)||void 0===d?void 0:d.ecr)||void 0===g?void 0:g.email,contactPhoneNumber:null===(v=null===(c=a.config)||void 0===c?void 0:c.ecr)||void 0===v?void 0:v.contactPhoneNumber},csaEnabled:null===(f=a.featureFlags)||void 0===f?void 0:f.ecrEnabled,codeScannerEnabled:null===(b=a.featureFlags)||void 0===b?void 0:b.codeScannerEnabled,hybridTextSearchEnabled:null===(p=a.featureFlags)||void 0===p?void 0:p.hybridTextSearchEnabled,assemblyNavigationEnabled:null===(h=a.featureFlags)||void 0===h?void 0:h.assemblyNavigationEnabled,trackingEnabled:null===(m=a.featureFlags)||void 0===m?void 0:m.trackingEnabled}},n.mapFeatureFlags=function(a){var n,e,i,o,t,r,l,u,s;return{assemblyNavigationEnabled:null===(n=a.featureFlags)||void 0===n?void 0:n.assemblyNavigationEnabled,imageSearchEnabled:null===(e=a.featureFlags)||void 0===e?void 0:e.imageSearchEnabled,codeScannerEnabled:null===(i=a.featureFlags)||void 0===i?void 0:i.codeScannerEnabled,hybridTextSearchEnabled:null===(o=a.featureFlags)||void 0===o?void 0:o.hybridTextSearchEnabled,ecrEnabled:null===(t=a.featureFlags)||void 0===t?void 0:t.ecrEnabled,trackingEnabled:null===(r=a.featureFlags)||void 0===r?void 0:r.trackingEnabled,enrichedPartMetadataEnabled:null===(l=a.featureFlags)||void 0===l?void 0:l.enrichedPartMetadataEnabled,partRelationsEnabled:null===(u=a.featureFlags)||void 0===u?void 0:u.partRelationsEnabled,catalogOptimizationEnabled:null===(s=a.featureFlags)||void 0===s?void 0:s.catalogOptimizationEnabled}},n.mapCI=function(a){var n,e,i,o;return{format:null===(n=a.ci)||void 0===n?void 0:n.format,theme:null===(e=a.ci)||void 0===e?void 0:e.theme,colors:null===(i=a.ci)||void 0===i?void 0:i.colors,assets:null===(o=a.ci)||void 0===o?void 0:o.assets}},n.mapSubOrgs=function(a){var e,i=__assign(__assign({},a),{subOrgs:null});return null===(e=a.subOrgs)||void 0===e?void 0:e.map((function(a){return n.fromAPIResponse(__assign(__assign({},(0,lodash_1.mergeWith)({},i,a,(function(a,n){if(Array.isArray(a))return n}))),{subOrgs:null}))}))},n}(api_object_1.APIObject);exports.Organization=Organization;
@@ -0,0 +1,17 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ /**
3
+ * Abstract wrapper-class for files.
4
+ * Since files can have a different representation per platform, a file-warper-strategy is used here,
5
+ * to not directly expose the file-type.
6
+ * The platform-specific file-functions have to be implemented in the app in the shape of Platform-Adapters.
7
+ * Internally the Partium-SDK will only work with this abstract type.
8
+ */
9
+ export declare enum PFileType {
10
+ IMAGE = 0,
11
+ TEXT = 1,
12
+ UNKNOWN = 2
13
+ }
14
+ export declare abstract class PFile {
15
+ abstract supportsMultipartUpload(): boolean;
16
+ abstract appendToFormData(name: string, formData: FormData): void;
17
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";var PFileType;Object.defineProperty(exports,"__esModule",{value:!0}),exports.PFile=exports.PFileType=void 0,function(e){e[e.IMAGE=0]="IMAGE",e[e.TEXT=1]="TEXT",e[e.UNKNOWN=2]="UNKNOWN"}(PFileType||(exports.PFileType=PFileType={}));var PFile=function(){};exports.PFile=PFile;
@@ -0,0 +1,23 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ import { APIObject } from '..';
3
+ /**
4
+ * Paginated list of objects
5
+ */
6
+ export declare class PaginatedList<T extends APIObject> {
7
+ items: T[];
8
+ currentPageIdx: number;
9
+ totalPages: number;
10
+ itemsPerPage: number;
11
+ cursorPaginationEnabled: boolean;
12
+ nextPage: string;
13
+ previousPage: string;
14
+ constructor(items: T[], currentPageIdx: number, totalPages: number, itemsPerPage: number, nextPage?: string, previousPage?: string, cursorPaginationEnabled?: boolean);
15
+ static EMPTY: PaginatedList<any>;
16
+ moreResultsAvailable(): boolean;
17
+ append(newPage: PaginatedList<T>): void;
18
+ /**
19
+ * Helper method to clone this PaginatedList.
20
+ * @returns a deep copy of this PaginatedList
21
+ */
22
+ clone(): PaginatedList<T>;
23
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PaginatedList=void 0;var lodash_1=require("lodash"),PaginatedList=function(){function t(t,e,i,s,a,n,r){this.items=t,this.currentPageIdx=e,this.totalPages=i,this.itemsPerPage=s,this.previousPage=n,this.nextPage=a,this.cursorPaginationEnabled=r}return t.prototype.moreResultsAvailable=function(){return this.currentPageIdx<this.totalPages||!!this.nextPage&&this.cursorPaginationEnabled},t.prototype.append=function(t){this.items=this.items.concat(t.items),this.currentPageIdx=t.currentPageIdx,this.totalPages=t.totalPages,this.itemsPerPage=t.itemsPerPage,this.cursorPaginationEnabled=t.cursorPaginationEnabled,this.nextPage=t.nextPage,this.previousPage=t.previousPage},t.prototype.clone=function(){return(0,lodash_1.cloneDeep)(this)},t.EMPTY=new t([],0,0,0),t}();exports.PaginatedList=PaginatedList;
@@ -0,0 +1,31 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ import { HttpsClientService } from '../services/http/https-client/https-client.service.interface';
3
+ import { AuthenticationConfig } from './auth-config';
4
+ import { BaseServiceClass } from '../services/base.service';
5
+ import { FileTransferService } from '../services/http/file-transfer/file-transfer.service.interface';
6
+ import { LocalStorageService } from '../services/local-storage.service.interface';
7
+ import { DeviceStatusService } from '../services/device-status.service.interface';
8
+ import { FileService } from '../services/file.service.interface';
9
+ export declare enum AUTHENTICATION_METHOD {
10
+ OAUTH = 0,
11
+ OAUTH_API_KEY = 1
12
+ }
13
+ /**
14
+ * The Partium-configuration that is passed to the Partium-SDK for the initialization.
15
+ * It contains information about the backend-url, the authentication-method and it's configuration,
16
+ * and some references to Platform-Adapters that need to be implemented.
17
+ */
18
+ export declare class PartiumConfig {
19
+ partiumApiBaseUrl?: string;
20
+ partiumLoginUrl?: string;
21
+ authenticationMethod?: AUTHENTICATION_METHOD;
22
+ authenticationConfig?: AuthenticationConfig;
23
+ recentPartsMaxPartHistoryLength?: number;
24
+ favoritePartsMaxPartLength?: number;
25
+ httpsClientService: BaseServiceClass<HttpsClientService>;
26
+ fileTransferService: BaseServiceClass<FileTransferService>;
27
+ localStorageService: BaseServiceClass<LocalStorageService>;
28
+ deviceStatusService: BaseServiceClass<DeviceStatusService>;
29
+ fileService: BaseServiceClass<FileService>;
30
+ constructor(init?: Partial<PartiumConfig>);
31
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PartiumConfig=exports.AUTHENTICATION_METHOD=void 0;var AUTHENTICATION_METHOD,auth_config_1=require("./auth-config"),fetch_api_https_client_service_1=require("../integration-defaults/http/https-client/fetch-api-https-client.service"),fetch_api_file_transfer_service_1=require("../integration-defaults/http/file-transfer/fetch-api-file-transfer.service"),web_local_storage_service_1=require("../integration-defaults/web-local-storage.service"),web_device_status_service_1=require("../integration-defaults/web-device-status.service"),web_file_service_1=require("../integration-defaults/web-file.service");!function(e){e[e.OAUTH=0]="OAUTH",e[e.OAUTH_API_KEY=1]="OAUTH_API_KEY"}(AUTHENTICATION_METHOD||(exports.AUTHENTICATION_METHOD=AUTHENTICATION_METHOD={}));var PartiumConfig=function(e){this.partiumApiBaseUrl="https://api.partium.io",this.partiumLoginUrl="https://login.partium.io",this.authenticationMethod=AUTHENTICATION_METHOD.OAUTH_API_KEY,this.recentPartsMaxPartHistoryLength=30,this.favoritePartsMaxPartLength=50,this.httpsClientService=fetch_api_https_client_service_1.FetchAPIHttpsClientService,this.fileTransferService=fetch_api_file_transfer_service_1.FetchAPIFileTransferService,this.localStorageService=web_local_storage_service_1.WebLocalStorageService,this.deviceStatusService=web_device_status_service_1.WebDeviceStatusService,this.fileService=web_file_service_1.WebFileService,Object.assign(this,e),this.authenticationMethod===AUTHENTICATION_METHOD.OAUTH&&(this.authenticationConfig||(this.authenticationConfig=new auth_config_1.OauthAuthenticationConfig))};exports.PartiumConfig=PartiumConfig;
@@ -0,0 +1,16 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ /**
3
+ * Token claims of the user token that are used in Partium client
4
+ */
5
+ export interface UserToken {
6
+ sub: string;
7
+ preferred_username: string;
8
+ role: string;
9
+ email?: string;
10
+ groups?: string[];
11
+ [key: string]: any;
12
+ }
13
+ /**
14
+ * Decodes jwt token string and returns an object with type UserToken
15
+ */
16
+ export declare function createUserToken(token: string): UserToken;
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.createUserToken=createUserToken;var jwt_decode_1=require("jwt-decode");function createUserToken(e){return(0,jwt_decode_1.jwtDecode)(e)}
@@ -0,0 +1,48 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ import { UserToken } from './user-token';
3
+ export declare enum Role {
4
+ admin = "admin",
5
+ announcementsEditor = "announcementsEditor",//partium/org/announcementsEditor
6
+ partiumAnnouncementsEditor = "partiumAnnouncementsEditor",// partium/announcementsEditor
7
+ /** @deprecated role does not exist in Partium */
8
+ user = "user",
9
+ /** Partium Analytics user role */
10
+ analyst = "dataAnalyst",
11
+ /** Partium Data Insights user role */
12
+ dataInsightAnalyst = "dataInsightAnalyst",
13
+ csa = "csa",
14
+ factoryWorker = "factoryWorker",
15
+ developer = "developer",
16
+ catalogAdmin = "catalogAdmin",
17
+ dataManipulator = "dataManipulator"
18
+ }
19
+ /**
20
+ * The user-object of the user that is logged in into the SDK.
21
+ */
22
+ export declare class User {
23
+ /** Can be either an email or the `preferred_username` of the user (can be any string) */
24
+ email: string;
25
+ /** @deprecated first role of the set of roles the user has. Use `roles` property instead. */
26
+ role: Role;
27
+ /**
28
+ * Set of roles the user has.
29
+ * Does not distinguish the organizations in which the user has certain roles.
30
+ */
31
+ roles: Set<Role>;
32
+ /**
33
+ * List of groups of the user.
34
+ * This can be used in cases where roles can not be parsed from them directly.
35
+ */
36
+ groups: string[];
37
+ constructor(email: string, role: Role, roles?: Set<Role>, groups?: string[]);
38
+ /**
39
+ * Creates a User object from a UserToken object (parsed jwt token)
40
+ * @param token - jwt token in UserToken format
41
+ * @returns created User with values populated from token
42
+ */
43
+ static createFromToken(token: UserToken): User;
44
+ private static createRoles;
45
+ private static getRoleFromGroup;
46
+ private static checkPartiumRoles;
47
+ private static getRoleByString;
48
+ }
@@ -0,0 +1,2 @@
1
+ // Copyright © 2022-2025 Partium, Inc. DBA Partium
2
+ "use strict";var Role;Object.defineProperty(exports,"__esModule",{value:!0}),exports.User=exports.Role=void 0,function(e){e.admin="admin",e.announcementsEditor="announcementsEditor",e.partiumAnnouncementsEditor="partiumAnnouncementsEditor",e.user="user",e.analyst="dataAnalyst",e.dataInsightAnalyst="dataInsightAnalyst",e.csa="csa",e.factoryWorker="factoryWorker",e.developer="developer",e.catalogAdmin="catalogAdmin",e.dataManipulator="dataManipulator"}(Role||(exports.Role=Role={}));var User=function(){function e(e,t,r,n){void 0===n&&(n=[]),this.email=e,this.role=t,this.roles=r||new Set([t]),this.groups=n}return e.createFromToken=function(t){var r=t.email||t.preferred_username,n=this.createRoles(t),o=t.groups||[];return new e(r,n.values().next().value,n,o)},e.createRoles=function(e){if(e.role)return new Set([e.role]);if(e.groups){for(var t=new Set,r=0,n=e.groups;r<n.length;r++){var o=n[r],a=this.getRoleFromGroup(o);t.add(a)}return t}return new Set},e.getRoleFromGroup=function(e){var t=this.checkPartiumRoles(e),r=e.slice(e.lastIndexOf("/")+1);return this.getRoleByString(r,t)},e.checkPartiumRoles=function(e){var t=e.split("/"),r="partium"===t[t.length-2],n=t[t.length-1],o=Object.values(Role);return r&&!!o.find((function(e){return e===n}))},e.getRoleByString=function(e,t){if(Object.values(Role).includes(e)){var r=e;return r===Role.announcementsEditor&&t?Role.partiumAnnouncementsEditor:r}return Role.factoryWorker},e}();exports.User=User;