@learnorama/mozaik-sdk 0.1.0-staging.11.1

package/dist/react/partner-reader.js

@@ -0,0 +1,226 @@
+"use client";
+import { r as request } from "../chunks/client.js";
+import { useMutation, useQuery } from "@tanstack/react-query";
+//#region src/react/partner-reader/partner-reader.ts
+/**
+* Generated by orval 🍺
+* Do not edit manually.
+* Mozaik backend
+* Four products behind one API — Biblio, Médiathèques, the partner catalogues (Nextory and YouScribe) and Prof Express. Authentication is Keycloak SSO only, once, for all of them: see the **auth** section below for the browser flow and the three failure modes.
+* OpenAPI spec version: 0.1.0
+*/
+const withQueryKey = (query, queryKey) => {
+	const result = { queryKey };
+	for (const key of Object.keys(query)) {
+		if (key === "queryKey") continue;
+		Object.defineProperty(result, key, {
+			enumerable: true,
+			configurable: true,
+			get: () => query[key]
+		});
+	}
+	return result;
+};
+const getReadPackageUrl = (provider, mediaId, params) => {
+	const normalizedParams = new URLSearchParams();
+	Object.entries(params || {}).forEach(([key, value]) => {
+		if (value !== void 0) normalizedParams.append(key, value === null ? "null" : String(value));
+	});
+	const stringifiedParams = normalizedParams.toString();
+	return stringifiedParams.length > 0 ? `/partners/${provider}/media/${mediaId}/package?${stringifiedParams}` : `/partners/${provider}/media/${mediaId}/package`;
+};
+/**
+* Where to fetch the content itself.
+*
+* The returned URL is a short-lived DRM-wrapped credential. It is not cached
+* here and should not be stored by the client.
+*
+* Opens a consumption lease, so the read appears in the ledger and counts
+* against the establishment's live seats like any other. Its id comes back in
+* ``lease``: keep it alive with ``PUT /consumption/{eventId}`` and drop it with
+* ``DELETE`` when the reader closes. A client that does neither is not broken
+* — the reaper closes the lease about a minute after the last heartbeat — but
+* every such read is a seat held past the end of it.
+*
+* Re-opening the same title returns the lease already held rather than a
+* second one, so a page reload does not leak a seat.
+* @summary Read Package
+*/
+const readPackage = async (provider, mediaId, params, options) => {
+	return request(getReadPackageUrl(provider, mediaId, params), {
+		...options,
+		method: "GET"
+	});
+};
+const getReadPackageQueryKey = (provider, mediaId, params) => {
+	return [`/partners/${provider}/media/${mediaId}/package`, ...params ? [params] : []];
+};
+const getReadPackageQueryOptions = (provider, mediaId, params, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getReadPackageQueryKey(provider, mediaId, params);
+	const queryFn = ({ signal }) => readPackage(provider, mediaId, params, {
+		signal,
+		...requestOptions
+	});
+	return {
+		queryKey,
+		queryFn,
+		enabled: provider !== null && provider !== void 0 && mediaId !== null && mediaId !== void 0,
+		...queryOptions
+	};
+};
+/**
+* @summary Read Package
+*/
+function useReadPackage(provider, mediaId, params, options, queryClient) {
+	const queryOptions = getReadPackageQueryOptions(provider, mediaId, params, options);
+	const query = useQuery(queryOptions, queryClient);
+	return withQueryKey(query, queryOptions.queryKey);
+}
+const getReadPositionUrl = (provider, mediaId) => {
+	return `/partners/${provider}/media/${mediaId}/position`;
+};
+/**
+* Where this reader last was, according to the partner.
+*
+* ``404`` when the partner holds no position — a book never opened has no
+* place to return to, and reporting zero would make a client jump a reader who
+* *is* mid-book back to the start if the call ever failed soft.
+* @summary Read Position
+*/
+const readPosition = async (provider, mediaId, options) => {
+	return request(getReadPositionUrl(provider, mediaId), {
+		...options,
+		method: "GET"
+	});
+};
+const getReadPositionQueryKey = (provider, mediaId) => {
+	return [`/partners/${provider}/media/${mediaId}/position`];
+};
+const getReadPositionQueryOptions = (provider, mediaId, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getReadPositionQueryKey(provider, mediaId);
+	const queryFn = ({ signal }) => readPosition(provider, mediaId, {
+		signal,
+		...requestOptions
+	});
+	return {
+		queryKey,
+		queryFn,
+		enabled: provider !== null && provider !== void 0 && mediaId !== null && mediaId !== void 0,
+		...queryOptions
+	};
+};
+/**
+* @summary Read Position
+*/
+function useReadPosition(provider, mediaId, options, queryClient) {
+	const queryOptions = getReadPositionQueryOptions(provider, mediaId, options);
+	const query = useQuery(queryOptions, queryClient);
+	return withQueryKey(query, queryOptions.queryKey);
+}
+const getWritePositionUrl = (provider, mediaId) => {
+	return `/partners/${provider}/media/${mediaId}/position`;
+};
+/**
+* Record progress, and report the partner's own metering alongside it.
+*
+* ``usage_blocks`` is forwarded first when present, because the legacy did and
+* the partner treats the two as one act: metering after a position update
+* records consumption against a page the reader has already left.
+* @summary Write Position
+*/
+const writePosition = async (provider, mediaId, readingPositionWrite, options) => {
+	const getHeaders = (h) => {
+		if (!h) return {};
+		if (h instanceof Headers) return Object.fromEntries(h.entries());
+		if (Symbol.iterator in h) return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+		const headers = {};
+		for (const [name, value] of Object.entries(h)) if (value !== void 0) headers[name] = value;
+		return headers;
+	};
+	return request(getWritePositionUrl(provider, mediaId), {
+		...options,
+		method: "PATCH",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(readingPositionWrite)
+	});
+};
+const getWritePositionMutationKey = () => ["writePosition"];
+const getWritePositionMutationOptions = (options) => {
+	const mutationKey = getWritePositionMutationKey();
+	const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey ? options : {
+		...options,
+		mutation: {
+			...options.mutation,
+			mutationKey
+		}
+	} : {
+		mutation: { mutationKey },
+		request: void 0
+	};
+	const mutationFn = (props) => {
+		const { provider, mediaId, data } = props ?? {};
+		return writePosition(provider, mediaId, data, requestOptions);
+	};
+	return {
+		mutationFn,
+		...mutationOptions
+	};
+};
+/**
+* @summary Write Position
+*/
+const useWritePosition = (options, queryClient) => {
+	return useMutation(getWritePositionMutationOptions(options), queryClient);
+};
+const getListCurrentReadingsUrl = (provider) => {
+	return `/partners/${provider}/readings`;
+};
+/**
+* The partner's own "continue reading" list, joined back to our catalogue.
+*
+* Entries the partner knows and our catalogue does not are dropped rather than
+* surfaced with a null id: the import runs nightly and the partner's list is
+* live, so a title added today is genuinely not browsable here yet, and a card
+* that cannot be opened is worse than one that is absent.
+* @summary List Current Readings
+*/
+const listCurrentReadings = async (provider, options) => {
+	return request(getListCurrentReadingsUrl(provider), {
+		...options,
+		method: "GET"
+	});
+};
+const getListCurrentReadingsQueryKey = (provider) => {
+	return [`/partners/${provider}/readings`];
+};
+const getListCurrentReadingsQueryOptions = (provider, options) => {
+	const { query: queryOptions, request: requestOptions } = options ?? {};
+	const queryKey = queryOptions?.queryKey ?? getListCurrentReadingsQueryKey(provider);
+	const queryFn = ({ signal }) => listCurrentReadings(provider, {
+		signal,
+		...requestOptions
+	});
+	return {
+		queryKey,
+		queryFn,
+		enabled: provider !== null && provider !== void 0,
+		...queryOptions
+	};
+};
+/**
+* @summary List Current Readings
+*/
+function useListCurrentReadings(provider, options, queryClient) {
+	const queryOptions = getListCurrentReadingsQueryOptions(provider, options);
+	const query = useQuery(queryOptions, queryClient);
+	return withQueryKey(query, queryOptions.queryKey);
+}
+//#endregion
+export { getListCurrentReadingsQueryKey, getListCurrentReadingsQueryOptions, getListCurrentReadingsUrl, getReadPackageQueryKey, getReadPackageQueryOptions, getReadPackageUrl, getReadPositionQueryKey, getReadPositionQueryOptions, getReadPositionUrl, getWritePositionMutationKey, getWritePositionMutationOptions, getWritePositionUrl, listCurrentReadings, readPackage, readPosition, useListCurrentReadings, useReadPackage, useReadPosition, useWritePosition, writePosition };
+
+//# sourceMappingURL=partner-reader.js.map

