Allow developer to add custom FeedGeneratorService implementations (#44)

* Use a CollectionBuilder to register FeedGenerators.  Updated Backend implementation to obtain IProductFeedGeneratorService instances via this collection.

* Updated Frontend implementation to use FeedGeneratorId instead of FeedType

* Provide a mechanism for IProductFeedGeneratrorService implementations to declare the format they generate.  Use this format declaration to return the correct output within ProductFeedController.

* Define a base class for ProductFeedGeneratorService implementations as a developer aid.

* Resolve Typescript incompatible types error for feedGeneratorId

* Remove GoogleMerchantFeed Mapping defaults

* fix code format; add comments; add a general exception class.

* clean up codes

* remove unnecessary using statements

* bump version to 16.1.0

* Fix breaking changes

* Fix the breaking change

* enable package validation

* Fix breaking changes

* Split the ProductFeedController to make it easier to bump the api version of the actions. Improve the backward compatibility.

* rebuild frontend

* Fix a API breaking change

---------

Co-authored-by: Ben White <[email protected]>
Co-authored-by: Dinh Tran <[email protected]>

Author: 3 people

src/Umbraco.Commerce.ProductFeeds.Client/frontend/package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "umbraco-commerce-product-feeds",
-    "version": "15.0.0",
+    "version": "16.0.0",
     "description": "A product feeds generator for Umbraco Commerce",
     "main": "./src/index.ts",
     "type": "module",
@@ -31,8 +31,8 @@
     "license": "ISC",
     "dependencies": {
         "@hey-api/client-axios": "^0.8.0",
-        "@umbraco-cms/backoffice": "^16.0.0-rc3",
-        "@umbraco-commerce/backoffice": "^16.0.0-rc1",
+        "@umbraco-cms/backoffice": "^16.0.0",
+        "@umbraco-commerce/backoffice": "^16.0.0",
         "nanoid": "^5.1.5"
     }
-}
+}

src/Umbraco.Commerce.ProductFeeds.Client/frontend/package.json

@@ -14,5 +14,5 @@ import { type Config, type ClientOptions as DefaultClientOptions, createClient,
 export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
 
 export const client = createClient(createConfig<ClientOptions>({
-    baseURL: 'https://localhost:44322',
+    baseURL: 'http://localhost:44321',
 }));

src/Umbraco.Commerce.ProductFeeds.Client/frontend/src/generated/apis/client.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { type Options as ClientOptions, type TDataShape, type Client, formDataBodySerializer } from '@hey-api/client-axios';
-import type { DeleteData, DeleteResponses, DeleteErrors, GetDocumentTypesData, GetDocumentTypesResponses, GetDocumentTypesErrors, GetFeedTypesData, GetFeedTypesResponses, GetFeedTypesErrors, GetDetailsData, GetDetailsResponses, GetDetailsErrors, GetByStoreData, GetByStoreResponses, GetByStoreErrors, GetPropertyValueExtractorsData, GetPropertyValueExtractorsResponses, GetPropertyValueExtractorsErrors, SaveData, SaveResponses, SaveErrors } from './types.gen';
+import type { DeleteV2Data, DeleteV2Responses, DeleteV2Errors, DeleteData, DeleteResponses, DeleteErrors, GetDocumentTypesData, GetDocumentTypesResponses, GetDocumentTypesErrors, GetDocumentTypesV2Data, GetDocumentTypesV2Responses, GetDocumentTypesV2Errors, GetFeedGeneratorsV2Data, GetFeedGeneratorsV2Responses, GetFeedGeneratorsV2Errors, GetFeedTypesData, GetFeedTypesResponses, GetFeedTypesErrors, GetDetailsData, GetDetailsResponses, GetDetailsErrors, GetDetailsV2Data, GetDetailsV2Responses, GetDetailsV2Errors, GetByStoreData, GetByStoreResponses, GetByStoreErrors, GetByStoreV2Data, GetByStoreV2Responses, GetByStoreV2Errors, GetPropertyValueExtractorsData, GetPropertyValueExtractorsResponses, GetPropertyValueExtractorsErrors, GetPropertyValueExtractorsV2Data, GetPropertyValueExtractorsV2Responses, GetPropertyValueExtractorsV2Errors, SaveData, SaveResponses, SaveErrors, SaveV2Data, SaveV2Responses, SaveV2Errors } from './types.gen';
 import { client as _heyApiClient } from './client.gen';
 
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -18,6 +18,28 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
     meta?: Record<string, unknown>;
 };
 
