@contentstack/delivery-sdk 4.11.2 → 5.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 (549) hide show
  1. package/README.md +31 -2
  2. package/dist/{modern/lib → legacy/assets}/asset.cjs +15 -34
  3. package/dist/legacy/assets/asset.cjs.map +1 -0
  4. package/dist/legacy/{lib/asset.cjs → assets/asset.js} +13 -34
  5. package/dist/legacy/assets/asset.js.map +1 -0
  6. package/dist/{modern/lib/cache.cjs → legacy/cache/index.cjs} +14 -35
  7. package/dist/legacy/cache/index.cjs.map +1 -0
  8. package/dist/legacy/{lib/cache.js → cache/index.js} +10 -8
  9. package/dist/legacy/cache/index.js.map +1 -0
  10. package/dist/legacy/{lib → common}/error-messages.cjs +8 -34
  11. package/dist/legacy/common/error-messages.cjs.map +1 -0
  12. package/dist/legacy/{lib → common}/error-messages.js +6 -9
  13. package/dist/legacy/common/error-messages.js.map +1 -0
  14. package/dist/{modern/lib → legacy/common}/pagination.cjs +10 -32
  15. package/dist/legacy/common/pagination.cjs.map +1 -0
  16. package/dist/legacy/{lib/pagination.cjs → common/pagination.js} +10 -34
  17. package/dist/legacy/common/pagination.js.map +1 -0
  18. package/dist/legacy/common/string-extensions.cjs +11 -0
  19. package/dist/legacy/common/string-extensions.cjs.map +1 -0
  20. package/dist/legacy/{lib → common}/string-extensions.js +1 -2
  21. package/dist/legacy/common/string-extensions.js.map +1 -0
  22. package/dist/legacy/{lib → common}/types.cjs +17 -55
  23. package/dist/legacy/common/types.cjs.map +1 -0
  24. package/dist/legacy/{lib → common}/types.js +3 -18
  25. package/dist/legacy/common/types.js.map +1 -0
  26. package/dist/legacy/common/utils.cjs +29 -0
  27. package/dist/legacy/common/utils.cjs.map +1 -0
  28. package/dist/legacy/{lib → common}/utils.js +7 -10
  29. package/dist/legacy/common/utils.js.map +1 -0
  30. package/dist/legacy/content-type/index.cjs +43 -0
  31. package/dist/legacy/content-type/index.cjs.map +1 -0
  32. package/dist/legacy/content-type/index.js +41 -0
  33. package/dist/legacy/content-type/index.js.map +1 -0
  34. package/dist/legacy/{lib → entries}/entries.cjs +21 -41
  35. package/dist/legacy/entries/entries.cjs.map +1 -0
  36. package/dist/{modern/lib → legacy/entries}/entries.js +15 -12
  37. package/dist/legacy/entries/entries.js.map +1 -0
  38. package/dist/{modern/lib → legacy/entries}/entry.cjs +20 -36
  39. package/dist/legacy/entries/entry.cjs.map +1 -0
  40. package/dist/legacy/{lib/entry.cjs → entries/entry.js} +18 -36
  41. package/dist/legacy/entries/entry.js.map +1 -0
  42. package/dist/{modern/lib/global-field.cjs → legacy/global-field/index.cjs} +15 -34
  43. package/dist/legacy/global-field/index.cjs.map +1 -0
  44. package/dist/legacy/{lib/global-field.cjs → global-field/index.js} +13 -34
  45. package/dist/legacy/global-field/index.js.map +1 -0
  46. package/dist/legacy/index.cjs +28 -48
  47. package/dist/legacy/index.cjs.map +1 -1
  48. package/dist/legacy/index.js +9 -11
  49. package/dist/legacy/index.js.map +1 -1
  50. package/dist/legacy/{lib → query}/asset-query.cjs +10 -34
  51. package/dist/legacy/query/asset-query.cjs.map +1 -0
  52. package/dist/{modern/lib → legacy/query}/asset-query.js +8 -9
  53. package/dist/legacy/query/asset-query.js.map +1 -0
  54. package/dist/{modern/lib → legacy/query}/base-query.cjs +20 -37
  55. package/dist/legacy/query/base-query.cjs.map +1 -0
  56. package/dist/legacy/{lib/base-query.cjs → query/base-query.js} +18 -37
  57. package/dist/legacy/query/base-query.js.map +1 -0
  58. package/dist/legacy/query/contenttype-query.cjs +51 -0
  59. package/dist/legacy/query/contenttype-query.cjs.map +1 -0
  60. package/dist/legacy/query/contenttype-query.js +49 -0
  61. package/dist/legacy/query/contenttype-query.js.map +1 -0
  62. package/dist/legacy/query/global-field-query.cjs +30 -0
  63. package/dist/legacy/query/global-field-query.cjs.map +1 -0
  64. package/dist/{modern/lib → legacy/query}/global-field-query.js +7 -8
  65. package/dist/legacy/query/global-field-query.js.map +1 -0
  66. package/dist/legacy/{lib → query}/query.cjs +46 -66
  67. package/dist/legacy/query/query.cjs.map +1 -0
  68. package/dist/{modern/lib → legacy/query}/query.js +15 -12
  69. package/dist/legacy/query/query.js.map +1 -0
  70. package/dist/legacy/query/taxonomy-query.cjs +14 -0
  71. package/dist/legacy/query/taxonomy-query.cjs.map +1 -0
  72. package/dist/legacy/query/taxonomy-query.js +12 -0
  73. package/dist/legacy/query/taxonomy-query.js.map +1 -0
  74. package/dist/{modern/lib → legacy/stack}/contentstack.cjs +44 -56
  75. package/dist/legacy/stack/contentstack.cjs.map +1 -0
  76. package/dist/{modern/lib → legacy/stack}/contentstack.js +19 -16
  77. package/dist/legacy/stack/contentstack.js.map +1 -0
  78. package/dist/legacy/stack/index.cjs +11 -0
  79. package/dist/legacy/stack/index.cjs.map +1 -0
  80. package/dist/legacy/stack/index.js +7 -0
  81. package/dist/legacy/stack/index.js.map +1 -0
  82. package/dist/{modern/lib → legacy/stack}/stack.cjs +30 -49
  83. package/dist/legacy/stack/stack.cjs.map +1 -0
  84. package/dist/legacy/{lib → stack}/stack.js +20 -16
  85. package/dist/legacy/stack/stack.js.map +1 -0
  86. package/dist/legacy/sync/synchronization.cjs +30 -0
  87. package/dist/legacy/sync/synchronization.cjs.map +1 -0
  88. package/dist/{modern/lib → legacy/sync}/synchronization.js +11 -13
  89. package/dist/legacy/sync/synchronization.js.map +1 -0
  90. package/dist/modern/{lib/asset.js → assets/asset.cjs} +13 -10
  91. package/dist/modern/assets/asset.cjs.map +1 -0
  92. package/dist/modern/{lib → assets}/asset.d.ts +2 -4
  93. package/dist/modern/assets/asset.d.ts.map +1 -0
  94. package/dist/{legacy/lib → modern/assets}/asset.js +10 -9
  95. package/dist/modern/assets/asset.js.map +1 -0
  96. package/dist/modern/{lib/string-extensions.d.ts → assets/image-transform.d.ts} +3 -16
  97. package/dist/modern/assets/image-transform.d.ts.map +1 -0
  98. package/dist/modern/assets/index.d.ts +3 -0
  99. package/dist/modern/assets/index.d.ts.map +1 -0
  100. package/dist/{legacy/lib/cache.cjs → modern/cache/index.cjs} +14 -35
  101. package/dist/modern/cache/index.cjs.map +1 -0
  102. package/dist/{legacy/lib/cache.d.ts → modern/cache/index.d.ts} +3 -10
  103. package/dist/modern/cache/index.d.ts.map +1 -0
  104. package/dist/modern/{lib/cache.js → cache/index.js} +10 -8
  105. package/dist/modern/cache/index.js.map +1 -0
  106. package/dist/modern/{lib → common}/error-messages.cjs +8 -34
  107. package/dist/modern/common/error-messages.cjs.map +1 -0
  108. package/dist/{legacy/lib → modern/common}/error-messages.d.ts +4 -5
  109. package/dist/modern/common/error-messages.d.ts.map +1 -0
  110. package/dist/modern/{lib → common}/error-messages.js +6 -9
  111. package/dist/modern/common/error-messages.js.map +1 -0
  112. package/dist/{legacy/lib/pagination.js → modern/common/pagination.cjs} +10 -12
  113. package/dist/modern/common/pagination.cjs.map +1 -0
  114. package/dist/{legacy/lib → modern/common}/pagination.d.ts +3 -10
  115. package/dist/modern/common/pagination.d.ts.map +1 -0
  116. package/dist/modern/{lib → common}/pagination.js +6 -10
  117. package/dist/modern/common/pagination.js.map +1 -0
  118. package/dist/modern/common/string-extensions.cjs +11 -0
  119. package/dist/modern/common/string-extensions.cjs.map +1 -0
  120. package/dist/modern/common/string-extensions.d.ts +8 -0
  121. package/dist/modern/common/string-extensions.d.ts.map +1 -0
  122. package/dist/modern/{lib → common}/string-extensions.js +1 -2
  123. package/dist/modern/common/string-extensions.js.map +1 -0
  124. package/dist/modern/{lib → common}/types.cjs +17 -55
  125. package/dist/modern/common/types.cjs.map +1 -0
  126. package/dist/{legacy/lib → modern/common}/types.d.ts +60 -41
  127. package/dist/modern/common/types.d.ts.map +1 -0
  128. package/dist/modern/{lib → common}/types.js +3 -18
  129. package/dist/modern/common/types.js.map +1 -0
  130. package/dist/modern/common/utils.cjs +29 -0
  131. package/dist/modern/common/utils.cjs.map +1 -0
  132. package/dist/modern/common/utils.d.ts +14 -0
  133. package/dist/modern/common/utils.d.ts.map +1 -0
  134. package/dist/modern/{lib → common}/utils.js +7 -10
  135. package/dist/modern/common/utils.js.map +1 -0
  136. package/dist/{legacy/lib/content-type.js → modern/content-type/index.cjs} +18 -14
  137. package/dist/modern/content-type/index.cjs.map +1 -0
  138. package/dist/{legacy/lib/content-type.d.ts → modern/content-type/index.d.ts} +4 -13
  139. package/dist/modern/content-type/index.d.ts.map +1 -0
  140. package/dist/modern/{lib/content-type.js → content-type/index.js} +13 -11
  141. package/dist/modern/content-type/index.js.map +1 -0
  142. package/dist/modern/{lib → entries}/entries.cjs +18 -41
  143. package/dist/modern/entries/entries.cjs.map +1 -0
  144. package/dist/modern/{lib → entries}/entries.d.ts +5 -11
  145. package/dist/modern/entries/entries.d.ts.map +1 -0
  146. package/dist/{legacy/lib → modern/entries}/entries.js +12 -12
  147. package/dist/modern/entries/entries.js.map +1 -0
  148. package/dist/modern/{lib/entry.js → entries/entry.cjs} +18 -12
  149. package/dist/modern/entries/entry.cjs.map +1 -0
  150. package/dist/modern/{lib → entries}/entry.d.ts +2 -4
  151. package/dist/modern/entries/entry.d.ts.map +1 -0
  152. package/dist/{legacy/lib → modern/entries}/entry.js +14 -10
  153. package/dist/modern/entries/entry.js.map +1 -0
  154. package/dist/modern/entries/index.d.ts +3 -0
  155. package/dist/modern/entries/index.d.ts.map +1 -0
  156. package/dist/modern/{lib/global-field.js → global-field/index.cjs} +13 -10
  157. package/dist/modern/global-field/index.cjs.map +1 -0
  158. package/dist/{legacy/lib/global-field.d.cts → modern/global-field/index.d.ts} +2 -4
  159. package/dist/modern/global-field/index.d.ts.map +1 -0
  160. package/dist/{legacy/lib/global-field.js → modern/global-field/index.js} +10 -9
  161. package/dist/modern/global-field/index.js.map +1 -0
  162. package/dist/modern/index.cjs +28 -48
  163. package/dist/modern/index.cjs.map +1 -1
  164. package/dist/modern/index.d.ts +17 -26
  165. package/dist/modern/index.d.ts.map +1 -0
  166. package/dist/modern/index.js +9 -11
  167. package/dist/modern/index.js.map +1 -1
  168. package/dist/modern/{lib → query}/asset-query.cjs +10 -34
  169. package/dist/modern/query/asset-query.cjs.map +1 -0
  170. package/dist/{legacy/lib → modern/query}/asset-query.d.ts +4 -11
  171. package/dist/modern/query/asset-query.d.ts.map +1 -0
  172. package/dist/{legacy/lib → modern/query}/asset-query.js +8 -9
  173. package/dist/modern/query/asset-query.js.map +1 -0
  174. package/dist/{legacy/lib/base-query.js → modern/query/base-query.cjs} +18 -16
  175. package/dist/modern/query/base-query.cjs.map +1 -0
  176. package/dist/modern/query/base-query.d.ts +174 -0
  177. package/dist/modern/query/base-query.d.ts.map +1 -0
  178. package/dist/modern/{lib → query}/base-query.js +14 -14
  179. package/dist/modern/query/base-query.js.map +1 -0
  180. package/dist/{legacy/lib/contenttype-query.js → modern/query/contenttype-query.cjs} +13 -10
  181. package/dist/modern/query/contenttype-query.cjs.map +1 -0
  182. package/dist/modern/{lib → query}/contenttype-query.d.ts +3 -9
  183. package/dist/modern/query/contenttype-query.d.ts.map +1 -0
  184. package/dist/modern/{lib → query}/contenttype-query.js +10 -9
  185. package/dist/modern/query/contenttype-query.js.map +1 -0
  186. package/dist/modern/query/entry-queryable.d.ts +4 -0
  187. package/dist/modern/query/entry-queryable.d.ts.map +1 -0
  188. package/dist/modern/query/global-field-query.cjs +30 -0
  189. package/dist/modern/query/global-field-query.cjs.map +1 -0
  190. package/dist/modern/{lib → query}/global-field-query.d.ts +3 -11
  191. package/dist/modern/query/global-field-query.d.ts.map +1 -0
  192. package/dist/{legacy/lib → modern/query}/global-field-query.js +7 -8
  193. package/dist/modern/query/global-field-query.js.map +1 -0
  194. package/dist/modern/query/index.d.ts +8 -0
  195. package/dist/modern/query/index.d.ts.map +1 -0
  196. package/dist/modern/{lib → query}/query.cjs +43 -66
  197. package/dist/modern/query/query.cjs.map +1 -0
  198. package/dist/{legacy/base-query-B4_k3n_p.d.ts → modern/query/query.d.ts} +4 -176
  199. package/dist/modern/query/query.d.ts.map +1 -0
  200. package/dist/{legacy/lib → modern/query}/query.js +12 -12
  201. package/dist/modern/query/query.js.map +1 -0
  202. package/dist/modern/query/taxonomy-query.cjs +14 -0
  203. package/dist/modern/query/taxonomy-query.cjs.map +1 -0
  204. package/dist/modern/query/taxonomy-query.d.ts +6 -0
  205. package/dist/modern/query/taxonomy-query.d.ts.map +1 -0
  206. package/dist/modern/query/taxonomy-query.js +12 -0
  207. package/dist/modern/query/taxonomy-query.js.map +1 -0
  208. package/dist/{legacy/lib → modern/stack}/contentstack.cjs +51 -66
  209. package/dist/modern/stack/contentstack.cjs.map +1 -0
  210. package/dist/modern/{contentstack-BmTB3Y49.d.cts → stack/contentstack.d.ts} +8 -13
  211. package/dist/modern/stack/contentstack.d.ts.map +1 -0
  212. package/dist/{legacy/lib → modern/stack}/contentstack.js +26 -26
  213. package/dist/modern/stack/contentstack.js.map +1 -0
  214. package/dist/modern/stack/index.cjs +11 -0
  215. package/dist/modern/stack/index.cjs.map +1 -0
  216. package/dist/modern/stack/index.d.ts +6 -0
  217. package/dist/modern/stack/index.d.ts.map +1 -0
  218. package/dist/modern/stack/index.js +7 -0
  219. package/dist/modern/stack/index.js.map +1 -0
  220. package/dist/{legacy/lib → modern/stack}/stack.cjs +27 -49
  221. package/dist/modern/stack/stack.cjs.map +1 -0
  222. package/dist/{legacy/lib → modern/stack}/stack.d.ts +11 -21
  223. package/dist/modern/stack/stack.d.ts.map +1 -0
  224. package/dist/modern/{lib → stack}/stack.js +17 -16
  225. package/dist/modern/stack/stack.js.map +1 -0
  226. package/dist/modern/sync/index.d.ts +3 -0
  227. package/dist/modern/sync/index.d.ts.map +1 -0
  228. package/dist/modern/sync/synchronization.cjs +30 -0
  229. package/dist/modern/sync/synchronization.cjs.map +1 -0
  230. package/dist/modern/sync/synchronization.d.ts +4 -0
  231. package/dist/modern/sync/synchronization.d.ts.map +1 -0
  232. package/dist/{legacy/lib → modern/sync}/synchronization.js +11 -13
  233. package/dist/modern/sync/synchronization.js.map +1 -0
  234. package/package.json +19 -21
  235. package/dist/legacy/base-query-DrXtYoPl.d.cts +0 -548
  236. package/dist/legacy/contentstack-BmTB3Y49.d.cts +0 -35
  237. package/dist/legacy/contentstack-DajCqJdu.d.ts +0 -35
  238. package/dist/legacy/index.d.cts +0 -26
  239. package/dist/legacy/index.d.ts +0 -26
  240. package/dist/legacy/lib/asset-query.cjs.map +0 -1
  241. package/dist/legacy/lib/asset-query.d.cts +0 -110
  242. package/dist/legacy/lib/asset-query.js.map +0 -1
  243. package/dist/legacy/lib/asset.cjs.map +0 -1
  244. package/dist/legacy/lib/asset.d.cts +0 -108
  245. package/dist/legacy/lib/asset.d.ts +0 -108
  246. package/dist/legacy/lib/asset.js.map +0 -1
  247. package/dist/legacy/lib/base-query.cjs.map +0 -1
  248. package/dist/legacy/lib/base-query.d.cts +0 -8
  249. package/dist/legacy/lib/base-query.d.ts +0 -8
  250. package/dist/legacy/lib/base-query.js.map +0 -1
  251. package/dist/legacy/lib/cache.cjs.map +0 -1
  252. package/dist/legacy/lib/cache.d.cts +0 -20
  253. package/dist/legacy/lib/cache.js.map +0 -1
  254. package/dist/legacy/lib/content-type.cjs +0 -61
  255. package/dist/legacy/lib/content-type.cjs.map +0 -1
  256. package/dist/legacy/lib/content-type.d.cts +0 -50
  257. package/dist/legacy/lib/content-type.js.map +0 -1
  258. package/dist/legacy/lib/contentstack.cjs.map +0 -1
  259. package/dist/legacy/lib/contentstack.d.cts +0 -21
  260. package/dist/legacy/lib/contentstack.d.ts +0 -21
  261. package/dist/legacy/lib/contentstack.js.map +0 -1
  262. package/dist/legacy/lib/contenttype-query.cjs +0 -70
  263. package/dist/legacy/lib/contenttype-query.cjs.map +0 -1
  264. package/dist/legacy/lib/contenttype-query.d.cts +0 -43
  265. package/dist/legacy/lib/contenttype-query.d.ts +0 -43
  266. package/dist/legacy/lib/contenttype-query.js.map +0 -1
  267. package/dist/legacy/lib/entries.cjs.map +0 -1
  268. package/dist/legacy/lib/entries.d.cts +0 -191
  269. package/dist/legacy/lib/entries.d.ts +0 -191
  270. package/dist/legacy/lib/entries.js.map +0 -1
  271. package/dist/legacy/lib/entry-queryable.cjs +0 -33
  272. package/dist/legacy/lib/entry-queryable.cjs.map +0 -1
  273. package/dist/legacy/lib/entry-queryable.d.cts +0 -13
  274. package/dist/legacy/lib/entry-queryable.d.ts +0 -13
  275. package/dist/legacy/lib/entry-queryable.js +0 -8
  276. package/dist/legacy/lib/entry-queryable.js.map +0 -1
  277. package/dist/legacy/lib/entry.cjs.map +0 -1
  278. package/dist/legacy/lib/entry.d.cts +0 -170
  279. package/dist/legacy/lib/entry.d.ts +0 -170
  280. package/dist/legacy/lib/entry.js.map +0 -1
  281. package/dist/legacy/lib/error-messages.cjs.map +0 -1
  282. package/dist/legacy/lib/error-messages.d.cts +0 -31
  283. package/dist/legacy/lib/error-messages.js.map +0 -1
  284. package/dist/legacy/lib/global-field-query.cjs +0 -54
  285. package/dist/legacy/lib/global-field-query.cjs.map +0 -1
  286. package/dist/legacy/lib/global-field-query.d.cts +0 -27
  287. package/dist/legacy/lib/global-field-query.d.ts +0 -27
  288. package/dist/legacy/lib/global-field-query.js.map +0 -1
  289. package/dist/legacy/lib/global-field.cjs.map +0 -1
  290. package/dist/legacy/lib/global-field.d.ts +0 -38
  291. package/dist/legacy/lib/global-field.js.map +0 -1
  292. package/dist/legacy/lib/image-transform.cjs +0 -528
  293. package/dist/legacy/lib/image-transform.cjs.map +0 -1
  294. package/dist/legacy/lib/image-transform.d.cts +0 -7
  295. package/dist/legacy/lib/image-transform.d.ts +0 -7
  296. package/dist/legacy/lib/image-transform.js +0 -506
  297. package/dist/legacy/lib/image-transform.js.map +0 -1
  298. package/dist/legacy/lib/pagination.cjs.map +0 -1
  299. package/dist/legacy/lib/pagination.d.cts +0 -99
  300. package/dist/legacy/lib/pagination.js.map +0 -1
  301. package/dist/legacy/lib/query.cjs.map +0 -1
  302. package/dist/legacy/lib/query.d.cts +0 -8
  303. package/dist/legacy/lib/query.d.ts +0 -8
  304. package/dist/legacy/lib/query.js.map +0 -1
  305. package/dist/legacy/lib/stack.cjs.map +0 -1
  306. package/dist/legacy/lib/stack.d.cts +0 -170
  307. package/dist/legacy/lib/stack.js.map +0 -1
  308. package/dist/legacy/lib/string-extensions.cjs +0 -27
  309. package/dist/legacy/lib/string-extensions.cjs.map +0 -1
  310. package/dist/legacy/lib/string-extensions.d.cts +0 -404
  311. package/dist/legacy/lib/string-extensions.d.ts +0 -404
  312. package/dist/legacy/lib/string-extensions.js.map +0 -1
  313. package/dist/legacy/lib/synchronization.cjs +0 -65
  314. package/dist/legacy/lib/synchronization.cjs.map +0 -1
  315. package/dist/legacy/lib/synchronization.d.cts +0 -10
  316. package/dist/legacy/lib/synchronization.d.ts +0 -10
  317. package/dist/legacy/lib/synchronization.js.map +0 -1
  318. package/dist/legacy/lib/taxonomy-query.cjs +0 -38
  319. package/dist/legacy/lib/taxonomy-query.cjs.map +0 -1
  320. package/dist/legacy/lib/taxonomy-query.d.cts +0 -14
  321. package/dist/legacy/lib/taxonomy-query.d.ts +0 -14
  322. package/dist/legacy/lib/taxonomy-query.js +0 -13
  323. package/dist/legacy/lib/taxonomy-query.js.map +0 -1
  324. package/dist/legacy/lib/types.cjs.map +0 -1
  325. package/dist/legacy/lib/types.d.cts +0 -318
  326. package/dist/legacy/lib/types.js.map +0 -1
  327. package/dist/legacy/lib/utils.cjs +0 -55
  328. package/dist/legacy/lib/utils.cjs.map +0 -1
  329. package/dist/legacy/lib/utils.d.cts +0 -21
  330. package/dist/legacy/lib/utils.d.ts +0 -21
  331. package/dist/legacy/lib/utils.js.map +0 -1
  332. package/dist/legacy/persistance/config/persistance-storage-config.cjs +0 -19
  333. package/dist/legacy/persistance/config/persistance-storage-config.cjs.map +0 -1
  334. package/dist/legacy/persistance/config/persistance-storage-config.d.cts +0 -33
  335. package/dist/legacy/persistance/config/persistance-storage-config.d.ts +0 -33
  336. package/dist/legacy/persistance/config/persistance-storage-config.js +0 -1
  337. package/dist/legacy/persistance/config/persistance-storage-config.js.map +0 -1
  338. package/dist/legacy/persistance/helper/utils.cjs +0 -31
  339. package/dist/legacy/persistance/helper/utils.cjs.map +0 -1
  340. package/dist/legacy/persistance/helper/utils.d.cts +0 -4
  341. package/dist/legacy/persistance/helper/utils.d.ts +0 -4
  342. package/dist/legacy/persistance/helper/utils.js +0 -6
  343. package/dist/legacy/persistance/helper/utils.js.map +0 -1
  344. package/dist/legacy/persistance/index.cjs +0 -31
  345. package/dist/legacy/persistance/index.cjs.map +0 -1
  346. package/dist/legacy/persistance/index.d.cts +0 -7
  347. package/dist/legacy/persistance/index.d.ts +0 -7
  348. package/dist/legacy/persistance/index.js +0 -6
  349. package/dist/legacy/persistance/index.js.map +0 -1
  350. package/dist/legacy/persistance/persistance-store.cjs +0 -162
  351. package/dist/legacy/persistance/persistance-store.cjs.map +0 -1
  352. package/dist/legacy/persistance/persistance-store.d.cts +0 -51
  353. package/dist/legacy/persistance/persistance-store.d.ts +0 -51
  354. package/dist/legacy/persistance/persistance-store.js +0 -137
  355. package/dist/legacy/persistance/persistance-store.js.map +0 -1
  356. package/dist/legacy/persistance/storages/index.cjs +0 -34
  357. package/dist/legacy/persistance/storages/index.cjs.map +0 -1
  358. package/dist/legacy/persistance/storages/index.d.cts +0 -4
  359. package/dist/legacy/persistance/storages/index.d.ts +0 -4
  360. package/dist/legacy/persistance/storages/index.js +0 -8
  361. package/dist/legacy/persistance/storages/index.js.map +0 -1
  362. package/dist/legacy/persistance/storages/local-storage.cjs +0 -66
  363. package/dist/legacy/persistance/storages/local-storage.cjs.map +0 -1
  364. package/dist/legacy/persistance/storages/local-storage.d.cts +0 -6
  365. package/dist/legacy/persistance/storages/local-storage.d.ts +0 -6
  366. package/dist/legacy/persistance/storages/local-storage.js +0 -41
  367. package/dist/legacy/persistance/storages/local-storage.js.map +0 -1
  368. package/dist/legacy/persistance/storages/memory-storage.cjs +0 -60
  369. package/dist/legacy/persistance/storages/memory-storage.cjs.map +0 -1
  370. package/dist/legacy/persistance/storages/memory-storage.d.cts +0 -6
  371. package/dist/legacy/persistance/storages/memory-storage.d.ts +0 -6
  372. package/dist/legacy/persistance/storages/memory-storage.js +0 -35
  373. package/dist/legacy/persistance/storages/memory-storage.js.map +0 -1
  374. package/dist/legacy/persistance/types/index.cjs +0 -19
  375. package/dist/legacy/persistance/types/index.cjs.map +0 -1
  376. package/dist/legacy/persistance/types/index.d.cts +0 -3
  377. package/dist/legacy/persistance/types/index.d.ts +0 -3
  378. package/dist/legacy/persistance/types/index.js +0 -1
  379. package/dist/legacy/persistance/types/index.js.map +0 -1
  380. package/dist/legacy/persistance/types/storage-type.cjs +0 -19
  381. package/dist/legacy/persistance/types/storage-type.cjs.map +0 -1
  382. package/dist/legacy/persistance/types/storage-type.d.cts +0 -3
  383. package/dist/legacy/persistance/types/storage-type.d.ts +0 -3
  384. package/dist/legacy/persistance/types/storage-type.js +0 -1
  385. package/dist/legacy/persistance/types/storage-type.js.map +0 -1
  386. package/dist/legacy/persistance/types/storage.cjs +0 -19
  387. package/dist/legacy/persistance/types/storage.cjs.map +0 -1
  388. package/dist/legacy/persistance/types/storage.d.cts +0 -12
  389. package/dist/legacy/persistance/types/storage.d.ts +0 -12
  390. package/dist/legacy/persistance/types/storage.js +0 -1
  391. package/dist/legacy/persistance/types/storage.js.map +0 -1
  392. package/dist/modern/base-query-B4_k3n_p.d.ts +0 -548
  393. package/dist/modern/base-query-DrXtYoPl.d.cts +0 -548
  394. package/dist/modern/contentstack-DajCqJdu.d.ts +0 -35
  395. package/dist/modern/index.d.cts +0 -26
  396. package/dist/modern/lib/asset-query.cjs.map +0 -1
  397. package/dist/modern/lib/asset-query.d.cts +0 -110
  398. package/dist/modern/lib/asset-query.d.ts +0 -110
  399. package/dist/modern/lib/asset-query.js.map +0 -1
  400. package/dist/modern/lib/asset.cjs.map +0 -1
  401. package/dist/modern/lib/asset.d.cts +0 -108
  402. package/dist/modern/lib/asset.js.map +0 -1
  403. package/dist/modern/lib/base-query.cjs.map +0 -1
  404. package/dist/modern/lib/base-query.d.cts +0 -8
  405. package/dist/modern/lib/base-query.d.ts +0 -8
  406. package/dist/modern/lib/base-query.js.map +0 -1
  407. package/dist/modern/lib/cache.cjs.map +0 -1
  408. package/dist/modern/lib/cache.d.cts +0 -20
  409. package/dist/modern/lib/cache.d.ts +0 -20
  410. package/dist/modern/lib/cache.js.map +0 -1
  411. package/dist/modern/lib/content-type.cjs +0 -61
  412. package/dist/modern/lib/content-type.cjs.map +0 -1
  413. package/dist/modern/lib/content-type.d.cts +0 -50
  414. package/dist/modern/lib/content-type.d.ts +0 -50
  415. package/dist/modern/lib/content-type.js.map +0 -1
  416. package/dist/modern/lib/contentstack.cjs.map +0 -1
  417. package/dist/modern/lib/contentstack.d.cts +0 -21
  418. package/dist/modern/lib/contentstack.d.ts +0 -21
  419. package/dist/modern/lib/contentstack.js.map +0 -1
  420. package/dist/modern/lib/contenttype-query.cjs +0 -70
  421. package/dist/modern/lib/contenttype-query.cjs.map +0 -1
  422. package/dist/modern/lib/contenttype-query.d.cts +0 -43
  423. package/dist/modern/lib/contenttype-query.js.map +0 -1
  424. package/dist/modern/lib/entries.cjs.map +0 -1
  425. package/dist/modern/lib/entries.d.cts +0 -191
  426. package/dist/modern/lib/entries.js.map +0 -1
  427. package/dist/modern/lib/entry-queryable.cjs +0 -33
  428. package/dist/modern/lib/entry-queryable.cjs.map +0 -1
  429. package/dist/modern/lib/entry-queryable.d.cts +0 -13
  430. package/dist/modern/lib/entry-queryable.d.ts +0 -13
  431. package/dist/modern/lib/entry-queryable.js +0 -8
  432. package/dist/modern/lib/entry-queryable.js.map +0 -1
  433. package/dist/modern/lib/entry.cjs.map +0 -1
  434. package/dist/modern/lib/entry.d.cts +0 -170
  435. package/dist/modern/lib/entry.js.map +0 -1
  436. package/dist/modern/lib/error-messages.cjs.map +0 -1
  437. package/dist/modern/lib/error-messages.d.cts +0 -31
  438. package/dist/modern/lib/error-messages.d.ts +0 -31
  439. package/dist/modern/lib/error-messages.js.map +0 -1
  440. package/dist/modern/lib/global-field-query.cjs +0 -54
  441. package/dist/modern/lib/global-field-query.cjs.map +0 -1
  442. package/dist/modern/lib/global-field-query.d.cts +0 -27
  443. package/dist/modern/lib/global-field-query.js.map +0 -1
  444. package/dist/modern/lib/global-field.cjs.map +0 -1
  445. package/dist/modern/lib/global-field.d.cts +0 -38
  446. package/dist/modern/lib/global-field.d.ts +0 -38
  447. package/dist/modern/lib/global-field.js.map +0 -1
  448. package/dist/modern/lib/image-transform.cjs +0 -528
  449. package/dist/modern/lib/image-transform.cjs.map +0 -1
  450. package/dist/modern/lib/image-transform.d.cts +0 -7
  451. package/dist/modern/lib/image-transform.d.ts +0 -7
  452. package/dist/modern/lib/image-transform.js +0 -506
  453. package/dist/modern/lib/image-transform.js.map +0 -1
  454. package/dist/modern/lib/pagination.cjs.map +0 -1
  455. package/dist/modern/lib/pagination.d.cts +0 -99
  456. package/dist/modern/lib/pagination.d.ts +0 -99
  457. package/dist/modern/lib/pagination.js.map +0 -1
  458. package/dist/modern/lib/query.cjs.map +0 -1
  459. package/dist/modern/lib/query.d.cts +0 -8
  460. package/dist/modern/lib/query.d.ts +0 -8
  461. package/dist/modern/lib/query.js.map +0 -1
  462. package/dist/modern/lib/stack.cjs.map +0 -1
  463. package/dist/modern/lib/stack.d.cts +0 -170
  464. package/dist/modern/lib/stack.d.ts +0 -170
  465. package/dist/modern/lib/stack.js.map +0 -1
  466. package/dist/modern/lib/string-extensions.cjs +0 -27
  467. package/dist/modern/lib/string-extensions.cjs.map +0 -1
  468. package/dist/modern/lib/string-extensions.d.cts +0 -404
  469. package/dist/modern/lib/string-extensions.js.map +0 -1
  470. package/dist/modern/lib/synchronization.cjs +0 -65
  471. package/dist/modern/lib/synchronization.cjs.map +0 -1
  472. package/dist/modern/lib/synchronization.d.cts +0 -10
  473. package/dist/modern/lib/synchronization.d.ts +0 -10
  474. package/dist/modern/lib/synchronization.js.map +0 -1
  475. package/dist/modern/lib/taxonomy-query.cjs +0 -38
  476. package/dist/modern/lib/taxonomy-query.cjs.map +0 -1
  477. package/dist/modern/lib/taxonomy-query.d.cts +0 -14
  478. package/dist/modern/lib/taxonomy-query.d.ts +0 -14
  479. package/dist/modern/lib/taxonomy-query.js +0 -13
  480. package/dist/modern/lib/taxonomy-query.js.map +0 -1
  481. package/dist/modern/lib/types.cjs.map +0 -1
  482. package/dist/modern/lib/types.d.cts +0 -318
  483. package/dist/modern/lib/types.d.ts +0 -318
  484. package/dist/modern/lib/types.js.map +0 -1
  485. package/dist/modern/lib/utils.cjs +0 -55
  486. package/dist/modern/lib/utils.cjs.map +0 -1
  487. package/dist/modern/lib/utils.d.cts +0 -21
  488. package/dist/modern/lib/utils.d.ts +0 -21
  489. package/dist/modern/lib/utils.js.map +0 -1
  490. package/dist/modern/persistance/config/persistance-storage-config.cjs +0 -19
  491. package/dist/modern/persistance/config/persistance-storage-config.cjs.map +0 -1
  492. package/dist/modern/persistance/config/persistance-storage-config.d.cts +0 -33
  493. package/dist/modern/persistance/config/persistance-storage-config.d.ts +0 -33
  494. package/dist/modern/persistance/config/persistance-storage-config.js +0 -1
  495. package/dist/modern/persistance/config/persistance-storage-config.js.map +0 -1
  496. package/dist/modern/persistance/helper/utils.cjs +0 -31
  497. package/dist/modern/persistance/helper/utils.cjs.map +0 -1
  498. package/dist/modern/persistance/helper/utils.d.cts +0 -4
  499. package/dist/modern/persistance/helper/utils.d.ts +0 -4
  500. package/dist/modern/persistance/helper/utils.js +0 -6
  501. package/dist/modern/persistance/helper/utils.js.map +0 -1
  502. package/dist/modern/persistance/index.cjs +0 -31
  503. package/dist/modern/persistance/index.cjs.map +0 -1
  504. package/dist/modern/persistance/index.d.cts +0 -7
  505. package/dist/modern/persistance/index.d.ts +0 -7
  506. package/dist/modern/persistance/index.js +0 -6
  507. package/dist/modern/persistance/index.js.map +0 -1
  508. package/dist/modern/persistance/persistance-store.cjs +0 -162
  509. package/dist/modern/persistance/persistance-store.cjs.map +0 -1
  510. package/dist/modern/persistance/persistance-store.d.cts +0 -51
  511. package/dist/modern/persistance/persistance-store.d.ts +0 -51
  512. package/dist/modern/persistance/persistance-store.js +0 -137
  513. package/dist/modern/persistance/persistance-store.js.map +0 -1
  514. package/dist/modern/persistance/storages/index.cjs +0 -34
  515. package/dist/modern/persistance/storages/index.cjs.map +0 -1
  516. package/dist/modern/persistance/storages/index.d.cts +0 -4
  517. package/dist/modern/persistance/storages/index.d.ts +0 -4
  518. package/dist/modern/persistance/storages/index.js +0 -8
  519. package/dist/modern/persistance/storages/index.js.map +0 -1
  520. package/dist/modern/persistance/storages/local-storage.cjs +0 -66
  521. package/dist/modern/persistance/storages/local-storage.cjs.map +0 -1
  522. package/dist/modern/persistance/storages/local-storage.d.cts +0 -6
  523. package/dist/modern/persistance/storages/local-storage.d.ts +0 -6
  524. package/dist/modern/persistance/storages/local-storage.js +0 -41
  525. package/dist/modern/persistance/storages/local-storage.js.map +0 -1
  526. package/dist/modern/persistance/storages/memory-storage.cjs +0 -60
  527. package/dist/modern/persistance/storages/memory-storage.cjs.map +0 -1
  528. package/dist/modern/persistance/storages/memory-storage.d.cts +0 -6
  529. package/dist/modern/persistance/storages/memory-storage.d.ts +0 -6
  530. package/dist/modern/persistance/storages/memory-storage.js +0 -35
  531. package/dist/modern/persistance/storages/memory-storage.js.map +0 -1
  532. package/dist/modern/persistance/types/index.cjs +0 -19
  533. package/dist/modern/persistance/types/index.cjs.map +0 -1
  534. package/dist/modern/persistance/types/index.d.cts +0 -3
  535. package/dist/modern/persistance/types/index.d.ts +0 -3
  536. package/dist/modern/persistance/types/index.js +0 -1
  537. package/dist/modern/persistance/types/index.js.map +0 -1
  538. package/dist/modern/persistance/types/storage-type.cjs +0 -19
  539. package/dist/modern/persistance/types/storage-type.cjs.map +0 -1
  540. package/dist/modern/persistance/types/storage-type.d.cts +0 -3
  541. package/dist/modern/persistance/types/storage-type.d.ts +0 -3
  542. package/dist/modern/persistance/types/storage-type.js +0 -1
  543. package/dist/modern/persistance/types/storage-type.js.map +0 -1
  544. package/dist/modern/persistance/types/storage.cjs +0 -19
  545. package/dist/modern/persistance/types/storage.cjs.map +0 -1
  546. package/dist/modern/persistance/types/storage.d.cts +0 -12
  547. package/dist/modern/persistance/types/storage.d.ts +0 -12
  548. package/dist/modern/persistance/types/storage.js +0 -1
  549. package/dist/modern/persistance/types/storage.js.map +0 -1
