@umbraco-cms/backoffice 17.4.0-rc2 → 18.0.0-beta1

package/dist-cms/packages/core/backend-api/client/types.gen.d.ts

@@ -47,7 +47,7 @@ export interface Config<T extends ClientOptions = ClientOptions> extends Omit<Re
 export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
     responseStyle: TResponseStyle;
     throwOnError: ThrowOnError;
-}>, Pick<ServerSentEventsOptions<TData>, 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
     /**
      * Any body that you want to add to your request.
      *
@@ -63,6 +63,7 @@ export interface RequestOptions<TData = unknown, TResponseStyle extends Response
     url: Url;
 }
 export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    headers: Headers;
     serializedBody?: string;
 }
 export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
@@ -76,8 +77,10 @@ export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extend
     data: undefined;
     error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
 }) & {
-    request: Request;
-    response: Response;
+    /** request may be undefined, because error may be from building the request object itself */
+    request?: Request;
+    /** response may be undefined, because error may be from building the request object itself or from a network error */
+    response?: Response;
 }>;
 export interface ClientOptions {
     baseUrl?: string;
@@ -85,14 +88,14 @@ export interface ClientOptions {
     throwOnError?: boolean;
 }
 type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
-type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
+type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
 type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
 type BuildUrlFn = <TData extends {
     body?: unknown;
     path?: Record<string, unknown>;
     query?: Record<string, unknown>;
     url: string;
-}>(options: Pick<TData, 'url'> & Options<TData>) => string;
+}>(options: TData & Options<TData>) => string;
 export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
     interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
 };
@@ -113,12 +116,5 @@ export interface TDataShape {
     url: string;
 }
 type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & Omit<TData, 'url'>;
-export type OptionsLegacyParser<TData = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = TData extends {
-    body?: any;
-} ? TData extends {
-    headers?: any;
-} ? OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body' | 'headers' | 'url'> & TData : OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body' | 'url'> & TData & Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers'> : TData extends {
-    headers?: any;
-} ? OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'headers' | 'url'> & TData & Pick<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'body'> : OmitKeys<RequestOptions<unknown, TResponseStyle, ThrowOnError>, 'url'> & TData;
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
 export {};

package/dist-cms/packages/core/backend-api/client/utils.gen.d.ts

@@ -1,6 +1,6 @@
 import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
 import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js';
-export declare const createQuerySerializer: <T = unknown>({ allowReserved, array, object, }?: QuerySerializerOptions) => (queryParams: T) => string;
+export declare const createQuerySerializer: <T = unknown>({ parameters, ...args }?: QuerySerializerOptions) => (queryParams: T) => string;
 /**
  * Infers parseAs value from provided Content-Type header.
  */
