@vendure/admin-ui 1.7.3 → 1.8.0

package/README.md

@@ -0,0 +1,49 @@
+# Vendure Admin UI
+
+This is the administration interface for Vendure.
+
+It is an Angular application built with the Angular CLI.
+
+The UI is powered by the [Clarity Design System](https://clarity.design).
+
+## Structure
+
+### Library
+
+The Admin UI is structured as an Angular library conforming to the [ng-packagr format](https://github.com/ng-packagr/ng-packagr). This library is what is published to npm as `@vendure/admin-ui`. The library consists
+of a set of modules which are accessible from consuming applications as sub-packages:
+
+* `@vendure/admin-ui/core`
+* `@vendure/admin-ui/catalog`
+* `@vendure/admin-ui/orders`
+
+etc. These library packages are located at [./src/lib](./src/lib)
+
+When built with `yarn build`, the output will be located in the `./package` sub directory. This is also the root of the published npm package.
+
+### Application
+
+In addition to the library, there is also a full application located at [./src/app](./src/app). This application is used both during development of the Admin UI, and also as the "default" Admin UI without any UI extensions, as provided as the default by the [admin-ui-plugin](../admin-ui-plugin).
+
+## Localization
+
+Localization of UI strings is handled by [ngx-translate](http://www.ngx-translate.com/). The translation strings should use the [ICU MessageFormat](http://userguide.icu-project.org/formatparse/messages).
+
+Translation keys are automatically extracted by running:
+```
+yarn extract-translations
+```
+This scan the source files for any translation keys, and add them to each of the translation files located in [`./src/lib/static/i18n-messages/`](./src/lib/static/i18n-messages/).
+
+A report is generated for each language detailing what percentage of the translation tokens are translated into that language:
+
+```text
+Extracting translation tokens for "src\lib\static\i18n-messages\de.json"
+de: 592 of 650 tokens translated (91%)
+```
+
+This report data is also saved to the [i18n-coverage.json](./i18n-coverage.json) file.
+
+To add support for a new language, create a new empty json file (`{}`) in the `i18n-messages` directory named `<languageCode>.json`, where `languageCode` is one of the supported codes as given in the [LanguageCode enum type](../core/src/api/schema/common/language-code.graphql), then run `yarn extract-translations`
+
+

package/angular.json

@@ -0,0 +1,196 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "vendure-admin": {
+      "root": "",
+      "sourceRoot": "src",
+      "projectType": "application",
+      "prefix": "vdr",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "baseHref": "/admin/",
+            "outputPath": "dist",
+            "index": "src/lib/static/index.html",
+            "main": "src/main.ts",
+            "polyfills": "src/lib/static/polyfills.ts",
+            "tsConfig": "src/tsconfig.app.json",
+            "assets": [
+              { "glob": "**/*", "input": "src/lib/static/", "output": "/" }
+            ],
+            "styles": [
+              "src/lib/static/styles/styles.scss"
+            ],
+            "stylePreprocessorOptions": {
+              "includePaths": [
+                "./src/lib/static/styles"
+              ]
+            },
+            "allowedCommonJsDependencies": [
+              "graphql-tag",
+              "zen-observable",
+              "lodash",
+              "apollo-upload-client",
+              "@vendure/common/lib/simple-deep-clone"
+            ],
+            "vendorChunk": true,
+            "extractLicenses": false,
+            "buildOptimizer": false,
+            "sourceMap": true,
+            "optimization": false,
+            "namedChunks": true
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "6kb"
+                }
+              ],
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.prod.ts"
+                }
+              ],
+              "optimization": {
+                "styles": {
+                  "inlineCritical": false
+                }
+              },
+              "outputHashing": "all",
+              "namedChunks": false,
+              "extractLicenses": true,
+              "vendorChunk": false
+            }
+          },
+          "defaultConfiguration": ""
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "browserTarget": "vendure-admin:build"
+          },
+          "configurations": {
+            "production": {
+              "browserTarget": "vendure-admin:build:production"
+            },
+            "plugin": {
+              "browserTarget": "vendure-admin:build:plugin-watch"
+            },
+            "plugin-dev": {
+              "browserTarget": "vendure-admin:build:plugin-dev-watch"
+            }
+          }
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "vendure-admin:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "src/test.ts",
+            "polyfills": "src/lib/static/polyfills.ts",
+            "tsConfig": "src/tsconfig.spec.json",
+            "karmaConfig": "src/karma.conf.js",
+            "styles": [
+              "src/lib/static/styles/styles.scss"
+            ],
+            "scripts": [],
+            "assets": [
+              "src/lib/static/favicon.ico",
+              "src/lib/static/assets"
+            ],
+            "stylePreprocessorOptions": {
+              "includePaths": [
+                "./src/lib/static/styles"
+              ]
+            }
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "src/tsconfig.app.json",
+              "src/tsconfig.spec.json"
+            ],
+            "exclude": [
+              "**/node_modules/**"
+            ]
+          }
+        }
+      }
+    },
+    "vendure-admin-e2e": {
+      "root": "e2e/",
+      "projectType": "application",
+      "architect": {
+        "e2e": {
+          "builder": "@angular-devkit/build-angular:protractor",
+          "options": {
+            "protractorConfig": "e2e/protractor.conf.js",
+            "devServerTarget": "vendure-admin:serve"
+          },
+          "configurations": {
+            "production": {
+              "devServerTarget": "vendure-admin:serve:production"
+            }
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": "e2e/tsconfig.e2e.json",
+            "exclude": [
+              "**/node_modules/**"
+            ]
+          }
+        }
+      }
+    },
+    "vendure-admin-lib": {
+      "projectType": "library",
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "vdr",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:ng-packagr",
+          "options": {
+            "tsConfig": "./tsconfig.lib.json",
+            "project": "./src/lib/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "./tsconfig.lib.prod.json"
+            }
+          }
+        }
+      }
+    }
+  },
+  "defaultProject": "vendure-admin",
+  "schematics": {
+    "@schematics/angular:component": {
+      "skipTests": true,
+      "changeDetection": "OnPush"
+    }
+  },
+  "cli": {
+    "packageManager": "yarn",
+    "analytics": "61fa89f7-706a-46c0-bcdb-b1d3664195ce"
+  }
+}

