@learnorama/mozaik-sdk 0.1.0-staging.11.1

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 (208) hide show
  1. package/README.md +94 -0
  2. package/dist/api/account.d.ts +75 -0
  3. package/dist/api/account.js +117 -0
  4. package/dist/api/account.js.map +1 -0
  5. package/dist/api/admin-catalogue.d.ts +68 -0
  6. package/dist/api/admin-catalogue.js +155 -0
  7. package/dist/api/admin-catalogue.js.map +1 -0
  8. package/dist/api/admin-consumption.d.ts +27 -0
  9. package/dist/api/admin-consumption.js +55 -0
  10. package/dist/api/admin-consumption.js.map +1 -0
  11. package/dist/api/admin-licenses.d.ts +21 -0
  12. package/dist/api/admin-licenses.js +34 -0
  13. package/dist/api/admin-licenses.js.map +1 -0
  14. package/dist/api/admin-patrons.d.ts +36 -0
  15. package/dist/api/admin-patrons.js +76 -0
  16. package/dist/api/admin-patrons.js.map +1 -0
  17. package/dist/api/admin-reviews.d.ts +30 -0
  18. package/dist/api/admin-reviews.js +63 -0
  19. package/dist/api/admin-reviews.js.map +1 -0
  20. package/dist/api/admin-roles.d.ts +34 -0
  21. package/dist/api/admin-roles.js +62 -0
  22. package/dist/api/admin-roles.js.map +1 -0
  23. package/dist/api/admin-support.d.ts +68 -0
  24. package/dist/api/admin-support.js +116 -0
  25. package/dist/api/admin-support.js.map +1 -0
  26. package/dist/api/admin-tenants.d.ts +33 -0
  27. package/dist/api/admin-tenants.js +68 -0
  28. package/dist/api/admin-tenants.js.map +1 -0
  29. package/dist/api/admin-tutoring.d.ts +159 -0
  30. package/dist/api/admin-tutoring.js +455 -0
  31. package/dist/api/admin-tutoring.js.map +1 -0
  32. package/dist/api/auth.d.ts +92 -0
  33. package/dist/api/auth.js +192 -0
  34. package/dist/api/auth.js.map +1 -0
  35. package/dist/api/biblio-catalogue.d.ts +122 -0
  36. package/dist/api/biblio-catalogue.js +223 -0
  37. package/dist/api/biblio-catalogue.js.map +1 -0
  38. package/dist/api/biblio-home.d.ts +18 -0
  39. package/dist/api/biblio-home.js +31 -0
  40. package/dist/api/biblio-home.js.map +1 -0
  41. package/dist/api/biblio-library.d.ts +94 -0
  42. package/dist/api/biblio-library.js +187 -0
  43. package/dist/api/biblio-library.js.map +1 -0
  44. package/dist/api/biblio-nextory.d.ts +43 -0
  45. package/dist/api/biblio-nextory.js +65 -0
  46. package/dist/api/biblio-nextory.js.map +1 -0
  47. package/dist/api/biblio-press.d.ts +38 -0
  48. package/dist/api/biblio-press.js +70 -0
  49. package/dist/api/biblio-press.js.map +1 -0
  50. package/dist/api/biblio-search.d.ts +17 -0
  51. package/dist/api/biblio-search.js +30 -0
  52. package/dist/api/biblio-search.js.map +1 -0
  53. package/dist/api/biblio-telemetry.d.ts +28 -0
  54. package/dist/api/biblio-telemetry.js +49 -0
  55. package/dist/api/biblio-telemetry.js.map +1 -0
  56. package/dist/api/consumption.d.ts +30 -0
  57. package/dist/api/consumption.js +45 -0
  58. package/dist/api/consumption.js.map +1 -0
  59. package/dist/api/cvs-app.d.ts +39 -0
  60. package/dist/api/cvs-app.js +72 -0
  61. package/dist/api/cvs-app.js.map +1 -0
  62. package/dist/api/cvs-documents.d.ts +106 -0
  63. package/dist/api/cvs-documents.js +208 -0
  64. package/dist/api/cvs-documents.js.map +1 -0
  65. package/dist/api/cvs-favorites.d.ts +53 -0
  66. package/dist/api/cvs-favorites.js +82 -0
  67. package/dist/api/cvs-favorites.js.map +1 -0
  68. package/dist/api/cvs-loans.d.ts +59 -0
  69. package/dist/api/cvs-loans.js +106 -0
  70. package/dist/api/cvs-loans.js.map +1 -0
  71. package/dist/api/cvs-streaming.d.ts +40 -0
  72. package/dist/api/cvs-streaming.js +68 -0
  73. package/dist/api/cvs-streaming.js.map +1 -0
  74. package/dist/api/index.d.ts +34 -0
  75. package/dist/api/index.js +34 -0
  76. package/dist/api/partner-catalogue.d.ts +77 -0
  77. package/dist/api/partner-catalogue.js +125 -0
  78. package/dist/api/partner-catalogue.js.map +1 -0
  79. package/dist/api/partner-reader.d.ts +56 -0
  80. package/dist/api/partner-reader.js +103 -0
  81. package/dist/api/partner-reader.js.map +1 -0
  82. package/dist/api/profiles.d.ts +64 -0
  83. package/dist/api/profiles.js +126 -0
  84. package/dist/api/profiles.js.map +1 -0
  85. package/dist/api/tutoring-catalogue.d.ts +32 -0
  86. package/dist/api/tutoring-catalogue.js +59 -0
  87. package/dist/api/tutoring-catalogue.js.map +1 -0
  88. package/dist/api/tutoring-chat.d.ts +31 -0
  89. package/dist/api/tutoring-chat.js +71 -0
  90. package/dist/api/tutoring-chat.js.map +1 -0
  91. package/dist/api/tutoring-dispatch.d.ts +37 -0
  92. package/dist/api/tutoring-dispatch.js +83 -0
  93. package/dist/api/tutoring-dispatch.js.map +1 -0
  94. package/dist/api/tutoring-practitioner.d.ts +55 -0
  95. package/dist/api/tutoring-practitioner.js +110 -0
  96. package/dist/api/tutoring-practitioner.js.map +1 -0
  97. package/dist/api/tutoring-requests.d.ts +86 -0
  98. package/dist/api/tutoring-requests.js +176 -0
  99. package/dist/api/tutoring-requests.js.map +1 -0
  100. package/dist/chunks/client.d.ts +28 -0
  101. package/dist/chunks/client.js +61 -0
  102. package/dist/chunks/client.js.map +1 -0
  103. package/dist/chunks/index.d.ts +4566 -0
  104. package/dist/index.d.ts +9 -0
  105. package/dist/index.js +10 -0
  106. package/dist/index.js.map +1 -0
  107. package/dist/models.d.ts +3 -0
  108. package/dist/models.js +175 -0
  109. package/dist/models.js.map +1 -0
  110. package/dist/react/account.d.ts +163 -0
  111. package/dist/react/account.js +240 -0
  112. package/dist/react/account.js.map +1 -0
  113. package/dist/react/admin-catalogue.d.ts +196 -0
  114. package/dist/react/admin-catalogue.js +336 -0
  115. package/dist/react/admin-catalogue.js.map +1 -0
  116. package/dist/react/admin-consumption.d.ts +75 -0
  117. package/dist/react/admin-consumption.js +127 -0
  118. package/dist/react/admin-consumption.js.map +1 -0
  119. package/dist/react/admin-licenses.d.ts +50 -0
  120. package/dist/react/admin-licenses.js +78 -0
  121. package/dist/react/admin-licenses.js.map +1 -0
  122. package/dist/react/admin-patrons.d.ts +111 -0
  123. package/dist/react/admin-patrons.js +173 -0
  124. package/dist/react/admin-patrons.js.map +1 -0
  125. package/dist/react/admin-reviews.d.ts +78 -0
  126. package/dist/react/admin-reviews.js +135 -0
  127. package/dist/react/admin-reviews.js.map +1 -0
  128. package/dist/react/admin-roles.d.ts +82 -0
  129. package/dist/react/admin-roles.js +135 -0
  130. package/dist/react/admin-roles.js.map +1 -0
  131. package/dist/react/admin-support.d.ts +123 -0
  132. package/dist/react/admin-support.js +208 -0
  133. package/dist/react/admin-support.js.map +1 -0
  134. package/dist/react/admin-tenants.d.ts +108 -0
  135. package/dist/react/admin-tenants.js +165 -0
  136. package/dist/react/admin-tenants.js.map +1 -0
  137. package/dist/react/admin-tutoring.d.ts +556 -0
  138. package/dist/react/admin-tutoring.js +954 -0
  139. package/dist/react/admin-tutoring.js.map +1 -0
  140. package/dist/react/auth.d.ts +220 -0
  141. package/dist/react/auth.js +372 -0
  142. package/dist/react/auth.js.map +1 -0
  143. package/dist/react/biblio-catalogue.d.ts +374 -0
  144. package/dist/react/biblio-catalogue.js +498 -0
  145. package/dist/react/biblio-catalogue.js.map +1 -0
  146. package/dist/react/biblio-home.d.ts +47 -0
  147. package/dist/react/biblio-home.js +75 -0
  148. package/dist/react/biblio-home.js.map +1 -0
  149. package/dist/react/biblio-library.d.ts +285 -0
  150. package/dist/react/biblio-library.js +411 -0
  151. package/dist/react/biblio-library.js.map +1 -0
  152. package/dist/react/biblio-nextory.d.ts +100 -0
  153. package/dist/react/biblio-nextory.js +163 -0
  154. package/dist/react/biblio-nextory.js.map +1 -0
  155. package/dist/react/biblio-press.d.ts +121 -0
  156. package/dist/react/biblio-press.js +163 -0
  157. package/dist/react/biblio-press.js.map +1 -0
  158. package/dist/react/biblio-search.d.ts +46 -0
  159. package/dist/react/biblio-search.js +74 -0
  160. package/dist/react/biblio-search.js.map +1 -0
  161. package/dist/react/biblio-telemetry.d.ts +49 -0
  162. package/dist/react/biblio-telemetry.js +85 -0
  163. package/dist/react/biblio-telemetry.js.map +1 -0
  164. package/dist/react/consumption.d.ts +66 -0
  165. package/dist/react/consumption.js +109 -0
  166. package/dist/react/consumption.js.map +1 -0
  167. package/dist/react/cvs-app.d.ts +86 -0
  168. package/dist/react/cvs-app.js +144 -0
  169. package/dist/react/cvs-app.js.map +1 -0
  170. package/dist/react/cvs-documents.d.ts +254 -0
  171. package/dist/react/cvs-documents.js +418 -0
  172. package/dist/react/cvs-documents.js.map +1 -0
  173. package/dist/react/cvs-favorites.d.ts +143 -0
  174. package/dist/react/cvs-favorites.js +206 -0
  175. package/dist/react/cvs-favorites.js.map +1 -0
  176. package/dist/react/cvs-loans.d.ts +140 -0
  177. package/dist/react/cvs-loans.js +234 -0
  178. package/dist/react/cvs-loans.js.map +1 -0
  179. package/dist/react/cvs-streaming.d.ts +87 -0
  180. package/dist/react/cvs-streaming.js +141 -0
  181. package/dist/react/cvs-streaming.js.map +1 -0
  182. package/dist/react/index.d.ts +34 -0
  183. package/dist/react/index.js +34 -0
  184. package/dist/react/partner-catalogue.d.ts +223 -0
  185. package/dist/react/partner-catalogue.js +301 -0
  186. package/dist/react/partner-catalogue.js.map +1 -0
  187. package/dist/react/partner-reader.d.ts +159 -0
  188. package/dist/react/partner-reader.js +226 -0
  189. package/dist/react/partner-reader.js.map +1 -0
  190. package/dist/react/profiles.d.ts +174 -0
  191. package/dist/react/profiles.js +279 -0
  192. package/dist/react/profiles.js.map +1 -0
  193. package/dist/react/tutoring-catalogue.d.ts +115 -0
  194. package/dist/react/tutoring-catalogue.js +151 -0
  195. package/dist/react/tutoring-catalogue.js.map +1 -0
  196. package/dist/react/tutoring-chat.d.ts +96 -0
  197. package/dist/react/tutoring-chat.js +172 -0
  198. package/dist/react/tutoring-chat.js.map +1 -0
  199. package/dist/react/tutoring-dispatch.d.ts +102 -0
  200. package/dist/react/tutoring-dispatch.js +183 -0
  201. package/dist/react/tutoring-dispatch.js.map +1 -0
  202. package/dist/react/tutoring-practitioner.d.ts +129 -0
  203. package/dist/react/tutoring-practitioner.js +230 -0
  204. package/dist/react/tutoring-practitioner.js.map +1 -0
  205. package/dist/react/tutoring-requests.d.ts +233 -0
  206. package/dist/react/tutoring-requests.js +385 -0
  207. package/dist/react/tutoring-requests.js.map +1 -0
  208. package/package.json +70 -0