@@ -11,7 +11,11 @@ export declare const setAuthParams: ({ security, ...options }: Pick<Required<Req
 export declare const buildUrl: Client['buildUrl'];
 export declare const mergeConfigs: (a: Config, b: Config) => Config;
 export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
-type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, 
+/** response may be undefined due to a network error where no response object is produced */
+response: Res | undefined, 
+/** request may be undefined, because error may be from building the request object itself */
+request: Req | undefined, options: Options) => Err | Promise<Err>;
 type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
 type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
 declare class Interceptors<Interceptor> {

package/dist-cms/packages/core/backend-api/client/utils.gen.js

@@ -3,7 +3,7 @@ import { getAuthToken } from '../core/auth.gen.js';
 import { jsonBodySerializer } from '../core/bodySerializer.gen.js';
 import { serializeArrayParam, serializeObjectParam, serializePrimitiveParam, } from '../core/pathSerializer.gen.js';
 import { getUrl } from '../core/utils.gen.js';
-export const createQuerySerializer = ({ allowReserved, array, object, } = {}) => {
+export const createQuerySerializer = ({ parameters = {}, ...args } = {}) => {
     const querySerializer = (queryParams) => {
         const search = [];
         if (queryParams && typeof queryParams === 'object') {
@@ -12,33 +12,34 @@ export const createQuerySerializer = ({ allowReserved, array, object, } = {}) =>
                 if (value === undefined || value === null) {
                     continue;
                 }
+                const options = parameters[name] || args;
                 if (Array.isArray(value)) {
                     const serializedArray = serializeArrayParam({
-                        allowReserved,
+                        allowReserved: options.allowReserved,
                         explode: true,
                         name,
                         style: 'form',
                         value,
-                        ...array,
+                        ...options.array,
                     });
                     if (serializedArray)
                         search.push(serializedArray);
                 }
                 else if (typeof value === 'object') {
                     const serializedObject = serializeObjectParam({
-                        allowReserved,
+                        allowReserved: options.allowReserved,
                         explode: true,
                         name,
                         style: 'deepObject',
                         value: value,
-                        ...object,
+                        ...options.object,
                     });
                     if (serializedObject)
                         search.push(serializedObject);
                 }
                 else {
                     const serializedPrimitive = serializePrimitiveParam({
-                        allowReserved,
+                        allowReserved: options.allowReserved,
                         name,
                         value: value,
                     });
@@ -64,8 +65,7 @@ export const getParseAs = (contentType) => {
     if (!cleanContent) {
         return;
     }
-    if (cleanContent.startsWith('application/json') ||
-        cleanContent.endsWith('+json')) {
+    if (cleanContent.startsWith('application/json') || cleanContent.endsWith('+json')) {
         return 'json';
     }
     if (cleanContent === 'multipart/form-data') {
@@ -147,9 +147,7 @@ export const mergeHeaders = (...headers) => {
         if (!header) {
             continue;
         }
-        const iterator = header instanceof Headers
-            ? headersEntries(header)
-            : Object.entries(header);
+        const iterator = header instanceof Headers ? headersEntries(header) : Object.entries(header);
         for (const [key, value] of iterator) {
             if (value === null) {
                 mergedHeaders.delete(key);
@@ -160,7 +158,7 @@ export const mergeHeaders = (...headers) => {
                 }
             }
             else if (value !== undefined) {
-                // assume object headers are meant to be JSON stringified, i.e. their
+                // assume object headers are meant to be JSON stringified, i.e., their
                 // content value in OpenAPI specification is 'application/json'
                 mergedHeaders.set(key, typeof value === 'object' ? JSON.stringify(value) : value);
             }

package/dist-cms/packages/core/backend-api/client.gen.js

@@ -1,5 +1,3 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { createClient, createConfig } from './client/index.js';
-export const client = createClient(createConfig({
-    throwOnError: true
-}));
+export const client = createClient(createConfig({ throwOnError: true }));

package/dist-cms/packages/core/backend-api/core/bodySerializer.gen.d.ts

@@ -1,17 +1,25 @@
 import type { ArrayStyle, ObjectStyle, SerializerOptions } from './pathSerializer.gen.js';
 export type QuerySerializer = (query: Record<string, unknown>) => string;
-export type BodySerializer = (body: any) => any;
-export interface QuerySerializerOptions {
+export type BodySerializer = (body: unknown) => unknown;
+type QuerySerializerOptionsObject = {
     allowReserved?: boolean;
-    array?: SerializerOptions<ArrayStyle>;
-    object?: SerializerOptions<ObjectStyle>;
-}
+    array?: Partial<SerializerOptions<ArrayStyle>>;
+    object?: Partial<SerializerOptions<ObjectStyle>>;
+};
+export type QuerySerializerOptions = QuerySerializerOptionsObject & {
+    /**
+     * Per-parameter serialization overrides. When provided, these settings
+     * override the global array/object settings for specific parameter names.
+     */
+    parameters?: Record<string, QuerySerializerOptionsObject>;
+};
 export declare const formDataBodySerializer: {
-    bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(body: T) => FormData;
+    bodySerializer: (body: unknown) => FormData;
 };
 export declare const jsonBodySerializer: {
-    bodySerializer: <T>(body: T) => string;
+    bodySerializer: (body: unknown) => string;
 };
 export declare const urlSearchParamsBodySerializer: {
-    bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(body: T) => string;
+    bodySerializer: (body: unknown) => string;
 };
+export {};

package/dist-cms/packages/core/backend-api/core/bodySerializer.gen.js

@@ -36,7 +36,7 @@ export const formDataBodySerializer = {
     },
 };
 export const jsonBodySerializer = {
-    bodySerializer: (body) => JSON.stringify(body, (_key, value) => typeof value === 'bigint' ? value.toString() : value),
+    bodySerializer: (body) => JSON.stringify(body, (_key, value) => (typeof value === 'bigint' ? value.toString() : value)),
 };
 export const urlSearchParamsBodySerializer = {
     bodySerializer: (body) => {

package/dist-cms/packages/core/backend-api/core/params.gen.d.ts

@@ -17,6 +17,16 @@ export type Field = {
      */
     key?: string;
     map?: string;
+} | {
+    /**
+     * Field name. This is the name we want the user to see and use.
+     */
+    key: string;
+    /**
+     * Field mapped name. This is the name we want to use in the request.
+     * If `in` is omitted, `map` aliases `key` to the transport layer.
+     */
+    map: Slot;
 };
 export interface Fields {
     allowExtra?: Partial<Record<Slot, boolean>>;

package/dist-cms/packages/core/backend-api/core/params.gen.js

@@ -19,6 +19,11 @@ const buildKeyMap = (fields, map) => {
                 });
             }
         }
+        else if ('key' in config) {
+            map.set(config.key, {
+                map: config.map,
+            });
+        }
         else if (config.args) {
             buildKeyMap(config.args, map);
         }
@@ -27,7 +32,7 @@ const buildKeyMap = (fields, map) => {
 };
 const stripEmptySlots = (params) => {
     for (const [slot, value] of Object.entries(params)) {
-        if (value && typeof value === 'object' && !Object.keys(value).length) {
+        if (value && typeof value === 'object' && !Array.isArray(value) && !Object.keys(value).length) {
             delete params[slot];
         }
     }
@@ -52,7 +57,9 @@ export const buildClientParams = (args, fields) => {
             if (config.key) {
                 const field = map.get(config.key);
                 const name = field.map || config.key;
-                params[field.in][name] = arg;
+                if (field.in) {
+                    params[field.in][name] = arg;
+                }
             }
             else {
                 params.body = arg;
@@ -62,8 +69,13 @@ export const buildClientParams = (args, fields) => {
             for (const [key, value] of Object.entries(arg ?? {})) {
                 const field = map.get(key);
                 if (field) {
-                    const name = field.map || key;
-                    params[field.in][name] = value;
+                    if (field.in) {
+                        const name = field.map || key;
+                        params[field.in][name] = value;
+                    }
+                    else {
+                        params[field.map] = value;
+                    }
                 }
                 else {
                     const extra = extraPrefixes.find(([prefix]) => key.startsWith(prefix));
@@ -71,8 +83,8 @@ export const buildClientParams = (args, fields) => {
                         const [prefix, slot] = extra;
                         params[slot][key.slice(prefix.length)] = value;
                     }
-                    else {
-                        for (const [slot, allowed] of Object.entries(config.allowExtra ?? {})) {
+                    else if ('allowExtra' in config && config.allowExtra) {
+                        for (const [slot, allowed] of Object.entries(config.allowExtra)) {
                             if (allowed) {
                                 params[slot][key] = value;
                                 break;

package/dist-cms/packages/core/backend-api/core/pathSerializer.gen.js

@@ -62,9 +62,7 @@ export const serializeArrayParam = ({ allowReserved, explode, name, style, value
         });
     })
         .join(separator);
-    return style === 'label' || style === 'matrix'
-        ? separator + joinedValues
-        : joinedValues;
+    return style === 'label' || style === 'matrix' ? separator + joinedValues : joinedValues;
 };
 export const serializePrimitiveParam = ({ allowReserved, name, value, }) => {
     if (value === undefined || value === null) {
@@ -82,11 +80,7 @@ export const serializeObjectParam = ({ allowReserved, explode, name, style, valu
     if (style !== 'deepObject' && !explode) {
         let values = [];
         Object.entries(value).forEach(([key, v]) => {
-            values = [
-                ...values,
-                key,
-                allowReserved ? v : encodeURIComponent(v),
-            ];
+            values = [...values, key, allowReserved ? v : encodeURIComponent(v)];
         });
         const joinedValues = values.join(',');
         switch (style) {
@@ -108,7 +102,5 @@ export const serializeObjectParam = ({ allowReserved, explode, name, style, valu
         value: v,
     }))
         .join(separator);
-    return style === 'label' || style === 'matrix'
-        ? separator + joinedValues
-        : joinedValues;
+    return style === 'label' || style === 'matrix' ? separator + joinedValues : joinedValues;
 };

package/dist-cms/packages/core/backend-api/core/queryKeySerializer.gen.js

@@ -3,9 +3,7 @@
  * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes.
  */
 export const queryKeyJsonReplacer = (_key, value) => {
-    if (value === undefined ||
-        typeof value === 'function' ||
-        typeof value === 'symbol') {
+    if (value === undefined || typeof value === 'function' || typeof value === 'symbol') {
         return undefined;
     }
     if (typeof value === 'bigint') {
@@ -69,14 +67,10 @@ export const serializeQueryKeyValue = (value) => {
     if (value === null) {
         return null;
     }
-    if (typeof value === 'string' ||
-        typeof value === 'number' ||
-        typeof value === 'boolean') {
+    if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
         return value;
     }
-    if (value === undefined ||
-        typeof value === 'function' ||
-        typeof value === 'symbol') {
+    if (value === undefined || typeof value === 'function' || typeof value === 'symbol') {
         return undefined;
     }
     if (typeof value === 'bigint') {
@@ -88,8 +82,7 @@ export const serializeQueryKeyValue = (value) => {
     if (Array.isArray(value)) {
         return stringifyToJsonValue(value);
     }
-    if (typeof URLSearchParams !== 'undefined' &&
-        value instanceof URLSearchParams) {
+    if (typeof URLSearchParams !== 'undefined' && value instanceof URLSearchParams) {
         return serializeSearchParams(value);
     }
     if (isPlainObject(value)) {

package/dist-cms/packages/core/backend-api/core/serverSentEvents.gen.d.ts

@@ -68,4 +68,4 @@ export interface StreamEvent<TData = unknown> {
 export type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
     stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
 };
-export declare const createSseClient: <TData = unknown>({ onRequest, onSseError, onSseEvent, responseTransformer, responseValidator, sseDefaultRetryDelay, sseMaxRetryAttempts, sseMaxRetryDelay, sseSleepFn, url, ...options }: ServerSentEventsOptions) => ServerSentEventsResult<TData>;
+export declare function createSseClient<TData = unknown>({ onRequest, onSseError, onSseEvent, responseTransformer, responseValidator, sseDefaultRetryDelay, sseMaxRetryAttempts, sseMaxRetryDelay, sseSleepFn, url, ...options }: ServerSentEventsOptions): ServerSentEventsResult<TData>;

package/dist-cms/packages/core/backend-api/core/serverSentEvents.gen.js

@@ -1,8 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
-export const createSseClient = ({ onRequest, onSseError, onSseEvent, responseTransformer, responseValidator, sseDefaultRetryDelay, sseMaxRetryAttempts, sseMaxRetryDelay, sseSleepFn, url, ...options }) => {
+export function createSseClient({ onRequest, onSseError, onSseEvent, responseTransformer, responseValidator, sseDefaultRetryDelay, sseMaxRetryAttempts, sseMaxRetryDelay, sseSleepFn, url, ...options }) {
     let lastEventId;
-    const sleep = sseSleepFn ??
-        ((ms) => new Promise((resolve) => setTimeout(resolve, ms)));
+    const sleep = sseSleepFn ?? ((ms) => new Promise((resolve) => setTimeout(resolve, ms)));
     const createStream = async function* () {
         let retryDelay = sseDefaultRetryDelay ?? 3000;
         let attempt = 0;
@@ -37,9 +36,7 @@ export const createSseClient = ({ onRequest, onSseError, onSseEvent, responseTra
                     throw new Error(`SSE failed: ${response.status} ${response.statusText}`);
                 if (!response.body)
                     throw new Error('No body in SSE response');
-                const reader = response.body
-                    .pipeThrough(new TextDecoderStream())
-                    .getReader();
+                const reader = response.body.pipeThrough(new TextDecoderStream()).getReader();
                 let buffer = '';
                 const abortHandler = () => {
                     try {
@@ -56,6 +53,7 @@ export const createSseClient = ({ onRequest, onSseError, onSseEvent, responseTra
                         if (done)
                             break;
                         buffer += value;
+                        buffer = buffer.replace(/\r\n?/g, '\n'); // normalize line endings
                         const chunks = buffer.split('\n\n');
                         buffer = chunks.pop() ?? '';
                         for (const chunk of chunks) {
@@ -120,8 +118,7 @@ export const createSseClient = ({ onRequest, onSseError, onSseEvent, responseTra
             catch (error) {
                 // connection failed or aborted; retry after delay
                 onSseError?.(error);
-                if (sseMaxRetryAttempts !== undefined &&
-                    attempt >= sseMaxRetryAttempts) {
+                if (sseMaxRetryAttempts !== undefined && attempt >= sseMaxRetryAttempts) {
                     break; // stop after firing error
                 }
                 // exponential backoff: double retry each attempt, cap at 30s
@@ -132,4 +129,4 @@ export const createSseClient = ({ onRequest, onSseError, onSseEvent, responseTra
     };
     const stream = createStream();
     return { stream };
-};
+}

package/dist-cms/packages/core/backend-api/core/types.gen.d.ts

@@ -61,7 +61,7 @@ export interface Config {
     requestValidator?: (data: unknown) => Promise<unknown>;
     /**
      * A function transforming response data before it's returned. This is useful
-     * for post-processing data, e.g. converting ISO strings into Date objects.
+     * for post-processing data, e.g., converting ISO strings into Date objects.
      */
     responseTransformer?: (data: unknown) => Promise<unknown>;
     /**

package/dist-cms/packages/core/backend-api/core/utils.gen.js

@@ -75,7 +75,7 @@ export function getValidRequestBody(options) {
             const hasSerializedBody = options.serializedBody !== undefined && options.serializedBody !== '';
             return hasSerializedBody ? options.serializedBody : null;
         }
-        // not all clients implement a serializedBody property (i.e. client-axios)
+        // not all clients implement a serializedBody property (i.e., client-axios)
         return options.body !== '' ? options.body : null;
     }
     // plain/text body