package/dist/react/partner-reader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"partner-reader.js","names":[],"sources":["../../src/react/partner-reader/partner-reader.ts"],"sourcesContent":["/**\n * Generated by orval 🍺\n * Do not edit manually.\n * Mozaik backend\n * Four products behind one API — Biblio, Médiathèques, the partner catalogues (Nextory and YouScribe) and Prof Express. Authentication is Keycloak SSO only, once, for all of them: see the **auth** section below for the browser flow and the three failure modes.\n * OpenAPI spec version: 0.1.0\n */\nimport {\n  useMutation,\n  useQuery\n} from '@tanstack/react-query';\nimport type {\n  DataTag,\n  DefinedInitialDataOptions,\n  DefinedUseQueryResult,\n  MutationFunction,\n  QueryClient,\n  QueryFunction,\n  QueryKey,\n  UndefinedInitialDataOptions,\n  UseMutationOptions,\n  UseMutationResult,\n  UseQueryOptions,\n  UseQueryResult\n} from '@tanstack/react-query';\n\nimport type {\n  CurrentReadingListRead,\n  HTTPExceptionResponse,\n  PartnerProvider,\n  ReadPackageParams,\n  ReaderPackageRead,\n  ReadingPositionRead,\n  ReadingPositionWrite,\n  ValidationErrorResponse\n} from '../../models';\n\nimport { request } from '../../client';\nimport type { ErrorType , BodyType } from '../../client';\n\n\ntype SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];\n\n\n\nconst withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKey: K } => {\n  const result = { queryKey } as T & { queryKey: K };\n  for (const key of Object.keys(query)) {\n    // The explicit queryKey always wins, matching the previous\n    // `{ ...query, queryKey }` spread where it was set last.\n    if (key === 'queryKey') continue;\n    Object.defineProperty(result, key, {\n      enumerable: true,\n      configurable: true,\n      get: () => (query as Record<string, unknown>)[key],\n    });\n  }\n  return result;\n};\n\nexport const getReadPackageUrl = (provider: PartnerProvider,\n    mediaId: number,\n    params?: ReadPackageParams,) => {\n  const normalizedParams = new URLSearchParams();\n\n  Object.entries(params || {}).forEach(([key, value]) => {\n\n    if (value !== undefined) {\n      normalizedParams.append(key, value === null ? 'null' : String(value))\n    }\n  });\n\n  const stringifiedParams = normalizedParams.toString();\n\n  return stringifiedParams.length > 0 ? `/partners/${provider}/media/${mediaId}/package?${stringifiedParams}` : `/partners/${provider}/media/${mediaId}/package`\n}\n\n/**\n * Where to fetch the content itself.\n *\n * The returned URL is a short-lived DRM-wrapped credential. It is not cached\n * here and should not be stored by the client.\n *\n * Opens a consumption lease, so the read appears in the ledger and counts\n * against the establishment's live seats like any other. Its id comes back in\n * ``lease``: keep it alive with ``PUT /consumption/{eventId}`` and drop it with\n * ``DELETE`` when the reader closes. A client that does neither is not broken\n * — the reaper closes the lease about a minute after the last heartbeat — but\n * every such read is a seat held past the end of it.\n *\n * Re-opening the same title returns the lease already held rather than a\n * second one, so a page reload does not leak a seat.\n * @summary Read Package\n */\nexport const readPackage = async (provider: PartnerProvider,\n    mediaId: number,\n    params?: ReadPackageParams, options?: Parameters<typeof request>[1]): Promise<ReaderPackageRead> => {\n\n  return request<ReaderPackageRead>(getReadPackageUrl(provider,mediaId,params),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\n\n\n\nexport const getReadPackageQueryKey = (provider: PartnerProvider,\n    mediaId: number,\n    params?: ReadPackageParams,) => {\n    return [\n    `/partners/${provider}/media/${mediaId}/package`, ...(params ? [params] : [])\n    ] as const;\n    }\n\n\nexport const getReadPackageQueryOptions = <TData = Awaited<ReturnType<typeof readPackage>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(provider: PartnerProvider,\n    mediaId: number,\n    params?: ReadPackageParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPackage>>, TError, TData>>, request?: SecondParameter<typeof request>}\n) => {\n\nconst {query: queryOptions, request: requestOptions} = options ?? {};\n\n  const queryKey =  queryOptions?.queryKey ?? getReadPackageQueryKey(provider,mediaId,params);\n\n\n\n    const queryFn: QueryFunction<Awaited<ReturnType<typeof readPackage>>> = ({ signal }) => readPackage(provider,mediaId,params, { signal, ...requestOptions });\n\n\n\n\n\n   return  { queryKey, queryFn, enabled: provider !== null && provider !== undefined && mediaId !== null && mediaId !== undefined, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof readPackage>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }\n}\n\nexport type ReadPackageQueryResult = NonNullable<Awaited<ReturnType<typeof readPackage>>>\nexport type ReadPackageQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>\n\n\nexport function useReadPackage<TData = Awaited<ReturnType<typeof readPackage>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number,\n    params: undefined |  ReadPackageParams, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPackage>>, TError, TData>> & Pick<\n        DefinedInitialDataOptions<\n          Awaited<ReturnType<typeof readPackage>>,\n          TError,\n          Awaited<ReturnType<typeof readPackage>>\n        > , 'initialData'\n      >, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\nexport function useReadPackage<TData = Awaited<ReturnType<typeof readPackage>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number,\n    params?: ReadPackageParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPackage>>, TError, TData>> & Pick<\n        UndefinedInitialDataOptions<\n          Awaited<ReturnType<typeof readPackage>>,\n          TError,\n          Awaited<ReturnType<typeof readPackage>>\n        > , 'initialData'\n      >, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\nexport function useReadPackage<TData = Awaited<ReturnType<typeof readPackage>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number,\n    params?: ReadPackageParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPackage>>, TError, TData>>, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\n/**\n * @summary Read Package\n */\n\nexport function useReadPackage<TData = Awaited<ReturnType<typeof readPackage>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number,\n    params?: ReadPackageParams, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPackage>>, TError, TData>>, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {\n\n  const queryOptions = getReadPackageQueryOptions(provider,mediaId,params,options)\n\n  const query = useQuery(queryOptions, queryClient) as  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\n\n  return withQueryKey(query, queryOptions.queryKey);\n}\n\n\n\n\n\n\nexport const getReadPositionUrl = (provider: PartnerProvider,\n    mediaId: number,) => {\n\n\n\n\n  return `/partners/${provider}/media/${mediaId}/position`\n}\n\n/**\n * Where this reader last was, according to the partner.\n *\n * ``404`` when the partner holds no position — a book never opened has no\n * place to return to, and reporting zero would make a client jump a reader who\n * *is* mid-book back to the start if the call ever failed soft.\n * @summary Read Position\n */\nexport const readPosition = async (provider: PartnerProvider,\n    mediaId: number, options?: Parameters<typeof request>[1]): Promise<ReadingPositionRead> => {\n\n  return request<ReadingPositionRead>(getReadPositionUrl(provider,mediaId),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\n\n\n\nexport const getReadPositionQueryKey = (provider: PartnerProvider,\n    mediaId: number,) => {\n    return [\n    `/partners/${provider}/media/${mediaId}/position`\n    ] as const;\n    }\n\n\nexport const getReadPositionQueryOptions = <TData = Awaited<ReturnType<typeof readPosition>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(provider: PartnerProvider,\n    mediaId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPosition>>, TError, TData>>, request?: SecondParameter<typeof request>}\n) => {\n\nconst {query: queryOptions, request: requestOptions} = options ?? {};\n\n  const queryKey =  queryOptions?.queryKey ?? getReadPositionQueryKey(provider,mediaId);\n\n\n\n    const queryFn: QueryFunction<Awaited<ReturnType<typeof readPosition>>> = ({ signal }) => readPosition(provider,mediaId, { signal, ...requestOptions });\n\n\n\n\n\n   return  { queryKey, queryFn, enabled: provider !== null && provider !== undefined && mediaId !== null && mediaId !== undefined, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof readPosition>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }\n}\n\nexport type ReadPositionQueryResult = NonNullable<Awaited<ReturnType<typeof readPosition>>>\nexport type ReadPositionQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>\n\n\nexport function useReadPosition<TData = Awaited<ReturnType<typeof readPosition>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPosition>>, TError, TData>> & Pick<\n        DefinedInitialDataOptions<\n          Awaited<ReturnType<typeof readPosition>>,\n          TError,\n          Awaited<ReturnType<typeof readPosition>>\n        > , 'initialData'\n      >, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\nexport function useReadPosition<TData = Awaited<ReturnType<typeof readPosition>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPosition>>, TError, TData>> & Pick<\n        UndefinedInitialDataOptions<\n          Awaited<ReturnType<typeof readPosition>>,\n          TError,\n          Awaited<ReturnType<typeof readPosition>>\n        > , 'initialData'\n      >, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\nexport function useReadPosition<TData = Awaited<ReturnType<typeof readPosition>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPosition>>, TError, TData>>, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\n/**\n * @summary Read Position\n */\n\nexport function useReadPosition<TData = Awaited<ReturnType<typeof readPosition>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider,\n    mediaId: number, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof readPosition>>, TError, TData>>, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {\n\n  const queryOptions = getReadPositionQueryOptions(provider,mediaId,options)\n\n  const query = useQuery(queryOptions, queryClient) as  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\n\n  return withQueryKey(query, queryOptions.queryKey);\n}\n\n\n\n\n\n\nexport const getWritePositionUrl = (provider: PartnerProvider,\n    mediaId: number,) => {\n\n\n\n\n  return `/partners/${provider}/media/${mediaId}/position`\n}\n\n/**\n * Record progress, and report the partner's own metering alongside it.\n *\n * ``usage_blocks`` is forwarded first when present, because the legacy did and\n * the partner treats the two as one act: metering after a position update\n * records consumption against a page the reader has already left.\n * @summary Write Position\n */\nexport const writePosition = async (provider: PartnerProvider,\n    mediaId: number,\n    readingPositionWrite: ReadingPositionWrite, options?: Parameters<typeof request>[1]): Promise<ReadingPositionRead> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<ReadingPositionRead>(getWritePositionUrl(provider,mediaId),\n  {\n    ...options,\n    method: 'PATCH',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(readingPositionWrite)\n  }\n);}\n\n\n\n\n\nexport const getWritePositionMutationKey = () => ['writePosition'] as const;\n\nexport const getWritePositionMutationOptions = <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>,\n    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof writePosition>>, TError,WritePositionMutationVariables, TContext>, request?: SecondParameter<typeof request>}\n): UseMutationOptions<Awaited<ReturnType<typeof writePosition>>, TError,WritePositionMutationVariables, TContext> => {\n\nconst mutationKey = getWritePositionMutationKey();\nconst {mutation: mutationOptions, request: requestOptions} = options ?\n      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?\n      options\n      : {...options, mutation: {...options.mutation, mutationKey}}\n      : {mutation: { mutationKey, }, request: undefined};\n\n\n\n\n      const mutationFn: MutationFunction<Awaited<ReturnType<typeof writePosition>>, WritePositionMutationVariables> = (props) => {\n          const {provider,mediaId,data} = props ?? {};\n\n          return  writePosition(provider,mediaId,data,requestOptions)\n        }\n\n\n\n\n\n\n  return  { mutationFn, ...mutationOptions }}\n\n    export type WritePositionMutationResult = NonNullable<Awaited<ReturnType<typeof writePosition>>>\n    export type WritePositionMutationBody = BodyType<ReadingPositionWrite>\n    export type WritePositionMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>\n    export type WritePositionMutationVariables = {provider: PartnerProvider;mediaId: number;data: BodyType<ReadingPositionWrite>}\n\n    /**\n * @summary Write Position\n */\nexport const useWritePosition = <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>,\n    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof writePosition>>, TError,WritePositionMutationVariables, TContext>, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient): UseMutationResult<\n        Awaited<ReturnType<typeof writePosition>>,\n        TError,\n        WritePositionMutationVariables,\n        TContext\n      > => {\n      return useMutation(getWritePositionMutationOptions(options), queryClient);\n    }\n    export const getListCurrentReadingsUrl = (provider: PartnerProvider,) => {\n\n\n\n\n  return `/partners/${provider}/readings`\n}\n\n/**\n * The partner's own \"continue reading\" list, joined back to our catalogue.\n *\n * Entries the partner knows and our catalogue does not are dropped rather than\n * surfaced with a null id: the import runs nightly and the partner's list is\n * live, so a title added today is genuinely not browsable here yet, and a card\n * that cannot be opened is worse than one that is absent.\n * @summary List Current Readings\n */\nexport const listCurrentReadings = async (provider: PartnerProvider, options?: Parameters<typeof request>[1]): Promise<CurrentReadingListRead> => {\n\n  return request<CurrentReadingListRead>(getListCurrentReadingsUrl(provider),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\n\n\n\nexport const getListCurrentReadingsQueryKey = (provider: PartnerProvider,) => {\n    return [\n    `/partners/${provider}/readings`\n    ] as const;\n    }\n\n\nexport const getListCurrentReadingsQueryOptions = <TData = Awaited<ReturnType<typeof listCurrentReadings>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(provider: PartnerProvider, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof listCurrentReadings>>, TError, TData>>, request?: SecondParameter<typeof request>}\n) => {\n\nconst {query: queryOptions, request: requestOptions} = options ?? {};\n\n  const queryKey =  queryOptions?.queryKey ?? getListCurrentReadingsQueryKey(provider);\n\n\n\n    const queryFn: QueryFunction<Awaited<ReturnType<typeof listCurrentReadings>>> = ({ signal }) => listCurrentReadings(provider, { signal, ...requestOptions });\n\n\n\n\n\n   return  { queryKey, queryFn, enabled: provider !== null && provider !== undefined, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof listCurrentReadings>>, TError, TData> & { queryKey: DataTag<QueryKey, TData, TError> }\n}\n\nexport type ListCurrentReadingsQueryResult = NonNullable<Awaited<ReturnType<typeof listCurrentReadings>>>\nexport type ListCurrentReadingsQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>\n\n\nexport function useListCurrentReadings<TData = Awaited<ReturnType<typeof listCurrentReadings>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider, options: { query:Partial<UseQueryOptions<Awaited<ReturnType<typeof listCurrentReadings>>, TError, TData>> & Pick<\n        DefinedInitialDataOptions<\n          Awaited<ReturnType<typeof listCurrentReadings>>,\n          TError,\n          Awaited<ReturnType<typeof listCurrentReadings>>\n        > , 'initialData'\n      >, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\nexport function useListCurrentReadings<TData = Awaited<ReturnType<typeof listCurrentReadings>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof listCurrentReadings>>, TError, TData>> & Pick<\n        UndefinedInitialDataOptions<\n          Awaited<ReturnType<typeof listCurrentReadings>>,\n          TError,\n          Awaited<ReturnType<typeof listCurrentReadings>>\n        > , 'initialData'\n      >, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\nexport function useListCurrentReadings<TData = Awaited<ReturnType<typeof listCurrentReadings>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof listCurrentReadings>>, TError, TData>>, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n  ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> }\n/**\n * @summary List Current Readings\n */\n\nexport function useListCurrentReadings<TData = Awaited<ReturnType<typeof listCurrentReadings>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(\n provider: PartnerProvider, options?: { query?:Partial<UseQueryOptions<Awaited<ReturnType<typeof listCurrentReadings>>, TError, TData>>, request?: SecondParameter<typeof request>}\n , queryClient?: QueryClient\n ):  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {\n\n  const queryOptions = getListCurrentReadingsQueryOptions(provider,options)\n\n  const query = useQuery(queryOptions, queryClient) as  UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };\n\n  return withQueryKey(query, queryOptions.queryKey);\n}\n\n\n\n\n\n\n"],"mappings":";;;;;;;;;;;AA6CA,MAAM,gBAAqC,OAAU,aAAqC;CACxF,MAAM,SAAS,EAAE,SAAS;CAC1B,KAAK,MAAM,OAAO,OAAO,KAAK,KAAK,GAAG;EAGpC,IAAI,QAAQ,YAAY;EACxB,OAAO,eAAe,QAAQ,KAAK;GACjC,YAAY;GACZ,cAAc;GACd,WAAY,MAAkC;EAChD,CAAC;CACH;CACA,OAAO;AACT;AAEA,MAAa,qBAAqB,UAC9B,SACA,WAAgC;CAClC,MAAM,mBAAmB,IAAI,gBAAgB;CAE7C,OAAO,QAAQ,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,WAAW;EAErD,IAAI,UAAU,KAAA,GACZ,iBAAiB,OAAO,KAAK,UAAU,OAAO,SAAS,OAAO,KAAK,CAAC;CAExE,CAAC;CAED,MAAM,oBAAoB,iBAAiB,SAAS;CAEpD,OAAO,kBAAkB,SAAS,IAAI,aAAa,SAAS,SAAS,QAAQ,WAAW,sBAAsB,aAAa,SAAS,SAAS,QAAQ;AACvJ;;;;;;;;;;;;;;;;;;AAmBA,MAAa,cAAc,OAAO,UAC9B,SACA,QAA4B,YAAwE;CAEtG,OAAO,QAA2B,kBAAkB,UAAS,SAAQ,MAAM,GAC3E;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAMF,MAAa,0BAA0B,UACnC,SACA,WAAgC;CAChC,OAAO,CACP,aAAa,SAAS,SAAS,QAAQ,WAAW,GAAI,SAAS,CAAC,MAAM,IAAI,CAAC,CAC3E;AACA;AAGJ,MAAa,8BAAoJ,UAC7J,SACA,QAA4B,YAC3B;CAEL,MAAM,EAAC,OAAO,cAAc,SAAS,mBAAkB,WAAW,CAAC;CAEjE,MAAM,WAAY,cAAc,YAAY,uBAAuB,UAAS,SAAQ,MAAM;CAIxF,MAAM,WAAmE,EAAE,aAAa,YAAY,UAAS,SAAQ,QAAQ;EAAE;EAAQ,GAAG;CAAe,CAAC;CAM3J,OAAQ;EAAE;EAAU;EAAS,SAAS,aAAa,QAAQ,aAAa,KAAA,KAAa,YAAY,QAAQ,YAAY,KAAA;EAAW,GAAG;CAAY;AAClJ;;;;AAwCA,SAAgB,eACf,UACG,SACA,QAA4B,SAC7B,aACiF;CAElF,MAAM,eAAe,2BAA2B,UAAS,SAAQ,QAAO,OAAO;CAE/E,MAAM,QAAQ,SAAS,cAAc,WAAW;CAEhD,OAAO,aAAa,OAAO,aAAa,QAAQ;AAClD;AAOA,MAAa,sBAAsB,UAC/B,YAAqB;CAKvB,OAAO,aAAa,SAAS,SAAS,QAAQ;AAChD;;;;;;;;;AAUA,MAAa,eAAe,OAAO,UAC/B,SAAiB,YAA0E;CAE7F,OAAO,QAA6B,mBAAmB,UAAS,OAAO,GACvE;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAMF,MAAa,2BAA2B,UACpC,YAAqB;CACrB,OAAO,CACP,aAAa,SAAS,SAAS,QAAQ,UACvC;AACA;AAGJ,MAAa,+BAAsJ,UAC/J,SAAiB,YAChB;CAEL,MAAM,EAAC,OAAO,cAAc,SAAS,mBAAkB,WAAW,CAAC;CAEjE,MAAM,WAAY,cAAc,YAAY,wBAAwB,UAAS,OAAO;CAIlF,MAAM,WAAoE,EAAE,aAAa,aAAa,UAAS,SAAS;EAAE;EAAQ,GAAG;CAAe,CAAC;CAMtJ,OAAQ;EAAE;EAAU;EAAS,SAAS,aAAa,QAAQ,aAAa,KAAA,KAAa,YAAY,QAAQ,YAAY,KAAA;EAAW,GAAG;CAAY;AAClJ;;;;AAqCA,SAAgB,gBACf,UACG,SAAiB,SAClB,aACiF;CAElF,MAAM,eAAe,4BAA4B,UAAS,SAAQ,OAAO;CAEzE,MAAM,QAAQ,SAAS,cAAc,WAAW;CAEhD,OAAO,aAAa,OAAO,aAAa,QAAQ;AAClD;AAOA,MAAa,uBAAuB,UAChC,YAAqB;CAKvB,OAAO,aAAa,SAAS,SAAS,QAAQ;AAChD;;;;;;;;;AAUA,MAAa,gBAAgB,OAAO,UAChC,SACA,sBAA4C,YAA0E;CAEtH,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAA6B,oBAAoB,UAAS,OAAO,GACtE;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,oBAAoB;CAC3C,CACF;AAAE;AAMF,MAAa,oCAAoC,CAAC,eAAe;AAEjE,MAAa,mCACW,YAC6F;CAErH,MAAM,cAAc,4BAA4B;CAChD,MAAM,EAAC,UAAU,iBAAiB,SAAS,mBAAkB,UACvD,QAAQ,YAAY,iBAAiB,QAAQ,YAAY,QAAQ,SAAS,cAC1E,UACE;EAAC,GAAG;EAAS,UAAU;GAAC,GAAG,QAAQ;GAAU;EAAW;CAAC,IACzD;EAAC,UAAU,EAAE,YAAa;EAAG,SAAS,KAAA;CAAS;CAKjD,MAAM,cAA2G,UAAU;EACvH,MAAM,EAAC,UAAS,SAAQ,SAAQ,SAAS,CAAC;EAE1C,OAAQ,cAAc,UAAS,SAAQ,MAAK,cAAc;CAC5D;CAON,OAAQ;EAAE;EAAY,GAAG;CAAgB;AAAC;;;;AAU5C,MAAa,oBACW,SACrB,gBAKQ;CACL,OAAO,YAAY,gCAAgC,OAAO,GAAG,WAAW;AAC1E;AACA,MAAa,6BAA6B,aAA+B;CAK3E,OAAO,aAAa,SAAS;AAC/B;;;;;;;;;;AAWA,MAAa,sBAAsB,OAAO,UAA2B,YAA6E;CAEhJ,OAAO,QAAgC,0BAA0B,QAAQ,GACzE;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAMF,MAAa,kCAAkC,aAA+B;CAC1E,OAAO,CACP,aAAa,SAAS,UACtB;AACA;AAGJ,MAAa,sCAAoK,UAA2B,YACvM;CAEL,MAAM,EAAC,OAAO,cAAc,SAAS,mBAAkB,WAAW,CAAC;CAEjE,MAAM,WAAY,cAAc,YAAY,+BAA+B,QAAQ;CAIjF,MAAM,WAA2E,EAAE,aAAa,oBAAoB,UAAU;EAAE;EAAQ,GAAG;CAAe,CAAC;CAM5J,OAAQ;EAAE;EAAU;EAAS,SAAS,aAAa,QAAQ,aAAa,KAAA;EAAW,GAAG;CAAY;AACrG;;;;AAkCA,SAAgB,uBACf,UAA2B,SACzB,aACiF;CAElF,MAAM,eAAe,mCAAmC,UAAS,OAAO;CAExE,MAAM,QAAQ,SAAS,cAAc,WAAW;CAEhD,OAAO,aAAa,OAAO,aAAa,QAAQ;AAClD"}

