feat(admin-ui): Thumbnails make use of focal point data

Relates to #93
vendure-ecommerce · Feb 13, 2020 · 667b885 · 667b885
1 parent f717fb3
commit 667b885
Show file tree

Hide file tree

Showing 16 changed files with 72 additions and 19 deletions.
diff --git a/packages/admin-ui/src/app/catalog/components/product-assets/product-assets.component.html b/packages/admin-ui/src/app/catalog/components/product-assets/product-assets.component.html
@@ -3,7 +3,7 @@
         <div class="featured-asset">
             <img
                 *ngIf="featuredAsset"
-                [src]="featuredAsset!.preview + '?preset=small'"
+                [src]="featuredAsset | assetPreview:'small'"
                 (click)="previewAsset(featuredAsset)"
             />
             <div class="placeholder" *ngIf="!featuredAsset">
@@ -25,7 +25,7 @@
     <div class="featured-asset compact">
         <img
             *ngIf="featuredAsset"
-            [src]="featuredAsset!.preview + '?preset=thumb'"
+            [src]="featuredAsset | assetPreview:'thumb'"
             (click)="previewAsset(featuredAsset)"
         />
 
@@ -66,7 +66,7 @@
                     [title]=""
                     tabindex="0"
                 >
-                    <img [src]="asset.preview + '?preset=tiny'" />
+                    <img [src]="asset | assetPreview:'tiny'" />
                 </div>
                 <vdr-dropdown-menu vdrPosition="bottom-right">
                     <button type="button" vdrDropdownItem (click)="previewAsset(asset)">

diff --git a/packages/admin-ui/src/app/catalog/components/product-list/product-list.component.html b/packages/admin-ui/src/app/catalog/components/product-list/product-list.component.html
@@ -51,11 +51,11 @@
                 <img
                     *ngIf="
                         groupByProduct
-                            ? result.productPreview
-                            : result.productVariantPreview || result.productPreview as image;
+                            ? result.productAsset
+                            : result.productVariantAsset || result.productAsset as asset;
                         else imagePlaceholder
                     "
-                    [src]="image + '?preset=tiny'"
+                    [src]="asset | assetPreview:'tiny'"
                 />
                 <ng-template #imagePlaceholder>
                     <div class="placeholder"><clr-icon shape="image" size="48"></clr-icon></div>

diff --git a/...i/src/app/catalog/components/product-variants-table/product-variants-table.component.html b/...i/src/app/catalog/components/product-variants-table/product-variants-table.component.html
@@ -15,7 +15,7 @@
                     <div class="featured-asset">
                         <img
                             *ngIf="variant.featuredAsset"
-                            [src]="variant.featuredAsset!.preview + '?preset=tiny'"
+                            [src]="variant.featuredAsset | assetPreview:'tiny'"
                         />
                         <div class="placeholder" *ngIf="!variant.featuredAsset">
                             <clr-icon shape="image" size="48"></clr-icon>

diff --git a/packages/admin-ui/src/app/catalog/providers/routing/asset-resolver.ts b/packages/admin-ui/src/app/catalog/providers/routing/asset-resolver.ts
@@ -23,6 +23,7 @@ export class AssetResolver extends BaseEntityResolver<Asset.Fragment> {
                 height: 0,
                 source: '',
                 preview: '',
+                focalPoint: null,
             },
             id => dataService.product.getAsset(id).mapStream(data => data.asset),
         );

