@starlightcms/js-sdk 3.0.0 → 3.1.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 (143) hide show
  1. package/dist/cjs/client.d.ts.map +1 -1
  2. package/dist/cjs/client.js +1 -1
  3. package/dist/cjs/client.js.map +1 -1
  4. package/dist/cjs/instances/Collection/index.js +4 -4
  5. package/dist/cjs/instances/Collection/index.js.map +1 -1
  6. package/dist/cjs/instances/Collection/types.d.ts +14 -6
  7. package/dist/cjs/instances/Collection/types.d.ts.map +1 -1
  8. package/dist/cjs/instances/Collection/types.js.map +1 -1
  9. package/dist/cjs/instances/Form/index.d.ts.map +1 -1
  10. package/dist/cjs/instances/Form/index.js +4 -4
  11. package/dist/cjs/instances/Form/index.js.map +1 -1
  12. package/dist/cjs/instances/Form/types.d.ts +12 -4
  13. package/dist/cjs/instances/Form/types.d.ts.map +1 -1
  14. package/dist/cjs/instances/Form/types.js.map +1 -1
  15. package/dist/cjs/instances/Model/index.d.ts.map +1 -1
  16. package/dist/cjs/instances/Model/index.js +2 -2
  17. package/dist/cjs/instances/Model/index.js.map +1 -1
  18. package/dist/cjs/instances/Model/types.d.ts +7 -2
  19. package/dist/cjs/instances/Model/types.d.ts.map +1 -1
  20. package/dist/cjs/instances/Model/types.js.map +1 -1
  21. package/dist/cjs/instances/ModelCategory/index.d.ts +1 -1
  22. package/dist/cjs/instances/ModelCategory/index.d.ts.map +1 -1
  23. package/dist/cjs/instances/ModelCategory/index.js +4 -4
  24. package/dist/cjs/instances/ModelCategory/index.js.map +1 -1
  25. package/dist/cjs/instances/ModelCategory/types.d.ts +16 -7
  26. package/dist/cjs/instances/ModelCategory/types.d.ts.map +1 -1
  27. package/dist/cjs/instances/ModelCategory/types.js.map +1 -1
  28. package/dist/cjs/selectors/Collection/index.js +4 -4
  29. package/dist/cjs/selectors/Collection/index.js.map +1 -1
  30. package/dist/cjs/selectors/Collection/types.d.ts +13 -6
  31. package/dist/cjs/selectors/Collection/types.d.ts.map +1 -1
  32. package/dist/cjs/selectors/Collection/types.js.map +1 -1
  33. package/dist/cjs/selectors/Entry/index.d.ts.map +1 -1
  34. package/dist/cjs/selectors/Entry/index.js +2 -2
  35. package/dist/cjs/selectors/Entry/index.js.map +1 -1
  36. package/dist/cjs/selectors/Entry/types.d.ts +13 -10
  37. package/dist/cjs/selectors/Entry/types.d.ts.map +1 -1
  38. package/dist/cjs/selectors/Entry/types.js.map +1 -1
  39. package/dist/cjs/selectors/Media/index.js +4 -4
  40. package/dist/cjs/selectors/Media/index.js.map +1 -1
  41. package/dist/cjs/selectors/Media/types.d.ts +12 -3
  42. package/dist/cjs/selectors/Media/types.d.ts.map +1 -1
  43. package/dist/cjs/selectors/Media/types.js.map +1 -1
  44. package/dist/cjs/selectors/Model/index.d.ts +1 -1
  45. package/dist/cjs/selectors/Model/index.d.ts.map +1 -1
  46. package/dist/cjs/selectors/Model/index.js +4 -4
  47. package/dist/cjs/selectors/Model/index.js.map +1 -1
  48. package/dist/cjs/selectors/Model/types.d.ts +12 -3
  49. package/dist/cjs/selectors/Model/types.d.ts.map +1 -1
  50. package/dist/cjs/selectors/Model/types.js.map +1 -1
  51. package/dist/cjs/selectors/ModelCategory/index.d.ts +1 -1
  52. package/dist/cjs/selectors/ModelCategory/index.d.ts.map +1 -1
  53. package/dist/cjs/selectors/ModelCategory/index.js +4 -4
  54. package/dist/cjs/selectors/ModelCategory/index.js.map +1 -1
  55. package/dist/cjs/selectors/ModelCategory/types.d.ts +13 -6
  56. package/dist/cjs/selectors/ModelCategory/types.d.ts.map +1 -1
  57. package/dist/cjs/selectors/ModelCategory/types.js.map +1 -1
  58. package/dist/cjs/selectors/Search/index.d.ts.map +1 -1
  59. package/dist/cjs/selectors/Search/index.js +2 -2
  60. package/dist/cjs/selectors/Search/index.js.map +1 -1
  61. package/dist/cjs/selectors/Search/types.d.ts +8 -5
  62. package/dist/cjs/selectors/Search/types.d.ts.map +1 -1
  63. package/dist/cjs/selectors/Search/types.js.map +1 -1
  64. package/dist/cjs/selectors/Singleton/index.js +4 -4
  65. package/dist/cjs/selectors/Singleton/index.js.map +1 -1
  66. package/dist/cjs/selectors/Singleton/types.d.ts +12 -3
  67. package/dist/cjs/selectors/Singleton/types.d.ts.map +1 -1
  68. package/dist/cjs/selectors/Singleton/types.js.map +1 -1
  69. package/dist/cjs/types/index.d.ts +10 -2
  70. package/dist/cjs/types/index.d.ts.map +1 -1
  71. package/dist/cjs/types/index.js.map +1 -1
  72. package/dist/esm/client.d.ts.map +1 -1
  73. package/dist/esm/client.js +1 -1
  74. package/dist/esm/client.js.map +1 -1
  75. package/dist/esm/instances/Collection/index.js +4 -4
  76. package/dist/esm/instances/Collection/index.js.map +1 -1
  77. package/dist/esm/instances/Collection/types.d.ts +14 -6
  78. package/dist/esm/instances/Collection/types.d.ts.map +1 -1
  79. package/dist/esm/instances/Collection/types.js.map +1 -1
  80. package/dist/esm/instances/Form/index.d.ts.map +1 -1
  81. package/dist/esm/instances/Form/index.js +4 -4
  82. package/dist/esm/instances/Form/index.js.map +1 -1
  83. package/dist/esm/instances/Form/types.d.ts +12 -4
  84. package/dist/esm/instances/Form/types.d.ts.map +1 -1
  85. package/dist/esm/instances/Form/types.js.map +1 -1
  86. package/dist/esm/instances/Model/index.d.ts.map +1 -1
  87. package/dist/esm/instances/Model/index.js +2 -2
  88. package/dist/esm/instances/Model/index.js.map +1 -1
  89. package/dist/esm/instances/Model/types.d.ts +7 -2
  90. package/dist/esm/instances/Model/types.d.ts.map +1 -1
  91. package/dist/esm/instances/Model/types.js.map +1 -1
  92. package/dist/esm/instances/ModelCategory/index.d.ts +1 -1
  93. package/dist/esm/instances/ModelCategory/index.d.ts.map +1 -1
  94. package/dist/esm/instances/ModelCategory/index.js +4 -4
  95. package/dist/esm/instances/ModelCategory/index.js.map +1 -1
  96. package/dist/esm/instances/ModelCategory/types.d.ts +16 -7
  97. package/dist/esm/instances/ModelCategory/types.d.ts.map +1 -1
  98. package/dist/esm/instances/ModelCategory/types.js.map +1 -1
  99. package/dist/esm/selectors/Collection/index.js +4 -4
  100. package/dist/esm/selectors/Collection/index.js.map +1 -1
  101. package/dist/esm/selectors/Collection/types.d.ts +13 -6
  102. package/dist/esm/selectors/Collection/types.d.ts.map +1 -1
  103. package/dist/esm/selectors/Collection/types.js.map +1 -1
  104. package/dist/esm/selectors/Entry/index.d.ts.map +1 -1
  105. package/dist/esm/selectors/Entry/index.js +2 -2
  106. package/dist/esm/selectors/Entry/index.js.map +1 -1
  107. package/dist/esm/selectors/Entry/types.d.ts +13 -10
  108. package/dist/esm/selectors/Entry/types.d.ts.map +1 -1
  109. package/dist/esm/selectors/Entry/types.js.map +1 -1
  110. package/dist/esm/selectors/Media/index.js +4 -4
  111. package/dist/esm/selectors/Media/index.js.map +1 -1
  112. package/dist/esm/selectors/Media/types.d.ts +12 -3
  113. package/dist/esm/selectors/Media/types.d.ts.map +1 -1
  114. package/dist/esm/selectors/Media/types.js.map +1 -1
  115. package/dist/esm/selectors/Model/index.d.ts +1 -1
  116. package/dist/esm/selectors/Model/index.d.ts.map +1 -1
  117. package/dist/esm/selectors/Model/index.js +4 -4
  118. package/dist/esm/selectors/Model/index.js.map +1 -1
  119. package/dist/esm/selectors/Model/types.d.ts +12 -3
  120. package/dist/esm/selectors/Model/types.d.ts.map +1 -1
  121. package/dist/esm/selectors/Model/types.js.map +1 -1
  122. package/dist/esm/selectors/ModelCategory/index.d.ts +1 -1
  123. package/dist/esm/selectors/ModelCategory/index.d.ts.map +1 -1
  124. package/dist/esm/selectors/ModelCategory/index.js +4 -4
  125. package/dist/esm/selectors/ModelCategory/index.js.map +1 -1
  126. package/dist/esm/selectors/ModelCategory/types.d.ts +13 -6
  127. package/dist/esm/selectors/ModelCategory/types.d.ts.map +1 -1
  128. package/dist/esm/selectors/ModelCategory/types.js.map +1 -1
  129. package/dist/esm/selectors/Search/index.d.ts.map +1 -1
  130. package/dist/esm/selectors/Search/index.js +2 -2
  131. package/dist/esm/selectors/Search/index.js.map +1 -1
  132. package/dist/esm/selectors/Search/types.d.ts +8 -5
  133. package/dist/esm/selectors/Search/types.d.ts.map +1 -1
  134. package/dist/esm/selectors/Search/types.js.map +1 -1
  135. package/dist/esm/selectors/Singleton/index.js +4 -4
  136. package/dist/esm/selectors/Singleton/index.js.map +1 -1
  137. package/dist/esm/selectors/Singleton/types.d.ts +12 -3
  138. package/dist/esm/selectors/Singleton/types.d.ts.map +1 -1
  139. package/dist/esm/selectors/Singleton/types.js.map +1 -1
  140. package/dist/esm/types/index.d.ts +10 -2
  141. package/dist/esm/types/index.d.ts.map +1 -1
  142. package/dist/esm/types/index.js.map +1 -1
  143. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- import { BaseRequestParameters, Entry, QueryableFields, QueryableRequestParameters, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
1
+ import { ListRequestParameters, Entry, QueryableFields, QueryableRequestParameters, SerializedData, StarlightItemResponse, StarlightListResponse, BaseRequestParameters } from '../../types';
2
2
  /**
3
3
  * Request parameters for listing entries.
4
4
  *
@@ -6,7 +6,7 @@ import { BaseRequestParameters, Entry, QueryableFields, QueryableRequestParamete
6
6
  *
7
7
  * @group Request Parameters
8
8
  */
9
- export interface ListEntriesParams extends BaseRequestParameters, QueryableRequestParameters {
9
+ export interface ListEntriesParams extends ListRequestParameters, QueryableRequestParameters {
10
10
  /**
11
11
  * A comma-separated list of categories. Only entries in these categories
12
12
  * will be returned. If undefined, all entries in the model will be listed.
@@ -49,14 +49,14 @@ export interface ListEntriesParams extends BaseRequestParameters, QueryableReque
49
49
  *
50
50
  * @group Request Parameters
51
51
  */
52
- export type GetEntryParams = {
52
+ export interface GetEntryParams extends BaseRequestParameters {
53
53
  /**
54
54
  * Preview token generated by the Starlight admin interface. If defined and
55
55
  * valid, the API will return a preview of the entry revision associated
56
56
  * with the token.
57
57
  */
58
58
  preview?: string;
59
- };
59
+ }
60
60
  /**
61
61
  * A Selector that provide methods to list and request information on
62
62
  * {@apilink Entry | Entries}.
@@ -90,9 +90,9 @@ export interface EntrySelector<D extends SerializedData> {
90
90
  * @param slug The entry slug.
91
91
  * @param params An optional object of request parameters. See
92
92
  * {@link GetEntryParams} for all available options.
93
- * @param options An optional object of Fetch parameters. Use it to modify
94
- * the fetch request.See [MDN documentation on fetch()](https://developer.mozilla.org/en-US/docs/Web/API/fetch)
95
- * 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
96
  */
97
97
  get(slug: string, params?: GetEntryParams, options?: RequestInit): Promise<StarlightItemResponse<Entry<D>>>;
98
98
  /**
@@ -126,10 +126,13 @@ export interface EntrySelector<D extends SerializedData> {
126
126
  * })
127
127
  * ```
128
128
  *
129
- * @param options An optional object of request parameters. See
130
- * {@link ListEntriesParams} for all available options. `field:foo`
129
+ * @param params An optional object of request parameters. See
130
+ * {@link ListEntriesParams} for all available parameters. `field:foo`
131
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.
132
135
  */
133
- list(options?: ListEntriesParams & QueryableFields<D>): Promise<StarlightListResponse<Entry<D>>>;
136
+ list(params?: ListEntriesParams & QueryableFields<D>, options?: RequestInit): Promise<StarlightListResponse<Entry<D>>>;
134
137
  }
135
138
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
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,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,iBACf,SAAQ,qBAAqB,EAC3B,0BAA0B;IAC5B;;;;;;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,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,CAAC,CAAC,GAC/C,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
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 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n Entry,\n QueryableFields,\n QueryableRequestParameters,\n SerializedData,\n StarlightItemResponse,\n StarlightListResponse,\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 BaseRequestParameters,\n 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 type GetEntryParams = {\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 parameters. Use it to modify\n * the fetch request.See [MDN documentation on fetch()](https://developer.mozilla.org/en-US/docs/Web/API/fetch)\n * for all available options.\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 options An optional object of request parameters. See\n * {@link ListEntriesParams} for all available options. `field:foo`\n * syntax is also supported, see {@link QueryableFields} for more info.\n */\n list(\n options?: ListEntriesParams & QueryableFields<D>\n ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}
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"]}
@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.default = makeMediaSelector;
4
4
  function makeMediaSelector(client) {
5
5
  return {
6
- list() {
7
- return client.get('/media');
6
+ list(params, options) {
7
+ return client.get('/media', params, options);
8
8
  },
9
- get(id) {
10
- return client.get(`/media/${id}`);
9
+ get(id, params, options) {
10
+ return client.get(`/media/${id}`, params, options);
11
11
  },
12
12
  };
13
13
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Media/index.ts"],"names":[],"mappings":";;AAGA,oCAYC;AAZD,SAAwB,iBAAiB,CACvC,MAAuB;IAEvB,OAAO;QACL,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;QAED,GAAG,CAAC,EAAE;YACJ,OAAO,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;QACnC,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { MediaSelector } from './types'\n\nexport default function makeMediaSelector(\n client: StarlightClient\n): MediaSelector {\n return {\n list() {\n return client.get('/media')\n },\n\n get(id) {\n return client.get(`/media/${id}`)\n },\n }\n}\n\nexport { MediaSelector }\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Media/index.ts"],"names":[],"mappings":";;AAGA,oCAYC;AAZD,SAAwB,iBAAiB,CACvC,MAAuB;IAEvB,OAAO;QACL,IAAI,CAAC,MAAM,EAAE,OAAO;YAClB,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9C,CAAC;QAED,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO;YACrB,OAAO,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACpD,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { MediaSelector } from './types'\n\nexport default function makeMediaSelector(\n client: StarlightClient,\n): MediaSelector {\n return {\n list(params, options) {\n return client.get('/media', params, options)\n },\n\n get(id, params, options) {\n return client.get(`/media/${id}`, params, options)\n },\n }\n}\n\nexport { MediaSelector }\n"]}
@@ -1,4 +1,4 @@
1
- import { MediaObject, StarlightItemResponse, StarlightListResponse } from '../../types';
1
+ import { BaseRequestParameters, MediaObject, StarlightItemResponse, StarlightListResponse } from '../../types';
2
2
  /**
3
3
  * A Selector that provide methods to list and request information on
4
4
  * {@apilink MediaObject | MediaObjects}.
@@ -22,8 +22,12 @@ export interface MediaSelector {
22
22
  * ```
23
23
  *
24
24
  * @param id The media object ID.
25
+ * @param params An optional object of request parameters.
26
+ * @param options An optional object of fetch options. See
27
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
28
+ * more info.
25
29
  */
26
- get(id: number | string): Promise<StarlightItemResponse<MediaObject>>;
30
+ get(id: number | string, params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<MediaObject>>;
27
31
  /**
28
32
  * Returns a {@link StarlightListResponse} with the list of
29
33
  * {@apilink MediaObject | MediaObjects} in this workspace.
@@ -34,7 +38,12 @@ export interface MediaSelector {
34
38
  *
35
39
  * const response = await Starlight.media.list()
36
40
  * ```
41
+ *
42
+ * @param params An optional object of request parameters.
43
+ * @param options An optional object of fetch options. See
44
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
45
+ * more info.
37
46
  */
38
- list(): Promise<StarlightListResponse<MediaObject>>;
47
+ list(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightListResponse<MediaObject>>;
39
48
  }
40
49
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;IAErE;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;CACpD"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CACD,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;IAE9C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;CAC/C"}
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n MediaObject,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink MediaObject | MediaObjects}.\n *\n * You can use a MediaSelector by accessing\n * {@apilink StarlightClient.media}.\n *\n * @group Selectors\n */\nexport interface MediaSelector {\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link MediaObject}.\n *\n * Note: MediaObjects are identified by their IDs, since they don't have slugs.\n *\n * @example Requesting information from a media object of id \"123456789\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.media.get('123456789')\n * ```\n *\n * @param id The media object ID.\n */\n get(id: number | string): Promise<StarlightItemResponse<MediaObject>>\n\n /**\n * Returns a {@link StarlightListResponse} with the list of\n * {@apilink MediaObject | MediaObjects} in this workspace.\n *\n * @example Requesting all media objects from the workspace.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.media.list()\n * ```\n */\n list(): Promise<StarlightListResponse<MediaObject>>\n}\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n MediaObject,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink MediaObject | MediaObjects}.\n *\n * You can use a MediaSelector by accessing\n * {@apilink StarlightClient.media}.\n *\n * @group Selectors\n */\nexport interface MediaSelector {\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link MediaObject}.\n *\n * Note: MediaObjects are identified by their IDs, since they don't have slugs.\n *\n * @example Requesting information from a media object of id \"123456789\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.media.get('123456789')\n * ```\n *\n * @param id The media object ID.\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 id: number | string,\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<MediaObject>>\n\n /**\n * Returns a {@link StarlightListResponse} with the list of\n * {@apilink MediaObject | MediaObjects} in this workspace.\n *\n * @example Requesting all media objects from the workspace.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.media.list()\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 list(\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightListResponse<MediaObject>>\n}\n"]}
@@ -1,5 +1,5 @@
1
1
  import { StarlightClient, WorkspaceModelDefinition } from '../../types';
2
- import { ModelSelector, DynamicModelSelector } from './types';
2
+ import { DynamicModelSelector, ModelSelector } from './types';
3
3
  export default function makeModelSelector<D extends WorkspaceModelDefinition>(client: StarlightClient): DynamicModelSelector<D>;
4
4
  export { ModelSelector, DynamicModelSelector };
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGf,wBAAwB,EACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAG7D,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,wBAAwB,EAC1E,MAAM,EAAE,eAAe,GACtB,oBAAoB,CAAC,CAAC,CAAC,CAoBzB;AAED,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACvE,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAG7D,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,wBAAwB,EAC1E,MAAM,EAAE,eAAe,GACtB,oBAAoB,CAAC,CAAC,CAAC,CAoBzB;AAED,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAA"}
@@ -7,11 +7,11 @@ exports.default = makeModelSelector;
7
7
  const Model_1 = __importDefault(require("../../instances/Model"));
8
8
  function makeModelSelector(client) {
9
9
  const modelClient = {
10
- list() {
11
- return client.get('/models');
10
+ list(params, options) {
11
+ return client.get('/models', params, options);
12
12
  },
13
- get(slug) {
14
- return client.get(`/models/${slug}`);
13
+ get(slug, params, options) {
14
+ return client.get(`/models/${slug}`, params, options);
15
15
  },
16
16
  };
17
17
  return new Proxy(modelClient, {
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":";;;;;AAUA,oCAsBC;AAxBD,kEAAqD;AAErD,SAAwB,iBAAiB,CACvC,MAAuB;IAEvB,MAAM,WAAW,GAAkB;QACjC,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC9B,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;QACtC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC5B,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,eAAiB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;YACxC,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC","sourcesContent":["import {\n Model,\n StarlightClient,\n StarlightItemResponse,\n StarlightListResponse,\n WorkspaceModelDefinition,\n} from '../../types'\nimport { ModelSelector, DynamicModelSelector } from './types'\nimport makeModelInstance from '../../instances/Model'\n\nexport default function makeModelSelector<D extends WorkspaceModelDefinition>(\n client: StarlightClient\n): DynamicModelSelector<D> {\n const modelClient: ModelSelector = {\n list(): Promise<StarlightListResponse<Model>> {\n return client.get('/models')\n },\n\n get(slug): Promise<StarlightItemResponse<Model>> {\n return client.get(`/models/${slug}`)\n },\n }\n\n return new Proxy(modelClient, {\n get(target, prop) {\n if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n return makeModelInstance(client, prop)\n }\n\n return Reflect.get(target, prop)\n },\n }) as DynamicModelSelector<D>\n}\n\nexport { ModelSelector, DynamicModelSelector }\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":";;;;;AAIA,oCAsBC;AAxBD,kEAAqD;AAErD,SAAwB,iBAAiB,CACvC,MAAuB;IAEvB,MAAM,WAAW,GAAkB;QACjC,IAAI,CAAC,MAAM,EAAE,OAAO;YAClB,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC/C,CAAC;QAED,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO;YACvB,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACvD,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC5B,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,eAAiB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;YACxC,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC","sourcesContent":["import { StarlightClient, WorkspaceModelDefinition } from '../../types'\nimport { DynamicModelSelector, ModelSelector } from './types'\nimport makeModelInstance from '../../instances/Model'\n\nexport default function makeModelSelector<D extends WorkspaceModelDefinition>(\n client: StarlightClient,\n): DynamicModelSelector<D> {\n const modelClient: ModelSelector = {\n list(params, options) {\n return client.get('/models', params, options)\n },\n\n get(slug, params, options) {\n return client.get(`/models/${slug}`, params, options)\n },\n }\n\n return new Proxy(modelClient, {\n get(target, prop) {\n if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n return makeModelInstance(client, prop)\n }\n\n return Reflect.get(target, prop)\n },\n }) as DynamicModelSelector<D>\n}\n\nexport { ModelSelector, DynamicModelSelector }\n"]}
@@ -1,4 +1,4 @@
1
- import { Model, StarlightItemResponse, StarlightListResponse, WorkspaceModelDefinition } from '../../types';
1
+ import { BaseRequestParameters, Model, StarlightItemResponse, StarlightListResponse, WorkspaceModelDefinition } from '../../types';
2
2
  import { DynamicModelInstance } from '../../instances/Model';
3
3
  /**
4
4
  * A Selector that provide methods to list and request information on
@@ -23,8 +23,13 @@ export interface ModelSelector {
23
23
  *
24
24
  * const response = await Starlight.models.list()
25
25
  * ```
26
+ *
27
+ * @param params An optional object of request parameters.
28
+ * @param options An optional object of fetch options. See
29
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
30
+ * more info.
26
31
  */
27
- list(): Promise<StarlightListResponse<Model>>;
32
+ list(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightListResponse<Model>>;
28
33
  /**
29
34
  * Returns a {@link StarlightItemResponse} with a single {@link Model}.
30
35
  *
@@ -40,8 +45,12 @@ export interface ModelSelector {
40
45
  * ```
41
46
  *
42
47
  * @param slug The model slug.
48
+ * @param params An optional object of request parameters.
49
+ * @param options An optional object of fetch options. See
50
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
51
+ * more info.
43
52
  */
44
- get(slug: string): Promise<StarlightItemResponse<Model>>;
53
+ get(slug: string, params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<Model>>;
45
54
  }
46
55
  /**
47
56
  * A Selector that provide all {@link ModelSelector} methods and adds support
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAE5D;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAE7C;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;CACzD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,wBAAwB,IACjE,aAAa,GAAG;KACb,CAAC,IAAI,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAA"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AAE5D;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;CACzC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,wBAAwB,IACjE,aAAa,GAAG;KACb,CAAC,IAAI,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n Model,\n StarlightItemResponse,\n StarlightListResponse,\n WorkspaceModelDefinition,\n} from '../../types'\nimport { DynamicModelInstance } from '../../instances/Model'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Model | Models}.\n *\n * You can use a ModelSelector by accessing\n * {@apilink StarlightClient.models}.\n *\n * To list entries or categories of a specific model, use a\n * {@link ModelInstance}.\n *\n * @group Selectors\n */\nexport interface ModelSelector {\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink Model | Models}.\n *\n * @example Requesting all models from a workspace.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.models.list()\n * ```\n */\n list(): Promise<StarlightListResponse<Model>>\n\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link Model}.\n *\n * Note that this method only returns information on a model, like its title,\n * slug, creation date, and entry count. If you want list its entries or\n * categories, you need to use a {@link ModelInstance}.\n *\n * @example Requesting information from a model of slug \"clients\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.get('clients')\n * ```\n *\n * @param slug The model slug.\n */\n get(slug: string): Promise<StarlightItemResponse<Model>>\n}\n\n/**\n * A Selector that provide all {@link ModelSelector} methods and adds support\n * for creating {@apilink DynamicModelInstance | DynamicModelInstances} using\n * the dynamic syntax.\n *\n * See {@link ModelSelector} 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 DynamicModelInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"posts\" below will be a DynamicModelInstance.\n * const response = await Starlight.models.posts.entries.list()\n * ```\n *\n * @category Selectors\n */\nexport type DynamicModelSelector<T extends WorkspaceModelDefinition> =\n ModelSelector & {\n [K in keyof T]: DynamicModelInstance<T[K]>\n }\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n Model,\n StarlightItemResponse,\n StarlightListResponse,\n WorkspaceModelDefinition,\n} from '../../types'\nimport { DynamicModelInstance } from '../../instances/Model'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Model | Models}.\n *\n * You can use a ModelSelector by accessing\n * {@apilink StarlightClient.models}.\n *\n * To list entries or categories of a specific model, use a\n * {@link ModelInstance}.\n *\n * @group Selectors\n */\nexport interface ModelSelector {\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink Model | Models}.\n *\n * @example Requesting all models from a workspace.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.models.list()\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 list(\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightListResponse<Model>>\n\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link Model}.\n *\n * Note that this method only returns information on a model, like its title,\n * slug, creation date, and entry count. If you want list its entries or\n * categories, you need to use a {@link ModelInstance}.\n *\n * @example Requesting information from a model of slug \"clients\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.get('clients')\n * ```\n *\n * @param slug The model 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,\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<Model>>\n}\n\n/**\n * A Selector that provide all {@link ModelSelector} methods and adds support\n * for creating {@apilink DynamicModelInstance | DynamicModelInstances} using\n * the dynamic syntax.\n *\n * See {@link ModelSelector} 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 DynamicModelInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"posts\" below will be a DynamicModelInstance.\n * const response = await Starlight.models.posts.entries.list()\n * ```\n *\n * @category Selectors\n */\nexport type DynamicModelSelector<T extends WorkspaceModelDefinition> =\n ModelSelector & {\n [K in keyof T]: DynamicModelInstance<T[K]>\n }\n"]}
@@ -1,5 +1,5 @@
1
1
  import { SerializedData, StarlightClient } from '../../types';
2
- import { ModelCategorySelector, DynamicModelCategorySelector, ListModelCategoriesOptions } from './types';
2
+ import { DynamicModelCategorySelector, ListModelCategoriesOptions, ModelCategorySelector } from './types';
3
3
  export default function makeModelCategorySelector<D extends SerializedData>(client: StarlightClient, model: string): DynamicModelCategorySelector<D>;
4
4
  export { ModelCategorySelector, DynamicModelCategorySelector, ListModelCategoriesOptions, };
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,eAAe,EAGhB,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,EAC3B,MAAM,SAAS,CAAA;AAGhB,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,CAAC,SAAS,cAAc,EACxE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,4BAA4B,CAAC,CAAC,CAAC,CAoBjC;AAED,OAAO,EACL,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,GAC3B,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7D,OAAO,EACL,4BAA4B,EAC5B,0BAA0B,EAC1B,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAGhB,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,CAAC,SAAS,cAAc,EACxE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,4BAA4B,CAAC,CAAC,CAAC,CAoBjC;AAED,OAAO,EACL,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,GAC3B,CAAA"}
@@ -7,11 +7,11 @@ exports.default = makeModelCategorySelector;
7
7
  const ModelCategory_1 = __importDefault(require("../../instances/ModelCategory"));
8
8
  function makeModelCategorySelector(client, model) {
9
9
  const selector = {
10
- list(options) {
11
- return client.get(`/models/${model}/categories`, Object.assign({}, options));
10
+ list(params, options) {
11
+ return client.get(`/models/${model}/categories`, params, options);
12
12
  },
13
- get(slug) {
14
- return client.get(`/models/${model}/categories/${slug}`);
13
+ get(slug, params, options) {
14
+ return client.get(`/models/${model}/categories/${slug}`, params, options);
15
15
  },
16
16
  };
17
17
  return new Proxy(selector, {
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":";;;;;AAcA,4CAuBC;AAzBD,kFAAqE;AAErE,SAAwB,yBAAyB,CAC/C,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAA0B;QACtC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,aAAa,oBAAO,OAAO,EAAG,CAAA;QAClE,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,IAAI,EAAE,CAAC,CAAA;QAC1D,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,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;YACvD,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC","sourcesContent":["import {\n ModelCategory,\n SerializedData,\n StarlightClient,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../../types'\nimport {\n ModelCategorySelector,\n DynamicModelCategorySelector,\n ListModelCategoriesOptions,\n} from './types'\nimport makeModelCategoryInstance from '../../instances/ModelCategory'\n\nexport default function makeModelCategorySelector<D extends SerializedData>(\n client: StarlightClient,\n model: string\n): DynamicModelCategorySelector<D> {\n const selector: ModelCategorySelector = {\n list(options): Promise<StarlightListResponse<ModelCategory>> {\n return client.get(`/models/${model}/categories`, { ...options })\n },\n\n get(slug): Promise<StarlightItemResponse<ModelCategory>> {\n return client.get(`/models/${model}/categories/${slug}`)\n },\n }\n\n return new Proxy(selector, {\n get(target, prop) {\n if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n return makeModelCategoryInstance(client, model, prop)\n }\n\n return Reflect.get(target, prop)\n },\n }) as DynamicModelCategorySelector<D>\n}\n\nexport {\n ModelCategorySelector,\n DynamicModelCategorySelector,\n ListModelCategoriesOptions,\n}\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":";;;;;AAQA,4CAuBC;AAzBD,kFAAqE;AAErE,SAAwB,yBAAyB,CAC/C,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAA0B;QACtC,IAAI,CAAC,MAAM,EAAE,OAAO;YAClB,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACnE,CAAC;QAED,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO;YACvB,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC3E,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,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;YACvD,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC","sourcesContent":["import { SerializedData, StarlightClient } from '../../types'\nimport {\n DynamicModelCategorySelector,\n ListModelCategoriesOptions,\n ModelCategorySelector,\n} from './types'\nimport makeModelCategoryInstance from '../../instances/ModelCategory'\n\nexport default function makeModelCategorySelector<D extends SerializedData>(\n client: StarlightClient,\n model: string,\n): DynamicModelCategorySelector<D> {\n const selector: ModelCategorySelector = {\n list(params, options) {\n return client.get(`/models/${model}/categories`, params, options)\n },\n\n get(slug, params, options) {\n return client.get(`/models/${model}/categories/${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 makeModelCategoryInstance(client, model, prop)\n }\n\n return Reflect.get(target, prop)\n },\n }) as DynamicModelCategorySelector<D>\n}\n\nexport {\n ModelCategorySelector,\n DynamicModelCategorySelector,\n ListModelCategoriesOptions,\n}\n"]}
@@ -1,4 +1,4 @@
1
- import { BaseRequestParameters, ModelCategory, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
1
+ import { BaseRequestParameters, ListRequestParameters, ModelCategory, SerializedData, StarlightItemResponse, StarlightListResponse } from '../../types';
2
2
  import { ModelCategoryInstance } from '../../instances/ModelCategory';
3
3
  /**
4
4
  * Request parameters for listing model categories.
@@ -7,7 +7,7 @@ import { ModelCategoryInstance } from '../../instances/ModelCategory';
7
7
  *
8
8
  * @group Request Parameters
9
9
  */
10
- export interface ListModelCategoriesOptions extends BaseRequestParameters {
10
+ export interface ListModelCategoriesOptions extends ListRequestParameters {
11
11
  /**
12
12
  * Define how items will be ordered. Check this field type to see the
13
13
  * allowed options.
@@ -35,10 +35,13 @@ export interface ModelCategorySelector {
35
35
  * const response = await Starlight.posts.categories.list()
36
36
  * ```
37
37
  *
38
- * @param options An optional object of request parameters. See
39
- * {@link ListModelCategoriesOptions} for all available options.
38
+ * @param params An optional object of request parameters. See
39
+ * {@link ListModelCategoriesOptions} for all available 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.
40
43
  */
41
- list(options?: ListModelCategoriesOptions): Promise<StarlightListResponse<ModelCategory>>;
44
+ list(params?: ListModelCategoriesOptions, options?: RequestInit): Promise<StarlightListResponse<ModelCategory>>;
42
45
  /**
43
46
  * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.
44
47
  *
@@ -50,8 +53,12 @@ export interface ModelCategorySelector {
50
53
  * ```
51
54
  *
52
55
  * @param slug The category slug.
56
+ * @param params An optional object of request parameters.
57
+ * @param options An optional object of fetch options. See
58
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
59
+ * more info.
53
60
  */
54
- get(slug: string): Promise<StarlightItemResponse<ModelCategory>>;
61
+ get(slug: string, params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<ModelCategory>>;
55
62
  }
56
63
  /**
57
64
  * A Selector that provide all {@link ModelCategorySelector} methods and adds
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAErE;;;;;;GAMG;AACH,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,WAAW,GACX,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,CAAA;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IAEhD;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;CACjE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,cAAc,IAC/D,qBAAqB,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACzC,CAAA"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAErE;;;;;;GAMG;AACH,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,WAAW,GACX,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,CAAA;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,0BAA0B,EACnC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IAEhD;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;CACjD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,4BAA4B,CAAC,CAAC,SAAS,cAAc,IAC/D,qBAAqB,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACzC,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n ModelCategory,\n SerializedData,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance } from '../../instances/ModelCategory'\n\n/**\n * Request parameters for listing model categories.\n *\n * Used by {@apilink ModelCategorySelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListModelCategoriesOptions extends BaseRequestParameters {\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 | 'entry_count:asc'\n | 'entry_count:desc'\n | 'slug:asc'\n | 'slug:desc'\n | 'created_at:asc'\n | 'created_at:desc'\n | 'updated_at:asc'\n | 'updated_at:desc'\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink ModelCategory | ModelCategories}.\n *\n * You can use a ModelCategorySelector by accessing\n * {@apilink ModelInstance.categories}.\n *\n * @group Selectors\n */\nexport interface ModelCategorySelector {\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink ModelCategory | ModelCategories}.\n *\n * @example Requesting all categories from a model.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.categories.list()\n * ```\n *\n * @param options An optional object of request parameters. See\n * {@link ListModelCategoriesOptions} for all available options.\n */\n list(\n options?: ListModelCategoriesOptions\n ): Promise<StarlightListResponse<ModelCategory>>\n\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.\n *\n * @example Requesting information from a category \"premium\" from a model of slug \"plans\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.plans.premium.get()\n * ```\n *\n * @param slug The category slug.\n */\n get(slug: string): Promise<StarlightItemResponse<ModelCategory>>\n}\n\n/**\n * A Selector that provide all {@link ModelCategorySelector} methods and adds\n * support for creating {@apilink ModelCategoryInstance | ModelCategoryInstances}\n * using the dynamic syntax.\n *\n * See {@link ModelCategorySelector} to view all available methods. You can use\n * a DynamicModelCategorySelector by accessing {@apilink ModelInstance.categories}.\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 ModelCategorySelector using the dynamic syntax on a model of slug \"posts\"\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"articles\" below will be a ModelCategorySelector.\n * const response = await Starlight.posts.categories.articles.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicModelCategorySelector<D extends SerializedData> =\n ModelCategorySelector & {\n [slug: string]: ModelCategoryInstance<D>\n }\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n ListRequestParameters,\n ModelCategory,\n SerializedData,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance } from '../../instances/ModelCategory'\n\n/**\n * Request parameters for listing model categories.\n *\n * Used by {@apilink ModelCategorySelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListModelCategoriesOptions extends ListRequestParameters {\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 | 'entry_count:asc'\n | 'entry_count:desc'\n | 'slug:asc'\n | 'slug:desc'\n | 'created_at:asc'\n | 'created_at:desc'\n | 'updated_at:asc'\n | 'updated_at:desc'\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink ModelCategory | ModelCategories}.\n *\n * You can use a ModelCategorySelector by accessing\n * {@apilink ModelInstance.categories}.\n *\n * @group Selectors\n */\nexport interface ModelCategorySelector {\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink ModelCategory | ModelCategories}.\n *\n * @example Requesting all categories from a model.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.categories.list()\n * ```\n *\n * @param params An optional object of request parameters. See\n * {@link ListModelCategoriesOptions} 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?: ListModelCategoriesOptions,\n options?: RequestInit,\n ): Promise<StarlightListResponse<ModelCategory>>\n\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.\n *\n * @example Requesting information from a category \"premium\" from a model of slug \"plans\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.plans.premium.get()\n * ```\n *\n * @param slug The category 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,\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<ModelCategory>>\n}\n\n/**\n * A Selector that provide all {@link ModelCategorySelector} methods and adds\n * support for creating {@apilink ModelCategoryInstance | ModelCategoryInstances}\n * using the dynamic syntax.\n *\n * See {@link ModelCategorySelector} to view all available methods. You can use\n * a DynamicModelCategorySelector by accessing {@apilink ModelInstance.categories}.\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 ModelCategorySelector using the dynamic syntax on a model of slug \"posts\"\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"articles\" below will be a ModelCategorySelector.\n * const response = await Starlight.posts.categories.articles.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicModelCategorySelector<D extends SerializedData> =\n ModelCategorySelector & {\n [slug: string]: ModelCategoryInstance<D>\n }\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,eAAe,EAEhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7D,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,MAAM,EAAE,eAAe,GACtB,cAAc,CAQhB;AAED,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7D,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,MAAM,EAAE,eAAe,GACtB,cAAc,CAMhB;AAED,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,CAAA"}
@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.default = makeSearchSelector;
4
4
  function makeSearchSelector(client) {
5
5
  return {
6
- entries(options) {
7
- return client.get('/search/entries', Object.assign({}, options));
6
+ entries(params, options) {
7
+ return client.get('/search/entries', params, options);
8
8
  },
9
9
  };
10
10
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":";;AAQA,qCAUC;AAVD,SAAwB,kBAAkB,CACxC,MAAuB;IAEvB,OAAO;QACL,OAAO,CACL,OAA4B;YAE5B,OAAO,MAAM,CAAC,GAAG,CAAC,iBAAiB,oBAAO,OAAO,EAAG,CAAA;QACtD,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import {\n Entry,\n SerializedData,\n StarlightClient,\n StarlightListResponse,\n} from '../../types'\nimport { SearchEntriesParams, SearchSelector } from './types'\n\nexport default function makeSearchSelector(\n client: StarlightClient\n): SearchSelector {\n return {\n entries<T extends SerializedData = Record<string, unknown>>(\n options: SearchEntriesParams\n ): Promise<StarlightListResponse<Entry<T>>> {\n return client.get('/search/entries', { ...options })\n },\n }\n}\n\nexport { SearchSelector, SearchEntriesParams }\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Search/index.ts"],"names":[],"mappings":";;AAGA,qCAQC;AARD,SAAwB,kBAAkB,CACxC,MAAuB;IAEvB,OAAO;QACL,OAAO,CAAC,MAAM,EAAE,OAAO;YACrB,OAAO,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACvD,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { SearchEntriesParams, SearchSelector } from './types'\n\nexport default function makeSearchSelector(\n client: StarlightClient,\n): SearchSelector {\n return {\n entries(params, options) {\n return client.get('/search/entries', params, options)\n },\n }\n}\n\nexport { SearchSelector, SearchEntriesParams }\n"]}
@@ -1,4 +1,4 @@
1
- import { BaseRequestParameters, Entry, SerializedData, StarlightListResponse } from '../../types';
1
+ import { ListRequestParameters, Entry, SerializedData, StarlightListResponse } from '../../types';
2
2
  /**
3
3
  * Request parameters for searching entries.
4
4
  *
@@ -6,7 +6,7 @@ import { BaseRequestParameters, Entry, SerializedData, StarlightListResponse } f
6
6
  *
7
7
  * @group Request Parameters
8
8
  */
9
- export interface SearchEntriesParams extends BaseRequestParameters {
9
+ export interface SearchEntriesParams extends ListRequestParameters {
10
10
  /**
11
11
  * A comma-separated list of models. Only entries in these models
12
12
  * will be returned. If undefined, entries from all
@@ -79,9 +79,12 @@ export interface SearchSelector {
79
79
  * })
80
80
  * ```
81
81
  *
82
- * @param options An optional object of request parameters. See
83
- * {@link SearchEntriesParams} for all available options.
82
+ * @param params An optional object of request parameters. See
83
+ * {@link SearchEntriesParams} for all available parameters.
84
+ * @param options An optional object of fetch options. See
85
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
86
+ * more info.
84
87
  */
85
- entries<T extends SerializedData = Record<string, unknown>>(options?: SearchEntriesParams): Promise<StarlightListResponse<Entry<T>>>;
88
+ entries<T extends SerializedData = Record<string, unknown>>(params?: SearchEntriesParams, options?: RequestInit): Promise<StarlightListResponse<Entry<T>>>;
86
89
  }
87
90
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,cAAc,EACd,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,iBAAiB,CAAA;IACrB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,OAAO,CAAC,CAAC,SAAS,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,cAAc,EACd,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAChE;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,gBAAgB,GAChB,iBAAiB,CAAA;IACrB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,OAAO,CAAC,CAAC,SAAS,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxD,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n Entry,\n SerializedData,\n StarlightListResponse,\n} from '../../types'\n\n/**\n * Request parameters for searching entries.\n *\n * Used by {@apilink SearchSelector.entries}.\n *\n * @group Request Parameters\n */\nexport interface SearchEntriesParams extends BaseRequestParameters {\n /**\n * A comma-separated list of models. Only entries in these models\n * will be returned. If undefined, entries from all\n * workspace models will be listed.\n *\n * For instance, to show only entries in the \"posts\" and \"videos\" categories,\n * pass `'posts,videos'`.\n */\n models?: string\n /**\n * A comma-separated list of categories. Only entries in these categories\n * will be returned. If undefined, all entries will be listed, independently\n * of their categories.\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 | 'updated_at:asc'\n | 'updated_at:desc'\n /**\n * If defined, removes the given item from the list. Useful to create \"related\n * posts\" lists.\n *\n * Note: this field only accepts IDs, and not slugs. Only one ID is allowed.\n */\n except?: number\n}\n\n/**\n * A Selector that provide methods to search for content. Only entry search\n * is supported for the time being.\n *\n * You can use a SearchSelector by accessing\n * {@apilink StarlightClient.search}.\n *\n * @group Selectors\n */\nexport interface SearchSelector {\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink Entry | Entries}. By default, entries from all models are\n * returned, but filtering by model can be configured.\n *\n * @example Listing all entries in all workspace models.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.search.entries()\n * ```\n *\n * @example Searching for \"hello world\" within all entries in all workspace models.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.search.entries({\n * query: 'hello world'\n * })\n * ```\n *\n * @example Filtering the last example within specific models.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.search.entries({\n * query: 'hello world',\n * models: 'posts,videos,magazines'\n * })\n * ```\n *\n * @param options An optional object of request parameters. See\n * {@link SearchEntriesParams} for all available options.\n */\n entries<T extends SerializedData = Record<string, unknown>>(\n options?: SearchEntriesParams\n ): Promise<StarlightListResponse<Entry<T>>>\n}\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Search/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n ListRequestParameters,\n Entry,\n SerializedData,\n StarlightListResponse,\n} from '../../types'\n\n/**\n * Request parameters for searching entries.\n *\n * Used by {@apilink SearchSelector.entries}.\n *\n * @group Request Parameters\n */\nexport interface SearchEntriesParams extends ListRequestParameters {\n /**\n * A comma-separated list of models. Only entries in these models\n * will be returned. If undefined, entries from all\n * workspace models will be listed.\n *\n * For instance, to show only entries in the \"posts\" and \"videos\" categories,\n * pass `'posts,videos'`.\n */\n models?: string\n /**\n * A comma-separated list of categories. Only entries in these categories\n * will be returned. If undefined, all entries will be listed, independently\n * of their categories.\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 | 'updated_at:asc'\n | 'updated_at:desc'\n /**\n * If defined, removes the given item from the list. Useful to create \"related\n * posts\" lists.\n *\n * Note: this field only accepts IDs, and not slugs. Only one ID is allowed.\n */\n except?: number\n}\n\n/**\n * A Selector that provide methods to search for content. Only entry search\n * is supported for the time being.\n *\n * You can use a SearchSelector by accessing\n * {@apilink StarlightClient.search}.\n *\n * @group Selectors\n */\nexport interface SearchSelector {\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink Entry | Entries}. By default, entries from all models are\n * returned, but filtering by model can be configured.\n *\n * @example Listing all entries in all workspace models.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.search.entries()\n * ```\n *\n * @example Searching for \"hello world\" within all entries in all workspace models.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.search.entries({\n * query: 'hello world'\n * })\n * ```\n *\n * @example Filtering the last example within specific models.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.search.entries({\n * query: 'hello world',\n * models: 'posts,videos,magazines'\n * })\n * ```\n *\n * @param params An optional object of request parameters. See\n * {@link SearchEntriesParams} 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 entries<T extends SerializedData = Record<string, unknown>>(\n params?: SearchEntriesParams,\n options?: RequestInit,\n ): Promise<StarlightListResponse<Entry<T>>>\n}\n"]}
@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.default = makeSingletonSelector;
4
4
  function makeSingletonSelector(client) {
5
5
  return {
6
- list() {
7
- return client.get('/singletons');
6
+ list(params, options) {
7
+ return client.get('/singletons', params, options);
8
8
  },
9
- get(slug) {
10
- return client.get(`/singletons/${slug}`);
9
+ get(slug, params, options) {
10
+ return client.get(`/singletons/${slug}`, params, options);
11
11
  },
12
12
  };
13
13
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Singleton/index.ts"],"names":[],"mappings":";;AAGA,wCAYC;AAZD,SAAwB,qBAAqB,CAC3C,MAAuB;IAEvB,OAAO;QACL,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;QAClC,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC,CAAA;QAC1C,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { SingletonSelector } from './types'\n\nexport default function makeSingletonSelector(\n client: StarlightClient\n): SingletonSelector {\n return {\n list() {\n return client.get('/singletons')\n },\n\n get(slug) {\n return client.get(`/singletons/${slug}`)\n },\n }\n}\n\nexport { SingletonSelector }\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Singleton/index.ts"],"names":[],"mappings":";;AAGA,wCAYC;AAZD,SAAwB,qBAAqB,CAC3C,MAAuB;IAEvB,OAAO;QACL,IAAI,CAAC,MAAM,EAAE,OAAO;YAClB,OAAO,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACnD,CAAC;QAED,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO;YACvB,OAAO,MAAM,CAAC,GAAG,CAAC,eAAe,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { SingletonSelector } from './types'\n\nexport default function makeSingletonSelector(\n client: StarlightClient,\n): SingletonSelector {\n return {\n list(params, options) {\n return client.get('/singletons', params, options)\n },\n\n get(slug, params, options) {\n return client.get(`/singletons/${slug}`, params, options)\n },\n }\n}\n\nexport { SingletonSelector }\n"]}
@@ -1,4 +1,4 @@
1
- import { SerializedData, Singleton, StarlightItemResponse, StarlightListResponse } from '../../types';
1
+ import { BaseRequestParameters, SerializedData, Singleton, StarlightItemResponse, StarlightListResponse } from '../../types';
2
2
  /**
3
3
  * A Selector that provide methods to list and request information on
4
4
  * {@apilink Singleton | Singletons}.
@@ -37,8 +37,12 @@ export interface SingletonSelector {
37
37
  * ```
38
38
  * @typeParam D - The type of the returned Singleton's `data` property.
39
39
  * @param slug The singleton slug.
40
+ * @param params An optional object of request parameters.
41
+ * @param options An optional object of fetch options. See
42
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
43
+ * more info.
40
44
  */
41
- get<D extends SerializedData>(slug: string): Promise<StarlightItemResponse<Singleton<D>>>;
45
+ get<D extends SerializedData>(slug: string, params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<Singleton<D>>>;
42
46
  /**
43
47
  * Returns a {@link StarlightListResponse} with a list of
44
48
  * {@apilink Singleton | Singletons}.
@@ -49,7 +53,12 @@ export interface SingletonSelector {
49
53
  *
50
54
  * const response = await Starlight.singletons.list()
51
55
  * ```
56
+ *
57
+ * @param params An optional object of request parameters.
58
+ * @param options An optional object of fetch options. See
59
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
60
+ * more info.
52
61
  */
53
- list(): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>;
62
+ list(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>;
54
63
  }
55
64
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,EAC1B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE/C;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3E"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,EAC1B,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE/C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;CACtE"}
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n SerializedData,\n Singleton,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Singleton | Singletons}.\n *\n * You can use an SingletonSelector by accessing\n * {@apilink ModelInstance.singletons}.\n *\n * @group Selectors\n */\nexport interface SingletonSelector {\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link Singleton}.\n * This methods supports typing the returned Singleton by passing its data\n * type as the generic type `<D>`.\n *\n * @example Requesting information from a singleton of slug \"home\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.singletons.get('home')\n * ```\n *\n * @example Typing last example's response.\n * ```ts\n * import Starlight, { StringField, MediaField, VisualField } from '@starlightcms/js-sdk'\n *\n * type HomeFields = {\n * title: StringField\n * subtitle: StringField\n * hero_image: MediaField\n * hero_content: VisualField\n * }\n *\n * // `response.data` will be of type Singleton<HomeFields>\n * const response = await Starlight.singletons.get<HomeFields>('home')\n * ```\n * @typeParam D - The type of the returned Singleton's `data` property.\n * @param slug The singleton slug.\n */\n get<D extends SerializedData>(\n slug: string\n ): Promise<StarlightItemResponse<Singleton<D>>>\n\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink Singleton | Singletons}.\n *\n * @example Requesting all workspace singletons.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.singletons.list()\n * ```\n */\n list(): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>\n}\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n BaseRequestParameters,\n SerializedData,\n Singleton,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Singleton | Singletons}.\n *\n * You can use an SingletonSelector by accessing\n * {@apilink ModelInstance.singletons}.\n *\n * @group Selectors\n */\nexport interface SingletonSelector {\n /**\n * Returns a {@link StarlightItemResponse} with a single {@link Singleton}.\n * This methods supports typing the returned Singleton by passing its data\n * type as the generic type `<D>`.\n *\n * @example Requesting information from a singleton of slug \"home\".\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.singletons.get('home')\n * ```\n *\n * @example Typing last example's response.\n * ```ts\n * import Starlight, { StringField, MediaField, VisualField } from '@starlightcms/js-sdk'\n *\n * type HomeFields = {\n * title: StringField\n * subtitle: StringField\n * hero_image: MediaField\n * hero_content: VisualField\n * }\n *\n * // `response.data` will be of type Singleton<HomeFields>\n * const response = await Starlight.singletons.get<HomeFields>('home')\n * ```\n * @typeParam D - The type of the returned Singleton's `data` property.\n * @param slug The singleton 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<D extends SerializedData>(\n slug: string,\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightItemResponse<Singleton<D>>>\n\n /**\n * Returns a {@link StarlightListResponse} with a list of\n * {@apilink Singleton | Singletons}.\n *\n * @example Requesting all workspace singletons.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.singletons.list()\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 list(\n params?: BaseRequestParameters,\n options?: RequestInit,\n ): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>\n}\n"]}