@@ -0,0 +1,374 @@
1
+
2
+ import { An as LikeRead, Gn as HTTPExceptionResponse, Or as ContentRead, Rr as CatalogRead, Vn as LearningPathDetailRead, Wt as PackDetailRead, X as RecommendationsRead, Z as ReadRecommendationsParams, dt as ReadCatalogParams, et as ReadPackParams, fr as EditorDetailRead, lr as EditorListRead, lt as ReadEditorParams, t as ValidationErrorResponse, ut as ReadCatalogThemeParams, wn as ListEditorsParams } from "../chunks/index.js";
3
+ import { a as ErrorType, c as request } from "../chunks/client.js";
4
+ import { DataTag, DefinedInitialDataOptions, DefinedUseQueryResult, QueryClient, QueryKey, UndefinedInitialDataOptions, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from "@tanstack/react-query";
5
+ //#region src/react/biblio-catalogue/biblio-catalogue.d.ts
6
+ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
7
+ export declare const getReadContentUrl: (contentId: number) => string;
8
+ /**
9
+ * One content item, with this caller's own state on it (E34).
10
+ *
11
+ * ``liked`` and ``favorited`` are why this is not just the summary shape: they
12
+ * are per-caller and therefore uncacheable across users, which is worth knowing
13
+ * before anyone puts a shared cache in front of it.
14
+ * @summary Read Content
15
+ */
16
+ export declare const readContent: (contentId: number, options?: Parameters<typeof request>[1]) => Promise<ContentRead>;
17
+ export declare const getReadContentQueryKey: (contentId: number) => readonly [`/biblio/contents/${number}`];
18
+ export declare const getReadContentQueryOptions: <TData = Awaited<ReturnType<typeof readContent>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, options?: {
19
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readContent>>, TError, TData>>;
20
+ request?: SecondParameter<typeof request>;
21
+ }) => UseQueryOptions<Awaited<ReturnType<typeof readContent>>, TError, TData> & {
22
+ queryKey: DataTag<QueryKey, TData, TError>;
23
+ };
24
+ export type ReadContentQueryResult = NonNullable<Awaited<ReturnType<typeof readContent>>>;
25
+ export type ReadContentQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
26
+ export declare function useReadContent<TData = Awaited<ReturnType<typeof readContent>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, options: {
27
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readContent>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readContent>>, TError, Awaited<ReturnType<typeof readContent>>>, 'initialData'>;
28
+ request?: SecondParameter<typeof request>;
29
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
30
+ queryKey: DataTag<QueryKey, TData, TError>;
31
+ };
32
+ export declare function useReadContent<TData = Awaited<ReturnType<typeof readContent>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, options?: {
33
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readContent>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readContent>>, TError, Awaited<ReturnType<typeof readContent>>>, 'initialData'>;
34
+ request?: SecondParameter<typeof request>;
35
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
36
+ queryKey: DataTag<QueryKey, TData, TError>;
37
+ };
38
+ export declare function useReadContent<TData = Awaited<ReturnType<typeof readContent>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, options?: {
39
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readContent>>, TError, TData>>;
40
+ request?: SecondParameter<typeof request>;
41
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
42
+ queryKey: DataTag<QueryKey, TData, TError>;
43
+ };
44
+ export declare const getUnlikeContentUrl: (contentId: number) => string;
45
+ /**
46
+ * Withdraw a like (E37). Idempotent — not liked is already the desired state.
47
+ * @summary Unlike Content
48
+ */
49
+ export declare const unlikeContent: (contentId: number, options?: Parameters<typeof request>[1]) => Promise<LikeRead>;
50
+ export declare const getUnlikeContentMutationKey: () => readonly ['unlikeContent'];
51
+ export declare const getUnlikeContentMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
52
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof unlikeContent>>, TError, UnlikeContentMutationVariables, TContext>;
53
+ request?: SecondParameter<typeof request>;
54
+ }) => UseMutationOptions<Awaited<ReturnType<typeof unlikeContent>>, TError, UnlikeContentMutationVariables, TContext>;
55
+ export type UnlikeContentMutationResult = NonNullable<Awaited<ReturnType<typeof unlikeContent>>>;
56
+ export type UnlikeContentMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
57
+ export type UnlikeContentMutationVariables = {
58
+ contentId: number;
59
+ };
60
+ /**
61
+ * @summary Unlike Content
62
+ */
63
+ export declare const useUnlikeContent: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
64
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof unlikeContent>>, TError, UnlikeContentMutationVariables, TContext>;
65
+ request?: SecondParameter<typeof request>;
66
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof unlikeContent>>, TError, UnlikeContentMutationVariables, TContext>;
67
+ export declare const getLikeContentUrl: (contentId: number) => string;
68
+ /**
69
+ * Record a like (E36). Idempotent.
70
+ *
71
+ * This and :func:`unlike_content` replace one non-idempotent
72
+ * ``POST /content/{id}/toggle-like``. A retried toggle reverses the user's
73
+ * intent; a repeated ``PUT`` cannot (§4, consequence 3).
74
+ *
75
+ * ``like_count`` is recomputed from ``content_rating`` rather than incremented,
76
+ * because an increment beside an upsert double-counts the second time the same
77
+ * person likes the same thing.
78
+ * @summary Like Content
79
+ */
80
+ export declare const likeContent: (contentId: number, options?: Parameters<typeof request>[1]) => Promise<LikeRead>;
81
+ export declare const getLikeContentMutationKey: () => readonly ['likeContent'];
82
+ export declare const getLikeContentMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
83
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof likeContent>>, TError, LikeContentMutationVariables, TContext>;
84
+ request?: SecondParameter<typeof request>;
85
+ }) => UseMutationOptions<Awaited<ReturnType<typeof likeContent>>, TError, LikeContentMutationVariables, TContext>;
86
+ export type LikeContentMutationResult = NonNullable<Awaited<ReturnType<typeof likeContent>>>;
87
+ export type LikeContentMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
88
+ export type LikeContentMutationVariables = {
89
+ contentId: number;
90
+ };
91
+ /**
92
+ * @summary Like Content
93
+ */
94
+ export declare const useLikeContent: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
95
+ mutation?: UseMutationOptions<Awaited<ReturnType<typeof likeContent>>, TError, LikeContentMutationVariables, TContext>;
96
+ request?: SecondParameter<typeof request>;
97
+ }, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof likeContent>>, TError, LikeContentMutationVariables, TContext>;
98
+ export declare const getReadRecommendationsUrl: (contentId: number, params?: ReadRecommendationsParams) => string;
99
+ /**
100
+ * Related content the caller can also reach (E35).
101
+ *
102
+ * Recommending something the account cannot open is worse than recommending
103
+ * nothing, so the candidate set is entitlement-filtered before ranking rather
104
+ * than after — filtering afterwards silently shortens the list instead.
105
+ *
106
+ * Keyword overlap for now, over the GIN index on ``content.keywords``.
107
+ * @summary Read Recommendations
108
+ */
109
+ export declare const readRecommendations: (contentId: number, params?: ReadRecommendationsParams, options?: Parameters<typeof request>[1]) => Promise<RecommendationsRead>;
110
+ export declare const getReadRecommendationsQueryKey: (contentId: number, params?: ReadRecommendationsParams) => readonly [`/biblio/contents/${number}/recommendations`, ...ReadRecommendationsParams[]];
111
+ export declare const getReadRecommendationsQueryOptions: <TData = Awaited<ReturnType<typeof readRecommendations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, params?: ReadRecommendationsParams, options?: {
112
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readRecommendations>>, TError, TData>>;
113
+ request?: SecondParameter<typeof request>;
114
+ }) => UseQueryOptions<Awaited<ReturnType<typeof readRecommendations>>, TError, TData> & {
115
+ queryKey: DataTag<QueryKey, TData, TError>;
116
+ };
117
+ export type ReadRecommendationsQueryResult = NonNullable<Awaited<ReturnType<typeof readRecommendations>>>;
118
+ export type ReadRecommendationsQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
119
+ export declare function useReadRecommendations<TData = Awaited<ReturnType<typeof readRecommendations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, params: undefined | ReadRecommendationsParams, options: {
120
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readRecommendations>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readRecommendations>>, TError, Awaited<ReturnType<typeof readRecommendations>>>, 'initialData'>;
121
+ request?: SecondParameter<typeof request>;
122
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
123
+ queryKey: DataTag<QueryKey, TData, TError>;
124
+ };
125
+ export declare function useReadRecommendations<TData = Awaited<ReturnType<typeof readRecommendations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, params?: ReadRecommendationsParams, options?: {
126
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readRecommendations>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readRecommendations>>, TError, Awaited<ReturnType<typeof readRecommendations>>>, 'initialData'>;
127
+ request?: SecondParameter<typeof request>;
128
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
129
+ queryKey: DataTag<QueryKey, TData, TError>;
130
+ };
131
+ export declare function useReadRecommendations<TData = Awaited<ReturnType<typeof readRecommendations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(contentId: number, params?: ReadRecommendationsParams, options?: {
132
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readRecommendations>>, TError, TData>>;
133
+ request?: SecondParameter<typeof request>;
134
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
135
+ queryKey: DataTag<QueryKey, TData, TError>;
136
+ };
137
+ export declare const getListEditorsUrl: (params?: ListEditorsParams) => string;
138
+ /**
139
+ * Active editors (E44).
140
+ *
141
+ * ``order`` and ``sort`` are resolved against a whitelist and never
142
+ * interpolated. The legacy passed both straight to the query layer (defect
143
+ * D17); an unrecognised value is ``422`` rather than a surprise ordering.
144
+ *
145
+ * The collection is not wrapped in a single-element array. The legacy
146
+ * ``GET /api/v1/editors/`` was (§2.1).
147
+ *
148
+ * Authenticated even though the answer does not depend on who is asking. Which
149
+ * publishers a platform carries is commercial information, and an endpoint that
150
+ * enumerates them for anyone is a competitor's first request. The sibling
151
+ * ``/editors/{id}`` was already authenticated; this one was not, which is how
152
+ * the inconsistency was found.
153
+ * @summary List Editors
154
+ */
155
+ export declare const listEditors: (params?: ListEditorsParams, options?: Parameters<typeof request>[1]) => Promise<EditorListRead>;
156
+ export declare const getListEditorsQueryKey: (params?: ListEditorsParams) => readonly ["/biblio/editors", ...ListEditorsParams[]];
157
+ export declare const getListEditorsQueryOptions: <TData = Awaited<ReturnType<typeof listEditors>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params?: ListEditorsParams, options?: {
158
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listEditors>>, TError, TData>>;
159
+ request?: SecondParameter<typeof request>;
160
+ }) => UseQueryOptions<Awaited<ReturnType<typeof listEditors>>, TError, TData> & {
161
+ queryKey: DataTag<QueryKey, TData, TError>;
162
+ };
163
+ export type ListEditorsQueryResult = NonNullable<Awaited<ReturnType<typeof listEditors>>>;
164
+ export type ListEditorsQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
165
+ export declare function useListEditors<TData = Awaited<ReturnType<typeof listEditors>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params: undefined | ListEditorsParams, options: {
166
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listEditors>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listEditors>>, TError, Awaited<ReturnType<typeof listEditors>>>, 'initialData'>;
167
+ request?: SecondParameter<typeof request>;
168
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
169
+ queryKey: DataTag<QueryKey, TData, TError>;
170
+ };
171
+ export declare function useListEditors<TData = Awaited<ReturnType<typeof listEditors>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params?: ListEditorsParams, options?: {
172
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listEditors>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listEditors>>, TError, Awaited<ReturnType<typeof listEditors>>>, 'initialData'>;
173
+ request?: SecondParameter<typeof request>;
174
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
175
+ queryKey: DataTag<QueryKey, TData, TError>;
176
+ };
177
+ export declare function useListEditors<TData = Awaited<ReturnType<typeof listEditors>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params?: ListEditorsParams, options?: {
178
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listEditors>>, TError, TData>>;
179
+ request?: SecondParameter<typeof request>;
180
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
181
+ queryKey: DataTag<QueryKey, TData, TError>;
182
+ };
183
+ export declare const getReadEditorUrl: (editorId: number, params?: ReadEditorParams) => string;
184
+ /**
185
+ * One editor and the content of theirs this caller can reach (E45).
186
+ *
187
+ * One endpoint replaces two — a page and a JSON route that used ``pageSize``
188
+ * instead of ``limit`` and wrapped the object in an array. Same entity, two
189
+ * conventions, one codebase (§4, consequence 5).
190
+ * @summary Read Editor
191
+ */
192
+ export declare const readEditor: (editorId: number, params?: ReadEditorParams, options?: Parameters<typeof request>[1]) => Promise<EditorDetailRead>;
193
+ export declare const getReadEditorQueryKey: (editorId: number, params?: ReadEditorParams) => readonly [`/biblio/editors/${number}`, ...ReadEditorParams[]];
194
+ export declare const getReadEditorQueryOptions: <TData = Awaited<ReturnType<typeof readEditor>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(editorId: number, params?: ReadEditorParams, options?: {
195
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readEditor>>, TError, TData>>;
196
+ request?: SecondParameter<typeof request>;
197
+ }) => UseQueryOptions<Awaited<ReturnType<typeof readEditor>>, TError, TData> & {
198
+ queryKey: DataTag<QueryKey, TData, TError>;
199
+ };
200
+ export type ReadEditorQueryResult = NonNullable<Awaited<ReturnType<typeof readEditor>>>;
201
+ export type ReadEditorQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
202
+ export declare function useReadEditor<TData = Awaited<ReturnType<typeof readEditor>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(editorId: number, params: undefined | ReadEditorParams, options: {
203
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readEditor>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readEditor>>, TError, Awaited<ReturnType<typeof readEditor>>>, 'initialData'>;
204
+ request?: SecondParameter<typeof request>;
205
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
206
+ queryKey: DataTag<QueryKey, TData, TError>;
207
+ };
208
+ export declare function useReadEditor<TData = Awaited<ReturnType<typeof readEditor>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(editorId: number, params?: ReadEditorParams, options?: {
209
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readEditor>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readEditor>>, TError, Awaited<ReturnType<typeof readEditor>>>, 'initialData'>;
210
+ request?: SecondParameter<typeof request>;
211
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
212
+ queryKey: DataTag<QueryKey, TData, TError>;
213
+ };
214
+ export declare function useReadEditor<TData = Awaited<ReturnType<typeof readEditor>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(editorId: number, params?: ReadEditorParams, options?: {
215
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readEditor>>, TError, TData>>;
216
+ request?: SecondParameter<typeof request>;
217
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
218
+ queryKey: DataTag<QueryKey, TData, TError>;
219
+ };
220
+ export declare const getReadLearningPathUrl: (learningPathId: number) => string;
221
+ /**
222
+ * A ``parcours`` and the content it walks through, in order.
223
+ *
224
+ * The other end of the ``parcours`` array on a pack, which named paths a client
225
+ * then had no way to open.
226
+ *
227
+ * Steps the caller is not entitled to are **dropped, not hidden behind a
228
+ * padlock**: the same category test every listing uses decides what appears, so
229
+ * a path cannot become a way to learn that an item exists. That does mean a
230
+ * path can come back with fewer steps than the library curated, and with gaps
231
+ * in ``stepOrder`` — which is why the order is a field rather than the array
232
+ * index.
233
+ *
234
+ * An inactive path is ``404`` rather than an empty one: it was withdrawn, and
235
+ * an empty sequence would read as "we have nothing for you" instead.
236
+ * @summary Read Learning Path
237
+ */
238
+ export declare const readLearningPath: (learningPathId: number, options?: Parameters<typeof request>[1]) => Promise<LearningPathDetailRead>;
239
+ export declare const getReadLearningPathQueryKey: (learningPathId: number) => readonly [`/biblio/learning-paths/${number}`];
240
+ export declare const getReadLearningPathQueryOptions: <TData = Awaited<ReturnType<typeof readLearningPath>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(learningPathId: number, options?: {
241
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readLearningPath>>, TError, TData>>;
242
+ request?: SecondParameter<typeof request>;
243
+ }) => UseQueryOptions<Awaited<ReturnType<typeof readLearningPath>>, TError, TData> & {
244
+ queryKey: DataTag<QueryKey, TData, TError>;
245
+ };
246
+ export type ReadLearningPathQueryResult = NonNullable<Awaited<ReturnType<typeof readLearningPath>>>;
247
+ export type ReadLearningPathQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
248
+ export declare function useReadLearningPath<TData = Awaited<ReturnType<typeof readLearningPath>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(learningPathId: number, options: {
249
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readLearningPath>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readLearningPath>>, TError, Awaited<ReturnType<typeof readLearningPath>>>, 'initialData'>;
250
+ request?: SecondParameter<typeof request>;
251
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
252
+ queryKey: DataTag<QueryKey, TData, TError>;
253
+ };
254
+ export declare function useReadLearningPath<TData = Awaited<ReturnType<typeof readLearningPath>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(learningPathId: number, options?: {
255
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readLearningPath>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readLearningPath>>, TError, Awaited<ReturnType<typeof readLearningPath>>>, 'initialData'>;
256
+ request?: SecondParameter<typeof request>;
257
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
258
+ queryKey: DataTag<QueryKey, TData, TError>;
259
+ };
260
+ export declare function useReadLearningPath<TData = Awaited<ReturnType<typeof readLearningPath>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(learningPathId: number, options?: {
261
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readLearningPath>>, TError, TData>>;
262
+ request?: SecondParameter<typeof request>;
263
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
264
+ queryKey: DataTag<QueryKey, TData, TError>;
265
+ };
266
+ export declare const getReadPackUrl: (packId: number, params?: ReadPackParams) => string;
267
+ /**
268
+ * A pack with its catalogs, latest additions and learning paths (E38).
269
+ *
270
+ * ``canonical`` is how the redirect dies. When a pack resolves to a single
271
+ * catalog the legacy answered ``302``; here the response is ``200`` and
272
+ * ``canonical`` names the resolved catalog, leaving the client to decide whether
273
+ * to follow it (§5.1).
274
+ *
275
+ * A pack the caller has no entitlement to is ``404``. The legacy dereferenced
276
+ * ``null`` and returned ``500`` (defect D12).
277
+ * @summary Read Pack
278
+ */
279
+ export declare const readPack: (packId: number, params?: ReadPackParams, options?: Parameters<typeof request>[1]) => Promise<PackDetailRead>;
280
+ export declare const getReadPackQueryKey: (packId: number, params?: ReadPackParams) => readonly [`/biblio/packs/${number}`, ...ReadPackParams[]];
281
+ export declare const getReadPackQueryOptions: <TData = Awaited<ReturnType<typeof readPack>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, params?: ReadPackParams, options?: {
282
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readPack>>, TError, TData>>;
283
+ request?: SecondParameter<typeof request>;
284
+ }) => UseQueryOptions<Awaited<ReturnType<typeof readPack>>, TError, TData> & {
285
+ queryKey: DataTag<QueryKey, TData, TError>;
286
+ };
287
+ export type ReadPackQueryResult = NonNullable<Awaited<ReturnType<typeof readPack>>>;
288
+ export type ReadPackQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
289
+ export declare function useReadPack<TData = Awaited<ReturnType<typeof readPack>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, params: undefined | ReadPackParams, options: {
290
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readPack>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readPack>>, TError, Awaited<ReturnType<typeof readPack>>>, 'initialData'>;
291
+ request?: SecondParameter<typeof request>;
292
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
293
+ queryKey: DataTag<QueryKey, TData, TError>;
294
+ };
295
+ export declare function useReadPack<TData = Awaited<ReturnType<typeof readPack>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, params?: ReadPackParams, options?: {
296
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readPack>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readPack>>, TError, Awaited<ReturnType<typeof readPack>>>, 'initialData'>;
297
+ request?: SecondParameter<typeof request>;
298
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
299
+ queryKey: DataTag<QueryKey, TData, TError>;
300
+ };
301
+ export declare function useReadPack<TData = Awaited<ReturnType<typeof readPack>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, params?: ReadPackParams, options?: {
302
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readPack>>, TError, TData>>;
303
+ request?: SecondParameter<typeof request>;
304
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
305
+ queryKey: DataTag<QueryKey, TData, TError>;
306
+ };
307
+ export declare const getReadCatalogUrl: (packId: number, catalogId: number, params?: ReadCatalogParams) => string;
308
+ /**
309
+ * One catalog inside a pack (E39).
310
+ * @summary Read Catalog
311
+ */
312
+ export declare const readCatalog: (packId: number, catalogId: number, params?: ReadCatalogParams, options?: Parameters<typeof request>[1]) => Promise<CatalogRead>;
313
+ export declare const getReadCatalogQueryKey: (packId: number, catalogId: number, params?: ReadCatalogParams) => readonly [`/biblio/packs/${number}/catalogs/${number}`, ...ReadCatalogParams[]];
314
+ export declare const getReadCatalogQueryOptions: <TData = Awaited<ReturnType<typeof readCatalog>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, params?: ReadCatalogParams, options?: {
315
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalog>>, TError, TData>>;
316
+ request?: SecondParameter<typeof request>;
317
+ }) => UseQueryOptions<Awaited<ReturnType<typeof readCatalog>>, TError, TData> & {
318
+ queryKey: DataTag<QueryKey, TData, TError>;
319
+ };
320
+ export type ReadCatalogQueryResult = NonNullable<Awaited<ReturnType<typeof readCatalog>>>;
321
+ export type ReadCatalogQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
322
+ export declare function useReadCatalog<TData = Awaited<ReturnType<typeof readCatalog>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, params: undefined | ReadCatalogParams, options: {
323
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalog>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readCatalog>>, TError, Awaited<ReturnType<typeof readCatalog>>>, 'initialData'>;
324
+ request?: SecondParameter<typeof request>;
325
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
326
+ queryKey: DataTag<QueryKey, TData, TError>;
327
+ };
328
+ export declare function useReadCatalog<TData = Awaited<ReturnType<typeof readCatalog>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, params?: ReadCatalogParams, options?: {
329
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalog>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readCatalog>>, TError, Awaited<ReturnType<typeof readCatalog>>>, 'initialData'>;
330
+ request?: SecondParameter<typeof request>;
331
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
332
+ queryKey: DataTag<QueryKey, TData, TError>;
333
+ };
334
+ export declare function useReadCatalog<TData = Awaited<ReturnType<typeof readCatalog>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, params?: ReadCatalogParams, options?: {
335
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalog>>, TError, TData>>;
336
+ request?: SecondParameter<typeof request>;
337
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
338
+ queryKey: DataTag<QueryKey, TData, TError>;
339
+ };
340
+ export declare const getReadCatalogThemeUrl: (packId: number, catalogId: number, themeId: number, params?: ReadCatalogThemeParams) => string;
341
+ /**
342
+ * The same catalog, narrowed to one theme (E40).
343
+ * @summary Read Catalog Theme
344
+ */
345
+ export declare const readCatalogTheme: (packId: number, catalogId: number, themeId: number, params?: ReadCatalogThemeParams, options?: Parameters<typeof request>[1]) => Promise<CatalogRead>;
346
+ export declare const getReadCatalogThemeQueryKey: (packId: number, catalogId: number, themeId: number, params?: ReadCatalogThemeParams) => readonly [`/biblio/packs/${number}/catalogs/${number}/themes/${number}`, ...ReadCatalogThemeParams[]];
347
+ export declare const getReadCatalogThemeQueryOptions: <TData = Awaited<ReturnType<typeof readCatalogTheme>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, themeId: number, params?: ReadCatalogThemeParams, options?: {
348
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalogTheme>>, TError, TData>>;
349
+ request?: SecondParameter<typeof request>;
350
+ }) => UseQueryOptions<Awaited<ReturnType<typeof readCatalogTheme>>, TError, TData> & {
351
+ queryKey: DataTag<QueryKey, TData, TError>;
352
+ };
353
+ export type ReadCatalogThemeQueryResult = NonNullable<Awaited<ReturnType<typeof readCatalogTheme>>>;
354
+ export type ReadCatalogThemeQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
355
+ export declare function useReadCatalogTheme<TData = Awaited<ReturnType<typeof readCatalogTheme>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, themeId: number, params: undefined | ReadCatalogThemeParams, options: {
356
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalogTheme>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readCatalogTheme>>, TError, Awaited<ReturnType<typeof readCatalogTheme>>>, 'initialData'>;
357
+ request?: SecondParameter<typeof request>;
358
+ }, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
359
+ queryKey: DataTag<QueryKey, TData, TError>;
360
+ };
361
+ export declare function useReadCatalogTheme<TData = Awaited<ReturnType<typeof readCatalogTheme>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, themeId: number, params?: ReadCatalogThemeParams, options?: {
362
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalogTheme>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readCatalogTheme>>, TError, Awaited<ReturnType<typeof readCatalogTheme>>>, 'initialData'>;
363
+ request?: SecondParameter<typeof request>;
364
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
365
+ queryKey: DataTag<QueryKey, TData, TError>;
366
+ };
367
+ export declare function useReadCatalogTheme<TData = Awaited<ReturnType<typeof readCatalogTheme>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(packId: number, catalogId: number, themeId: number, params?: ReadCatalogThemeParams, options?: {
368
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readCatalogTheme>>, TError, TData>>;
369
+ request?: SecondParameter<typeof request>;
370
+ }, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
371
+ queryKey: DataTag<QueryKey, TData, TError>;
372
+ };
373
+ //#endregion
374
+ //# sourceMappingURL=biblio-catalogue.d.ts.map