diff --git a/packages/admin-ui/src/app/common/generated-types.ts b/packages/admin-ui/src/app/common/generated-types.ts
@@ -3157,9 +3157,11 @@ export type SearchResult = {
   productId: Scalars['ID'],
   productName: Scalars['String'],
   productPreview: Scalars['String'],
+  productAsset?: Maybe<SearchResultAsset>,
   productVariantId: Scalars['ID'],
   productVariantName: Scalars['String'],
   productVariantPreview: Scalars['String'],
+  productVariantAsset?: Maybe<SearchResultAsset>,
   price: SearchResultPrice,
   priceWithTax: SearchResultPrice,
   currencyCode: CurrencyCode,
@@ -3172,6 +3174,13 @@ export type SearchResult = {
   score: Scalars['Float'],
 };
 
+export type SearchResultAsset = {
+  __typename?: 'SearchResultAsset',
+  id: Scalars['ID'],
+  preview: Scalars['String'],
+  focalPoint?: Maybe<Coordinate>,
+};
+
 /** The price of a search result product, either as a range or as a single price */
 export type SearchResultPrice = PriceRange | SinglePrice;
 
@@ -4030,7 +4039,7 @@ export type AddNoteToOrderMutationVariables = {
 
 export type AddNoteToOrderMutation = ({ __typename?: 'Mutation' } & { addNoteToOrder: ({ __typename?: 'Order' } & Pick<Order, 'id'>) });
 
-export type AssetFragment = ({ __typename?: 'Asset' } & Pick<Asset, 'id' | 'createdAt' | 'updatedAt' | 'name' | 'fileSize' | 'mimeType' | 'type' | 'preview' | 'source' | 'width' | 'height'>);
+export type AssetFragment = ({ __typename?: 'Asset' } & Pick<Asset, 'id' | 'createdAt' | 'updatedAt' | 'name' | 'fileSize' | 'mimeType' | 'type' | 'preview' | 'source' | 'width' | 'height'> & { focalPoint: Maybe<({ __typename?: 'Coordinate' } & Pick<Coordinate, 'x' | 'y'>)> });
 
 export type ProductVariantFragment = ({ __typename?: 'ProductVariant' } & Pick<ProductVariant, 'id' | 'createdAt' | 'updatedAt' | 'enabled' | 'languageCode' | 'name' | 'price' | 'currencyCode' | 'priceIncludesTax' | 'priceWithTax' | 'stockOnHand' | 'trackInventory' | 'sku'> & { taxRateApplied: ({ __typename?: 'TaxRate' } & Pick<TaxRate, 'id' | 'name' | 'value'>), taxCategory: ({ __typename?: 'TaxCategory' } & Pick<TaxCategory, 'id' | 'name'>), options: Array<({ __typename?: 'ProductOption' } & Pick<ProductOption, 'id' | 'code' | 'languageCode' | 'name' | 'groupId'> & { translations: Array<({ __typename?: 'ProductOptionTranslation' } & Pick<ProductOptionTranslation, 'id' | 'languageCode' | 'name'>)> })>, facetValues: Array<({ __typename?: 'FacetValue' } & Pick<FacetValue, 'id' | 'code' | 'name'> & { facet: ({ __typename?: 'Facet' } & Pick<Facet, 'id' | 'name'>) })>, featuredAsset: Maybe<({ __typename?: 'Asset' } & AssetFragment)>, assets: Array<({ __typename?: 'Asset' } & AssetFragment)>, translations: Array<({ __typename?: 'ProductVariantTranslation' } & Pick<ProductVariantTranslation, 'id' | 'languageCode' | 'name'>)> });
 
@@ -4164,7 +4173,7 @@ export type SearchProductsQueryVariables = {
 };
 
 
-export type SearchProductsQuery = ({ __typename?: 'Query' } & { search: ({ __typename?: 'SearchResponse' } & Pick<SearchResponse, 'totalItems'> & { items: Array<({ __typename?: 'SearchResult' } & Pick<SearchResult, 'enabled' | 'productId' | 'productName' | 'productPreview' | 'productVariantId' | 'productVariantName' | 'productVariantPreview' | 'sku' | 'channelIds'>)>, facetValues: Array<({ __typename?: 'FacetValueResult' } & Pick<FacetValueResult, 'count'> & { facetValue: ({ __typename?: 'FacetValue' } & Pick<FacetValue, 'id' | 'createdAt' | 'updatedAt' | 'name'> & { facet: ({ __typename?: 'Facet' } & Pick<Facet, 'id' | 'createdAt' | 'updatedAt' | 'name'>) }) })> }) });
+export type SearchProductsQuery = ({ __typename?: 'Query' } & { search: ({ __typename?: 'SearchResponse' } & Pick<SearchResponse, 'totalItems'> & { items: Array<({ __typename?: 'SearchResult' } & Pick<SearchResult, 'enabled' | 'productId' | 'productName' | 'productVariantId' | 'productVariantName' | 'sku' | 'channelIds'> & { productAsset: Maybe<({ __typename?: 'SearchResultAsset' } & Pick<SearchResultAsset, 'id' | 'preview'> & { focalPoint: Maybe<({ __typename?: 'Coordinate' } & Pick<Coordinate, 'x' | 'y'>)> })>, productVariantAsset: Maybe<({ __typename?: 'SearchResultAsset' } & Pick<SearchResultAsset, 'id' | 'preview'> & { focalPoint: Maybe<({ __typename?: 'Coordinate' } & Pick<Coordinate, 'x' | 'y'>)> })> })>, facetValues: Array<({ __typename?: 'FacetValueResult' } & Pick<FacetValueResult, 'count'> & { facetValue: ({ __typename?: 'FacetValue' } & Pick<FacetValue, 'id' | 'createdAt' | 'updatedAt' | 'name'> & { facet: ({ __typename?: 'Facet' } & Pick<Facet, 'id' | 'createdAt' | 'updatedAt' | 'name'>) }) })> }) });
 
 export type UpdateProductOptionMutationVariables = {
   input: UpdateProductOptionInput
@@ -5028,6 +5037,7 @@ export namespace AddNoteToOrder {
 
 export namespace Asset {
   export type Fragment = AssetFragment;
+  export type FocalPoint = (NonNullable<AssetFragment['focalPoint']>);
 }
 
 export namespace ProductVariant {
@@ -5177,6 +5187,10 @@ export namespace SearchProducts {
   export type Query = SearchProductsQuery;
   export type Search = SearchProductsQuery['search'];
   export type Items = (NonNullable<SearchProductsQuery['search']['items'][0]>);
+  export type ProductAsset = (NonNullable<(NonNullable<SearchProductsQuery['search']['items'][0]>)['productAsset']>);
+  export type FocalPoint = (NonNullable<(NonNullable<(NonNullable<SearchProductsQuery['search']['items'][0]>)['productAsset']>)['focalPoint']>);
+  export type ProductVariantAsset = (NonNullable<(NonNullable<SearchProductsQuery['search']['items'][0]>)['productVariantAsset']>);
+  export type _FocalPoint = (NonNullable<(NonNullable<(NonNullable<SearchProductsQuery['search']['items'][0]>)['productVariantAsset']>)['focalPoint']>);
   export type FacetValues = (NonNullable<SearchProductsQuery['search']['facetValues'][0]>);
   export type FacetValue = (NonNullable<SearchProductsQuery['search']['facetValues'][0]>)['facetValue'];
   export type Facet = (NonNullable<SearchProductsQuery['search']['facetValues'][0]>)['facetValue']['facet'];

diff --git a/packages/admin-ui/src/app/data/definitions/product-definitions.ts b/packages/admin-ui/src/app/data/definitions/product-definitions.ts
@@ -374,10 +374,24 @@ export const SEARCH_PRODUCTS = gql`
                 enabled
                 productId
                 productName
-                productPreview
+                productAsset {
+                    id
+                    preview
+                    focalPoint {
+                        x
+                        y
+                    }
+                }
                 productVariantId
                 productVariantName
-                productVariantPreview
+                productVariantAsset {
+                    id
+                    preview
+                    focalPoint {
+                        x
+                        y
+                    }
+                }
                 sku
                 channelIds
             }

diff --git a/.../admin-ui/src/app/order/components/cancel-order-dialog/cancel-order-dialog.component.html b/.../admin-ui/src/app/order/components/cancel-order-dialog/cancel-order-dialog.component.html
@@ -19,7 +19,7 @@
                 [class.is-cancelled]="line.quantity === 0"
             >
                 <td class="align-middle thumb">
-                    <img [src]="line.featuredAsset.preview + '?preset=tiny'" />
+                    <img [src]="line.featuredAsset | assetPreview:'tiny'" />
                 </td>
                 <td class="align-middle name">{{ line.productVariant.name }}</td>
                 <td class="align-middle sku">{{ line.productVariant.sku }}</td>

diff --git a/...dmin-ui/src/app/order/components/fulfill-order-dialog/fulfill-order-dialog.component.html b/...dmin-ui/src/app/order/components/fulfill-order-dialog/fulfill-order-dialog.component.html
@@ -18,7 +18,7 @@
                 [class.ignore]="getUnfulfilledCount(line) === 0"
             >
                 <td class="align-middle thumb">
-                    <img *ngIf="line.featuredAsset" [src]="line.featuredAsset.preview + '?preset=tiny'" />
+                    <img *ngIf="line.featuredAsset" [src]="line.featuredAsset | assetPreview:'tiny'" />
                 </td>
                 <td class="align-middle name">{{ line.productVariant.name }}</td>
                 <td class="align-middle sku">{{ line.productVariant.sku }}</td>

diff --git a/packages/admin-ui/src/app/order/components/order-detail/order-detail.component.html b/packages/admin-ui/src/app/order/components/order-detail/order-detail.component.html
@@ -87,7 +87,7 @@
                     [class.is-cancelled]="line.quantity === 0"
                 >
                     <td class="align-middle thumb">
-                        <img *ngIf="line.featuredAsset" [src]="line.featuredAsset.preview + '?preset=tiny'" />
+                        <img *ngIf="line.featuredAsset" [src]="line.featuredAsset | assetPreview:'tiny'" />
                     </td>
                     <td class="align-middle name">{{ line.productVariant.name }}</td>
                     <td class="align-middle sku">{{ line.productVariant.sku }}</td>

diff --git a/.../admin-ui/src/app/order/components/refund-order-dialog/refund-order-dialog.component.html b/.../admin-ui/src/app/order/components/refund-order-dialog/refund-order-dialog.component.html
@@ -16,7 +16,7 @@
             </thead>
             <tr *ngFor="let line of order.lines" class="order-line">
                 <td class="align-middle thumb">
-                    <img [src]="line.featuredAsset.preview + '?preset=tiny'" />
+                    <img [src]="line.featuredAsset | assetPreview:'tiny'" />
                 </td>
                 <td class="align-middle name">{{ line.productVariant.name }}</td>
                 <td class="align-middle sku">{{ line.productVariant.sku }}</td>

diff --git a/packages/admin-ui/src/app/shared/components/asset-gallery/asset-gallery.component.html b/packages/admin-ui/src/app/shared/components/asset-gallery/asset-gallery.component.html
@@ -7,7 +7,7 @@
     >
         <div class="card-img">
             <div class="selected-checkbox"><clr-icon shape="check-circle" size="32"></clr-icon></div>
-            <img [src]="asset.preview + '?preset=thumb'" />
+            <img [src]="asset | assetPreview:'thumb'" />
         </div>
         <div class="detail">
             <vdr-entity-info

diff --git a/packages/admin-ui/src/app/shared/components/asset-preview/asset-preview.component.html b/packages/admin-ui/src/app/shared/components/asset-preview/asset-preview.component.html
@@ -8,7 +8,7 @@
             [editable]="settingFocalPoint"
             (focalPointChange)="onFocalPointChange($event)"
         >
-            <img class="" [src]="asset.preview + '?preset=' + size" #imageElement (load)="getDimensions()" />
+            <img class="asset-image" [src]="asset | assetPreview:size" #imageElement (load)="onImageLoad()" />
         </vdr-focal-point-control>
         <div class="focal-point-info" *ngIf="settingFocalPoint">
             <button class="icon-button" (click)="setFocalPointCancel()">

diff --git a/packages/admin-ui/src/app/shared/components/asset-preview/asset-preview.component.ts b/packages/admin-ui/src/app/shared/components/asset-preview/asset-preview.component.ts
@@ -95,6 +95,11 @@ export class AssetPreviewComponent implements OnInit, OnDestroy {
         return parts[parts.length - 1];
     }
 
+    onImageLoad() {
+        this.updateDimensions();
+        this.changeDetector.markForCheck();
+    }
+
     updateDimensions() {
         const img = this.imageElementRef.nativeElement;
         const container = this.previewDivRef.nativeElement;
@@ -142,7 +147,7 @@ export class AssetPreviewComponent implements OnInit, OnDestroy {
             .subscribe(
                 () => {
                     this.notificationService.success(_('asset.update-focal-point-success'));
-                    this.asset.focalPoint = null;
+                    this.asset = { ...this.asset, focalPoint: null };
                     this.changeDetector.markForCheck();
                 },
                 () => this.notificationService.error(_('asset.update-focal-point-error')),
@@ -173,7 +178,7 @@ export class AssetPreviewComponent implements OnInit, OnDestroy {
                 .subscribe(
                     () => {
                         this.notificationService.success(_('asset.update-focal-point-success'));
-                        this.asset.focalPoint = { x, y };
+                        this.asset = { ...this.asset, focalPoint: { x, y } };
                         this.changeDetector.markForCheck();
                     },
                     () => this.notificationService.error(_('asset.update-focal-point-error')),

diff --git a/packages/admin-ui/src/app/shared/pipes/asset-preview.pipe.ts b/packages/admin-ui/src/app/shared/pipes/asset-preview.pipe.ts
@@ -0,0 +1,16 @@
+import { Pipe, PipeTransform } from '@angular/core';
+
+import { Asset } from '../../common/generated-types';
+
+@Pipe({
+    name: 'assetPreview',
+})
+export class AssetPreviewPipe implements PipeTransform {
+    transform(asset: Asset, preset: string = 'thumb'): string {
+        if (!asset.preview || typeof asset.preview !== 'string') {
+            throw new Error(`Expected an Asset, got ${JSON.stringify(asset)}`);
+        }
+        const fp = asset.focalPoint ? `&fpx=${asset.focalPoint.x}&fpy=${asset.focalPoint.y}` : '';
+        return `${asset.preview}?preset=${preset}${fp}`;
+    }
+}
diff --git a/packages/admin-ui/src/app/shared/shared-declarations.ts b/packages/admin-ui/src/app/shared/shared-declarations.ts
@@ -11,6 +11,7 @@ export {
     AssetPreviewDialogComponent,
 } from './components/asset-preview-dialog/asset-preview-dialog.component';
 export { AssetPreviewComponent } from './components/asset-preview/asset-preview.component';
+export { AssetPreviewPipe } from './pipes/asset-preview.pipe';
 export { PercentageSuffixInputComponent } from './components/affixed-input/percentage-suffix-input.component';
 export {
     ChannelAssignmentControlComponent,

diff --git a/packages/admin-ui/src/app/shared/shared.module.ts b/packages/admin-ui/src/app/shared/shared.module.ts
@@ -26,6 +26,7 @@ import {
     AssetPickerDialogComponent,
     AssetPreviewComponent,
     AssetPreviewDialogComponent,
+    AssetPreviewPipe,
     ChannelAssignmentControlComponent,
     ChannelBadgeComponent,
     ChannelLabelPipe,
@@ -152,6 +153,7 @@ const DECLARATIONS = [
     ExtensionHostComponent,
     CustomFieldLabelPipe,
     FocalPointControlComponent,
+    AssetPreviewPipe,
 ];
 
 @NgModule({