@starlightcms/js-sdk 4.0.0-beta.2 → 4.0.0-beta.3

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 (304) hide show
  1. package/dist/index.cjs +397 -0
  2. package/dist/index.d.cts +5087 -0
  3. package/dist/index.d.cts.map +1 -0
  4. package/dist/index.d.mts +5087 -0
  5. package/dist/index.d.mts.map +1 -0
  6. package/dist/index.mjs +391 -0
  7. package/dist/index.mjs.map +1 -0
  8. package/package.json +18 -13
  9. package/dist/cjs/client.d.ts +0 -42
  10. package/dist/cjs/client.d.ts.map +0 -1
  11. package/dist/cjs/client.js +0 -145
  12. package/dist/cjs/client.js.map +0 -1
  13. package/dist/cjs/errors.d.ts +0 -40
  14. package/dist/cjs/errors.d.ts.map +0 -1
  15. package/dist/cjs/errors.js +0 -18
  16. package/dist/cjs/errors.js.map +0 -1
  17. package/dist/cjs/index.d.ts +0 -29
  18. package/dist/cjs/index.d.ts.map +0 -1
  19. package/dist/cjs/index.js +0 -47
  20. package/dist/cjs/index.js.map +0 -1
  21. package/dist/cjs/instances/Collection/index.d.ts +0 -5
  22. package/dist/cjs/instances/Collection/index.d.ts.map +0 -1
  23. package/dist/cjs/instances/Collection/index.js +0 -14
  24. package/dist/cjs/instances/Collection/index.js.map +0 -1
  25. package/dist/cjs/instances/Collection/types.d.ts +0 -79
  26. package/dist/cjs/instances/Collection/types.d.ts.map +0 -1
  27. package/dist/cjs/instances/Collection/types.js +0 -3
  28. package/dist/cjs/instances/Collection/types.js.map +0 -1
  29. package/dist/cjs/instances/Form/index.d.ts +0 -5
  30. package/dist/cjs/instances/Form/index.d.ts.map +0 -1
  31. package/dist/cjs/instances/Form/index.js +0 -14
  32. package/dist/cjs/instances/Form/index.js.map +0 -1
  33. package/dist/cjs/instances/Form/types.d.ts +0 -46
  34. package/dist/cjs/instances/Form/types.d.ts.map +0 -1
  35. package/dist/cjs/instances/Form/types.js +0 -3
  36. package/dist/cjs/instances/Form/types.js.map +0 -1
  37. package/dist/cjs/instances/Model/index.d.ts +0 -5
  38. package/dist/cjs/instances/Model/index.d.ts.map +0 -1
  39. package/dist/cjs/instances/Model/index.js +0 -34
  40. package/dist/cjs/instances/Model/index.js.map +0 -1
  41. package/dist/cjs/instances/Model/types.d.ts +0 -102
  42. package/dist/cjs/instances/Model/types.d.ts.map +0 -1
  43. package/dist/cjs/instances/Model/types.js +0 -3
  44. package/dist/cjs/instances/Model/types.js.map +0 -1
  45. package/dist/cjs/instances/ModelCategory/index.d.ts +0 -5
  46. package/dist/cjs/instances/ModelCategory/index.d.ts.map +0 -1
  47. package/dist/cjs/instances/ModelCategory/index.js +0 -14
  48. package/dist/cjs/instances/ModelCategory/index.js.map +0 -1
  49. package/dist/cjs/instances/ModelCategory/types.d.ts +0 -76
  50. package/dist/cjs/instances/ModelCategory/types.d.ts.map +0 -1
  51. package/dist/cjs/instances/ModelCategory/types.js +0 -3
  52. package/dist/cjs/instances/ModelCategory/types.js.map +0 -1
  53. package/dist/cjs/selectors/Collection/index.d.ts +0 -5
  54. package/dist/cjs/selectors/Collection/index.d.ts.map +0 -1
  55. package/dist/cjs/selectors/Collection/index.js +0 -26
  56. package/dist/cjs/selectors/Collection/index.js.map +0 -1
  57. package/dist/cjs/selectors/Collection/types.d.ts +0 -98
  58. package/dist/cjs/selectors/Collection/types.d.ts.map +0 -1
  59. package/dist/cjs/selectors/Collection/types.js +0 -3
  60. package/dist/cjs/selectors/Collection/types.js.map +0 -1
  61. package/dist/cjs/selectors/Entry/index.d.ts +0 -5
  62. package/dist/cjs/selectors/Entry/index.d.ts.map +0 -1
  63. package/dist/cjs/selectors/Entry/index.js +0 -14
  64. package/dist/cjs/selectors/Entry/index.js.map +0 -1
  65. package/dist/cjs/selectors/Entry/types.d.ts +0 -138
  66. package/dist/cjs/selectors/Entry/types.d.ts.map +0 -1
  67. package/dist/cjs/selectors/Entry/types.js +0 -3
  68. package/dist/cjs/selectors/Entry/types.js.map +0 -1
  69. package/dist/cjs/selectors/Form/index.d.ts +0 -4
  70. package/dist/cjs/selectors/Form/index.d.ts.map +0 -1
  71. package/dist/cjs/selectors/Form/index.js +0 -18
  72. package/dist/cjs/selectors/Form/index.js.map +0 -1
  73. package/dist/cjs/selectors/Form/types.d.ts +0 -22
  74. package/dist/cjs/selectors/Form/types.d.ts.map +0 -1
  75. package/dist/cjs/selectors/Form/types.js +0 -3
  76. package/dist/cjs/selectors/Form/types.js.map +0 -1
  77. package/dist/cjs/selectors/Media/index.d.ts +0 -5
  78. package/dist/cjs/selectors/Media/index.d.ts.map +0 -1
  79. package/dist/cjs/selectors/Media/index.js +0 -14
  80. package/dist/cjs/selectors/Media/index.js.map +0 -1
  81. package/dist/cjs/selectors/Media/types.d.ts +0 -49
  82. package/dist/cjs/selectors/Media/types.d.ts.map +0 -1
  83. package/dist/cjs/selectors/Media/types.js +0 -3
  84. package/dist/cjs/selectors/Media/types.js.map +0 -1
  85. package/dist/cjs/selectors/Model/index.d.ts +0 -5
  86. package/dist/cjs/selectors/Model/index.d.ts.map +0 -1
  87. package/dist/cjs/selectors/Model/index.js +0 -26
  88. package/dist/cjs/selectors/Model/index.js.map +0 -1
  89. package/dist/cjs/selectors/Model/types.d.ts +0 -78
  90. package/dist/cjs/selectors/Model/types.d.ts.map +0 -1
  91. package/dist/cjs/selectors/Model/types.js +0 -3
  92. package/dist/cjs/selectors/Model/types.js.map +0 -1
  93. package/dist/cjs/selectors/ModelCategory/index.d.ts +0 -5
  94. package/dist/cjs/selectors/ModelCategory/index.d.ts.map +0 -1
  95. package/dist/cjs/selectors/ModelCategory/index.js +0 -26
  96. package/dist/cjs/selectors/ModelCategory/index.js.map +0 -1
  97. package/dist/cjs/selectors/ModelCategory/types.d.ts +0 -87
  98. package/dist/cjs/selectors/ModelCategory/types.d.ts.map +0 -1
  99. package/dist/cjs/selectors/ModelCategory/types.js +0 -3
  100. package/dist/cjs/selectors/ModelCategory/types.js.map +0 -1
  101. package/dist/cjs/selectors/Search/index.d.ts +0 -5
  102. package/dist/cjs/selectors/Search/index.d.ts.map +0 -1
  103. package/dist/cjs/selectors/Search/index.js +0 -11
  104. package/dist/cjs/selectors/Search/index.js.map +0 -1
  105. package/dist/cjs/selectors/Search/types.d.ts +0 -90
  106. package/dist/cjs/selectors/Search/types.d.ts.map +0 -1
  107. package/dist/cjs/selectors/Search/types.js +0 -3
  108. package/dist/cjs/selectors/Search/types.js.map +0 -1
  109. package/dist/cjs/selectors/Singleton/index.d.ts +0 -5
  110. package/dist/cjs/selectors/Singleton/index.d.ts.map +0 -1
  111. package/dist/cjs/selectors/Singleton/index.js +0 -14
  112. package/dist/cjs/selectors/Singleton/index.js.map +0 -1
  113. package/dist/cjs/selectors/Singleton/types.d.ts +0 -64
  114. package/dist/cjs/selectors/Singleton/types.d.ts.map +0 -1
  115. package/dist/cjs/selectors/Singleton/types.js +0 -3
  116. package/dist/cjs/selectors/Singleton/types.js.map +0 -1
  117. package/dist/cjs/types/entities.d.ts +0 -362
  118. package/dist/cjs/types/entities.d.ts.map +0 -1
  119. package/dist/cjs/types/entities.js +0 -3
  120. package/dist/cjs/types/entities.js.map +0 -1
  121. package/dist/cjs/types/fields.d.ts +0 -123
  122. package/dist/cjs/types/fields.d.ts.map +0 -1
  123. package/dist/cjs/types/fields.js +0 -3
  124. package/dist/cjs/types/fields.js.map +0 -1
  125. package/dist/cjs/types/groups.d.ts +0 -30
  126. package/dist/cjs/types/groups.d.ts.map +0 -1
  127. package/dist/cjs/types/groups.js +0 -3
  128. package/dist/cjs/types/groups.js.map +0 -1
  129. package/dist/cjs/types/index.d.ts +0 -629
  130. package/dist/cjs/types/index.d.ts.map +0 -1
  131. package/dist/cjs/types/index.js +0 -24
  132. package/dist/cjs/types/index.js.map +0 -1
  133. package/dist/cjs/types/instances.d.ts +0 -4
  134. package/dist/cjs/types/instances.d.ts.map +0 -1
  135. package/dist/cjs/types/instances.js +0 -3
  136. package/dist/cjs/types/instances.js.map +0 -1
  137. package/dist/cjs/types/selectors.d.ts +0 -8
  138. package/dist/cjs/types/selectors.d.ts.map +0 -1
  139. package/dist/cjs/types/selectors.js +0 -3
  140. package/dist/cjs/types/selectors.js.map +0 -1
  141. package/dist/cjs/types/utilities.d.ts +0 -83
  142. package/dist/cjs/types/utilities.d.ts.map +0 -1
  143. package/dist/cjs/types/utilities.js +0 -3
  144. package/dist/cjs/types/utilities.js.map +0 -1
  145. package/dist/cjs/types/visual.d.ts +0 -185
  146. package/dist/cjs/types/visual.d.ts.map +0 -1
  147. package/dist/cjs/types/visual.js +0 -3
  148. package/dist/cjs/types/visual.js.map +0 -1
  149. package/dist/cjs/utils/image.d.ts +0 -72
  150. package/dist/cjs/utils/image.d.ts.map +0 -1
  151. package/dist/cjs/utils/image.js +0 -101
  152. package/dist/cjs/utils/image.js.map +0 -1
  153. package/dist/cjs/utils/index.d.ts +0 -2
  154. package/dist/cjs/utils/index.d.ts.map +0 -1
  155. package/dist/cjs/utils/index.js +0 -18
  156. package/dist/cjs/utils/index.js.map +0 -1
  157. package/dist/esm/client.d.ts +0 -42
  158. package/dist/esm/client.d.ts.map +0 -1
  159. package/dist/esm/client.js +0 -139
  160. package/dist/esm/client.js.map +0 -1
  161. package/dist/esm/errors.d.ts +0 -40
  162. package/dist/esm/errors.d.ts.map +0 -1
  163. package/dist/esm/errors.js +0 -14
  164. package/dist/esm/errors.js.map +0 -1
  165. package/dist/esm/index.d.ts +0 -29
  166. package/dist/esm/index.d.ts.map +0 -1
  167. package/dist/esm/index.js +0 -29
  168. package/dist/esm/index.js.map +0 -1
  169. package/dist/esm/instances/Collection/index.d.ts +0 -5
  170. package/dist/esm/instances/Collection/index.d.ts.map +0 -1
  171. package/dist/esm/instances/Collection/index.js +0 -11
  172. package/dist/esm/instances/Collection/index.js.map +0 -1
  173. package/dist/esm/instances/Collection/types.d.ts +0 -79
  174. package/dist/esm/instances/Collection/types.d.ts.map +0 -1
  175. package/dist/esm/instances/Collection/types.js +0 -2
  176. package/dist/esm/instances/Collection/types.js.map +0 -1
  177. package/dist/esm/instances/Form/index.d.ts +0 -5
  178. package/dist/esm/instances/Form/index.d.ts.map +0 -1
  179. package/dist/esm/instances/Form/index.js +0 -11
  180. package/dist/esm/instances/Form/index.js.map +0 -1
  181. package/dist/esm/instances/Form/types.d.ts +0 -46
  182. package/dist/esm/instances/Form/types.d.ts.map +0 -1
  183. package/dist/esm/instances/Form/types.js +0 -2
  184. package/dist/esm/instances/Form/types.js.map +0 -1
  185. package/dist/esm/instances/Model/index.d.ts +0 -5
  186. package/dist/esm/instances/Model/index.d.ts.map +0 -1
  187. package/dist/esm/instances/Model/index.js +0 -28
  188. package/dist/esm/instances/Model/index.js.map +0 -1
  189. package/dist/esm/instances/Model/types.d.ts +0 -102
  190. package/dist/esm/instances/Model/types.d.ts.map +0 -1
  191. package/dist/esm/instances/Model/types.js +0 -2
  192. package/dist/esm/instances/Model/types.js.map +0 -1
  193. package/dist/esm/instances/ModelCategory/index.d.ts +0 -5
  194. package/dist/esm/instances/ModelCategory/index.d.ts.map +0 -1
  195. package/dist/esm/instances/ModelCategory/index.js +0 -11
  196. package/dist/esm/instances/ModelCategory/index.js.map +0 -1
  197. package/dist/esm/instances/ModelCategory/types.d.ts +0 -76
  198. package/dist/esm/instances/ModelCategory/types.d.ts.map +0 -1
  199. package/dist/esm/instances/ModelCategory/types.js +0 -2
  200. package/dist/esm/instances/ModelCategory/types.js.map +0 -1
  201. package/dist/esm/selectors/Collection/index.d.ts +0 -5
  202. package/dist/esm/selectors/Collection/index.d.ts.map +0 -1
  203. package/dist/esm/selectors/Collection/index.js +0 -20
  204. package/dist/esm/selectors/Collection/index.js.map +0 -1
  205. package/dist/esm/selectors/Collection/types.d.ts +0 -98
  206. package/dist/esm/selectors/Collection/types.d.ts.map +0 -1
  207. package/dist/esm/selectors/Collection/types.js +0 -2
  208. package/dist/esm/selectors/Collection/types.js.map +0 -1
  209. package/dist/esm/selectors/Entry/index.d.ts +0 -5
  210. package/dist/esm/selectors/Entry/index.d.ts.map +0 -1
  211. package/dist/esm/selectors/Entry/index.js +0 -11
  212. package/dist/esm/selectors/Entry/index.js.map +0 -1
  213. package/dist/esm/selectors/Entry/types.d.ts +0 -138
  214. package/dist/esm/selectors/Entry/types.d.ts.map +0 -1
  215. package/dist/esm/selectors/Entry/types.js +0 -2
  216. package/dist/esm/selectors/Entry/types.js.map +0 -1
  217. package/dist/esm/selectors/Form/index.d.ts +0 -4
  218. package/dist/esm/selectors/Form/index.d.ts.map +0 -1
  219. package/dist/esm/selectors/Form/index.js +0 -12
  220. package/dist/esm/selectors/Form/index.js.map +0 -1
  221. package/dist/esm/selectors/Form/types.d.ts +0 -22
  222. package/dist/esm/selectors/Form/types.d.ts.map +0 -1
  223. package/dist/esm/selectors/Form/types.js +0 -2
  224. package/dist/esm/selectors/Form/types.js.map +0 -1
  225. package/dist/esm/selectors/Media/index.d.ts +0 -5
  226. package/dist/esm/selectors/Media/index.d.ts.map +0 -1
  227. package/dist/esm/selectors/Media/index.js +0 -11
  228. package/dist/esm/selectors/Media/index.js.map +0 -1
  229. package/dist/esm/selectors/Media/types.d.ts +0 -49
  230. package/dist/esm/selectors/Media/types.d.ts.map +0 -1
  231. package/dist/esm/selectors/Media/types.js +0 -2
  232. package/dist/esm/selectors/Media/types.js.map +0 -1
  233. package/dist/esm/selectors/Model/index.d.ts +0 -5
  234. package/dist/esm/selectors/Model/index.d.ts.map +0 -1
  235. package/dist/esm/selectors/Model/index.js +0 -20
  236. package/dist/esm/selectors/Model/index.js.map +0 -1
  237. package/dist/esm/selectors/Model/types.d.ts +0 -78
  238. package/dist/esm/selectors/Model/types.d.ts.map +0 -1
  239. package/dist/esm/selectors/Model/types.js +0 -2
  240. package/dist/esm/selectors/Model/types.js.map +0 -1
  241. package/dist/esm/selectors/ModelCategory/index.d.ts +0 -5
  242. package/dist/esm/selectors/ModelCategory/index.d.ts.map +0 -1
  243. package/dist/esm/selectors/ModelCategory/index.js +0 -20
  244. package/dist/esm/selectors/ModelCategory/index.js.map +0 -1
  245. package/dist/esm/selectors/ModelCategory/types.d.ts +0 -87
  246. package/dist/esm/selectors/ModelCategory/types.d.ts.map +0 -1
  247. package/dist/esm/selectors/ModelCategory/types.js +0 -2
  248. package/dist/esm/selectors/ModelCategory/types.js.map +0 -1
  249. package/dist/esm/selectors/Search/index.d.ts +0 -5
  250. package/dist/esm/selectors/Search/index.d.ts.map +0 -1
  251. package/dist/esm/selectors/Search/index.js +0 -8
  252. package/dist/esm/selectors/Search/index.js.map +0 -1
  253. package/dist/esm/selectors/Search/types.d.ts +0 -90
  254. package/dist/esm/selectors/Search/types.d.ts.map +0 -1
  255. package/dist/esm/selectors/Search/types.js +0 -2
  256. package/dist/esm/selectors/Search/types.js.map +0 -1
  257. package/dist/esm/selectors/Singleton/index.d.ts +0 -5
  258. package/dist/esm/selectors/Singleton/index.d.ts.map +0 -1
  259. package/dist/esm/selectors/Singleton/index.js +0 -11
  260. package/dist/esm/selectors/Singleton/index.js.map +0 -1
  261. package/dist/esm/selectors/Singleton/types.d.ts +0 -64
  262. package/dist/esm/selectors/Singleton/types.d.ts.map +0 -1
  263. package/dist/esm/selectors/Singleton/types.js +0 -2
  264. package/dist/esm/selectors/Singleton/types.js.map +0 -1
  265. package/dist/esm/types/entities.d.ts +0 -362
  266. package/dist/esm/types/entities.d.ts.map +0 -1
  267. package/dist/esm/types/entities.js +0 -2
  268. package/dist/esm/types/entities.js.map +0 -1
  269. package/dist/esm/types/fields.d.ts +0 -123
  270. package/dist/esm/types/fields.d.ts.map +0 -1
  271. package/dist/esm/types/fields.js +0 -2
  272. package/dist/esm/types/fields.js.map +0 -1
  273. package/dist/esm/types/groups.d.ts +0 -30
  274. package/dist/esm/types/groups.d.ts.map +0 -1
  275. package/dist/esm/types/groups.js +0 -2
  276. package/dist/esm/types/groups.js.map +0 -1
  277. package/dist/esm/types/index.d.ts +0 -629
  278. package/dist/esm/types/index.d.ts.map +0 -1
  279. package/dist/esm/types/index.js +0 -8
  280. package/dist/esm/types/index.js.map +0 -1
  281. package/dist/esm/types/instances.d.ts +0 -4
  282. package/dist/esm/types/instances.d.ts.map +0 -1
  283. package/dist/esm/types/instances.js +0 -2
  284. package/dist/esm/types/instances.js.map +0 -1
  285. package/dist/esm/types/selectors.d.ts +0 -8
  286. package/dist/esm/types/selectors.d.ts.map +0 -1
  287. package/dist/esm/types/selectors.js +0 -2
  288. package/dist/esm/types/selectors.js.map +0 -1
  289. package/dist/esm/types/utilities.d.ts +0 -83
  290. package/dist/esm/types/utilities.d.ts.map +0 -1
  291. package/dist/esm/types/utilities.js +0 -2
  292. package/dist/esm/types/utilities.js.map +0 -1
  293. package/dist/esm/types/visual.d.ts +0 -185
  294. package/dist/esm/types/visual.d.ts.map +0 -1
  295. package/dist/esm/types/visual.js +0 -2
  296. package/dist/esm/types/visual.js.map +0 -1
  297. package/dist/esm/utils/image.d.ts +0 -72
  298. package/dist/esm/utils/image.d.ts.map +0 -1
  299. package/dist/esm/utils/image.js +0 -96
  300. package/dist/esm/utils/image.js.map +0 -1
  301. package/dist/esm/utils/index.d.ts +0 -2
  302. package/dist/esm/utils/index.d.ts.map +0 -1
  303. package/dist/esm/utils/index.js +0 -2
  304. package/dist/esm/utils/index.js.map +0 -1