+export const deleteV2 = <ThrowOnError extends boolean = false>(options?: Options<DeleteV2Data, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).post<DeleteV2Responses, DeleteV2Errors, ThrowOnError>({
+        ...formDataBodySerializer,
+        responseType: 'json',
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http',
+            },
+        ],
+        url: '/umbraco/ucproductfeeds/management/api/v2/setting/delete',
+        ...options,
+        headers: {
+            'Content-Type': null,
+            ...options?.headers,
+        },
+    });
+};
+
+/**
+ * @deprecated
+ */
 export const delete_ = <ThrowOnError extends boolean = false>(options?: Options<DeleteData, ThrowOnError>) => {
     return (options?.client ?? _heyApiClient).post<DeleteResponses, DeleteErrors, ThrowOnError>({
         ...formDataBodySerializer,
@@ -37,6 +59,9 @@ export const delete_ = <ThrowOnError extends boolean = false>(options?: Options<
     });
 };
 
+/**
+ * @deprecated
+ */
 export const getDocumentTypes = <ThrowOnError extends boolean = false>(options?: Options<GetDocumentTypesData, ThrowOnError>) => {
     return (options?.client ?? _heyApiClient).get<GetDocumentTypesResponses, GetDocumentTypesErrors, ThrowOnError>({
         security: [
@@ -50,6 +75,36 @@ export const getDocumentTypes = <ThrowOnError extends boolean = false>(options?:
     });
 };
 
+export const getDocumentTypesV2 = <ThrowOnError extends boolean = false>(options?: Options<GetDocumentTypesV2Data, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<GetDocumentTypesV2Responses, GetDocumentTypesV2Errors, ThrowOnError>({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http',
+            },
+        ],
+        url: '/umbraco/ucproductfeeds/management/api/v2/setting/documenttypes',
+        ...options,
+    });
+};
+
+export const getFeedGeneratorsV2 = <ThrowOnError extends boolean = false>(options?: Options<GetFeedGeneratorsV2Data, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<GetFeedGeneratorsV2Responses, GetFeedGeneratorsV2Errors, ThrowOnError>({
+        responseType: 'json',
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http',
+            },
+        ],
+        url: '/umbraco/ucproductfeeds/management/api/v2/setting/feedgenerators',
+        ...options,
+    });
+};
+
+/**
+ * @deprecated
+ */
 export const getFeedTypes = <ThrowOnError extends boolean = false>(options?: Options<GetFeedTypesData, ThrowOnError>) => {
     return (options?.client ?? _heyApiClient).get<GetFeedTypesResponses, GetFeedTypesErrors, ThrowOnError>({
         responseType: 'json',
@@ -64,6 +119,9 @@ export const getFeedTypes = <ThrowOnError extends boolean = false>(options?: Opt
     });
 };
 
+/**
+ * @deprecated
+ */
 export const getDetails = <ThrowOnError extends boolean = false>(options: Options<GetDetailsData, ThrowOnError>) => {
     return (options.client ?? _heyApiClient).get<GetDetailsResponses, GetDetailsErrors, ThrowOnError>({
         responseType: 'json',
@@ -78,6 +136,23 @@ export const getDetails = <ThrowOnError extends boolean = false>(options: Option
     });
 };
 
+export const getDetailsV2 = <ThrowOnError extends boolean = false>(options: Options<GetDetailsV2Data, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetDetailsV2Responses, GetDetailsV2Errors, ThrowOnError>({
+        responseType: 'json',
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http',
+            },
+        ],
+        url: '/umbraco/ucproductfeeds/management/api/v2/setting/get/{id}',
+        ...options,
+    });
+};
+
+/**
+ * @deprecated
+ */
 export const getByStore = <ThrowOnError extends boolean = false>(options: Options<GetByStoreData, ThrowOnError>) => {
     return (options.client ?? _heyApiClient).get<GetByStoreResponses, GetByStoreErrors, ThrowOnError>({
         responseType: 'json',
@@ -92,6 +167,23 @@ export const getByStore = <ThrowOnError extends boolean = false>(options: Option
     });
 };
 
+export const getByStoreV2 = <ThrowOnError extends boolean = false>(options: Options<GetByStoreV2Data, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetByStoreV2Responses, GetByStoreV2Errors, ThrowOnError>({
+        responseType: 'json',
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http',
+            },
+        ],
+        url: '/umbraco/ucproductfeeds/management/api/v2/setting/getbystore',
+        ...options,
+    });
+};
+
+/**
+ * @deprecated
+ */
 export const getPropertyValueExtractors = <ThrowOnError extends boolean = false>(options?: Options<GetPropertyValueExtractorsData, ThrowOnError>) => {
     return (options?.client ?? _heyApiClient).get<GetPropertyValueExtractorsResponses, GetPropertyValueExtractorsErrors, ThrowOnError>({
         responseType: 'json',
@@ -106,6 +198,23 @@ export const getPropertyValueExtractors = <ThrowOnError extends boolean = false>
     });
 };
 
+export const getPropertyValueExtractorsV2 = <ThrowOnError extends boolean = false>(options?: Options<GetPropertyValueExtractorsV2Data, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<GetPropertyValueExtractorsV2Responses, GetPropertyValueExtractorsV2Errors, ThrowOnError>({
+        responseType: 'json',
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http',
+            },
+        ],
+        url: '/umbraco/ucproductfeeds/management/api/v2/setting/propertyvalueextractors',
+        ...options,
+    });
+};
+
+/**
+ * @deprecated
+ */
 export const save = <ThrowOnError extends boolean = false>(options?: Options<SaveData, ThrowOnError>) => {
     return (options?.client ?? _heyApiClient).post<SaveResponses, SaveErrors, ThrowOnError>({
         responseType: 'json',
@@ -122,4 +231,22 @@ export const save = <ThrowOnError extends boolean = false>(options?: Options<Sav
             ...options?.headers,
         },
     });
+};
+
+export const saveV2 = <ThrowOnError extends boolean = false>(options?: Options<SaveV2Data, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).post<SaveV2Responses, SaveV2Errors, ThrowOnError>({
+        responseType: 'json',
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http',
+            },
+        ],
+        url: '/umbraco/ucproductfeeds/management/api/v2/setting/save',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers,
+        },
+    });
 };