@progress/sitefinity-webservices-sdk 1.1.15 → 2.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 (231) hide show
  1. package/README.md +84 -51
  2. package/esm/chunks/chunk-2ID24RPE.mjs +179 -0
  3. package/esm/chunks/chunk-2ID24RPE.mjs.map +7 -0
  4. package/esm/chunks/chunk-AHDZ2CWQ.mjs +93 -0
  5. package/esm/chunks/chunk-AHDZ2CWQ.mjs.map +7 -0
  6. package/esm/chunks/chunk-BFLQBM7R.mjs +136 -0
  7. package/esm/chunks/chunk-BFLQBM7R.mjs.map +7 -0
  8. package/esm/chunks/chunk-CMGV26CS.mjs +66 -0
  9. package/esm/chunks/chunk-CMGV26CS.mjs.map +7 -0
  10. package/esm/chunks/chunk-DHWDJAGV.mjs +180 -0
  11. package/esm/chunks/chunk-DHWDJAGV.mjs.map +7 -0
  12. package/esm/chunks/chunk-EH4CERVO.mjs +82 -0
  13. package/esm/chunks/chunk-EH4CERVO.mjs.map +7 -0
  14. package/esm/chunks/chunk-F4CWOE7M.mjs +57 -0
  15. package/esm/chunks/chunk-F4CWOE7M.mjs.map +7 -0
  16. package/esm/chunks/chunk-FUFBYOIF.mjs +98 -0
  17. package/esm/chunks/chunk-FUFBYOIF.mjs.map +7 -0
  18. package/esm/chunks/chunk-J2B7UDVZ.mjs +132 -0
  19. package/esm/chunks/chunk-J2B7UDVZ.mjs.map +7 -0
  20. package/esm/chunks/chunk-L3IMDFA5.mjs +1 -0
  21. package/esm/chunks/chunk-L3IMDFA5.mjs.map +7 -0
  22. package/esm/chunks/chunk-NNYY2VBC.mjs +383 -0
  23. package/esm/chunks/chunk-NNYY2VBC.mjs.map +7 -0
  24. package/esm/chunks/chunk-PI55MBSL.mjs +256 -0
  25. package/esm/chunks/chunk-PI55MBSL.mjs.map +7 -0
  26. package/esm/chunks/chunk-PXPK2IV6.mjs +568 -0
  27. package/esm/chunks/chunk-PXPK2IV6.mjs.map +7 -0
  28. package/esm/chunks/chunk-QPSEKUOI.mjs +35 -0
  29. package/esm/chunks/chunk-QPSEKUOI.mjs.map +7 -0
  30. package/esm/chunks/chunk-RQAAYOY6.mjs +72 -0
  31. package/esm/chunks/chunk-RQAAYOY6.mjs.map +7 -0
  32. package/esm/chunks/chunk-TTVNTTW5.mjs +145 -0
  33. package/esm/chunks/chunk-TTVNTTW5.mjs.map +7 -0
  34. package/esm/chunks/chunk-VLDX2FH2.mjs +235 -0
  35. package/esm/chunks/chunk-VLDX2FH2.mjs.map +7 -0
  36. package/esm/chunks/chunk-VWT2RJET.mjs +102 -0
  37. package/esm/chunks/chunk-VWT2RJET.mjs.map +7 -0
  38. package/esm/chunks/chunk-W2OWM3L7.mjs +19 -0
  39. package/esm/chunks/chunk-W2OWM3L7.mjs.map +7 -0
  40. package/esm/chunks/chunk-WX5J7F5D.mjs +43 -0
  41. package/esm/chunks/chunk-WX5J7F5D.mjs.map +7 -0
  42. package/esm/chunks/chunk-YB2LMPUX.mjs +54 -0
  43. package/esm/chunks/chunk-YB2LMPUX.mjs.map +7 -0
  44. package/package.json +67 -36
  45. package/sitefinity-webservices-sdk.cjs +2761 -0
  46. package/sitefinity-webservices-sdk.cjs.map +7 -0
  47. package/sitefinity-webservices-sdk.d.mts +1 -0
  48. package/{dist/sitefinity-webservices-sdk.d.ts → sitefinity-webservices-sdk.d.ts} +6 -0
  49. package/sitefinity-webservices-sdk.global.d.ts +5 -0
  50. package/sitefinity-webservices-sdk.js +2764 -0
  51. package/sitefinity-webservices-sdk.js.map +7 -0
  52. package/sitefinity-webservices-sdk.min.js +3 -0
  53. package/sitefinity-webservices-sdk.mjs +124 -0
  54. package/sitefinity-webservices-sdk.mjs.map +7 -0
  55. package/src/BlobBuilder.d.ts +12 -0
  56. package/src/Data.d.ts +259 -0
  57. package/src/Expression.d.ts +37 -0
  58. package/src/OrderProperty.d.ts +24 -0
  59. package/src/Query.d.ts +104 -0
  60. package/src/QueryBase.d.ts +40 -0
  61. package/src/QueryBuilder.d.ts +29 -0
  62. package/src/Requests/BatchRequest.d.ts +174 -0
  63. package/src/Requests/ExecutableRequest.d.ts +43 -0
  64. package/src/Requests/Request.d.ts +225 -0
  65. package/src/Requests/RequestBase.d.ts +58 -0
  66. package/{dist/src → src}/Requests/RequestFactory.d.ts +24 -2
  67. package/src/Sitefinity.d.ts +141 -0
  68. package/src/Transport/FetchTransport.d.ts +17 -0
  69. package/src/Transport/HttpTransport.d.ts +69 -0
  70. package/src/Transport/XhrTransport.d.ts +8 -0
  71. package/src/WhereQuery.d.ts +88 -0
  72. package/src/chunk-upload/chunk-upload.sdk.d.ts +305 -0
  73. package/src/chunk-upload/chunked-file-upload.utilities.d.ts +58 -0
  74. package/{dist/src → src}/constants.d.ts +21 -0
  75. package/src/utils.d.ts +103 -0
  76. package/.editorconfig +0 -29
  77. package/.eslintignore +0 -4
  78. package/.eslintrc.js +0 -40
  79. package/config/helpers.ts +0 -8
  80. package/config/webpack.common.ts +0 -39
  81. package/config/webpack.dev.ts +0 -37
  82. package/config/webpack.prod.ts +0 -17
  83. package/dist/docs/.nojekyll +0 -1
  84. package/dist/docs/assets/highlight.css +0 -71
  85. package/dist/docs/assets/main.js +0 -58
  86. package/dist/docs/assets/search.js +0 -1
  87. package/dist/docs/assets/style.css +0 -1280
  88. package/dist/docs/classes/BlobBuilder.BlobBuilder.html +0 -137
  89. package/dist/docs/classes/Data.Data.html +0 -387
  90. package/dist/docs/classes/Expression.BinaryExpression.html +0 -184
  91. package/dist/docs/classes/Expression.ComplexExpression.html +0 -146
  92. package/dist/docs/classes/Expression.ExpressionBase.html +0 -125
  93. package/dist/docs/classes/OrderProperty.OrderProperty.html +0 -151
  94. package/dist/docs/classes/Query.Query.html +0 -353
  95. package/dist/docs/classes/QueryBase.QueryBase.html +0 -185
  96. package/dist/docs/classes/QueryBuilder.QueryBuilder.html +0 -206
  97. package/dist/docs/classes/Requests_BatchRequest.BatchRequest.html +0 -731
  98. package/dist/docs/classes/Requests_BatchRequest.Transaction.html +0 -332
  99. package/dist/docs/classes/Requests_ExecutableRequest.ExecutableRequest.html +0 -340
  100. package/dist/docs/classes/Requests_Request.CommitChunksRequest.html +0 -303
  101. package/dist/docs/classes/Requests_Request.CreateRelatedRequest.html +0 -310
  102. package/dist/docs/classes/Requests_Request.CreateRequest.html +0 -307
  103. package/dist/docs/classes/Requests_Request.DeleteRelatedByIdRequest.html +0 -309
  104. package/dist/docs/classes/Requests_Request.DeleteRelatedRequest.html +0 -302
  105. package/dist/docs/classes/Requests_Request.DeleteRequest.html +0 -298
  106. package/dist/docs/classes/Requests_Request.GetByIdRequest.html +0 -298
  107. package/dist/docs/classes/Requests_Request.GetRelatedByIdRequest.html +0 -309
  108. package/dist/docs/classes/Requests_Request.GetRelatedRequest.html +0 -302
  109. package/dist/docs/classes/Requests_Request.GetRequest.html +0 -295
  110. package/dist/docs/classes/Requests_Request.UpdateRequest.html +0 -309
  111. package/dist/docs/classes/Requests_Request.UploadChunkRequest.html +0 -359
  112. package/dist/docs/classes/Requests_Request.UploadRequest.html +0 -329
  113. package/dist/docs/classes/Requests_RequestBase.RequestBase.html +0 -275
  114. package/dist/docs/classes/Requests_RequestFactory.RequestFactory.html +0 -344
  115. package/dist/docs/classes/Sitefinity.Sitefinity.html +0 -188
  116. package/dist/docs/classes/WhereQuery.WhereQuery.html +0 -436
  117. package/dist/docs/classes/chunk_upload_chunk_upload_sdk.ChunkUploadSdk.html +0 -231
  118. package/dist/docs/classes/chunk_upload_chunked_file_upload_utilities.ChunkedFileUploadUtilities.html +0 -131
  119. package/dist/docs/classes/utils.utils.html +0 -303
  120. package/dist/docs/index.html +0 -129
  121. package/dist/docs/interfaces/Data.CreateRelatedRequestOptions.html +0 -155
  122. package/dist/docs/interfaces/Data.CreateRequestOptions.html +0 -153
  123. package/dist/docs/interfaces/Data.OperationsRequestOptions.html +0 -145
  124. package/dist/docs/interfaces/Data.PropertyRequestOptions.html +0 -149
  125. package/dist/docs/interfaces/Data.RequestOptionsBase.html +0 -136
  126. package/dist/docs/interfaces/Data.SingleRelatedItemRequestOptions.html +0 -155
  127. package/dist/docs/interfaces/Data.UpdateRequestOptions.html +0 -155
  128. package/dist/docs/interfaces/Data.UploadRequestOptions.html +0 -169
  129. package/dist/docs/interfaces/Requests_BatchRequest.BatchCreateRelatedRequestOptions.html +0 -161
  130. package/dist/docs/interfaces/Requests_BatchRequest.BatchCreateRequestOptions.html +0 -153
  131. package/dist/docs/interfaces/Requests_BatchRequest.BatchPropertyRequestOptions.html +0 -153
  132. package/dist/docs/interfaces/Requests_BatchRequest.BatchRequestOptionsBase.html +0 -145
  133. package/dist/docs/interfaces/Requests_BatchRequest.BatchRequestOptionsExtended.html +0 -153
  134. package/dist/docs/interfaces/Requests_BatchRequest.BatchSingleItemRequestOptions.html +0 -145
  135. package/dist/docs/interfaces/Requests_BatchRequest.BatchSingleRelatedItemRequestOptions.html +0 -161
  136. package/dist/docs/interfaces/Requests_BatchRequest.BatchUpdateRequestOptions.html +0 -161
  137. package/dist/docs/interfaces/Requests_ExecutableRequest.ResponseHandlers.html +0 -98
  138. package/dist/docs/interfaces/Requests_Request.CommitChunksRequestOptionsExtended.html +0 -215
  139. package/dist/docs/interfaces/Requests_Request.PostRequestOptionsExtended.html +0 -159
  140. package/dist/docs/interfaces/Requests_Request.PutRequestOptionsExtended.html +0 -161
  141. package/dist/docs/interfaces/Requests_Request.RelatedByIdRequestOptionsExtended.html +0 -169
  142. package/dist/docs/interfaces/Requests_Request.RelatedRequestOptionsExtended.html +0 -163
  143. package/dist/docs/interfaces/Requests_Request.UploadChunkRequestOptionsExtended.html +0 -217
  144. package/dist/docs/interfaces/Requests_Request.UploadRequestOptionsExtended.html +0 -180
  145. package/dist/docs/interfaces/Requests_RequestBase.RequestOptionsBaseExtended.html +0 -148
  146. package/dist/docs/interfaces/Sitefinity.SDKOptions.html +0 -128
  147. package/dist/docs/interfaces/Sitefinity.Token.html +0 -94
  148. package/dist/docs/interfaces/Sitefinity.TypeOptions.html +0 -160
  149. package/dist/docs/interfaces/chunk_upload_chunk_upload_sdk.ChunkUploadInfoDTO.html +0 -159
  150. package/dist/docs/interfaces/chunk_upload_chunk_upload_sdk.ChunkUploadResult.html +0 -111
  151. package/dist/docs/interfaces/chunk_upload_chunk_upload_sdk.CleanUpChunksRequestOptions.html +0 -171
  152. package/dist/docs/interfaces/chunk_upload_chunk_upload_sdk.CommitChunksRequestOptions.html +0 -204
  153. package/dist/docs/interfaces/chunk_upload_chunk_upload_sdk.GetChunkUploadInfoRequestOptions.html +0 -166
  154. package/dist/docs/interfaces/chunk_upload_chunk_upload_sdk.UploadChunkRequestOptions.html +0 -206
  155. package/dist/docs/interfaces/chunk_upload_chunked_file_upload_utilities.ChunkFileResult.html +0 -101
  156. package/dist/docs/interfaces/chunk_upload_chunked_file_upload_utilities.FileUploadChunk.html +0 -94
  157. package/dist/docs/modules/BlobBuilder.html +0 -73
  158. package/dist/docs/modules/Data.html +0 -92
  159. package/dist/docs/modules/Expression.html +0 -77
  160. package/dist/docs/modules/OrderProperty.html +0 -73
  161. package/dist/docs/modules/Query.html +0 -73
  162. package/dist/docs/modules/QueryBase.html +0 -73
  163. package/dist/docs/modules/QueryBuilder.html +0 -73
  164. package/dist/docs/modules/Requests_BatchRequest.html +0 -94
  165. package/dist/docs/modules/Requests_ExecutableRequest.html +0 -78
  166. package/dist/docs/modules/Requests_Request.html +0 -114
  167. package/dist/docs/modules/Requests_RequestBase.html +0 -78
  168. package/dist/docs/modules/Requests_RequestFactory.html +0 -73
  169. package/dist/docs/modules/Sitefinity.html +0 -82
  170. package/dist/docs/modules/WhereQuery.html +0 -73
  171. package/dist/docs/modules/chunk_upload_chunk_upload_sdk.html +0 -88
  172. package/dist/docs/modules/chunk_upload_chunked_file_upload_utilities.html +0 -80
  173. package/dist/docs/modules/constants.html +0 -83
  174. package/dist/docs/modules/utils.html +0 -73
  175. package/dist/docs/modules.html +0 -80
  176. package/dist/docs/variables/constants.CONTENT_TYPES.html +0 -76
  177. package/dist/docs/variables/constants.EXPRESSION_TYPE.html +0 -106
  178. package/dist/docs/variables/constants.HEADER_NAMES.html +0 -102
  179. package/dist/docs/variables/constants.HTTP_METHODS.html +0 -84
  180. package/dist/docs/variables/constants.ODATA_PARAMS.html +0 -90
  181. package/dist/docs/variables/constants.SF_PARAMS.html +0 -84
  182. package/dist/samples.html +0 -625
  183. package/dist/sitefinity-webservices-sdk.js +0 -3125
  184. package/dist/sitefinity-webservices-sdk.js.map +0 -1
  185. package/dist/sitefinity-webservices-sdk.min.js +0 -1
  186. package/dist/src/BlobBuilder.d.ts +0 -14
  187. package/dist/src/Data.d.ts +0 -154
  188. package/dist/src/Data.spec.d.ts +0 -1
  189. package/dist/src/Expression.d.ts +0 -19
  190. package/dist/src/OrderProperty.d.ts +0 -8
  191. package/dist/src/Query.d.ts +0 -59
  192. package/dist/src/QueryBase.d.ts +0 -18
  193. package/dist/src/QueryBuilder.d.ts +0 -13
  194. package/dist/src/Requests/BatchRequest.d.ts +0 -146
  195. package/dist/src/Requests/ExecutableRequest.d.ts +0 -22
  196. package/dist/src/Requests/Request.d.ts +0 -132
  197. package/dist/src/Requests/RequestBase.d.ts +0 -27
  198. package/dist/src/Requests/request.spec.d.ts +0 -1
  199. package/dist/src/Sitefinity.d.ts +0 -75
  200. package/dist/src/Sitefinity.spec.d.ts +0 -1
  201. package/dist/src/WhereQuery.d.ts +0 -72
  202. package/dist/src/chunk-upload/chunk-upload.sdk.d.ts +0 -295
  203. package/dist/src/chunk-upload/chunk-upload.sdk.spec.d.ts +0 -1
  204. package/dist/src/chunk-upload/chunked-file-upload.utilities.d.ts +0 -13
  205. package/dist/src/utils.d.ts +0 -16
  206. package/karma.conf.js +0 -29
  207. package/sitefinity-webservices-sdk.ts +0 -15
  208. package/src/BlobBuilder.ts +0 -20
  209. package/src/Data.spec.ts +0 -160
  210. package/src/Data.ts +0 -418
  211. package/src/Expression.ts +0 -36
  212. package/src/OrderProperty.ts +0 -39
  213. package/src/Query.ts +0 -106
  214. package/src/QueryBase.ts +0 -57
  215. package/src/QueryBuilder.ts +0 -180
  216. package/src/Requests/BatchRequest.ts +0 -807
  217. package/src/Requests/ExecutableRequest.ts +0 -117
  218. package/src/Requests/Request.ts +0 -327
  219. package/src/Requests/RequestBase.ts +0 -163
  220. package/src/Requests/RequestFactory.ts +0 -75
  221. package/src/Requests/request.spec.ts +0 -132
  222. package/src/Sitefinity.spec.ts +0 -483
  223. package/src/Sitefinity.ts +0 -125
  224. package/src/WhereQuery.ts +0 -145
  225. package/src/chunk-upload/chunk-upload.sdk.spec.ts +0 -342
  226. package/src/chunk-upload/chunk-upload.sdk.ts +0 -439
  227. package/src/chunk-upload/chunked-file-upload.utilities.ts +0 -64
  228. package/src/constants.ts +0 -66
  229. package/src/utils.ts +0 -125
  230. package/template.html +0 -625
  231. package/tsconfig.json +0 -38
