Skip to content

Commit 3da1bc1

Browse files
rickbutterfieldrickbutterfield
committed
Refactor controllers
1 parent 2b48ce2 commit 3da1bc1

File tree

45 files changed

+1501
-1219
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1501
-1219
lines changed

‎src/Umbraco.Community.ContentAudit.UI/src/api/sdk.gen.ts‎

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import type { Client, Options as Options2, TDataShape } from './client';
44
import { client } from './client.gen';
5-
import type { ChildrenData, ChildrenResponses, GetAllImagesData, GetAllImagesResponses, GetAllIssuesData, GetAllIssuesResponses, GetCollectionData, GetCollectionResponses, GetDuplicateContentUrlsData, GetDuplicateContentUrlsResponses, GetExportDataData, GetExportDataResponses, GetExternalLinksData, GetExternalLinksResponses, GetHealthScoreData, GetHealthScoreResponses, GetInteralLinksData, GetInteralLinksResponses, GetIssueData, GetIssueResponses, GetLatestAuditDataData, GetLatestAuditDataResponses, GetLatestAuditOverviewData, GetLatestAuditOverviewResponses, GetLatestPageAuditDataData, GetLatestPageAuditDataResponses, GetOrphanedPagesData, GetOrphanedPagesResponses, GetPagesWithMissingMetadataData, GetPagesWithMissingMetadataResponses, GetSettingsData, GetSettingsResponses, RootData, RootResponses, StartCrawlData, StartCrawlResponses } from './types.gen';
5+
import type { ChildrenData, ChildrenResponses, ExportData, ExportResponses, GetAllImagesData, GetAllImagesResponses, GetAllIssuesData, GetAllIssuesResponses, GetByKeyData, GetByKeyResponses, GetCollectionData, GetCollectionResponses, GetDuplicateContentUrlsData, GetDuplicateContentUrlsResponses, GetExternalLinksData, GetExternalLinksResponses, GetHealthScoreData, GetHealthScoreResponses, GetInternalLinksData, GetInternalLinksResponses, GetIssueData, GetIssueResponses, GetLatestAuditDataData, GetLatestAuditDataResponses, GetLatestAuditOverviewData, GetLatestAuditOverviewResponses, GetOrphanedPagesData, GetOrphanedPagesResponses, GetPagesWithMissingMetadataData, GetPagesWithMissingMetadataResponses, GetSettingsData, GetSettingsResponses, RootData, RootResponses, StartCrawlData, StartCrawlResponses } from './types.gen';
66