@@ -1,506 +0,0 @@
1
- // src/lib/image-transform.ts
2
- import "./string-extensions.js";
3
- import {
4
- CanvasBy,
5
- CropBy
6
- } from "./types.js";
7
- var ImageTransform = class {
8
- constructor() {
9
- this.obj = {};
10
- }
11
- /**
12
- * @method auto
13
- * @memberof ImageTransform
14
- * @description The auto parameter lets you enable the functionality that automates certain image optimization features.
15
- * @returns {ImageTransform}
16
- * @example
17
- * const url = 'www.example.com';
18
- * const transformObj = new ImageTransform().auto();
19
- *
20
- * const transformURL = url.transform(transformObj);
21
- */
22
- auto() {
23
- this.obj.auto = "webp";
24
- return this;
25
- }
26
- /**
27
- * @method quality
28
- * @memberof ImageTransform
29
- * @description The quality parameter lets you control the compression level of images that have Lossy file format.
30
- * @param {number} qualityNum - Quality range: 1-100.
31
- * @returns {ImageTransform}
32
- * @example
33
- * const url = 'www.example.com';
34
- * const transformObj = new ImageTransform().quality(50);
35
- *
36
- * const transformURL = url.transform(transformObj);
37
- */
38
- quality(qualityNum) {
39
- this.obj.quality = qualityNum.toString();
40
- return this;
41
- }
42
- /**
43
- * @method format
44
- * @memberof ImageTransform
45
- * @description The format parameter lets you convert a given image from one format to another.
46
- * @param {Format} format - Specifies the format to change to.
47
- * @returns {ImageTransform}
48
- * @example
49
- * const url = 'www.example.com';
50
- * const transformObj = new ImageTransform().format(Format.PJPG);
51
- *
52
- * const transformURL = url.transform(transformObj);
53
- */
54
- format(format) {
55
- this.obj.format = format;
56
- return this;
57
- }
58
- /**
59
- * @method resize
60
- * @memberof ImageTransform
61
- * @description The resize parameter lets you resize the image in terms of width, height, upscaling the image.
62
- * @param {object} options - Resize options object
63
- * @param {string | number} [options.width] - Specifies the width to resize the image to.
64
- * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')
65
- * @param {string | number} [options.height] - Specifies the height to resize the image to.
66
- * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')
67
- * @param {string} [options.disable] - The disable parameter disables the functionality that is enabled by default.
68
- * As of now, there is only one value, i.e., upscale, that you can use with the disable parameter.
69
- * @returns {ImageTransform}
70
- * @example
71
- * const url = 'www.example.com';
72
- * const transformObj = new ImageTransform().resize({ width: 200, height: 200, disable: 'upscale' });
73
- *
74
- * const transformURL = url.transform(transformObj);
75
- */
76
- resize({
77
- width,
78
- height,
79
- disable
80
- }) {
81
- if (width) this.obj.width = width.toString();
82
- if (height) this.obj.height = height.toString();
83
- if (disable) this.obj.disable = "upscale";
84
- return this;
85
- }
86
- /**
87
- * @method crop
88
- * @memberof ImageTransform
89
- * @description The crop parameter allows you to remove pixels from an image. You can crop an image by specifying
90
- * the height and width in pixels or percentage value, or defining height and width in aspect ratio.
91
- * You can also define a sub region (i.e., define the starting point for crop) before cropping the image,
92
- * or you can offset the image on its X and Y axis (i.e., define the centre point of the crop) before cropping the image.
93
- * @param {object} options - Crop options object
94
- * @param {string | number} options.width - Specifies the width to resize the image to.
95
- * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')
96
- * @param {string | number} options.height - Specifies the height to resize the image to.
97
- * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')
98
- * @param {string | number} [options.xval] - (Optional) For CropBy Region, xval defines the X-axis position
99
- * of the top left corner of the crop. For CropBy Offset, xval defines the horizontal offset of the crop region.
100
- * @param {string | number} [options.yval] - (Optional) For CropBy Region, yval defines the Y-axis position
101
- * of the top left corner of the crop. For CropBy Offset, yval defines the vertical offset of the crop region.
102
- * @param {CropBy} [options.cropBy] - (Optional) Specifies the CropBy type. Values are DEFAULT, ASPECTRATIO, REGION, OFFSET.
103
- * @param {boolean} [options.safe] - (Optional) Ensures that the output image never returns an error due to the specified crop area being
104
- * out of bounds. The output image is returned as an intersection of the source image and the defined crop area.
105
- * @param {boolean} [options.smart] - (Optional) Ensures crop is done using content-aware algorithms. Content-aware image cropping returns a
106
- * cropped image that automatically fits the defined dimensions while intelligently including the most important components of the image.
107
- * @returns {ImageTransform}
108
- * @example
109
- * const url = 'www.example.com';
110
- * const transformObj = new ImageTransform().crop({ width: 100, height: 200 })
111
- *
112
- * const transformURL = url.transform(transformObj);
113
- * @example
114
- * const url = 'www.example.com';
115
- * const transformObj = new ImageTransform().crop({ width: 2, height: 3, cropBy: CropBy.ASPECTRATIO })
116
- *
117
- * const transformURL = url.transform(transformObj);
118
- * @example
119
- * const url = 'www.example.com';
120
- * const transformObj = new ImageTransform().crop({ width: 200, height: 300, cropBy: CropBy.REGION, xval: 100, yval: 150 })
121
- *
122
- * const transformURL = url.transform(transformObj);
123
- * @example
124
- * const url = 'www.example.com';
125
- * const transformObj = new ImageTransform().crop({ width: 200, height: 300, cropBy: CropBy.OFFSET, xval: 100, yval: 150 })
126
- *
127
- * const transformURL = url.transform(transformObj);
128
- */
129
- crop({
130
- width,
131
- height,
132
- xval,
133
- yval,
134
- cropBy = CropBy.DEFAULT,
135
- safe = false,
136
- smart = false
137
- }) {
138
- switch (cropBy) {
139
- case CropBy.DEFAULT: {
140
- this.obj.crop = [width.toString(), height.toString()];
141
- break;
142
- }
143
- case CropBy.ASPECTRATIO: {
144
- this.obj.crop = `${width}:${height}`;
145
- break;
146
- }
147
- case CropBy.REGION: {
148
- this.obj.crop = [width.toString(), height.toString(), `x${xval}`, `y${yval}`];
149
- break;
150
- }
151
- case CropBy.OFFSET: {
152
- this.obj.crop = [width.toString(), height.toString(), `offset-x${xval}`, `offset-y${yval}`];
153
- }
154
- }
155
- if (Array.isArray(this.obj.crop)) {
156
- if (safe) this.obj.crop = [...this.obj.crop, "safe"];
157
- if (smart) this.obj.crop = [...this.obj.crop, "smart"];
158
- }
159
- return this;
160
- }
161
- /**
162
- * @method fit
163
- * @memberof ImageTransform
164
- * @description The fit parameter enables you to fit the given image properly within the specified height and width.
165
- * @param {FitBy} type - Specifies fit type (BOUNDS or CROP).
166
- * @returns {ImageTransform}
167
- * @example
168
- * const url = 'www.example.com';
169
- * const transformObj = new ImageTransform().resize({ width: 200, height: 200 }).fit(FitBy.BOUNDS);
170
- *
171
- * const transformURL = url.transform(transformObj);
172
- */
173
- fit(type) {
174
- this.obj.fit = type;
175
- return this;
176
- }
177
- /**
178
- * @method trim
179
- * @memberof ImageTransform
180
- * @description The trim parameter lets you trim an image from the edges. This is especially useful for removing border or white spaces.
181
- * @param {number | number[]} trimValues - specifies values for top, right, bottom, and left edges of an image.
182
- * @returns {ImageTransform}
183
- * @example
184
- * const url = 'www.example.com';
185
- * const transformObj = new ImageTransform().trim([25, 50, 75, 90]);
186
- *
187
- * const transformURL = url.transform(transformObj);
188
- * @example
189
- * const url = 'www.example.com';
190
- * const transformObj = new ImageTransform().trim([25, 50, 25]);
191
- *
192
- * const transformURL = url.transform(transformObj);
193
- * @example
194
- * const url = 'www.example.com';
195
- * const transformObj = new ImageTransform().trim(50);
196
- *
197
- * const transformURL = url.transform(transformObj);
198
- */
199
- trim(trimValues) {
200
- this.obj.trim = trimValues.toString();
201
- return this;
202
- }
203
- /**
204
- * @method orient
205
- * @memberof ImageTransform
206
- * @description The orient parameter lets you control the cardinal orientation of the given image. Using this parameter,
207
- * you can orient the image right or left, flip horizontally or vertically or both
208
- * @param {Orientation} orientType - Type of Orientation. Values are DEFAULT, FLIP_HORIZONTAL, FLIP_HORIZONTAL_VERTICAL,
209
- * FLIP_VERTICAL, FLIP_HORIZONTAL_LEFT, RIGHT, FLIP_HORIZONTAL_RIGHT, LEFT.
210
- * @returns {ImageTransform}
211
- * @example
212
- * const url = 'www.example.com';
213
- * const transformObj = new ImageTransform().orient(Orientation.FLIP_HORIZONTAL);
214
- *
215
- * const transformURL = url.transform(transformObj);
216
- */
217
- orient(orientType) {
218
- this.obj.orient = orientType.toString();
219
- return this;
220
- }
221
- /**
222
- * @method overlay
223
- * @memberof ImageTransform
224
- * @description The overlay parameter allows you to put one image on top of another.
225
- * You need to specify the relative URL of the image as value for this parameter.
226
- * @param {object} options - Overlay options object
227
- * @param {string} options.relativeURL - URL of the image to overlay on base image
228
- * @param {OverlayAlign | OverlayAlign[]} [options.align] - lets you define the position of the overlay image.
229
- * Accepted values are TOP, BOTTOM, LEFT, RIGHT, MIDDLE, CENTER.
230
- * @param {OverlayRepeat} [options.repeat] - lets you define how the overlay image will be repeated on the given image.
231
- * Accepted values are X, Y, BOTH.
232
- * @param {string | number} [options.width] - lets you define the width of the overlay image.
233
- * For pixels, use any whole number between 1 and 8192. For percentages, use any decimal number between 0.0 and 0.99.
234
- * @param {string | number} [options.height] - lets you define the height of the overlay image.
235
- * For pixels, use any whole number between 1 and 8192. For percentages, use any decimal number between 0.0 and 0.99
236
- * @param {number | number[]} [options.pad] - lets you add extra pixels to the edges of an image.
237
- * This is useful if you want to add whitespace or border to an image.
238
- * @returns {ImageTransform}
239
- * @example
240
- * const url = 'www.example.com';
241
- * const transformObj = new ImageTransform().overlay({ relativeURL: overlayImgURL });
242
- *
243
- * const transformURL = url.transform(transformObj);
244
- * @example
245
- * const url = 'www.example.com';
246
- * const transformObj = new ImageTransform().overlay({ relativeURL: overlayImgURL, align: OverlayAlign.BOTTOM });
247
- *
248
- * const transformURL = url.transform(transformObj);
249
- * @example
250
- * const url = 'www.example.com';
251
- * const transformObj = new ImageTransform().overlay({
252
- * relativeURL: overlayImgURL,
253
- * align: OverlayAlign.BOTTOM,
254
- * repeat: OverlayRepeat.Y,
255
- * width: '50p',
256
- * });
257
- *
258
- * const transformURL = url.transform(transformObj);
259
- */
260
- overlay({
261
- relativeURL,
262
- align,
263
- repeat,
264
- width,
265
- height
266
- }) {
267
- this.obj.overlay = relativeURL;
268
- if (align) this.obj["overlay-align"] = align.toString();
269
- if (repeat) this.obj["overlay-repeat"] = repeat.toString();
270
- if (width) this.obj["overlay-width"] = width.toString();
271
- if (height) this.obj["overlay-height"] = height.toString();
272
- return this;
273
- }
274
- /**
275
- * @method padding
276
- * @memberof ImageTransform
277
- * @description The padding parameter lets you add extra pixels to the edges of an image.
278
- * This is useful if you want to add whitespace or border to an image.
279
- * @param {number | number[]} padding - padding value in pixels or percentages
280
- * @returns {ImageTransform}
281
- * @example
282
- * const url = 'www.example.com';
283
- * const transformObj = new ImageTransform().padding([25, 50, 75, 90]);
284
- *
285
- * const transformURL = url.transform(transformObj);
286
- * @example
287
- * const url = 'www.example.com';
288
- * const transformObj = new ImageTransform().padding(50);
289
- *
290
- * const transformURL = url.transform(transformObj);
291
- */
292
- padding(padding) {
293
- this.obj.pad = padding.toString();
294
- return this;
295
- }
296
- /**
297
- * @method bgColor
298
- * @memberof ImageTransform
299
- * @description The bgColor parameter lets you set a background color for the given image.
300
- * @param {string | number[]} color - color of the background
301
- * @returns {ImageTransform}
302
- * @example
303
- * const url = 'www.example.com';
304
- * const transformObj = new ImageTransform().bgColor('cccccc');
305
- *
306
- * const transformURL = url.transform(transformObj);
307
- * @example
308
- * const url = 'www.example.com';
309
- * const transformObj = new ImageTransform().bgColor([140, 220, 123, 0.5] );
310
- *
311
- * const transformURL = url.transform(transformObj);
312
- */
313
- bgColor(color) {
314
- this.obj["bg-color"] = color.toString();
315
- return this;
316
- }
317
- /**
318
- * @method dpr
319
- * @memberof ImageTransform
320
- * @description The dpr parameter lets you deliver images with appropriate size to devices that come with a defined device pixel ratio.
321
- * @param {number} dprValue - value of device pixel ratio 1-10000 or 0.0 to 9999.999
322
- * @returns {ImageTransform}
323
- * @example
324
- * const url = 'www.example.com';
325
- * const transformObj = new ImageTransform().resize({ width: 300, height: 500 }).dpr(10);
326
- *
327
- * const transformURL = url.transform(transformObj);
328
- */
329
- dpr(dprValue) {
330
- this.obj.dpr = dprValue.toString();
331
- return this;
332
- }
333
- /**
334
- * @method blur
335
- * @memberof ImageTransform
336
- * @description The blur parameter allows you to decrease the focus and clarity of a given image.
337
- * @param {number} blurValue - to set the blur intensity between 1-1000.
338
- * @returns {ImageTransform}
339
- * @example
340
- * const url = 'www.example.com';
341
- * const transformObj = new ImageTransform().blur(10);
342
- *
343
- * const transformURL = url.transform(transformObj);
344
- */
345
- blur(blurValue) {
346
- this.obj.blur = blurValue.toString();
347
- return this;
348
- }
349
- /**
350
- * @method frame
351
- * @memberof ImageTransform
352
- * @description The frame parameter fetches the first frame from an animated GIF (Graphics Interchange Format)
353
- * file that comprises a sequence of moving images.
354
- * @returns {ImageTransform}
355
- * @example
356
- * const url = 'www.example.com';
357
- * const transformObj = new ImageTransform().frame();
358
- *
359
- * const transformURL = url.transform(transformObj);
360
- */
361
- frame() {
362
- this.obj.frame = "1";
363
- return this;
364
- }
365
- /**
366
- * @method sharpen
367
- * @memberof ImageTransform
368
- * @description The sharpen parameter allows you to increase the definition of the edges of objects in an image.
369
- * @param {number} amount - [0-10] specifies the amount of contrast to be set for the image edges
370
- * @param {number} radius - [1-1000] specifies the radius of the image edges
371
- * @param {number} threshold - [0-255] specifies the range of image edges that need to be ignored while sharpening
372
- * @returns {ImageTransform}
373
- * @example
374
- * const url = 'www.example.com';
375
- * const transformObj = new ImageTransform().sharpen(5, 1000, 2);
376
- *
377
- * const transformURL = url.transform(transformObj);
378
- */
379
- sharpen(amount, radius, threshold) {
380
- this.obj.sharpen = [`a${amount}`, `r${radius}`, `t${threshold}`].toString();
381
- return this;
382
- }
383
- /**
384
- * @method saturation
385
- * @memberof ImageTransform
386
- * @description The saturation parameter allows you to increase or decrease the intensity of the colors in a given image.
387
- * @param {number} saturationValue - to set the saturation of image between -100 to 100
388
- * @returns {ImageTransform}
389
- * @example
390
- * const url = 'www.example.com';
391
- * const transformObj = new ImageTransform().saturation(-80.99);
392
- *
393
- * const transformURL = url.transform(transformObj);
394
- */
395
- saturation(saturationValue) {
396
- this.obj.saturation = saturationValue.toString();
397
- return this;
398
- }
399
- /**
400
- * @method contrast
401
- * @memberof ImageTransform
402
- * @description The contrast parameter lets you adjust the contrast level of the image.
403
- * @param {number} contrastValue - to set the contrast of image between -100 to 100
404
- * @returns {ImageTransform}
405
- * @example
406
- * const url = 'www.example.com';
407
- * const transformObj = new ImageTransform().contrast(-80.99);
408
- *
409
- * const transformURL = url.transform(transformObj);
410
- */
411
- contrast(contrastValue) {
412
- this.obj.contrast = contrastValue.toString();
413
- return this;
414
- }
415
- /**
416
- * @method brightness
417
- * @memberof ImageTransform
418
- * @description The brightness parameter lets you adjust the brightness level of the image.
419
- * @param {number} brightnessValue - to set the brightness of image between -100 to 100
420
- * @returns {ImageTransform}
421
- * @example
422
- * const url = 'www.example.com';
423
- * const transformObj = new ImageTransform().brightness(80.50);
424
- *
425
- * const transformURL = url.transform(transformObj);
426
- */
427
- brightness(brightnessValue) {
428
- this.obj.brightness = brightnessValue.toString();
429
- return this;
430
- }
431
- /**
432
- * @method resizeFilter
433
- * @memberof ImageTransform
434
- * @description The resizeFilter parameter allows you to use the resizing filter to increase or
435
- * decrease the number of pixels in a given image.
436
- * @param {ResizeFilter} type - type of Filter to apply
437
- * Values are NEAREST, BILINEAR, BICUBIC, LANCZOS2, LANCZOS3.
438
- * @returns {ImageTransform}
439
- * @example
440
- * const url = 'www.example.com';
441
- * const transformObj = new ImageTransform().resize({ width: 500, height: 550 }).resizeFilter(ResizeFilter.NEAREST);
442
- *
443
- * const transformURL = url.transform(transformObj);
444
- */
445
- resizeFilter(type) {
446
- this.obj["resize-filter"] = type;
447
- return this;
448
- }
449
- /**
450
- * @method canvas
451
- * @memberof ImageTransform
452
- * @description The canvas parameter allows you to increase the size of the canvas that surrounds an image.
453
- * You can specify the height and width of the canvas area in pixels or percentage or define the height and width
454
- * of the aspect ratio of the canvas. You can also define the starting point for the canvas area or offset the canvas on its X and Y axis.
455
- * @param {string | number} width - sets width of the canvas
456
- * @param {string | number} height - sets height of the canvas
457
- * @param {string | number} xval - defines the X-axis position of the top left corner or horizontal offset
458
- * @param {string | number} yval - defines the Y-axis position of the top left corner or vertical offset
459
- * @param {CanvasBy} canvasBy - Specifies the canvasBy type. Accepted values are DEFAULT, ASPECTRATIO, REGION, OFFSET.
460
- * @returns {ImageTransform}
461
- * @example
462
- * const url = 'www.example.com';
463
- * const transformObj = new ImageTransform().canvas({ width: 100, height: 200 });
464
- *
465
- * const transformURL = url.transform(transformObj);
466
- * @example
467
- * const url = 'www.example.com';
468
- * const transformObj = new ImageTransform().canvas({ width: 200, height: 300, canvasBy: CanvasBy.OFFSET, xval: 100, yval: 150 });
469
- *
470
- * const transformURL = url.transform(transformObj);
471
- */
472
- canvas({
473
- width,
474
- height,
475
- xval,
476
- yval,
477
- canvasBy = CanvasBy.DEFAULT
478
- }) {
479
- switch (canvasBy) {
480
- case CanvasBy.DEFAULT: {
481
- this.obj.canvas = [width.toString(), height.toString()];
482
- break;
483
- }
484
- case CanvasBy.ASPECTRATIO: {
485
- this.obj.canvas = `${width}:${height}`;
486
- break;
487
- }
488
- case CanvasBy.REGION: {
489
- this.obj.canvas = [width.toString(), height.toString()];
490
- if (xval) this.obj.canvas.push(`x${xval}`);
491
- if (yval) this.obj.canvas.push(`y${yval}`);
492
- break;
493
- }
494
- case CanvasBy.OFFSET: {
495
- this.obj.canvas = [width.toString(), height.toString()];
496
- if (xval) this.obj.canvas.push(`offset-x${xval}`);
497
- if (yval) this.obj.canvas.push(`offset-y${yval}`);
498
- }
499
- }
500
- return this;
501
- }
502
- };
503
- export {
504
- ImageTransform
505
- };
506
- //# sourceMappingURL=image-transform.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../src/lib/image-transform.ts"],"sourcesContent":["/* eslint-disable @cspell/spellchecker */\nimport './string-extensions';\nimport {\n CanvasBy,\n CropBy,\n FitBy,\n Format,\n Orientation,\n OverlayAlign,\n OverlayRepeat,\n ResizeFilter,\n TransformData,\n} from './types';\n\nexport class ImageTransform {\n obj: TransformData = {};\n\n /**\n * @method auto\n * @memberof ImageTransform\n * @description The auto parameter lets you enable the functionality that automates certain image optimization features.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().auto();\n *\n * const transformURL = url.transform(transformObj);\n */\n auto(): ImageTransform {\n this.obj.auto = 'webp';\n\n return this;\n }\n\n /**\n * @method quality\n * @memberof ImageTransform\n * @description The quality parameter lets you control the compression level of images that have Lossy file format.\n * @param {number} qualityNum - Quality range: 1-100.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().quality(50);\n *\n * const transformURL = url.transform(transformObj);\n */\n quality(qualityNum: number): ImageTransform {\n this.obj.quality = qualityNum.toString();\n\n return this;\n }\n\n /**\n * @method format\n * @memberof ImageTransform\n * @description The format parameter lets you convert a given image from one format to another.\n * @param {Format} format - Specifies the format to change to.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().format(Format.PJPG);\n *\n * const transformURL = url.transform(transformObj);\n */\n format(format: Format): ImageTransform {\n this.obj.format = format;\n\n return this;\n }\n\n /**\n * @method resize\n * @memberof ImageTransform\n * @description The resize parameter lets you resize the image in terms of width, height, upscaling the image.\n * @param {object} options - Resize options object\n * @param {string | number} [options.width] - Specifies the width to resize the image to.\n * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')\n * @param {string | number} [options.height] - Specifies the height to resize the image to.\n * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')\n * @param {string} [options.disable] - The disable parameter disables the functionality that is enabled by default.\n * As of now, there is only one value, i.e., upscale, that you can use with the disable parameter.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().resize({ width: 200, height: 200, disable: 'upscale' });\n *\n * const transformURL = url.transform(transformObj);\n */\n resize({\n width,\n height,\n disable,\n }: {\n width?: string | number;\n height?: string | number;\n disable?: string;\n }): ImageTransform {\n if (width) this.obj.width = width.toString();\n if (height) this.obj.height = height.toString();\n if (disable) this.obj.disable = 'upscale';\n\n return this;\n }\n\n /**\n * @method crop\n * @memberof ImageTransform\n * @description The crop parameter allows you to remove pixels from an image. You can crop an image by specifying\n * the height and width in pixels or percentage value, or defining height and width in aspect ratio.\n * You can also define a sub region (i.e., define the starting point for crop) before cropping the image,\n * or you can offset the image on its X and Y axis (i.e., define the centre point of the crop) before cropping the image.\n * @param {object} options - Crop options object\n * @param {string | number} options.width - Specifies the width to resize the image to.\n * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')\n * @param {string | number} options.height - Specifies the height to resize the image to.\n * The value can be in pixels (for example, 400) or in percentage (for example, 0.60 OR '60p')\n * @param {string | number} [options.xval] - (Optional) For CropBy Region, xval defines the X-axis position\n * of the top left corner of the crop. For CropBy Offset, xval defines the horizontal offset of the crop region.\n * @param {string | number} [options.yval] - (Optional) For CropBy Region, yval defines the Y-axis position\n * of the top left corner of the crop. For CropBy Offset, yval defines the vertical offset of the crop region.\n * @param {CropBy} [options.cropBy] - (Optional) Specifies the CropBy type. Values are DEFAULT, ASPECTRATIO, REGION, OFFSET.\n * @param {boolean} [options.safe] - (Optional) Ensures that the output image never returns an error due to the specified crop area being\n * out of bounds. The output image is returned as an intersection of the source image and the defined crop area.\n * @param {boolean} [options.smart] - (Optional) Ensures crop is done using content-aware algorithms. Content-aware image cropping returns a\n * cropped image that automatically fits the defined dimensions while intelligently including the most important components of the image.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().crop({ width: 100, height: 200 })\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().crop({ width: 2, height: 3, cropBy: CropBy.ASPECTRATIO })\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().crop({ width: 200, height: 300, cropBy: CropBy.REGION, xval: 100, yval: 150 })\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().crop({ width: 200, height: 300, cropBy: CropBy.OFFSET, xval: 100, yval: 150 })\n *\n * const transformURL = url.transform(transformObj);\n */\n crop({\n width,\n height,\n xval,\n yval,\n cropBy = CropBy.DEFAULT,\n safe = false,\n smart = false,\n }: {\n width: string | number;\n height: string | number;\n xval?: string | number;\n yval?: string | number;\n cropBy?: CropBy;\n safe?: boolean;\n smart?: boolean;\n }): ImageTransform {\n switch (cropBy) {\n case CropBy.DEFAULT: {\n this.obj.crop = [width.toString(), height.toString()];\n break;\n }\n case CropBy.ASPECTRATIO: {\n this.obj.crop = `${width}:${height}`;\n break;\n }\n case CropBy.REGION: {\n this.obj.crop = [width.toString(), height.toString(), `x${xval}`, `y${yval}`];\n break;\n }\n case CropBy.OFFSET: {\n this.obj.crop = [width.toString(), height.toString(), `offset-x${xval}`, `offset-y${yval}`];\n }\n }\n // Only add safe/smart when crop is an array (not for ASPECTRATIO which is a string)\n if (Array.isArray(this.obj.crop)) {\n if (safe) this.obj.crop = [...this.obj.crop, 'safe'];\n if (smart) this.obj.crop = [...this.obj.crop, 'smart'];\n }\n\n return this;\n }\n\n /**\n * @method fit\n * @memberof ImageTransform\n * @description The fit parameter enables you to fit the given image properly within the specified height and width.\n * @param {FitBy} type - Specifies fit type (BOUNDS or CROP).\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().resize({ width: 200, height: 200 }).fit(FitBy.BOUNDS);\n *\n * const transformURL = url.transform(transformObj);\n */\n fit(type: FitBy): ImageTransform {\n this.obj.fit = type;\n\n return this;\n }\n\n /**\n * @method trim\n * @memberof ImageTransform\n * @description The trim parameter lets you trim an image from the edges. This is especially useful for removing border or white spaces.\n * @param {number | number[]} trimValues - specifies values for top, right, bottom, and left edges of an image.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().trim([25, 50, 75, 90]);\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().trim([25, 50, 25]);\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().trim(50);\n *\n * const transformURL = url.transform(transformObj);\n */\n trim(trimValues: number | number[]): ImageTransform {\n this.obj.trim = trimValues.toString();\n\n return this;\n }\n\n /**\n * @method orient\n * @memberof ImageTransform\n * @description The orient parameter lets you control the cardinal orientation of the given image. Using this parameter,\n * you can orient the image right or left, flip horizontally or vertically or both\n * @param {Orientation} orientType - Type of Orientation. Values are DEFAULT, FLIP_HORIZONTAL, FLIP_HORIZONTAL_VERTICAL,\n * FLIP_VERTICAL, FLIP_HORIZONTAL_LEFT, RIGHT, FLIP_HORIZONTAL_RIGHT, LEFT.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().orient(Orientation.FLIP_HORIZONTAL);\n *\n * const transformURL = url.transform(transformObj);\n */\n orient(orientType: Orientation): ImageTransform {\n this.obj.orient = orientType.toString();\n\n return this;\n }\n\n /**\n * @method overlay\n * @memberof ImageTransform\n * @description The overlay parameter allows you to put one image on top of another.\n * You need to specify the relative URL of the image as value for this parameter.\n * @param {object} options - Overlay options object\n * @param {string} options.relativeURL - URL of the image to overlay on base image\n * @param {OverlayAlign | OverlayAlign[]} [options.align] - lets you define the position of the overlay image.\n * Accepted values are TOP, BOTTOM, LEFT, RIGHT, MIDDLE, CENTER.\n * @param {OverlayRepeat} [options.repeat] - lets you define how the overlay image will be repeated on the given image.\n * Accepted values are X, Y, BOTH.\n * @param {string | number} [options.width] - lets you define the width of the overlay image.\n * For pixels, use any whole number between 1 and 8192. For percentages, use any decimal number between 0.0 and 0.99.\n * @param {string | number} [options.height] - lets you define the height of the overlay image.\n * For pixels, use any whole number between 1 and 8192. For percentages, use any decimal number between 0.0 and 0.99\n * @param {number | number[]} [options.pad] - lets you add extra pixels to the edges of an image. \n * This is useful if you want to add whitespace or border to an image.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().overlay({ relativeURL: overlayImgURL });\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().overlay({ relativeURL: overlayImgURL, align: OverlayAlign.BOTTOM });\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().overlay({\n * relativeURL: overlayImgURL,\n * align: OverlayAlign.BOTTOM,\n * repeat: OverlayRepeat.Y,\n * width: '50p',\n * });\n *\n * const transformURL = url.transform(transformObj);\n */\n overlay({\n relativeURL,\n align,\n repeat,\n width,\n height,\n }: {\n relativeURL: string;\n align?: OverlayAlign | OverlayAlign[];\n repeat?: OverlayRepeat;\n width?: string | number;\n height?: string | number;\n pad?: number | number[];\n }): ImageTransform {\n this.obj.overlay = relativeURL;\n if (align) this.obj['overlay-align'] = align.toString();\n if (repeat) this.obj['overlay-repeat'] = repeat.toString();\n if (width) this.obj['overlay-width'] = width.toString();\n if (height) this.obj['overlay-height'] = height.toString();\n\n return this;\n }\n\n /**\n * @method padding\n * @memberof ImageTransform\n * @description The padding parameter lets you add extra pixels to the edges of an image. \n * This is useful if you want to add whitespace or border to an image.\n * @param {number | number[]} padding - padding value in pixels or percentages\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().padding([25, 50, 75, 90]);\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().padding(50);\n *\n * const transformURL = url.transform(transformObj);\n */\n padding(padding: number | number[]): ImageTransform {\n this.obj.pad = padding.toString();\n\n return this;\n }\n\n /**\n * @method bgColor\n * @memberof ImageTransform\n * @description The bgColor parameter lets you set a background color for the given image.\n * @param {string | number[]} color - color of the background\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().bgColor('cccccc');\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().bgColor([140, 220, 123, 0.5] );\n *\n * const transformURL = url.transform(transformObj);\n */\n bgColor(color: string | number[]): ImageTransform {\n this.obj['bg-color'] = color.toString();\n\n return this;\n }\n\n /**\n * @method dpr\n * @memberof ImageTransform\n * @description The dpr parameter lets you deliver images with appropriate size to devices that come with a defined device pixel ratio.\n * @param {number} dprValue - value of device pixel ratio 1-10000 or 0.0 to 9999.999\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().resize({ width: 300, height: 500 }).dpr(10);\n *\n * const transformURL = url.transform(transformObj);\n */\n dpr(dprValue: number): ImageTransform {\n this.obj.dpr = dprValue.toString();\n\n return this;\n }\n\n /**\n * @method blur\n * @memberof ImageTransform\n * @description The blur parameter allows you to decrease the focus and clarity of a given image.\n * @param {number} blurValue - to set the blur intensity between 1-1000.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().blur(10);\n *\n * const transformURL = url.transform(transformObj);\n */\n blur(blurValue: number): ImageTransform {\n this.obj.blur = blurValue.toString();\n\n return this;\n }\n\n /**\n * @method frame\n * @memberof ImageTransform\n * @description The frame parameter fetches the first frame from an animated GIF (Graphics Interchange Format)\n * file that comprises a sequence of moving images.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().frame();\n *\n * const transformURL = url.transform(transformObj);\n */\n frame(): ImageTransform {\n this.obj.frame = '1';\n\n return this;\n }\n\n /**\n * @method sharpen\n * @memberof ImageTransform\n * @description The sharpen parameter allows you to increase the definition of the edges of objects in an image.\n * @param {number} amount - [0-10] specifies the amount of contrast to be set for the image edges\n * @param {number} radius - [1-1000] specifies the radius of the image edges\n * @param {number} threshold - [0-255] specifies the range of image edges that need to be ignored while sharpening\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().sharpen(5, 1000, 2);\n *\n * const transformURL = url.transform(transformObj);\n */\n sharpen(amount: number, radius: number, threshold: number): ImageTransform {\n this.obj.sharpen = [`a${amount}`, `r${radius}`, `t${threshold}`].toString();\n\n return this;\n }\n\n /**\n * @method saturation\n * @memberof ImageTransform\n * @description The saturation parameter allows you to increase or decrease the intensity of the colors in a given image.\n * @param {number} saturationValue - to set the saturation of image between -100 to 100\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().saturation(-80.99);\n *\n * const transformURL = url.transform(transformObj);\n */\n saturation(saturationValue: number): ImageTransform {\n this.obj.saturation = saturationValue.toString();\n\n return this;\n }\n\n /**\n * @method contrast\n * @memberof ImageTransform\n * @description The contrast parameter lets you adjust the contrast level of the image.\n * @param {number} contrastValue - to set the contrast of image between -100 to 100\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().contrast(-80.99);\n *\n * const transformURL = url.transform(transformObj);\n */\n contrast(contrastValue: number): ImageTransform {\n this.obj.contrast = contrastValue.toString();\n\n return this;\n }\n\n /**\n * @method brightness\n * @memberof ImageTransform\n * @description The brightness parameter lets you adjust the brightness level of the image.\n * @param {number} brightnessValue - to set the brightness of image between -100 to 100\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().brightness(80.50);\n *\n * const transformURL = url.transform(transformObj);\n */\n brightness(brightnessValue: number): ImageTransform {\n this.obj.brightness = brightnessValue.toString();\n\n return this;\n }\n\n /**\n * @method resizeFilter\n * @memberof ImageTransform\n * @description The resizeFilter parameter allows you to use the resizing filter to increase or\n * decrease the number of pixels in a given image.\n * @param {ResizeFilter} type - type of Filter to apply\n * Values are NEAREST, BILINEAR, BICUBIC, LANCZOS2, LANCZOS3.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().resize({ width: 500, height: 550 }).resizeFilter(ResizeFilter.NEAREST);\n *\n * const transformURL = url.transform(transformObj);\n */\n resizeFilter(type: ResizeFilter): ImageTransform {\n this.obj['resize-filter'] = type;\n\n return this;\n }\n\n /**\n * @method canvas\n * @memberof ImageTransform\n * @description The canvas parameter allows you to increase the size of the canvas that surrounds an image.\n * You can specify the height and width of the canvas area in pixels or percentage or define the height and width\n * of the aspect ratio of the canvas. You can also define the starting point for the canvas area or offset the canvas on its X and Y axis.\n * @param {string | number} width - sets width of the canvas\n * @param {string | number} height - sets height of the canvas\n * @param {string | number} xval - defines the X-axis position of the top left corner or horizontal offset\n * @param {string | number} yval - defines the Y-axis position of the top left corner or vertical offset\n * @param {CanvasBy} canvasBy - Specifies the canvasBy type. Accepted values are DEFAULT, ASPECTRATIO, REGION, OFFSET.\n * @returns {ImageTransform}\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().canvas({ width: 100, height: 200 });\n *\n * const transformURL = url.transform(transformObj);\n * @example\n * const url = 'www.example.com';\n * const transformObj = new ImageTransform().canvas({ width: 200, height: 300, canvasBy: CanvasBy.OFFSET, xval: 100, yval: 150 });\n *\n * const transformURL = url.transform(transformObj);\n */\n canvas({\n width,\n height,\n xval,\n yval,\n canvasBy = CanvasBy.DEFAULT,\n }: {\n width: string | number;\n height: string | number;\n xval?: string | number;\n yval?: string | number;\n canvasBy?: CanvasBy;\n }): ImageTransform {\n switch (canvasBy) {\n case CanvasBy.DEFAULT: {\n this.obj.canvas = [width.toString(), height.toString()];\n break;\n }\n case CanvasBy.ASPECTRATIO: {\n this.obj.canvas = `${width}:${height}`;\n break;\n }\n case CanvasBy.REGION: {\n this.obj.canvas = [width.toString(), height.toString()];\n if (xval) this.obj.canvas.push(`x${xval}`);\n if (yval) this.obj.canvas.push(`y${yval}`);\n break;\n }\n case CanvasBy.OFFSET: {\n this.obj.canvas = [width.toString(), height.toString()];\n if (xval) this.obj.canvas.push(`offset-x${xval}`);\n if (yval) this.obj.canvas.push(`offset-y${yval}`);\n }\n }\n\n return this;\n }\n}\n"],"mappings":";AACA,OAAO;AACP;AAAA,EACE;AAAA,EACA;AAAA,OAQK;AAEA,IAAM,iBAAN,MAAqB;AAAA,EAArB;AACL,eAAqB,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAatB,OAAuB;AACrB,SAAK,IAAI,OAAO;AAEhB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,QAAQ,YAAoC;AAC1C,SAAK,IAAI,UAAU,WAAW,SAAS;AAEvC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,OAAO,QAAgC;AACrC,SAAK,IAAI,SAAS;AAElB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA,OAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAImB;AACjB,QAAI,MAAO,MAAK,IAAI,QAAQ,MAAM,SAAS;AAC3C,QAAI,OAAQ,MAAK,IAAI,SAAS,OAAO,SAAS;AAC9C,QAAI,QAAS,MAAK,IAAI,UAAU;AAEhC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6CA,KAAK;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,SAAS,OAAO;AAAA,IAChB,OAAO;AAAA,IACP,QAAQ;AAAA,EACV,GAQmB;AACjB,YAAQ,QAAQ;AAAA,MACd,KAAK,OAAO,SAAS;AACnB,aAAK,IAAI,OAAO,CAAC,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACpD;AAAA,MACF;AAAA,MACA,KAAK,OAAO,aAAa;AACvB,aAAK,IAAI,OAAO,GAAG,KAAK,IAAI,MAAM;AAClC;AAAA,MACF;AAAA,MACA,KAAK,OAAO,QAAQ;AAClB,aAAK,IAAI,OAAO,CAAC,MAAM,SAAS,GAAG,OAAO,SAAS,GAAG,IAAI,IAAI,IAAI,IAAI,IAAI,EAAE;AAC5E;AAAA,MACF;AAAA,MACA,KAAK,OAAO,QAAQ;AAClB,aAAK,IAAI,OAAO,CAAC,MAAM,SAAS,GAAG,OAAO,SAAS,GAAG,WAAW,IAAI,IAAI,WAAW,IAAI,EAAE;AAAA,MAC5F;AAAA,IACF;AAEA,QAAI,MAAM,QAAQ,KAAK,IAAI,IAAI,GAAG;AAChC,UAAI,KAAM,MAAK,IAAI,OAAO,CAAC,GAAG,KAAK,IAAI,MAAM,MAAM;AACnD,UAAI,MAAO,MAAK,IAAI,OAAO,CAAC,GAAG,KAAK,IAAI,MAAM,OAAO;AAAA,IACvD;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAI,MAA6B;AAC/B,SAAK,IAAI,MAAM;AAEf,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,KAAK,YAA+C;AAClD,SAAK,IAAI,OAAO,WAAW,SAAS;AAEpC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,OAAO,YAAyC;AAC9C,SAAK,IAAI,SAAS,WAAW,SAAS;AAEtC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyCA,QAAQ;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAOmB;AACjB,SAAK,IAAI,UAAU;AACnB,QAAI,MAAO,MAAK,IAAI,eAAe,IAAI,MAAM,SAAS;AACtD,QAAI,OAAQ,MAAK,IAAI,gBAAgB,IAAI,OAAO,SAAS;AACzD,QAAI,MAAO,MAAK,IAAI,eAAe,IAAI,MAAM,SAAS;AACtD,QAAI,OAAQ,MAAK,IAAI,gBAAgB,IAAI,OAAO,SAAS;AAEzD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA,QAAQ,SAA4C;AAClD,SAAK,IAAI,MAAM,QAAQ,SAAS;AAEhC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBA,QAAQ,OAA0C;AAChD,SAAK,IAAI,UAAU,IAAI,MAAM,SAAS;AAEtC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAI,UAAkC;AACpC,SAAK,IAAI,MAAM,SAAS,SAAS;AAEjC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,KAAK,WAAmC;AACtC,SAAK,IAAI,OAAO,UAAU,SAAS;AAEnC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,QAAwB;AACtB,SAAK,IAAI,QAAQ;AAEjB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,QAAQ,QAAgB,QAAgB,WAAmC;AACzE,SAAK,IAAI,UAAU,CAAC,IAAI,MAAM,IAAI,IAAI,MAAM,IAAI,IAAI,SAAS,EAAE,EAAE,SAAS;AAE1E,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,WAAW,iBAAyC;AAClD,SAAK,IAAI,aAAa,gBAAgB,SAAS;AAE/C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,SAAS,eAAuC;AAC9C,SAAK,IAAI,WAAW,cAAc,SAAS;AAE3C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,WAAW,iBAAyC;AAClD,SAAK,IAAI,aAAa,gBAAgB,SAAS;AAE/C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,aAAa,MAAoC;AAC/C,SAAK,IAAI,eAAe,IAAI;AAE5B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,OAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,WAAW,SAAS;AAAA,EACtB,GAMmB;AACjB,YAAQ,UAAU;AAAA,MAChB,KAAK,SAAS,SAAS;AACrB,aAAK,IAAI,SAAS,CAAC,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACtD;AAAA,MACF;AAAA,MACA,KAAK,SAAS,aAAa;AACzB,aAAK,IAAI,SAAS,GAAG,KAAK,IAAI,MAAM;AACpC;AAAA,MACF;AAAA,MACA,KAAK,SAAS,QAAQ;AACpB,aAAK,IAAI,SAAS,CAAC,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACtD,YAAI,KAAM,MAAK,IAAI,OAAO,KAAK,IAAI,IAAI,EAAE;AACzC,YAAI,KAAM,MAAK,IAAI,OAAO,KAAK,IAAI,IAAI,EAAE;AACzC;AAAA,MACF;AAAA,MACA,KAAK,SAAS,QAAQ;AACpB,aAAK,IAAI,SAAS,CAAC,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AACtD,YAAI,KAAM,MAAK,IAAI,OAAO,KAAK,WAAW,IAAI,EAAE;AAChD,YAAI,KAAM,MAAK,IAAI,OAAO,KAAK,WAAW,IAAI,EAAE;AAAA,MAClD;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AACF;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../../src/lib/pagination.ts"],"sourcesContent":["import { PaginationObj, queryParams } from './types';\n\nexport class Pagination {\n _queryParams: queryParams = {};\n /**\n * @method constructor\n * @memberof Pagination\n * @description Create a pagination class object to paginate through the query response\n * @param {BaseQuery} object of class BaseQuery\n * @param {PaginationObj} object to send skip and limit values\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const query = stack.contentType(\"contentTypeUid\").entry().query();\n *\n * interface TEntryProps {\n * uid: string;\n * title: string;\n * created_at: string;\n * _version: number;\n * locale: string;\n * created_by: string;\n * url: string;\n * // other props\n * }\n * interface TEntries {\n * entries: TEntryProps[];\n * }\n * const pagedResult = await query.paginate().find<TEntries>();\n * OR\n * const pageObj = await query.paginate({ skip: 10, limit: 20 }).find<TEntries>();\n * @returns {Pagination}\n */\n paginate(paginationObj?: PaginationObj) {\n this._queryParams.skip = paginationObj?.skip || 0;\n this._queryParams.limit = paginationObj?.limit || 10;\n\n return this;\n }\n\n /**\n * @method next\n * @memberof Pagination\n * @description Go to next set of response values - skips the current num of responses and shows next responses\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const query = stack.contentType(\"contentTypeUid\").entry().query();\n *\n * interface TEntryProps {\n * uid: string;\n * title: string;\n * created_at: string;\n * _version: number;\n * locale: string;\n * created_by: string;\n * url: string;\n * // other props\n * }\n * interface TEntries {\n * entries: TEntryProps[];\n * }\n * const pagedResult = await query.paginate().find<TEntries>();\n * const nextPageResult = await query.next().find<TEntries>();\n * @returns {Object}\n */\n next() {\n if (!this._queryParams.skip) this.paginate();\n\n (this._queryParams.skip as number) += this._queryParams.limit as number;\n\n return this;\n }\n\n /**\n * @method previous\n * @memberof Pagination\n * @description Go to previous set of response values - skips the current num of responses and shows previous responses\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const query = stack.contentType(\"contentTypeUid\").entry().query();\n *\n * interface TEntryProps {\n * uid: string;\n * title: string;\n * created_at: string;\n * _version: number;\n * locale: string;\n * created_by: string;\n * url: string;\n * // other props\n * }\n * interface TEntries {\n * entries: TEntryProps[];\n * }\n * const pagedResult = await query.paginate().find<TEntries>();\n * const prevPageResult = await query.previous().find<TEntries>();\n * @returns {Pagination}\n */\n previous() {\n if (!this._queryParams.skip) this.paginate();\n\n const skipVal = (this._queryParams.skip as number) - (this._queryParams.limit as number);\n this._queryParams.skip = skipVal < 0 ? 0 : skipVal;\n\n return this;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEO,IAAM,aAAN,MAAiB;AAAA,EAAjB;AACL,wBAA4B,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA+B7B,SAAS,eAA+B;AACtC,SAAK,aAAa,QAAO,+CAAe,SAAQ;AAChD,SAAK,aAAa,SAAQ,+CAAe,UAAS;AAElD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6BA,OAAO;AACL,QAAI,CAAC,KAAK,aAAa,KAAM,MAAK,SAAS;AAE3C,IAAC,KAAK,aAAa,QAAmB,KAAK,aAAa;AAExD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6BA,WAAW;AACT,QAAI,CAAC,KAAK,aAAa,KAAM,MAAK,SAAS;AAE3C,UAAM,UAAW,KAAK,aAAa,OAAmB,KAAK,aAAa;AACxE,SAAK,aAAa,OAAO,UAAU,IAAI,IAAI;AAE3C,WAAO;AAAA,EACT;AACF;","names":[]}
@@ -1,99 +0,0 @@
1
- import { queryParams, PaginationObj } from './types.cjs';
2
- import '@contentstack/core';
3
- import '../persistance/types/storage-type.cjs';
4
- import '../persistance/config/persistance-storage-config.cjs';
5
- import '../persistance/types/storage.cjs';
6
- import '../persistance/helper/utils.cjs';
7
-
8
- declare class Pagination {
9
- _queryParams: queryParams;
10
- /**
11
- * @method constructor
12
- * @memberof Pagination
13
- * @description Create a pagination class object to paginate through the query response
14
- * @param {BaseQuery} object of class BaseQuery
15
- * @param {PaginationObj} object to send skip and limit values
16
- * @example
17
- * import contentstack from '@contentstack/delivery-sdk'
18
- *
19
- * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
20
- * const query = stack.contentType("contentTypeUid").entry().query();
21
- *
22
- * interface TEntryProps {
23
- * uid: string;
24
- * title: string;
25
- * created_at: string;
26
- * _version: number;
27
- * locale: string;
28
- * created_by: string;
29
- * url: string;
30
- * // other props
31
- * }
32
- * interface TEntries {
33
- * entries: TEntryProps[];
34
- * }
35
- * const pagedResult = await query.paginate().find<TEntries>();
36
- * OR
37
- * const pageObj = await query.paginate({ skip: 10, limit: 20 }).find<TEntries>();
38
- * @returns {Pagination}
39
- */
40
- paginate(paginationObj?: PaginationObj): this;
41
- /**
42
- * @method next
43
- * @memberof Pagination
44
- * @description Go to next set of response values - skips the current num of responses and shows next responses
45
- * @example
46
- * import contentstack from '@contentstack/delivery-sdk'
47
- *
48
- * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
49
- * const query = stack.contentType("contentTypeUid").entry().query();
50
- *
51
- * interface TEntryProps {
52
- * uid: string;
53
- * title: string;
54
- * created_at: string;
55
- * _version: number;
56
- * locale: string;
57
- * created_by: string;
58
- * url: string;
59
- * // other props
60
- * }
61
- * interface TEntries {
62
- * entries: TEntryProps[];
63
- * }
64
- * const pagedResult = await query.paginate().find<TEntries>();
65
- * const nextPageResult = await query.next().find<TEntries>();
66
- * @returns {Object}
67
- */
68
- next(): this;
69
- /**
70
- * @method previous
71
- * @memberof Pagination
72
- * @description Go to previous set of response values - skips the current num of responses and shows previous responses
73
- * @example
74
- * import contentstack from '@contentstack/delivery-sdk'
75
- *
76
- * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
77
- * const query = stack.contentType("contentTypeUid").entry().query();
78
- *
79
- * interface TEntryProps {
80
- * uid: string;
81
- * title: string;
82
- * created_at: string;
83
- * _version: number;
84
- * locale: string;
85
- * created_by: string;
86
- * url: string;
87
- * // other props
88
- * }
89
- * interface TEntries {
90
- * entries: TEntryProps[];
91
- * }
92
- * const pagedResult = await query.paginate().find<TEntries>();
93
- * const prevPageResult = await query.previous().find<TEntries>();
94
- * @returns {Pagination}
95
- */
96
- previous(): this;
97
- }
98
-
99
- export { Pagination };