Skip to content

Commit 16c0825

Browse files
authored
Upgrade to Umbraco 17 (#16)
* First stab at migrating the server-side to Umbraco 17 * Align solution structure with other projects * Fix obsoletions * Upgrade the client to Umbraco 17 * Include Umbraco.Cms.DevelopmentMode.Backoffice in site * Use the same icon in the list of sorters as is used in the main workspace view. * Bump package version
1 parent 77e4003 commit 16c0825

30 files changed

Lines changed: 3606 additions & 1353 deletions

NoCode.DeliveryApi.sln

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kjac.NoCode.DeliveryApi", "
77
EndProject
88
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kjac.NoCode.DeliveryApi.Site", "src\Kjac.NoCode.DeliveryApi.Site\Kjac.NoCode.DeliveryApi.Site.csproj", "{6766845F-8F12-4805-BDB1-3DCECEB2778B}"
99
EndProject
10-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{20840517-0943-47FA-9814-8243BAE5E90B}"
10+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution items", "Solution items", "{20840517-0943-47FA-9814-8243BAE5E90B}"
1111
ProjectSection(SolutionItems) = preProject
1212
README.md = README.md
1313
umbraco-marketplace.json = umbraco-marketplace.json
14+
global.json = global.json
15+
src\Kjac.NoCode.DeliveryApi\Client\package.json = src\Kjac.NoCode.DeliveryApi\Client\package.json
1416
EndProjectSection
1517
EndProject
1618
Global

global.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"sdk": {
3+
"version": "10.0.0",
4+
"rollForward": "latestMajor",
5+
"allowPrerelease": true
6+
}
7+
}

src/Kjac.NoCode.DeliveryApi.Site/Kjac.NoCode.DeliveryApi.Site.csproj

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
<Project Sdk="Microsoft.NET.Sdk.Web">
22
<PropertyGroup>
3-
<TargetFramework>net9.0</TargetFramework>
3+
<TargetFramework>net10.0</TargetFramework>
44
<ImplicitUsings>enable</ImplicitUsings>
55
<Nullable>enable</Nullable>
66
<LangVersion>default</LangVersion>
77
</PropertyGroup>
88

99
<ItemGroup>
10-
<PackageReference Include="Umbraco.Cms" Version="16.0.0" />
10+
<PackageReference Include="Umbraco.Cms" Version="17.0.0" />
11+
<PackageReference Include="Umbraco.Cms.DevelopmentMode.Backoffice" Version="17.0.1" />
1112
</ItemGroup>
1213

1314
<ItemGroup>

src/Kjac.NoCode.DeliveryApi/Client/package-lock.json

Lines changed: 1474 additions & 1244 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Kjac.NoCode.DeliveryApi/Client/package.json

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@
99
"generate-client": "node scripts/generate-openapi.js https://localhost:44346/umbraco/swagger/no-code-delivery-api/swagger.json"
1010
},
1111
"devDependencies": {
12-
"@hey-api/client-fetch": "^0.10.0",
13-
"@hey-api/openapi-ts": "^0.66.7",
14-
"@umbraco-cms/backoffice": "^16.0.0",
15-
"chalk": "^5.4.1",
16-
"cross-env": "^7.0.3",
12+
"@hey-api/openapi-ts": "^0.85.0",
13+
"@umbraco-cms/backoffice": "^17.0.0",
14+
"chalk": "^5.6.2",
15+
"cross-env": "^10.1.0",
1716
"node-fetch": "^3.3.2",
18-
"typescript": "^5.8.3",
19-
"vite": "^6.3.4"
17+
"typescript": "^5.9.3",
18+
"vite": "^7.1.9"
2019
}
2120
}
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// This file is auto-generated by @hey-api/openapi-ts
22

3-
import type { ClientOptions } from './types.gen';
4-
import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';
3+
import { type ClientOptions, type Config, createClient, createConfig } from './client';
4+
import type { ClientOptions as ClientOptions2 } from './types.gen';
55

66
/**
77
* The `createClientConfig()` function will be called on client initialization
@@ -11,8 +11,8 @@ import { type Config, type ClientOptions as DefaultClientOptions, createClient,
1111
* `setConfig()`. This is useful for example if you're using Next.js
1212
* to ensure your client always has the correct values.
1313
*/
14-
export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
14+
export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
1515