77
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
88
/**
@@ -33,22 +33,15 @@ export class AuditService {
3333
});
3434
}
3535

36-
public static getAllIssues<ThrowOnError extends boolean = true>(options?: Options<GetAllIssuesData, ThrowOnError>) {
37-
return (options?.client ?? client).get<GetAllIssuesResponses, unknown, ThrowOnError>({
38-
url: '/umbraco/content-audit/management/api/v1/audit/all-issues',
39-
...options
40-
});
41-
}
42-
4336
public static getDuplicateContentUrls<ThrowOnError extends boolean = true>(options?: Options<GetDuplicateContentUrlsData, ThrowOnError>) {
4437
return (options?.client ?? client).get<GetDuplicateContentUrlsResponses, unknown, ThrowOnError>({
4538
url: '/umbraco/content-audit/management/api/v1/audit/duplicate-content',
4639
...options
4740
});
4841
}
4942

50-
public static getExportData<ThrowOnError extends boolean = true>(options?: Options<GetExportDataData, ThrowOnError>) {
51-
return (options?.client ?? client).get<GetExportDataResponses, unknown, ThrowOnError>({
43+
public static export<ThrowOnError extends boolean = true>(options?: Options<ExportData, ThrowOnError>) {
44+
return (options?.client ?? client).get<ExportResponses, unknown, ThrowOnError>({
5245
url: '/umbraco/content-audit/management/api/v1/audit/export',
5346
...options
5447
});
@@ -68,20 +61,13 @@ export class AuditService {
6861
});
6962
}
7063

71-
public static getInteralLinks<ThrowOnError extends boolean = true>(options?: Options<GetInteralLinksData, ThrowOnError>) {
72-
return (options?.client ?? client).get<GetInteralLinksResponses, unknown, ThrowOnError>({
64+
public static getInternalLinks<ThrowOnError extends boolean = true>(options?: Options<GetInternalLinksData, ThrowOnError>) {
65+
return (options?.client ?? client).get<GetInternalLinksResponses, unknown, ThrowOnError>({
7366
url: '/umbraco/content-audit/management/api/v1/audit/internal-links',
7467
...options
7568
});
7669
}
7770

78-
public static getIssue<ThrowOnError extends boolean = true>(options?: Options<GetIssueData, ThrowOnError>) {
79-
return (options?.client ?? client).get<GetIssueResponses, unknown, ThrowOnError>({
80-
url: '/umbraco/content-audit/management/api/v1/audit/issue',
81-
...options
82-
});
83-
}
84-
8571
public static getLatestAuditOverview<ThrowOnError extends boolean = true>(options?: Options<GetLatestAuditOverviewData, ThrowOnError>) {
8672
return (options?.client ?? client).get<GetLatestAuditOverviewResponses, unknown, ThrowOnError>({
8773
url: '/umbraco/content-audit/management/api/v1/audit/latest-audit',
@@ -96,8 +82,8 @@ export class AuditService {
9682
});
9783
}
9884

99-
public static getLatestPageAuditData<ThrowOnError extends boolean = true>(options?: Options<GetLatestPageAuditDataData, ThrowOnError>) {
100-
return (options?.client ?? client).get<GetLatestPageAuditDataResponses, unknown, ThrowOnError>({
85+
public static getByKey<ThrowOnError extends boolean = true>(options?: Options<GetByKeyData, ThrowOnError>) {
86+
return (options?.client ?? client).get<GetByKeyResponses, unknown, ThrowOnError>({
10187
url: '/umbraco/content-audit/management/api/v1/audit/latest-page-data',
10288
...options
10389
});
@@ -141,6 +127,22 @@ export class CrawlService {
141127
}
142128
}
143129

130+
export class IssueService {
131+
public static getAllIssues<ThrowOnError extends boolean = true>(options?: Options<GetAllIssuesData, ThrowOnError>) {
132+
return (options?.client ?? client).get<GetAllIssuesResponses, unknown, ThrowOnError>({
133+
url: '/umbraco/content-audit/management/api/v1/issue',
134+
...options
135+
});
136+
}
137+
138+
public static getIssue<ThrowOnError extends boolean = true>(options: Options<GetIssueData, ThrowOnError>) {
139+
return (options.client ?? client).get<GetIssueResponses, unknown, ThrowOnError>({
140+
url: '/umbraco/content-audit/management/api/v1/issue/{id}',
141+
...options
142+
});
143+
}
144+
}
145+
144146
export class SettingsService {
145147
public static getSettings<ThrowOnError extends boolean = true>(options?: Options<GetSettingsData, ThrowOnError>) {
146148
return (options?.client ?? client).get<GetSettingsResponses, unknown, ThrowOnError>({

‎src/Umbraco.Community.ContentAudit.UI/src/api/types.gen.ts‎

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -420,25 +420,6 @@ export type GetAllImagesResponses = {
420420

421421
export type GetAllImagesResponse = GetAllImagesResponses[keyof GetAllImagesResponses];
422422

423-
export type GetAllIssuesData = {
424-
body?: never;
425-
path?: never;
426-
query?: {
427-
skip?: number;
428-
take?: number;
429-
};
430-
url: '/umbraco/content-audit/management/api/v1/audit/all-issues';
431-
};
432-
433-
export type GetAllIssuesResponses = {
434-
/**
435-
* OK
436-
*/
437-
200: PagedIssueDtoModel;
438-
};
439-
440-
export type GetAllIssuesResponse = GetAllIssuesResponses[keyof GetAllIssuesResponses];
441-
442423
export type GetDuplicateContentUrlsData = {
443424
body?: never;
444425
path?: never;
@@ -459,21 +440,21 @@ export type GetDuplicateContentUrlsResponses = {
459440

460441
export type GetDuplicateContentUrlsResponse = GetDuplicateContentUrlsResponses[keyof GetDuplicateContentUrlsResponses];
461442

462-
export type GetExportDataData = {
443+
export type ExportData = {
463444
body?: never;
464445
path?: never;
465446
query?: never;
466447
url: '/umbraco/content-audit/management/api/v1/audit/export';
467448
};
468449

469-
export type GetExportDataResponses = {
450+
export type ExportResponses = {
470451
/**
471452
* OK
472453
*/
473454
200: Blob | File;
474455
};
475456

476-
export type GetExportDataResponse = GetExportDataResponses[keyof GetExportDataResponses];
457+
export type ExportResponse = ExportResponses[keyof ExportResponses];
477458

478459
export type GetExternalLinksData = {
479460
body?: never;
@@ -511,7 +492,7 @@ export type GetHealthScoreResponses = {
511492

512493
export type GetHealthScoreResponse = GetHealthScoreResponses[keyof GetHealthScoreResponses];
513494

514-
export type GetInteralLinksData = {
495+
export type GetInternalLinksData = {
515496
body?: never;
516497
path?: never;
517498
query?: {
@@ -522,32 +503,14 @@ export type GetInteralLinksData = {
522503
url: '/umbraco/content-audit/management/api/v1/audit/internal-links';
523504
};
524505

525-
export type GetInteralLinksResponses = {
506+
export type GetInternalLinksResponses = {
526507
/**
527508
* OK
528509
*/
529510
200: PagedLinkGroupDtoModel;
530511
};
531512

532-
export type GetInteralLinksResponse = GetInteralLinksResponses[keyof GetInteralLinksResponses];
533-
534-
export type GetIssueData = {
535-
body?: never;
536-
path?: never;
537-
query?: {
538-
issueGuid?: string;
539-
};
540-
url: '/umbraco/content-audit/management/api/v1/audit/issue';
541-
};
542-
543-
export type GetIssueResponses = {
544-
/**
545-
* OK
546-
*/
547-
200: IssueDto;
548-
};
549-
550-
export type GetIssueResponse = GetIssueResponses[keyof GetIssueResponses];
513+
export type GetInternalLinksResponse = GetInternalLinksResponses[keyof GetInternalLinksResponses];
551514

552515
export type GetLatestAuditOverviewData = {
553516
body?: never;
@@ -586,7 +549,7 @@ export type GetLatestAuditDataResponses = {
586549

587550
export type GetLatestAuditDataResponse = GetLatestAuditDataResponses[keyof GetLatestAuditDataResponses];
588551

589-
export type GetLatestPageAuditDataData = {
552+
export type GetByKeyData = {
590553
body?: never;
591554
path?: never;
592555
query?: {
@@ -595,14 +558,14 @@ export type GetLatestPageAuditDataData = {
595558
url: '/umbraco/content-audit/management/api/v1/audit/latest-page-data';
596559
};
597560

598-
export type GetLatestPageAuditDataResponses = {
561+
export type GetByKeyResponses = {
599562
/**
600563
* OK
601564
*/
602565
200: PageAnalysisDto;
603566
};
604567

605-
export type GetLatestPageAuditDataResponse = GetLatestPageAuditDataResponses[keyof GetLatestPageAuditDataResponses];
568+
export type GetByKeyResponse = GetByKeyResponses[keyof GetByKeyResponses];
606569

607570
export type GetPagesWithMissingMetadataData = {
608571
body?: never;
@@ -694,6 +657,43 @@ export type StartCrawlResponses = {
694657

695658
export type StartCrawlResponse = StartCrawlResponses[keyof StartCrawlResponses];
696659

660+
export type GetAllIssuesData = {
661+
body?: never;
662+
path?: never;
663+
query?: {
664+
skip?: number;
665+
take?: number;
666+
};
667+
url: '/umbraco/content-audit/management/api/v1/issue';
668+
};
669+
670+
export type GetAllIssuesResponses = {
671+
/**
672+
* OK
673+
*/
674+
200: PagedIssueDtoModel;
675+
};
676+
677+
export type GetAllIssuesResponse = GetAllIssuesResponses[keyof GetAllIssuesResponses];
678+
679+
export type GetIssueData = {
680+
body?: never;
681+
path: {
682+
id: string;
683+
};
684+
query?: never;
685+
url: '/umbraco/content-audit/management/api/v1/issue/{id}';
686+
};
687+
688+
export type GetIssueResponses = {
689+
/**
690+
* OK
691+
*/
692+
200: IssueDto;
693+
};
694+
695+
export type GetIssueResponse = GetIssueResponses[keyof GetIssueResponses];
696+
697697
export type GetSettingsData = {
698698
body?: never;
699699
path?: never;

‎src/Umbraco.Community.ContentAudit.UI/src/repository/sources/audit.source.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
22
import { UmbDataSourceResponse } from "@umbraco-cms/backoffice/repository";
33
import { tryExecute } from '@umbraco-cms/backoffice/resources';
4-
import { AuditService, GetAllIssuesResponse, GetHealthScoreResponse, GetLatestAuditOverviewResponse, GetPagesWithMissingMetadataResponse, GetCollectionResponse } from "../../api";
4+
import { AuditService, GetAllIssuesResponse, GetHealthScoreResponse, GetLatestAuditOverviewResponse, GetPagesWithMissingMetadataResponse, GetCollectionResponse, IssueService } from "../../api";
55

66
export interface AuditDataSource {
77
getLatestAuditOverview(): Promise<UmbDataSourceResponse<GetLatestAuditOverviewResponse>>
@@ -27,7 +27,7 @@ export class ContentAuditDataSource implements AuditDataSource {
2727
}
2828

2929
async getTopIssues(): Promise<UmbDataSourceResponse<GetAllIssuesResponse>> {
30-
return await tryExecute(this.#host, AuditService.getAllIssues({
30+
return await tryExecute(this.#host, IssueService.getAllIssues({
3131
query: { skip: 0, take: 5 }
3232
}));
3333
}

‎src/Umbraco.Community.ContentAudit.UI/src/section/all-pages/repository/detail/all-pages-detail.server.data-source.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export class ContentAuditAllPagesServerDataSource implements UmbReadDetailDataSo
1515

1616
const { data, error } = await tryExecute(
1717
this.#host,
18-
AuditService.getLatestPageAuditData({ query: { unique: unique } })
18+
AuditService.getByKey({ query: { unique: unique } })
1919
);
2020

2121
if (error || !data) {

‎src/Umbraco.Community.ContentAudit.UI/src/section/audits/workspace/audits/audits-workspace.context.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { UmbWorkspaceRouteManager } from "@umbraco-cms/backoffice/workspace";
55
import { UmbArrayState, UmbObjectState } from "@umbraco-cms/backoffice/observable-api";
66
import { CONTENT_AUDIT_AUDITS_WORKSPACE_ALIAS } from "../constants";
77
import ContentAuditAuditsWorkspaceEditorElement from "./audits-workspace-editor.element";
8-
import { OverviewDto, AuditService, IssueDto } from "../../../../api";
8+
import { OverviewDto, AuditService, IssueDto, IssueService } from "../../../../api";
99
import { tryExecute } from "@umbraco-cms/backoffice/resources";
1010

1111
export class ContentAuditAuditsWorkspaceContext extends UmbContextBase {
@@ -50,7 +50,7 @@ export class ContentAuditAuditsWorkspaceContext extends UmbContextBase {
5050
}
5151

5252
async loadIssues() {
53-
const { data } = await tryExecute(this, AuditService.getAllIssues({ query: { skip: 0, take: 100 } }));
53+
const { data } = await tryExecute(this, IssueService.getAllIssues({ query: { skip: 0, take: 100 } }));
5454

5555
if (data && data.items) {
5656
// Sort by priority score descending

‎src/Umbraco.Community.ContentAudit.UI/src/section/export/workspace/views/export.element.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export class ContentAuditExportElement extends UmbElementMixin(LitElement) {
1010
}
1111

1212
async #exportCsv() {
13-
const { data, error } = await tryExecuteAndNotify(this, AuditService.getExportData());
13+
const { data, error } = await tryExecuteAndNotify(this, AuditService.export());
1414

1515
if (data) {
1616
const blob = new Blob([data], { type: 'text/csv;charset=utf-8;' });

‎src/Umbraco.Community.ContentAudit.UI/src/section/inbound-links/collection/repository/inbound-links-collection.server.data-source.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export class ContentAuditInboundLinksCollectionDataSource implements UmbCollecti
1111
}
1212

1313
async getCollection(filter: UmbCollectionFilterModel) {
14-
const { data, error } = await tryExecute(this.#host, AuditService.getInteralLinks({ query: filter }));
14+
const { data, error } = await tryExecute(this.#host, AuditService.getInternalLinks({ query: filter }));
1515

1616
if (error) {
1717
return { error };

‎src/Umbraco.Community.ContentAudit.UI/src/section/issues/collection/repository/issue-collection.server.data-source.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { UmbCollectionDataSource, UmbCollectionFilterModel } from "@umbraco-cms/backoffice/collection";
22
import { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
3-
import { IssueDto, AuditService } from "../../../../api";
3+
import { IssueDto, IssueService } from "../../../../api";
44
import { tryExecute } from "@umbraco-cms/backoffice/resources";
55

66
export class ContentAuditIssuesCollectionDataSource implements UmbCollectionDataSource<IssueDto> {
@@ -11,7 +11,7 @@ export class ContentAuditIssuesCollectionDataSource implements UmbCollectionData
1111
}
1212

1313
async getCollection(filter: UmbCollectionFilterModel) {
14-
const { data, error } = await tryExecute(this.#host, AuditService.getAllIssues({ query: filter }));
14+
const { data, error } = await tryExecute(this.#host, IssueService.getAllIssues({ query: filter }));
1515

1616
if (error) {
1717
return { error };

‎src/Umbraco.Community.ContentAudit.UI/src/section/issues/repository/detail/issues-detail.server.data-source.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { UmbReadDetailDataSource } from "@umbraco-cms/backoffice/repository";
2-
import { AuditService, IssueDto } from "../../../../api";
2+
import { IssueDto, IssueService } from "../../../../api";
33
import { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
44
import { tryExecute } from "@umbraco-cms/backoffice/resources";
55

@@ -15,7 +15,7 @@ export class ContentAuditIssuesServerDataSource implements UmbReadDetailDataSour
1515

1616
const { data, error } = await tryExecute(
1717
this.#host,
18-
AuditService.getIssue({ query: { issueGuid: unique } })
18+
IssueService.getIssue({ path: { id: unique } })
1919
);
2020

2121
if (error || !data) {

0 commit comments

Comments
 (0)