package/i18n-coverage.json

@@ -0,0 +1,71 @@
+{
+  "generatedOn": "2022-10-18T18:49:58.336Z",
+  "lastCommit": "43421c67f52ac66880b606a17fe62b19d6385d85",
+  "translationStatus": {
+    "cs": {
+      "tokenCount": 687,
+      "translatedCount": 593,
+      "percentage": 86
+    },
+    "de": {
+      "tokenCount": 687,
+      "translatedCount": 572,
+      "percentage": 83
+    },
+    "en": {
+      "tokenCount": 687,
+      "translatedCount": 685,
+      "percentage": 100
+    },
+    "es": {
+      "tokenCount": 687,
+      "translatedCount": 624,
+      "percentage": 91
+    },
+    "fr": {
+      "tokenCount": 687,
+      "translatedCount": 614,
+      "percentage": 89
+    },
+    "it": {
+      "tokenCount": 687,
+      "translatedCount": 622,
+      "percentage": 91
+    },
+    "pl": {
+      "tokenCount": 687,
+      "translatedCount": 407,
+      "percentage": 59
+    },
+    "pt_BR": {
+      "tokenCount": 687,
+      "translatedCount": 591,
+      "percentage": 86
+    },
+    "pt_PT": {
+      "tokenCount": 687,
+      "translatedCount": 635,
+      "percentage": 92
+    },
+    "ru": {
+      "tokenCount": 687,
+      "translatedCount": 621,
+      "percentage": 90
+    },
+    "uk": {
+      "tokenCount": 687,
+      "translatedCount": 621,
+      "percentage": 90
+    },
+    "zh_Hans": {
+      "tokenCount": 687,
+      "translatedCount": 559,
+      "percentage": 81
+    },
+    "zh_Hant": {
+      "tokenCount": 687,
+      "translatedCount": 387,
+      "percentage": 56
+    }
+  }
+}