42083 V14: Integrations (Shopify)

dtng95 · dtng95 · commit 54bcbb501737 · 2024-07-10T19:00:22.000+07:00
- Update  generated API
- Update property picker name
- add vite config
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify.Core/Api/Management/Controllers/ShopifyControllerBase.cs b/src/Umbraco.Cms.Integrations.Commerce.Shopify.Core/Api/Management/Controllers/ShopifyControllerBase.cs
@@ -43,16 +43,5 @@ protected HttpRequestMessage CreateRequest(string accessToken)
             requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
             return requestMessage;
         }
-
-        public IActionResult OAuth(string code)
-        {
-            return new ContentResult
-            {
-                Content = string.IsNullOrEmpty(code)
-                    ? JavascriptResponse.Fail("Authorization process failed.")
-                    : JavascriptResponse.Ok(code),
-                ContentType = "text/html"
-            };
-        }
     }
 }
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify.Core/Services/ShopifyService.cs b/src/Umbraco.Cms.Integrations.Commerce.Shopify.Core/Services/ShopifyService.cs
@@ -39,11 +39,7 @@ public class ShopifyService : IShopifyService
 
         private readonly ShopifyOAuthSettings _oauthSettings;
 
-#if NETCOREAPP
         private readonly ILogger<ShopifyService> _umbCoreLogger;
-#else
-        private readonly ILogger _umbCoreLogger;
-#endif
 
         private readonly ITokenService _tokenService;
 
@@ -53,7 +49,6 @@ public class ShopifyService : IShopifyService
         // Access to the client within the class is via ClientFactory(), allowing us to mock the responses in tests.
         public static Func<HttpClient> ClientFactory = () => Client;
 
-#if NETCOREAPP
         public ShopifyService(ILogger<ShopifyService> logger,
             IOptions<ShopifySettings> options, IOptions<ShopifyOAuthSettings> oauthOptions,
             ITokenService tokenService)
@@ -73,25 +68,6 @@ public ShopifyService(ILogger<ShopifyService> logger,
 
             _tokenService = tokenService;
         }
-#else
-        public ShopifyService(ILogger logger, ITokenService tokenService)
-        {
-            var resolver = new JsonPropertyRenameContractResolver();
-            resolver.RenameProperty(typeof(ResponseDto<ProductsListDto>), "Result", "products");
-
-            _serializerSettings = new JsonSerializerSettings
-            {
-                ContractResolver = resolver
-            };
-
-            _settings = new ShopifySettings(ConfigurationManager.AppSettings);
-            _oauthSettings = new ShopifyOAuthSettings(ConfigurationManager.AppSettings);
-
-            _umbCoreLogger = logger;
-
-            _tokenService = tokenService;
-        }
-#endif
 
         public EditorSettings GetApiConfiguration()
         {
@@ -301,19 +277,11 @@ private void Log(ShopifyLogLevel logLevel, string message)
         {
             if (logLevel == ShopifyLogLevel.Error)
             {
-#if NETCOREAPP
                 _umbCoreLogger.LogError(message);
-#else
-                _umbCoreLogger.Error<ShopifyService>(message);
-#endif
             }
             else if (logLevel == ShopifyLogLevel.Information)
             {
-#if NETCOREAPP
                 _umbCoreLogger.LogInformation(message);
-#else
-                _umbCoreLogger.Info<ShopifyService>(message: message);
-#endif
             }
         }
     }
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/index.html b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/index.html
@@ -6,7 +6,6 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Vite + Lit + TS</title>
     <link rel="stylesheet" href="./src/index.css" />