package/dist/react/profiles.d.ts

@@ -0,0 +1,174 @@
+
+import { Gn as HTTPExceptionResponse, gt as ProfileCreateWrite, ht as ProfileRead, mt as ProfileListRead, pt as ProfileUpdateWrite, t as ValidationErrorResponse } from "../chunks/index.js";
+import { a as ErrorType, c as request, n as BodyType } from "../chunks/client.js";
+import { DataTag, DefinedInitialDataOptions, DefinedUseQueryResult, QueryClient, QueryKey, UndefinedInitialDataOptions, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from "@tanstack/react-query";
+//#region src/react/profiles/profiles.d.ts
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+export declare const getListProfilesUrl: () => string;
+/**
+ * Every profile on this account, the holder included (E20).
+ *
+ * Unpaginated: the cap is :data:`PROFILE_LIMIT`, so there is no page to turn.
+ * One endpoint replaces two legacy routes that rendered the same collection
+ * differently — the difference was presentation, which is the client's problem.
+ * @summary List Profiles
+ */
+export declare const listProfiles: (options?: Parameters<typeof request>[1]) => Promise<ProfileListRead>;
+export declare const getListProfilesQueryKey: () => readonly [`/me/profiles`];
+export declare const getListProfilesQueryOptions: <TData = Awaited<ReturnType<typeof listProfiles>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProfiles>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listProfiles>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListProfilesQueryResult = NonNullable<Awaited<ReturnType<typeof listProfiles>>>;
+export type ListProfilesQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useListProfiles<TData = Awaited<ReturnType<typeof listProfiles>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProfiles>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listProfiles>>, TError, Awaited<ReturnType<typeof listProfiles>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListProfiles<TData = Awaited<ReturnType<typeof listProfiles>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProfiles>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listProfiles>>, TError, Awaited<ReturnType<typeof listProfiles>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListProfiles<TData = Awaited<ReturnType<typeof listProfiles>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listProfiles>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getCreateProfileUrl: () => string;
+/**
+ * Add a profile to this account (E21).
+ *
+ * The new row inherits ``tenant_id`` from the holder rather than accepting one:
+ * a profile belongs to the same company as the account it hangs off, and
+ * letting that be supplied would be a way into another tenant.
+ *
+ * A profile has no credential of its own. It has no ``login``, no ``email`` and
+ * no password — it is reached by switching within an authenticated session, so
+ * there is nothing for it to authenticate *with*.
+ * @summary Create Profile
+ */
+export declare const createProfile: (profileCreateWrite: ProfileCreateWrite, options?: Parameters<typeof request>[1]) => Promise<ProfileRead>;
+export declare const getCreateProfileMutationKey: () => readonly ['createProfile'];
+export declare const getCreateProfileMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof createProfile>>, TError, CreateProfileMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof createProfile>>, TError, CreateProfileMutationVariables, TContext>;
+export type CreateProfileMutationResult = NonNullable<Awaited<ReturnType<typeof createProfile>>>;
+export type CreateProfileMutationBody = BodyType<ProfileCreateWrite>;
+export type CreateProfileMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type CreateProfileMutationVariables = {
+  data: BodyType<ProfileCreateWrite>;
+};
+/**
+ * @summary Create Profile
+ */
+export declare const useCreateProfile: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof createProfile>>, TError, CreateProfileMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createProfile>>, TError, CreateProfileMutationVariables, TContext>;
+export declare const getDeleteProfileUrl: (profileId: number) => string;
+/**
+ * Remove a profile (E24). Idempotent.
+ *
+ * Deleting a profile that is already gone is ``204``, not ``404``: the caller
+ * asked for it to be absent and it is absent. A retried delete after a timeout
+ * must not read as a failure.
+ *
+ * The account holder cannot be deleted this way — that is E17, which anonymises
+ * the whole account and is a different decision with different consequences.
+ * @summary Delete Profile
+ */
+export declare const deleteProfile: (profileId: number, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getDeleteProfileMutationKey: () => readonly ['deleteProfile'];
+export declare const getDeleteProfileMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteProfile>>, TError, DeleteProfileMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof deleteProfile>>, TError, DeleteProfileMutationVariables, TContext>;
+export type DeleteProfileMutationResult = NonNullable<Awaited<ReturnType<typeof deleteProfile>>>;
+export type DeleteProfileMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type DeleteProfileMutationVariables = {
+  profileId: number;
+};
+/**
+ * @summary Delete Profile
+ */
+export declare const useDeleteProfile: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteProfile>>, TError, DeleteProfileMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteProfile>>, TError, DeleteProfileMutationVariables, TContext>;
+export declare const getReadProfileUrl: (profileId: number) => string;
+/**
+ * One profile (E22). Returns the resource; the legacy rendered an edit form.
+ * @summary Read Profile
+ */
+export declare const readProfile: (profileId: number, options?: Parameters<typeof request>[1]) => Promise<ProfileRead>;
+export declare const getReadProfileQueryKey: (profileId: number) => readonly [`/me/profiles/${number}`];
+export declare const getReadProfileQueryOptions: <TData = Awaited<ReturnType<typeof readProfile>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(profileId: number, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readProfile>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof readProfile>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ReadProfileQueryResult = NonNullable<Awaited<ReturnType<typeof readProfile>>>;
+export type ReadProfileQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useReadProfile<TData = Awaited<ReturnType<typeof readProfile>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(profileId: number, options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readProfile>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readProfile>>, TError, Awaited<ReturnType<typeof readProfile>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadProfile<TData = Awaited<ReturnType<typeof readProfile>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(profileId: number, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readProfile>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readProfile>>, TError, Awaited<ReturnType<typeof readProfile>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadProfile<TData = Awaited<ReturnType<typeof readProfile>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(profileId: number, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readProfile>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getUpdateProfileUrl: (profileId: number) => string;
+/**
+ * Partially update a profile (E23).
+ *
+ * The target comes from the path and the row is re-read from the database
+ * before anything is written, so nothing in the body can retarget the write.
+ * That is the one habit worth keeping from the legacy handler, which overwrote
+ * the identity fields from the trusted record for exactly this reason.
+ *
+ * ``exclude_unset`` is what makes this a PATCH rather than a PUT wearing the
+ * wrong verb: a field the client did not send is untouched, which is not the
+ * same as a field it sent as null.
+ * @summary Update Profile
+ */
+export declare const updateProfile: (profileId: number, profileUpdateWrite: ProfileUpdateWrite, options?: Parameters<typeof request>[1]) => Promise<ProfileRead>;
+export declare const getUpdateProfileMutationKey: () => readonly ['updateProfile'];
+export declare const getUpdateProfileMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateProfile>>, TError, UpdateProfileMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof updateProfile>>, TError, UpdateProfileMutationVariables, TContext>;
+export type UpdateProfileMutationResult = NonNullable<Awaited<ReturnType<typeof updateProfile>>>;
+export type UpdateProfileMutationBody = BodyType<ProfileUpdateWrite>;
+export type UpdateProfileMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type UpdateProfileMutationVariables = {
+  profileId: number;
+  data: BodyType<ProfileUpdateWrite>;
+};
+/**
+ * @summary Update Profile
+ */
+export declare const useUpdateProfile: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateProfile>>, TError, UpdateProfileMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updateProfile>>, TError, UpdateProfileMutationVariables, TContext>;
+//#endregion
+//# sourceMappingURL=profiles.d.ts.map