@@ -0,0 +1,102 @@
1
+ import {
2
+ RequestFactory
3
+ } from "./chunk-AHDZ2CWQ.mjs";
4
+ import {
5
+ Data
6
+ } from "./chunk-NNYY2VBC.mjs";
7
+ import {
8
+ Query
9
+ } from "./chunk-J2B7UDVZ.mjs";
10
+ import {
11
+ utils
12
+ } from "./chunk-2ID24RPE.mjs";
13
+
14
+ // src/Sitefinity.ts
15
+ var Sitefinity = class {
16
+ /**
17
+ * Creates the SDK entry point.
18
+ *
19
+ * @param options Service URL and optional site-level configuration.
20
+ */
21
+ constructor(options) {
22
+ this.baseUrl = options.baseUrl;
23
+ this.siteId = options.siteId;
24
+ this.factory = new RequestFactory(options);
25
+ }
26
+ /**
27
+ * Creates a data client for an entity set.
28
+ *
29
+ * The returned client uses the SDK defaults unless a URL, provider, culture, site,
30
+ * query parameters, or headers are overridden in `options`.
31
+ *
32
+ * @param options Entity-set and request URL options.
33
+ * @returns A data client for the requested entity set.
34
+ *
35
+ * @example
36
+ * const news = sdk.data({ entitySet: "newsitems", culture: "en" });
37
+ * news.get({ successCb: items => console.log(items) });
38
+ */
39
+ data(options) {
40
+ const urlOptions = {
41
+ baseUrl: utils.addTrailingSlash(options.baseUrl || this.baseUrl),
42
+ provider: options.provider,
43
+ culture: options.culture,
44
+ siteId: options.siteId || this.siteId,
45
+ additionalQueryParams: options.additionalQueryParams,
46
+ additionalHeaders: options.additionalHeaders,
47
+ entitySet: options.entitySet
48
+ };
49
+ return new Data(urlOptions, this.factory);
50
+ }
51
+ /**
52
+ * Creates a batch for grouping requests and optional upload, update, or workflow operations.
53
+ *
54
+ * Call `execute()` after adding requests. The callbacks receive the batch response,
55
+ * failure payload, and progress event respectively. Batch options override SDK URL options.
56
+ *
57
+ * @param success Callback invoked when the batch succeeds.
58
+ * @param failure Callback invoked when the batch fails.
59
+ * @param progress Callback invoked as request progress is reported.
60
+ * @param options Optional URL and request options for the batch.
61
+ * @returns A batch request that can be populated and executed.
62
+ */
63
+ batch(success, failure, progress, options) {
64
+ if (!options)
65
+ options = {};
66
+ const batch = this.factory.batch({
67
+ successCb: success,
68
+ failureCb: failure,
69
+ progressCb: progress,
70
+ urlOptions: {
71
+ baseUrl: utils.addTrailingSlash(options.baseUrl || this.baseUrl),
72
+ provider: options.provider,
73
+ culture: options.culture,
74
+ siteId: options.siteId || this.siteId,
75
+ additionalQueryParams: options.additionalQueryParams,
76
+ additionalHeaders: options.additionalHeaders
77
+ }
78
+ });
79
+ return batch;
80
+ }
81
+ /**
82
+ * Sets the value sent in the `Authorization` header.
83
+ *
84
+ * The current token form is `{ type, value }`, for example
85
+ * `{ type: "Bearer", value: "token" }`. A raw string is also accepted at runtime
86
+ * for backward compatibility and is sent unchanged.
87
+ *
88
+ * @param token Token object or legacy raw authorization header value.
89
+ */
90
+ setToken(token) {
91
+ this.factory.token = token;
92
+ }
93
+ };
94
+ /**
95
+ * Query builder constructor exposed for consumers that need to build OData queries.
96
+ */
97
+ Sitefinity.Query = Query;
98
+
99
+ export {
100
+ Sitefinity
101
+ };
102
+ //# sourceMappingURL=chunk-VWT2RJET.mjs.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../src/Sitefinity.ts"],
4
+ "sourcesContent": ["\uFEFFimport { RequestFactory } from \"./Requests/RequestFactory\";\nimport { Data } from \"./Data\";\nimport { Query } from \"./Query\";\nimport { utils } from \"./utils\";\nimport { ResponseHandlers } from \"./Requests/ExecutableRequest\";\nimport { BatchRequest } from \"./Requests/BatchRequest\";\nimport { HttpTransport } from \"./Transport/HttpTransport\";\n\n/**\n * Entry point for querying and modifying content through the Sitefinity Web Services API.\n */\nexport class Sitefinity {\n /**\n * Query builder constructor exposed for consumers that need to build OData queries.\n */\n public static Query: typeof Query = Query;\n\n private factory: RequestFactory;\n private baseUrl: string;\n private siteId: string;\n\n /**\n * Creates the SDK entry point.\n *\n * @param options Service URL and optional site-level configuration.\n */\n constructor(options: SDKOptions) {\n this.baseUrl = options.baseUrl;\n this.siteId = options.siteId;\n this.factory = new RequestFactory(options);\n }\n\n /**\n * Creates a data client for an entity set.\n *\n * The returned client uses the SDK defaults unless a URL, provider, culture, site,\n * query parameters, or headers are overridden in `options`.\n *\n * @param options Entity-set and request URL options.\n * @returns A data client for the requested entity set.\n *\n * @example\n * const news = sdk.data({ entitySet: \"newsitems\", culture: \"en\" });\n * news.get({ successCb: items => console.log(items) });\n */\n data(options: TypeOptions): Data {\n const urlOptions: TypeOptions = {\n baseUrl: utils.addTrailingSlash(options.baseUrl || this.baseUrl),\n provider: options.provider,\n culture: options.culture,\n siteId: options.siteId || this.siteId,\n additionalQueryParams: options.additionalQueryParams,\n additionalHeaders: options.additionalHeaders,\n entitySet: options.entitySet\n };\n\n return new Data(urlOptions, this.factory);\n }\n\n /**\n * Creates a batch for grouping requests and optional upload, update, or workflow operations.\n *\n * Call `execute()` after adding requests. The callbacks receive the batch response,\n * failure payload, and progress event respectively. Batch options override SDK URL options.\n *\n * @param success Callback invoked when the batch succeeds.\n * @param failure Callback invoked when the batch fails.\n * @param progress Callback invoked as request progress is reported.\n * @param options Optional URL and request options for the batch.\n * @returns A batch request that can be populated and executed.\n */\n batch(success?: Function, failure?: Function, progress?: Function, options?: TypeOptions): BatchRequest {\n if (!options)\n options = {};\n\n const batch = this.factory.batch({\n successCb: success,\n failureCb: failure,\n progressCb: progress,\n urlOptions: {\n baseUrl: utils.addTrailingSlash(options.baseUrl || this.baseUrl),\n provider: options.provider,\n culture: options.culture,\n siteId: options.siteId || this.siteId,\n additionalQueryParams: options.additionalQueryParams,\n additionalHeaders: options.additionalHeaders\n }\n });\n\n return batch;\n }\n\n /**\n * Sets the value sent in the `Authorization` header.\n *\n * The current token form is `{ type, value }`, for example\n * `{ type: \"Bearer\", value: \"token\" }`. A raw string is also accepted at runtime\n * for backward compatibility and is sent unchanged.\n *\n * @param token Token object or legacy raw authorization header value.\n */\n setToken(token: AuthorizationToken) {\n this.factory.token = token;\n }\n}\n\ninterface OptionsBase {\n /**\n * Service URL that points to the configured Sitefinity service.\n */\n baseUrl?: string;\n\n /**\n * ID of the site for which requests are executed.\n */\n siteId?: string;\n}\n\n/**\n * Configuration options for the SDK entry point.\n */\nexport interface SDKOptions extends OptionsBase {\n /**\n * Default callbacks used when a request does not provide its own callback.\n */\n handlers?: ResponseHandlers;\n\n /**\n * Adds the Sitefinity unlimited-choices request header when true.\n */\n enableUnlimitedChoices?: boolean;\n\n /**\n * Adds the Sitefinity integration-mode request header when true.\n */\n integrationMode?: boolean;\n\n /**\n * Sends every HTTP request the SDK makes. Use it to route SDK traffic through your own HTTP stack,\n * such as Angular's `HttpClient` or `fetch`. Defaults to {@link XhrTransport}, which uses `XMLHttpRequest`.\n */\n transport?: HttpTransport;\n}\n\n/**\n * Configuration options for an entity-set data client or batch.\n */\nexport interface TypeOptions extends OptionsBase {\n /**\n * URL name of the entity set, such as `\"newsitems\"` or `\"images\"`.\n */\n entitySet?: string;\n\n /**\n * Provider name. When omitted, Sitefinity uses the site's default provider.\n */\n provider?: string;\n\n /**\n * Culture name. When omitted, Sitefinity uses the site's default culture.\n */\n culture?: string;\n\n /**\n * Additional query-string values appended to each request URL.\n */\n additionalQueryParams?: { [key: string]: string };\n\n /**\n * Additional headers sent with each request.\n */\n additionalHeaders?: { [key: string]: string };\n}\n\n/**\n * Structured authorization token.\n *\n * `setToken` also accepts a raw string at runtime for backward compatibility.\n */\nexport interface Token {\n /**\n * Authorization scheme, such as `\"Bearer\"`.\n */\n type: string;\n\n /**\n * Token value.\n */\n value: string;\n}\n\n/**\n * Structured authorization token or a legacy raw `Authorization` header value.\n */\nexport type AuthorizationToken = Token | string;\n"],
5
+ "mappings": ";;;;;;;;;;;;;;AAWO,IAAM,aAAN,MAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAepB,YAAY,SAAqB;AAC7B,SAAK,UAAU,QAAQ;AACvB,SAAK,SAAS,QAAQ;AACtB,SAAK,UAAU,IAAI,eAAe,OAAO;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,SAA4B;AAC7B,UAAM,aAA0B;AAAA,MAC5B,SAAS,MAAM,iBAAiB,QAAQ,WAAW,KAAK,OAAO;AAAA,MAC/D,UAAU,QAAQ;AAAA,MAClB,SAAS,QAAQ;AAAA,MACjB,QAAQ,QAAQ,UAAU,KAAK;AAAA,MAC/B,uBAAuB,QAAQ;AAAA,MAC/B,mBAAmB,QAAQ;AAAA,MAC3B,WAAW,QAAQ;AAAA,IACvB;AAEA,WAAO,IAAI,KAAK,YAAY,KAAK,OAAO;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,SAAoB,SAAoB,UAAqB,SAAqC;AACpG,QAAI,CAAC;AACD,gBAAU,CAAC;AAEf,UAAM,QAAQ,KAAK,QAAQ,MAAM;AAAA,MAC7B,WAAW;AAAA,MACX,WAAW;AAAA,MACX,YAAY;AAAA,MACZ,YAAY;AAAA,QACR,SAAS,MAAM,iBAAiB,QAAQ,WAAW,KAAK,OAAO;AAAA,QAC/D,UAAU,QAAQ;AAAA,QAClB,SAAS,QAAQ;AAAA,QACjB,QAAQ,QAAQ,UAAU,KAAK;AAAA,QAC/B,uBAAuB,QAAQ;AAAA,QAC/B,mBAAmB,QAAQ;AAAA,MAC/B;AAAA,IACJ,CAAC;AAED,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,SAAS,OAA2B;AAChC,SAAK,QAAQ,QAAQ;AAAA,EACzB;AACJ;AAAA;AAAA;AAAA;AA7Fa,WAIK,QAAsB;",
6
+ "names": []
7
+ }
@@ -0,0 +1,19 @@
1
+ // src/BlobBuilder.ts
2
+ var BlobBuilder = class {
3
+ constructor() {
4
+ this.blob = new Blob();
5
+ }
6
+ /** Appends a value to the blob being built. */
7
+ append(value) {
8
+ this.blob = new Blob([this.blob, value]);
9
+ }
10
+ /** Returns the accumulated blob content. */
11
+ build() {
12
+ return this.blob;
13
+ }
14
+ };
15
+
16
+ export {
17
+ BlobBuilder
18
+ };
19
+ //# sourceMappingURL=chunk-W2OWM3L7.mjs.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../src/BlobBuilder.ts"],
4
+ "sourcesContent": ["/**\n * Incrementally builds a `Blob`, primarily for multipart batch MIME bodies.\n *\n * This is a low-level helper for advanced request construction.\n */\nexport class BlobBuilder {\n private blob = new Blob();\n\n /** Appends a value to the blob being built. */\n append(value: any) {\n this.blob = new Blob([this.blob, value]);\n }\n\n /** Returns the accumulated blob content. */\n build(): Blob {\n return this.blob;\n }\n}\n"],
5
+ "mappings": ";AAKO,IAAM,cAAN,MAAkB;AAAA,EAAlB;AACH,SAAQ,OAAO,IAAI,KAAK;AAAA;AAAA;AAAA,EAGxB,OAAO,OAAY;AACf,SAAK,OAAO,IAAI,KAAK,CAAC,KAAK,MAAM,KAAK,CAAC;AAAA,EAC3C;AAAA;AAAA,EAGA,QAAc;AACV,WAAO,KAAK;AAAA,EAChB;AACJ;",
6
+ "names": []
7
+ }
@@ -0,0 +1,43 @@
1
+ // src/Transport/XhrTransport.ts
2
+ var XMLHttpRequestDone = 4;
3
+ var XhrTransport = class {
4
+ /** Sends the request with a new `XMLHttpRequest` and reports its final state. */
5
+ send(request, onComplete) {
6
+ const xhr = new XMLHttpRequest();
7
+ xhr.onreadystatechange = () => {
8
+ if (xhr.readyState === XMLHttpRequestDone) {
9
+ onComplete({
10
+ status: xhr.status,
11
+ body: xhr.responseText,
12
+ // Parsed on demand: only $batch reads the headers, and minimal XHR fakes may not implement them.
13
+ get headers() {
14
+ return parseResponseHeaders(xhr.getAllResponseHeaders());
15
+ }
16
+ });
17
+ }
18
+ };
19
+ if (request.onUploadProgress && xhr.upload) {
20
+ xhr.upload.onprogress = request.onUploadProgress;
21
+ }
22
+ xhr.open(request.method, request.url, true);
23
+ for (const name of Object.keys(request.headers)) {
24
+ xhr.setRequestHeader(name, request.headers[name]);
25
+ }
26
+ xhr.send(request.body);
27
+ }
28
+ };
29
+ function parseResponseHeaders(raw) {
30
+ const headers = {};
31
+ for (const line of (raw ?? "").split(/\r?\n/)) {
32
+ const separator = line.indexOf(":");
33
+ if (separator > 0) {
34
+ headers[line.substring(0, separator).trim().toLowerCase()] = line.substring(separator + 1).trim();
35
+ }
36
+ }
37
+ return headers;
38
+ }
39
+
40
+ export {
41
+ XhrTransport
42
+ };
43
+ //# sourceMappingURL=chunk-WX5J7F5D.mjs.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../src/Transport/XhrTransport.ts"],
4
+ "sourcesContent": ["import { HttpTransport, HttpTransportRequest, HttpTransportResponse } from \"./HttpTransport\";\n\nconst XMLHttpRequestDone = 4;\n\n/**\n * Default transport. Sends requests with `XMLHttpRequest`.\n */\nexport class XhrTransport implements HttpTransport {\n /** Sends the request with a new `XMLHttpRequest` and reports its final state. */\n send(request: HttpTransportRequest, onComplete: (response: HttpTransportResponse) => void): void {\n const xhr = new XMLHttpRequest();\n\n xhr.onreadystatechange = () => {\n if (xhr.readyState === XMLHttpRequestDone) {\n onComplete({\n status: xhr.status,\n body: xhr.responseText,\n // Parsed on demand: only $batch reads the headers, and minimal XHR fakes may not implement them.\n get headers() {\n return parseResponseHeaders(xhr.getAllResponseHeaders());\n }\n });\n }\n };\n\n if (request.onUploadProgress && xhr.upload) {\n xhr.upload.onprogress = request.onUploadProgress;\n }\n\n xhr.open(request.method, request.url, true);\n\n for (const name of Object.keys(request.headers)) {\n xhr.setRequestHeader(name, request.headers[name]);\n }\n\n xhr.send(request.body);\n }\n}\n\nfunction parseResponseHeaders(raw: string | null): { [name: string]: string } {\n const headers: { [name: string]: string } = {};\n\n for (const line of (raw ?? \"\").split(/\\r?\\n/)) {\n const separator = line.indexOf(\":\");\n if (separator > 0) {\n headers[line.substring(0, separator).trim().toLowerCase()] = line.substring(separator + 1).trim();\n }\n }\n\n return headers;\n}\n"],
5
+ "mappings": ";AAEA,IAAM,qBAAqB;AAKpB,IAAM,eAAN,MAA4C;AAAA;AAAA,EAE/C,KAAK,SAA+B,YAA6D;AAC7F,UAAM,MAAM,IAAI,eAAe;AAE/B,QAAI,qBAAqB,MAAM;AAC3B,UAAI,IAAI,eAAe,oBAAoB;AACvC,mBAAW;AAAA,UACP,QAAQ,IAAI;AAAA,UACZ,MAAM,IAAI;AAAA;AAAA,UAEV,IAAI,UAAU;AACV,mBAAO,qBAAqB,IAAI,sBAAsB,CAAC;AAAA,UAC3D;AAAA,QACJ,CAAC;AAAA,MACL;AAAA,IACJ;AAEA,QAAI,QAAQ,oBAAoB,IAAI,QAAQ;AACxC,UAAI,OAAO,aAAa,QAAQ;AAAA,IACpC;AAEA,QAAI,KAAK,QAAQ,QAAQ,QAAQ,KAAK,IAAI;AAE1C,eAAW,QAAQ,OAAO,KAAK,QAAQ,OAAO,GAAG;AAC7C,UAAI,iBAAiB,MAAM,QAAQ,QAAQ,IAAI,CAAC;AAAA,IACpD;AAEA,QAAI,KAAK,QAAQ,IAAI;AAAA,EACzB;AACJ;AAEA,SAAS,qBAAqB,KAAgD;AAC1E,QAAM,UAAsC,CAAC;AAE7C,aAAW,SAAS,OAAO,IAAI,MAAM,OAAO,GAAG;AAC3C,UAAM,YAAY,KAAK,QAAQ,GAAG;AAClC,QAAI,YAAY,GAAG;AACf,cAAQ,KAAK,UAAU,GAAG,SAAS,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,KAAK,UAAU,YAAY,CAAC,EAAE,KAAK;AAAA,IACpG;AAAA,EACJ;AAEA,SAAO;AACX;",
6
+ "names": []
7
+ }
@@ -0,0 +1,54 @@
1
+ import {
2
+ utils
3
+ } from "./chunk-2ID24RPE.mjs";
4
+
5
+ // src/OrderProperty.ts
6
+ var OrderProperty = class {
7
+ /**
8
+ * Creates an order-by descriptor.
9
+ *
10
+ * The property path may include a trailing `asc` or `desc` direction.
11
+ * Without a direction, ascending order is used.
12
+ *
13
+ * @param propertyPath Property name, optionally followed by `asc` or `desc`.
14
+ * @param isDesc Explicit direction override when supplied.
15
+ * @throws Error If the property name is not a string or the direction is invalid.
16
+ */
17
+ constructor(propertyPath, isDesc = null) {
18
+ this.propertyPath = propertyPath;
19
+ this.isDesc = isDesc;
20
+ if (!utils.isString(propertyPath))
21
+ throw new Error("Property name is not a valid string");
22
+ propertyPath = propertyPath.trim();
23
+ const parts = propertyPath.split(" ");
24
+ if (parts.length > 1 && isDesc !== true && isDesc !== false) {
25
+ isDesc = parts[1].toLowerCase() == "desc";
26
+ if (!isDesc) {
27
+ const isAsc = parts[1].toLowerCase() == "asc";
28
+ if (!isAsc) {
29
+ throw new Error("the second word in the propertyPath must begin with 'desc' or 'asc'");
30
+ }
31
+ }
32
+ }
33
+ this.propertyPath = parts[0];
34
+ this.isDesc = isDesc;
35
+ }
36
+ /** Returns the property name without its direction. */
37
+ getPropertyPath() {
38
+ return this.propertyPath;
39
+ }
40
+ /** Returns `true` for descending order and `false` for ascending order. */
41
+ getDirection() {
42
+ return this.isDesc;
43
+ }
44
+ /** Returns the normalized `property direction` string used in `$orderby`. */
45
+ getValue() {
46
+ const direction = this.isDesc ? "desc" : "asc";
47
+ return this.propertyPath + " " + direction;
48
+ }
49
+ };
50
+
51
+ export {
52
+ OrderProperty
53
+ };
54
+ //# sourceMappingURL=chunk-YB2LMPUX.mjs.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../src/OrderProperty.ts"],
4
+ "sourcesContent": ["\uFEFFimport { utils } from \"./utils\";\n\n/**\n * Represents one validated OData order-by property and direction.\n */\nexport class OrderProperty {\n /**\n * Creates an order-by descriptor.\n *\n * The property path may include a trailing `asc` or `desc` direction.\n * Without a direction, ascending order is used.\n *\n * @param propertyPath Property name, optionally followed by `asc` or `desc`.\n * @param isDesc Explicit direction override when supplied.\n * @throws Error If the property name is not a string or the direction is invalid.\n */\n constructor(private propertyPath: string, private isDesc: boolean = null) {\n if (!utils.isString(propertyPath))\n throw new Error(\"Property name is not a valid string\");\n\n propertyPath = propertyPath.trim();\n\n const parts = propertyPath.split(\" \");\n // parts[0] is the propertyPath; [1] would be whether descending or not.\n if (parts.length > 1 && isDesc !== true && isDesc !== false) {\n isDesc = parts[1].toLowerCase() == \"desc\";\n if (!isDesc) {\n // isDesc is false but check to make sure its intended.\n const isAsc = parts[1].toLowerCase() == \"asc\";\n if (!isAsc) {\n throw new Error(\"the second word in the propertyPath must begin with 'desc' or 'asc'\");\n }\n }\n }\n\n this.propertyPath = parts[0];\n this.isDesc = isDesc;\n }\n\n /** Returns the property name without its direction. */\n getPropertyPath(): string {\n return this.propertyPath;\n }\n\n /** Returns `true` for descending order and `false` for ascending order. */\n getDirection(): boolean {\n return this.isDesc;\n }\n\n /** Returns the normalized `property direction` string used in `$orderby`. */\n getValue(): string {\n const direction = (this.isDesc) ? \"desc\" : \"asc\";\n return this.propertyPath + \" \" + direction;\n }\n}\n"],
5
+ "mappings": ";;;;;AAKO,IAAM,gBAAN,MAAoB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWvB,YAAoB,cAA8B,SAAkB,MAAM;AAAtD;AAA8B;AAC9C,QAAI,CAAC,MAAM,SAAS,YAAY;AAC5B,YAAM,IAAI,MAAM,qCAAqC;AAEzD,mBAAe,aAAa,KAAK;AAEjC,UAAM,QAAQ,aAAa,MAAM,GAAG;AAEpC,QAAI,MAAM,SAAS,KAAK,WAAW,QAAQ,WAAW,OAAO;AACzD,eAAS,MAAM,CAAC,EAAE,YAAY,KAAK;AACnC,UAAI,CAAC,QAAQ;AAET,cAAM,QAAQ,MAAM,CAAC,EAAE,YAAY,KAAK;AACxC,YAAI,CAAC,OAAO;AACR,gBAAM,IAAI,MAAM,qEAAqE;AAAA,QACzF;AAAA,MACJ;AAAA,IACJ;AAEA,SAAK,eAAe,MAAM,CAAC;AAC3B,SAAK,SAAS;AAAA,EAClB;AAAA;AAAA,EAGA,kBAA0B;AACtB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA,EAGA,eAAwB;AACpB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA,EAGA,WAAmB;AACf,UAAM,YAAa,KAAK,SAAU,SAAS;AAC3C,WAAO,KAAK,eAAe,MAAM;AAAA,EACrC;AACJ;",
6
+ "names": []
7
+ }
package/package.json CHANGED
@@ -1,41 +1,72 @@
1
1
  {
2
2
  "name": "@progress/sitefinity-webservices-sdk",
3
- "version": "1.1.15",
4
- "scripts": {
5
- "start": "webpack-dev-server --config config/webpack.dev.ts",
6
- "build:dev": "webpack --config config/webpack.dev.ts --progress --profile",
7
- "build:prod": "webpack --config config/webpack.prod.ts --progress --profile",
8
- "build:release": "npm run build:dev & npm run build:prod & npm run docs",
9
- "test": "karma start --single_run",
10
- "test:debug": "karma start",
11
- "docs": "typedoc",
12
- "lint": "eslint . --ext .ts",
13
- "lint:fix": "eslint . --ext .ts --fix"
3
+ "version": "2.0.0",
4
+ "description": "JavaScript SDK for the Sitefinity OData web services.",
5
+ "keywords": [
6
+ "sitefinity",
7
+ "progress",
8
+ "odata",
9
+ "rest",
10
+ "sdk",
11
+ "cms",
12
+ "web-services"
13
+ ],
14
+ "license": "MIT",
15
+ "author": "Progress Software Corporation",
16
+ "homepage": "https://github.com/Sitefinity/sitefinity-dx/tree/HEAD/sitefinity-webservices-sdk#readme",
17
+ "bugs": {
18
+ "url": "https://github.com/Sitefinity/sitefinity-dx/issues"
14
19
  },
15
- "devDependencies": {
16
- "@types/jasmine": "4.3.1",
17
- "@types/jasmine-ajax": "3.3.3",
18
- "@types/node": "18.13.0",
19
- "@typescript-eslint/eslint-plugin": "5.51.0",
20
- "@typescript-eslint/parser": "5.51.0",
21
- "eslint": "8.33.0",
22
- "html-webpack-plugin": "5.5.0",
23
- "jasmine": "4.3.0",
24
- "jasmine-ajax": "4.0.0",
25
- "jasmine-spec-reporter": "7.0.0",
26
- "karma": "6.4.1",
27
- "karma-chrome-launcher": "3.1.1",
28
- "karma-jasmine": "5.1.0",
29
- "karma-jasmine-ajax": "0.1.13",
30
- "karma-spec-reporter": "0.0.34",
31
- "karma-typescript": "5.5.3",
32
- "ts-loader": "9.4.2",
33
- "ts-node": "10.9.1",
34
- "typedoc": "0.23.24",
35
- "typescript": "4.8.2",
36
- "webpack": "5.98.0",
37
- "webpack-cli": "4.10.0",
38
- "webpack-dev-server": "4.10.1",
39
- "webpack-merge": "5.8.0"
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/Sitefinity/sitefinity-dx.git",
23
+ "directory": "sitefinity-webservices-sdk"
24
+ },
25
+ "type": "commonjs",
26
+ "engines": {
27
+ "node": ">=18"
28
+ },
29
+ "sideEffects": false,
30
+ "main": "./sitefinity-webservices-sdk.cjs",
31
+ "module": "./sitefinity-webservices-sdk.mjs",
32
+ "types": "./sitefinity-webservices-sdk.d.ts",
33
+ "exports": {
34
+ ".": {
35
+ "import": {
36
+ "types": "./sitefinity-webservices-sdk.d.mts",
37
+ "default": "./sitefinity-webservices-sdk.mjs"
38
+ },
39
+ "require": {
40
+ "types": "./sitefinity-webservices-sdk.d.ts",
41
+ "default": "./sitefinity-webservices-sdk.cjs"
42
+ }
43
+ },
44
+ "./browser-global": {
45
+ "types": "./sitefinity-webservices-sdk.global.d.ts",
46
+ "default": "./sitefinity-webservices-sdk.js"
47
+ },
48
+ "./package.json": "./package.json"
49
+ },
50
+ "files": [
51
+ "LICENSE.txt",
52
+ "README.md",
53
+ "sitefinity-webservices-sdk.cjs",
54
+ "sitefinity-webservices-sdk.cjs.map",
55
+ "sitefinity-webservices-sdk.d.ts",
56
+ "sitefinity-webservices-sdk.mjs",
57
+ "sitefinity-webservices-sdk.mjs.map",
58
+ "sitefinity-webservices-sdk.d.mts",
59
+ "sitefinity-webservices-sdk.js",
60
+ "sitefinity-webservices-sdk.js.map",
61
+ "sitefinity-webservices-sdk.min.js",
62
+ "sitefinity-webservices-sdk.global.d.ts",
63
+ "esm/chunks/**/*.mjs",
64
+ "esm/chunks/**/*.mjs.map",
65
+ "src/**/*.d.ts"
66
+ ],
67
+ "unpkg": "./sitefinity-webservices-sdk.min.js",
68
+ "jsdelivr": "./sitefinity-webservices-sdk.min.js",
69
+ "publishConfig": {
70
+ "access": "public"
40
71
  }
41
72
  }