-    <script type="module" src="/src/my-element.ts"></script>
   </head>
   <body>
     <my-element>
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/generated/models.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/generated/models.ts
@@ -1,5 +1,14 @@
 
 
+export type ConfigurationTypeModel = {
+        readonly value: string
+    };
+
+export type EditorSettingsModel = {
+        isValid: boolean
+type: ConfigurationTypeModel
+    };
+
 export enum EventMessageTypeModel {
     DEFAULT = 'Default',
     INFO = 'Info',
@@ -78,9 +87,9 @@ GetListByIds: {
         
         
         responses: {
-            CheckConfiguration: any
+            CheckConfiguration: EditorSettingsModel
                 ,GetAccessToken: string
-                ,GetAuthorizationUrl: any
+                ,GetAuthorizationUrl: string
                 ,GetList: ResponseDtoProductsListDtoModel
                 ,GetListByIds: ResponseDtoProductsListDtoModel
                 ,RevokeAccessToken: string
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/generated/services.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/generated/services.ts
@@ -6,7 +6,7 @@ import type { ShopifyData } from './models';
 export class ShopifyService {
 
 	/**
-	 * @returns any OK
+	 * @returns unknown OK
 	 * @throws ApiError
 	 */
 	public static checkConfiguration(): CancelablePromise<ShopifyData['responses']['CheckConfiguration']> {
@@ -35,7 +35,7 @@ export class ShopifyService {
 	}
 
 	/**
-	 * @returns any OK
+	 * @returns string OK
 	 * @throws ApiError
 	 */
 	public static getAuthorizationUrl(): CancelablePromise<ShopifyData['responses']['GetAuthorizationUrl']> {
@@ -74,7 +74,7 @@ export class ShopifyService {
                     requestBody
                 } = data;
 		return __request(OpenAPI, {
-			method: 'POST',
+			method: 'GET',
 			url: '/umbraco/shopify/management/api/v1/get-list-by-ids',
 			body: requestBody,
 			mediaType: 'application/json',
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/modal/shopify-modal.element.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/modal/shopify-modal.element.ts
@@ -5,12 +5,12 @@ import {
 } from "@umbraco-cms/backoffice/notification";
 import type { UUIInputEvent } from "@umbraco-cms/backoffice/external/uui";
 import type { ShopifyServiceStatus } from "../models/shopify-service.model.js";
-import type { ShopifyPickerModalData, ShopifyPickerModalValue } from "./shopify.modal-token.js";
+import type { ShopifyProductPickerModalData, ShopifyProductPickerModalValue } from "./shopify.modal-token.js";
 import type { ProductsListDtoModel } from "../generated";
 import { SHOPIFY_CONTEXT_TOKEN } from "../context/shopify.context.js";
 
 const elementName = "shopify-modal";
 
-export default class ShopifyModalElement extends UmbModalBaseElement<ShopifyPickerModalData, ShopifyPickerModalValue>{
+export default class ShopifyModalElement extends UmbModalBaseElement<ShopifyProductPickerModalData, ShopifyProductPickerModalValue>{
 
 }
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/modal/shopify.modal-token.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/modal/shopify.modal-token.ts
@@ -1,15 +1,15 @@
 import { UmbModalToken } from "@umbraco-cms/backoffice/modal";
 import type { ProductDtoModel } from "../generated";
 
-export type ShopifyPickerModalData = {
+export type ShopifyProductPickerModalData = {
     headline: string;
 }
 
-export type ShopifyPickerModalValue = {
+export type ShopifyProductPickerModalValue = {
     products: ProductDtoModel;
 }
 
-export const SHOPIFY_MODAL_TOKEN = new UmbModalToken<ShopifyPickerModalData, ShopifyPickerModalValue>("Shopify.Modal", {
+export const SHOPIFY_MODAL_TOKEN = new UmbModalToken<ShopifyProductPickerModalData, ShopifyProductPickerModalValue>("Shopify.Modal", {
     modal: {
         type: "sidebar",
         size: "small"
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/property-editor/authorization-property-editor.element.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/property-editor/authorization-property-editor.element.ts
@@ -0,0 +1,19 @@
+import { UmbElementMixin } from "@umbraco-cms/backoffice/element-api";
+import { LitElement, customElement, html, property, state, when } from "@umbraco-cms/backoffice/external/lit";
+import { UMB_NOTIFICATION_CONTEXT, type UmbNotificationColor} from "@umbraco-cms/backoffice/notification";
+import { ConfigDescription, type ShopifyOAuthSetup, type ShopifyServiceStatus } from "../models/shopify-service.model";
+import { SHOPIFY_CONTEXT_TOKEN } from "../context/shopify.context";
+import type { OAuthRequestDtoModel } from "../generated";
+
+const elementName = "shopify-authorization";
+
+@customElement(elementName)
+export class ShopifyAuthorizationElement extends UmbElementMixin(LitElement){
+    #shopifyContext!: typeof SHOPIFY_CONTEXT_TOKEN.TYPE;
+
+    render() {
+        return html`
+            <div><span>Authentication</span></div>
+        `;
+    }
+}
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/property-editor/manifests.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/property-editor/manifests.ts
@@ -4,8 +4,8 @@ export const propertyEditorUiManifest : ManifestPropertyEditorUi = {
     type: "propertyEditorUi",
     alias: "Shopify.PropertyEditorUi.ProductPicker",
     name: "Shopify Product Picker Property Editor UI",
-    js: () => import("./shopify-picker-property-editor.element.js"),
-    elementName: "shopify-picker",
+    js: () => import("./shopify-product-picker-property-editor.element.js"),
+    elementName: "shopify-product-picker",
     meta: {
         label: "Shopify Product Picker",
         icon: "icon-handshake",
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/property-editor/shopify-product-picker-property-editor.element.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/src/property-editor/shopify-product-picker-property-editor.element.ts
@@ -10,7 +10,7 @@ import { SHOPIFY_CONTEXT_TOKEN } from "../context/shopify.context";
 import type { ProductDtoModel } from "../generated/models";
 
 const elementName = "shopify-picker";
-export class ShopifyPickerPropertyEditor extends UmbElementMixin(LitElement){
+export class ShopifyProductPickerPropertyEditor extends UmbElementMixin(LitElement){
     #modalManagerContext?: typeof UMB_MODAL_MANAGER_CONTEXT.TYPE;
     #shopifyContext!: typeof SHOPIFY_CONTEXT_TOKEN.TYPE;
 
@@ -108,10 +108,10 @@ export class ShopifyPickerPropertyEditor extends UmbElementMixin(LitElement){
 }
 
 
-export default ShopifyPickerPropertyEditor;
+export default ShopifyProductPickerPropertyEditor;
 
 declare global {
     interface HTMLElementTagNameMap {
-        [elementName]: ShopifyPickerPropertyEditor;
+        [elementName]: ShopifyProductPickerPropertyEditor;
     }
 }
diff --git a/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/vite.config.ts b/src/Umbraco.Cms.Integrations.Commerce.Shopify/Client/vite.config.ts
@@ -0,0 +1,19 @@
+import { defineConfig } from "vite";
+import tsconfigPaths from "vite-tsconfig-paths";
+
+export default defineConfig({
+    build: {
+        lib: {
+            entry: "src/index.ts",
+            formats: ["es"],
+        },
+        outDir: "obj/Debug/net8.0/clientassets",
+        emptyOutDir: true,
+        sourcemap: true,
+        rollupOptions: {
+            external: [/^@umbraco-cms/],
+            onwarn: () => { },
+        },
+    },
+    plugins: [tsconfigPaths()],
+});

Original file line number	Diff line number	Diff line change
`@@ -43,16 +43,5 @@ protected HttpRequestMessage CreateRequest(string accessToken)`
`43`	`43`	`requestMessage.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);`
`44`	`44`	`return requestMessage;`
`45`	`45`	`}`
`46`		`-`
`47`		`- public IActionResult OAuth(string code)`
`48`		`- {`
`49`		`- return new ContentResult`
`50`		`- {`
`51`		`- Content = string.IsNullOrEmpty(code)`
`52`		`- ? JavascriptResponse.Fail("Authorization process failed.")`
`53`		`- : JavascriptResponse.Ok(code),`
`54`		`- ContentType = "text/html"`
`55`		`- };`
`56`		`- }`
`57`	`46`	`}`
`58`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import { SHOPIFY_CONTEXT_TOKEN } from "../context/shopify.context";`
`10`	`10`	`import type { ProductDtoModel } from "../generated/models";`
`11`	`11`
`12`	`12`	`const elementName = "shopify-picker";`
`13`		`-export class ShopifyPickerPropertyEditor extends UmbElementMixin(LitElement){`
	`13`	`+export class ShopifyProductPickerPropertyEditor extends UmbElementMixin(LitElement){`
`14`	`14`	`#modalManagerContext?: typeof UMB_MODAL_MANAGER_CONTEXT.TYPE;`
`15`	`15`	`#shopifyContext!: typeof SHOPIFY_CONTEXT_TOKEN.TYPE;`
`16`	`16`
`@@ -108,10 +108,10 @@ export class ShopifyPickerPropertyEditor extends UmbElementMixin(LitElement){`
`108`	`108`	`}`
`109`	`109`
`110`	`110`
`111`		`-export default ShopifyPickerPropertyEditor;`
	`111`	`+export default ShopifyProductPickerPropertyEditor;`
`112`	`112`
`113`	`113`	`declare global {`
`114`	`114`	`interface HTMLElementTagNameMap {`
`115`		`- [elementName]: ShopifyPickerPropertyEditor;`
	`115`	`+ [elementName]: ShopifyProductPickerPropertyEditor;`
`116`	`116`	`}`
`117`	`117`	`}`