@@ -1,102 +0,0 @@
1
- import { BaseRequestParameters, Model, SerializedData, StarlightItemResponse } from '../../types';
2
- import { EntrySelector } from '../../selectors/Entry';
3
- import { DynamicModelCategorySelector } from '../../selectors/ModelCategory';
4
- import { ModelCategoryInstance } from '../ModelCategory';
5
- /**
6
- * An Instance that provide methods to request information from a {@link Model},
7
- * its {@apilink Entry | Entries}, and its {@apilink ModelCategory | Categories}.
8
- *
9
- * You can access a ModelInstance using {@apilink StarlightClient.model} or
10
- * using the dynamic syntax on a {@link DynamicStarlightClient}. Usage
11
- * examples will use the dynamic syntax.
12
- *
13
- * To list all workspace models, use a {@link ModelSelector}.
14
- *
15
- * @group Instances
16
- */
17
- export interface ModelInstance<D extends SerializedData> {
18
- /**
19
- * Returns a {@link StarlightItemResponse} with a single {@link Model}.
20
- *
21
- * @example Requesting information from a model of slug `posts`.
22
- * ```ts
23
- * import Starlight from '@starlightcms/js-sdk'
24
- *
25
- * const response = await Starlight.posts.get()
26
- * ```
27
- *
28
- * @param params An optional object of request parameters.
29
- * @param options An optional object of fetch options. See
30
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
31
- * more info.
32
- */
33
- get(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<Model>>;
34
- /**
35
- * Returns a {@link ModelCategoryInstance}.
36
- *
37
- * If you're using a {@link DynamicModelInstance}, you can use the
38
- * dynamic syntax instead of this method.
39
- *
40
- * @example Listing all entries from the "news" category of a model of slug "posts".
41
- * ```ts
42
- * import Starlight from '@starlightcms/js-sdk'
43
- *
44
- * const response = await Starlight.posts.category('news').entries()
45
- * ```
46
- *
47
- * @param slug The category slug.
48
- */
49
- category(slug: string): ModelCategoryInstance<D>;
50
- /**
51
- * Returns an {@link EntrySelector}.
52
- *
53
- * This is an accessor, which means that it should be used just like a common
54
- * object parameter. For instance:
55
- *
56
- * ```ts
57
- * import Starlight from '@starlightcms/js-sdk'
58
- *
59
- * // "entries" below is an EntrySelector.
60
- * const response = await Starlight.posts.entries.list()
61
- * ```
62
- */
63
- get entries(): EntrySelector<D>;
64
- /**
65
- * Returns a {@link DynamicModelCategorySelector}.
66
- *
67
- * This is an accessor, which means that it should be used just like a common
68
- * object parameter. For instance:
69
- *
70
- * ```ts
71
- * import Starlight from '@starlightcms/js-sdk'
72
- *
73
- * // "categories" below is a DynamicModelCategorySelector.
74
- * const response = await Starlight.posts.categories.get('interviews')
75
- * ```
76
- */
77
- get categories(): DynamicModelCategorySelector<D>;
78
- }
79
- /**
80
- * An Instance that provide all {@link ModelInstance} methods and adds support
81
- * for creating {@apilink ModelCategoryInstance | ModelCategoryInstances} using
82
- * the dynamic syntax.
83
- *
84
- * See {@link ModelInstance} to view all available methods.
85
- *
86
- * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}
87
- * documentation to learn more about the dynamic syntax.
88
- *
89
- * @example Accessing a ModelCategoryInstance using the dynamic syntax.
90
- * ```ts
91
- * import Starlight from '@starlightcms/js-sdk'
92
- *
93
- * // "articles" below will be a ModelCategoryInstance.
94
- * const response = await Starlight.posts.articles.list()
95
- * ```
96
- *
97
- * @category Instances
98
- */
99
- export type DynamicModelInstance<D extends SerializedData> = ModelInstance<D> & {
100
- [key: string]: ModelCategoryInstance<D>;
101
- };
102
- //# sourceMappingURL=types.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,cAAc,EACd,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAExD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD;;;;;;;;;;;;;;OAcG;IACH,GAAG,CACD,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;IAEhD;;;;;;;;;;;;OAYG;IACH,IAAI,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,CAAA;IAE/B;;;;;;;;;;;;OAYG;IACH,IAAI,UAAU,IAAI,4BAA4B,CAAC,CAAC,CAAC,CAAA;CAClD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,cAAc,IACvD,aAAa,CAAC,CAAC,CAAC,GAAG;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACxC,CAAA"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n Model,\n SerializedData,\n StarlightItemResponse,\n} from '../../types'\nimport { EntrySelector } from '../../selectors/Entry'\nimport { DynamicModelCategorySelector } from '../../selectors/ModelCategory'\nimport { ModelCategoryInstance } from '../ModelCategory'\n\n/**\n * An Instance that provide methods to request information from a {@link Model},\n * its {@apilink Entry | Entries}, and its {@apilink ModelCategory | Categories}.\n *\n * You can access a ModelInstance using {@apilink StarlightClient.model} or\n * using the dynamic syntax on a {@link DynamicStarlightClient}. Usage\n * examples will use the dynamic syntax.\n *\n * To list all workspace models, use a {@link ModelSelector}.\n *\n * @group Instances\n */\nexport interface ModelInstance<D extends SerializedData> {\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link Model}.\n *\n * @example Requesting information from a model of slug `posts`.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.get()\n * ```\n *\n * @param params An optional object of request parameters.\n * @param options An optional object of fetch options. See\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n * more info.\n */\n get(\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<Model>>\n\n /**\n * Returns a {@link ModelCategoryInstance}.\n *\n * If you're using a {@link DynamicModelInstance}, you can use the\n * dynamic syntax instead of this method.\n *\n * @example Listing all entries from the \"news\" category of a model of slug \"posts\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.category('news').entries()\n * ```\n *\n * @param slug The category slug.\n */\n category(slug: string): ModelCategoryInstance<D>\n\n /**\n * Returns an {@link EntrySelector}.\n *\n * This is an accessor, which means that it should be used just like a common\n * object parameter. For instance:\n *\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"entries\" below is an EntrySelector.\n * const response = await Starlight.posts.entries.list()\n * ```\n */\n get entries(): EntrySelector<D>\n\n /**\n * Returns a {@link DynamicModelCategorySelector}.\n *\n * This is an accessor, which means that it should be used just like a common\n * object parameter. For instance:\n *\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"categories\" below is a DynamicModelCategorySelector.\n * const response = await Starlight.posts.categories.get('interviews')\n * ```\n */\n get categories(): DynamicModelCategorySelector<D>\n}\n\n/**\n * An Instance that provide all {@link ModelInstance} methods and adds support\n * for creating {@apilink ModelCategoryInstance | ModelCategoryInstances} using\n * the dynamic syntax.\n *\n * See {@link ModelInstance} to view all available methods.\n *\n * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}\n * documentation to learn more about the dynamic syntax.\n *\n * @example Accessing a ModelCategoryInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"articles\" below will be a ModelCategoryInstance.\n * const response = await Starlight.posts.articles.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicModelInstance<D extends SerializedData> =\n ModelInstance<D> & {\n [key: string]: ModelCategoryInstance<D>\n }\n"]}
@@ -1,5 +0,0 @@
1
- import { SerializedData, StarlightClient } from '../../types';
2
- import { ModelCategoryEntryListParams, ModelCategoryInstance } from './types';
3
- export default function makeModelCategoryInstance<D extends SerializedData>(client: StarlightClient, model: string, category: string): ModelCategoryInstance<D>;
4
- export { ModelCategoryInstance, ModelCategoryEntryListParams };
5
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7D,OAAO,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE7E,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,CAAC,SAAS,cAAc,EACxE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,qBAAqB,CAAC,CAAC,CAAC,CAiB1B;AAED,OAAO,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,CAAA"}
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = makeModelCategoryInstance;
4
- function makeModelCategoryInstance(client, model, category) {
5
- return {
6
- get(params, options) {
7
- return client.get(`/models/${model}/categories/${category}`, params, options);
8
- },
9
- entries(params, options) {
10
- return client.get(`/models/${model}/categories/${category}/entries`, params, options);
11
- },
12
- };
13
- }
14
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":";;AAGA,4CAqBC;AArBD,SAAwB,yBAAyB,CAC/C,MAAuB,EACvB,KAAa,EACb,QAAgB;IAEhB,OAAO;QACL,GAAG,CAAC,MAAM,EAAE,OAAO;YACjB,OAAO,MAAM,CAAC,GAAG,CACf,WAAW,KAAK,eAAe,QAAQ,EAAE,EACzC,MAAM,EACN,OAAO,CACR,CAAA;QACH,CAAC;QACD,OAAO,CAAC,MAAM,EAAE,OAAO;YACrB,OAAO,MAAM,CAAC,GAAG,CACf,WAAW,KAAK,eAAe,QAAQ,UAAU,EACjD,MAAM,EACN,OAAO,CACR,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { SerializedData, StarlightClient } from '../../types'\nimport { ModelCategoryEntryListParams, ModelCategoryInstance } from './types'\n\nexport default function makeModelCategoryInstance<D extends SerializedData>(\n client: StarlightClient,\n model: string,\n category: string,\n): ModelCategoryInstance<D> {\n return {\n get(params, options) {\n return client.get(\n `/models/${model}/categories/${category}`,\n params,\n options,\n )\n },\n entries(params, options) {\n return client.get(\n `/models/${model}/categories/${category}/entries`,\n params,\n options,\n )\n },\n }\n}\n\nexport { ModelCategoryInstance, ModelCategoryEntryListParams }\n"]}
@@ -1,76 +0,0 @@
1
- import { ListRequestParameters, Entry, ModelCategory, QueryableFields, QueryableRequestParameters, SerializedData, StarlightItemResponse, StarlightListResponse, BaseRequestParameters } from '../../types';
2
- /**
3
- * Request parameters for listing category entries.
4
- *
5
- * Used by {@apilink ModelCategoryInstance.entries}.
6
- *
7
- * @group Request Parameters
8
- */
9
- export interface ModelCategoryEntryListParams extends ListRequestParameters, QueryableRequestParameters {
10
- /**
11
- * Define how entries will be ordered. Check this field type to see the
12
- * allowed options.
13
- */
14
- order?: 'title:asc' | 'title:desc' | 'published_at:asc' | 'published_at:desc' | 'views:asc' | 'views:desc';
15
- }
16
- /**
17
- * An Instance that provide methods to request information from a
18
- * {@link ModelCategory} and its {@apilink Entry | Entries}.
19
- *
20
- * You can access a ModelCategoryInstance using
21
- * {@apilink ModelInstance.category} or using the dynamic syntax on a
22
- * {@link DynamicModelInstance}. Usage examples will use the dynamic syntax.
23
- *
24
- * To list all categories from a model, use a {@link ModelCategorySelector}.
25
- *
26
- * @group Instances
27
- */
28
- export interface ModelCategoryInstance<D extends SerializedData> {
29
- /**
30
- * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.
31
- *
32
- * @example Requesting information from a category called "articles" in a model of slug "posts".
33
- * ```ts
34
- * import Starlight from '@starlightcms/js-sdk'
35
- *
36
- * const response = await Starlight.posts.articles.get()
37
- * ```
38
- *
39
- * @param params An optional object of request parameters.
40
- * @param options An optional object of fetch options. See
41
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
42
- * more info.
43
- */
44
- get(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<ModelCategory>>;
45
- /**
46
- * Returns a {@link StarlightListResponse} with the list of entries of this
47
- * {@link ModelCategory}.
48
- *
49
- * @example Requesting all items from a category called "gaming" in a model of slug "posts".
50
- * ```ts
51
- * import Starlight from '@starlightcms/js-sdk'
52
- *
53
- * const response = await Starlight.posts.gaming.items()
54
- * ```
55
- *
56
- * @example Paginating and searching on the last example.
57
- * ```ts
58
- * import Starlight from '@starlightcms/js-sdk'
59
- *
60
- * const response = await Starlight.posts.gaming.items({
61
- * page: 5,
62
- * query: 'kirby'
63
- * })
64
- * ```
65
- *
66
- * @param params An optional object of request parameters. See
67
- * {@link ModelCategoryEntryListParams} for all available parameters.
68
- * `field:foo` syntax is also supported, see {@link QueryableFields}
69
- * for more info.
70
- * @param options An optional object of fetch options. See
71
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
72
- * more info.
73
- */
74
- entries(params?: ModelCategoryEntryListParams & QueryableFields<D>, options?: RequestInit): Promise<StarlightListResponse<Entry<D>>>;
75
- }
76
- //# sourceMappingURL=types.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,aAAa,EACb,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,4BACf,SAAQ,qBAAqB,EAAE,0BAA0B;IACzD;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;CACjB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,cAAc;IAC7D;;;;;;;;;;;;;;OAcG;IACH,GAAG,CACD,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CACL,MAAM,CAAC,EAAE,4BAA4B,GAAG,eAAe,CAAC,CAAC,CAAC,EAC1D,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n ListRequestParameters,\n Entry,\n ModelCategory,\n QueryableFields,\n QueryableRequestParameters,\n SerializedData,\n StarlightItemResponse,\n StarlightListResponse,\n BaseRequestParameters,\n} from '../../types'\n\n/**\n * Request parameters for listing category entries.\n *\n * Used by {@apilink ModelCategoryInstance.entries}.\n *\n * @group Request Parameters\n */\nexport interface ModelCategoryEntryListParams\n extends ListRequestParameters, QueryableRequestParameters {\n /**\n * Define how entries will be ordered. Check this field type to see the\n * allowed options.\n */\n order?:\n | 'title:asc'\n | 'title:desc'\n | 'published_at:asc'\n | 'published_at:desc'\n | 'views:asc'\n | 'views:desc'\n}\n\n/**\n * An Instance that provide methods to request information from a\n * {@link ModelCategory} and its {@apilink Entry | Entries}.\n *\n * You can access a ModelCategoryInstance using\n * {@apilink ModelInstance.category} or using the dynamic syntax on a\n * {@link DynamicModelInstance}. Usage examples will use the dynamic syntax.\n *\n * To list all categories from a model, use a {@link ModelCategorySelector}.\n *\n * @group Instances\n */\nexport interface ModelCategoryInstance<D extends SerializedData> {\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.\n *\n * @example Requesting information from a category called \"articles\" in a model of slug \"posts\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.articles.get()\n * ```\n *\n * @param params An optional object of request parameters.\n * @param options An optional object of fetch options. See\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n * more info.\n */\n get(\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<ModelCategory>>\n\n /**\n * Returns a {@link StarlightListResponse} with the list of entries of this\n * {@link ModelCategory}.\n *\n * @example Requesting all items from a category called \"gaming\" in a model of slug \"posts\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.gaming.items()\n * ```\n *\n * @example Paginating and searching on the last example.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.gaming.items({\n * page: 5,\n * query: 'kirby'\n * })\n * ```\n *\n * @param params An optional object of request parameters. See\n * {@link ModelCategoryEntryListParams} for all available parameters.\n * `field:foo` syntax is also supported, see {@link QueryableFields}\n * for more info.\n * @param options An optional object of fetch options. See\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n * more info.\n */\n entries(\n params?: ModelCategoryEntryListParams & QueryableFields<D>,\n options?: RequestInit,\n ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}
@@ -1,5 +0,0 @@
1
- import { StarlightClient } from '../../types';
2
- import { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams } from './types';
3
- export default function makeCollectionSelector(client: StarlightClient): DynamicCollectionSelector;
4
- export { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams };
5
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAGhB,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,MAAM,EAAE,eAAe,GACtB,yBAAyB,CAoB3B;AAED,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,CAAA"}
@@ -1,26 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.default = makeCollectionSelector;
7
- const Collection_1 = __importDefault(require("../../instances/Collection"));
8
- function makeCollectionSelector(client) {
9
- const selector = {
10
- list(params, options) {
11
- return client.get('/collections', params, options);
12
- },
13
- get(slug, params, options) {
14
- return client.get(`/collections/${slug}`, params, options);
15
- },
16
- };
17
- return new Proxy(selector, {
18
- get(target, prop) {
19
- if (typeof prop === 'string' && !Reflect.has(target, prop)) {
20
- return (0, Collection_1.default)(client, prop);
21
- }
22
- return Reflect.get(target, prop);
23
- },
24
- });
25
- }
26
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":";;;;;AAQA,yCAsBC;AAxBD,4EAA+D;AAE/D,SAAwB,sBAAsB,CAC5C,MAAuB;IAEvB,MAAM,QAAQ,GAAuB;QACnC,IAAI,CAAC,MAAM,EAAE,OAAO;YAClB,OAAO,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACpD,CAAC;QAED,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO;YACvB,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC5D,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QACzB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC3D,OAAO,IAAA,oBAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;YAC7C,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA8B,CAAA;AACjC,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport {\n CollectionSelector,\n DynamicCollectionSelector,\n ListCollectionsParams,\n} from './types'\nimport makeCollectionInstance from '../../instances/Collection'\n\nexport default function makeCollectionSelector(\n client: StarlightClient,\n): DynamicCollectionSelector {\n const selector: CollectionSelector = {\n list(params, options) {\n return client.get('/collections', params, options)\n },\n\n get(slug, params, options) {\n return client.get(`/collections/${slug}`, params, options)\n },\n }\n\n return new Proxy(selector, {\n get(target, prop) {\n if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n return makeCollectionInstance(client, prop)\n }\n\n return Reflect.get(target, prop)\n },\n }) as DynamicCollectionSelector\n}\n\nexport { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams }\n"]}
@@ -1,98 +0,0 @@
1
- import { ListRequestParameters, Collection, StarlightItemResponse, StarlightListResponse, BaseRequestParameters } from '../../types';
2
- import { CollectionInstance } from '../../instances/Collection';
3
- /**
4
- * Request parameters for listing collections.
5
- *
6
- * Used by {@apilink CollectionSelector.list}.
7
- *
8
- * @group Request Parameters
9
- */
10
- export interface ListCollectionsParams extends ListRequestParameters {
11
- /**
12
- * Define how items will be ordered. Check this field type to see the
13
- * allowed options.
14
- */
15
- order?: 'title:asc' | 'title:desc' | 'item_count:asc' | 'item_count:desc';
16
- }
17
- /**
18
- * A Selector that provide methods to list and request information on
19
- * {@apilink Collection | Collections}.
20
- *
21
- * You can use a CollectionSelector by accessing
22
- * {@apilink StarlightClient.collections}.
23
- *
24
- * To get items from a specific collection, use a {@link CollectionInstance}.
25
- *
26
- * @group Selectors
27
- */
28
- export interface CollectionSelector {
29
- /**
30
- * Returns a {@link StarlightListResponse} with the list of
31
- * {@apilink Collection | Collections} in this workspace.
32
- *
33
- * @example Requesting all collections from the workspace.
34
- * ```ts
35
- * import Starlight from '@starlightcms/js-sdk'
36
- *
37
- * const response = await Starlight.collections.list()
38
- * ```
39
- *
40
- * @example Paginating and searching on the last example.
41
- * ```ts
42
- * import Starlight from '@starlightcms/js-sdk'
43
- *
44
- * const response = await Starlight.collections.list({
45
- * page: 2,
46
- * query: 'photos',
47
- * })
48
- * ```
49
- *
50
- * @param params An optional object of request parameters. See
51
- * {@link ListCollectionsParams} for all available parameters.
52
- * @param options An optional object of fetch options. See
53
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
54
- * more info.
55
- */
56
- list(params?: ListCollectionsParams, options?: RequestInit): Promise<StarlightListResponse<Collection>>;
57
- /**
58
- * Returns a {@link StarlightItemResponse} with a single {@link Collection}.
59
- *
60
- * @example Requesting information from a collection of slug "event-photos".
61
- * ```ts
62
- * import Starlight from '@starlightcms/js-sdk'
63
- *
64
- * const response = await Starlight.collections.get('event-photos')
65
- * ```
66
- *
67
- * @param slug The collection slug.
68
- * @param params An optional object of request parameters.
69
- * @param options An optional object of fetch options. See
70
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
71
- * more info.
72
- */
73
- get(slug: string | number, params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<Collection>>;
74
- }
75
- /**
76
- * A Selector that provide all {@link CollectionSelector} methods and adds
77
- * support for creating {@apilink CollectionInstance | CollectionInstances}
78
- * using the dynamic syntax.
79
- *
80
- * See {@link CollectionSelector} to view all available methods.
81
- *
82
- * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}
83
- * documentation to learn more about the dynamic syntax.
84
- *
85
- * @example Accessing a CollectionInstance using the dynamic syntax.
86
- * ```ts
87
- * import Starlight from '@starlightcms/js-sdk'
88
- *
89
- * // "sliders" below will be a CollectionInstance.
90
- * const response = await Starlight.collections.sliders.list()
91
- * ```
92
- *
93
- * @category Instances
94
- */
95
- export type DynamicCollectionSelector = CollectionSelector & {
96
- [key: string]: CollectionInstance<unknown>;
97
- };
98
- //# sourceMappingURL=types.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE;;;OAGG;IACH,KAAK,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,gBAAgB,GAAG,iBAAiB,CAAA;CAC1E;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;IAE7C;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;CAC9C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,yBAAyB,GAAG,kBAAkB,GAAG;IAC3D,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;CAC3C,CAAA"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n ListRequestParameters,\n Collection,\n StarlightItemResponse,\n StarlightListResponse,\n BaseRequestParameters,\n} from '../../types'\nimport { CollectionInstance } from '../../instances/Collection'\n\n/**\n * Request parameters for listing collections.\n *\n * Used by {@apilink CollectionSelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListCollectionsParams extends ListRequestParameters {\n /**\n * Define how items will be ordered. Check this field type to see the\n * allowed options.\n */\n order?: 'title:asc' | 'title:desc' | 'item_count:asc' | 'item_count:desc'\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Collection | Collections}.\n *\n * You can use a CollectionSelector by accessing\n * {@apilink StarlightClient.collections}.\n *\n * To get items from a specific collection, use a {@link CollectionInstance}.\n *\n * @group Selectors\n */\nexport interface CollectionSelector {\n /**\n * Returns a {@link StarlightListResponse} with the list of\n * {@apilink Collection | Collections} in this workspace.\n *\n * @example Requesting all collections from the workspace.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.collections.list()\n * ```\n *\n * @example Paginating and searching on the last example.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.collections.list({\n * page: 2,\n * query: 'photos',\n * })\n * ```\n *\n * @param params An optional object of request parameters. See\n * {@link ListCollectionsParams} for all available parameters.\n * @param options An optional object of fetch options. See\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n * more info.\n */\n list(\n params?: ListCollectionsParams,\n options?: RequestInit,\n ): Promise<StarlightListResponse<Collection>>\n\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link Collection}.\n *\n * @example Requesting information from a collection of slug \"event-photos\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.collections.get('event-photos')\n * ```\n *\n * @param slug The collection slug.\n * @param params An optional object of request parameters.\n * @param options An optional object of fetch options. See\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n * more info.\n */\n get(\n slug: string | number,\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<Collection>>\n}\n\n/**\n * A Selector that provide all {@link CollectionSelector} methods and adds\n * support for creating {@apilink CollectionInstance | CollectionInstances}\n * using the dynamic syntax.\n *\n * See {@link CollectionSelector} to view all available methods.\n *\n * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}\n * documentation to learn more about the dynamic syntax.\n *\n * @example Accessing a CollectionInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"sliders\" below will be a CollectionInstance.\n * const response = await Starlight.collections.sliders.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicCollectionSelector = CollectionSelector & {\n [key: string]: CollectionInstance<unknown>\n}\n"]}
@@ -1,5 +0,0 @@
1
- import { SerializedData, StarlightClient } from '../../types';
2
- import { EntrySelector, ListEntriesParams } from './types';
3
- export default function makeEntrySelector<D extends SerializedData>(client: StarlightClient, model: string): EntrySelector<D>;
4
- export { EntrySelector, ListEntriesParams };
5
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Entry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7D,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAE1D,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAChE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,aAAa,CAAC,CAAC,CAAC,CAUlB;AAED,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,CAAA"}
@@ -1,14 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = makeEntrySelector;
4
- function makeEntrySelector(client, model) {
5
- return {
6
- list(params, options) {
7
- return client.get(`/models/${model}/entries`, params, options);
8
- },
9
- get(slug, params, options) {
10
- return client.get(`/models/${model}/entries/${slug}`, params, options);
11
- },
12
- };
13
- }
14
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Entry/index.ts"],"names":[],"mappings":";;AAGA,oCAaC;AAbD,SAAwB,iBAAiB,CACvC,MAAuB,EACvB,KAAa;IAEb,OAAO;QACL,IAAI,CAAC,MAAM,EAAE,OAAO;YAClB,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAChE,CAAC;QAED,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO;YACvB,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,YAAY,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACxE,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { SerializedData, StarlightClient } from '../../types'\nimport { EntrySelector, ListEntriesParams } from './types'\n\nexport default function makeEntrySelector<D extends SerializedData>(\n client: StarlightClient,\n model: string,\n): EntrySelector<D> {\n return {\n list(params, options) {\n return client.get(`/models/${model}/entries`, params, options)\n },\n\n get(slug, params, options) {\n return client.get(`/models/${model}/entries/${slug}`, params, options)\n },\n }\n}\n\nexport { EntrySelector, ListEntriesParams }\n"]}
@@ -1,138 +0,0 @@
1
- import { ListRequestParameters, Entry, QueryableFields, QueryableRequestParameters, SerializedData, StarlightItemResponse, StarlightListResponse, BaseRequestParameters } from '../../types';
2
- /**
3
- * Request parameters for listing entries.
4
- *
5
- * Used by {@apilink EntrySelector.list}.
6
- *
7
- * @group Request Parameters
8
- */
9
- export interface ListEntriesParams extends ListRequestParameters, QueryableRequestParameters {
10
- /**
11
- * A comma-separated list of categories. Only entries in these categories
12
- * will be returned. If undefined, all entries in the model will be listed.
13
- *
14
- * For instance, to show only entries in the "news" and "articles" categories,
15
- * pass `'news,category'`.
16
- */
17
- categories?: string;
18
- /**
19
- * Define how items will be ordered. Check this field type to see the
20
- * allowed options.
21
- */
22
- order?: 'title:asc' | 'title:desc' | 'published_at:asc' | 'published_at:desc' | 'views:asc' | 'views:desc';
23
- /**
24
- * When false, the returned entries won't have any data attached to them,
25
- * even if their Model have listable fields. Defaults to true.
26
- */
27
- data?: boolean;
28
- /**
29
- * When given, return entries published before the given date. Should be an
30
- * ISO 8601 date string.
31
- *
32
- * Tip: in JavaScript, you can get an ISO 8601 date string by using
33
- * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
34
- */
35
- published_before?: string;
36
- /**
37
- * When given, return entries published after the given date. Should be an
38
- * ISO 8601 date string.
39
- *
40
- * Tip: in JavaScript, you can get an ISO 8601 date string by using
41
- * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
42
- */
43
- published_after?: string;
44
- }
45
- /**
46
- * Request parameters for getting an entry.
47
- *
48
- * Used by {@apilink EntrySelector.get}.
49
- *
50
- * @group Request Parameters
51
- */
52
- export interface GetEntryParams extends BaseRequestParameters {
53
- /**
54
- * Preview token generated by the Starlight admin interface. If defined and
55
- * valid, the API will return a preview of the entry revision associated
56
- * with the token.
57
- */
58
- preview?: string;
59
- }
60
- /**
61
- * A Selector that provide methods to list and request information on
62
- * {@apilink Entry | Entries}.
63
- *
64
- * You can use an EntrySelector by accessing
65
- * {@apilink ModelInstance.entries}.
66
- *
67
- * @group Selectors
68
- */
69
- export interface EntrySelector<D extends SerializedData> {
70
- /**
71
- * Returns a {@link StarlightItemResponse} with a single {@link Entry}.
72
- * Supports revision previewing by passing a `preview` parameter.
73
- *
74
- * @example Requesting information from an entry "hello-world" from a model of slug "posts".
75
- * ```ts
76
- * import Starlight from '@starlightcms/js-sdk'
77
- *
78
- * const response = await Starlight.posts.entries.get('hello-world')
79
- * ```
80
- *
81
- * @example Passing a preview token on the last example.
82
- * ```ts
83
- * import Starlight from '@starlightcms/js-sdk'
84
- *
85
- * const response = await Starlight.posts.entries.get('hello-world', {
86
- * preview: 'CDfkvt1zTF5XhxWzi2Lejgo1'
87
- * })
88
- * ```
89
- *
90
- * @param slug The entry slug.
91
- * @param params An optional object of request parameters. See
92
- * {@link GetEntryParams} for all available options.
93
- * @param options An optional object of fetch options. See
94
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
95
- * more info.
96
- */
97
- get(slug: string, params?: GetEntryParams, options?: RequestInit): Promise<StarlightItemResponse<Entry<D>>>;
98
- /**
99
- * Returns a {@link StarlightListResponse} with a list of
100
- * {@apilink Entry | Entries}.
101
- *
102
- * @example Requesting all entries from a model of slug "recipes".
103
- * ```ts
104
- * import Starlight from '@starlightcms/js-sdk'
105
- *
106
- * const response = await Starlight.recipes.entries.list()
107
- * ```
108
- *
109
- * @example Paginating and searching on the last example.
110
- * ```ts
111
- * import Starlight from '@starlightcms/js-sdk'
112
- *
113
- * const response = await Starlight.recipes.entries.list({
114
- * page: 2,
115
- * query: 'gravy',
116
- * 'field:is_vegan': true,
117
- * })
118
- * ```
119
- *
120
- * @example Ordering entries by number of views.
121
- * ```ts
122
- * import Starlight from '@starlightcms/js-sdk'
123
- *
124
- * const response = await Starlight.recipes.entries.list({
125
- * order: 'views:desc'
126
- * })
127
- * ```
128
- *
129
- * @param params An optional object of request parameters. See
130
- * {@link ListEntriesParams} for all available parameters. `field:foo`
131
- * syntax is also supported, see {@link QueryableFields} for more info.
132
- * @param options An optional object of fetch options. See
133
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
134
- * more info.
135
- */
136
- list(params?: ListEntriesParams & QueryableFields<D>, options?: RequestInit): Promise<StarlightListResponse<Entry<D>>>;
137
- }
138
- //# sourceMappingURL=types.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,iBACf,SAAQ,qBAAqB,EAAE,0BAA0B;IACzD;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAC3D;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,cAAc,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,CAAC,CAAC,EAC/C,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n ListRequestParameters,\n Entry,\n QueryableFields,\n QueryableRequestParameters,\n SerializedData,\n StarlightItemResponse,\n StarlightListResponse,\n BaseRequestParameters,\n} from '../../types'\n\n/**\n * Request parameters for listing entries.\n *\n * Used by {@apilink EntrySelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListEntriesParams\n extends ListRequestParameters, QueryableRequestParameters {\n /**\n * A comma-separated list of categories. Only entries in these categories\n * will be returned. If undefined, all entries in the model will be listed.\n *\n * For instance, to show only entries in the \"news\" and \"articles\" categories,\n * pass `'news,category'`.\n */\n categories?: string\n /**\n * Define how items will be ordered. Check this field type to see the\n * allowed options.\n */\n order?:\n | 'title:asc'\n | 'title:desc'\n | 'published_at:asc'\n | 'published_at:desc'\n | 'views:asc'\n | 'views:desc'\n /**\n * When false, the returned entries won't have any data attached to them,\n * even if their Model have listable fields. Defaults to true.\n */\n data?: boolean\n /**\n * When given, return entries published before the given date. Should be an\n * ISO 8601 date string.\n *\n * Tip: in JavaScript, you can get an ISO 8601 date string by using\n * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).\n */\n published_before?: string\n /**\n * When given, return entries published after the given date. Should be an\n * ISO 8601 date string.\n *\n * Tip: in JavaScript, you can get an ISO 8601 date string by using\n * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).\n */\n published_after?: string\n}\n\n/**\n * Request parameters for getting an entry.\n *\n * Used by {@apilink EntrySelector.get}.\n *\n * @group Request Parameters\n */\nexport interface GetEntryParams extends BaseRequestParameters {\n /**\n * Preview token generated by the Starlight admin interface. If defined and\n * valid, the API will return a preview of the entry revision associated\n * with the token.\n */\n preview?: string\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Entry | Entries}.\n *\n * You can use an EntrySelector by accessing\n * {@apilink ModelInstance.entries}.\n *\n * @group Selectors\n */\nexport interface EntrySelector<D extends SerializedData> {\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link Entry}.\n * Supports revision previewing by passing a `preview` parameter.\n *\n * @example Requesting information from an entry \"hello-world\" from a model of slug \"posts\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.get('hello-world')\n * ```\n *\n * @example Passing a preview token on the last example.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.get('hello-world', {\n * preview: 'CDfkvt1zTF5XhxWzi2Lejgo1'\n * })\n * ```\n *\n * @param slug The entry slug.\n * @param params An optional object of request parameters. See\n * {@link GetEntryParams} for all available options.\n * @param options An optional object of fetch options. See\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n * more info.\n */\n get(\n slug: string,\n params?: GetEntryParams,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<Entry<D>>>\n\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink Entry | Entries}.\n *\n * @example Requesting all entries from a model of slug \"recipes\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.recipes.entries.list()\n * ```\n *\n * @example Paginating and searching on the last example.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.recipes.entries.list({\n * page: 2,\n * query: 'gravy',\n * 'field:is_vegan': true,\n * })\n * ```\n *\n * @example Ordering entries by number of views.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.recipes.entries.list({\n * order: 'views:desc'\n * })\n * ```\n *\n * @param params An optional object of request parameters. See\n * {@link ListEntriesParams} for all available parameters. `field:foo`\n * syntax is also supported, see {@link QueryableFields} for more info.\n * @param options An optional object of fetch options. See\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n * more info.\n */\n list(\n params?: ListEntriesParams & QueryableFields<D>,\n options?: RequestInit,\n ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}
@@ -1,4 +0,0 @@
1
- import { StarlightClient } from '../../types';
2
- import { DynamicFormSelector } from './types';
3
- export default function makeFormSelector(client: StarlightClient): DynamicFormSelector;
4
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Form/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAG7C,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,MAAM,EAAE,eAAe,GACtB,mBAAmB,CAarB"}
@@ -1,18 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.default = makeFormSelector;
7
- const Form_1 = __importDefault(require("../../instances/Form"));
8
- function makeFormSelector(client) {
9
- return new Proxy({}, {
10
- get(target, prop) {
11
- if (typeof prop === 'string' && !Reflect.has(target, prop)) {
12
- return (0, Form_1.default)(client, prop);
13
- }
14
- return Reflect.get(target, prop);
15
- },
16
- });
17
- }
18
- //# sourceMappingURL=index.js.map