16-
export const client = createClient(createConfig<ClientOptions>({
16+
export const client = createClient(createConfig<ClientOptions2>({
1717
baseUrl: 'https://localhost:44346'
18-
}));
18+
}));
Lines changed: 268 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
1+
// This file is auto-generated by @hey-api/openapi-ts
2+
3+
import { createSseClient } from '../core/serverSentEvents.gen';
4+
import type { HttpMethod } from '../core/types.gen';
5+
import { getValidRequestBody } from '../core/utils.gen';
6+
import type {
7+
Client,
8+
Config,
9+
RequestOptions,
10+
ResolvedRequestOptions,
11+
} from './types.gen';
12+
import {
13+
buildUrl,
14+
createConfig,
15+
createInterceptors,
16+
getParseAs,
17+
mergeConfigs,
18+
mergeHeaders,
19+
setAuthParams,
20+
} from './utils.gen';
21+
22+
type ReqInit = Omit<RequestInit, 'body' | 'headers'> & {
23+
body?: any;
24+
headers: ReturnType<typeof mergeHeaders>;
25+
};
26+
27+
export const createClient = (config: Config = {}): Client => {
28+
let _config = mergeConfigs(createConfig(), config);
29+
30+
const getConfig = (): Config => ({ ..._config });
31+
32+
const setConfig = (config: Config): Config => {
33+
_config = mergeConfigs(_config, config);
34+
return getConfig();
35+
};
36+
37+
const interceptors = createInterceptors<
38+
Request,
39+
Response,
40+
unknown,
41+
ResolvedRequestOptions
42+
>();
43+
44+
const beforeRequest = async (options: RequestOptions) => {
45+
const opts = {
46+
..._config,
47+
...options,
48+
fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
49+
headers: mergeHeaders(_config.headers, options.headers),
50+
serializedBody: undefined,
51+
};
52+
53+
if (opts.security) {
54+
await setAuthParams({
55+
...opts,
56+
security: opts.security,
57+
});
58+
}
59+
60+
if (opts.requestValidator) {
61+
await opts.requestValidator(opts);
62+
}
63+
64+
if (opts.body !== undefined && opts.bodySerializer) {
65+
opts.serializedBody = opts.bodySerializer(opts.body);
66+
}
67+
68+
// remove Content-Type header if body is empty to avoid sending invalid requests
69+
if (opts.body === undefined || opts.serializedBody === '') {
70+
opts.headers.delete('Content-Type');
71+
}
72+
73+
const url = buildUrl(opts);
74+
75+
return { opts, url };
76+
};
77+
78+
const request: Client['request'] = async (options) => {
79+
// @ts-expect-error
80+
const { opts, url } = await beforeRequest(options);
81+
const requestInit: ReqInit = {
82+
redirect: 'follow',
83+
...opts,
84+
body: getValidRequestBody(opts),
85+
};
86+
87+
let request = new Request(url, requestInit);
88+
89+
for (const fn of interceptors.request.fns) {
90+
if (fn) {
91+
request = await fn(request, opts);
92+
}
93+
}
94+
95+
// fetch must be assigned here, otherwise it would throw the error:
96+
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
97+
const _fetch = opts.fetch!;
98+
let response = await _fetch(request);
99+
100+
for (const fn of interceptors.response.fns) {
101+
if (fn) {
102+
response = await fn(response, request, opts);
103+
}
104+
}
105+
106+
const result = {
107+
request,
108+
response,
109+
};
110+
111+
if (response.ok) {
112+
const parseAs =
113+
(opts.parseAs === 'auto'
114+
? getParseAs(response.headers.get('Content-Type'))
115+
: opts.parseAs) ?? 'json';
116+
117+
if (
118+
response.status === 204 ||
119+
response.headers.get('Content-Length') === '0'
120+
) {
121+
let emptyData: any;
122+
switch (parseAs) {
123+
case 'arrayBuffer':
124+
case 'blob':
125+
case 'text':
126+
emptyData = await response[parseAs]();
127+
break;
128+
case 'formData':
129+
emptyData = new FormData();
130+
break;
131+
case 'stream':
132+
emptyData = response.body;
133+
break;
134+
case 'json':
135+
default:
136+
emptyData = {};
137+
break;
138+
}
139+
return opts.responseStyle === 'data'
140+
? emptyData
141+
: {
142+
data: emptyData,
143+
...result,
144+
};
145+
}
146+
147+
let data: any;
148+
switch (parseAs) {
149+
case 'arrayBuffer':
150+
case 'blob':
151+
case 'formData':
152+
case 'json':
153+
case 'text':
154+
data = await response[parseAs]();
155+
break;
156+
case 'stream':
157+
return opts.responseStyle === 'data'
158+
? response.body
159+
: {
160+
data: response.body,
161+
...result,
162+
};
163+
}
164+
165+
if (parseAs === 'json') {
166+
if (opts.responseValidator) {
167+
await opts.responseValidator(data);
168+
}
169+
170+
if (opts.responseTransformer) {
171+
data = await opts.responseTransformer(data);
172+
}
173+
}
174+
175+
return opts.responseStyle === 'data'
176+
? data
177+
: {
178+
data,
179+
...result,
180+
};
181+
}
182+
183+
const textError = await response.text();
184+
let jsonError: unknown;
185+
186+
try {
187+
jsonError = JSON.parse(textError);
188+
} catch {
189+
// noop
190+
}
191+
192+
const error = jsonError ?? textError;
193+
let finalError = error;
194+
195+
for (const fn of interceptors.error.fns) {
196+
if (fn) {
197+
finalError = (await fn(error, response, request, opts)) as string;
198+
}
199+
}
200+
201+
finalError = finalError || ({} as string);
202+
203+
if (opts.throwOnError) {
204+
throw finalError;
205+
}
206+
207+
// TODO: we probably want to return error and improve types
208+
return opts.responseStyle === 'data'
209+
? undefined
210+
: {
211+
error: finalError,
212+
...result,
213+
};
214+
};
215+
216+
const makeMethodFn =
217+
(method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
218+
request({ ...options, method });
219+
220+
const makeSseFn =
221+
(method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
222+
const { opts, url } = await beforeRequest(options);
223+
return createSseClient({
224+
...opts,
225+
body: opts.body as BodyInit | null | undefined,
226+
headers: opts.headers as unknown as Record<string, string>,
227+
method,
228+
onRequest: async (url, init) => {
229+
let request = new Request(url, init);
230+
for (const fn of interceptors.request.fns) {
231+
if (fn) {
232+
request = await fn(request, opts);
233+
}
234+
}
235+
return request;
236+
},
237+
url,
238+
});
239+
};
240+
241+
return {
242+
buildUrl,
243+
connect: makeMethodFn('CONNECT'),
244+
delete: makeMethodFn('DELETE'),
245+
get: makeMethodFn('GET'),
246+
getConfig,
247+
head: makeMethodFn('HEAD'),
248+
interceptors,
249+
options: makeMethodFn('OPTIONS'),
250+
patch: makeMethodFn('PATCH'),
251+
post: makeMethodFn('POST'),
252+
put: makeMethodFn('PUT'),
253+
request,
254+
setConfig,
255+
sse: {
256+
connect: makeSseFn('CONNECT'),
257+
delete: makeSseFn('DELETE'),
258+
get: makeSseFn('GET'),
259+
head: makeSseFn('HEAD'),
260+
options: makeSseFn('OPTIONS'),
261+
patch: makeSseFn('PATCH'),
262+
post: makeSseFn('POST'),
263+
put: makeSseFn('PUT'),
264+
trace: makeSseFn('TRACE'),
265+
},
266+
trace: makeMethodFn('TRACE'),
267+
} as Client;
268+
};
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// This file is auto-generated by @hey-api/openapi-ts
2+
3+
export type { Auth } from '../core/auth.gen';
4+
export type { QuerySerializerOptions } from '../core/bodySerializer.gen';
5+
export {
6+
formDataBodySerializer,
7+
jsonBodySerializer,
8+
urlSearchParamsBodySerializer,
9+
} from '../core/bodySerializer.gen';
10+
export { buildClientParams } from '../core/params.gen';
11+
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen';
12+
export { createClient } from './client.gen';
13+
export type {
14+
Client,
15+
ClientOptions,
16+
Config,
17+
CreateClientConfig,
18+
Options,
19+
OptionsLegacyParser,
20+
RequestOptions,
21+
RequestResult,
22+
ResolvedRequestOptions,
23+
ResponseStyle,
24+
TDataShape,
25+
} from './types.gen';
26+
export { createConfig, mergeHeaders } from './utils.gen';

0 commit comments

Comments
 (0)